]>
git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blob - include/drm/drm_panel.h
2 * Copyright (C) 2013, NVIDIA Corporation. All rights reserved.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sub license,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the
12 * next paragraph) shall be included in all copies or substantial portions
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 #ifndef __DRM_PANEL_H__
25 #define __DRM_PANEL_H__
27 #include <linux/err.h>
28 #include <linux/errno.h>
29 #include <linux/list.h>
35 struct display_timing
;
38 * struct drm_panel_funcs - perform operations on a given panel
40 * The .prepare() function is typically called before the display controller
41 * starts to transmit video data. Panel drivers can use this to turn the panel
42 * on and wait for it to become ready. If additional configuration is required
43 * (via a control bus such as I2C, SPI or DSI for example) this is a good time
46 * After the display controller has started transmitting video data, it's safe
47 * to call the .enable() function. This will typically enable the backlight to
48 * make the image on screen visible. Some panels require a certain amount of
49 * time or frames before the image is displayed. This function is responsible
50 * for taking this into account before enabling the backlight to avoid visual
53 * Before stopping video transmission from the display controller it can be
54 * necessary to turn off the panel to avoid visual glitches. This is done in
55 * the .disable() function. Analogously to .enable() this typically involves
56 * turning off the backlight and waiting for some time to make sure no image
57 * is visible on the panel. It is then safe for the display controller to
58 * cease transmission of video data.
60 * To save power when no video data is transmitted, a driver can power down
61 * the panel. This is the job of the .unprepare() function.
63 struct drm_panel_funcs
{
67 * Turn on panel and perform set up.
69 int (*prepare
)(struct drm_panel
*panel
);
74 * Enable panel (turn on back light, etc.).
76 int (*enable
)(struct drm_panel
*panel
);
81 * Disable panel (turn off back light, etc.).
83 int (*disable
)(struct drm_panel
*panel
);
90 int (*unprepare
)(struct drm_panel
*panel
);
95 * Add modes to the connector that the panel is attached to and
96 * return the number of modes added.
98 int (*get_modes
)(struct drm_panel
*panel
);
103 * Copy display timings into the provided array and return
104 * the number of display timings available.
106 int (*get_timings
)(struct drm_panel
*panel
, unsigned int num_timings
,
107 struct display_timing
*timings
);
111 * struct drm_panel - DRM panel object
117 * DRM device owning the panel.
119 struct drm_device
*drm
;
124 * DRM connector that the panel is attached to.
126 struct drm_connector
*connector
;
131 * Parent device of the panel.
138 * Operations that can be performed on the panel.
140 const struct drm_panel_funcs
*funcs
;
145 * Panel entry in registry.
147 struct list_head list
;
150 void drm_panel_init(struct drm_panel
*panel
);
152 int drm_panel_add(struct drm_panel
*panel
);
153 void drm_panel_remove(struct drm_panel
*panel
);
155 int drm_panel_attach(struct drm_panel
*panel
, struct drm_connector
*connector
);
156 void drm_panel_detach(struct drm_panel
*panel
);
158 int drm_panel_prepare(struct drm_panel
*panel
);
159 int drm_panel_unprepare(struct drm_panel
*panel
);
161 int drm_panel_enable(struct drm_panel
*panel
);
162 int drm_panel_disable(struct drm_panel
*panel
);
164 int drm_panel_get_modes(struct drm_panel
*panel
);
166 #if defined(CONFIG_OF) && defined(CONFIG_DRM_PANEL)
167 struct drm_panel
*of_drm_find_panel(const struct device_node
*np
);
169 static inline struct drm_panel
*of_drm_find_panel(const struct device_node
*np
)
171 return ERR_PTR(-ENODEV
);