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
25 #define to_exynos_crtc(x) container_of(x, struct exynos_drm_crtc, base)
26 #define to_exynos_plane(x) container_of(x, struct exynos_drm_plane, base)
28 /* This enumerates device type. */
29 enum exynos_drm_device_type {
30 EXYNOS_DEVICE_TYPE_NONE,
31 EXYNOS_DEVICE_TYPE_CRTC,
32 EXYNOS_DEVICE_TYPE_CONNECTOR,
35 /* this enumerates display type. */
36 enum exynos_drm_output_type {
37 EXYNOS_DISPLAY_TYPE_NONE,
38 /* RGB or CPU Interface. */
39 EXYNOS_DISPLAY_TYPE_LCD,
41 EXYNOS_DISPLAY_TYPE_HDMI,
42 /* Virtual Display Interface. */
43 EXYNOS_DISPLAY_TYPE_VIDI,
47 * Exynos drm common overlay structure.
50 * @src_x: offset x on a framebuffer to be displayed.
51 * - the unit is screen coordinates.
52 * @src_y: offset y on a framebuffer to be displayed.
53 * - the unit is screen coordinates.
54 * @src_width: width of a partial image to be displayed from framebuffer.
55 * @src_height: height of a partial image to be displayed from framebuffer.
56 * @fb_width: width of a framebuffer.
57 * @fb_height: height of a framebuffer.
58 * @crtc_x: offset x on hardware screen.
59 * @crtc_y: offset y on hardware screen.
60 * @crtc_width: window width to be displayed (hardware screen).
61 * @crtc_height: window height to be displayed (hardware screen).
62 * @mode_width: width of screen mode.
63 * @mode_height: height of screen mode.
64 * @refresh: refresh rate.
65 * @scan_flag: interlace or progressive way.
66 * (it could be DRM_MODE_FLAG_*)
67 * @bpp: pixel size.(in bit)
68 * @pixel_format: fourcc pixel format of this overlay
69 * @dma_addr: array of bus(accessed by dma) address to the memory region
70 * allocated for a overlay.
71 * @zpos: order of overlay layer(z position).
72 * @index_color: if using color key feature then this value would be used
74 * @default_win: a window to be enabled.
75 * @color_key: color key on or off.
76 * @local_path: in case of lcd type, local path mode on or off.
77 * @transparency: transparency on or off.
78 * @activated: activated or not.
79 * @enabled: enabled or not.
80 * @resume: to resume 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 src_width;
91 unsigned int src_height;
92 unsigned int fb_width;
93 unsigned int fb_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;
119 * Exynos DRM Display Structure.
120 * - this structure is common to analog tv, digital tv and lcd panel.
122 * @create_connector: initialize and register a new connector
123 * @remove: cleans up the display for removal
124 * @mode_fixup: fix mode data comparing to hw specific display mode.
125 * @mode_set: convert drm_display_mode to hw specific display mode and
126 * would be called by encoder->mode_set().
127 * @check_mode: check if mode is valid or not.
128 * @dpms: display device on or off.
129 * @commit: apply changes to hw
131 struct exynos_drm_display;
132 struct exynos_drm_display_ops {
133 int (*create_connector)(struct exynos_drm_display *display,
134 struct drm_encoder *encoder);
135 void (*remove)(struct exynos_drm_display *display);
136 void (*mode_fixup)(struct exynos_drm_display *display,
137 struct drm_connector *connector,
138 const struct drm_display_mode *mode,
139 struct drm_display_mode *adjusted_mode);
140 void (*mode_set)(struct exynos_drm_display *display,
141 struct drm_display_mode *mode);
142 int (*check_mode)(struct exynos_drm_display *display,
143 struct drm_display_mode *mode);
144 void (*dpms)(struct exynos_drm_display *display, int mode);
145 void (*commit)(struct exynos_drm_display *display);
149 * Exynos drm display structure, maps 1:1 with an encoder/connector
151 * @list: the list entry for this manager
152 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
153 * @encoder: encoder object this display maps to
154 * @connector: connector object this display maps to
155 * @ops: pointer to callbacks for exynos drm specific functionality
156 * @ctx: A pointer to the display's implementation specific context
158 struct exynos_drm_display {
159 struct list_head list;
160 enum exynos_drm_output_type type;
161 struct drm_encoder *encoder;
162 struct drm_connector *connector;
163 struct exynos_drm_display_ops *ops;
167 * Exynos drm crtc ops
169 * @dpms: control device power.
170 * @mode_fixup: fix mode data before applying it
171 * @commit: set current hw specific display mode to hw.
172 * @enable_vblank: specific driver callback for enabling vblank interrupt.
173 * @disable_vblank: specific driver callback for disabling vblank interrupt.
174 * @wait_for_vblank: wait for vblank interrupt to make sure that
175 * hardware overlay is updated.
176 * @win_commit: apply hardware specific overlay data to registers.
177 * @win_disable: disable hardware specific overlay.
178 * @te_handler: trigger to transfer video image at the tearing effect
179 * synchronization signal if there is a page flip request.
181 struct exynos_drm_crtc;
182 struct exynos_drm_crtc_ops {
183 void (*dpms)(struct exynos_drm_crtc *crtc, int mode);
184 bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
185 const struct drm_display_mode *mode,
186 struct drm_display_mode *adjusted_mode);
187 void (*commit)(struct exynos_drm_crtc *crtc);
188 int (*enable_vblank)(struct exynos_drm_crtc *crtc);
189 void (*disable_vblank)(struct exynos_drm_crtc *crtc);
190 void (*wait_for_vblank)(struct exynos_drm_crtc *crtc);
191 void (*win_commit)(struct exynos_drm_crtc *crtc, unsigned int zpos);
192 void (*win_disable)(struct exynos_drm_crtc *crtc, unsigned int zpos);
193 void (*te_handler)(struct exynos_drm_crtc *crtc);
197 * Exynos specific crtc structure.
199 * @base: crtc object.
200 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
201 * @pipe: a crtc index created at load() with a new crtc object creation
202 * and the crtc object would be set to private->crtc array
203 * to get a crtc object corresponding to this pipe from private->crtc
204 * array when irq interrupt occurred. the reason of using this pipe is that
205 * drm framework doesn't support multiple irq yet.
206 * we can refer to the crtc to current hardware interrupt occurred through
208 * @dpms: store the crtc dpms value
209 * @event: vblank event that is currently queued for flip
210 * @ops: pointer to callbacks for exynos drm specific functionality
211 * @ctx: A pointer to the crtc's implementation specific context
213 struct exynos_drm_crtc {
214 struct drm_crtc base;
215 enum exynos_drm_output_type type;
218 wait_queue_head_t pending_flip_queue;
219 struct drm_pending_vblank_event *event;
220 struct exynos_drm_crtc_ops *ops;
224 struct exynos_drm_g2d_private {
226 struct list_head inuse_cmdlist;
227 struct list_head event_list;
228 struct list_head userptr_list;
231 struct drm_exynos_file_private {
232 struct exynos_drm_g2d_private *g2d_priv;
233 struct device *ipp_dev;
237 * Exynos drm private structure.
239 * @da_start: start address to device address space.
240 * with iommu, device address space starts from this address
241 * otherwise default one.
242 * @da_space_size: size of device address space.
243 * if 0 then default value is used for it.
244 * @pipe: the pipe number for this crtc/manager.
246 struct exynos_drm_private {
247 struct drm_fb_helper *fb_helper;
250 * created crtc object would be contained at this array and
251 * this array is used to be aware of which crtc did it request vblank.
253 struct drm_crtc *crtc[MAX_CRTC];
254 struct drm_property *plane_zpos_property;
256 unsigned long da_start;
257 unsigned long da_space_size;
263 * Exynos drm sub driver structure.
265 * @list: sub driver has its own list object to register to exynos drm driver.
266 * @dev: pointer to device object for subdrv device driver.
267 * @drm_dev: pointer to drm_device and this pointer would be set
268 * when sub driver calls exynos_drm_subdrv_register().
269 * @probe: this callback would be called by exynos drm driver after
270 * subdrv is registered to it.
271 * @remove: this callback is used to release resources created
273 * @open: this would be called with drm device file open.
274 * @close: this would be called with drm device file close.
276 struct exynos_drm_subdrv {
277 struct list_head list;
279 struct drm_device *drm_dev;
281 int (*probe)(struct drm_device *drm_dev, struct device *dev);
282 void (*remove)(struct drm_device *drm_dev, struct device *dev);
283 int (*open)(struct drm_device *drm_dev, struct device *dev,
284 struct drm_file *file);
285 void (*close)(struct drm_device *drm_dev, struct device *dev,
286 struct drm_file *file);
289 /* This function would be called by non kms drivers such as g2d and ipp. */
290 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
292 /* this function removes subdrv list from exynos drm driver */
293 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
295 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
296 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
297 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
298 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
300 #ifdef CONFIG_DRM_EXYNOS_IPP
301 int exynos_platform_device_ipp_register(void);
302 void exynos_platform_device_ipp_unregister(void);
304 static inline int exynos_platform_device_ipp_register(void) { return 0; }
305 static inline void exynos_platform_device_ipp_unregister(void) {}
309 #ifdef CONFIG_DRM_EXYNOS_DPI
310 struct exynos_drm_display * exynos_dpi_probe(struct device *dev);
311 int exynos_dpi_remove(struct exynos_drm_display *display);
313 static inline struct exynos_drm_display *
314 exynos_dpi_probe(struct device *dev) { return NULL; }
315 static inline int exynos_dpi_remove(struct exynos_drm_display *display)
321 #ifdef CONFIG_DRM_EXYNOS_VIDI
322 int exynos_drm_probe_vidi(void);
323 void exynos_drm_remove_vidi(void);
325 static inline int exynos_drm_probe_vidi(void) { return 0; }
326 static inline void exynos_drm_remove_vidi(void) {}
329 /* This function creates a encoder and a connector, and initializes them. */
330 int exynos_drm_create_enc_conn(struct drm_device *dev,
331 struct exynos_drm_display *display);
333 int exynos_drm_component_add(struct device *dev,
334 enum exynos_drm_device_type dev_type,
335 enum exynos_drm_output_type out_type);
337 void exynos_drm_component_del(struct device *dev,
338 enum exynos_drm_device_type dev_type);
340 extern struct platform_driver fimd_driver;
341 extern struct platform_driver decon_driver;
342 extern struct platform_driver dp_driver;
343 extern struct platform_driver dsi_driver;
344 extern struct platform_driver mixer_driver;
345 extern struct platform_driver hdmi_driver;
346 extern struct platform_driver exynos_drm_common_hdmi_driver;
347 extern struct platform_driver vidi_driver;
348 extern struct platform_driver g2d_driver;
349 extern struct platform_driver fimc_driver;
350 extern struct platform_driver rotator_driver;
351 extern struct platform_driver gsc_driver;
352 extern struct platform_driver ipp_driver;