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.
26 #ifndef DC_INTERFACE_H_
27 #define DC_INTERFACE_H_
30 #include "grph_object_defs.h"
31 #include "logger_types.h"
32 #include "gpio_types.h"
33 #include "link_service_types.h"
35 #define MAX_SURFACES 3
37 #define MAX_SINKS_PER_LINK 4
39 /*******************************************************************************
40 * Display Core Interfaces
41 ******************************************************************************/
47 uint32_t max_slave_planes
;
48 uint32_t max_downscale_ratio
;
49 uint32_t i2c_speed_in_khz
;
51 unsigned int max_cursor_size
;
55 struct dc_dcc_surface_param
{
56 enum surface_pixel_format format
;
57 struct dc_size surface_size
;
58 enum swizzle_mode_values swizzle_mode
;
59 enum dc_scan_direction scan
;
62 struct dc_dcc_setting
{
63 unsigned int max_compressed_blk_size
;
64 unsigned int max_uncompressed_blk_size
;
65 bool independent_64b_blks
;
68 struct dc_surface_dcc_cap
{
70 bool const_color_support
;
74 struct dc_dcc_setting rgb
;
78 struct dc_dcc_setting luma
;
79 struct dc_dcc_setting chroma
;
84 /* Forward declaration*/
87 struct validate_context
;
93 struct dc_stream_funcs
{
94 bool (*adjust_vmin_vmax
)(struct dc
*dc
,
95 const struct dc_stream
**stream
,
100 void (*stream_update_scaling
)(const struct dc
*dc
,
101 const struct dc_stream
*dc_stream
,
102 const struct rect
*src
,
103 const struct rect
*dst
);
104 bool (*set_gamut_remap
)(struct dc
*dc
,
105 const struct dc_stream
**stream
, int num_streams
);
106 bool (*set_psr_enable
)(struct dc
*dc
, bool enable
);
107 bool (*setup_psr
)(struct dc
*dc
, const struct dc_stream
*stream
);
110 struct link_training_settings
;
112 struct dc_link_funcs
{
113 void (*set_drive_settings
)(struct dc
*dc
,
114 struct link_training_settings
*lt_settings
,
115 const struct dc_link
*link
);
116 void (*perform_link_training
)(struct dc
*dc
,
117 struct dc_link_settings
*link_setting
,
118 bool skip_video_pattern
);
119 void (*set_preferred_link_settings
)(struct dc
*dc
,
120 struct dc_link_settings
*link_setting
,
121 const struct dc_link
*link
);
122 void (*enable_hpd
)(const struct dc_link
*link
);
123 void (*disable_hpd
)(const struct dc_link
*link
);
124 void (*set_test_pattern
)(
125 const struct dc_link
*link
,
126 enum dp_test_pattern test_pattern
,
127 const struct link_training_settings
*p_link_settings
,
128 const unsigned char *p_custom_pattern
,
129 unsigned int cust_pattern_size
);
132 /* Structure to hold configuration flags set by dm at dc creation. */
135 bool disable_disp_pll_sharing
;
139 bool surface_visual_confirm
;
143 bool validation_trace
;
144 bool disable_stutter
;
146 bool disable_dfs_bypass
;
147 bool disable_pplib_clock_request
;
148 bool disable_clock_gate
;
150 bool force_abm_enable
;
155 struct dc_cap_funcs cap_funcs
;
156 struct dc_stream_funcs stream_funcs
;
157 struct dc_link_funcs link_funcs
;
158 struct dc_config config
;
159 struct dc_debug debug
;
162 enum frame_buffer_mode
{
163 FRAME_BUFFER_MODE_LOCAL_ONLY
= 0,
164 FRAME_BUFFER_MODE_ZFB_ONLY
,
165 FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL
,
168 struct dchub_init_data
{
169 bool dchub_initialzied
;
170 bool dchub_info_valid
;
171 int64_t zfb_phys_addr_base
;
172 int64_t zfb_mc_base_addr
;
173 uint64_t zfb_size_in_byte
;
174 enum frame_buffer_mode fb_mode
;
177 struct dc_init_data
{
178 struct hw_asic_id asic_id
;
179 void *driver
; /* ctx */
180 struct cgs_device
*cgs_device
;
182 int num_virtual_links
;
184 * If 'vbios_override' not NULL, it will be called instead
185 * of the real VBIOS. Intended use is Diagnostics on FPGA.
187 struct dc_bios
*vbios_override
;
188 enum dce_environment dce_environment
;
190 struct dc_config flags
;
193 struct dc
*dc_create(const struct dc_init_data
*init_params
);
195 void dc_destroy(struct dc
**dc
);
197 bool dc_init_dchub(struct dc
*dc
, struct dchub_init_data
*dh_data
);
199 /*******************************************************************************
201 ******************************************************************************/
204 TRANSFER_FUNC_POINTS
= 1025
207 struct dc_hdr_static_metadata
{
211 /* display chromaticities and white point in units of 0.00001 */
212 unsigned int chromaticity_green_x
;
213 unsigned int chromaticity_green_y
;
214 unsigned int chromaticity_blue_x
;
215 unsigned int chromaticity_blue_y
;
216 unsigned int chromaticity_red_x
;
217 unsigned int chromaticity_red_y
;
218 unsigned int chromaticity_white_point_x
;
219 unsigned int chromaticity_white_point_y
;
221 uint32_t min_luminance
;
222 uint32_t max_luminance
;
223 uint32_t maximum_content_light_level
;
224 uint32_t maximum_frame_average_light_level
;
227 enum dc_transfer_func_type
{
229 TF_TYPE_DISTRIBUTED_POINTS
,
233 struct dc_transfer_func_distributed_points
{
234 struct fixed31_32 red
[TRANSFER_FUNC_POINTS
];
235 struct fixed31_32 green
[TRANSFER_FUNC_POINTS
];
236 struct fixed31_32 blue
[TRANSFER_FUNC_POINTS
];
238 uint16_t end_exponent
;
239 uint16_t x_point_at_y1_red
;
240 uint16_t x_point_at_y1_green
;
241 uint16_t x_point_at_y1_blue
;
244 enum dc_transfer_func_predefined
{
245 TRANSFER_FUNCTION_SRGB
,
246 TRANSFER_FUNCTION_BT709
,
247 TRANSFER_FUNCTION_PQ
,
248 TRANSFER_FUNCTION_LINEAR
,
251 struct dc_transfer_func
{
252 enum dc_transfer_func_type type
;
253 enum dc_transfer_func_predefined tf
;
254 struct dc_transfer_func_distributed_points tf_pts
;
260 struct dc_plane_address address
;
262 struct scaling_taps scaling_quality
;
263 struct rect src_rect
;
264 struct rect dst_rect
;
265 struct rect clip_rect
;
267 union plane_size plane_size
;
268 union dc_tiling_info tiling_info
;
269 struct dc_plane_dcc_param dcc
;
270 enum dc_color_space color_space
;
272 enum surface_pixel_format format
;
273 enum dc_rotation_angle rotation
;
274 bool horizontal_mirror
;
275 enum plane_stereo_format stereo_format
;
277 struct dc_hdr_static_metadata hdr_static_ctx
;
279 const struct dc_gamma
*gamma_correction
;
280 const struct dc_transfer_func
*in_transfer_func
;
283 struct dc_plane_info
{
284 union plane_size plane_size
;
285 union dc_tiling_info tiling_info
;
286 struct dc_plane_dcc_param dcc
;
287 enum surface_pixel_format format
;
288 enum dc_rotation_angle rotation
;
289 bool horizontal_mirror
;
290 enum plane_stereo_format stereo_format
;
291 enum dc_color_space color_space
; /*todo: wrong place, fits in scaling info*/
295 struct dc_scaling_info
{
296 struct rect src_rect
;
297 struct rect dst_rect
;
298 struct rect clip_rect
;
299 struct scaling_taps scaling_quality
;
302 struct dc_surface_update
{
303 const struct dc_surface
*surface
;
305 /* isr safe update parameters. null means no updates */
306 struct dc_flip_addrs
*flip_addr
;
307 struct dc_plane_info
*plane_info
;
308 struct dc_scaling_info
*scaling_info
;
309 /* following updates require alloc/sleep/spin that is not isr safe,
310 * null means no updates
312 /* gamma TO BE REMOVED */
313 struct dc_gamma
*gamma
;
314 struct dc_hdr_static_metadata
*hdr_static_metadata
;
315 struct dc_transfer_func
*in_transfer_func
;
316 struct dc_transfer_func
*out_transfer_func
;
321 * This structure is filled in by dc_surface_get_status and contains
322 * the last requested address and the currently active address so the called
323 * can determine if there are any outstanding flips
325 struct dc_surface_status
{
326 struct dc_plane_address requested_address
;
327 struct dc_plane_address current_address
;
328 bool is_flip_pending
;
332 * Create a new surface with default parameters;
334 struct dc_surface
*dc_create_surface(const struct dc
*dc
);
335 const struct dc_surface_status
*dc_surface_get_status(
336 const struct dc_surface
*dc_surface
);
338 void dc_surface_retain(const struct dc_surface
*dc_surface
);
339 void dc_surface_release(const struct dc_surface
*dc_surface
);
341 void dc_gamma_retain(const struct dc_gamma
*dc_gamma
);
342 void dc_gamma_release(const struct dc_gamma
**dc_gamma
);
343 struct dc_gamma
*dc_create_gamma(void);
345 void dc_transfer_func_retain(const struct dc_transfer_func
*dc_tf
);
346 void dc_transfer_func_release(const struct dc_transfer_func
*dc_tf
);
347 struct dc_transfer_func
*dc_create_transfer_func(void);
350 * This structure holds a surface address. There could be multiple addresses
351 * in cases such as Stereo 3D, Planar YUV, etc. Other per-flip attributes such
352 * as frame durations and DCC format can also be set.
354 struct dc_flip_addrs
{
355 struct dc_plane_address address
;
357 /* TODO: add flip duration for FreeSync */
361 * Optimized flip address update function.
364 * Surface addresses and flip attributes are programmed.
365 * Surface flip occur at next configured time (h_sync or v_sync flip)
367 void dc_flip_surface_addrs(struct dc
*dc
,
368 const struct dc_surface
*const surfaces
[],
369 struct dc_flip_addrs flip_addrs
[],
373 * Set up surface attributes and associate to a stream
374 * The surfaces parameter is an absolute set of all surface active for the stream.
375 * If no surfaces are provided, the stream will be blanked; no memory read.
376 * Any flip related attribute changes must be done through this interface.
379 * Surfaces attributes are programmed and configured to be composed into stream.
380 * This does not trigger a flip. No surface address is programmed.
383 bool dc_commit_surfaces_to_stream(
385 const struct dc_surface
**dc_surfaces
,
386 uint8_t surface_count
,
387 const struct dc_stream
*stream
);
389 bool dc_pre_update_surfaces_to_stream(
391 const struct dc_surface
*const *new_surfaces
,
392 uint8_t new_surface_count
,
393 const struct dc_stream
*stream
);
395 bool dc_post_update_surfaces_to_stream(
398 void dc_update_surfaces_for_stream(struct dc
*dc
, struct dc_surface_update
*updates
,
399 int surface_count
, const struct dc_stream
*stream
);
401 enum surface_update_type
{
402 UPDATE_TYPE_FAST
, /* super fast, safe to execute in isr */
403 UPDATE_TYPE_MED
, /* a lot of programming needed. may need to alloc */
404 UPDATE_TYPE_FULL
, /* may need to shuffle resources */
407 /*******************************************************************************
409 ******************************************************************************/
411 const struct dc_sink
*sink
;
412 struct dc_crtc_timing timing
;
414 enum dc_color_space output_color_space
;
416 struct rect src
; /* composition area */
417 struct rect dst
; /* stream addressable area */
419 struct audio_info audio_info
;
421 bool ignore_msa_timing_param
;
423 struct freesync_context freesync_ctx
;
425 const struct dc_transfer_func
*out_transfer_func
;
426 struct colorspace_transform gamut_remap_matrix
;
427 struct csc_transform csc_color_matrix
;
429 /* TODO: dithering */
430 /* TODO: custom INFO packets */
431 /* TODO: ABM info (DMCU) */
436 struct dc_stream_update
{
446 * Setup stream attributes if no stream updates are provided
447 * there will be no impact on the stream parameters
449 * Set up surface attributes and associate to a stream
450 * The surfaces parameter is an absolute set of all surface active for the stream.
451 * If no surfaces are provided, the stream will be blanked; no memory read.
452 * Any flip related attribute changes must be done through this interface.
455 * Surfaces attributes are programmed and configured to be composed into stream.
456 * This does not trigger a flip. No surface address is programmed.
460 void dc_update_surfaces_and_stream(struct dc
*dc
,
461 struct dc_surface_update
*surface_updates
, int surface_count
,
462 const struct dc_stream
*dc_stream
,
463 struct dc_stream_update
*stream_update
);
466 * Log the current stream state.
469 const struct dc_stream
*stream
,
470 struct dal_logger
*dc_logger
,
471 enum dc_log_type log_type
);
473 uint8_t dc_get_current_stream_count(const struct dc
*dc
);
474 struct dc_stream
*dc_get_stream_at_index(const struct dc
*dc
, uint8_t i
);
477 * Return the current frame counter.
479 uint32_t dc_stream_get_vblank_counter(const struct dc_stream
*stream
);
481 /* TODO: Return parsed values rather than direct register read
482 * This has a dependency on the caller (amdgpu_get_crtc_scanoutpos)
483 * being refactored properly to be dce-specific
485 uint32_t dc_stream_get_scanoutpos(
486 const struct dc_stream
*stream
, uint32_t *vbl
, uint32_t *position
);
489 * Structure to store surface/stream associations for validation
491 struct dc_validation_set
{
492 const struct dc_stream
*stream
;
493 const struct dc_surface
*surfaces
[MAX_SURFACES
];
494 uint8_t surface_count
;
498 * This function takes a set of resources and checks that they are cofunctional.
501 * No hardware is programmed for call. Only validation is done.
503 bool dc_validate_resources(
505 const struct dc_validation_set set
[],
509 * This function takes a stream and checks if it is guaranteed to be supported.
510 * Guaranteed means that MAX_COFUNC similar streams are supported.
513 * No hardware is programmed for call. Only validation is done.
516 bool dc_validate_guaranteed(
518 const struct dc_stream
*stream
);
521 * Set up streams and links associated to drive sinks
522 * The streams parameter is an absolute set of all active streams.
525 * Phy, Encoder, Timing Generator are programmed and enabled.
526 * New streams are enabled with blank stream; no memory read.
528 bool dc_commit_streams(
530 const struct dc_stream
*streams
[],
531 uint8_t stream_count
);
534 * Create a new default stream for the requested sink
536 struct dc_stream
*dc_create_stream_for_sink(const struct dc_sink
*dc_sink
);
538 void dc_stream_retain(const struct dc_stream
*dc_stream
);
539 void dc_stream_release(const struct dc_stream
*dc_stream
);
541 struct dc_stream_status
{
542 int primary_otg_inst
;
544 const struct dc_surface
*surfaces
[MAX_SURFACE_NUM
];
547 * link this stream passes through
549 const struct dc_link
*link
;
552 const struct dc_stream_status
*dc_stream_get_status(
553 const struct dc_stream
*dc_stream
);
555 enum surface_update_type
dc_check_update_surfaces_for_stream(
557 struct dc_surface_update
*updates
,
559 struct dc_stream_update
*stream_update
,
560 const struct dc_stream_status
*stream_status
);
562 /*******************************************************************************
564 ******************************************************************************/
567 * A link contains one or more sinks and their connected status.
568 * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
571 const struct dc_sink
*remote_sinks
[MAX_SINKS_PER_LINK
];
572 unsigned int sink_count
;
573 const struct dc_sink
*local_sink
;
574 unsigned int link_index
;
575 enum dc_connection_type type
;
576 enum signal_type connector_signal
;
577 enum dc_irq_source irq_source_hpd
;
578 enum dc_irq_source irq_source_hpd_rx
;/* aka DP Short Pulse */
579 /* caps is the same as reported_link_cap. link_traing use
580 * reported_link_cap. Will clean up. TODO
582 struct dc_link_settings reported_link_cap
;
583 struct dc_link_settings verified_link_cap
;
584 struct dc_link_settings max_link_setting
;
585 struct dc_link_settings cur_link_settings
;
586 struct dc_lane_settings cur_lane_setting
;
589 uint8_t link_enc_hw_inst
;
591 struct psr_caps psr_caps
;
592 bool test_pattern_enabled
;
593 union compliance_test_state compliance_test_state
;
597 union dpcd_rev dpcd_rev
;
598 union max_lane_count max_ln_count
;
599 union max_down_spread max_down_spread
;
601 /* dongle type (DP converter, CV smart dongle) */
602 enum display_dongle_type dongle_type
;
603 /* Dongle's downstream count. */
604 union sink_count sink_count
;
605 /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
606 indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
607 bool is_dp_hdmi_s3d_converter
;
609 bool allow_invalid_MSA_timing_param
;
611 uint32_t sink_dev_id
;
612 uint32_t branch_dev_id
;
613 int8_t branch_dev_name
[6];
614 int8_t branch_hw_revision
;
617 struct dc_link_status
{
618 struct dpcd_caps
*dpcd_caps
;
621 const struct dc_link_status
*dc_link_get_status(const struct dc_link
*dc_link
);
624 * Return an enumerated dc_link. dc_link order is constant and determined at
625 * boot time. They cannot be created or destroyed.
626 * Use dc_get_caps() to get number of links.
628 const struct dc_link
*dc_get_link_at_index(const struct dc
*dc
, uint32_t link_index
);
630 /* Return id of physical connector represented by a dc_link at link_index.*/
631 const struct graphics_object_id
dc_get_link_id_at_index(
632 struct dc
*dc
, uint32_t link_index
);
634 /* Set backlight level of an embedded panel (eDP, LVDS). */
635 bool dc_link_set_backlight_level(const struct dc_link
*dc_link
, uint32_t level
,
636 uint32_t frame_ramp
, const struct dc_stream
*stream
);
638 bool dc_link_set_psr_enable(const struct dc_link
*dc_link
, bool enable
);
640 bool dc_link_setup_psr(const struct dc_link
*dc_link
,
641 const struct dc_stream
*stream
);
643 /* Request DC to detect if there is a Panel connected.
644 * boot - If this call is during initial boot.
645 * Return false for any type of detection failure or MST detection
646 * true otherwise. True meaning further action is required (status update
647 * and OS notification).
649 bool dc_link_detect(const struct dc_link
*dc_link
, bool boot
);
651 /* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
653 * true - Downstream port status changed. DM should call DC to do the
655 * false - no change in Downstream port status. No further action required
657 bool dc_link_handle_hpd_rx_irq(const struct dc_link
*dc_link
);
659 struct dc_sink_init_data
;
661 struct dc_sink
*dc_link_add_remote_sink(
662 const struct dc_link
*dc_link
,
665 struct dc_sink_init_data
*init_data
);
667 void dc_link_remove_remote_sink(
668 const struct dc_link
*link
,
669 const struct dc_sink
*sink
);
671 /* Used by diagnostics for virtual link at the moment */
672 void dc_link_set_sink(const struct dc_link
*link
, struct dc_sink
*sink
);
674 void dc_link_dp_set_drive_settings(
675 struct dc_link
*link
,
676 struct link_training_settings
*lt_settings
);
678 bool dc_link_dp_perform_link_training(
679 struct dc_link
*link
,
680 const struct dc_link_settings
*link_setting
,
681 bool skip_video_pattern
);
683 void dc_link_dp_enable_hpd(const struct dc_link
*link
);
685 void dc_link_dp_disable_hpd(const struct dc_link
*link
);
687 bool dc_link_dp_set_test_pattern(
688 const struct dc_link
*link
,
689 enum dp_test_pattern test_pattern
,
690 const struct link_training_settings
*p_link_settings
,
691 const unsigned char *p_custom_pattern
,
692 unsigned int cust_pattern_size
);
694 /*******************************************************************************
695 * Sink Interfaces - A sink corresponds to a display output device
696 ******************************************************************************/
698 struct dc_container_id
{
699 // 128bit GUID in binary form
700 unsigned char guid
[16];
701 // 8 byte port ID -> ELD.PortID
702 unsigned int portId
[2];
703 // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
704 unsigned short manufacturerName
;
705 // 2 byte product code -> ELD.ProductCode
706 unsigned short productCode
;
710 * The sink structure contains EDID and other display device properties
713 enum signal_type sink_signal
;
714 struct dc_edid dc_edid
; /* raw edid */
715 struct dc_edid_caps edid_caps
; /* parse display caps */
716 struct dc_container_id
*dc_container_id
;
717 uint32_t dongle_max_pix_clk
;
718 bool converter_disable_audio
;
721 void dc_sink_retain(const struct dc_sink
*sink
);
722 void dc_sink_release(const struct dc_sink
*sink
);
724 const struct audio
**dc_get_audios(struct dc
*dc
);
726 struct dc_sink_init_data
{
727 enum signal_type sink_signal
;
728 const struct dc_link
*link
;
729 uint32_t dongle_max_pix_clk
;
730 bool converter_disable_audio
;
733 struct dc_sink
*dc_sink_create(const struct dc_sink_init_data
*init_params
);
734 bool dc_sink_get_container_id(struct dc_sink
*dc_sink
, struct dc_container_id
*container_id
);
735 bool dc_sink_set_container_id(struct dc_sink
*dc_sink
, const struct dc_container_id
*container_id
);
737 /*******************************************************************************
738 * Cursor interfaces - To manages the cursor within a stream
739 ******************************************************************************/
740 /* TODO: Deprecated once we switch to dc_set_cursor_position */
741 bool dc_stream_set_cursor_attributes(
742 const struct dc_stream
*stream
,
743 const struct dc_cursor_attributes
*attributes
);
745 bool dc_stream_set_cursor_position(
746 const struct dc_stream
*stream
,
747 struct dc_cursor_position
*position
);
749 /* Newer interfaces */
751 struct dc_plane_address address
;
752 struct dc_cursor_attributes attributes
;
755 /*******************************************************************************
756 * Interrupt interfaces
757 ******************************************************************************/
758 enum dc_irq_source
dc_interrupt_to_irq_source(
762 void dc_interrupt_set(const struct dc
*dc
, enum dc_irq_source src
, bool enable
);
763 void dc_interrupt_ack(struct dc
*dc
, enum dc_irq_source src
);
764 enum dc_irq_source
dc_get_hpd_irq_source_at_index(
765 struct dc
*dc
, uint32_t link_index
);
767 /*******************************************************************************
769 ******************************************************************************/
771 void dc_set_power_state(
773 enum dc_acpi_cm_power_state power_state
);
774 void dc_resume(const struct dc
*dc
);
776 /*******************************************************************************
778 ******************************************************************************/
780 const struct ddc_service
*dc_get_ddc_at_index(
781 struct dc
*dc
, uint32_t link_index
);
784 * DPCD access interfaces
801 bool dc_query_ddc_data(
813 struct i2c_command
*cmd
);
816 #endif /* DC_INTERFACE_H_ */