xref: /linux/drivers/gpu/drm/exynos/exynos_drm_drv.h (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* exynos_drm_drv.h
3  *
4  * Copyright (c) 2011 Samsung Electronics Co., Ltd.
5  * Authors:
6  *	Inki Dae <inki.dae@samsung.com>
7  *	Joonyoung Shim <jy0922.shim@samsung.com>
8  *	Seung-Woo Kim <sw0312.kim@samsung.com>
9  */
10 
11 #ifndef _EXYNOS_DRM_DRV_H_
12 #define _EXYNOS_DRM_DRV_H_
13 
14 #include <linux/module.h>
15 
16 #include <drm/drm_crtc.h>
17 #include <drm/drm_device.h>
18 #include <drm/drm_plane.h>
19 
20 #define MAX_CRTC	3
21 #define MAX_PLANE	5
22 
23 #define DEFAULT_WIN	0
24 
25 struct drm_crtc_state;
26 struct drm_display_mode;
27 
28 #define to_exynos_crtc(x)	container_of(x, struct exynos_drm_crtc, base)
29 #define to_exynos_plane(x)	container_of(x, struct exynos_drm_plane, base)
30 
31 /* this enumerates display type. */
32 enum exynos_drm_output_type {
33 	EXYNOS_DISPLAY_TYPE_NONE,
34 	/* RGB or CPU Interface. */
35 	EXYNOS_DISPLAY_TYPE_LCD,
36 	/* HDMI Interface. */
37 	EXYNOS_DISPLAY_TYPE_HDMI,
38 	/* Virtual Display Interface. */
39 	EXYNOS_DISPLAY_TYPE_VIDI,
40 };
41 
42 struct exynos_drm_rect {
43 	unsigned int x, y;
44 	unsigned int w, h;
45 };
46 
47 /*
48  * Exynos drm plane state structure.
49  *
50  * @base: plane_state object (contains drm_framebuffer pointer)
51  * @src: rectangle of the source image data to be displayed (clipped to
52  *       visible part).
53  * @crtc: rectangle of the target image position on hardware screen
54  *       (clipped to visible part).
55  * @h_ratio: horizontal scaling ratio, 16.16 fixed point
56  * @v_ratio: vertical scaling ratio, 16.16 fixed point
57  *
58  * this structure consists plane state data that will be applied to hardware
59  * specific overlay info.
60  */
61 
62 struct exynos_drm_plane_state {
63 	struct drm_plane_state base;
64 	struct exynos_drm_rect crtc;
65 	struct exynos_drm_rect src;
66 	unsigned int h_ratio;
67 	unsigned int v_ratio;
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 };
91 
92 #define EXYNOS_DRM_PLANE_CAP_DOUBLE	(1 << 0)
93 #define EXYNOS_DRM_PLANE_CAP_SCALE	(1 << 1)
94 #define EXYNOS_DRM_PLANE_CAP_ZPOS	(1 << 2)
95 #define EXYNOS_DRM_PLANE_CAP_TILE	(1 << 3)
96 #define EXYNOS_DRM_PLANE_CAP_PIX_BLEND	(1 << 4)
97 #define EXYNOS_DRM_PLANE_CAP_WIN_BLEND	(1 << 5)
98 
99 /*
100  * Exynos DRM plane configuration structure.
101  *
102  * @zpos: initial z-position of the plane.
103  * @type: type of the plane (primary, cursor or overlay).
104  * @pixel_formats: supported pixel formats.
105  * @num_pixel_formats: number of elements in 'pixel_formats'.
106  * @capabilities: supported features (see EXYNOS_DRM_PLANE_CAP_*)
107  */
108 
109 struct exynos_drm_plane_config {
110 	unsigned int zpos;
111 	enum drm_plane_type type;
112 	const uint32_t *pixel_formats;
113 	unsigned int num_pixel_formats;
114 	unsigned int capabilities;
115 };
116 
117 /*
118  * Exynos drm crtc ops
119  *
120  * @atomic_enable: enable the device
121  * @atomic_disable: disable the device
122  * @enable_vblank: specific driver callback for enabling vblank interrupt.
123  * @disable_vblank: specific driver callback for disabling vblank interrupt.
124  * @mode_valid: specific driver callback for mode validation
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  */
133 struct exynos_drm_crtc;
134 struct exynos_drm_crtc_ops {
135 	void (*atomic_enable)(struct exynos_drm_crtc *crtc);
136 	void (*atomic_disable)(struct exynos_drm_crtc *crtc);
137 	int (*enable_vblank)(struct exynos_drm_crtc *crtc);
138 	void (*disable_vblank)(struct exynos_drm_crtc *crtc);
139 	enum drm_mode_status (*mode_valid)(struct exynos_drm_crtc *crtc,
140 		const struct drm_display_mode *mode);
141 	bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
142 			   const struct drm_display_mode *mode,
143 			   struct drm_display_mode *adjusted_mode);
144 	int (*atomic_check)(struct exynos_drm_crtc *crtc,
145 			    struct drm_crtc_state *state);
146 	void (*atomic_begin)(struct exynos_drm_crtc *crtc);
147 	void (*update_plane)(struct exynos_drm_crtc *crtc,
148 			     struct exynos_drm_plane *plane);
149 	void (*disable_plane)(struct exynos_drm_crtc *crtc,
150 			      struct exynos_drm_plane *plane);
151 	void (*atomic_flush)(struct exynos_drm_crtc *crtc);
152 	void (*te_handler)(struct exynos_drm_crtc *crtc);
153 };
154 
155 struct exynos_drm_clk {
156 	void (*enable)(struct exynos_drm_clk *clk, bool enable);
157 };
158 
159 /*
160  * Exynos specific crtc structure.
161  *
162  * @base: crtc object.
163  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
164  * @ops: pointer to callbacks for exynos drm specific functionality
165  * @ctx: A pointer to the crtc's implementation specific context
166  * @pipe_clk: A pointer to the crtc's pipeline clock.
167  */
168 struct exynos_drm_crtc {
169 	struct drm_crtc			base;
170 	enum exynos_drm_output_type	type;
171 	const struct exynos_drm_crtc_ops	*ops;
172 	void				*ctx;
173 	struct exynos_drm_clk		*pipe_clk;
174 	bool				i80_mode : 1;
175 };
176 
177 static inline void exynos_drm_pipe_clk_enable(struct exynos_drm_crtc *crtc,
178 					      bool enable)
179 {
180 	if (crtc->pipe_clk)
181 		crtc->pipe_clk->enable(crtc->pipe_clk, enable);
182 }
183 
184 struct drm_exynos_file_private {
185 	/* for g2d api */
186 	struct list_head	inuse_cmdlist;
187 	struct list_head	event_list;
188 	struct list_head	userptr_list;
189 };
190 
191 /*
192  * Exynos drm private structure.
193  *
194  * @pending: the crtcs that have pending updates to finish
195  * @lock: protect access to @pending
196  * @wait: wait an atomic commit to finish
197  */
198 struct exynos_drm_private {
199 	struct device *g2d_dev;
200 	struct device *vidi_dev;
201 	void *mapping;
202 
203 	/* for atomic commit */
204 	u32			pending;
205 	spinlock_t		lock;
206 	wait_queue_head_t	wait;
207 };
208 
209 static inline bool is_drm_iommu_supported(struct drm_device *drm_dev)
210 {
211 	struct exynos_drm_private *priv = drm_dev->dev_private;
212 
213 	return priv->mapping ? true : false;
214 }
215 
216 int exynos_drm_register_dma(struct drm_device *drm, struct device *dev,
217 			    void **dma_priv);
218 void exynos_drm_unregister_dma(struct drm_device *drm, struct device *dev,
219 			       void **dma_priv);
220 void exynos_drm_cleanup_dma(struct drm_device *drm);
221 
222 #ifdef CONFIG_DRM_EXYNOS_DPI
223 struct drm_encoder *exynos_dpi_probe(struct device *dev);
224 int exynos_dpi_remove(struct drm_encoder *encoder);
225 int exynos_dpi_bind(struct drm_device *dev, struct drm_encoder *encoder);
226 #else
227 static inline struct drm_encoder *
228 exynos_dpi_probe(struct device *dev) { return NULL; }
229 static inline int exynos_dpi_remove(struct drm_encoder *encoder)
230 {
231 	return 0;
232 }
233 static inline int exynos_dpi_bind(struct drm_device *dev,
234 				  struct drm_encoder *encoder)
235 {
236 	return 0;
237 }
238 #endif
239 
240 #ifdef CONFIG_DRM_EXYNOS_FIMC
241 int exynos_drm_check_fimc_device(struct device *dev);
242 #else
243 static inline int exynos_drm_check_fimc_device(struct device *dev)
244 {
245 	return 0;
246 }
247 #endif
248 
249 extern struct platform_driver fimd_driver;
250 extern struct platform_driver exynos5433_decon_driver;
251 extern struct platform_driver decon_driver;
252 extern struct platform_driver dp_driver;
253 extern struct platform_driver dsi_driver;
254 extern struct platform_driver mixer_driver;
255 extern struct platform_driver hdmi_driver;
256 extern struct platform_driver vidi_driver;
257 extern struct platform_driver g2d_driver;
258 extern struct platform_driver fimc_driver;
259 extern struct platform_driver rotator_driver;
260 extern struct platform_driver scaler_driver;
261 extern struct platform_driver gsc_driver;
262 extern struct platform_driver mic_driver;
263 #endif
264