xref: /linux/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_mdss.h (revision c110cfd1)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (c) 2015-2018, The Linux Foundation. All rights reserved.
3  */
4 
5 #ifndef _DPU_HW_MDSS_H
6 #define _DPU_HW_MDSS_H
7 
8 #include <linux/kernel.h>
9 #include <linux/err.h>
10 
11 #include "msm_drv.h"
12 
13 #define DPU_DBG_NAME			"dpu"
14 
15 #define DPU_NONE                        0
16 
17 #ifndef DPU_CSC_MATRIX_COEFF_SIZE
18 #define DPU_CSC_MATRIX_COEFF_SIZE	9
19 #endif
20 
21 #ifndef DPU_CSC_CLAMP_SIZE
22 #define DPU_CSC_CLAMP_SIZE		6
23 #endif
24 
25 #ifndef DPU_CSC_BIAS_SIZE
26 #define DPU_CSC_BIAS_SIZE		3
27 #endif
28 
29 #ifndef DPU_MAX_PLANES
30 #define DPU_MAX_PLANES			4
31 #endif
32 
33 #define PIPES_PER_STAGE			2
34 #ifndef DPU_MAX_DE_CURVES
35 #define DPU_MAX_DE_CURVES		3
36 #endif
37 
38 enum dpu_format_flags {
39 	DPU_FORMAT_FLAG_YUV_BIT,
40 	DPU_FORMAT_FLAG_DX_BIT,
41 	DPU_FORMAT_FLAG_COMPRESSED_BIT,
42 	DPU_FORMAT_FLAG_BIT_MAX,
43 };
44 
45 #define DPU_FORMAT_FLAG_YUV		BIT(DPU_FORMAT_FLAG_YUV_BIT)
46 #define DPU_FORMAT_FLAG_DX		BIT(DPU_FORMAT_FLAG_DX_BIT)
47 #define DPU_FORMAT_FLAG_COMPRESSED	BIT(DPU_FORMAT_FLAG_COMPRESSED_BIT)
48 #define DPU_FORMAT_IS_YUV(X)		\
49 	(test_bit(DPU_FORMAT_FLAG_YUV_BIT, (X)->flag))
50 #define DPU_FORMAT_IS_DX(X)		\
51 	(test_bit(DPU_FORMAT_FLAG_DX_BIT, (X)->flag))
52 #define DPU_FORMAT_IS_LINEAR(X)		((X)->fetch_mode == DPU_FETCH_LINEAR)
53 #define DPU_FORMAT_IS_TILE(X) \
54 	(((X)->fetch_mode == DPU_FETCH_UBWC) && \
55 			!test_bit(DPU_FORMAT_FLAG_COMPRESSED_BIT, (X)->flag))
56 #define DPU_FORMAT_IS_UBWC(X) \
57 	(((X)->fetch_mode == DPU_FETCH_UBWC) && \
58 			test_bit(DPU_FORMAT_FLAG_COMPRESSED_BIT, (X)->flag))
59 
60 #define DPU_BLEND_FG_ALPHA_FG_CONST	(0 << 0)
61 #define DPU_BLEND_FG_ALPHA_BG_CONST	(1 << 0)
62 #define DPU_BLEND_FG_ALPHA_FG_PIXEL	(2 << 0)
63 #define DPU_BLEND_FG_ALPHA_BG_PIXEL	(3 << 0)
64 #define DPU_BLEND_FG_INV_ALPHA		(1 << 2)
65 #define DPU_BLEND_FG_MOD_ALPHA		(1 << 3)
66 #define DPU_BLEND_FG_INV_MOD_ALPHA	(1 << 4)
67 #define DPU_BLEND_FG_TRANSP_EN		(1 << 5)
68 #define DPU_BLEND_BG_ALPHA_FG_CONST	(0 << 8)
69 #define DPU_BLEND_BG_ALPHA_BG_CONST	(1 << 8)
70 #define DPU_BLEND_BG_ALPHA_FG_PIXEL	(2 << 8)
71 #define DPU_BLEND_BG_ALPHA_BG_PIXEL	(3 << 8)
72 #define DPU_BLEND_BG_INV_ALPHA		(1 << 10)
73 #define DPU_BLEND_BG_MOD_ALPHA		(1 << 11)
74 #define DPU_BLEND_BG_INV_MOD_ALPHA	(1 << 12)
75 #define DPU_BLEND_BG_TRANSP_EN		(1 << 13)
76 
77 #define DPU_VSYNC0_SOURCE_GPIO		0
78 #define DPU_VSYNC1_SOURCE_GPIO		1
79 #define DPU_VSYNC2_SOURCE_GPIO		2
80 #define DPU_VSYNC_SOURCE_INTF_0		3
81 #define DPU_VSYNC_SOURCE_INTF_1		4
82 #define DPU_VSYNC_SOURCE_INTF_2		5
83 #define DPU_VSYNC_SOURCE_INTF_3		6
84 #define DPU_VSYNC_SOURCE_WD_TIMER_4	11
85 #define DPU_VSYNC_SOURCE_WD_TIMER_3	12
86 #define DPU_VSYNC_SOURCE_WD_TIMER_2	13
87 #define DPU_VSYNC_SOURCE_WD_TIMER_1	14
88 #define DPU_VSYNC_SOURCE_WD_TIMER_0	15
89 
90 enum dpu_hw_blk_type {
91 	DPU_HW_BLK_TOP = 0,
92 	DPU_HW_BLK_SSPP,
93 	DPU_HW_BLK_LM,
94 	DPU_HW_BLK_CTL,
95 	DPU_HW_BLK_PINGPONG,
96 	DPU_HW_BLK_INTF,
97 	DPU_HW_BLK_WB,
98 	DPU_HW_BLK_DSPP,
99 	DPU_HW_BLK_MERGE_3D,
100 	DPU_HW_BLK_DSC,
101 	DPU_HW_BLK_MAX,
102 };
103 
104 enum dpu_mdp {
105 	MDP_TOP = 0x1,
106 	MDP_MAX,
107 };
108 
109 enum dpu_sspp {
110 	SSPP_NONE,
111 	SSPP_VIG0,
112 	SSPP_VIG1,
113 	SSPP_VIG2,
114 	SSPP_VIG3,
115 	SSPP_RGB0,
116 	SSPP_RGB1,
117 	SSPP_RGB2,
118 	SSPP_RGB3,
119 	SSPP_DMA0,
120 	SSPP_DMA1,
121 	SSPP_DMA2,
122 	SSPP_DMA3,
123 	SSPP_CURSOR0,
124 	SSPP_CURSOR1,
125 	SSPP_MAX
126 };
127 
128 enum dpu_sspp_type {
129 	SSPP_TYPE_VIG,
130 	SSPP_TYPE_RGB,
131 	SSPP_TYPE_DMA,
132 	SSPP_TYPE_CURSOR,
133 	SSPP_TYPE_MAX
134 };
135 
136 enum dpu_lm {
137 	LM_0 = 1,
138 	LM_1,
139 	LM_2,
140 	LM_3,
141 	LM_4,
142 	LM_5,
143 	LM_6,
144 	LM_MAX
145 };
146 
147 enum dpu_stage {
148 	DPU_STAGE_BASE = 0,
149 	DPU_STAGE_0,
150 	DPU_STAGE_1,
151 	DPU_STAGE_2,
152 	DPU_STAGE_3,
153 	DPU_STAGE_4,
154 	DPU_STAGE_5,
155 	DPU_STAGE_6,
156 	DPU_STAGE_7,
157 	DPU_STAGE_8,
158 	DPU_STAGE_9,
159 	DPU_STAGE_10,
160 	DPU_STAGE_MAX
161 };
162 enum dpu_dspp {
163 	DSPP_0 = 1,
164 	DSPP_1,
165 	DSPP_2,
166 	DSPP_3,
167 	DSPP_MAX
168 };
169 
170 enum dpu_ctl {
171 	CTL_0 = 1,
172 	CTL_1,
173 	CTL_2,
174 	CTL_3,
175 	CTL_4,
176 	CTL_5,
177 	CTL_MAX
178 };
179 
180 enum dpu_dsc {
181 	DSC_NONE = 0,
182 	DSC_0,
183 	DSC_1,
184 	DSC_2,
185 	DSC_3,
186 	DSC_4,
187 	DSC_5,
188 	DSC_MAX
189 };
190 
191 enum dpu_pingpong {
192 	PINGPONG_0 = 1,
193 	PINGPONG_1,
194 	PINGPONG_2,
195 	PINGPONG_3,
196 	PINGPONG_4,
197 	PINGPONG_5,
198 	PINGPONG_S0,
199 	PINGPONG_MAX
200 };
201 
202 enum dpu_merge_3d {
203 	MERGE_3D_0 = 1,
204 	MERGE_3D_1,
205 	MERGE_3D_2,
206 	MERGE_3D_MAX
207 };
208 
209 enum dpu_intf {
210 	INTF_0 = 1,
211 	INTF_1,
212 	INTF_2,
213 	INTF_3,
214 	INTF_4,
215 	INTF_5,
216 	INTF_6,
217 	INTF_MAX
218 };
219 
220 enum dpu_intf_type {
221 	INTF_NONE = 0x0,
222 	INTF_DSI = 0x1,
223 	INTF_HDMI = 0x3,
224 	INTF_LCDC = 0x5,
225 	INTF_EDP = 0x9,
226 	INTF_DP = 0xa,
227 	INTF_TYPE_MAX,
228 
229 	/* virtual interfaces */
230 	INTF_WB = 0x100,
231 };
232 
233 enum dpu_intf_mode {
234 	INTF_MODE_NONE = 0,
235 	INTF_MODE_CMD,
236 	INTF_MODE_VIDEO,
237 	INTF_MODE_WB_BLOCK,
238 	INTF_MODE_WB_LINE,
239 	INTF_MODE_MAX
240 };
241 
242 enum dpu_wb {
243 	WB_0 = 1,
244 	WB_1,
245 	WB_2,
246 	WB_3,
247 	WB_MAX
248 };
249 
250 enum dpu_cwb {
251 	CWB_0 = 0x1,
252 	CWB_1,
253 	CWB_2,
254 	CWB_3,
255 	CWB_MAX
256 };
257 
258 enum dpu_wd_timer {
259 	WD_TIMER_0 = 0x1,
260 	WD_TIMER_1,
261 	WD_TIMER_2,
262 	WD_TIMER_3,
263 	WD_TIMER_4,
264 	WD_TIMER_5,
265 	WD_TIMER_MAX
266 };
267 
268 enum dpu_vbif {
269 	VBIF_0,
270 	VBIF_1,
271 	VBIF_MAX,
272 	VBIF_RT = VBIF_0,
273 	VBIF_NRT = VBIF_1
274 };
275 
276 /**
277  * DPU HW,Component order color map
278  */
279 enum {
280 	C0_G_Y = 0,
281 	C1_B_Cb = 1,
282 	C2_R_Cr = 2,
283 	C3_ALPHA = 3
284 };
285 
286 /**
287  * enum dpu_plane_type - defines how the color component pixel packing
288  * @DPU_PLANE_INTERLEAVED   : Color components in single plane
289  * @DPU_PLANE_PLANAR        : Color component in separate planes
290  * @DPU_PLANE_PSEUDO_PLANAR : Chroma components interleaved in separate plane
291  */
292 enum dpu_plane_type {
293 	DPU_PLANE_INTERLEAVED,
294 	DPU_PLANE_PLANAR,
295 	DPU_PLANE_PSEUDO_PLANAR,
296 };
297 
298 /**
299  * enum dpu_chroma_samp_type - chroma sub-samplng type
300  * @DPU_CHROMA_RGB   : No chroma subsampling
301  * @DPU_CHROMA_H2V1  : Chroma pixels are horizontally subsampled
302  * @DPU_CHROMA_H1V2  : Chroma pixels are vertically subsampled
303  * @DPU_CHROMA_420   : 420 subsampling
304  */
305 enum dpu_chroma_samp_type {
306 	DPU_CHROMA_RGB,
307 	DPU_CHROMA_H2V1,
308 	DPU_CHROMA_H1V2,
309 	DPU_CHROMA_420
310 };
311 
312 /**
313  * dpu_fetch_type - Defines How DPU HW fetches data
314  * @DPU_FETCH_LINEAR   : fetch is line by line
315  * @DPU_FETCH_TILE     : fetches data in Z order from a tile
316  * @DPU_FETCH_UBWC     : fetch and decompress data
317  */
318 enum dpu_fetch_type {
319 	DPU_FETCH_LINEAR,
320 	DPU_FETCH_TILE,
321 	DPU_FETCH_UBWC
322 };
323 
324 /**
325  * Value of enum chosen to fit the number of bits
326  * expected by the HW programming.
327  */
328 enum {
329 	COLOR_ALPHA_1BIT = 0,
330 	COLOR_ALPHA_4BIT = 1,
331 	COLOR_4BIT = 0,
332 	COLOR_5BIT = 1, /* No 5-bit Alpha */
333 	COLOR_6BIT = 2, /* 6-Bit Alpha also = 2 */
334 	COLOR_8BIT = 3, /* 8-Bit Alpha also = 3 */
335 };
336 
337 /**
338  * enum dpu_3d_blend_mode
339  * Desribes how the 3d data is blended
340  * @BLEND_3D_NONE      : 3d blending not enabled
341  * @BLEND_3D_FRAME_INT : Frame interleaving
342  * @BLEND_3D_H_ROW_INT : Horizontal row interleaving
343  * @BLEND_3D_V_ROW_INT : vertical row interleaving
344  * @BLEND_3D_COL_INT   : column interleaving
345  * @BLEND_3D_MAX       :
346  */
347 enum dpu_3d_blend_mode {
348 	BLEND_3D_NONE = 0,
349 	BLEND_3D_FRAME_INT,
350 	BLEND_3D_H_ROW_INT,
351 	BLEND_3D_V_ROW_INT,
352 	BLEND_3D_COL_INT,
353 	BLEND_3D_MAX
354 };
355 
356 /** struct dpu_format - defines the format configuration which
357  * allows DPU HW to correctly fetch and decode the format
358  * @base: base msm_format structure containing fourcc code
359  * @fetch_planes: how the color components are packed in pixel format
360  * @element: element color ordering
361  * @bits: element bit widths
362  * @chroma_sample: chroma sub-samplng type
363  * @unpack_align_msb: unpack aligned, 0 to LSB, 1 to MSB
364  * @unpack_tight: 0 for loose, 1 for tight
365  * @unpack_count: 0 = 1 component, 1 = 2 component
366  * @bpp: bytes per pixel
367  * @alpha_enable: whether the format has an alpha channel
368  * @num_planes: number of planes (including meta data planes)
369  * @fetch_mode: linear, tiled, or ubwc hw fetch behavior
370  * @flag: usage bit flags
371  * @tile_width: format tile width
372  * @tile_height: format tile height
373  */
374 struct dpu_format {
375 	struct msm_format base;
376 	enum dpu_plane_type fetch_planes;
377 	u8 element[DPU_MAX_PLANES];
378 	u8 bits[DPU_MAX_PLANES];
379 	enum dpu_chroma_samp_type chroma_sample;
380 	u8 unpack_align_msb;
381 	u8 unpack_tight;
382 	u8 unpack_count;
383 	u8 bpp;
384 	u8 alpha_enable;
385 	u8 num_planes;
386 	enum dpu_fetch_type fetch_mode;
387 	DECLARE_BITMAP(flag, DPU_FORMAT_FLAG_BIT_MAX);
388 	u16 tile_width;
389 	u16 tile_height;
390 };
391 #define to_dpu_format(x) container_of(x, struct dpu_format, base)
392 
393 /**
394  * struct dpu_hw_fmt_layout - format information of the source pixel data
395  * @format: pixel format parameters
396  * @num_planes: number of planes (including meta data planes)
397  * @width: image width
398  * @height: image height
399  * @total_size: total size in bytes
400  * @plane_addr: address of each plane
401  * @plane_size: length of each plane
402  * @plane_pitch: pitch of each plane
403  */
404 struct dpu_hw_fmt_layout {
405 	const struct dpu_format *format;
406 	uint32_t num_planes;
407 	uint32_t width;
408 	uint32_t height;
409 	uint32_t total_size;
410 	uint32_t plane_addr[DPU_MAX_PLANES];
411 	uint32_t plane_size[DPU_MAX_PLANES];
412 	uint32_t plane_pitch[DPU_MAX_PLANES];
413 };
414 
415 struct dpu_csc_cfg {
416 	/* matrix coefficients in S15.16 format */
417 	uint32_t csc_mv[DPU_CSC_MATRIX_COEFF_SIZE];
418 	uint32_t csc_pre_bv[DPU_CSC_BIAS_SIZE];
419 	uint32_t csc_post_bv[DPU_CSC_BIAS_SIZE];
420 	uint32_t csc_pre_lv[DPU_CSC_CLAMP_SIZE];
421 	uint32_t csc_post_lv[DPU_CSC_CLAMP_SIZE];
422 };
423 
424 /**
425  * struct dpu_mdss_color - mdss color description
426  * color 0 : green
427  * color 1 : blue
428  * color 2 : red
429  * color 3 : alpha
430  */
431 struct dpu_mdss_color {
432 	u32 color_0;
433 	u32 color_1;
434 	u32 color_2;
435 	u32 color_3;
436 };
437 
438 /*
439  * Define bit masks for h/w logging.
440  */
441 #define DPU_DBG_MASK_NONE     (1 << 0)
442 #define DPU_DBG_MASK_INTF     (1 << 1)
443 #define DPU_DBG_MASK_LM       (1 << 2)
444 #define DPU_DBG_MASK_CTL      (1 << 3)
445 #define DPU_DBG_MASK_PINGPONG (1 << 4)
446 #define DPU_DBG_MASK_SSPP     (1 << 5)
447 #define DPU_DBG_MASK_WB       (1 << 6)
448 #define DPU_DBG_MASK_TOP      (1 << 7)
449 #define DPU_DBG_MASK_VBIF     (1 << 8)
450 #define DPU_DBG_MASK_ROT      (1 << 9)
451 #define DPU_DBG_MASK_DSPP     (1 << 10)
452 #define DPU_DBG_MASK_DSC      (1 << 11)
453 
454 #endif  /* _DPU_HW_MDSS_H */
455