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 <drm/drmP.h>
19 #include <linux/module.h>
20 
21 #define MAX_CRTC	3
22 #define MAX_PLANE	5
23 #define MAX_FB_BUFFER	4
24 
25 #define DEFAULT_WIN	0
26 
27 #define to_exynos_crtc(x)	container_of(x, struct exynos_drm_crtc, base)
28 #define to_exynos_plane(x)	container_of(x, struct exynos_drm_plane, base)
29 
30 /* this enumerates display type. */
31 enum exynos_drm_output_type {
32 	EXYNOS_DISPLAY_TYPE_NONE,
33 	/* RGB or CPU Interface. */
34 	EXYNOS_DISPLAY_TYPE_LCD,
35 	/* HDMI Interface. */
36 	EXYNOS_DISPLAY_TYPE_HDMI,
37 	/* Virtual Display Interface. */
38 	EXYNOS_DISPLAY_TYPE_VIDI,
39 };
40 
41 struct exynos_drm_rect {
42 	unsigned int x, y;
43 	unsigned int w, h;
44 };
45 
46 /*
47  * Exynos drm plane state structure.
48  *
49  * @base: plane_state object (contains drm_framebuffer pointer)
50  * @src: rectangle of the source image data to be displayed (clipped to
51  *       visible part).
52  * @crtc: rectangle of the target image position on hardware screen
53  *       (clipped to visible part).
54  * @h_ratio: horizontal scaling ratio, 16.16 fixed point
55  * @v_ratio: vertical scaling ratio, 16.16 fixed point
56  *
57  * this structure consists plane state data that will be applied to hardware
58  * specific overlay info.
59  */
60 
61 struct exynos_drm_plane_state {
62 	struct drm_plane_state base;
63 	struct exynos_drm_rect crtc;
64 	struct exynos_drm_rect src;
65 	unsigned int h_ratio;
66 	unsigned int v_ratio;
67 	unsigned int zpos;
68 };
69 
70 static inline struct exynos_drm_plane_state *
71 to_exynos_plane_state(struct drm_plane_state *state)
72 {
73 	return container_of(state, struct exynos_drm_plane_state, base);
74 }
75 
76 /*
77  * Exynos drm common overlay structure.
78  *
79  * @base: plane object
80  * @index: hardware index of the overlay layer
81  *
82  * this structure is common to exynos SoC and its contents would be copied
83  * to hardware specific overlay info.
84  */
85 
86 struct exynos_drm_plane {
87 	struct drm_plane base;
88 	const struct exynos_drm_plane_config *config;
89 	unsigned int index;
90 	struct drm_framebuffer *pending_fb;
91 };
92 
93 #define EXYNOS_DRM_PLANE_CAP_DOUBLE	(1 << 0)
94 #define EXYNOS_DRM_PLANE_CAP_SCALE	(1 << 1)
95 #define EXYNOS_DRM_PLANE_CAP_ZPOS	(1 << 2)
96 
97 /*
98  * Exynos DRM plane configuration structure.
99  *
100  * @zpos: initial z-position of the plane.
101  * @type: type of the plane (primary, cursor or overlay).
102  * @pixel_formats: supported pixel formats.
103  * @num_pixel_formats: number of elements in 'pixel_formats'.
104  * @capabilities: supported features (see EXYNOS_DRM_PLANE_CAP_*)
105  */
106 
107 struct exynos_drm_plane_config {
108 	unsigned int zpos;
109 	enum drm_plane_type type;
110 	const uint32_t *pixel_formats;
111 	unsigned int num_pixel_formats;
112 	unsigned int capabilities;
113 };
114 
115 /*
116  * Exynos drm crtc ops
117  *
118  * @enable: enable the device
119  * @disable: disable the device
120  * @commit: set current hw specific display mode to hw.
121  * @enable_vblank: specific driver callback for enabling vblank interrupt.
122  * @disable_vblank: specific driver callback for disabling vblank interrupt.
123  * @wait_for_vblank: wait for vblank interrupt to make sure that
124  *	hardware overlay is updated.
125  * @atomic_check: validate state
126  * @atomic_begin: prepare device to receive an update
127  * @atomic_flush: mark the end of device update
128  * @update_plane: apply hardware specific overlay data to registers.
129  * @disable_plane: disable hardware specific overlay.
130  * @te_handler: trigger to transfer video image at the tearing effect
131  *	synchronization signal if there is a page flip request.
132  * @clock_enable: optional function enabling/disabling display domain clock,
133  *	called from exynos-dp driver before powering up (with
134  *	'enable' argument as true) and after powering down (with
135  *	'enable' as false).
136  */
137 struct exynos_drm_crtc;
138 struct exynos_drm_crtc_ops {
139 	void (*enable)(struct exynos_drm_crtc *crtc);
140 	void (*disable)(struct exynos_drm_crtc *crtc);
141 	void (*commit)(struct exynos_drm_crtc *crtc);
142 	int (*enable_vblank)(struct exynos_drm_crtc *crtc);
143 	void (*disable_vblank)(struct exynos_drm_crtc *crtc);
144 	void (*wait_for_vblank)(struct exynos_drm_crtc *crtc);
145 	int (*atomic_check)(struct exynos_drm_crtc *crtc,
146 			    struct drm_crtc_state *state);
147 	void (*atomic_begin)(struct exynos_drm_crtc *crtc);
148 	void (*update_plane)(struct exynos_drm_crtc *crtc,
149 			     struct exynos_drm_plane *plane);
150 	void (*disable_plane)(struct exynos_drm_crtc *crtc,
151 			      struct exynos_drm_plane *plane);
152 	void (*atomic_flush)(struct exynos_drm_crtc *crtc);
153 	void (*te_handler)(struct exynos_drm_crtc *crtc);
154 	void (*clock_enable)(struct exynos_drm_crtc *crtc, bool enable);
155 };
156 
157 /*
158  * Exynos specific crtc structure.
159  *
160  * @base: crtc object.
161  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
162  * @pipe: a crtc index created at load() with a new crtc object creation
163  *	and the crtc object would be set to private->crtc array
164  *	to get a crtc object corresponding to this pipe from private->crtc
165  *	array when irq interrupt occurred. the reason of using this pipe is that
166  *	drm framework doesn't support multiple irq yet.
167  *	we can refer to the crtc to current hardware interrupt occurred through
168  *	this pipe value.
169  * @enabled: if the crtc is enabled or not
170  * @event: vblank event that is currently queued for flip
171  * @wait_update: wait all pending planes updates to finish
172  * @pending_update: number of pending plane updates in this crtc
173  * @ops: pointer to callbacks for exynos drm specific functionality
174  * @ctx: A pointer to the crtc's implementation specific context
175  */
176 struct exynos_drm_crtc {
177 	struct drm_crtc			base;
178 	enum exynos_drm_output_type	type;
179 	unsigned int			pipe;
180 	struct drm_pending_vblank_event	*event;
181 	wait_queue_head_t		wait_update;
182 	atomic_t			pending_update;
183 	const struct exynos_drm_crtc_ops	*ops;
184 	void				*ctx;
185 };
186 
187 struct exynos_drm_g2d_private {
188 	struct device		*dev;
189 	struct list_head	inuse_cmdlist;
190 	struct list_head	event_list;
191 	struct list_head	userptr_list;
192 };
193 
194 struct drm_exynos_file_private {
195 	struct exynos_drm_g2d_private	*g2d_priv;
196 	struct device			*ipp_dev;
197 };
198 
199 /*
200  * Exynos drm private structure.
201  *
202  * @da_start: start address to device address space.
203  *	with iommu, device address space starts from this address
204  *	otherwise default one.
205  * @da_space_size: size of device address space.
206  *	if 0 then default value is used for it.
207  * @pipe: the pipe number for this crtc/manager.
208  * @pending: the crtcs that have pending updates to finish
209  * @lock: protect access to @pending
210  * @wait: wait an atomic commit to finish
211  */
212 struct exynos_drm_private {
213 	struct drm_fb_helper *fb_helper;
214 
215 	/*
216 	 * created crtc object would be contained at this array and
217 	 * this array is used to be aware of which crtc did it request vblank.
218 	 */
219 	struct drm_crtc *crtc[MAX_CRTC];
220 	struct drm_property *plane_zpos_property;
221 
222 	struct device *dma_dev;
223 	unsigned long da_start;
224 	unsigned long da_space_size;
225 	void *mapping;
226 
227 	unsigned int pipe;
228 
229 	/* for atomic commit */
230 	u32			pending;
231 	spinlock_t		lock;
232 	wait_queue_head_t	wait;
233 };
234 
235 static inline struct device *to_dma_dev(struct drm_device *dev)
236 {
237 	struct exynos_drm_private *priv = dev->dev_private;
238 
239 	return priv->dma_dev;
240 }
241 
242 /*
243  * Exynos drm sub driver structure.
244  *
245  * @list: sub driver has its own list object to register to exynos drm driver.
246  * @dev: pointer to device object for subdrv device driver.
247  * @drm_dev: pointer to drm_device and this pointer would be set
248  *	when sub driver calls exynos_drm_subdrv_register().
249  * @probe: this callback would be called by exynos drm driver after
250  *     subdrv is registered to it.
251  * @remove: this callback is used to release resources created
252  *     by probe callback.
253  * @open: this would be called with drm device file open.
254  * @close: this would be called with drm device file close.
255  */
256 struct exynos_drm_subdrv {
257 	struct list_head list;
258 	struct device *dev;
259 	struct drm_device *drm_dev;
260 
261 	int (*probe)(struct drm_device *drm_dev, struct device *dev);
262 	void (*remove)(struct drm_device *drm_dev, struct device *dev);
263 	int (*open)(struct drm_device *drm_dev, struct device *dev,
264 			struct drm_file *file);
265 	void (*close)(struct drm_device *drm_dev, struct device *dev,
266 			struct drm_file *file);
267 };
268 
269  /* This function would be called by non kms drivers such as g2d and ipp. */
270 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
271 
272 /* this function removes subdrv list from exynos drm driver */
273 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
274 
275 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
276 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
277 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
278 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
279 
280 #ifdef CONFIG_DRM_EXYNOS_DPI
281 struct drm_encoder *exynos_dpi_probe(struct device *dev);
282 int exynos_dpi_remove(struct drm_encoder *encoder);
283 int exynos_dpi_bind(struct drm_device *dev, struct drm_encoder *encoder);
284 #else
285 static inline struct drm_encoder *
286 exynos_dpi_probe(struct device *dev) { return NULL; }
287 static inline int exynos_dpi_remove(struct drm_encoder *encoder)
288 {
289 	return 0;
290 }
291 static inline int exynos_dpi_bind(struct drm_device *dev,
292 				  struct drm_encoder *encoder)
293 {
294 	return 0;
295 }
296 #endif
297 
298 int exynos_atomic_commit(struct drm_device *dev, struct drm_atomic_state *state,
299 			 bool async);
300 
301 
302 extern struct platform_driver fimd_driver;
303 extern struct platform_driver exynos5433_decon_driver;
304 extern struct platform_driver decon_driver;
305 extern struct platform_driver dp_driver;
306 extern struct platform_driver dsi_driver;
307 extern struct platform_driver mixer_driver;
308 extern struct platform_driver hdmi_driver;
309 extern struct platform_driver vidi_driver;
310 extern struct platform_driver g2d_driver;
311 extern struct platform_driver fimc_driver;
312 extern struct platform_driver rotator_driver;
313 extern struct platform_driver gsc_driver;
314 extern struct platform_driver ipp_driver;
315 extern struct platform_driver mic_driver;
316 #endif
317