2 * Copyright 2015 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.
26 #ifndef __DC_HW_SEQUENCER_H__
27 #define __DC_HW_SEQUENCER_H__
29 #include "inc/clock_source.h"
30 #include "inc/hw/timing_generator.h"
31 #include "inc/hw/opp.h"
32 #include "inc/hw/link_encoder.h"
33 #include "inc/core_status.h"
37 struct dc_stream_status;
38 struct dc_writeback_info;
39 struct dchub_init_data;
40 struct dc_static_screen_params;
42 struct dc_phy_addr_space_config;
43 struct dc_virtual_addr_space_config;
48 struct pg_block_update;
50 struct subvp_pipe_control_lock_fast_params {
53 bool subvp_immediate_flip;
56 struct pipe_control_lock_params {
58 struct pipe_ctx *pipe_ctx;
62 struct set_flip_control_gsl_params {
63 struct pipe_ctx *pipe_ctx;
67 struct program_triplebuffer_params {
69 struct pipe_ctx *pipe_ctx;
70 bool enableTripleBuffer;
73 struct update_plane_addr_params {
75 struct pipe_ctx *pipe_ctx;
78 struct set_input_transfer_func_params {
80 struct pipe_ctx *pipe_ctx;
81 struct dc_plane_state *plane_state;
84 struct program_gamut_remap_params {
85 struct pipe_ctx *pipe_ctx;
88 struct program_manual_trigger_params {
89 struct pipe_ctx *pipe_ctx;
92 struct send_dmcub_cmd_params {
93 struct dc_context *ctx;
94 union dmub_rb_cmd *cmd;
95 enum dm_dmub_wait_type wait_type;
98 struct setup_dpp_params {
99 struct pipe_ctx *pipe_ctx;
102 struct program_bias_and_scale_params {
103 struct pipe_ctx *pipe_ctx;
106 struct set_output_transfer_func_params {
108 struct pipe_ctx *pipe_ctx;
109 const struct dc_stream_state *stream;
112 struct update_visual_confirm_params {
114 struct pipe_ctx *pipe_ctx;
118 struct power_on_mpc_mem_pwr_params {
124 struct set_output_csc_params {
127 const uint16_t *regval;
128 enum mpc_output_csc_mode ocsc_mode;
131 struct set_ocsc_default_params {
134 enum dc_color_space color_space;
135 enum mpc_output_csc_mode ocsc_mode;
138 struct subvp_save_surf_addr {
139 struct dc_dmub_srv *dc_dmub_srv;
140 const struct dc_plane_address *addr;
144 struct wait_for_dcc_meta_propagation_params {
146 const struct pipe_ctx *top_pipe_to_program;
149 struct fams2_global_control_lock_fast_params {
155 union block_sequence_params {
156 struct update_plane_addr_params update_plane_addr_params;
157 struct subvp_pipe_control_lock_fast_params subvp_pipe_control_lock_fast_params;
158 struct pipe_control_lock_params pipe_control_lock_params;
159 struct set_flip_control_gsl_params set_flip_control_gsl_params;
160 struct program_triplebuffer_params program_triplebuffer_params;
161 struct set_input_transfer_func_params set_input_transfer_func_params;
162 struct program_gamut_remap_params program_gamut_remap_params;
163 struct program_manual_trigger_params program_manual_trigger_params;
164 struct send_dmcub_cmd_params send_dmcub_cmd_params;
165 struct setup_dpp_params setup_dpp_params;
166 struct program_bias_and_scale_params program_bias_and_scale_params;
167 struct set_output_transfer_func_params set_output_transfer_func_params;
168 struct update_visual_confirm_params update_visual_confirm_params;
169 struct power_on_mpc_mem_pwr_params power_on_mpc_mem_pwr_params;
170 struct set_output_csc_params set_output_csc_params;
171 struct set_ocsc_default_params set_ocsc_default_params;
172 struct subvp_save_surf_addr subvp_save_surf_addr;
173 struct wait_for_dcc_meta_propagation_params wait_for_dcc_meta_propagation_params;
174 struct fams2_global_control_lock_fast_params fams2_global_control_lock_fast_params;
177 enum block_sequence_func {
178 DMUB_SUBVP_PIPE_CONTROL_LOCK_FAST = 0,
179 OPTC_PIPE_CONTROL_LOCK,
180 HUBP_SET_FLIP_CONTROL_GSL,
181 HUBP_PROGRAM_TRIPLEBUFFER,
182 HUBP_UPDATE_PLANE_ADDR,
183 DPP_SET_INPUT_TRANSFER_FUNC,
184 DPP_PROGRAM_GAMUT_REMAP,
185 OPTC_PROGRAM_MANUAL_TRIGGER,
188 DPP_PROGRAM_BIAS_AND_SCALE,
189 DPP_SET_OUTPUT_TRANSFER_FUNC,
190 MPC_UPDATE_VISUAL_CONFIRM,
191 MPC_POWER_ON_MPC_MEM_PWR,
193 MPC_SET_OCSC_DEFAULT,
194 DMUB_SUBVP_SAVE_SURF_ADDR,
195 HUBP_WAIT_FOR_DCC_META_PROP,
196 DMUB_FAMS2_GLOBAL_CONTROL_LOCK_FAST,
200 struct block_sequence {
201 union block_sequence_params params;
202 enum block_sequence_func func;
205 struct hw_sequencer_funcs {
206 void (*hardware_release)(struct dc *dc);
207 /* Embedded Display Related */
208 void (*edp_power_control)(struct dc_link *link, bool enable);
209 void (*edp_wait_for_hpd_ready)(struct dc_link *link, bool power_up);
210 void (*edp_wait_for_T12)(struct dc_link *link);
212 /* Pipe Programming Related */
213 void (*init_hw)(struct dc *dc);
214 void (*power_down_on_boot)(struct dc *dc);
215 void (*enable_accelerated_mode)(struct dc *dc,
216 struct dc_state *context);
217 enum dc_status (*apply_ctx_to_hw)(struct dc *dc,
218 struct dc_state *context);
219 void (*disable_plane)(struct dc *dc, struct dc_state *state, struct pipe_ctx *pipe_ctx);
220 void (*disable_pixel_data)(struct dc *dc, struct pipe_ctx *pipe_ctx, bool blank);
221 void (*apply_ctx_for_surface)(struct dc *dc,
222 const struct dc_stream_state *stream,
223 int num_planes, struct dc_state *context);
224 void (*program_front_end_for_ctx)(struct dc *dc,
225 struct dc_state *context);
226 void (*wait_for_pending_cleared)(struct dc *dc,
227 struct dc_state *context);
228 void (*post_unlock_program_front_end)(struct dc *dc,
229 struct dc_state *context);
230 void (*update_plane_addr)(const struct dc *dc,
231 struct pipe_ctx *pipe_ctx);
232 void (*update_dchub)(struct dce_hwseq *hws,
233 struct dchub_init_data *dh_data);
234 void (*wait_for_mpcc_disconnect)(struct dc *dc,
235 struct resource_pool *res_pool,
236 struct pipe_ctx *pipe_ctx);
237 void (*edp_backlight_control)(
238 struct dc_link *link,
240 void (*program_triplebuffer)(const struct dc *dc,
241 struct pipe_ctx *pipe_ctx, bool enableTripleBuffer);
242 void (*update_pending_status)(struct pipe_ctx *pipe_ctx);
243 void (*update_dsc_pg)(struct dc *dc, struct dc_state *context, bool safe_to_disable);
245 /* Pipe Lock Related */
246 void (*pipe_control_lock)(struct dc *dc,
247 struct pipe_ctx *pipe, bool lock);
248 void (*interdependent_update_lock)(struct dc *dc,
249 struct dc_state *context, bool lock);
250 void (*set_flip_control_gsl)(struct pipe_ctx *pipe_ctx,
251 bool flip_immediate);
252 void (*cursor_lock)(struct dc *dc, struct pipe_ctx *pipe, bool lock);
255 void (*get_position)(struct pipe_ctx **pipe_ctx, int num_pipes,
256 struct crtc_position *position);
257 int (*get_vupdate_offset_from_vsync)(struct pipe_ctx *pipe_ctx);
258 void (*calc_vupdate_position)(
260 struct pipe_ctx *pipe_ctx,
261 uint32_t *start_line,
263 void (*enable_per_frame_crtc_position_reset)(struct dc *dc,
264 int group_size, struct pipe_ctx *grouped_pipes[]);
265 void (*enable_timing_synchronization)(struct dc *dc,
266 struct dc_state *state,
267 int group_index, int group_size,
268 struct pipe_ctx *grouped_pipes[]);
269 void (*enable_vblanks_synchronization)(struct dc *dc,
270 int group_index, int group_size,
271 struct pipe_ctx *grouped_pipes[]);
272 void (*setup_periodic_interrupt)(struct dc *dc,
273 struct pipe_ctx *pipe_ctx);
274 void (*set_drr)(struct pipe_ctx **pipe_ctx, int num_pipes,
275 struct dc_crtc_timing_adjust adjust);
276 void (*set_static_screen_control)(struct pipe_ctx **pipe_ctx,
278 const struct dc_static_screen_params *events);
281 void (*enable_stream)(struct pipe_ctx *pipe_ctx);
282 void (*disable_stream)(struct pipe_ctx *pipe_ctx);
283 void (*blank_stream)(struct pipe_ctx *pipe_ctx);
284 void (*unblank_stream)(struct pipe_ctx *pipe_ctx,
285 struct dc_link_settings *link_settings);
287 /* Bandwidth Related */
288 void (*prepare_bandwidth)(struct dc *dc, struct dc_state *context);
289 bool (*update_bandwidth)(struct dc *dc, struct dc_state *context);
290 void (*optimize_bandwidth)(struct dc *dc, struct dc_state *context);
292 /* Infopacket Related */
293 void (*set_avmute)(struct pipe_ctx *pipe_ctx, bool enable);
294 void (*send_immediate_sdp_message)(
295 struct pipe_ctx *pipe_ctx,
296 const uint8_t *custom_sdp_message,
297 unsigned int sdp_message_size);
298 void (*update_info_frame)(struct pipe_ctx *pipe_ctx);
299 void (*set_dmdata_attributes)(struct pipe_ctx *pipe);
300 void (*program_dmdata_engine)(struct pipe_ctx *pipe_ctx);
301 bool (*dmdata_status_done)(struct pipe_ctx *pipe_ctx);
304 void (*set_cursor_position)(struct pipe_ctx *pipe);
305 void (*set_cursor_attribute)(struct pipe_ctx *pipe);
306 void (*set_cursor_sdr_white_level)(struct pipe_ctx *pipe);
309 void (*program_gamut_remap)(struct pipe_ctx *pipe_ctx);
310 void (*program_output_csc)(struct dc *dc, struct pipe_ctx *pipe_ctx,
311 enum dc_color_space colorspace,
312 uint16_t *matrix, int opp_id);
313 void (*trigger_3dlut_dma_load)(struct dc *dc, struct pipe_ctx *pipe_ctx);
316 int (*init_sys_ctx)(struct dce_hwseq *hws,
318 struct dc_phy_addr_space_config *pa_config);
319 void (*init_vm_ctx)(struct dce_hwseq *hws,
321 struct dc_virtual_addr_space_config *va_config,
324 /* Writeback Related */
325 void (*update_writeback)(struct dc *dc,
326 struct dc_writeback_info *wb_info,
327 struct dc_state *context);
328 void (*enable_writeback)(struct dc *dc,
329 struct dc_writeback_info *wb_info,
330 struct dc_state *context);
331 void (*disable_writeback)(struct dc *dc,
332 unsigned int dwb_pipe_inst);
334 bool (*mmhubbub_warmup)(struct dc *dc,
335 unsigned int num_dwb,
336 struct dc_writeback_info *wb_info);
339 enum dc_status (*set_clock)(struct dc *dc,
340 enum dc_clock_type clock_type,
341 uint32_t clk_khz, uint32_t stepping);
342 void (*get_clock)(struct dc *dc, enum dc_clock_type clock_type,
343 struct dc_clock_config *clock_cfg);
344 void (*optimize_pwr_state)(const struct dc *dc,
345 struct dc_state *context);
346 void (*exit_optimized_pwr_state)(const struct dc *dc,
347 struct dc_state *context);
348 void (*calculate_pix_rate_divider)(struct dc *dc,
349 struct dc_state *context,
350 const struct dc_stream_state *stream);
353 void (*enable_audio_stream)(struct pipe_ctx *pipe_ctx);
354 void (*disable_audio_stream)(struct pipe_ctx *pipe_ctx);
356 /* Stereo 3D Related */
357 void (*setup_stereo)(struct pipe_ctx *pipe_ctx, struct dc *dc);
359 /* HW State Logging Related */
360 void (*log_hw_state)(struct dc *dc, struct dc_log_buffer_ctx *log_ctx);
361 void (*log_color_state)(struct dc *dc,
362 struct dc_log_buffer_ctx *log_ctx);
363 void (*get_hw_state)(struct dc *dc, char *pBuf,
364 unsigned int bufSize, unsigned int mask);
365 void (*clear_status_bits)(struct dc *dc, unsigned int mask);
367 bool (*set_backlight_level)(struct pipe_ctx *pipe_ctx,
368 struct set_backlight_level_params *params);
370 void (*set_abm_immediate_disable)(struct pipe_ctx *pipe_ctx);
372 void (*set_pipe)(struct pipe_ctx *pipe_ctx);
374 void (*enable_dp_link_output)(struct dc_link *link,
375 const struct link_resource *link_res,
376 enum signal_type signal,
377 enum clock_source_id clock_source,
378 const struct dc_link_settings *link_settings);
379 void (*enable_tmds_link_output)(struct dc_link *link,
380 const struct link_resource *link_res,
381 enum signal_type signal,
382 enum clock_source_id clock_source,
383 enum dc_color_depth color_depth,
384 uint32_t pixel_clock);
385 void (*enable_lvds_link_output)(struct dc_link *link,
386 const struct link_resource *link_res,
387 enum clock_source_id clock_source,
388 uint32_t pixel_clock);
389 void (*disable_link_output)(struct dc_link *link,
390 const struct link_resource *link_res,
391 enum signal_type signal);
393 void (*get_dcc_en_bits)(struct dc *dc, int *dcc_en_bits);
395 /* Idle Optimization Related */
396 bool (*apply_idle_power_optimizations)(struct dc *dc, bool enable);
398 bool (*does_plane_fit_in_mall)(struct dc *dc,
401 enum surface_pixel_format format,
402 struct dc_cursor_attributes *cursor_attr);
403 void (*commit_subvp_config)(struct dc *dc, struct dc_state *context);
404 void (*enable_phantom_streams)(struct dc *dc, struct dc_state *context);
405 void (*disable_phantom_streams)(struct dc *dc, struct dc_state *context);
406 void (*subvp_pipe_control_lock)(struct dc *dc,
407 struct dc_state *context,
409 bool should_lock_all_pipes,
410 struct pipe_ctx *top_pipe_to_program,
411 bool subvp_prev_use);
412 void (*subvp_pipe_control_lock_fast)(union block_sequence_params *params);
414 void (*z10_restore)(const struct dc *dc);
415 void (*z10_save_init)(struct dc *dc);
416 bool (*is_abm_supported)(struct dc *dc,
417 struct dc_state *context, struct dc_stream_state *stream);
419 void (*set_disp_pattern_generator)(const struct dc *dc,
420 struct pipe_ctx *pipe_ctx,
421 enum controller_dp_test_pattern test_pattern,
422 enum controller_dp_color_space color_space,
423 enum dc_color_depth color_depth,
424 const struct tg_color *solid_color,
425 int width, int height, int offset);
426 void (*blank_phantom)(struct dc *dc,
427 struct timing_generator *tg,
430 void (*update_visual_confirm_color)(struct dc *dc,
431 struct pipe_ctx *pipe_ctx,
433 void (*update_phantom_vp_position)(struct dc *dc,
434 struct dc_state *context,
435 struct pipe_ctx *phantom_pipe);
436 void (*apply_update_flags_for_phantom)(struct pipe_ctx *phantom_pipe);
438 void (*calc_blocks_to_gate)(struct dc *dc, struct dc_state *context,
439 struct pg_block_update *update_state);
440 void (*calc_blocks_to_ungate)(struct dc *dc, struct dc_state *context,
441 struct pg_block_update *update_state);
442 void (*hw_block_power_up)(struct dc *dc,
443 struct pg_block_update *update_state);
444 void (*hw_block_power_down)(struct dc *dc,
445 struct pg_block_update *update_state);
446 void (*root_clock_control)(struct dc *dc,
447 struct pg_block_update *update_state, bool power_on);
448 bool (*is_pipe_topology_transition_seamless)(struct dc *dc,
449 const struct dc_state *cur_ctx,
450 const struct dc_state *new_ctx);
451 void (*wait_for_dcc_meta_propagation)(const struct dc *dc,
452 const struct pipe_ctx *top_pipe_to_program);
453 void (*fams2_global_control_lock)(struct dc *dc,
454 struct dc_state *context,
456 void (*fams2_update_config)(struct dc *dc,
457 struct dc_state *context,
459 void (*fams2_global_control_lock_fast)(union block_sequence_params *params);
460 void (*set_long_vtotal)(struct pipe_ctx **pipe_ctx, int num_pipes, uint32_t v_total_min, uint32_t v_total_max);
461 void (*program_outstanding_updates)(struct dc *dc,
462 struct dc_state *context);
463 void (*setup_hpo_hw_control)(const struct dce_hwseq *hws, bool enable);
464 void (*wait_for_all_pending_updates)(const struct pipe_ctx *pipe_ctx);
467 void color_space_to_black_color(
469 enum dc_color_space colorspace,
470 struct tg_color *black_color);
472 bool hwss_wait_for_blank_complete(
473 struct timing_generator *tg);
475 const uint16_t *find_color_matrix(
476 enum dc_color_space color_space,
477 uint32_t *array_size);
479 void get_surface_tile_visual_confirm_color(
480 struct pipe_ctx *pipe_ctx,
481 struct tg_color *color);
482 void get_surface_visual_confirm_color(
483 const struct pipe_ctx *pipe_ctx,
484 struct tg_color *color);
486 void get_hdr_visual_confirm_color(
487 struct pipe_ctx *pipe_ctx,
488 struct tg_color *color);
489 void get_mpctree_visual_confirm_color(
490 struct pipe_ctx *pipe_ctx,
491 struct tg_color *color);
493 void get_subvp_visual_confirm_color(
494 struct pipe_ctx *pipe_ctx,
495 struct tg_color *color);
497 void get_fams2_visual_confirm_color(
499 struct dc_state *context,
500 struct pipe_ctx *pipe_ctx,
501 struct tg_color *color);
503 void get_mclk_switch_visual_confirm_color(
504 struct pipe_ctx *pipe_ctx,
505 struct tg_color *color);
507 void get_cursor_visual_confirm_color(
508 struct pipe_ctx *pipe_ctx,
509 struct tg_color *color);
511 void set_p_state_switch_method(
513 struct dc_state *context,
514 struct pipe_ctx *pipe_ctx);
516 void hwss_execute_sequence(struct dc *dc,
517 struct block_sequence block_sequence[],
520 void hwss_build_fast_sequence(struct dc *dc,
521 struct dc_dmub_cmd *dc_dmub_cmd,
522 unsigned int dmub_cmd_count,
523 struct block_sequence block_sequence[],
524 unsigned int *num_steps,
525 struct pipe_ctx *pipe_ctx,
526 struct dc_stream_status *stream_status,
527 struct dc_state *context);
529 void hwss_wait_for_all_blank_complete(struct dc *dc,
530 struct dc_state *context);
532 void hwss_wait_for_odm_update_pending_complete(struct dc *dc,
533 struct dc_state *context);
535 void hwss_wait_for_no_pipes_pending(struct dc *dc,
536 struct dc_state *context);
538 void hwss_wait_for_outstanding_hw_updates(struct dc *dc,
539 struct dc_state *dc_context);
541 void hwss_process_outstanding_hw_updates(struct dc *dc,
542 struct dc_state *dc_context);
544 void hwss_send_dmcub_cmd(union block_sequence_params *params);
546 void hwss_program_manual_trigger(union block_sequence_params *params);
548 void hwss_setup_dpp(union block_sequence_params *params);
550 void hwss_program_bias_and_scale(union block_sequence_params *params);
552 void hwss_power_on_mpc_mem_pwr(union block_sequence_params *params);
554 void hwss_set_output_csc(union block_sequence_params *params);
556 void hwss_set_ocsc_default(union block_sequence_params *params);
558 void hwss_subvp_save_surf_addr(union block_sequence_params *params);
560 #endif /* __DC_HW_SEQUENCER_H__ */