xref: /openbmc/linux/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h (revision f59a3ee6)
1 /* Copyright 2012-15 Advanced Micro Devices, Inc.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a
4  * copy of this software and associated documentation files (the "Software"),
5  * to deal in the Software without restriction, including without limitation
6  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
7  * and/or sell copies of the Software, and to permit persons to whom the
8  * Software is furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
16  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
17  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19  * OTHER DEALINGS IN THE SOFTWARE.
20  *
21  * Authors: AMD
22  *
23  */
24 
25 /**
26  * DOC: mpc-overview
27  *
28  * Multiple Pipe/Plane Combined (MPC) is a component in the hardware pipeline
29  * that performs blending of multiple planes, using global and per-pixel alpha.
30  * It also performs post-blending color correction operations according to the
31  * hardware capabilities, such as color transformation matrix and gamma 1D and
32  * 3D LUT.
33  */
34 
35 #ifndef __DC_MPCC_H__
36 #define __DC_MPCC_H__
37 
38 #include "dc_hw_types.h"
39 #include "hw_shared.h"
40 #include "transform.h"
41 
42 #define MAX_MPCC 6
43 #define MAX_OPP 6
44 
45 #define MAX_DWB		2
46 
47 enum mpc_output_csc_mode {
48 	MPC_OUTPUT_CSC_DISABLE = 0,
49 	MPC_OUTPUT_CSC_COEF_A,
50 	MPC_OUTPUT_CSC_COEF_B
51 };
52 
53 
54 enum mpcc_blend_mode {
55 	MPCC_BLEND_MODE_BYPASS,
56 	MPCC_BLEND_MODE_TOP_LAYER_PASSTHROUGH,
57 	MPCC_BLEND_MODE_TOP_LAYER_ONLY,
58 	MPCC_BLEND_MODE_TOP_BOT_BLENDING
59 };
60 
61 /**
62  * enum mpcc_alpha_blend_mode - define the alpha blend mode regarding pixel
63  * alpha and plane alpha values
64  */
65 enum mpcc_alpha_blend_mode {
66 	/**
67 	 * @MPCC_ALPHA_BLEND_MODE_PER_PIXEL_ALPHA: per pixel alpha using DPP
68 	 * alpha value
69 	 */
70 	MPCC_ALPHA_BLEND_MODE_PER_PIXEL_ALPHA,
71 	/**
72 	 * @MPCC_ALPHA_BLEND_MODE_PER_PIXEL_ALPHA_COMBINED_GLOBAL_GAIN: per
73 	 * pixel alpha using DPP alpha value multiplied by a global gain (plane
74 	 * alpha)
75 	 */
76 	MPCC_ALPHA_BLEND_MODE_PER_PIXEL_ALPHA_COMBINED_GLOBAL_GAIN,
77 	/**
78 	 * @MPCC_ALPHA_BLEND_MODE_GLOBAL_ALPHA: global alpha value, ignores
79 	 * pixel alpha and consider only plane alpha
80 	 */
81 	MPCC_ALPHA_BLEND_MODE_GLOBAL_ALPHA
82 };
83 
84 /**
85  * struct mpcc_blnd_cfg - MPCC blending configuration
86  *
87  * @black_color: background color
88  * @alpha_mode: alpha blend mode (MPCC_ALPHA_BLND_MODE)
89  * @pre_multiplied_alpha: whether pixel color values were pre-multiplied by the
90  * alpha channel (MPCC_ALPHA_MULTIPLIED_MODE)
91  * @global_gain: used when blend mode considers both pixel alpha and plane
92  * alpha value and assumes the global alpha value.
93  * @global_alpha: plane alpha value
94  */
95 struct mpcc_blnd_cfg {
96 	struct tg_color black_color;	/* background color */
97 	enum mpcc_alpha_blend_mode alpha_mode;	/* alpha blend mode */
98 	bool pre_multiplied_alpha;	/* alpha pre-multiplied mode flag */
99 	int global_gain;
100 	int global_alpha;
101 	bool overlap_only;
102 
103 	/* MPCC top/bottom gain settings */
104 	int bottom_gain_mode;
105 	int background_color_bpc;
106 	int top_gain;
107 	int bottom_inside_gain;
108 	int bottom_outside_gain;
109 };
110 
111 struct mpc_grph_gamut_adjustment {
112 	struct fixed31_32 temperature_matrix[CSC_TEMPERATURE_MATRIX_SIZE];
113 	enum graphics_gamut_adjust_type gamut_adjust_type;
114 };
115 
116 struct mpcc_sm_cfg {
117 	bool enable;
118 	/* 0-single plane,2-row subsampling,4-column subsampling,6-checkboard subsampling */
119 	int sm_mode;
120 	/* 0- disable frame alternate, 1- enable frame alternate */
121 	bool frame_alt;
122 	/* 0- disable field alternate, 1- enable field alternate */
123 	bool field_alt;
124 	/* 0-no force,2-force frame polarity from top,3-force frame polarity from bottom */
125 	int force_next_frame_porlarity;
126 	/* 0-no force,2-force field polarity from top,3-force field polarity from bottom */
127 	int force_next_field_polarity;
128 };
129 
130 struct mpc_denorm_clamp {
131 	int clamp_max_r_cr;
132 	int clamp_min_r_cr;
133 	int clamp_max_g_y;
134 	int clamp_min_g_y;
135 	int clamp_max_b_cb;
136 	int clamp_min_b_cb;
137 };
138 
139 struct mpc_dwb_flow_control {
140 	int flow_ctrl_mode;
141 	int flow_ctrl_cnt0;
142 	int flow_ctrl_cnt1;
143 };
144 
145 /**
146  * struct mpcc - MPCC connection and blending configuration for a single MPCC instance.
147  * @mpcc_id: MPCC physical instance
148  * @dpp_id: DPP input to this MPCC
149  * @mpcc_bot: pointer to bottom layer MPCC. NULL when not connected.
150  * @blnd_cfg: the blending configuration for this MPCC
151  * @sm_cfg: stereo mix setting for this MPCC
152  * @shared_bottom: if MPCC output to both OPP and DWB endpoints, true. Otherwise, false.
153  *
154  * This struct is used as a node in an MPC tree.
155  */
156 struct mpcc {
157 	int mpcc_id;			/* MPCC physical instance */
158 	int dpp_id;			/* DPP input to this MPCC */
159 	struct mpcc *mpcc_bot;		/* pointer to bottom layer MPCC.  NULL when not connected */
160 	struct mpcc_blnd_cfg blnd_cfg;	/* The blending configuration for this MPCC */
161 	struct mpcc_sm_cfg sm_cfg;	/* stereo mix setting for this MPCC */
162 	bool shared_bottom;		/* TRUE if MPCC output to both OPP and DWB endpoints, else FALSE */
163 };
164 
165 /**
166  * struct mpc_tree - MPC tree represents all MPCC connections for a pipe.
167  *
168  * @opp_id: the OPP instance that owns this MPC tree
169  * @opp_list: the top MPCC layer of the MPC tree that outputs to OPP endpoint
170  *
171  */
172 struct mpc_tree {
173 	int opp_id;			/* The OPP instance that owns this MPC tree */
174 	struct mpcc *opp_list;		/* The top MPCC layer of the MPC tree that outputs to OPP endpoint */
175 };
176 
177 struct mpc {
178 	const struct mpc_funcs *funcs;
179 	struct dc_context *ctx;
180 
181 	struct mpcc mpcc_array[MAX_MPCC];
182 	struct pwl_params blender_params;
183 	bool cm_bypass_mode;
184 };
185 
186 struct mpcc_state {
187 	uint32_t opp_id;
188 	uint32_t dpp_id;
189 	uint32_t bot_mpcc_id;
190 	uint32_t mode;
191 	uint32_t alpha_mode;
192 	uint32_t pre_multiplied_alpha;
193 	uint32_t overlap_only;
194 	uint32_t idle;
195 	uint32_t busy;
196 };
197 
198 /**
199  * struct mpc_funcs - funcs
200  */
201 struct mpc_funcs {
202 	void (*read_mpcc_state)(
203 			struct mpc *mpc,
204 			int mpcc_inst,
205 			struct mpcc_state *s);
206 
207 	/**
208 	 * @insert_plane:
209 	 *
210 	 * Insert DPP into MPC tree based on specified blending position.
211 	 * Only used for planes that are part of blending chain for OPP output
212 	 *
213 	 * Parameters:
214 	 * [in/out] mpc		- MPC context.
215 	 * [in/out] tree	- MPC tree structure that plane will be added to.
216 	 * [in]	blnd_cfg	- MPCC blending configuration for the new blending layer.
217 	 * [in]	sm_cfg		- MPCC stereo mix configuration for the new blending layer.
218 	 *			  stereo mix must disable for the very bottom layer of the tree config.
219 	 * [in]	insert_above_mpcc - Insert new plane above this MPCC.  If NULL, insert as bottom plane.
220 	 * [in]	dpp_id		 - DPP instance for the plane to be added.
221 	 * [in]	mpcc_id		 - The MPCC physical instance to use for blending.
222 	 *
223 	 * Return:  struct mpcc* - MPCC that was added.
224 	 */
225 	struct mpcc* (*insert_plane)(
226 			struct mpc *mpc,
227 			struct mpc_tree *tree,
228 			struct mpcc_blnd_cfg *blnd_cfg,
229 			struct mpcc_sm_cfg *sm_cfg,
230 			struct mpcc *insert_above_mpcc,
231 			int dpp_id,
232 			int mpcc_id);
233 
234 	/**
235 	 * @remove_mpcc:
236 	 *
237 	 * Remove a specified MPCC from the MPC tree.
238 	 *
239 	 * Parameters:
240 	 * [in/out] mpc		- MPC context.
241 	 * [in/out] tree	- MPC tree structure that plane will be removed from.
242 	 * [in/out] mpcc	- MPCC to be removed from tree.
243 	 *
244 	 * Return:  void
245 	 */
246 	void (*remove_mpcc)(
247 			struct mpc *mpc,
248 			struct mpc_tree *tree,
249 			struct mpcc *mpcc);
250 
251 	/**
252 	 * @mpc_init:
253 	 *
254 	 * Reset the MPCC HW status by disconnecting all muxes.
255 	 *
256 	 * Parameters:
257 	 * [in/out] mpc		- MPC context.
258 	 *
259 	 * Return:  void
260 	 */
261 	void (*mpc_init)(struct mpc *mpc);
262 	void (*mpc_init_single_inst)(
263 			struct mpc *mpc,
264 			unsigned int mpcc_id);
265 
266 	/**
267 	 * @update_blending:
268 	 *
269 	 * Update the blending configuration for a specified MPCC.
270 	 *
271 	 * Parameters:
272 	 * [in/out] mpc		- MPC context.
273 	 * [in]     blnd_cfg	- MPCC blending configuration.
274 	 * [in]     mpcc_id	- The MPCC physical instance.
275 	 *
276 	 * Return:  void
277 	 */
278 	void (*update_blending)(
279 		struct mpc *mpc,
280 		struct mpcc_blnd_cfg *blnd_cfg,
281 		int mpcc_id);
282 
283 	/**
284 	 * @cursor_lock:
285 	 *
286 	 * Lock cursor updates for the specified OPP.
287 	 * OPP defines the set of MPCC that are locked together for cursor.
288 	 *
289 	 * Parameters:
290 	 * [in] 	mpc		- MPC context.
291 	 * [in]     opp_id	- The OPP to lock cursor updates on
292 	 * [in]		lock	- lock/unlock the OPP
293 	 *
294 	 * Return:  void
295 	 */
296 	void (*cursor_lock)(
297 			struct mpc *mpc,
298 			int opp_id,
299 			bool lock);
300 
301 	/**
302 	 * @insert_plane_to_secondary:
303 	 *
304 	 * Add DPP into secondary MPC tree based on specified blending position.
305 	 * Only used for planes that are part of blending chain for DWB output
306 	 *
307 	 * Parameters:
308 	 * [in/out] mpc		- MPC context.
309 	 * [in/out] tree		- MPC tree structure that plane will be added to.
310 	 * [in]	blnd_cfg	- MPCC blending configuration for the new blending layer.
311 	 * [in]	sm_cfg		- MPCC stereo mix configuration for the new blending layer.
312 	 *			  stereo mix must disable for the very bottom layer of the tree config.
313 	 * [in]	insert_above_mpcc - Insert new plane above this MPCC.  If NULL, insert as bottom plane.
314 	 * [in]	dpp_id		- DPP instance for the plane to be added.
315 	 * [in]	mpcc_id		- The MPCC physical instance to use for blending.
316 	 *
317 	 * Return:  struct mpcc* - MPCC that was added.
318 	 */
319 	struct mpcc* (*insert_plane_to_secondary)(
320 			struct mpc *mpc,
321 			struct mpc_tree *tree,
322 			struct mpcc_blnd_cfg *blnd_cfg,
323 			struct mpcc_sm_cfg *sm_cfg,
324 			struct mpcc *insert_above_mpcc,
325 			int dpp_id,
326 			int mpcc_id);
327 
328 	/**
329 	 * @remove_mpcc_from_secondary:
330 	 *
331 	 * Remove a specified DPP from the 'secondary' MPC tree.
332 	 *
333 	 * Parameters:
334 	 * [in/out] mpc		- MPC context.
335 	 * [in/out] tree	- MPC tree structure that plane will be removed from.
336 	 * [in]     mpcc	- MPCC to be removed from tree.
337 	 * Return:  void
338 	 */
339 	void (*remove_mpcc_from_secondary)(
340 			struct mpc *mpc,
341 			struct mpc_tree *tree,
342 			struct mpcc *mpcc);
343 
344 	struct mpcc* (*get_mpcc_for_dpp_from_secondary)(
345 			struct mpc_tree *tree,
346 			int dpp_id);
347 
348 	struct mpcc* (*get_mpcc_for_dpp)(
349 			struct mpc_tree *tree,
350 			int dpp_id);
351 
352 	void (*wait_for_idle)(struct mpc *mpc, int id);
353 
354 	void (*assert_mpcc_idle_before_connect)(struct mpc *mpc, int mpcc_id);
355 
356 	void (*init_mpcc_list_from_hw)(
357 		struct mpc *mpc,
358 		struct mpc_tree *tree);
359 
360 	void (*set_denorm)(struct mpc *mpc,
361 			int opp_id,
362 			enum dc_color_depth output_depth);
363 
364 	void (*set_denorm_clamp)(
365 			struct mpc *mpc,
366 			int opp_id,
367 			struct mpc_denorm_clamp denorm_clamp);
368 
369 	void (*set_output_csc)(struct mpc *mpc,
370 			int opp_id,
371 			const uint16_t *regval,
372 			enum mpc_output_csc_mode ocsc_mode);
373 
374 	void (*set_ocsc_default)(struct mpc *mpc,
375 			int opp_id,
376 			enum dc_color_space color_space,
377 			enum mpc_output_csc_mode ocsc_mode);
378 
379 	void (*set_output_gamma)(
380 			struct mpc *mpc,
381 			int mpcc_id,
382 			const struct pwl_params *params);
383 	void (*power_on_mpc_mem_pwr)(
384 			struct mpc *mpc,
385 			int mpcc_id,
386 			bool power_on);
387 	void (*set_dwb_mux)(
388 			struct mpc *mpc,
389 			int dwb_id,
390 			int mpcc_id);
391 
392 	void (*disable_dwb_mux)(
393 		struct mpc *mpc,
394 		int dwb_id);
395 
396 	bool (*is_dwb_idle)(
397 		struct mpc *mpc,
398 		int dwb_id);
399 
400 	void (*set_out_rate_control)(
401 		struct mpc *mpc,
402 		int opp_id,
403 		bool enable,
404 		bool rate_2x_mode,
405 		struct mpc_dwb_flow_control *flow_control);
406 
407 	void (*set_gamut_remap)(
408 			struct mpc *mpc,
409 			int mpcc_id,
410 			const struct mpc_grph_gamut_adjustment *adjust);
411 
412 	bool (*program_1dlut)(
413 			struct mpc *mpc,
414 			const struct pwl_params *params,
415 			uint32_t rmu_idx);
416 
417 	bool (*program_shaper)(
418 			struct mpc *mpc,
419 			const struct pwl_params *params,
420 			uint32_t rmu_idx);
421 
422 	uint32_t (*acquire_rmu)(struct mpc *mpc, int mpcc_id, int rmu_idx);
423 
424 	bool (*program_3dlut)(
425 			struct mpc *mpc,
426 			const struct tetrahedral_params *params,
427 			int rmu_idx);
428 
429 	int (*release_rmu)(struct mpc *mpc, int mpcc_id);
430 
431 	unsigned int (*get_mpc_out_mux)(
432 			struct mpc *mpc,
433 			int opp_id);
434 
435 	void (*set_bg_color)(struct mpc *mpc,
436 			struct tg_color *bg_color,
437 			int mpcc_id);
438 	void (*set_mpc_mem_lp_mode)(struct mpc *mpc);
439 };
440 
441 #endif
442