3 * Copyright (c) 2011 Samsung Electronics Co., Ltd.
5 * Inki Dae <inki.dae@samsung.com>
6 * Joonyoung Shim <jy0922.shim@samsung.com>
7 * Seung-Woo Kim <sw0312.kim@samsung.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
15 #ifndef _EXYNOS_DRM_DRV_H_
16 #define _EXYNOS_DRM_DRV_H_
19 #include <linux/module.h>
23 #define MAX_FB_BUFFER 4
24 #define DEFAULT_ZPOS -1
26 #define to_exynos_crtc(x) container_of(x, struct exynos_drm_crtc, base)
27 #define to_exynos_plane(x) container_of(x, struct exynos_drm_plane, base)
29 /* This enumerates device type. */
30 enum exynos_drm_device_type {
31 EXYNOS_DEVICE_TYPE_NONE,
32 EXYNOS_DEVICE_TYPE_CRTC,
33 EXYNOS_DEVICE_TYPE_CONNECTOR,
36 /* this enumerates display type. */
37 enum exynos_drm_output_type {
38 EXYNOS_DISPLAY_TYPE_NONE,
39 /* RGB or CPU Interface. */
40 EXYNOS_DISPLAY_TYPE_LCD,
42 EXYNOS_DISPLAY_TYPE_HDMI,
43 /* Virtual Display Interface. */
44 EXYNOS_DISPLAY_TYPE_VIDI,
48 * Exynos drm common overlay structure.
51 * @fb_x: offset x on a framebuffer to be displayed.
52 * - the unit is screen coordinates.
53 * @fb_y: offset y on a framebuffer to be displayed.
54 * - the unit is screen coordinates.
55 * @fb_width: width of a framebuffer.
56 * @fb_height: height of a framebuffer.
57 * @src_width: width of a partial image to be displayed from framebuffer.
58 * @src_height: height of a partial image to be displayed from framebuffer.
59 * @crtc_x: offset x on hardware screen.
60 * @crtc_y: offset y on hardware screen.
61 * @crtc_width: window width to be displayed (hardware screen).
62 * @crtc_height: window height to be displayed (hardware screen).
63 * @mode_width: width of screen mode.
64 * @mode_height: height of screen mode.
65 * @refresh: refresh rate.
66 * @scan_flag: interlace or progressive way.
67 * (it could be DRM_MODE_FLAG_*)
68 * @bpp: pixel size.(in bit)
69 * @pixel_format: fourcc pixel format of this overlay
70 * @dma_addr: array of bus(accessed by dma) address to the memory region
71 * allocated for a overlay.
72 * @zpos: order of overlay layer(z position).
73 * @index_color: if using color key feature then this value would be used
75 * @default_win: a window to be enabled.
76 * @color_key: color key on or off.
77 * @local_path: in case of lcd type, local path mode on or off.
78 * @transparency: transparency on or off.
79 * @activated: activated or not.
80 * @enabled: enabled or not.
82 * this structure is common to exynos SoC and its contents would be copied
83 * to hardware specific overlay info.
86 struct exynos_drm_plane {
87 struct drm_plane base;
90 unsigned int fb_width;
91 unsigned int fb_height;
92 unsigned int src_width;
93 unsigned int src_height;
96 unsigned int crtc_width;
97 unsigned int crtc_height;
98 unsigned int mode_width;
99 unsigned int mode_height;
100 unsigned int refresh;
101 unsigned int scan_flag;
104 uint32_t pixel_format;
105 dma_addr_t dma_addr[MAX_FB_BUFFER];
107 unsigned int index_color;
118 * Exynos DRM Display Structure.
119 * - this structure is common to analog tv, digital tv and lcd panel.
121 * @create_connector: initialize and register a new connector
122 * @remove: cleans up the display for removal
123 * @mode_fixup: fix mode data comparing to hw specific display mode.
124 * @mode_set: convert drm_display_mode to hw specific display mode and
125 * would be called by encoder->mode_set().
126 * @check_mode: check if mode is valid or not.
127 * @dpms: display device on or off.
128 * @commit: apply changes to hw
130 struct exynos_drm_display;
131 struct exynos_drm_display_ops {
132 int (*create_connector)(struct exynos_drm_display *display,
133 struct drm_encoder *encoder);
134 void (*remove)(struct exynos_drm_display *display);
135 void (*mode_fixup)(struct exynos_drm_display *display,
136 struct drm_connector *connector,
137 const struct drm_display_mode *mode,
138 struct drm_display_mode *adjusted_mode);
139 void (*mode_set)(struct exynos_drm_display *display,
140 struct drm_display_mode *mode);
141 int (*check_mode)(struct exynos_drm_display *display,
142 struct drm_display_mode *mode);
143 void (*dpms)(struct exynos_drm_display *display, int mode);
144 void (*commit)(struct exynos_drm_display *display);
148 * Exynos drm display structure, maps 1:1 with an encoder/connector
150 * @list: the list entry for this manager
151 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
152 * @encoder: encoder object this display maps to
153 * @connector: connector object this display maps to
154 * @ops: pointer to callbacks for exynos drm specific functionality
155 * @ctx: A pointer to the display's implementation specific context
157 struct exynos_drm_display {
158 struct list_head list;
159 enum exynos_drm_output_type type;
160 struct drm_encoder *encoder;
161 struct drm_connector *connector;
162 struct exynos_drm_display_ops *ops;
166 * Exynos drm crtc ops
168 * @dpms: control device power.
169 * @mode_fixup: fix mode data before applying it
170 * @commit: set current hw specific display mode to hw.
171 * @enable_vblank: specific driver callback for enabling vblank interrupt.
172 * @disable_vblank: specific driver callback for disabling vblank interrupt.
173 * @wait_for_vblank: wait for vblank interrupt to make sure that
174 * hardware overlay is updated.
175 * @win_mode_set: copy drm overlay info to hw specific overlay info.
176 * @win_commit: apply hardware specific overlay data to registers.
177 * @win_enable: enable hardware specific overlay.
178 * @win_disable: disable hardware specific overlay.
179 * @te_handler: trigger to transfer video image at the tearing effect
180 * synchronization signal if there is a page flip request.
182 struct exynos_drm_crtc;
183 struct exynos_drm_crtc_ops {
184 void (*dpms)(struct exynos_drm_crtc *crtc, int mode);
185 bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
186 const struct drm_display_mode *mode,
187 struct drm_display_mode *adjusted_mode);
188 void (*commit)(struct exynos_drm_crtc *crtc);
189 int (*enable_vblank)(struct exynos_drm_crtc *crtc);
190 void (*disable_vblank)(struct exynos_drm_crtc *crtc);
191 void (*wait_for_vblank)(struct exynos_drm_crtc *crtc);
192 void (*win_mode_set)(struct exynos_drm_crtc *crtc,
193 struct exynos_drm_plane *plane);
194 void (*win_commit)(struct exynos_drm_crtc *crtc, int zpos);
195 void (*win_enable)(struct exynos_drm_crtc *crtc, int zpos);
196 void (*win_disable)(struct exynos_drm_crtc *crtc, int zpos);
197 void (*te_handler)(struct exynos_drm_crtc *crtc);
201 * Exynos specific crtc structure.
203 * @base: crtc object.
204 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
205 * @pipe: a crtc index created at load() with a new crtc object creation
206 * and the crtc object would be set to private->crtc array
207 * to get a crtc object corresponding to this pipe from private->crtc
208 * array when irq interrupt occurred. the reason of using this pipe is that
209 * drm framework doesn't support multiple irq yet.
210 * we can refer to the crtc to current hardware interrupt occurred through
212 * @dpms: store the crtc dpms value
213 * @ops: pointer to callbacks for exynos drm specific functionality
214 * @ctx: A pointer to the crtc's implementation specific context
216 struct exynos_drm_crtc {
217 struct drm_crtc base;
218 enum exynos_drm_output_type type;
221 wait_queue_head_t pending_flip_queue;
222 atomic_t pending_flip;
223 struct exynos_drm_crtc_ops *ops;
227 struct exynos_drm_g2d_private {
229 struct list_head inuse_cmdlist;
230 struct list_head event_list;
231 struct list_head userptr_list;
234 struct drm_exynos_file_private {
235 struct exynos_drm_g2d_private *g2d_priv;
236 struct device *ipp_dev;
240 * Exynos drm private structure.
242 * @da_start: start address to device address space.
243 * with iommu, device address space starts from this address
244 * otherwise default one.
245 * @da_space_size: size of device address space.
246 * if 0 then default value is used for it.
247 * @pipe: the pipe number for this crtc/manager.
249 struct exynos_drm_private {
250 struct drm_fb_helper *fb_helper;
252 /* list head for new event to be added. */
253 struct list_head pageflip_event_list;
256 * created crtc object would be contained at this array and
257 * this array is used to be aware of which crtc did it request vblank.
259 struct drm_crtc *crtc[MAX_CRTC];
260 struct drm_property *plane_zpos_property;
262 unsigned long da_start;
263 unsigned long da_space_size;
269 * Exynos drm sub driver structure.
271 * @list: sub driver has its own list object to register to exynos drm driver.
272 * @dev: pointer to device object for subdrv device driver.
273 * @drm_dev: pointer to drm_device and this pointer would be set
274 * when sub driver calls exynos_drm_subdrv_register().
275 * @probe: this callback would be called by exynos drm driver after
276 * subdrv is registered to it.
277 * @remove: this callback is used to release resources created
279 * @open: this would be called with drm device file open.
280 * @close: this would be called with drm device file close.
282 struct exynos_drm_subdrv {
283 struct list_head list;
285 struct drm_device *drm_dev;
287 int (*probe)(struct drm_device *drm_dev, struct device *dev);
288 void (*remove)(struct drm_device *drm_dev, struct device *dev);
289 int (*open)(struct drm_device *drm_dev, struct device *dev,
290 struct drm_file *file);
291 void (*close)(struct drm_device *drm_dev, struct device *dev,
292 struct drm_file *file);
295 /* This function would be called by non kms drivers such as g2d and ipp. */
296 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
298 /* this function removes subdrv list from exynos drm driver */
299 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
301 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
302 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
303 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
304 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
306 #ifdef CONFIG_DRM_EXYNOS_IPP
307 int exynos_platform_device_ipp_register(void);
308 void exynos_platform_device_ipp_unregister(void);
310 static inline int exynos_platform_device_ipp_register(void) { return 0; }
311 static inline void exynos_platform_device_ipp_unregister(void) {}
315 #ifdef CONFIG_DRM_EXYNOS_DPI
316 struct exynos_drm_display * exynos_dpi_probe(struct device *dev);
317 int exynos_dpi_remove(struct exynos_drm_display *display);
319 static inline struct exynos_drm_display *
320 exynos_dpi_probe(struct device *dev) { return NULL; }
321 static inline int exynos_dpi_remove(struct exynos_drm_display *display)
327 #ifdef CONFIG_DRM_EXYNOS_VIDI
328 int exynos_drm_probe_vidi(void);
329 void exynos_drm_remove_vidi(void);
331 static inline int exynos_drm_probe_vidi(void) { return 0; }
332 static inline void exynos_drm_remove_vidi(void) {}
335 /* This function creates a encoder and a connector, and initializes them. */
336 int exynos_drm_create_enc_conn(struct drm_device *dev,
337 struct exynos_drm_display *display);
339 int exynos_drm_component_add(struct device *dev,
340 enum exynos_drm_device_type dev_type,
341 enum exynos_drm_output_type out_type);
343 void exynos_drm_component_del(struct device *dev,
344 enum exynos_drm_device_type dev_type);
346 extern struct platform_driver fimd_driver;
347 extern struct platform_driver decon_driver;
348 extern struct platform_driver dp_driver;
349 extern struct platform_driver dsi_driver;
350 extern struct platform_driver mixer_driver;
351 extern struct platform_driver hdmi_driver;
352 extern struct platform_driver exynos_drm_common_hdmi_driver;
353 extern struct platform_driver vidi_driver;
354 extern struct platform_driver g2d_driver;
355 extern struct platform_driver fimc_driver;
356 extern struct platform_driver rotator_driver;
357 extern struct platform_driver gsc_driver;
358 extern struct platform_driver ipp_driver;