2 * Copyright 2012-14 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
30 #include "grph_object_defs.h"
32 /*******************************************************************************
34 ******************************************************************************/
35 struct timing_sync_info {
41 struct dc_stream_status {
46 struct timing_sync_info timing_sync_info;
47 struct dc_plane_state *plane_states[MAX_SURFACE_NUM];
48 bool is_abm_supported;
51 // TODO: References to this needs to be removed..
52 struct freesync_context {
56 enum hubp_dmdata_mode {
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)
65 enum hubp_dmdata_mode dmdata_mode;
66 /* Specifies if current dynamic meta data is to be used only for the current frame */
68 /* Specifies the size of Dynamic Metadata surface in byte. Size of 0 means no Dynamic metadata is fetched */
70 /* Specifies if a new dynamic meta data should be fetched for an upcoming frame */
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 */
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
81 uint32_t dmdata_dl_delta;
82 /* An unbounded array of uint32s, represents software dmdata to be loaded */
83 uint32_t *dmdata_sw_data;
86 struct dc_writeback_info {
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 */
98 struct dc_writeback_update {
99 unsigned int num_wb_info;
100 struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
103 enum vertical_interrupt_ref_point {
108 //For now, only v_update interrupt is used.
113 struct periodic_interrupt_config {
114 enum vertical_interrupt_ref_point ref_point;
118 struct dc_mst_stream_bw_update {
119 bool is_increase; // is bandwidth reduced or increased
120 uint32_t mst_stream_bw; // new mst bandwidth in kbps
123 union stream_update_flags {
128 uint32_t abm_level:1;
130 uint32_t gamut_remap:1;
131 uint32_t wb_update:1;
132 uint32_t dsc_changed : 1;
134 uint32_t crtc_timing_adjust : 1;
140 struct test_pattern {
141 enum dp_test_pattern type;
142 enum dp_test_pattern_color_space color_space;
143 struct link_training_settings const *p_link_settings;
144 unsigned char const *p_custom_pattern;
145 unsigned int cust_pattern_size;
148 struct dc_stream_state {
149 // sink is deprecated, new code should not reference
151 struct dc_sink *sink;
153 struct dc_link *link;
154 /* For dynamic link encoder assignment, update the link encoder assigned to
155 * a stream via the volatile dc_state rather than the static dc_link.
157 struct link_encoder *link_enc;
158 struct dc_panel_patch sink_patches;
159 union display_content_support content_support;
160 struct dc_crtc_timing timing;
161 struct dc_crtc_timing_adjust adjust;
162 struct dc_info_packet vrr_infopacket;
163 struct dc_info_packet vsc_infopacket;
164 struct dc_info_packet vsp_infopacket;
166 struct rect src; /* composition area */
167 struct rect dst; /* stream addressable area */
169 // TODO: References to this needs to be removed..
170 struct freesync_context freesync_ctx;
172 struct audio_info audio_info;
174 struct dc_info_packet hdr_static_metadata;
175 PHYSICAL_ADDRESS_LOC dmdata_address;
176 bool use_dynamic_meta;
178 struct dc_transfer_func *out_transfer_func;
179 struct colorspace_transform gamut_remap_matrix;
180 struct dc_csc_transform csc_color_matrix;
182 enum dc_color_space output_color_space;
183 enum dc_dither_option dither_option;
185 enum view_3d_format view_format;
187 bool use_vsc_sdp_for_colorimetry;
188 bool ignore_msa_timing_param;
190 bool freesync_on_desktop;
192 bool converter_disable_audio;
196 /* TODO: custom INFO packets */
197 /* TODO: ABM info (DMCU) */
201 unsigned int abm_level;
203 struct periodic_interrupt_config periodic_interrupt0;
204 struct periodic_interrupt_config periodic_interrupt1;
206 /* from core_stream struct */
207 struct dc_context *ctx;
209 /* used by DCP and FMT */
210 struct bit_depth_reduction_params bit_depth_params;
211 struct clamping_and_pixel_encoding_params clamping;
214 enum signal_type signal;
217 void *dm_stream_context;
219 struct dc_cursor_attributes cursor_attributes;
220 struct dc_cursor_position cursor_position;
221 uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
223 /* from stream struct */
224 struct kref refcount;
226 struct crtc_trigger_info triggered_crtc_reset;
229 unsigned int num_wb_info;
230 struct dc_writeback_info writeback_info[MAX_DWB_PIPES];
231 const struct dc_transfer_func *func_shaper;
232 const struct dc_3dlut *lut3d_func;
233 /* Computed state bits */
234 bool mode_changed : 1;
236 /* Output from DC when stream state is committed or altered
237 * DC may only access these values during:
238 * dc_commit_state, dc_commit_state_no_check, dc_commit_streams
239 * values may not change outside of those calls
242 // For interrupt management, some hardware instance
243 // offsets need to be exposed to DM
247 bool apply_edp_fast_boot_optimization;
248 bool apply_seamless_boot_optimization;
252 struct test_pattern test_pattern;
253 union stream_update_flags update_flags;
255 bool has_non_synchronizable_pclk;
256 bool vblank_synchronized;
259 #define ABM_LEVEL_IMMEDIATE_DISABLE 255
261 struct dc_stream_update {
262 struct dc_stream_state *stream;
266 struct dc_transfer_func *out_transfer_func;
267 struct dc_info_packet *hdr_static_metadata;
268 unsigned int *abm_level;
270 struct periodic_interrupt_config *periodic_interrupt0;
271 struct periodic_interrupt_config *periodic_interrupt1;
273 struct dc_info_packet *vrr_infopacket;
274 struct dc_info_packet *vsc_infopacket;
275 struct dc_info_packet *vsp_infopacket;
278 bool integer_scaling_update;
280 struct colorspace_transform *gamut_remap;
281 enum dc_color_space *output_color_space;
282 enum dc_dither_option *dither_option;
284 struct dc_csc_transform *output_csc_transform;
286 struct dc_writeback_update *wb_update;
287 struct dc_dsc_config *dsc_config;
288 struct dc_mst_stream_bw_update *mst_bw_update;
289 struct dc_transfer_func *func_shaper;
290 struct dc_3dlut *lut3d_func;
292 struct test_pattern *pending_test_pattern;
293 struct dc_crtc_timing_adjust *crtc_timing_adjust;
296 bool dc_is_stream_unchanged(
297 struct dc_stream_state *old_stream, struct dc_stream_state *stream);
298 bool dc_is_stream_scaling_unchanged(
299 struct dc_stream_state *old_stream, struct dc_stream_state *stream);
302 * Set up surface attributes and associate to a stream
303 * The surfaces parameter is an absolute set of all surface active for the stream.
304 * If no surfaces are provided, the stream will be blanked; no memory read.
305 * Any flip related attribute changes must be done through this interface.
308 * Surfaces attributes are programmed and configured to be composed into stream.
309 * This does not trigger a flip. No surface address is programmed.
312 void dc_commit_updates_for_stream(struct dc *dc,
313 struct dc_surface_update *srf_updates,
315 struct dc_stream_state *stream,
316 struct dc_stream_update *stream_update,
317 struct dc_state *state);
319 * Log the current stream state.
321 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream);
323 uint8_t dc_get_current_stream_count(struct dc *dc);
324 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i);
325 struct dc_stream_state *dc_stream_find_from_link(const struct dc_link *link);
328 * Return the current frame counter.
330 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream);
333 * Send dp sdp message.
335 bool dc_stream_send_dp_sdp(const struct dc_stream_state *stream,
336 const uint8_t *custom_sdp_message,
337 unsigned int sdp_message_size);
339 /* TODO: Return parsed values rather than direct register read
340 * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos)
341 * being refactored properly to be dce-specific
343 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream,
344 uint32_t *v_blank_start,
345 uint32_t *v_blank_end,
346 uint32_t *h_position,
347 uint32_t *v_position);
349 enum dc_status dc_add_stream_to_ctx(
351 struct dc_state *new_ctx,
352 struct dc_stream_state *stream);
354 enum dc_status dc_remove_stream_from_ctx(
356 struct dc_state *new_ctx,
357 struct dc_stream_state *stream);
360 bool dc_add_plane_to_context(
362 struct dc_stream_state *stream,
363 struct dc_plane_state *plane_state,
364 struct dc_state *context);
366 bool dc_remove_plane_from_context(
368 struct dc_stream_state *stream,
369 struct dc_plane_state *plane_state,
370 struct dc_state *context);
372 bool dc_rem_all_planes_for_stream(
374 struct dc_stream_state *stream,
375 struct dc_state *context);
377 bool dc_add_all_planes_for_stream(
379 struct dc_stream_state *stream,
380 struct dc_plane_state * const *plane_states,
382 struct dc_state *context);
384 bool dc_stream_add_writeback(struct dc *dc,
385 struct dc_stream_state *stream,
386 struct dc_writeback_info *wb_info);
388 bool dc_stream_remove_writeback(struct dc *dc,
389 struct dc_stream_state *stream,
390 uint32_t dwb_pipe_inst);
392 enum dc_status dc_stream_add_dsc_to_resource(struct dc *dc,
393 struct dc_state *state,
394 struct dc_stream_state *stream);
396 bool dc_stream_warmup_writeback(struct dc *dc,
398 struct dc_writeback_info *wb_info);
400 bool dc_stream_dmdata_status_done(struct dc *dc, struct dc_stream_state *stream);
402 bool dc_stream_set_dynamic_metadata(struct dc *dc,
403 struct dc_stream_state *stream,
404 struct dc_dmdata_attributes *dmdata_attr);
406 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream);
409 * Set up streams and links associated to drive sinks
410 * The streams parameter is an absolute set of all active streams.
413 * Phy, Encoder, Timing Generator are programmed and enabled.
414 * New streams are enabled with blank stream; no memory read.
417 * Enable stereo when commit_streams is not required,
418 * for example, frame alternate.
420 void dc_enable_stereo(
422 struct dc_state *context,
423 struct dc_stream_state *streams[],
424 uint8_t stream_count);
426 /* Triggers multi-stream synchronization. */
427 void dc_trigger_sync(struct dc *dc, struct dc_state *context);
429 enum surface_update_type dc_check_update_surfaces_for_stream(
431 struct dc_surface_update *updates,
433 struct dc_stream_update *stream_update,
434 const struct dc_stream_status *stream_status);
437 * Create a new default stream for the requested sink
439 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink);
441 struct dc_stream_state *dc_copy_stream(const struct dc_stream_state *stream);
443 void update_stream_signal(struct dc_stream_state *stream, struct dc_sink *sink);
445 void dc_stream_retain(struct dc_stream_state *dc_stream);
446 void dc_stream_release(struct dc_stream_state *dc_stream);
448 struct dc_stream_status *dc_stream_get_status_from_state(
449 struct dc_state *state,
450 struct dc_stream_state *stream);
451 struct dc_stream_status *dc_stream_get_status(
452 struct dc_stream_state *dc_stream);
455 bool dc_optimize_timing_for_fsft(
456 struct dc_stream_state *pStream,
457 unsigned int max_input_rate_in_khz);
460 /*******************************************************************************
461 * Cursor interfaces - To manages the cursor within a stream
462 ******************************************************************************/
463 /* TODO: Deprecated once we switch to dc_set_cursor_position */
464 bool dc_stream_set_cursor_attributes(
465 struct dc_stream_state *stream,
466 const struct dc_cursor_attributes *attributes);
468 bool dc_stream_set_cursor_position(
469 struct dc_stream_state *stream,
470 const struct dc_cursor_position *position);
473 bool dc_stream_adjust_vmin_vmax(struct dc *dc,
474 struct dc_stream_state *stream,
475 struct dc_crtc_timing_adjust *adjust);
477 bool dc_stream_get_last_used_drr_vtotal(struct dc *dc,
478 struct dc_stream_state *stream,
479 uint32_t *refresh_rate);
481 bool dc_stream_get_crtc_position(struct dc *dc,
482 struct dc_stream_state **stream,
485 unsigned int *nom_v_pos);
487 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY)
488 bool dc_stream_forward_dmcu_crc_window(struct dc *dc, struct dc_stream_state *stream,
489 struct crc_params *crc_window);
490 bool dc_stream_stop_dmcu_crc_win_update(struct dc *dc,
491 struct dc_stream_state *stream);
494 bool dc_stream_configure_crc(struct dc *dc,
495 struct dc_stream_state *stream,
496 struct crc_params *crc_window,
500 bool dc_stream_get_crc(struct dc *dc,
501 struct dc_stream_state *stream,
506 void dc_stream_set_static_screen_params(struct dc *dc,
507 struct dc_stream_state **stream,
509 const struct dc_static_screen_params *params);
511 void dc_stream_set_dyn_expansion(struct dc *dc, struct dc_stream_state *stream,
512 enum dc_dynamic_expansion option);
514 void dc_stream_set_dither_option(struct dc_stream_state *stream,
515 enum dc_dither_option option);
517 bool dc_stream_set_gamut_remap(struct dc *dc,
518 const struct dc_stream_state *stream);
520 bool dc_stream_program_csc_matrix(struct dc *dc,
521 struct dc_stream_state *stream);
523 bool dc_stream_get_crtc_position(struct dc *dc,
524 struct dc_stream_state **stream,
527 unsigned int *nom_v_pos);
529 struct pipe_ctx *dc_stream_get_pipe_ctx(struct dc_stream_state *stream);
531 #endif /* DC_STREAM_H_ */