xref: /linux/drivers/gpu/drm/amd/display/dc/dc_stream.h (revision 9c39c6ffe0c2945c7cf814814c096bc23b63f53d)
1 /*
2  * Copyright 2012-14 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 #ifndef DC_STREAM_H_
27 #define DC_STREAM_H_
28 
29 #include "dc_types.h"
30 #include "grph_object_defs.h"
31 
32 /*******************************************************************************
33  * Stream Interfaces
34  ******************************************************************************/
35 struct timing_sync_info {
36 	int group_id;
37 	int group_size;
38 	bool master;
39 };
40 
41 struct dc_stream_status {
42 	int primary_otg_inst;
43 	int stream_enc_inst;
44 	int plane_count;
45 	int audio_inst;
46 	struct timing_sync_info timing_sync_info;
47 	struct dc_plane_state *plane_states[MAX_SURFACE_NUM];
48 	bool is_abm_supported;
49 };
50 
51 // TODO: References to this needs to be removed..
52 struct freesync_context {
53 	bool dummy;
54 };
55 
56 enum hubp_dmdata_mode {
57 	DMDATA_SW_MODE,
58 	DMDATA_HW_MODE
59 };
60 
61 struct dc_dmdata_attributes {
62 	/* Specifies whether dynamic meta data will be updated by software
63 	 * or has to be fetched by hardware (DMA mode)
64 	 */
65 	enum hubp_dmdata_mode dmdata_mode;
66 	/* Specifies if current dynamic meta data is to be used only for the current frame */
67 	bool dmdata_repeat;
68 	/* Specifies the size of Dynamic Metadata surface in byte.  Size of 0 means no Dynamic metadata is fetched */
69 	uint32_t dmdata_size;
70 	/* Specifies if a new dynamic meta data should be fetched for an upcoming frame */
71 	bool dmdata_updated;
72 	/* If hardware mode is used, the base address where DMDATA surface is located */
73 	PHYSICAL_ADDRESS_LOC address;
74 	/* Specifies whether QOS level will be provided by TTU or it will come from DMDATA_QOS_LEVEL */
75 	bool dmdata_qos_mode;
76 	/* If qos_mode = 1, this is the QOS value to be used: */
77 	uint32_t dmdata_qos_level;
78 	/* Specifies the value in unit of REFCLK cycles to be added to the
79 	 * current time to produce the Amortized deadline for Dynamic Metadata chunk request
80 	 */
81 	uint32_t dmdata_dl_delta;
82 	/* An unbounded array of uint32s, represents software dmdata to be loaded */
83 	uint32_t *dmdata_sw_data;
84 };
85 
86 struct dc_writeback_info {
87 	bool wb_enabled;
88 	int dwb_pipe_inst;
89 	struct dc_dwb_params dwb_params;
90 	struct mcif_buf_params mcif_buf_params;
91 	struct mcif_warmup_params mcif_warmup_params;
92 	/* the plane that is the input to TOP_MUX for MPCC that is the DWB source */
93 	struct dc_plane_state *writeback_source_plane;
94 	/* source MPCC instance.  for use by internally by dc */
95 	int mpcc_inst;
96 };
97 
98 struct dc_writeback_update {
99 	unsigned int num_wb_info;
100 	struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
101 };
102 
103 enum vertical_interrupt_ref_point {
104 	START_V_UPDATE = 0,
105 	START_V_SYNC,
106 	INVALID_POINT
107 
108 	//For now, only v_update interrupt is used.
109 	//START_V_BLANK,
110 	//START_V_ACTIVE
111 };
112 
113 struct periodic_interrupt_config {
114 	enum vertical_interrupt_ref_point ref_point;
115 	int lines_offset;
116 };
117 
118 union stream_update_flags {
119 	struct {
120 		uint32_t scaling:1;
121 		uint32_t out_tf:1;
122 		uint32_t out_csc:1;
123 		uint32_t abm_level:1;
124 		uint32_t dpms_off:1;
125 		uint32_t gamut_remap:1;
126 		uint32_t wb_update:1;
127 		uint32_t dsc_changed : 1;
128 	} bits;
129 
130 	uint32_t raw;
131 };
132 
133 struct test_pattern {
134 	enum dp_test_pattern type;
135 	enum dp_test_pattern_color_space color_space;
136 	struct link_training_settings const *p_link_settings;
137 	unsigned char const *p_custom_pattern;
138 	unsigned int cust_pattern_size;
139 };
140 
141 struct dc_stream_state {
142 	// sink is deprecated, new code should not reference
143 	// this pointer
144 	struct dc_sink *sink;
145 
146 	struct dc_link *link;
147 	/* For dynamic link encoder assignment, update the link encoder assigned to
148 	 * a stream via the volatile dc_state rather than the static dc_link.
149 	 */
150 	struct link_encoder *link_enc;
151 	struct dc_panel_patch sink_patches;
152 	union display_content_support content_support;
153 	struct dc_crtc_timing timing;
154 	struct dc_crtc_timing_adjust adjust;
155 	struct dc_info_packet vrr_infopacket;
156 	struct dc_info_packet vsc_infopacket;
157 	struct dc_info_packet vsp_infopacket;
158 
159 	struct rect src; /* composition area */
160 	struct rect dst; /* stream addressable area */
161 
162 	// TODO: References to this needs to be removed..
163 	struct freesync_context freesync_ctx;
164 
165 	struct audio_info audio_info;
166 
167 	struct dc_info_packet hdr_static_metadata;
168 	PHYSICAL_ADDRESS_LOC dmdata_address;
169 	bool   use_dynamic_meta;
170 
171 	struct dc_transfer_func *out_transfer_func;
172 	struct colorspace_transform gamut_remap_matrix;
173 	struct dc_csc_transform csc_color_matrix;
174 
175 	enum dc_color_space output_color_space;
176 	enum dc_dither_option dither_option;
177 
178 	enum view_3d_format view_format;
179 
180 	bool use_vsc_sdp_for_colorimetry;
181 	bool ignore_msa_timing_param;
182 	bool converter_disable_audio;
183 	uint8_t qs_bit;
184 	uint8_t qy_bit;
185 
186 	/* TODO: custom INFO packets */
187 	/* TODO: ABM info (DMCU) */
188 	/* TODO: CEA VIC */
189 
190 	/* DMCU info */
191 	unsigned int abm_level;
192 
193 	struct periodic_interrupt_config periodic_interrupt0;
194 	struct periodic_interrupt_config periodic_interrupt1;
195 
196 	/* from core_stream struct */
197 	struct dc_context *ctx;
198 
199 	/* used by DCP and FMT */
200 	struct bit_depth_reduction_params bit_depth_params;
201 	struct clamping_and_pixel_encoding_params clamping;
202 
203 	int phy_pix_clk;
204 	enum signal_type signal;
205 	bool dpms_off;
206 
207 	void *dm_stream_context;
208 
209 	struct dc_cursor_attributes cursor_attributes;
210 	struct dc_cursor_position cursor_position;
211 	uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
212 
213 	/* from stream struct */
214 	struct kref refcount;
215 
216 	struct crtc_trigger_info triggered_crtc_reset;
217 
218 	/* writeback */
219 	unsigned int num_wb_info;
220 	struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
221 	const struct dc_transfer_func *func_shaper;
222 	const struct dc_3dlut *lut3d_func;
223 	/* Computed state bits */
224 	bool mode_changed : 1;
225 
226 	/* Output from DC when stream state is committed or altered
227 	 * DC may only access these values during:
228 	 * dc_commit_state, dc_commit_state_no_check, dc_commit_streams
229 	 * values may not change outside of those calls
230 	 */
231 	struct {
232 		// For interrupt management, some hardware instance
233 		// offsets need to be exposed to DM
234 		uint8_t otg_offset;
235 	} out;
236 
237 	bool apply_edp_fast_boot_optimization;
238 	bool apply_seamless_boot_optimization;
239 
240 	uint32_t stream_id;
241 	bool is_dsc_enabled;
242 
243 	struct test_pattern test_pattern;
244 	union stream_update_flags update_flags;
245 
246 	bool has_non_synchronizable_pclk;
247 	bool vblank_synchronized;
248 };
249 
250 #define ABM_LEVEL_IMMEDIATE_DISABLE 255
251 
252 struct dc_stream_update {
253 	struct dc_stream_state *stream;
254 
255 	struct rect src;
256 	struct rect dst;
257 	struct dc_transfer_func *out_transfer_func;
258 	struct dc_info_packet *hdr_static_metadata;
259 	unsigned int *abm_level;
260 
261 	struct periodic_interrupt_config *periodic_interrupt0;
262 	struct periodic_interrupt_config *periodic_interrupt1;
263 
264 	struct dc_info_packet *vrr_infopacket;
265 	struct dc_info_packet *vsc_infopacket;
266 	struct dc_info_packet *vsp_infopacket;
267 
268 	bool *dpms_off;
269 	bool integer_scaling_update;
270 
271 	struct colorspace_transform *gamut_remap;
272 	enum dc_color_space *output_color_space;
273 	enum dc_dither_option *dither_option;
274 
275 	struct dc_csc_transform *output_csc_transform;
276 
277 	struct dc_writeback_update *wb_update;
278 	struct dc_dsc_config *dsc_config;
279 	struct dc_transfer_func *func_shaper;
280 	struct dc_3dlut *lut3d_func;
281 
282 	struct test_pattern *pending_test_pattern;
283 };
284 
285 bool dc_is_stream_unchanged(
286 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
287 bool dc_is_stream_scaling_unchanged(
288 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
289 
290 /*
291  * Set up surface attributes and associate to a stream
292  * The surfaces parameter is an absolute set of all surface active for the stream.
293  * If no surfaces are provided, the stream will be blanked; no memory read.
294  * Any flip related attribute changes must be done through this interface.
295  *
296  * After this call:
297  *   Surfaces attributes are programmed and configured to be composed into stream.
298  *   This does not trigger a flip.  No surface address is programmed.
299  */
300 
301 void dc_commit_updates_for_stream(struct dc *dc,
302 		struct dc_surface_update *srf_updates,
303 		int surface_count,
304 		struct dc_stream_state *stream,
305 		struct dc_stream_update *stream_update,
306 		struct dc_state *state);
307 /*
308  * Log the current stream state.
309  */
310 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream);
311 
312 uint8_t dc_get_current_stream_count(struct dc *dc);
313 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i);
314 struct dc_stream_state *dc_stream_find_from_link(const struct dc_link *link);
315 
316 /*
317  * Return the current frame counter.
318  */
319 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream);
320 
321 /*
322  * Send dp sdp message.
323  */
324 bool dc_stream_send_dp_sdp(const struct dc_stream_state *stream,
325 		const uint8_t *custom_sdp_message,
326 		unsigned int sdp_message_size);
327 
328 /* TODO: Return parsed values rather than direct register read
329  * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos)
330  * being refactored properly to be dce-specific
331  */
332 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream,
333 				  uint32_t *v_blank_start,
334 				  uint32_t *v_blank_end,
335 				  uint32_t *h_position,
336 				  uint32_t *v_position);
337 
338 enum dc_status dc_add_stream_to_ctx(
339 			struct dc *dc,
340 		struct dc_state *new_ctx,
341 		struct dc_stream_state *stream);
342 
343 enum dc_status dc_remove_stream_from_ctx(
344 		struct dc *dc,
345 			struct dc_state *new_ctx,
346 			struct dc_stream_state *stream);
347 
348 
349 bool dc_add_plane_to_context(
350 		const struct dc *dc,
351 		struct dc_stream_state *stream,
352 		struct dc_plane_state *plane_state,
353 		struct dc_state *context);
354 
355 bool dc_remove_plane_from_context(
356 		const struct dc *dc,
357 		struct dc_stream_state *stream,
358 		struct dc_plane_state *plane_state,
359 		struct dc_state *context);
360 
361 bool dc_rem_all_planes_for_stream(
362 		const struct dc *dc,
363 		struct dc_stream_state *stream,
364 		struct dc_state *context);
365 
366 bool dc_add_all_planes_for_stream(
367 		const struct dc *dc,
368 		struct dc_stream_state *stream,
369 		struct dc_plane_state * const *plane_states,
370 		int plane_count,
371 		struct dc_state *context);
372 
373 bool dc_stream_add_writeback(struct dc *dc,
374 		struct dc_stream_state *stream,
375 		struct dc_writeback_info *wb_info);
376 
377 bool dc_stream_remove_writeback(struct dc *dc,
378 		struct dc_stream_state *stream,
379 		uint32_t dwb_pipe_inst);
380 
381 enum dc_status dc_stream_add_dsc_to_resource(struct dc *dc,
382 		struct dc_state *state,
383 		struct dc_stream_state *stream);
384 
385 bool dc_stream_warmup_writeback(struct dc *dc,
386 		int num_dwb,
387 		struct dc_writeback_info *wb_info);
388 
389 bool dc_stream_dmdata_status_done(struct dc *dc, struct dc_stream_state *stream);
390 
391 bool dc_stream_set_dynamic_metadata(struct dc *dc,
392 		struct dc_stream_state *stream,
393 		struct dc_dmdata_attributes *dmdata_attr);
394 
395 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream);
396 
397 /*
398  * Set up streams and links associated to drive sinks
399  * The streams parameter is an absolute set of all active streams.
400  *
401  * After this call:
402  *   Phy, Encoder, Timing Generator are programmed and enabled.
403  *   New streams are enabled with blank stream; no memory read.
404  */
405 /*
406  * Enable stereo when commit_streams is not required,
407  * for example, frame alternate.
408  */
409 void dc_enable_stereo(
410 	struct dc *dc,
411 	struct dc_state *context,
412 	struct dc_stream_state *streams[],
413 	uint8_t stream_count);
414 
415 /* Triggers multi-stream synchronization. */
416 void dc_trigger_sync(struct dc *dc, struct dc_state *context);
417 
418 enum surface_update_type dc_check_update_surfaces_for_stream(
419 		struct dc *dc,
420 		struct dc_surface_update *updates,
421 		int surface_count,
422 		struct dc_stream_update *stream_update,
423 		const struct dc_stream_status *stream_status);
424 
425 /**
426  * Create a new default stream for the requested sink
427  */
428 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink);
429 
430 struct dc_stream_state *dc_copy_stream(const struct dc_stream_state *stream);
431 
432 void update_stream_signal(struct dc_stream_state *stream, struct dc_sink *sink);
433 
434 void dc_stream_retain(struct dc_stream_state *dc_stream);
435 void dc_stream_release(struct dc_stream_state *dc_stream);
436 
437 struct dc_stream_status *dc_stream_get_status_from_state(
438 	struct dc_state *state,
439 	struct dc_stream_state *stream);
440 struct dc_stream_status *dc_stream_get_status(
441 	struct dc_stream_state *dc_stream);
442 
443 #ifndef TRIM_FSFT
444 bool dc_optimize_timing_for_fsft(
445 	struct dc_stream_state *pStream,
446 	unsigned int max_input_rate_in_khz);
447 #endif
448 
449 /*******************************************************************************
450  * Cursor interfaces - To manages the cursor within a stream
451  ******************************************************************************/
452 /* TODO: Deprecated once we switch to dc_set_cursor_position */
453 bool dc_stream_set_cursor_attributes(
454 	struct dc_stream_state *stream,
455 	const struct dc_cursor_attributes *attributes);
456 
457 bool dc_stream_set_cursor_position(
458 	struct dc_stream_state *stream,
459 	const struct dc_cursor_position *position);
460 
461 
462 bool dc_stream_adjust_vmin_vmax(struct dc *dc,
463 				struct dc_stream_state *stream,
464 				struct dc_crtc_timing_adjust *adjust);
465 
466 bool dc_stream_get_crtc_position(struct dc *dc,
467 				 struct dc_stream_state **stream,
468 				 int num_streams,
469 				 unsigned int *v_pos,
470 				 unsigned int *nom_v_pos);
471 
472 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY)
473 bool dc_stream_forward_dmcu_crc_window(struct dc *dc, struct dc_stream_state *stream,
474 			     struct crc_params *crc_window);
475 bool dc_stream_stop_dmcu_crc_win_update(struct dc *dc,
476 				 struct dc_stream_state *stream);
477 #endif
478 
479 bool dc_stream_configure_crc(struct dc *dc,
480 			     struct dc_stream_state *stream,
481 			     struct crc_params *crc_window,
482 			     bool enable,
483 			     bool continuous);
484 
485 bool dc_stream_get_crc(struct dc *dc,
486 		       struct dc_stream_state *stream,
487 		       uint32_t *r_cr,
488 		       uint32_t *g_y,
489 		       uint32_t *b_cb);
490 
491 void dc_stream_set_static_screen_params(struct dc *dc,
492 					struct dc_stream_state **stream,
493 					int num_streams,
494 					const struct dc_static_screen_params *params);
495 
496 void dc_stream_set_dyn_expansion(struct dc *dc, struct dc_stream_state *stream,
497 		enum dc_dynamic_expansion option);
498 
499 void dc_stream_set_dither_option(struct dc_stream_state *stream,
500 				 enum dc_dither_option option);
501 
502 bool dc_stream_set_gamut_remap(struct dc *dc,
503 			       const struct dc_stream_state *stream);
504 
505 bool dc_stream_program_csc_matrix(struct dc *dc,
506 				  struct dc_stream_state *stream);
507 
508 bool dc_stream_get_crtc_position(struct dc *dc,
509 				 struct dc_stream_state **stream,
510 				 int num_streams,
511 				 unsigned int *v_pos,
512 				 unsigned int *nom_v_pos);
513 
514 #endif /* DC_STREAM_H_ */
515