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