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 display type. */
29 enum exynos_drm_output_type {
30 EXYNOS_DISPLAY_TYPE_NONE,
31 /* RGB or CPU Interface. */
32 EXYNOS_DISPLAY_TYPE_LCD,
34 EXYNOS_DISPLAY_TYPE_HDMI,
35 /* Virtual Display Interface. */
36 EXYNOS_DISPLAY_TYPE_VIDI,
40 * Exynos drm common overlay structure.
43 * @src_x: offset x on a framebuffer to be displayed.
44 * - the unit is screen coordinates.
45 * @src_y: offset y on a framebuffer to be displayed.
46 * - the unit is screen coordinates.
47 * @src_w: width of a partial image to be displayed from framebuffer.
48 * @src_h: height of a partial image to be displayed from framebuffer.
49 * @crtc_x: offset x on hardware screen.
50 * @crtc_y: offset y on hardware screen.
51 * @crtc_w: window width to be displayed (hardware screen).
52 * @crtc_h: window height to be displayed (hardware screen).
53 * @h_ratio: horizontal scaling ratio, 16.16 fixed point
54 * @v_ratio: vertical scaling ratio, 16.16 fixed point
55 * @dma_addr: array of bus(accessed by dma) address to the memory region
56 * allocated for a overlay.
57 * @zpos: order of overlay layer(z position).
59 * this structure is common to exynos SoC and its contents would be copied
60 * to hardware specific overlay info.
63 struct exynos_drm_plane {
64 struct drm_plane base;
75 dma_addr_t dma_addr[MAX_FB_BUFFER];
80 * Exynos DRM Display Structure.
81 * - this structure is common to analog tv, digital tv and lcd panel.
83 * @create_connector: initialize and register a new connector
84 * @remove: cleans up the display for removal
85 * @mode_fixup: fix mode data comparing to hw specific display mode.
86 * @mode_set: convert drm_display_mode to hw specific display mode and
87 * would be called by encoder->mode_set().
88 * @check_mode: check if mode is valid or not.
89 * @dpms: display device on or off.
90 * @commit: apply changes to hw
92 struct exynos_drm_display;
93 struct exynos_drm_display_ops {
94 int (*create_connector)(struct exynos_drm_display *display,
95 struct drm_encoder *encoder);
96 void (*remove)(struct exynos_drm_display *display);
97 void (*mode_fixup)(struct exynos_drm_display *display,
98 struct drm_connector *connector,
99 const struct drm_display_mode *mode,
100 struct drm_display_mode *adjusted_mode);
101 void (*mode_set)(struct exynos_drm_display *display,
102 struct drm_display_mode *mode);
103 int (*check_mode)(struct exynos_drm_display *display,
104 struct drm_display_mode *mode);
105 void (*dpms)(struct exynos_drm_display *display, int mode);
106 void (*commit)(struct exynos_drm_display *display);
110 * Exynos drm display structure, maps 1:1 with an encoder/connector
112 * @list: the list entry for this manager
113 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
114 * @encoder: encoder object this display maps to
115 * @connector: connector object this display maps to
116 * @ops: pointer to callbacks for exynos drm specific functionality
117 * @ctx: A pointer to the display's implementation specific context
119 struct exynos_drm_display {
120 struct list_head list;
121 enum exynos_drm_output_type type;
122 struct drm_encoder *encoder;
123 struct drm_connector *connector;
124 struct exynos_drm_display_ops *ops;
128 * Exynos drm crtc ops
130 * @enable: enable the device
131 * @disable: disable the device
132 * @mode_fixup: fix mode data before applying it
133 * @commit: set current hw specific display mode to hw.
134 * @enable_vblank: specific driver callback for enabling vblank interrupt.
135 * @disable_vblank: specific driver callback for disabling vblank interrupt.
136 * @wait_for_vblank: wait for vblank interrupt to make sure that
137 * hardware overlay is updated.
138 * @update_plane: apply hardware specific overlay data to registers.
139 * @disable_plane: disable hardware specific overlay.
140 * @te_handler: trigger to transfer video image at the tearing effect
141 * synchronization signal if there is a page flip request.
142 * @clock_enable: optional function enabling/disabling display domain clock,
143 * called from exynos-dp driver before powering up (with
144 * 'enable' argument as true) and after powering down (with
145 * 'enable' as false).
147 struct exynos_drm_crtc;
148 struct exynos_drm_crtc_ops {
149 void (*enable)(struct exynos_drm_crtc *crtc);
150 void (*disable)(struct exynos_drm_crtc *crtc);
151 bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
152 const struct drm_display_mode *mode,
153 struct drm_display_mode *adjusted_mode);
154 void (*commit)(struct exynos_drm_crtc *crtc);
155 int (*enable_vblank)(struct exynos_drm_crtc *crtc);
156 void (*disable_vblank)(struct exynos_drm_crtc *crtc);
157 void (*wait_for_vblank)(struct exynos_drm_crtc *crtc);
158 void (*update_plane)(struct exynos_drm_crtc *crtc,
159 struct exynos_drm_plane *plane);
160 void (*disable_plane)(struct exynos_drm_crtc *crtc,
161 struct exynos_drm_plane *plane);
162 void (*te_handler)(struct exynos_drm_crtc *crtc);
163 void (*clock_enable)(struct exynos_drm_crtc *crtc, bool enable);
167 * Exynos specific crtc structure.
169 * @base: crtc object.
170 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
171 * @pipe: a crtc index created at load() with a new crtc object creation
172 * and the crtc object would be set to private->crtc array
173 * to get a crtc object corresponding to this pipe from private->crtc
174 * array when irq interrupt occurred. the reason of using this pipe is that
175 * drm framework doesn't support multiple irq yet.
176 * we can refer to the crtc to current hardware interrupt occurred through
178 * @enabled: if the crtc is enabled or not
179 * @event: vblank event that is currently queued for flip
180 * @ops: pointer to callbacks for exynos drm specific functionality
181 * @ctx: A pointer to the crtc's implementation specific context
183 struct exynos_drm_crtc {
184 struct drm_crtc base;
185 enum exynos_drm_output_type type;
188 wait_queue_head_t pending_flip_queue;
189 struct drm_pending_vblank_event *event;
190 const struct exynos_drm_crtc_ops *ops;
194 struct exynos_drm_g2d_private {
196 struct list_head inuse_cmdlist;
197 struct list_head event_list;
198 struct list_head userptr_list;
201 struct drm_exynos_file_private {
202 struct exynos_drm_g2d_private *g2d_priv;
203 struct device *ipp_dev;
207 * Exynos drm private structure.
209 * @da_start: start address to device address space.
210 * with iommu, device address space starts from this address
211 * otherwise default one.
212 * @da_space_size: size of device address space.
213 * if 0 then default value is used for it.
214 * @pipe: the pipe number for this crtc/manager.
216 struct exynos_drm_private {
217 struct drm_fb_helper *fb_helper;
220 * created crtc object would be contained at this array and
221 * this array is used to be aware of which crtc did it request vblank.
223 struct drm_crtc *crtc[MAX_CRTC];
224 struct drm_property *plane_zpos_property;
226 unsigned long da_start;
227 unsigned long da_space_size;
233 * Exynos drm sub driver structure.
235 * @list: sub driver has its own list object to register to exynos drm driver.
236 * @dev: pointer to device object for subdrv device driver.
237 * @drm_dev: pointer to drm_device and this pointer would be set
238 * when sub driver calls exynos_drm_subdrv_register().
239 * @probe: this callback would be called by exynos drm driver after
240 * subdrv is registered to it.
241 * @remove: this callback is used to release resources created
243 * @open: this would be called with drm device file open.
244 * @close: this would be called with drm device file close.
246 struct exynos_drm_subdrv {
247 struct list_head list;
249 struct drm_device *drm_dev;
251 int (*probe)(struct drm_device *drm_dev, struct device *dev);
252 void (*remove)(struct drm_device *drm_dev, struct device *dev);
253 int (*open)(struct drm_device *drm_dev, struct device *dev,
254 struct drm_file *file);
255 void (*close)(struct drm_device *drm_dev, struct device *dev,
256 struct drm_file *file);
259 /* This function would be called by non kms drivers such as g2d and ipp. */
260 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
262 /* this function removes subdrv list from exynos drm driver */
263 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
265 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
266 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
267 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
268 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
270 #ifdef CONFIG_DRM_EXYNOS_DPI
271 struct exynos_drm_display * exynos_dpi_probe(struct device *dev);
272 int exynos_dpi_remove(struct exynos_drm_display *display);
274 static inline struct exynos_drm_display *
275 exynos_dpi_probe(struct device *dev) { return NULL; }
276 static inline int exynos_dpi_remove(struct exynos_drm_display *display)
282 /* This function creates a encoder and a connector, and initializes them. */
283 int exynos_drm_create_enc_conn(struct drm_device *dev,
284 struct exynos_drm_display *display);
286 extern struct platform_driver fimd_driver;
287 extern struct platform_driver exynos5433_decon_driver;
288 extern struct platform_driver decon_driver;
289 extern struct platform_driver dp_driver;
290 extern struct platform_driver dsi_driver;
291 extern struct platform_driver mixer_driver;
292 extern struct platform_driver hdmi_driver;
293 extern struct platform_driver exynos_drm_common_hdmi_driver;
294 extern struct platform_driver vidi_driver;
295 extern struct platform_driver g2d_driver;
296 extern struct platform_driver fimc_driver;
297 extern struct platform_driver rotator_driver;
298 extern struct platform_driver gsc_driver;
299 extern struct platform_driver ipp_driver;
300 extern struct platform_driver mic_driver;