Commit | Line | Data |
---|---|---|
1c248b7d ID |
1 | /* exynos_drm_drv.h |
2 | * | |
3 | * Copyright (c) 2011 Samsung Electronics Co., Ltd. | |
4 | * Authors: | |
5 | * Inki Dae <inki.dae@samsung.com> | |
6 | * Joonyoung Shim <jy0922.shim@samsung.com> | |
7 | * Seung-Woo Kim <sw0312.kim@samsung.com> | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a | |
10 | * copy of this software and associated documentation files (the "Software"), | |
11 | * to deal in the Software without restriction, including without limitation | |
12 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
13 | * and/or sell copies of the Software, and to permit persons to whom the | |
14 | * Software is furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice (including the next | |
17 | * paragraph) shall be included in all copies or substantial portions of the | |
18 | * Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
23 | * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR | |
24 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | |
25 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
26 | * OTHER DEALINGS IN THE SOFTWARE. | |
27 | */ | |
28 | ||
29 | #ifndef _EXYNOS_DRM_DRV_H_ | |
30 | #define _EXYNOS_DRM_DRV_H_ | |
31 | ||
32 | #include "drm.h" | |
33 | ||
34 | #define MAX_CRTC 2 | |
35 | ||
36 | struct drm_device; | |
37 | struct exynos_drm_overlay; | |
38 | struct drm_connector; | |
39 | ||
40 | /* this enumerates display type. */ | |
41 | enum exynos_drm_output_type { | |
42 | EXYNOS_DISPLAY_TYPE_NONE, | |
43 | /* RGB or CPU Interface. */ | |
44 | EXYNOS_DISPLAY_TYPE_LCD, | |
45 | /* HDMI Interface. */ | |
46 | EXYNOS_DISPLAY_TYPE_HDMI, | |
47 | }; | |
48 | ||
49 | /* | |
50 | * Exynos drm overlay ops structure. | |
51 | * | |
52 | * @mode_set: copy drm overlay info to hw specific overlay info. | |
53 | * @commit: apply hardware specific overlay data to registers. | |
54 | * @disable: disable hardware specific overlay. | |
55 | */ | |
56 | struct exynos_drm_overlay_ops { | |
57 | void (*mode_set)(struct device *subdrv_dev, | |
58 | struct exynos_drm_overlay *overlay); | |
59 | void (*commit)(struct device *subdrv_dev); | |
60 | void (*disable)(struct device *subdrv_dev); | |
61 | }; | |
62 | ||
63 | /* | |
64 | * Exynos drm common overlay structure. | |
65 | * | |
19c8b834 ID |
66 | * @fb_x: offset x on a framebuffer to be displayed. |
67 | * - the unit is screen coordinates. | |
68 | * @fb_y: offset y on a framebuffer to be displayed. | |
69 | * - the unit is screen coordinates. | |
70 | * @fb_width: width of a framebuffer. | |
71 | * @fb_height: height of a framebuffer. | |
72 | * @crtc_x: offset x on hardware screen. | |
73 | * @crtc_y: offset y on hardware screen. | |
74 | * @crtc_width: window width to be displayed (hardware screen). | |
75 | * @crtc_height: window height to be displayed (hardware screen). | |
76 | * @mode_width: width of screen mode. | |
77 | * @mode_height: height of screen mode. | |
78 | * @refresh: refresh rate. | |
79 | * @scan_flag: interlace or progressive way. | |
80 | * (it could be DRM_MODE_FLAG_*) | |
1c248b7d ID |
81 | * @bpp: pixel size.(in bit) |
82 | * @paddr: bus(accessed by dma) physical memory address to this overlay | |
83 | * and this is physically continuous. | |
84 | * @vaddr: virtual memory addresss to this overlay. | |
85 | * @buf_off: start offset of framebuffer to be displayed. | |
1c248b7d ID |
86 | * @default_win: a window to be enabled. |
87 | * @color_key: color key on or off. | |
88 | * @index_color: if using color key feature then this value would be used | |
89 | * as index color. | |
90 | * @local_path: in case of lcd type, local path mode on or off. | |
91 | * @transparency: transparency on or off. | |
92 | * @activated: activated or not. | |
93 | * | |
94 | * this structure is common to exynos SoC and its contents would be copied | |
95 | * to hardware specific overlay info. | |
96 | */ | |
97 | struct exynos_drm_overlay { | |
19c8b834 ID |
98 | unsigned int fb_x; |
99 | unsigned int fb_y; | |
100 | unsigned int fb_width; | |
101 | unsigned int fb_height; | |
102 | unsigned int crtc_x; | |
103 | unsigned int crtc_y; | |
104 | unsigned int crtc_width; | |
105 | unsigned int crtc_height; | |
106 | unsigned int mode_width; | |
107 | unsigned int mode_height; | |
108 | unsigned int refresh; | |
109 | unsigned int scan_flag; | |
1c248b7d | 110 | unsigned int bpp; |
19c8b834 | 111 | unsigned int pitch; |
1c248b7d ID |
112 | dma_addr_t paddr; |
113 | void __iomem *vaddr; | |
114 | unsigned int buf_off; | |
1c248b7d ID |
115 | |
116 | bool default_win; | |
117 | bool color_key; | |
118 | unsigned int index_color; | |
119 | bool local_path; | |
120 | bool transparency; | |
121 | bool activated; | |
122 | }; | |
123 | ||
124 | /* | |
125 | * Exynos DRM Display Structure. | |
126 | * - this structure is common to analog tv, digital tv and lcd panel. | |
127 | * | |
128 | * @type: one of exynos_DISPLAY_TYPE_LCD and HDMI. | |
129 | * @is_connected: check for that display is connected or not. | |
130 | * @get_edid: get edid modes from display driver. | |
131 | * @get_timing: get timing object from display driver. | |
132 | * @check_timing: check if timing is valid or not. | |
133 | * @power_on: display device on or off. | |
134 | */ | |
135 | struct exynos_drm_display { | |
136 | enum exynos_drm_output_type type; | |
137 | bool (*is_connected)(struct device *dev); | |
138 | int (*get_edid)(struct device *dev, struct drm_connector *connector, | |
139 | u8 *edid, int len); | |
140 | void *(*get_timing)(struct device *dev); | |
141 | int (*check_timing)(struct device *dev, void *timing); | |
142 | int (*power_on)(struct device *dev, int mode); | |
143 | }; | |
144 | ||
145 | /* | |
146 | * Exynos drm manager ops | |
147 | * | |
148 | * @mode_set: convert drm_display_mode to hw specific display mode and | |
149 | * would be called by encoder->mode_set(). | |
150 | * @commit: set current hw specific display mode to hw. | |
151 | * @enable_vblank: specific driver callback for enabling vblank interrupt. | |
152 | * @disable_vblank: specific driver callback for disabling vblank interrupt. | |
153 | */ | |
154 | struct exynos_drm_manager_ops { | |
155 | void (*mode_set)(struct device *subdrv_dev, void *mode); | |
156 | void (*commit)(struct device *subdrv_dev); | |
157 | int (*enable_vblank)(struct device *subdrv_dev); | |
158 | void (*disable_vblank)(struct device *subdrv_dev); | |
159 | }; | |
160 | ||
161 | /* | |
162 | * Exynos drm common manager structure. | |
163 | * | |
164 | * @dev: pointer to device object for subdrv device driver. | |
165 | * sub drivers such as display controller or hdmi driver, | |
166 | * have their own device object. | |
167 | * @ops: pointer to callbacks for exynos drm specific framebuffer. | |
168 | * these callbacks should be set by specific drivers such fimd | |
169 | * or hdmi driver and are used to control hardware global registers. | |
170 | * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer. | |
171 | * these callbacks should be set by specific drivers such fimd | |
172 | * or hdmi driver and are used to control hardware overlay reigsters. | |
173 | * @display: pointer to callbacks for exynos drm specific framebuffer. | |
174 | * these callbacks should be set by specific drivers such fimd | |
175 | * or hdmi driver and are used to control display devices such as | |
176 | * analog tv, digital tv and lcd panel and also get timing data for them. | |
177 | */ | |
178 | struct exynos_drm_manager { | |
179 | struct device *dev; | |
180 | int pipe; | |
181 | struct exynos_drm_manager_ops *ops; | |
182 | struct exynos_drm_overlay_ops *overlay_ops; | |
183 | struct exynos_drm_display *display; | |
184 | }; | |
185 | ||
186 | /* | |
187 | * Exynos drm private structure. | |
188 | */ | |
189 | struct exynos_drm_private { | |
190 | struct drm_fb_helper *fb_helper; | |
191 | ||
192 | /* for pageflip */ | |
193 | struct list_head pageflip_event_list; | |
194 | bool pageflip_event; | |
195 | ||
196 | /* | |
197 | * created crtc object would be contained at this array and | |
198 | * this array is used to be aware of which crtc did it request vblank. | |
199 | */ | |
200 | struct drm_crtc *crtc[MAX_CRTC]; | |
201 | }; | |
202 | ||
203 | /* | |
204 | * Exynos drm sub driver structure. | |
205 | * | |
206 | * @list: sub driver has its own list object to register to exynos drm driver. | |
207 | * @drm_dev: pointer to drm_device and this pointer would be set | |
208 | * when sub driver calls exynos_drm_subdrv_register(). | |
209 | * @probe: this callback would be called by exynos drm driver after | |
210 | * subdrv is registered to it. | |
211 | * @remove: this callback is used to release resources created | |
212 | * by probe callback. | |
213 | * @manager: subdrv has its own manager to control a hardware appropriately | |
214 | * and we can access a hardware drawing on this manager. | |
215 | * @encoder: encoder object owned by this sub driver. | |
216 | * @connector: connector object owned by this sub driver. | |
217 | */ | |
218 | struct exynos_drm_subdrv { | |
219 | struct list_head list; | |
220 | struct drm_device *drm_dev; | |
221 | ||
222 | int (*probe)(struct drm_device *dev); | |
223 | void (*remove)(struct drm_device *dev); | |
224 | ||
225 | struct exynos_drm_manager manager; | |
226 | struct drm_encoder *encoder; | |
227 | struct drm_connector *connector; | |
228 | }; | |
229 | ||
230 | /* | |
231 | * this function calls a probe callback registered to sub driver list and | |
232 | * create its own encoder and connector and then set drm_device object | |
233 | * to global one. | |
234 | */ | |
235 | int exynos_drm_device_register(struct drm_device *dev); | |
236 | /* | |
237 | * this function calls a remove callback registered to sub driver list and | |
238 | * destroy its own encoder and connetor. | |
239 | */ | |
240 | int exynos_drm_device_unregister(struct drm_device *dev); | |
241 | ||
242 | /* | |
243 | * this function would be called by sub drivers such as display controller | |
244 | * or hdmi driver to register this sub driver object to exynos drm driver | |
245 | * and when a sub driver is registered to exynos drm driver a probe callback | |
246 | * of the sub driver is called and creates its own encoder and connector | |
247 | * and then fb helper and drm mode group would be re-initialized. | |
248 | */ | |
249 | int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); | |
250 | ||
251 | /* | |
252 | * this function removes subdrv list from exynos drm driver and fb helper | |
253 | * and drm mode group would be re-initialized. | |
254 | */ | |
255 | int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); | |
256 | ||
257 | #endif |