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 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice (including the next
17 * paragraph) shall be included in all copies or substantial portions of the
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
29 #ifndef _EXYNOS_DRM_DRV_H_
30 #define _EXYNOS_DRM_DRV_H_
32 #include <linux/module.h>
37 #define MAX_FB_BUFFER 4
38 #define DEFAULT_ZPOS -1
41 struct exynos_drm_overlay
;
44 extern unsigned int drm_vblank_offdelay
;
46 /* this enumerates display type. */
47 enum exynos_drm_output_type
{
48 EXYNOS_DISPLAY_TYPE_NONE
,
49 /* RGB or CPU Interface. */
50 EXYNOS_DISPLAY_TYPE_LCD
,
52 EXYNOS_DISPLAY_TYPE_HDMI
,
53 /* Virtual Display Interface. */
54 EXYNOS_DISPLAY_TYPE_VIDI
,
58 * Exynos drm overlay ops structure.
60 * @mode_set: copy drm overlay info to hw specific overlay info.
61 * @commit: apply hardware specific overlay data to registers.
62 * @enable: enable hardware specific overlay.
63 * @disable: disable hardware specific overlay.
65 struct exynos_drm_overlay_ops
{
66 void (*mode_set
)(struct device
*subdrv_dev
,
67 struct exynos_drm_overlay
*overlay
);
68 void (*commit
)(struct device
*subdrv_dev
, int zpos
);
69 void (*enable
)(struct device
*subdrv_dev
, int zpos
);
70 void (*disable
)(struct device
*subdrv_dev
, int zpos
);
74 * Exynos drm common overlay structure.
76 * @fb_x: offset x on a framebuffer to be displayed.
77 * - the unit is screen coordinates.
78 * @fb_y: offset y on a framebuffer to be displayed.
79 * - the unit is screen coordinates.
80 * @fb_width: width of a framebuffer.
81 * @fb_height: height of a framebuffer.
82 * @src_width: width of a partial image to be displayed from framebuffer.
83 * @src_height: height of a partial image to be displayed from framebuffer.
84 * @crtc_x: offset x on hardware screen.
85 * @crtc_y: offset y on hardware screen.
86 * @crtc_width: window width to be displayed (hardware screen).
87 * @crtc_height: window height to be displayed (hardware screen).
88 * @mode_width: width of screen mode.
89 * @mode_height: height of screen mode.
90 * @refresh: refresh rate.
91 * @scan_flag: interlace or progressive way.
92 * (it could be DRM_MODE_FLAG_*)
93 * @bpp: pixel size.(in bit)
94 * @pixel_format: fourcc pixel format of this overlay
95 * @dma_addr: array of bus(accessed by dma) address to the memory region
96 * allocated for a overlay.
97 * @vaddr: array of virtual memory addresss to this overlay.
98 * @zpos: order of overlay layer(z position).
99 * @default_win: a window to be enabled.
100 * @color_key: color key on or off.
101 * @index_color: if using color key feature then this value would be used
103 * @local_path: in case of lcd type, local path mode on or off.
104 * @transparency: transparency on or off.
105 * @activated: activated or not.
107 * this structure is common to exynos SoC and its contents would be copied
108 * to hardware specific overlay info.
110 struct exynos_drm_overlay
{
113 unsigned int fb_width
;
114 unsigned int fb_height
;
115 unsigned int src_width
;
116 unsigned int src_height
;
119 unsigned int crtc_width
;
120 unsigned int crtc_height
;
121 unsigned int mode_width
;
122 unsigned int mode_height
;
123 unsigned int refresh
;
124 unsigned int scan_flag
;
127 uint32_t pixel_format
;
128 dma_addr_t dma_addr
[MAX_FB_BUFFER
];
129 void __iomem
*vaddr
[MAX_FB_BUFFER
];
134 unsigned int index_color
;
141 * Exynos DRM Display Structure.
142 * - this structure is common to analog tv, digital tv and lcd panel.
144 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
145 * @is_connected: check for that display is connected or not.
146 * @get_edid: get edid modes from display driver.
147 * @get_panel: get panel object from display driver.
148 * @check_timing: check if timing is valid or not.
149 * @power_on: display device on or off.
151 struct exynos_drm_display_ops
{
152 enum exynos_drm_output_type type
;
153 bool (*is_connected
)(struct device
*dev
);
154 int (*get_edid
)(struct device
*dev
, struct drm_connector
*connector
,
156 void *(*get_panel
)(struct device
*dev
);
157 int (*check_timing
)(struct device
*dev
, void *timing
);
158 int (*power_on
)(struct device
*dev
, int mode
);
162 * Exynos drm manager ops
164 * @dpms: control device power.
165 * @apply: set timing, vblank and overlay data to registers.
166 * @mode_fixup: fix mode data comparing to hw specific display mode.
167 * @mode_set: convert drm_display_mode to hw specific display mode and
168 * would be called by encoder->mode_set().
169 * @get_max_resol: get maximum resolution to specific hardware.
170 * @commit: set current hw specific display mode to hw.
171 * @enable_vblank: specific driver callback for enabling vblank interrupt.
172 * @disable_vblank: specific driver callback for disabling vblank interrupt.
174 struct exynos_drm_manager_ops
{
175 void (*dpms
)(struct device
*subdrv_dev
, int mode
);
176 void (*apply
)(struct device
*subdrv_dev
);
177 void (*mode_fixup
)(struct device
*subdrv_dev
,
178 struct drm_connector
*connector
,
179 const struct drm_display_mode
*mode
,
180 struct drm_display_mode
*adjusted_mode
);
181 void (*mode_set
)(struct device
*subdrv_dev
, void *mode
);
182 void (*get_max_resol
)(struct device
*subdrv_dev
, unsigned int *width
,
183 unsigned int *height
);
184 void (*commit
)(struct device
*subdrv_dev
);
185 int (*enable_vblank
)(struct device
*subdrv_dev
);
186 void (*disable_vblank
)(struct device
*subdrv_dev
);
190 * Exynos drm common manager structure.
192 * @dev: pointer to device object for subdrv device driver.
193 * sub drivers such as display controller or hdmi driver,
194 * have their own device object.
195 * @ops: pointer to callbacks for exynos drm specific framebuffer.
196 * these callbacks should be set by specific drivers such fimd
197 * or hdmi driver and are used to control hardware global registers.
198 * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer.
199 * these callbacks should be set by specific drivers such fimd
200 * or hdmi driver and are used to control hardware overlay reigsters.
201 * @display: pointer to callbacks for exynos drm specific framebuffer.
202 * these callbacks should be set by specific drivers such fimd
203 * or hdmi driver and are used to control display devices such as
204 * analog tv, digital tv and lcd panel and also get timing data for them.
206 struct exynos_drm_manager
{
209 struct exynos_drm_manager_ops
*ops
;
210 struct exynos_drm_overlay_ops
*overlay_ops
;
211 struct exynos_drm_display_ops
*display_ops
;
214 struct exynos_drm_g2d_private
{
216 struct list_head inuse_cmdlist
;
217 struct list_head event_list
;
218 struct list_head gem_list
;
222 struct drm_exynos_file_private
{
223 struct exynos_drm_g2d_private
*g2d_priv
;
227 * Exynos drm private structure.
229 struct exynos_drm_private
{
230 struct drm_fb_helper
*fb_helper
;
232 /* list head for new event to be added. */
233 struct list_head pageflip_event_list
;
236 * created crtc object would be contained at this array and
237 * this array is used to be aware of which crtc did it request vblank.
239 struct drm_crtc
*crtc
[MAX_CRTC
];
240 struct drm_property
*plane_zpos_property
;
241 struct drm_property
*crtc_mode_property
;
245 * Exynos drm sub driver structure.
247 * @list: sub driver has its own list object to register to exynos drm driver.
248 * @dev: pointer to device object for subdrv device driver.
249 * @drm_dev: pointer to drm_device and this pointer would be set
250 * when sub driver calls exynos_drm_subdrv_register().
251 * @manager: subdrv has its own manager to control a hardware appropriately
252 * and we can access a hardware drawing on this manager.
253 * @probe: this callback would be called by exynos drm driver after
254 * subdrv is registered to it.
255 * @remove: this callback is used to release resources created
257 * @open: this would be called with drm device file open.
258 * @close: this would be called with drm device file close.
259 * @encoder: encoder object owned by this sub driver.
260 * @connector: connector object owned by this sub driver.
262 struct exynos_drm_subdrv
{
263 struct list_head list
;
265 struct drm_device
*drm_dev
;
266 struct exynos_drm_manager
*manager
;
268 int (*probe
)(struct drm_device
*drm_dev
, struct device
*dev
);
269 void (*remove
)(struct drm_device
*dev
);
270 int (*open
)(struct drm_device
*drm_dev
, struct device
*dev
,
271 struct drm_file
*file
);
272 void (*close
)(struct drm_device
*drm_dev
, struct device
*dev
,
273 struct drm_file
*file
);
275 struct drm_encoder
*encoder
;
276 struct drm_connector
*connector
;
280 * this function calls a probe callback registered to sub driver list and
281 * create its own encoder and connector and then set drm_device object
284 int exynos_drm_device_register(struct drm_device
*dev
);
286 * this function calls a remove callback registered to sub driver list and
287 * destroy its own encoder and connetor.
289 int exynos_drm_device_unregister(struct drm_device
*dev
);
292 * this function would be called by sub drivers such as display controller
293 * or hdmi driver to register this sub driver object to exynos drm driver
294 * and when a sub driver is registered to exynos drm driver a probe callback
295 * of the sub driver is called and creates its own encoder and connector.
297 int exynos_drm_subdrv_register(struct exynos_drm_subdrv
*drm_subdrv
);
299 /* this function removes subdrv list from exynos drm driver */
300 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv
*drm_subdrv
);
302 int exynos_drm_subdrv_open(struct drm_device
*dev
, struct drm_file
*file
);
303 void exynos_drm_subdrv_close(struct drm_device
*dev
, struct drm_file
*file
);
305 extern struct platform_driver fimd_driver
;
306 extern struct platform_driver hdmi_driver
;
307 extern struct platform_driver mixer_driver
;
308 extern struct platform_driver exynos_drm_common_hdmi_driver
;
309 extern struct platform_driver vidi_driver
;
310 extern struct platform_driver g2d_driver
;