xref: /linux/drivers/gpu/drm/amd/display/dc/dc_stream.h (revision cb8fef4b07f71da01843457b66e579ad248a625e)
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 mall_stream_config {
42 	/* MALL stream config to indicate if the stream is phantom or not.
43 	 * We will use a phantom stream to indicate that the pipe is phantom.
44 	 */
45 	enum mall_stream_type type;
46 	struct dc_stream_state *paired_stream;	// master / slave stream
47 	bool subvp_limit_cursor_size; /* stream has/is using subvp limiting hw cursor support */
48 	bool cursor_size_limit_subvp; /* stream is using hw cursor config preventing subvp */
49 };
50 
51 struct dc_stream_status {
52 	int primary_otg_inst;
53 	int stream_enc_inst;
54 
55 	/**
56 	 * @plane_count: Total of planes attached to a single stream
57 	 */
58 	int plane_count;
59 	int audio_inst;
60 	struct timing_sync_info timing_sync_info;
61 	struct dc_plane_state *plane_states[MAX_SURFACES];
62 	bool is_abm_supported;
63 	struct mall_stream_config mall_stream_config;
64 	bool fpo_in_use;
65 };
66 
67 
68 struct dc_writeback_info {
69 	bool wb_enabled;
70 	int dwb_pipe_inst;
71 	struct dc_dwb_params dwb_params;
72 	struct mcif_buf_params mcif_buf_params;
73 	struct mcif_warmup_params mcif_warmup_params;
74 	/* the plane that is the input to TOP_MUX for MPCC that is the DWB source */
75 	struct dc_plane_state *writeback_source_plane;
76 	/* source MPCC instance.  for use by internally by dc */
77 	int mpcc_inst;
78 };
79 
80 struct dc_writeback_update {
81 	unsigned int num_wb_info;
82 	struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
83 };
84 
85 enum vertical_interrupt_ref_point {
86 	START_V_UPDATE = 0,
87 	START_V_SYNC,
88 	INVALID_POINT
89 
90 	//For now, only v_update interrupt is used.
91 	//START_V_BLANK,
92 	//START_V_ACTIVE
93 };
94 
95 struct periodic_interrupt_config {
96 	enum vertical_interrupt_ref_point ref_point;
97 	int lines_offset;
98 };
99 
100 struct dc_mst_stream_bw_update {
101 	bool is_increase; // is bandwidth reduced or increased
102 	uint32_t mst_stream_bw; // new mst bandwidth in kbps
103 };
104 
105 union stream_update_flags {
106 	struct {
107 		uint32_t scaling:1;
108 		uint32_t out_tf:1;
109 		uint32_t out_csc:1;
110 		uint32_t abm_level:1;
111 		uint32_t dpms_off:1;
112 		uint32_t gamut_remap:1;
113 		uint32_t wb_update:1;
114 		uint32_t dsc_changed : 1;
115 		uint32_t mst_bw : 1;
116 		uint32_t crtc_timing_adjust : 1;
117 		uint32_t fams_changed : 1;
118 		uint32_t scaler_sharpener : 1;
119 		uint32_t sharpening_required : 1;
120 		uint32_t cursor_attr : 1;
121 		uint32_t cursor_pos : 1;
122 		uint32_t periodic_interrupt : 1;
123 		uint32_t info_frame : 1;
124 		uint32_t dmdata : 1;
125 		uint32_t dither : 1;
126 		uint32_t func_shaper : 1;
127 		uint32_t lut3d_func : 1;
128 		uint32_t reserved : 11; /* adjust when adding new flags */
129 	} bits;
130 
131 	uint32_t raw;
132 };
133 
134 static inline void stream_update_flags_clear(union stream_update_flags *flags)
135 {
136 	flags->raw = 0;
137 }
138 
139 static inline void stream_update_flags_set_full(union stream_update_flags *flags)
140 {
141 	stream_update_flags_clear(flags);
142 	flags->bits.scaling = 1;
143 	flags->bits.out_tf = 1;
144 	flags->bits.out_csc = 1;
145 	flags->bits.abm_level = 1;
146 	flags->bits.dpms_off = 1;
147 	flags->bits.gamut_remap = 1;
148 	flags->bits.wb_update = 1;
149 	flags->bits.dsc_changed = 1;
150 	flags->bits.mst_bw = 1;
151 	flags->bits.crtc_timing_adjust = 1;
152 	flags->bits.fams_changed = 1;
153 	flags->bits.scaler_sharpener = 1;
154 	flags->bits.sharpening_required = 1;
155 	flags->bits.cursor_attr = 1;
156 	flags->bits.cursor_pos = 1;
157 	flags->bits.periodic_interrupt = 1;
158 	flags->bits.info_frame = 1;
159 	flags->bits.dmdata = 1;
160 	flags->bits.dither = 1;
161 }
162 
163 struct test_pattern {
164 	enum dp_test_pattern type;
165 	enum dp_test_pattern_color_space color_space;
166 	struct link_training_settings const *p_link_settings;
167 	unsigned char const *p_custom_pattern;
168 	unsigned int cust_pattern_size;
169 };
170 
171 #define SUBVP_DRR_MARGIN_US 100 // 100us for DRR margin (SubVP + DRR)
172 
173 struct dc_stream_debug_options {
174 	uint8_t force_odm_combine_segments;
175 	/*
176 	 * When force_odm_combine_segments is non zero, allow dc to
177 	 * temporarily transition to ODM bypass when minimal transition state
178 	 * is required to prevent visual glitches showing on the screen
179 	 */
180 	uint8_t allow_transition_for_forced_odm;
181 };
182 
183 #define LUMINANCE_DATA_TABLE_SIZE 10
184 
185 struct luminance_data {
186 	bool is_valid;
187 	int refresh_rate_hz[LUMINANCE_DATA_TABLE_SIZE];
188 	int luminance_millinits[LUMINANCE_DATA_TABLE_SIZE];
189 	int flicker_criteria_milli_nits_GAMING;
190 	int flicker_criteria_milli_nits_STATIC;
191 	unsigned int nominal_refresh_rate;
192 	unsigned int dm_max_decrease_from_nominal;
193 };
194 
195 enum dc_drr_trigger_mode {
196 	DRR_TRIGGER_ON_FLIP = 0,
197 	DRR_TRIGGER_ON_FLIP_AND_CURSOR,
198 };
199 
200 struct dc_stream_state {
201 	// sink is deprecated, new code should not reference
202 	// this pointer
203 	struct dc_sink *sink;
204 
205 	struct dc_link *link;
206 	/* For dynamic link encoder assignment, update the link encoder assigned to
207 	 * a stream via the volatile dc_state rather than the static dc_link.
208 	 */
209 	struct link_encoder *link_enc;
210 	struct dc_stream_debug_options debug;
211 	struct dc_panel_patch sink_patches;
212 	struct dc_crtc_timing timing;
213 	struct dc_crtc_timing_adjust adjust;
214 	struct dc_info_packet vrr_infopacket;
215 	struct dc_info_packet vsc_infopacket;
216 	struct dc_info_packet vsp_infopacket;
217 	struct dc_info_packet hfvsif_infopacket;
218 	struct dc_info_packet vtem_infopacket;
219 	struct dc_info_packet adaptive_sync_infopacket;
220 	struct dc_info_packet avi_infopacket;
221 	uint8_t dsc_packed_pps[128];
222 	struct rect src; /* composition area */
223 	struct rect dst; /* stream addressable area */
224 
225 	struct audio_info audio_info;
226 
227 	struct dc_info_packet hdr_static_metadata;
228 	PHYSICAL_ADDRESS_LOC dmdata_address;
229 	bool   use_dynamic_meta;
230 
231 	struct dc_transfer_func out_transfer_func;
232 	struct colorspace_transform gamut_remap_matrix;
233 	struct dc_csc_transform csc_color_matrix;
234 
235 	enum dc_color_space output_color_space;
236 	enum display_content_type content_type;
237 	enum dc_dither_option dither_option;
238 
239 	enum view_3d_format view_format;
240 
241 	bool use_vsc_sdp_for_colorimetry;
242 	bool ignore_msa_timing_param;
243 
244 	/**
245 	 * @allow_freesync:
246 	 *
247 	 * It say if Freesync is enabled or not.
248 	 */
249 	bool allow_freesync;
250 
251 	/**
252 	 * @vrr_active_variable:
253 	 *
254 	 * It describes if VRR is in use.
255 	 */
256 	bool vrr_active_variable;
257 	bool freesync_on_desktop;
258 	bool vrr_active_fixed;
259 
260 	bool converter_disable_audio;
261 	uint8_t qs_bit;
262 	uint8_t qy_bit;
263 
264 	/* TODO: custom INFO packets */
265 	/* TODO: ABM info (DMCU) */
266 	/* TODO: CEA VIC */
267 
268 	/* DMCU info */
269 	unsigned int abm_level;
270 
271 	struct periodic_interrupt_config periodic_interrupt;
272 
273 	/* from core_stream struct */
274 	struct dc_context *ctx;
275 
276 	/* used by DCP and FMT */
277 	struct bit_depth_reduction_params bit_depth_params;
278 	struct clamping_and_pixel_encoding_params clamping;
279 
280 	int phy_pix_clk;
281 	enum signal_type signal;
282 	bool dpms_off;
283 
284 	void *dm_stream_context;
285 
286 	struct dc_cursor_attributes cursor_attributes;
287 	struct dc_cursor_position cursor_position;
288 	bool hw_cursor_req;
289 
290 	uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
291 
292 	/* from stream struct */
293 	struct kref refcount;
294 
295 	struct crtc_trigger_info triggered_crtc_reset;
296 
297 	/* writeback */
298 	unsigned int num_wb_info;
299 	struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
300 	const struct dc_transfer_func *func_shaper;
301 	const struct dc_3dlut *lut3d_func;
302 	/* Computed state bits */
303 	bool mode_changed : 1;
304 
305 	/* Output from DC when stream state is committed or altered
306 	 * DC may only access these values during:
307 	 * dc_commit_state, dc_commit_state_no_check, dc_commit_streams
308 	 * values may not change outside of those calls
309 	 */
310 	struct {
311 		// For interrupt management, some hardware instance
312 		// offsets need to be exposed to DM
313 		uint8_t otg_offset;
314 	} out;
315 
316 	bool apply_edp_fast_boot_optimization;
317 	bool apply_seamless_boot_optimization;
318 	uint32_t apply_boot_odm_mode;
319 
320 	uint32_t stream_id;
321 
322 	struct test_pattern test_pattern;
323 	union stream_update_flags update_flags;
324 
325 	bool has_non_synchronizable_pclk;
326 	bool vblank_synchronized;
327 	bool is_phantom;
328 
329 	struct luminance_data lumin_data;
330 	bool scaler_sharpener_update;
331 	bool sharpening_required;
332 
333 	enum dc_drr_trigger_mode drr_trigger_mode;
334 
335 
336 	enum dc_blending_linearity blending_linearity;
337 	struct dc_update_scratch_space *update_scratch;
338 	bool firmware_controlled_hdr_info_packet;
339 };
340 
341 #define ABM_LEVEL_IMMEDIATE_DISABLE 255
342 
343 struct dc_stream_update {
344 	struct dc_stream_state *stream;
345 
346 	struct rect src;
347 	struct rect dst;
348 	struct dc_transfer_func *out_transfer_func;
349 	struct dc_info_packet *hdr_static_metadata;
350 	unsigned int *abm_level;
351 
352 	struct periodic_interrupt_config *periodic_interrupt;
353 
354 	struct dc_info_packet *vrr_infopacket;
355 	struct dc_info_packet *vsc_infopacket;
356 	struct dc_info_packet *vsp_infopacket;
357 	struct dc_info_packet *hfvsif_infopacket;
358 	struct dc_info_packet *vtem_infopacket;
359 	struct dc_info_packet *adaptive_sync_infopacket;
360 	struct dc_info_packet *avi_infopacket;
361 
362 	bool *dpms_off;
363 	bool integer_scaling_update;
364 	bool *allow_freesync;
365 	bool *vrr_active_variable;
366 	bool *vrr_active_fixed;
367 
368 	struct colorspace_transform *gamut_remap;
369 	enum dc_color_space *output_color_space;
370 	enum dc_dither_option *dither_option;
371 
372 	struct dc_csc_transform *output_csc_transform;
373 
374 	struct dc_writeback_update *wb_update;
375 	struct dc_dsc_config *dsc_config;
376 	struct dc_mst_stream_bw_update *mst_bw_update;
377 	struct dc_transfer_func *func_shaper;
378 	struct dc_3dlut *lut3d_func;
379 
380 	struct test_pattern *pending_test_pattern;
381 	struct dc_crtc_timing_adjust *crtc_timing_adjust;
382 
383 	struct dc_cursor_attributes *cursor_attributes;
384 	struct dc_cursor_position *cursor_position;
385 	bool *hw_cursor_req;
386 	bool *scaler_sharpener_update;
387 	bool *sharpening_required;
388 
389 	enum dc_blending_linearity *blending_linearity;
390 
391 	enum dc_drr_trigger_mode *drr_trigger_mode;
392 };
393 
394 bool dc_is_stream_unchanged(
395 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
396 bool dc_is_stream_scaling_unchanged(
397 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
398 
399 /*
400  * Setup stream attributes if no stream updates are provided
401  * there will be no impact on the stream parameters
402  *
403  * Set up surface attributes and associate to a stream
404  * The surfaces parameter is an absolute set of all surface active for the stream.
405  * If no surfaces are provided, the stream will be blanked; no memory read.
406  * Any flip related attribute changes must be done through this interface.
407  *
408  * After this call:
409  *   Surfaces attributes are programmed and configured to be composed into stream.
410  *   This does not trigger a flip.  No surface address is programmed.
411  *
412  */
413 bool dc_update_planes_and_stream(struct dc *dc,
414 		struct dc_surface_update *surface_updates, int surface_count,
415 		struct dc_stream_state *dc_stream,
416 		struct dc_stream_update *stream_update);
417 
418 struct dc_state_update;
419 
420 
421 /*
422  * Set up surface attributes and associate to a stream
423  * The surfaces parameter is an absolute set of all surface active for the stream.
424  * If no surfaces are provided, the stream will be blanked; no memory read.
425  * Any flip related attribute changes must be done through this interface.
426  *
427  * After this call:
428  *   Surfaces attributes are programmed and configured to be composed into stream.
429  *   This does not trigger a flip.  No surface address is programmed.
430  */
431 void dc_commit_updates_for_stream(struct dc *dc,
432 		struct dc_surface_update *srf_updates,
433 		int surface_count,
434 		struct dc_stream_state *stream,
435 		struct dc_stream_update *stream_update,
436 		struct dc_state *state);
437 /*
438  * Log the current stream state.
439  */
440 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream);
441 
442 uint8_t dc_get_current_stream_count(struct dc *dc);
443 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i);
444 
445 /*
446  * Return the current frame counter.
447  */
448 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream);
449 
450 /*
451  * Send dp sdp message.
452  */
453 bool dc_stream_send_dp_sdp(const struct dc_stream_state *stream,
454 		const uint8_t *custom_sdp_message,
455 		unsigned int sdp_message_size);
456 
457 /* TODO: Return parsed values rather than direct register read
458  * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos)
459  * being refactored properly to be dce-specific
460  */
461 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream,
462 				  uint32_t *v_blank_start,
463 				  uint32_t *v_blank_end,
464 				  uint32_t *h_position,
465 				  uint32_t *v_position);
466 
467 bool dc_stream_add_writeback(struct dc *dc,
468 		struct dc_stream_state *stream,
469 		struct dc_writeback_info *wb_info);
470 
471 bool dc_stream_fc_disable_writeback(struct dc *dc,
472 		struct dc_stream_state *stream,
473 		uint32_t dwb_pipe_inst);
474 
475 bool dc_stream_remove_writeback(struct dc *dc,
476 		struct dc_stream_state *stream,
477 		uint32_t dwb_pipe_inst);
478 
479 enum dc_status dc_stream_add_dsc_to_resource(struct dc *dc,
480 		struct dc_state *state,
481 		struct dc_stream_state *stream);
482 
483 bool dc_stream_dmdata_status_done(struct dc *dc, struct dc_stream_state *stream);
484 
485 bool dc_stream_set_dynamic_metadata(struct dc *dc,
486 		struct dc_stream_state *stream,
487 		struct dc_dmdata_attributes *dmdata_attr);
488 
489 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream);
490 
491 /*
492  * Enable stereo when commit_streams is not required,
493  * for example, frame alternate.
494  */
495 void dc_enable_stereo(
496 	struct dc *dc,
497 	struct dc_state *context,
498 	struct dc_stream_state *streams[],
499 	uint8_t stream_count);
500 
501 /* Triggers multi-stream synchronization. */
502 void dc_trigger_sync(struct dc *dc, struct dc_state *context);
503 
504 /* Shim: packs args into dc_state_update and calls dc_check_state_update(). */
505 struct dc_update_descriptor dc_check_update_surfaces_for_stream(
506 		const struct dc_check_config *check_config,
507 		struct dc_surface_update *updates,
508 		int surface_count,
509 		struct dc_stream_update *stream_update);
510 
511 struct dc_link *dc_stream_get_link(
512 	const struct dc_stream_state *dc_stream);
513 
514 /**
515  * Create a new default stream for the requested sink
516  */
517 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink);
518 
519 struct dc_stream_state *dc_copy_stream(const struct dc_stream_state *stream);
520 
521 void update_stream_signal(struct dc_stream_state *stream, struct dc_sink *sink);
522 
523 void dc_stream_retain(struct dc_stream_state *dc_stream);
524 void dc_stream_release(struct dc_stream_state *dc_stream);
525 
526 struct dc_stream_status *dc_stream_get_status(struct dc_stream_state *dc_stream);
527 const struct dc_stream_status *dc_stream_get_status_const(const struct dc_stream_state *dc_stream);
528 
529 /*******************************************************************************
530  * Cursor interfaces - To manages the cursor within a stream
531  ******************************************************************************/
532 /* TODO: Deprecated once we switch to dc_set_cursor_position */
533 
534 void program_cursor_attributes(
535 	struct dc *dc,
536 	struct dc_stream_state *stream);
537 
538 void program_cursor_position(
539 	struct dc *dc,
540 	struct dc_stream_state *stream);
541 
542 bool dc_stream_check_cursor_attributes(
543 	const struct dc_stream_state *stream,
544 	struct dc_state *state,
545 	const struct dc_cursor_attributes *attributes);
546 
547 bool dc_stream_set_cursor_attributes(
548 	struct dc_stream_state *stream,
549 	const struct dc_cursor_attributes *attributes);
550 
551 bool dc_stream_program_cursor_attributes(
552 	struct dc_stream_state *stream,
553 	const struct dc_cursor_attributes *attributes);
554 
555 bool dc_stream_set_cursor_position(
556 	struct dc_stream_state *stream,
557 	const struct dc_cursor_position *position);
558 
559 bool dc_stream_program_cursor_position(
560 	struct dc_stream_state *stream,
561 	const struct dc_cursor_position *position);
562 
563 
564 bool dc_stream_adjust_vmin_vmax(struct dc *dc,
565 				struct dc_stream_state *stream,
566 				struct dc_crtc_timing_adjust *adjust);
567 
568 bool dc_stream_get_last_used_drr_vtotal(struct dc *dc,
569 		struct dc_stream_state *stream,
570 		uint32_t *refresh_rate);
571 
572 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY)
573 bool dc_stream_forward_crc_window(struct dc_stream_state *stream,
574 		struct rect *rect,
575 		uint8_t phy_id,
576 		bool is_stop);
577 
578 bool dc_stream_forward_multiple_crc_window(struct dc_stream_state *stream,
579 		struct crc_window *window,
580 		uint8_t phy_id,
581 		bool stop);
582 #endif
583 
584 bool dc_stream_configure_crc(struct dc *dc,
585 			     struct dc_stream_state *stream,
586 			     struct crc_params *crc_window,
587 			     bool enable,
588 			     bool continuous,
589 			     uint8_t idx,
590 			     bool reset,
591 			     enum crc_poly_mode crc_poly_mode);
592 
593 bool dc_stream_get_crc(struct dc *dc,
594 		       struct dc_stream_state *stream,
595 		       uint8_t idx,
596 		       uint32_t *r_cr,
597 		       uint32_t *g_y,
598 		       uint32_t *b_cb);
599 
600 void dc_stream_set_static_screen_params(struct dc *dc,
601 					struct dc_stream_state **stream,
602 					int num_streams,
603 					const struct dc_static_screen_params *params);
604 
605 void dc_stream_set_dyn_expansion(struct dc *dc, struct dc_stream_state *stream,
606 		enum dc_dynamic_expansion option);
607 
608 void dc_stream_set_dither_option(struct dc_stream_state *stream,
609 				 enum dc_dither_option option);
610 
611 bool dc_stream_set_gamut_remap(struct dc *dc,
612 			       const struct dc_stream_state *stream);
613 
614 bool dc_stream_program_csc_matrix(struct dc *dc,
615 				  struct dc_stream_state *stream);
616 
617 struct pipe_ctx *dc_stream_get_pipe_ctx(struct dc_stream_state *stream);
618 
619 void dc_dmub_update_dirty_rect(struct dc *dc,
620 			       int surface_count,
621 			       struct dc_stream_state *stream,
622 			       const struct dc_surface_update *srf_updates,
623 			       struct dc_state *context);
624 
625 bool dc_stream_is_cursor_limit_pending(struct dc *dc, struct dc_stream_state *stream);
626 bool dc_stream_can_clear_cursor_limit(struct dc *dc, struct dc_stream_state *stream);
627 
628 #endif /* DC_STREAM_H_ */
629