1aead40eaSThierry Reding /*
2aead40eaSThierry Reding * Copyright (C) 2013, NVIDIA Corporation. All rights reserved.
3aead40eaSThierry Reding *
4aead40eaSThierry Reding * Permission is hereby granted, free of charge, to any person obtaining a
5aead40eaSThierry Reding * copy of this software and associated documentation files (the "Software"),
6aead40eaSThierry Reding * to deal in the Software without restriction, including without limitation
7aead40eaSThierry Reding * the rights to use, copy, modify, merge, publish, distribute, sub license,
8aead40eaSThierry Reding * and/or sell copies of the Software, and to permit persons to whom the
9aead40eaSThierry Reding * Software is furnished to do so, subject to the following conditions:
10aead40eaSThierry Reding *
11aead40eaSThierry Reding * The above copyright notice and this permission notice (including the
12aead40eaSThierry Reding * next paragraph) shall be included in all copies or substantial portions
13aead40eaSThierry Reding * of the Software.
14aead40eaSThierry Reding *
15aead40eaSThierry Reding * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16aead40eaSThierry Reding * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17aead40eaSThierry Reding * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18aead40eaSThierry Reding * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19aead40eaSThierry Reding * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20aead40eaSThierry Reding * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21aead40eaSThierry Reding * DEALINGS IN THE SOFTWARE.
22aead40eaSThierry Reding */
23aead40eaSThierry Reding
24aead40eaSThierry Reding #ifndef __DRM_PANEL_H__
25aead40eaSThierry Reding #define __DRM_PANEL_H__
26aead40eaSThierry Reding
27bf3f5e98SJani Nikula #include <linux/err.h>
28e4e818ccSMasahiro Yamada #include <linux/errno.h>
29aead40eaSThierry Reding #include <linux/list.h>
30de087416SDouglas Anderson #include <linux/mutex.h>
31aead40eaSThierry Reding
32152dbdeaSSam Ravnborg struct backlight_device;
332509969aSDouglas Anderson struct dentry;
34e4e818ccSMasahiro Yamada struct device_node;
35aead40eaSThierry Reding struct drm_connector;
36aead40eaSThierry Reding struct drm_device;
37de087416SDouglas Anderson struct drm_panel_follower;
38aead40eaSThierry Reding struct drm_panel;
392938931fSPhilipp Zabel struct display_timing;
40aead40eaSThierry Reding
415f3e7503SDerek Basehore enum drm_panel_orientation;
425f3e7503SDerek Basehore
4345527d43SAjay Kumar /**
4445527d43SAjay Kumar * struct drm_panel_funcs - perform operations on a given panel
4545527d43SAjay Kumar *
4645527d43SAjay Kumar * The .prepare() function is typically called before the display controller
4745527d43SAjay Kumar * starts to transmit video data. Panel drivers can use this to turn the panel
4845527d43SAjay Kumar * on and wait for it to become ready. If additional configuration is required
4945527d43SAjay Kumar * (via a control bus such as I2C, SPI or DSI for example) this is a good time
5045527d43SAjay Kumar * to do that.
5145527d43SAjay Kumar *
5245527d43SAjay Kumar * After the display controller has started transmitting video data, it's safe
5345527d43SAjay Kumar * to call the .enable() function. This will typically enable the backlight to
5445527d43SAjay Kumar * make the image on screen visible. Some panels require a certain amount of
5545527d43SAjay Kumar * time or frames before the image is displayed. This function is responsible
5645527d43SAjay Kumar * for taking this into account before enabling the backlight to avoid visual
5745527d43SAjay Kumar * glitches.
5845527d43SAjay Kumar *
5945527d43SAjay Kumar * Before stopping video transmission from the display controller it can be
6045527d43SAjay Kumar * necessary to turn off the panel to avoid visual glitches. This is done in
6145527d43SAjay Kumar * the .disable() function. Analogously to .enable() this typically involves
6245527d43SAjay Kumar * turning off the backlight and waiting for some time to make sure no image
6345527d43SAjay Kumar * is visible on the panel. It is then safe for the display controller to
6445527d43SAjay Kumar * cease transmission of video data.
6545527d43SAjay Kumar *
6645527d43SAjay Kumar * To save power when no video data is transmitted, a driver can power down
6745527d43SAjay Kumar * the panel. This is the job of the .unprepare() function.
68152dbdeaSSam Ravnborg *
69152dbdeaSSam Ravnborg * Backlight can be handled automatically if configured using
7010f7b40eSRajeev Nandan * drm_panel_of_backlight() or drm_panel_dp_aux_backlight(). Then the driver
7110f7b40eSRajeev Nandan * does not need to implement the functionality to enable/disable backlight.
7245527d43SAjay Kumar */
73aead40eaSThierry Reding struct drm_panel_funcs {
748b0c6e2fSSam Ravnborg /**
758b0c6e2fSSam Ravnborg * @prepare:
768b0c6e2fSSam Ravnborg *
778b0c6e2fSSam Ravnborg * Turn on panel and perform set up.
785dce87a9SSam Ravnborg *
795dce87a9SSam Ravnborg * This function is optional.
808b0c6e2fSSam Ravnborg */
8145527d43SAjay Kumar int (*prepare)(struct drm_panel *panel);
828b0c6e2fSSam Ravnborg
838b0c6e2fSSam Ravnborg /**
848b0c6e2fSSam Ravnborg * @enable:
858b0c6e2fSSam Ravnborg *
868b0c6e2fSSam Ravnborg * Enable panel (turn on back light, etc.).
875dce87a9SSam Ravnborg *
885dce87a9SSam Ravnborg * This function is optional.
898b0c6e2fSSam Ravnborg */
90aead40eaSThierry Reding int (*enable)(struct drm_panel *panel);
918b0c6e2fSSam Ravnborg
928b0c6e2fSSam Ravnborg /**
938b0c6e2fSSam Ravnborg * @disable:
948b0c6e2fSSam Ravnborg *
958b0c6e2fSSam Ravnborg * Disable panel (turn off back light, etc.).
965dce87a9SSam Ravnborg *
975dce87a9SSam Ravnborg * This function is optional.
988b0c6e2fSSam Ravnborg */
998b0c6e2fSSam Ravnborg int (*disable)(struct drm_panel *panel);
1008b0c6e2fSSam Ravnborg
1018b0c6e2fSSam Ravnborg /**
1028b0c6e2fSSam Ravnborg * @unprepare:
1038b0c6e2fSSam Ravnborg *
1048b0c6e2fSSam Ravnborg * Turn off panel.
1055dce87a9SSam Ravnborg *
1065dce87a9SSam Ravnborg * This function is optional.
1078b0c6e2fSSam Ravnborg */
1088b0c6e2fSSam Ravnborg int (*unprepare)(struct drm_panel *panel);
1098b0c6e2fSSam Ravnborg
1108b0c6e2fSSam Ravnborg /**
1118b0c6e2fSSam Ravnborg * @get_modes:
1128b0c6e2fSSam Ravnborg *
1135dce87a9SSam Ravnborg * Add modes to the connector that the panel is attached to
1145dce87a9SSam Ravnborg * and returns the number of modes added.
1155dce87a9SSam Ravnborg *
1165dce87a9SSam Ravnborg * This function is mandatory.
1178b0c6e2fSSam Ravnborg */
1180ce8ddd8SSam Ravnborg int (*get_modes)(struct drm_panel *panel,
1190ce8ddd8SSam Ravnborg struct drm_connector *connector);
1208b0c6e2fSSam Ravnborg
1218b0c6e2fSSam Ravnborg /**
1225e41b01aSHsin-Yi Wang * @get_orientation:
1235e41b01aSHsin-Yi Wang *
1245e41b01aSHsin-Yi Wang * Return the panel orientation set by device tree or EDID.
1255e41b01aSHsin-Yi Wang *
1265e41b01aSHsin-Yi Wang * This function is optional.
1275e41b01aSHsin-Yi Wang */
1285e41b01aSHsin-Yi Wang enum drm_panel_orientation (*get_orientation)(struct drm_panel *panel);
1295e41b01aSHsin-Yi Wang
1305e41b01aSHsin-Yi Wang /**
1318b0c6e2fSSam Ravnborg * @get_timings:
1328b0c6e2fSSam Ravnborg *
1338b0c6e2fSSam Ravnborg * Copy display timings into the provided array and return
1348b0c6e2fSSam Ravnborg * the number of display timings available.
1355dce87a9SSam Ravnborg *
1365dce87a9SSam Ravnborg * This function is optional.
1378b0c6e2fSSam Ravnborg */
1382938931fSPhilipp Zabel int (*get_timings)(struct drm_panel *panel, unsigned int num_timings,
1392938931fSPhilipp Zabel struct display_timing *timings);
1402509969aSDouglas Anderson
1412509969aSDouglas Anderson /**
1422509969aSDouglas Anderson * @debugfs_init:
1432509969aSDouglas Anderson *
1442509969aSDouglas Anderson * Allows panels to create panels-specific debugfs files.
1452509969aSDouglas Anderson */
1462509969aSDouglas Anderson void (*debugfs_init)(struct drm_panel *panel, struct dentry *root);
147aead40eaSThierry Reding };
148aead40eaSThierry Reding
149de087416SDouglas Anderson struct drm_panel_follower_funcs {
150de087416SDouglas Anderson /**
151de087416SDouglas Anderson * @panel_prepared:
152de087416SDouglas Anderson *
153de087416SDouglas Anderson * Called after the panel has been powered on.
154de087416SDouglas Anderson */
155de087416SDouglas Anderson int (*panel_prepared)(struct drm_panel_follower *follower);
156de087416SDouglas Anderson
157de087416SDouglas Anderson /**
158de087416SDouglas Anderson * @panel_unpreparing:
159de087416SDouglas Anderson *
160de087416SDouglas Anderson * Called before the panel is powered off.
161de087416SDouglas Anderson */
162de087416SDouglas Anderson int (*panel_unpreparing)(struct drm_panel_follower *follower);
163de087416SDouglas Anderson };
164de087416SDouglas Anderson
165de087416SDouglas Anderson struct drm_panel_follower {
166de087416SDouglas Anderson /**
167de087416SDouglas Anderson * @funcs:
168de087416SDouglas Anderson *
169de087416SDouglas Anderson * Dependent device callbacks; should be initted by the caller.
170de087416SDouglas Anderson */
171de087416SDouglas Anderson const struct drm_panel_follower_funcs *funcs;
172de087416SDouglas Anderson
173de087416SDouglas Anderson /**
174de087416SDouglas Anderson * @list
175de087416SDouglas Anderson *
176de087416SDouglas Anderson * Used for linking into panel's list; set by drm_panel_add_follower().
177de087416SDouglas Anderson */
178de087416SDouglas Anderson struct list_head list;
179de087416SDouglas Anderson
180de087416SDouglas Anderson /**
181de087416SDouglas Anderson * @panel
182de087416SDouglas Anderson *
183de087416SDouglas Anderson * The panel we're dependent on; set by drm_panel_add_follower().
184de087416SDouglas Anderson */
185de087416SDouglas Anderson struct drm_panel *panel;
186de087416SDouglas Anderson };
187de087416SDouglas Anderson
18883127f67SThierry Reding /**
18983127f67SThierry Reding * struct drm_panel - DRM panel object
19083127f67SThierry Reding */
191aead40eaSThierry Reding struct drm_panel {
1928b0c6e2fSSam Ravnborg /**
1938b0c6e2fSSam Ravnborg * @dev:
1948b0c6e2fSSam Ravnborg *
1958b0c6e2fSSam Ravnborg * Parent device of the panel.
1968b0c6e2fSSam Ravnborg */
197aead40eaSThierry Reding struct device *dev;
198aead40eaSThierry Reding
1998b0c6e2fSSam Ravnborg /**
200152dbdeaSSam Ravnborg * @backlight:
201152dbdeaSSam Ravnborg *
202152dbdeaSSam Ravnborg * Backlight device, used to turn on backlight after the call
203152dbdeaSSam Ravnborg * to enable(), and to turn off backlight before the call to
204152dbdeaSSam Ravnborg * disable().
20510f7b40eSRajeev Nandan * backlight is set by drm_panel_of_backlight() or
20610f7b40eSRajeev Nandan * drm_panel_dp_aux_backlight() and drivers shall not assign it.
207152dbdeaSSam Ravnborg */
208152dbdeaSSam Ravnborg struct backlight_device *backlight;
209152dbdeaSSam Ravnborg
210152dbdeaSSam Ravnborg /**
2118b0c6e2fSSam Ravnborg * @funcs:
2128b0c6e2fSSam Ravnborg *
2138b0c6e2fSSam Ravnborg * Operations that can be performed on the panel.
2148b0c6e2fSSam Ravnborg */
215aead40eaSThierry Reding const struct drm_panel_funcs *funcs;
216aead40eaSThierry Reding
2178b0c6e2fSSam Ravnborg /**
2189a2654c0SLaurent Pinchart * @connector_type:
2199a2654c0SLaurent Pinchart *
2209a2654c0SLaurent Pinchart * Type of the panel as a DRM_MODE_CONNECTOR_* value. This is used to
2219a2654c0SLaurent Pinchart * initialise the drm_connector corresponding to the panel with the
2229a2654c0SLaurent Pinchart * correct connector type.
2239a2654c0SLaurent Pinchart */
2249a2654c0SLaurent Pinchart int connector_type;
2259a2654c0SLaurent Pinchart
2269a2654c0SLaurent Pinchart /**
2278b0c6e2fSSam Ravnborg * @list:
2288b0c6e2fSSam Ravnborg *
2298b0c6e2fSSam Ravnborg * Panel entry in registry.
2308b0c6e2fSSam Ravnborg */
231aead40eaSThierry Reding struct list_head list;
2325ea6b170SDave Stevenson
2335ea6b170SDave Stevenson /**
234de087416SDouglas Anderson * @followers:
235de087416SDouglas Anderson *
236de087416SDouglas Anderson * A list of struct drm_panel_follower dependent on this panel.
237de087416SDouglas Anderson */
238de087416SDouglas Anderson struct list_head followers;
239de087416SDouglas Anderson
240de087416SDouglas Anderson /**
241*c0571b20SDouglas Anderson * @follower_lock:
242de087416SDouglas Anderson *
243de087416SDouglas Anderson * Lock for followers list.
244de087416SDouglas Anderson */
245de087416SDouglas Anderson struct mutex follower_lock;
246de087416SDouglas Anderson
247de087416SDouglas Anderson /**
2485ea6b170SDave Stevenson * @prepare_prev_first:
2495ea6b170SDave Stevenson *
2505ea6b170SDave Stevenson * The previous controller should be prepared first, before the prepare
2515ea6b170SDave Stevenson * for the panel is called. This is largely required for DSI panels
2525ea6b170SDave Stevenson * where the DSI host controller should be initialised to LP-11 before
2535ea6b170SDave Stevenson * the panel is powered up.
2545ea6b170SDave Stevenson */
2555ea6b170SDave Stevenson bool prepare_prev_first;
256d2aacaf0SDouglas Anderson
257d2aacaf0SDouglas Anderson /**
258d2aacaf0SDouglas Anderson * @prepared:
259d2aacaf0SDouglas Anderson *
260d2aacaf0SDouglas Anderson * If true then the panel has been prepared.
261d2aacaf0SDouglas Anderson */
262d2aacaf0SDouglas Anderson bool prepared;
263d2aacaf0SDouglas Anderson
264d2aacaf0SDouglas Anderson /**
265d2aacaf0SDouglas Anderson * @enabled:
266d2aacaf0SDouglas Anderson *
267d2aacaf0SDouglas Anderson * If true then the panel has been enabled.
268d2aacaf0SDouglas Anderson */
269d2aacaf0SDouglas Anderson bool enabled;
270aead40eaSThierry Reding };
271aead40eaSThierry Reding
2726dbe0c4bSLaurent Pinchart void drm_panel_init(struct drm_panel *panel, struct device *dev,
2739a2654c0SLaurent Pinchart const struct drm_panel_funcs *funcs,
2749a2654c0SLaurent Pinchart int connector_type);
275aead40eaSThierry Reding
276c3ee8c65SBernard Zhao void drm_panel_add(struct drm_panel *panel);
277aead40eaSThierry Reding void drm_panel_remove(struct drm_panel *panel);
278aead40eaSThierry Reding
2797a833d30SSam Ravnborg int drm_panel_prepare(struct drm_panel *panel);
2807a833d30SSam Ravnborg int drm_panel_unprepare(struct drm_panel *panel);
2817a833d30SSam Ravnborg
2827a833d30SSam Ravnborg int drm_panel_enable(struct drm_panel *panel);
2837a833d30SSam Ravnborg int drm_panel_disable(struct drm_panel *panel);
2847a833d30SSam Ravnborg
28506c4a9c2SSam Ravnborg int drm_panel_get_modes(struct drm_panel *panel, struct drm_connector *connector);
2867a833d30SSam Ravnborg
287b61c8d5dSRob Herring #if defined(CONFIG_OF) && defined(CONFIG_DRM_PANEL)
288327bc443SLaurent Pinchart struct drm_panel *of_drm_find_panel(const struct device_node *np);
2895f3e7503SDerek Basehore int of_drm_get_panel_orientation(const struct device_node *np,
2905f3e7503SDerek Basehore enum drm_panel_orientation *orientation);
291aead40eaSThierry Reding #else
of_drm_find_panel(const struct device_node * np)292327bc443SLaurent Pinchart static inline struct drm_panel *of_drm_find_panel(const struct device_node *np)
293aead40eaSThierry Reding {
2945fa8e4a2SBoris Brezillon return ERR_PTR(-ENODEV);
295aead40eaSThierry Reding }
2965f3e7503SDerek Basehore
of_drm_get_panel_orientation(const struct device_node * np,enum drm_panel_orientation * orientation)2975f3e7503SDerek Basehore static inline int of_drm_get_panel_orientation(const struct device_node *np,
2985f3e7503SDerek Basehore enum drm_panel_orientation *orientation)
2995f3e7503SDerek Basehore {
3005f3e7503SDerek Basehore return -ENODEV;
3015f3e7503SDerek Basehore }
302aead40eaSThierry Reding #endif
303aead40eaSThierry Reding
304de087416SDouglas Anderson #if defined(CONFIG_DRM_PANEL)
305de087416SDouglas Anderson bool drm_is_panel_follower(struct device *dev);
306de087416SDouglas Anderson int drm_panel_add_follower(struct device *follower_dev,
307de087416SDouglas Anderson struct drm_panel_follower *follower);
308de087416SDouglas Anderson void drm_panel_remove_follower(struct drm_panel_follower *follower);
309de087416SDouglas Anderson int devm_drm_panel_add_follower(struct device *follower_dev,
310de087416SDouglas Anderson struct drm_panel_follower *follower);
311de087416SDouglas Anderson #else
drm_is_panel_follower(struct device * dev)312de087416SDouglas Anderson static inline bool drm_is_panel_follower(struct device *dev)
313de087416SDouglas Anderson {
314de087416SDouglas Anderson return false;
315de087416SDouglas Anderson }
316de087416SDouglas Anderson
drm_panel_add_follower(struct device * follower_dev,struct drm_panel_follower * follower)317de087416SDouglas Anderson static inline int drm_panel_add_follower(struct device *follower_dev,
318de087416SDouglas Anderson struct drm_panel_follower *follower)
319de087416SDouglas Anderson {
320de087416SDouglas Anderson return -ENODEV;
321de087416SDouglas Anderson }
322de087416SDouglas Anderson
drm_panel_remove_follower(struct drm_panel_follower * follower)323de087416SDouglas Anderson static inline void drm_panel_remove_follower(struct drm_panel_follower *follower) { }
devm_drm_panel_add_follower(struct device * follower_dev,struct drm_panel_follower * follower)324de087416SDouglas Anderson static inline int devm_drm_panel_add_follower(struct device *follower_dev,
325de087416SDouglas Anderson struct drm_panel_follower *follower)
326de087416SDouglas Anderson {
327de087416SDouglas Anderson return -ENODEV;
328de087416SDouglas Anderson }
329de087416SDouglas Anderson #endif
330de087416SDouglas Anderson
3318d6cb2f7SArnd Bergmann #if IS_ENABLED(CONFIG_DRM_PANEL) && (IS_BUILTIN(CONFIG_BACKLIGHT_CLASS_DEVICE) || \
3328d6cb2f7SArnd Bergmann (IS_MODULE(CONFIG_DRM) && IS_MODULE(CONFIG_BACKLIGHT_CLASS_DEVICE)))
333152dbdeaSSam Ravnborg int drm_panel_of_backlight(struct drm_panel *panel);
334152dbdeaSSam Ravnborg #else
drm_panel_of_backlight(struct drm_panel * panel)335152dbdeaSSam Ravnborg static inline int drm_panel_of_backlight(struct drm_panel *panel)
336152dbdeaSSam Ravnborg {
337152dbdeaSSam Ravnborg return 0;
338152dbdeaSSam Ravnborg }
339152dbdeaSSam Ravnborg #endif
340152dbdeaSSam Ravnborg
341aead40eaSThierry Reding #endif
342