1 /*
2  * Copyright 2012-15 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25 
26 
27 #ifndef __DAL_DPP_H__
28 #define __DAL_DPP_H__
29 
30 /**
31  * DOC: overview
32  *
33  * The DPP (Display Pipe and Plane) block is the unified display data
34  * processing engine in DCN for processing graphic or video data on per DPP
35  * rectangle base. This rectangle can be a part of SLS (Single Large Surface),
36  * or a layer to be blended with other DPP, or a rectangle associated with a
37  * display tile.
38  *
39  * It provides various functions including:
40  * - graphic color keyer
41  * - graphic cursor compositing
42  * - graphic or video image source to destination scaling
43  * - image sharping
44  * - video format conversion from 4:2:0 or 4:2:2 to 4:4:4
45  * - Color Space Conversion
46  * - Host LUT gamma adjustment
47  * - Color Gamut Remap
48  * - brightness and contrast adjustment.
49  *
50  * DPP pipe consists of Converter and Cursor (CNVC), Scaler (DSCL), Color
51  * Management (CM), Output Buffer (OBUF) and Digital Bypass (DPB) module
52  * connected in a video/graphics pipeline.
53  */
54 
55 #include "transform.h"
56 #include "cursor_reg_cache.h"
57 
58 union defer_reg_writes {
59 	struct {
60 		bool disable_blnd_lut:1;
61 		bool disable_3dlut:1;
62 		bool disable_shaper:1;
63 		bool disable_gamcor:1;
64 		bool disable_dscl:1;
65 	} bits;
66 	uint32_t raw;
67 };
68 
69 struct dpp {
70 	const struct dpp_funcs *funcs;
71 	struct dc_context *ctx;
72 	/**
73 	 * @inst:
74 	 *
75 	 * inst stands for "instance," and it is an id number that references a
76 	 * specific DPP.
77 	 */
78 	int inst;
79 	struct dpp_caps *caps;
80 	struct pwl_params regamma_params;
81 	struct pwl_params degamma_params;
82 	struct dpp_cursor_attributes cur_attr;
83 	union defer_reg_writes deferred_reg_writes;
84 
85 	struct pwl_params shaper_params;
86 	bool cm_bypass_mode;
87 
88 	struct cursor_position_cache_dpp  pos;
89 	struct cursor_attribute_cache_dpp att;
90 };
91 
92 struct dpp_input_csc_matrix {
93 	enum dc_color_space color_space;
94 	uint16_t regval[12];
95 };
96 
97 static const struct dpp_input_csc_matrix __maybe_unused dpp_input_csc_matrix[] = {
98 	{ COLOR_SPACE_SRGB,
99 		{ 0x2000, 0,      0,      0,
100 		  0,      0x2000, 0,      0,
101 		  0,      0,      0x2000, 0 } },
102 	{ COLOR_SPACE_SRGB_LIMITED,
103 		{ 0x2000, 0,      0,      0,
104 		  0,      0x2000, 0,      0,
105 		  0,      0,      0x2000, 0 } },
106 	{ COLOR_SPACE_YCBCR601,
107 		{ 0x2cdd, 0x2000, 0,      0xe991,
108 		  0xe926, 0x2000, 0xf4fd, 0x10ef,
109 		  0,      0x2000, 0x38b4, 0xe3a6 } },
110 	{ COLOR_SPACE_YCBCR601_LIMITED,
111 		{ 0x3353, 0x2568, 0,      0xe400,
112 		  0xe5dc, 0x2568, 0xf367, 0x1108,
113 		  0,      0x2568, 0x40de, 0xdd3a } },
114 	{ COLOR_SPACE_YCBCR709,
115 		{ 0x3265, 0x2000, 0,      0xe6ce,
116 		  0xf105, 0x2000, 0xfa01, 0xa7d,
117 		  0,      0x2000, 0x3b61, 0xe24f } },
118 	{ COLOR_SPACE_YCBCR709_LIMITED,
119 		{ 0x39a6, 0x2568, 0,      0xe0d6,
120 		  0xeedd, 0x2568, 0xf925, 0x9a8,
121 		  0,      0x2568, 0x43ee, 0xdbb2 } },
122 	{ COLOR_SPACE_2020_YCBCR_FULL,
123 		{ 0x2F30, 0x2000, 0,      0xE869,
124 		  0xEDB7, 0x2000, 0xFABC, 0xBC6,
125 		  0,      0x2000, 0x3C34, 0xE1E6 } },
126 	{ COLOR_SPACE_2020_YCBCR_LIMITED,
127 		{ 0x35B9, 0x2543, 0,      0xE2B2,
128 		  0xEB2F, 0x2543, 0xFA01, 0x0B1F,
129 		  0,      0x2543, 0x4489, 0xDB42 } },
130 	{ COLOR_SPACE_2020_RGB_LIMITEDRANGE,
131 		{ 0x35E0, 0x255F, 0,      0xE2B3,
132 		  0xEB20, 0x255F, 0xF9FD, 0xB1E,
133 		  0,      0x255F, 0x44BD, 0xDB43 } }
134 };
135 
136 struct dpp_grph_csc_adjustment {
137 	struct fixed31_32 temperature_matrix[CSC_TEMPERATURE_MATRIX_SIZE];
138 	enum graphics_gamut_adjust_type gamut_adjust_type;
139 };
140 
141 struct cnv_color_keyer_params {
142 	int color_keyer_en;
143 	int color_keyer_mode;
144 	int color_keyer_alpha_low;
145 	int color_keyer_alpha_high;
146 	int color_keyer_red_low;
147 	int color_keyer_red_high;
148 	int color_keyer_green_low;
149 	int color_keyer_green_high;
150 	int color_keyer_blue_low;
151 	int color_keyer_blue_high;
152 };
153 
154 /**
155  * struct cnv_alpha_2bit_lut - Set the 8bit alpha values based on the 2 bit alpha
156  */
157 struct cnv_alpha_2bit_lut {
158 	/**
159 	* @lut0: ALPHA_2BIT_LUT. ALPHA_2BIT_LUT0. Default: 0b00000000
160 	*/
161 	int lut0;
162 
163 	/**
164 	 * @lut1: ALPHA_2BIT_LUT. ALPHA_2BIT_LUT1. Default: 0b01010101
165 	 */
166 	int lut1;
167 
168 	/**
169 	 * @lut2: ALPHA_2BIT_LUT. ALPHA_2BIT_LUT2. Default: 0b10101010
170 	 */
171 	int lut2;
172 
173 	/**
174 	 * @lut3: ALPHA_2BIT_LUT. ALPHA_2BIT_LUT3. Default: 0b11111111
175 	 */
176 	int lut3;
177 };
178 
179 struct dcn_dpp_state {
180 	uint32_t is_enabled;
181 	uint32_t igam_lut_mode;
182 	uint32_t igam_input_format;
183 	uint32_t dgam_lut_mode;
184 	uint32_t rgam_lut_mode;
185 	// gamut_remap data for dcn10_get_cm_states()
186 	uint32_t gamut_remap_mode;
187 	uint32_t gamut_remap_c11_c12;
188 	uint32_t gamut_remap_c13_c14;
189 	uint32_t gamut_remap_c21_c22;
190 	uint32_t gamut_remap_c23_c24;
191 	uint32_t gamut_remap_c31_c32;
192 	uint32_t gamut_remap_c33_c34;
193 	// gamut_remap data for dcn*_log_color_state()
194 	struct dpp_grph_csc_adjustment gamut_remap;
195 	uint32_t shaper_lut_mode;
196 	uint32_t lut3d_mode;
197 	uint32_t lut3d_bit_depth;
198 	uint32_t lut3d_size;
199 	uint32_t blnd_lut_mode;
200 	uint32_t pre_dgam_mode;
201 	uint32_t pre_dgam_select;
202 	uint32_t gamcor_mode;
203 };
204 
205 struct CM_bias_params {
206 	uint32_t cm_bias_cr_r;
207 	uint32_t cm_bias_y_g;
208 	uint32_t cm_bias_cb_b;
209 	uint32_t cm_bias_format;
210 };
211 
212 struct dpp_funcs {
213 	bool (*dpp_program_gamcor_lut)(
214 		struct dpp *dpp_base, const struct pwl_params *params);
215 
216 	void (*dpp_set_pre_degam)(struct dpp *dpp_base,
217 			enum dc_transfer_func_predefined tr);
218 
219 	void (*dpp_program_cm_dealpha)(struct dpp *dpp_base,
220 		uint32_t enable, uint32_t additive_blending);
221 
222 	void (*dpp_program_cm_bias)(
223 		struct dpp *dpp_base,
224 		struct CM_bias_params *bias_params);
225 
226 	void (*dpp_read_state)(struct dpp *dpp, struct dcn_dpp_state *s);
227 
228 	void (*dpp_reset)(struct dpp *dpp);
229 
230 	void (*dpp_set_scaler)(struct dpp *dpp,
231 			const struct scaler_data *scl_data);
232 
233 	void (*dpp_set_pixel_storage_depth)(
234 			struct dpp *dpp,
235 			enum lb_pixel_depth depth,
236 			const struct bit_depth_reduction_params *bit_depth_params);
237 
238 	bool (*dpp_get_optimal_number_of_taps)(
239 			struct dpp *dpp,
240 			struct scaler_data *scl_data,
241 			const struct scaling_taps *in_taps);
242 
243 	void (*dpp_set_gamut_remap)(
244 			struct dpp *dpp,
245 			const struct dpp_grph_csc_adjustment *adjust);
246 
247 	void (*dpp_set_csc_default)(
248 		struct dpp *dpp,
249 		enum dc_color_space colorspace);
250 
251 	void (*dpp_set_csc_adjustment)(
252 		struct dpp *dpp,
253 		const uint16_t *regval);
254 
255 	void (*dpp_power_on_regamma_lut)(
256 		struct dpp *dpp,
257 		bool power_on);
258 
259 	void (*dpp_program_regamma_lut)(
260 			struct dpp *dpp,
261 			const struct pwl_result_data *rgb,
262 			uint32_t num);
263 
264 	void (*dpp_configure_regamma_lut)(
265 			struct dpp *dpp,
266 			bool is_ram_a);
267 
268 	void (*dpp_program_regamma_lutb_settings)(
269 			struct dpp *dpp,
270 			const struct pwl_params *params);
271 
272 	void (*dpp_program_regamma_luta_settings)(
273 			struct dpp *dpp,
274 			const struct pwl_params *params);
275 
276 	void (*dpp_program_regamma_pwl)(
277 		struct dpp *dpp,
278 		const struct pwl_params *params,
279 		enum opp_regamma mode);
280 
281 	void (*dpp_program_bias_and_scale)(
282 			struct dpp *dpp,
283 			struct dc_bias_and_scale *params);
284 
285 	void (*dpp_set_degamma)(
286 			struct dpp *dpp_base,
287 			enum ipp_degamma_mode mode);
288 
289 	void (*dpp_program_input_lut)(
290 			struct dpp *dpp_base,
291 			const struct dc_gamma *gamma);
292 
293 	void (*dpp_program_degamma_pwl)(struct dpp *dpp_base,
294 									 const struct pwl_params *params);
295 
296 	void (*dpp_setup)(
297 			struct dpp *dpp_base,
298 			enum surface_pixel_format format,
299 			enum expansion_mode mode,
300 			struct dc_csc_transform input_csc_color_matrix,
301 			enum dc_color_space input_color_space,
302 			struct cnv_alpha_2bit_lut *alpha_2bit_lut);
303 
304 	void (*dpp_full_bypass)(struct dpp *dpp_base);
305 
306 	void (*set_cursor_attributes)(
307 			struct dpp *dpp_base,
308 			struct dc_cursor_attributes *cursor_attributes);
309 
310 	void (*set_cursor_position)(
311 			struct dpp *dpp_base,
312 			const struct dc_cursor_position *pos,
313 			const struct dc_cursor_mi_param *param,
314 			uint32_t width,
315 			uint32_t height
316 			);
317 
318 	void (*dpp_set_hdr_multiplier)(
319 			struct dpp *dpp_base,
320 			uint32_t multiplier);
321 
322 	void (*set_optional_cursor_attributes)(
323 			struct dpp *dpp_base,
324 			struct dpp_cursor_attributes *attr);
325 
326 	void (*dpp_dppclk_control)(
327 			struct dpp *dpp_base,
328 			bool dppclk_div,
329 			bool enable);
330 
331 	void (*dpp_deferred_update)(
332 			struct dpp *dpp);
333 	bool (*dpp_program_blnd_lut)(
334 			struct dpp *dpp,
335 			const struct pwl_params *params);
336 	bool (*dpp_program_shaper_lut)(
337 			struct dpp *dpp,
338 			const struct pwl_params *params);
339 	bool (*dpp_program_3dlut)(
340 			struct dpp *dpp,
341 			const struct tetrahedral_params *params);
342 	void (*dpp_cnv_set_alpha_keyer)(
343 			struct dpp *dpp_base,
344 			struct cnv_color_keyer_params *color_keyer);
345 
346 	void (*dpp_get_gamut_remap)(struct dpp *dpp_base,
347 				    struct dpp_grph_csc_adjustment *adjust);
348 	void (*set_cursor_matrix)(
349 		struct dpp *dpp_base,
350 		enum dc_color_space color_space,
351 		struct dc_csc_transform cursor_csc_color_matrix);
352 };
353 
354 
355 
356 #endif
357