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 * @h_ratio: horizontal scaling ratio, 16.16 fixed point
65 * @v_ratio: vertical scaling ratio, 16.16 fixed point
66 * @refresh: refresh rate.
67 * @scan_flag: interlace or progressive way.
68 * (it could be DRM_MODE_FLAG_*)
69 * @bpp: pixel size.(in bit)
70 * @pixel_format: fourcc pixel format of this overlay
71 * @dma_addr: array of bus(accessed by dma) address to the memory region
72 * allocated for a overlay.
73 * @zpos: order of overlay layer(z position).
74 * @index_color: if using color key feature then this value would be used
76 * @default_win: a window to be enabled.
77 * @color_key: color key on or off.
78 * @local_path: in case of lcd type, local path mode on or off.
79 * @transparency: transparency on or off.
80 * @activated: activated or not.
81 * @enabled: enabled or not.
82 * @resume: to resume or not.
84 * this structure is common to exynos SoC and its contents would be copied
85 * to hardware specific overlay info.
88 struct exynos_drm_plane
{
89 struct drm_plane base
;
92 unsigned int src_width
;
93 unsigned int src_height
;
94 unsigned int fb_width
;
95 unsigned int fb_height
;
98 unsigned int crtc_width
;
99 unsigned int crtc_height
;
100 unsigned int mode_width
;
101 unsigned int mode_height
;
102 unsigned int h_ratio
;
103 unsigned int v_ratio
;
104 unsigned int refresh
;
105 unsigned int scan_flag
;
108 uint32_t pixel_format
;
109 dma_addr_t dma_addr
[MAX_FB_BUFFER
];
111 unsigned int index_color
;
123 * Exynos DRM Display Structure.
124 * - this structure is common to analog tv, digital tv and lcd panel.
126 * @create_connector: initialize and register a new connector
127 * @remove: cleans up the display for removal
128 * @mode_fixup: fix mode data comparing to hw specific display mode.
129 * @mode_set: convert drm_display_mode to hw specific display mode and
130 * would be called by encoder->mode_set().
131 * @check_mode: check if mode is valid or not.
132 * @dpms: display device on or off.
133 * @commit: apply changes to hw
135 struct exynos_drm_display
;
136 struct exynos_drm_display_ops
{
137 int (*create_connector
)(struct exynos_drm_display
*display
,
138 struct drm_encoder
*encoder
);
139 void (*remove
)(struct exynos_drm_display
*display
);
140 void (*mode_fixup
)(struct exynos_drm_display
*display
,
141 struct drm_connector
*connector
,
142 const struct drm_display_mode
*mode
,
143 struct drm_display_mode
*adjusted_mode
);
144 void (*mode_set
)(struct exynos_drm_display
*display
,
145 struct drm_display_mode
*mode
);
146 int (*check_mode
)(struct exynos_drm_display
*display
,
147 struct drm_display_mode
*mode
);
148 void (*dpms
)(struct exynos_drm_display
*display
, int mode
);
149 void (*commit
)(struct exynos_drm_display
*display
);
153 * Exynos drm display structure, maps 1:1 with an encoder/connector
155 * @list: the list entry for this manager
156 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
157 * @encoder: encoder object this display maps to
158 * @connector: connector object this display maps to
159 * @ops: pointer to callbacks for exynos drm specific functionality
160 * @ctx: A pointer to the display's implementation specific context
162 struct exynos_drm_display
{
163 struct list_head list
;
164 enum exynos_drm_output_type type
;
165 struct drm_encoder
*encoder
;
166 struct drm_connector
*connector
;
167 struct exynos_drm_display_ops
*ops
;
171 * Exynos drm crtc ops
173 * @dpms: control device power.
174 * @mode_fixup: fix mode data before applying it
175 * @commit: set current hw specific display mode to hw.
176 * @enable_vblank: specific driver callback for enabling vblank interrupt.
177 * @disable_vblank: specific driver callback for disabling vblank interrupt.
178 * @wait_for_vblank: wait for vblank interrupt to make sure that
179 * hardware overlay is updated.
180 * @win_commit: apply hardware specific overlay data to registers.
181 * @win_disable: disable hardware specific overlay.
182 * @te_handler: trigger to transfer video image at the tearing effect
183 * synchronization signal if there is a page flip request.
185 struct exynos_drm_crtc
;
186 struct exynos_drm_crtc_ops
{
187 void (*dpms
)(struct exynos_drm_crtc
*crtc
, int mode
);
188 bool (*mode_fixup
)(struct exynos_drm_crtc
*crtc
,
189 const struct drm_display_mode
*mode
,
190 struct drm_display_mode
*adjusted_mode
);
191 void (*commit
)(struct exynos_drm_crtc
*crtc
);
192 int (*enable_vblank
)(struct exynos_drm_crtc
*crtc
);
193 void (*disable_vblank
)(struct exynos_drm_crtc
*crtc
);
194 void (*wait_for_vblank
)(struct exynos_drm_crtc
*crtc
);
195 void (*win_commit
)(struct exynos_drm_crtc
*crtc
, unsigned int zpos
);
196 void (*win_disable
)(struct exynos_drm_crtc
*crtc
, unsigned 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 * @event: vblank event that is currently queued for flip
214 * @ops: pointer to callbacks for exynos drm specific functionality
215 * @ctx: A pointer to the crtc's implementation specific context
217 struct exynos_drm_crtc
{
218 struct drm_crtc base
;
219 enum exynos_drm_output_type type
;
222 wait_queue_head_t pending_flip_queue
;
223 struct drm_pending_vblank_event
*event
;
224 struct exynos_drm_crtc_ops
*ops
;
228 struct exynos_drm_g2d_private
{
230 struct list_head inuse_cmdlist
;
231 struct list_head event_list
;
232 struct list_head userptr_list
;
235 struct drm_exynos_file_private
{
236 struct exynos_drm_g2d_private
*g2d_priv
;
237 struct device
*ipp_dev
;
241 * Exynos drm private structure.
243 * @da_start: start address to device address space.
244 * with iommu, device address space starts from this address
245 * otherwise default one.
246 * @da_space_size: size of device address space.
247 * if 0 then default value is used for it.
248 * @pipe: the pipe number for this crtc/manager.
250 struct exynos_drm_private
{
251 struct drm_fb_helper
*fb_helper
;
254 * created crtc object would be contained at this array and
255 * this array is used to be aware of which crtc did it request vblank.
257 struct drm_crtc
*crtc
[MAX_CRTC
];
258 struct drm_property
*plane_zpos_property
;
260 unsigned long da_start
;
261 unsigned long da_space_size
;
267 * Exynos drm sub driver structure.
269 * @list: sub driver has its own list object to register to exynos drm driver.
270 * @dev: pointer to device object for subdrv device driver.
271 * @drm_dev: pointer to drm_device and this pointer would be set
272 * when sub driver calls exynos_drm_subdrv_register().
273 * @probe: this callback would be called by exynos drm driver after
274 * subdrv is registered to it.
275 * @remove: this callback is used to release resources created
277 * @open: this would be called with drm device file open.
278 * @close: this would be called with drm device file close.
280 struct exynos_drm_subdrv
{
281 struct list_head list
;
283 struct drm_device
*drm_dev
;
285 int (*probe
)(struct drm_device
*drm_dev
, struct device
*dev
);
286 void (*remove
)(struct drm_device
*drm_dev
, struct device
*dev
);
287 int (*open
)(struct drm_device
*drm_dev
, struct device
*dev
,
288 struct drm_file
*file
);
289 void (*close
)(struct drm_device
*drm_dev
, struct device
*dev
,
290 struct drm_file
*file
);
293 /* This function would be called by non kms drivers such as g2d and ipp. */
294 int exynos_drm_subdrv_register(struct exynos_drm_subdrv
*drm_subdrv
);
296 /* this function removes subdrv list from exynos drm driver */
297 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv
*drm_subdrv
);
299 int exynos_drm_device_subdrv_probe(struct drm_device
*dev
);
300 int exynos_drm_device_subdrv_remove(struct drm_device
*dev
);
301 int exynos_drm_subdrv_open(struct drm_device
*dev
, struct drm_file
*file
);
302 void exynos_drm_subdrv_close(struct drm_device
*dev
, struct drm_file
*file
);
304 #ifdef CONFIG_DRM_EXYNOS_IPP
305 int exynos_platform_device_ipp_register(void);
306 void exynos_platform_device_ipp_unregister(void);
308 static inline int exynos_platform_device_ipp_register(void) { return 0; }
309 static inline void exynos_platform_device_ipp_unregister(void) {}
313 #ifdef CONFIG_DRM_EXYNOS_DPI
314 struct exynos_drm_display
* exynos_dpi_probe(struct device
*dev
);
315 int exynos_dpi_remove(struct exynos_drm_display
*display
);
317 static inline struct exynos_drm_display
*
318 exynos_dpi_probe(struct device
*dev
) { return NULL
; }
319 static inline int exynos_dpi_remove(struct exynos_drm_display
*display
)
325 #ifdef CONFIG_DRM_EXYNOS_VIDI
326 int exynos_drm_probe_vidi(void);
327 void exynos_drm_remove_vidi(void);
329 static inline int exynos_drm_probe_vidi(void) { return 0; }
330 static inline void exynos_drm_remove_vidi(void) {}
333 /* This function creates a encoder and a connector, and initializes them. */
334 int exynos_drm_create_enc_conn(struct drm_device
*dev
,
335 struct exynos_drm_display
*display
);
337 int exynos_drm_component_add(struct device
*dev
,
338 enum exynos_drm_device_type dev_type
,
339 enum exynos_drm_output_type out_type
);
341 void exynos_drm_component_del(struct device
*dev
,
342 enum exynos_drm_device_type dev_type
);
344 extern struct platform_driver fimd_driver
;
345 extern struct platform_driver decon_driver
;
346 extern struct platform_driver dp_driver
;
347 extern struct platform_driver dsi_driver
;
348 extern struct platform_driver mixer_driver
;
349 extern struct platform_driver hdmi_driver
;
350 extern struct platform_driver exynos_drm_common_hdmi_driver
;
351 extern struct platform_driver vidi_driver
;
352 extern struct platform_driver g2d_driver
;
353 extern struct platform_driver fimc_driver
;
354 extern struct platform_driver rotator_driver
;
355 extern struct platform_driver gsc_driver
;
356 extern struct platform_driver ipp_driver
;