exynos/fimd: add parallel output related bindings
[linux-2.6-block.git] / drivers / gpu / drm / exynos / exynos_drm_drv.h
CommitLineData
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 *
d81aecb5
ID
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.
1c248b7d
ID
13 */
14
15#ifndef _EXYNOS_DRM_DRV_H_
16#define _EXYNOS_DRM_DRV_H_
17
4f9eb94f 18#include <linux/module.h>
1c248b7d 19
b73d1230 20#define MAX_CRTC 3
864ee9e6 21#define MAX_PLANE 5
b73d1230 22#define MAX_FB_BUFFER 4
864ee9e6 23#define DEFAULT_ZPOS -1
1c248b7d 24
b011941f
ID
25#define _wait_for(COND, MS) ({ \
26 unsigned long timeout__ = jiffies + msecs_to_jiffies(MS); \
27 int ret__ = 0; \
28 while (!(COND)) { \
29 if (time_after(jiffies, timeout__)) { \
30 ret__ = -ETIMEDOUT; \
31 break; \
32 } \
33 } \
34 ret__; \
35})
36
37#define wait_for(COND, MS) _wait_for(COND, MS)
38
1c248b7d
ID
39struct drm_device;
40struct exynos_drm_overlay;
41struct drm_connector;
42
52c68814
ID
43extern unsigned int drm_vblank_offdelay;
44
1c248b7d
ID
45/* this enumerates display type. */
46enum exynos_drm_output_type {
47 EXYNOS_DISPLAY_TYPE_NONE,
48 /* RGB or CPU Interface. */
49 EXYNOS_DISPLAY_TYPE_LCD,
50 /* HDMI Interface. */
51 EXYNOS_DISPLAY_TYPE_HDMI,
b73d1230
ID
52 /* Virtual Display Interface. */
53 EXYNOS_DISPLAY_TYPE_VIDI,
1c248b7d
ID
54};
55
1c248b7d
ID
56/*
57 * Exynos drm common overlay structure.
58 *
19c8b834
ID
59 * @fb_x: offset x on a framebuffer to be displayed.
60 * - the unit is screen coordinates.
61 * @fb_y: offset y on a framebuffer to be displayed.
62 * - the unit is screen coordinates.
63 * @fb_width: width of a framebuffer.
64 * @fb_height: height of a framebuffer.
0d8071ee
SWK
65 * @src_width: width of a partial image to be displayed from framebuffer.
66 * @src_height: height of a partial image to be displayed from framebuffer.
19c8b834
ID
67 * @crtc_x: offset x on hardware screen.
68 * @crtc_y: offset y on hardware screen.
69 * @crtc_width: window width to be displayed (hardware screen).
70 * @crtc_height: window height to be displayed (hardware screen).
71 * @mode_width: width of screen mode.
72 * @mode_height: height of screen mode.
73 * @refresh: refresh rate.
74 * @scan_flag: interlace or progressive way.
75 * (it could be DRM_MODE_FLAG_*)
1c248b7d 76 * @bpp: pixel size.(in bit)
229d3534
SWK
77 * @pixel_format: fourcc pixel format of this overlay
78 * @dma_addr: array of bus(accessed by dma) address to the memory region
79 * allocated for a overlay.
864ee9e6 80 * @zpos: order of overlay layer(z position).
1c248b7d
ID
81 * @default_win: a window to be enabled.
82 * @color_key: color key on or off.
83 * @index_color: if using color key feature then this value would be used
84 * as index color.
85 * @local_path: in case of lcd type, local path mode on or off.
86 * @transparency: transparency on or off.
87 * @activated: activated or not.
88 *
89 * this structure is common to exynos SoC and its contents would be copied
90 * to hardware specific overlay info.
91 */
92struct exynos_drm_overlay {
19c8b834
ID
93 unsigned int fb_x;
94 unsigned int fb_y;
95 unsigned int fb_width;
96 unsigned int fb_height;
0d8071ee
SWK
97 unsigned int src_width;
98 unsigned int src_height;
19c8b834
ID
99 unsigned int crtc_x;
100 unsigned int crtc_y;
101 unsigned int crtc_width;
102 unsigned int crtc_height;
103 unsigned int mode_width;
104 unsigned int mode_height;
105 unsigned int refresh;
106 unsigned int scan_flag;
1c248b7d 107 unsigned int bpp;
19c8b834 108 unsigned int pitch;
229d3534
SWK
109 uint32_t pixel_format;
110 dma_addr_t dma_addr[MAX_FB_BUFFER];
864ee9e6 111 int zpos;
1c248b7d
ID
112
113 bool default_win;
114 bool color_key;
115 unsigned int index_color;
116 bool local_path;
117 bool transparency;
118 bool activated;
119};
120
121/*
122 * Exynos DRM Display Structure.
123 * - this structure is common to analog tv, digital tv and lcd panel.
124 *
1f9cafc3 125 * @initialize: initializes the display with drm_dev
080be03d 126 * @remove: cleans up the display for removal
080be03d
SP
127 * @mode_fixup: fix mode data comparing to hw specific display mode.
128 * @mode_set: convert drm_display_mode to hw specific display mode and
129 * would be called by encoder->mode_set().
16844fb1 130 * @check_mode: check if mode is valid or not.
54c40ded 131 * @dpms: display device on or off.
080be03d 132 * @commit: apply changes to hw
1c248b7d 133 */
080be03d 134struct exynos_drm_display;
74ccc539 135struct exynos_drm_display_ops {
080be03d
SP
136 int (*initialize)(struct exynos_drm_display *display,
137 struct drm_device *drm_dev);
c37f42cd
SP
138 int (*create_connector)(struct exynos_drm_display *display,
139 struct drm_encoder *encoder);
080be03d 140 void (*remove)(struct exynos_drm_display *display);
080be03d
SP
141 void (*mode_fixup)(struct exynos_drm_display *display,
142 struct drm_connector *connector,
143 const struct drm_display_mode *mode,
144 struct drm_display_mode *adjusted_mode);
145 void (*mode_set)(struct exynos_drm_display *display,
146 struct drm_display_mode *mode);
147 int (*check_mode)(struct exynos_drm_display *display,
148 struct drm_display_mode *mode);
149 void (*dpms)(struct exynos_drm_display *display, int mode);
150 void (*commit)(struct exynos_drm_display *display);
151};
152
153/*
154 * Exynos drm display structure, maps 1:1 with an encoder/connector
155 *
156 * @list: the list entry for this manager
157 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
158 * @encoder: encoder object this display maps to
159 * @connector: connector object this display maps to
160 * @ops: pointer to callbacks for exynos drm specific functionality
161 * @ctx: A pointer to the display's implementation specific context
162 */
163struct exynos_drm_display {
164 struct list_head list;
1c248b7d 165 enum exynos_drm_output_type type;
080be03d
SP
166 struct drm_encoder *encoder;
167 struct drm_connector *connector;
168 struct exynos_drm_display_ops *ops;
169 void *ctx;
1c248b7d
ID
170};
171
172/*
173 * Exynos drm manager ops
174 *
1f9cafc3 175 * @initialize: initializes the manager with drm_dev
080be03d 176 * @remove: cleans up the manager for removal
ec05da95 177 * @dpms: control device power.
4b405269 178 * @mode_fixup: fix mode data before applying it
cd706aa8 179 * @mode_set: set the given mode to the manager
1c248b7d
ID
180 * @commit: set current hw specific display mode to hw.
181 * @enable_vblank: specific driver callback for enabling vblank interrupt.
182 * @disable_vblank: specific driver callback for disabling vblank interrupt.
f74085a9
P
183 * @wait_for_vblank: wait for vblank interrupt to make sure that
184 * hardware overlay is updated.
1c6244c3
SP
185 * @win_mode_set: copy drm overlay info to hw specific overlay info.
186 * @win_commit: apply hardware specific overlay data to registers.
187 * @win_enable: enable hardware specific overlay.
188 * @win_disable: disable hardware specific overlay.
1c248b7d 189 */
bb7704d6 190struct exynos_drm_manager;
1c248b7d 191struct exynos_drm_manager_ops {
bb7704d6 192 int (*initialize)(struct exynos_drm_manager *mgr,
080be03d
SP
193 struct drm_device *drm_dev, int pipe);
194 void (*remove)(struct exynos_drm_manager *mgr);
bb7704d6 195 void (*dpms)(struct exynos_drm_manager *mgr, int mode);
4b405269
SP
196 bool (*mode_fixup)(struct exynos_drm_manager *mgr,
197 const struct drm_display_mode *mode,
198 struct drm_display_mode *adjusted_mode);
cd706aa8
SP
199 void (*mode_set)(struct exynos_drm_manager *mgr,
200 const struct drm_display_mode *mode);
bb7704d6
SP
201 void (*commit)(struct exynos_drm_manager *mgr);
202 int (*enable_vblank)(struct exynos_drm_manager *mgr);
203 void (*disable_vblank)(struct exynos_drm_manager *mgr);
204 void (*wait_for_vblank)(struct exynos_drm_manager *mgr);
205 void (*win_mode_set)(struct exynos_drm_manager *mgr,
1c6244c3 206 struct exynos_drm_overlay *overlay);
bb7704d6
SP
207 void (*win_commit)(struct exynos_drm_manager *mgr, int zpos);
208 void (*win_enable)(struct exynos_drm_manager *mgr, int zpos);
209 void (*win_disable)(struct exynos_drm_manager *mgr, int zpos);
1c248b7d
ID
210};
211
212/*
080be03d 213 * Exynos drm common manager structure, maps 1:1 with a crtc
1c248b7d 214 *
080be03d
SP
215 * @list: the list entry for this manager
216 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
217 * @drm_dev: pointer to the drm device
218 * @pipe: the pipe number for this crtc/manager
219 * @ops: pointer to callbacks for exynos drm specific functionality
bb7704d6 220 * @ctx: A pointer to the manager's implementation specific context
1c248b7d
ID
221 */
222struct exynos_drm_manager {
080be03d
SP
223 struct list_head list;
224 enum exynos_drm_output_type type;
225 struct drm_device *drm_dev;
1c248b7d
ID
226 int pipe;
227 struct exynos_drm_manager_ops *ops;
bb7704d6 228 void *ctx;
1c248b7d
ID
229};
230
d7f1642c
JS
231struct exynos_drm_g2d_private {
232 struct device *dev;
233 struct list_head inuse_cmdlist;
234 struct list_head event_list;
2a3098ff 235 struct list_head userptr_list;
d7f1642c
JS
236};
237
cb471f14
EK
238struct exynos_drm_ipp_private {
239 struct device *dev;
240 struct list_head event_list;
241};
242
d7f1642c
JS
243struct drm_exynos_file_private {
244 struct exynos_drm_g2d_private *g2d_priv;
cb471f14 245 struct exynos_drm_ipp_private *ipp_priv;
96f54215 246 struct file *anon_filp;
d7f1642c
JS
247};
248
1c248b7d
ID
249/*
250 * Exynos drm private structure.
0519f9a1
ID
251 *
252 * @da_start: start address to device address space.
253 * with iommu, device address space starts from this address
254 * otherwise default one.
255 * @da_space_size: size of device address space.
256 * if 0 then default value is used for it.
257 * @da_space_order: order to device address space.
1c248b7d
ID
258 */
259struct exynos_drm_private {
260 struct drm_fb_helper *fb_helper;
261
ccf4d883 262 /* list head for new event to be added. */
1c248b7d 263 struct list_head pageflip_event_list;
1c248b7d
ID
264
265 /*
266 * created crtc object would be contained at this array and
267 * this array is used to be aware of which crtc did it request vblank.
268 */
269 struct drm_crtc *crtc[MAX_CRTC];
00ae67cf 270 struct drm_property *plane_zpos_property;
3b8d1cf8 271 struct drm_property *crtc_mode_property;
0519f9a1
ID
272
273 unsigned long da_start;
274 unsigned long da_space_size;
275 unsigned long da_space_order;
1c248b7d
ID
276};
277
278/*
279 * Exynos drm sub driver structure.
280 *
281 * @list: sub driver has its own list object to register to exynos drm driver.
677e84c1 282 * @dev: pointer to device object for subdrv device driver.
1c248b7d
ID
283 * @drm_dev: pointer to drm_device and this pointer would be set
284 * when sub driver calls exynos_drm_subdrv_register().
677e84c1
JS
285 * @manager: subdrv has its own manager to control a hardware appropriately
286 * and we can access a hardware drawing on this manager.
1c248b7d
ID
287 * @probe: this callback would be called by exynos drm driver after
288 * subdrv is registered to it.
289 * @remove: this callback is used to release resources created
290 * by probe callback.
9084f7b8
JS
291 * @open: this would be called with drm device file open.
292 * @close: this would be called with drm device file close.
1c248b7d
ID
293 */
294struct exynos_drm_subdrv {
295 struct list_head list;
677e84c1 296 struct device *dev;
1c248b7d
ID
297 struct drm_device *drm_dev;
298
41c24346 299 int (*probe)(struct drm_device *drm_dev, struct device *dev);
29cb6025 300 void (*remove)(struct drm_device *drm_dev, struct device *dev);
9084f7b8
JS
301 int (*open)(struct drm_device *drm_dev, struct device *dev,
302 struct drm_file *file);
303 void (*close)(struct drm_device *drm_dev, struct device *dev,
304 struct drm_file *file);
1c248b7d
ID
305};
306
307/*
308 * this function calls a probe callback registered to sub driver list and
309 * create its own encoder and connector and then set drm_device object
310 * to global one.
311 */
312int exynos_drm_device_register(struct drm_device *dev);
313/*
314 * this function calls a remove callback registered to sub driver list and
315 * destroy its own encoder and connetor.
316 */
317int exynos_drm_device_unregister(struct drm_device *dev);
318
080be03d
SP
319int exynos_drm_initialize_managers(struct drm_device *dev);
320void exynos_drm_remove_managers(struct drm_device *dev);
321int exynos_drm_initialize_displays(struct drm_device *dev);
322void exynos_drm_remove_displays(struct drm_device *dev);
323
324int exynos_drm_manager_register(struct exynos_drm_manager *manager);
325int exynos_drm_manager_unregister(struct exynos_drm_manager *manager);
326int exynos_drm_display_register(struct exynos_drm_display *display);
327int exynos_drm_display_unregister(struct exynos_drm_display *display);
328
1c248b7d
ID
329/*
330 * this function would be called by sub drivers such as display controller
331 * or hdmi driver to register this sub driver object to exynos drm driver
332 * and when a sub driver is registered to exynos drm driver a probe callback
132a5b91 333 * of the sub driver is called and creates its own encoder and connector.
1c248b7d
ID
334 */
335int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
336
132a5b91 337/* this function removes subdrv list from exynos drm driver */
1c248b7d
ID
338int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
339
9084f7b8
JS
340int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
341void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
342
ae9dace2
RS
343/*
344 * this function registers exynos drm hdmi platform device. It ensures only one
345 * instance of the device is created.
346 */
0f6f9592 347int exynos_platform_device_hdmi_register(void);
ae9dace2
RS
348
349/*
350 * this function unregisters exynos drm hdmi platform device if it exists.
351 */
352void exynos_platform_device_hdmi_unregister(void);
353
43f41900
SWK
354/*
355 * this function registers exynos drm ipp platform device.
356 */
357int exynos_platform_device_ipp_register(void);
358
359/*
360 * this function unregisters exynos drm ipp platform device if it exists.
361 */
362void exynos_platform_device_ipp_unregister(void);
363
1417f109 364extern struct platform_driver dp_driver;
132a5b91
JS
365extern struct platform_driver fimd_driver;
366extern struct platform_driver hdmi_driver;
367extern struct platform_driver mixer_driver;
368extern struct platform_driver exynos_drm_common_hdmi_driver;
b73d1230 369extern struct platform_driver vidi_driver;
d7f1642c 370extern struct platform_driver g2d_driver;
16102edb 371extern struct platform_driver fimc_driver;
bea8a429 372extern struct platform_driver rotator_driver;
f2646380 373extern struct platform_driver gsc_driver;
cb471f14 374extern struct platform_driver ipp_driver;
1c248b7d 375#endif