Loading...
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#define MAX_FB_BUFFER 4
23
24#define DEFAULT_WIN 0
25
26struct drm_crtc_state;
27struct drm_display_mode;
28
29#define to_exynos_crtc(x) container_of(x, struct exynos_drm_crtc, base)
30#define to_exynos_plane(x) container_of(x, struct exynos_drm_plane, base)
31
32/* this enumerates display type. */
33enum exynos_drm_output_type {
34 EXYNOS_DISPLAY_TYPE_NONE,
35 /* RGB or CPU Interface. */
36 EXYNOS_DISPLAY_TYPE_LCD,
37 /* HDMI Interface. */
38 EXYNOS_DISPLAY_TYPE_HDMI,
39 /* Virtual Display Interface. */
40 EXYNOS_DISPLAY_TYPE_VIDI,
41};
42
43struct exynos_drm_rect {
44 unsigned int x, y;
45 unsigned int w, h;
46};
47
48/*
49 * Exynos drm plane state structure.
50 *
51 * @base: plane_state object (contains drm_framebuffer pointer)
52 * @src: rectangle of the source image data to be displayed (clipped to
53 * visible part).
54 * @crtc: rectangle of the target image position on hardware screen
55 * (clipped to visible part).
56 * @h_ratio: horizontal scaling ratio, 16.16 fixed point
57 * @v_ratio: vertical scaling ratio, 16.16 fixed point
58 *
59 * this structure consists plane state data that will be applied to hardware
60 * specific overlay info.
61 */
62
63struct exynos_drm_plane_state {
64 struct drm_plane_state base;
65 struct exynos_drm_rect crtc;
66 struct exynos_drm_rect src;
67 unsigned int h_ratio;
68 unsigned int v_ratio;
69};
70
71static inline struct exynos_drm_plane_state *
72to_exynos_plane_state(struct drm_plane_state *state)
73{
74 return container_of(state, struct exynos_drm_plane_state, base);
75}
76
77/*
78 * Exynos drm common overlay structure.
79 *
80 * @base: plane object
81 * @index: hardware index of the overlay layer
82 *
83 * this structure is common to exynos SoC and its contents would be copied
84 * to hardware specific overlay info.
85 */
86
87struct exynos_drm_plane {
88 struct drm_plane base;
89 const struct exynos_drm_plane_config *config;
90 unsigned int index;
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#define EXYNOS_DRM_PLANE_CAP_TILE (1 << 3)
97#define EXYNOS_DRM_PLANE_CAP_PIX_BLEND (1 << 4)
98#define EXYNOS_DRM_PLANE_CAP_WIN_BLEND (1 << 5)
99
100/*
101 * Exynos DRM plane configuration structure.
102 *
103 * @zpos: initial z-position of the plane.
104 * @type: type of the plane (primary, cursor or overlay).
105 * @pixel_formats: supported pixel formats.
106 * @num_pixel_formats: number of elements in 'pixel_formats'.
107 * @capabilities: supported features (see EXYNOS_DRM_PLANE_CAP_*)
108 */
109
110struct exynos_drm_plane_config {
111 unsigned int zpos;
112 enum drm_plane_type type;
113 const uint32_t *pixel_formats;
114 unsigned int num_pixel_formats;
115 unsigned int capabilities;
116};
117
118/*
119 * Exynos drm crtc ops
120 *
121 * @enable: enable the device
122 * @disable: disable the device
123 * @enable_vblank: specific driver callback for enabling vblank interrupt.
124 * @disable_vblank: specific driver callback for disabling vblank interrupt.
125 * @mode_valid: specific driver callback for mode validation
126 * @atomic_check: validate state
127 * @atomic_begin: prepare device to receive an update
128 * @atomic_flush: mark the end of device update
129 * @update_plane: apply hardware specific overlay data to registers.
130 * @disable_plane: disable hardware specific overlay.
131 * @te_handler: trigger to transfer video image at the tearing effect
132 * synchronization signal if there is a page flip request.
133 */
134struct exynos_drm_crtc;
135struct exynos_drm_crtc_ops {
136 void (*enable)(struct exynos_drm_crtc *crtc);
137 void (*disable)(struct exynos_drm_crtc *crtc);
138 int (*enable_vblank)(struct exynos_drm_crtc *crtc);
139 void (*disable_vblank)(struct exynos_drm_crtc *crtc);
140 enum drm_mode_status (*mode_valid)(struct exynos_drm_crtc *crtc,
141 const struct drm_display_mode *mode);
142 bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
143 const struct drm_display_mode *mode,
144 struct drm_display_mode *adjusted_mode);
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};
155
156struct exynos_drm_clk {
157 void (*enable)(struct exynos_drm_clk *clk, bool enable);
158};
159
160/*
161 * Exynos specific crtc structure.
162 *
163 * @base: crtc object.
164 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
165 * @ops: pointer to callbacks for exynos drm specific functionality
166 * @ctx: A pointer to the crtc's implementation specific context
167 * @pipe_clk: A pointer to the crtc's pipeline clock.
168 */
169struct exynos_drm_crtc {
170 struct drm_crtc base;
171 enum exynos_drm_output_type type;
172 const struct exynos_drm_crtc_ops *ops;
173 void *ctx;
174 struct exynos_drm_clk *pipe_clk;
175 bool i80_mode : 1;
176};
177
178static inline void exynos_drm_pipe_clk_enable(struct exynos_drm_crtc *crtc,
179 bool enable)
180{
181 if (crtc->pipe_clk)
182 crtc->pipe_clk->enable(crtc->pipe_clk, enable);
183}
184
185struct drm_exynos_file_private {
186 /* for g2d api */
187 struct list_head inuse_cmdlist;
188 struct list_head event_list;
189 struct list_head userptr_list;
190};
191
192/*
193 * Exynos drm private structure.
194 *
195 * @pending: the crtcs that have pending updates to finish
196 * @lock: protect access to @pending
197 * @wait: wait an atomic commit to finish
198 */
199struct exynos_drm_private {
200 struct drm_fb_helper *fb_helper;
201
202 struct device *g2d_dev;
203 struct device *dma_dev;
204 void *mapping;
205
206 /* for atomic commit */
207 u32 pending;
208 spinlock_t lock;
209 wait_queue_head_t wait;
210};
211
212static inline struct device *to_dma_dev(struct drm_device *dev)
213{
214 struct exynos_drm_private *priv = dev->dev_private;
215
216 return priv->dma_dev;
217}
218
219static inline bool is_drm_iommu_supported(struct drm_device *drm_dev)
220{
221 struct exynos_drm_private *priv = drm_dev->dev_private;
222
223 return priv->mapping ? true : false;
224}
225
226int exynos_drm_register_dma(struct drm_device *drm, struct device *dev);
227void exynos_drm_unregister_dma(struct drm_device *drm, struct device *dev);
228void exynos_drm_cleanup_dma(struct drm_device *drm);
229
230#ifdef CONFIG_DRM_EXYNOS_DPI
231struct drm_encoder *exynos_dpi_probe(struct device *dev);
232int exynos_dpi_remove(struct drm_encoder *encoder);
233int exynos_dpi_bind(struct drm_device *dev, struct drm_encoder *encoder);
234#else
235static inline struct drm_encoder *
236exynos_dpi_probe(struct device *dev) { return NULL; }
237static inline int exynos_dpi_remove(struct drm_encoder *encoder)
238{
239 return 0;
240}
241static inline int exynos_dpi_bind(struct drm_device *dev,
242 struct drm_encoder *encoder)
243{
244 return 0;
245}
246#endif
247
248#ifdef CONFIG_DRM_EXYNOS_FIMC
249int exynos_drm_check_fimc_device(struct device *dev);
250#else
251static inline int exynos_drm_check_fimc_device(struct device *dev)
252{
253 return 0;
254}
255#endif
256
257int exynos_atomic_commit(struct drm_device *dev, struct drm_atomic_state *state,
258 bool nonblock);
259
260
261extern struct platform_driver fimd_driver;
262extern struct platform_driver exynos5433_decon_driver;
263extern struct platform_driver decon_driver;
264extern struct platform_driver dp_driver;
265extern struct platform_driver dsi_driver;
266extern struct platform_driver mixer_driver;
267extern struct platform_driver hdmi_driver;
268extern struct platform_driver vidi_driver;
269extern struct platform_driver g2d_driver;
270extern struct platform_driver fimc_driver;
271extern struct platform_driver rotator_driver;
272extern struct platform_driver scaler_driver;
273extern struct platform_driver gsc_driver;
274extern struct platform_driver mic_driver;
275#endif
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 exynos_drm_overlay;
41struct drm_connector;
42
43extern unsigned int drm_vblank_offdelay;
44
45/* this enumerates display type. */
46enum exynos_drm_output_type {
47 EXYNOS_DISPLAY_TYPE_NONE,
48 /* RGB or CPU Interface. */
49 EXYNOS_DISPLAY_TYPE_LCD,
50 /* HDMI Interface. */
51 EXYNOS_DISPLAY_TYPE_HDMI,
52 /* Virtual Display Interface. */
53 EXYNOS_DISPLAY_TYPE_VIDI,
54};
55
56/*
57 * Exynos drm common overlay structure.
58 *
59 * @fb_x: offset x on a framebuffer to be displayed.
60 * - the unit is screen coordinates.
61 * @fb_y: offset y on a framebuffer to be displayed.
62 * - the unit is screen coordinates.
63 * @fb_width: width of a framebuffer.
64 * @fb_height: height of a framebuffer.
65 * @src_width: width of a partial image to be displayed from framebuffer.
66 * @src_height: height of a partial image to be displayed from framebuffer.
67 * @crtc_x: offset x on hardware screen.
68 * @crtc_y: offset y on hardware screen.
69 * @crtc_width: window width to be displayed (hardware screen).
70 * @crtc_height: window height to be displayed (hardware screen).
71 * @mode_width: width of screen mode.
72 * @mode_height: height of screen mode.
73 * @refresh: refresh rate.
74 * @scan_flag: interlace or progressive way.
75 * (it could be DRM_MODE_FLAG_*)
76 * @bpp: pixel size.(in bit)
77 * @pixel_format: fourcc pixel format of this overlay
78 * @dma_addr: array of bus(accessed by dma) address to the memory region
79 * allocated for a overlay.
80 * @zpos: order of overlay layer(z position).
81 * @default_win: a window to be enabled.
82 * @color_key: color key on or off.
83 * @index_color: if using color key feature then this value would be used
84 * as index color.
85 * @local_path: in case of lcd type, local path mode on or off.
86 * @transparency: transparency on or off.
87 * @activated: activated or not.
88 *
89 * this structure is common to exynos SoC and its contents would be copied
90 * to hardware specific overlay info.
91 */
92struct exynos_drm_overlay {
93 unsigned int fb_x;
94 unsigned int fb_y;
95 unsigned int fb_width;
96 unsigned int fb_height;
97 unsigned int src_width;
98 unsigned int src_height;
99 unsigned int crtc_x;
100 unsigned int crtc_y;
101 unsigned int crtc_width;
102 unsigned int crtc_height;
103 unsigned int mode_width;
104 unsigned int mode_height;
105 unsigned int refresh;
106 unsigned int scan_flag;
107 unsigned int bpp;
108 unsigned int pitch;
109 uint32_t pixel_format;
110 dma_addr_t dma_addr[MAX_FB_BUFFER];
111 int zpos;
112
113 bool default_win;
114 bool color_key;
115 unsigned int index_color;
116 bool local_path;
117 bool transparency;
118 bool activated;
119};
120
121/*
122 * Exynos DRM Display Structure.
123 * - this structure is common to analog tv, digital tv and lcd panel.
124 *
125 * @initialize: initializes the display with drm_dev
126 * @remove: cleans up the display for removal
127 * @mode_fixup: fix mode data comparing to hw specific display mode.
128 * @mode_set: convert drm_display_mode to hw specific display mode and
129 * would be called by encoder->mode_set().
130 * @check_mode: check if mode is valid or not.
131 * @dpms: display device on or off.
132 * @commit: apply changes to hw
133 */
134struct exynos_drm_display;
135struct exynos_drm_display_ops {
136 int (*initialize)(struct exynos_drm_display *display,
137 struct drm_device *drm_dev);
138 int (*create_connector)(struct exynos_drm_display *display,
139 struct drm_encoder *encoder);
140 void (*remove)(struct exynos_drm_display *display);
141 void (*mode_fixup)(struct exynos_drm_display *display,
142 struct drm_connector *connector,
143 const struct drm_display_mode *mode,
144 struct drm_display_mode *adjusted_mode);
145 void (*mode_set)(struct exynos_drm_display *display,
146 struct drm_display_mode *mode);
147 int (*check_mode)(struct exynos_drm_display *display,
148 struct drm_display_mode *mode);
149 void (*dpms)(struct exynos_drm_display *display, int mode);
150 void (*commit)(struct exynos_drm_display *display);
151};
152
153/*
154 * Exynos drm display structure, maps 1:1 with an encoder/connector
155 *
156 * @list: the list entry for this manager
157 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
158 * @encoder: encoder object this display maps to
159 * @connector: connector object this display maps to
160 * @ops: pointer to callbacks for exynos drm specific functionality
161 * @ctx: A pointer to the display's implementation specific context
162 */
163struct exynos_drm_display {
164 struct list_head list;
165 enum exynos_drm_output_type type;
166 struct drm_encoder *encoder;
167 struct drm_connector *connector;
168 struct exynos_drm_display_ops *ops;
169 void *ctx;
170};
171
172/*
173 * Exynos drm manager ops
174 *
175 * @initialize: initializes the manager with drm_dev
176 * @remove: cleans up the manager for removal
177 * @dpms: control device power.
178 * @mode_fixup: fix mode data before applying it
179 * @mode_set: set the given mode to the manager
180 * @commit: set current hw specific display mode to hw.
181 * @enable_vblank: specific driver callback for enabling vblank interrupt.
182 * @disable_vblank: specific driver callback for disabling vblank interrupt.
183 * @wait_for_vblank: wait for vblank interrupt to make sure that
184 * hardware overlay is updated.
185 * @win_mode_set: copy drm overlay info to hw specific overlay info.
186 * @win_commit: apply hardware specific overlay data to registers.
187 * @win_enable: enable hardware specific overlay.
188 * @win_disable: disable hardware specific overlay.
189 */
190struct exynos_drm_manager;
191struct exynos_drm_manager_ops {
192 int (*initialize)(struct exynos_drm_manager *mgr,
193 struct drm_device *drm_dev, int pipe);
194 void (*remove)(struct exynos_drm_manager *mgr);
195 void (*dpms)(struct exynos_drm_manager *mgr, int mode);
196 bool (*mode_fixup)(struct exynos_drm_manager *mgr,
197 const struct drm_display_mode *mode,
198 struct drm_display_mode *adjusted_mode);
199 void (*mode_set)(struct exynos_drm_manager *mgr,
200 const struct drm_display_mode *mode);
201 void (*commit)(struct exynos_drm_manager *mgr);
202 int (*enable_vblank)(struct exynos_drm_manager *mgr);
203 void (*disable_vblank)(struct exynos_drm_manager *mgr);
204 void (*wait_for_vblank)(struct exynos_drm_manager *mgr);
205 void (*win_mode_set)(struct exynos_drm_manager *mgr,
206 struct exynos_drm_overlay *overlay);
207 void (*win_commit)(struct exynos_drm_manager *mgr, int zpos);
208 void (*win_enable)(struct exynos_drm_manager *mgr, int zpos);
209 void (*win_disable)(struct exynos_drm_manager *mgr, int zpos);
210};
211
212/*
213 * Exynos drm common manager structure, maps 1:1 with a crtc
214 *
215 * @list: the list entry for this manager
216 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
217 * @drm_dev: pointer to the drm device
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 int pipe;
227 struct exynos_drm_manager_ops *ops;
228 void *ctx;
229};
230
231struct exynos_drm_g2d_private {
232 struct device *dev;
233 struct list_head inuse_cmdlist;
234 struct list_head event_list;
235 struct list_head userptr_list;
236};
237
238struct exynos_drm_ipp_private {
239 struct device *dev;
240 struct list_head event_list;
241};
242
243struct drm_exynos_file_private {
244 struct exynos_drm_g2d_private *g2d_priv;
245 struct exynos_drm_ipp_private *ipp_priv;
246 struct file *anon_filp;
247};
248
249/*
250 * Exynos drm private structure.
251 *
252 * @da_start: start address to device address space.
253 * with iommu, device address space starts from this address
254 * otherwise default one.
255 * @da_space_size: size of device address space.
256 * if 0 then default value is used for it.
257 */
258struct exynos_drm_private {
259 struct drm_fb_helper *fb_helper;
260
261 /* list head for new event to be added. */
262 struct list_head pageflip_event_list;
263
264 /*
265 * created crtc object would be contained at this array and
266 * this array is used to be aware of which crtc did it request vblank.
267 */
268 struct drm_crtc *crtc[MAX_CRTC];
269 struct drm_property *plane_zpos_property;
270 struct drm_property *crtc_mode_property;
271
272 unsigned long da_start;
273 unsigned long da_space_size;
274};
275
276/*
277 * Exynos drm sub driver structure.
278 *
279 * @list: sub driver has its own list object to register to exynos drm driver.
280 * @dev: pointer to device object for subdrv device driver.
281 * @drm_dev: pointer to drm_device and this pointer would be set
282 * when sub driver calls exynos_drm_subdrv_register().
283 * @manager: subdrv has its own manager to control a hardware appropriately
284 * and we can access a hardware drawing on this manager.
285 * @probe: this callback would be called by exynos drm driver after
286 * subdrv is registered to it.
287 * @remove: this callback is used to release resources created
288 * by probe callback.
289 * @open: this would be called with drm device file open.
290 * @close: this would be called with drm device file close.
291 */
292struct exynos_drm_subdrv {
293 struct list_head list;
294 struct device *dev;
295 struct drm_device *drm_dev;
296
297 int (*probe)(struct drm_device *drm_dev, struct device *dev);
298 void (*remove)(struct drm_device *drm_dev, struct device *dev);
299 int (*open)(struct drm_device *drm_dev, struct device *dev,
300 struct drm_file *file);
301 void (*close)(struct drm_device *drm_dev, struct device *dev,
302 struct drm_file *file);
303};
304
305/*
306 * this function calls a probe callback registered to sub driver list and
307 * create its own encoder and connector and then set drm_device object
308 * to global one.
309 */
310int exynos_drm_device_register(struct drm_device *dev);
311/*
312 * this function calls a remove callback registered to sub driver list and
313 * destroy its own encoder and connetor.
314 */
315int exynos_drm_device_unregister(struct drm_device *dev);
316
317int exynos_drm_initialize_managers(struct drm_device *dev);
318void exynos_drm_remove_managers(struct drm_device *dev);
319int exynos_drm_initialize_displays(struct drm_device *dev);
320void exynos_drm_remove_displays(struct drm_device *dev);
321
322int exynos_drm_manager_register(struct exynos_drm_manager *manager);
323int exynos_drm_manager_unregister(struct exynos_drm_manager *manager);
324int exynos_drm_display_register(struct exynos_drm_display *display);
325int exynos_drm_display_unregister(struct exynos_drm_display *display);
326
327/*
328 * this function would be called by sub drivers such as display controller
329 * or hdmi driver to register this sub driver object to exynos drm driver
330 * and when a sub driver is registered to exynos drm driver a probe callback
331 * of the sub driver is called and creates its own encoder and connector.
332 */
333int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
334
335/* this function removes subdrv list from exynos drm driver */
336int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
337
338int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
339void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
340
341/*
342 * this function registers exynos drm hdmi platform device. It ensures only one
343 * instance of the device is created.
344 */
345int exynos_platform_device_hdmi_register(void);
346
347/*
348 * this function unregisters exynos drm hdmi platform device if it exists.
349 */
350void exynos_platform_device_hdmi_unregister(void);
351
352/*
353 * this function registers exynos drm ipp platform device.
354 */
355int exynos_platform_device_ipp_register(void);
356
357/*
358 * this function unregisters exynos drm ipp platform device if it exists.
359 */
360void exynos_platform_device_ipp_unregister(void);
361
362#ifdef CONFIG_DRM_EXYNOS_DPI
363int exynos_dpi_probe(struct device *dev);
364int exynos_dpi_remove(struct device *dev);
365#else
366static inline int exynos_dpi_probe(struct device *dev) { return 0; }
367static inline int exynos_dpi_remove(struct device *dev) { return 0; }
368#endif
369
370extern struct platform_driver dp_driver;
371extern struct platform_driver dsi_driver;
372extern struct platform_driver fimd_driver;
373extern struct platform_driver hdmi_driver;
374extern struct platform_driver mixer_driver;
375extern struct platform_driver exynos_drm_common_hdmi_driver;
376extern struct platform_driver vidi_driver;
377extern struct platform_driver g2d_driver;
378extern struct platform_driver fimc_driver;
379extern struct platform_driver rotator_driver;
380extern struct platform_driver gsc_driver;
381extern struct platform_driver ipp_driver;
382#endif