]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/gpu/drm/amd/display/dc/dc.h
drm/amd/display: Move resource_validate_ctx_destruct to dc.h
[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / amd / display / dc / dc.h
CommitLineData
4562236b
HW
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_INTERFACE_H_
27#define DC_INTERFACE_H_
28
29#include "dc_types.h"
4562236b
HW
30#include "grph_object_defs.h"
31#include "logger_types.h"
32#include "gpio_types.h"
33#include "link_service_types.h"
34
091a97e5 35#define MAX_SURFACES 3
ab2541b6 36#define MAX_STREAMS 6
4562236b
HW
37#define MAX_SINKS_PER_LINK 4
38
39/*******************************************************************************
40 * Display Core Interfaces
41 ******************************************************************************/
42
43struct dc_caps {
ab2541b6 44 uint32_t max_streams;
4562236b
HW
45 uint32_t max_links;
46 uint32_t max_audios;
47 uint32_t max_slave_planes;
d4e13b0d 48 uint32_t max_surfaces;
4562236b
HW
49 uint32_t max_downscale_ratio;
50 uint32_t i2c_speed_in_khz;
a37656b9
TC
51
52 unsigned int max_cursor_size;
4562236b
HW
53};
54
55
56struct dc_dcc_surface_param {
57 enum surface_pixel_format format;
58 struct dc_size surface_size;
2c8ad2d5 59 enum swizzle_mode_values swizzle_mode;
4562236b
HW
60 enum dc_scan_direction scan;
61};
62
63struct dc_dcc_setting {
64 unsigned int max_compressed_blk_size;
65 unsigned int max_uncompressed_blk_size;
66 bool independent_64b_blks;
67};
68
69struct dc_surface_dcc_cap {
70 bool capable;
71 bool const_color_support;
72
73 union {
74 struct {
75 struct dc_dcc_setting rgb;
76 } grph;
77
78 struct {
79 struct dc_dcc_setting luma;
80 struct dc_dcc_setting chroma;
81 } video;
82 };
83};
84
85/* Forward declaration*/
86struct dc;
87struct dc_surface;
88struct validate_context;
89
90struct dc_cap_funcs {
91 int i;
92};
93
94struct dc_stream_funcs {
95 bool (*adjust_vmin_vmax)(struct dc *dc,
96 const struct dc_stream **stream,
97 int num_streams,
98 int vmin,
99 int vmax);
100
101 void (*stream_update_scaling)(const struct dc *dc,
102 const struct dc_stream *dc_stream,
103 const struct rect *src,
104 const struct rect *dst);
105 bool (*set_gamut_remap)(struct dc *dc,
106 const struct dc_stream **stream, int num_streams);
4562236b
HW
107 bool (*set_psr_enable)(struct dc *dc, bool enable);
108 bool (*setup_psr)(struct dc *dc, const struct dc_stream *stream);
109};
110
111struct link_training_settings;
112
113struct dc_link_funcs {
114 void (*set_drive_settings)(struct dc *dc,
bf5cda33
HW
115 struct link_training_settings *lt_settings,
116 const struct dc_link *link);
4562236b
HW
117 void (*perform_link_training)(struct dc *dc,
118 struct dc_link_settings *link_setting,
119 bool skip_video_pattern);
120 void (*set_preferred_link_settings)(struct dc *dc,
88639168
ZF
121 struct dc_link_settings *link_setting,
122 const struct dc_link *link);
4562236b
HW
123 void (*enable_hpd)(const struct dc_link *link);
124 void (*disable_hpd)(const struct dc_link *link);
125 void (*set_test_pattern)(
126 const struct dc_link *link,
127 enum dp_test_pattern test_pattern,
128 const struct link_training_settings *p_link_settings,
129 const unsigned char *p_custom_pattern,
130 unsigned int cust_pattern_size);
131};
132
133/* Structure to hold configuration flags set by dm at dc creation. */
134struct dc_config {
135 bool gpu_vm_support;
136 bool disable_disp_pll_sharing;
137};
138
139struct dc_debug {
140 bool surface_visual_confirm;
141 bool max_disp_clk;
4562236b 142 bool surface_trace;
9474980a 143 bool timing_trace;
4562236b
HW
144 bool validation_trace;
145 bool disable_stutter;
146 bool disable_dcc;
147 bool disable_dfs_bypass;
2c8ad2d5 148 bool disable_pplib_clock_request;
4562236b 149 bool disable_clock_gate;
aa66df58 150 bool disable_dmcu;
70814f6f 151 bool force_abm_enable;
4562236b
HW
152};
153
154struct dc {
155 struct dc_caps caps;
156 struct dc_cap_funcs cap_funcs;
157 struct dc_stream_funcs stream_funcs;
158 struct dc_link_funcs link_funcs;
159 struct dc_config config;
160 struct dc_debug debug;
161};
162
2c8ad2d5
AD
163enum frame_buffer_mode {
164 FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
165 FRAME_BUFFER_MODE_ZFB_ONLY,
166 FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
167} ;
168
169struct dchub_init_data {
170 bool dchub_initialzied;
171 bool dchub_info_valid;
172 int64_t zfb_phys_addr_base;
173 int64_t zfb_mc_base_addr;
174 uint64_t zfb_size_in_byte;
175 enum frame_buffer_mode fb_mode;
176};
2c8ad2d5 177
4562236b
HW
178struct dc_init_data {
179 struct hw_asic_id asic_id;
180 void *driver; /* ctx */
181 struct cgs_device *cgs_device;
182
183 int num_virtual_links;
184 /*
185 * If 'vbios_override' not NULL, it will be called instead
186 * of the real VBIOS. Intended use is Diagnostics on FPGA.
187 */
188 struct dc_bios *vbios_override;
189 enum dce_environment dce_environment;
190
191 struct dc_config flags;
192};
193
194struct dc *dc_create(const struct dc_init_data *init_params);
195
196void dc_destroy(struct dc **dc);
197
2c8ad2d5 198bool dc_init_dchub(struct dc *dc, struct dchub_init_data *dh_data);
2c8ad2d5 199
4562236b
HW
200/*******************************************************************************
201 * Surface Interfaces
202 ******************************************************************************/
203
204enum {
fb735a9f 205 TRANSFER_FUNC_POINTS = 1025
4562236b
HW
206};
207
1646a6fe 208struct dc_hdr_static_metadata {
70063a59 209 bool hdr_supported;
1646a6fe
AW
210 bool is_hdr;
211
212 /* display chromaticities and white point in units of 0.00001 */
213 unsigned int chromaticity_green_x;
214 unsigned int chromaticity_green_y;
215 unsigned int chromaticity_blue_x;
216 unsigned int chromaticity_blue_y;
217 unsigned int chromaticity_red_x;
218 unsigned int chromaticity_red_y;
219 unsigned int chromaticity_white_point_x;
220 unsigned int chromaticity_white_point_y;
221
222 uint32_t min_luminance;
223 uint32_t max_luminance;
224 uint32_t maximum_content_light_level;
225 uint32_t maximum_frame_average_light_level;
226};
227
fb735a9f
AK
228enum dc_transfer_func_type {
229 TF_TYPE_PREDEFINED,
230 TF_TYPE_DISTRIBUTED_POINTS,
70063a59 231 TF_TYPE_BYPASS
fb735a9f
AK
232};
233
234struct dc_transfer_func_distributed_points {
fcd2f4bf
AZ
235 struct fixed31_32 red[TRANSFER_FUNC_POINTS];
236 struct fixed31_32 green[TRANSFER_FUNC_POINTS];
237 struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
238
fb735a9f 239 uint16_t end_exponent;
fcd2f4bf
AZ
240 uint16_t x_point_at_y1_red;
241 uint16_t x_point_at_y1_green;
242 uint16_t x_point_at_y1_blue;
fb735a9f
AK
243};
244
245enum dc_transfer_func_predefined {
246 TRANSFER_FUNCTION_SRGB,
247 TRANSFER_FUNCTION_BT709,
90e508ba 248 TRANSFER_FUNCTION_PQ,
fb735a9f
AK
249 TRANSFER_FUNCTION_LINEAR,
250};
251
252struct dc_transfer_func {
253 enum dc_transfer_func_type type;
254 enum dc_transfer_func_predefined tf;
255 struct dc_transfer_func_distributed_points tf_pts;
256};
257
4562236b
HW
258struct dc_surface {
259 bool visible;
260 bool flip_immediate;
261 struct dc_plane_address address;
262
263 struct scaling_taps scaling_quality;
264 struct rect src_rect;
265 struct rect dst_rect;
266 struct rect clip_rect;
267
268 union plane_size plane_size;
269 union dc_tiling_info tiling_info;
270 struct dc_plane_dcc_param dcc;
271 enum dc_color_space color_space;
272
273 enum surface_pixel_format format;
274 enum dc_rotation_angle rotation;
275 bool horizontal_mirror;
276 enum plane_stereo_format stereo_format;
277
1646a6fe
AW
278 struct dc_hdr_static_metadata hdr_static_ctx;
279
4562236b 280 const struct dc_gamma *gamma_correction;
fb735a9f 281 const struct dc_transfer_func *in_transfer_func;
4562236b
HW
282};
283
284struct dc_plane_info {
285 union plane_size plane_size;
286 union dc_tiling_info tiling_info;
9cd09bfe 287 struct dc_plane_dcc_param dcc;
4562236b
HW
288 enum surface_pixel_format format;
289 enum dc_rotation_angle rotation;
290 bool horizontal_mirror;
291 enum plane_stereo_format stereo_format;
292 enum dc_color_space color_space; /*todo: wrong place, fits in scaling info*/
293 bool visible;
294};
295
296struct dc_scaling_info {
297 struct rect src_rect;
298 struct rect dst_rect;
299 struct rect clip_rect;
300 struct scaling_taps scaling_quality;
301};
302
303struct dc_surface_update {
304 const struct dc_surface *surface;
305
306 /* isr safe update parameters. null means no updates */
307 struct dc_flip_addrs *flip_addr;
308 struct dc_plane_info *plane_info;
309 struct dc_scaling_info *scaling_info;
310 /* following updates require alloc/sleep/spin that is not isr safe,
311 * null means no updates
312 */
fb735a9f 313 /* gamma TO BE REMOVED */
4562236b 314 struct dc_gamma *gamma;
1646a6fe 315 struct dc_hdr_static_metadata *hdr_static_metadata;
fb735a9f
AK
316 struct dc_transfer_func *in_transfer_func;
317 struct dc_transfer_func *out_transfer_func;
318
4562236b
HW
319
320};
321/*
322 * This structure is filled in by dc_surface_get_status and contains
323 * the last requested address and the currently active address so the called
324 * can determine if there are any outstanding flips
325 */
326struct dc_surface_status {
327 struct dc_plane_address requested_address;
328 struct dc_plane_address current_address;
329 bool is_flip_pending;
330};
331
332/*
333 * Create a new surface with default parameters;
334 */
335struct dc_surface *dc_create_surface(const struct dc *dc);
336const struct dc_surface_status *dc_surface_get_status(
337 const struct dc_surface *dc_surface);
338
339void dc_surface_retain(const struct dc_surface *dc_surface);
340void dc_surface_release(const struct dc_surface *dc_surface);
341
89e89630 342void dc_gamma_retain(const struct dc_gamma *dc_gamma);
aff20230 343void dc_gamma_release(const struct dc_gamma **dc_gamma);
4562236b
HW
344struct dc_gamma *dc_create_gamma(void);
345
fb735a9f
AK
346void dc_transfer_func_retain(const struct dc_transfer_func *dc_tf);
347void dc_transfer_func_release(const struct dc_transfer_func *dc_tf);
90e508ba 348struct dc_transfer_func *dc_create_transfer_func(void);
fb735a9f 349
4562236b
HW
350/*
351 * This structure holds a surface address. There could be multiple addresses
352 * in cases such as Stereo 3D, Planar YUV, etc. Other per-flip attributes such
353 * as frame durations and DCC format can also be set.
354 */
355struct dc_flip_addrs {
356 struct dc_plane_address address;
357 bool flip_immediate;
4562236b
HW
358 /* TODO: add flip duration for FreeSync */
359};
360
361/*
362 * Optimized flip address update function.
363 *
364 * After this call:
365 * Surface addresses and flip attributes are programmed.
366 * Surface flip occur at next configured time (h_sync or v_sync flip)
367 */
368void dc_flip_surface_addrs(struct dc *dc,
369 const struct dc_surface *const surfaces[],
370 struct dc_flip_addrs flip_addrs[],
371 uint32_t count);
372
373/*
ab2541b6
AC
374 * Set up surface attributes and associate to a stream
375 * The surfaces parameter is an absolute set of all surface active for the stream.
376 * If no surfaces are provided, the stream will be blanked; no memory read.
4562236b
HW
377 * Any flip related attribute changes must be done through this interface.
378 *
379 * After this call:
ab2541b6 380 * Surfaces attributes are programmed and configured to be composed into stream.
4562236b
HW
381 * This does not trigger a flip. No surface address is programmed.
382 */
383
ab2541b6 384bool dc_commit_surfaces_to_stream(
4562236b
HW
385 struct dc *dc,
386 const struct dc_surface **dc_surfaces,
387 uint8_t surface_count,
ab2541b6 388 const struct dc_stream *stream);
4562236b 389
ab2541b6 390bool dc_pre_update_surfaces_to_stream(
4562236b
HW
391 struct dc *dc,
392 const struct dc_surface *const *new_surfaces,
393 uint8_t new_surface_count,
ab2541b6 394 const struct dc_stream *stream);
4562236b 395
ab2541b6 396bool dc_post_update_surfaces_to_stream(
4562236b
HW
397 struct dc *dc);
398
ab2541b6
AC
399void dc_update_surfaces_for_stream(struct dc *dc, struct dc_surface_update *updates,
400 int surface_count, const struct dc_stream *stream);
4562236b 401
5869b0f6
LE
402enum surface_update_type {
403 UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
404 UPDATE_TYPE_MED, /* a lot of programming needed. may need to alloc */
405 UPDATE_TYPE_FULL, /* may need to shuffle resources */
406};
407
4562236b 408/*******************************************************************************
ab2541b6 409 * Stream Interfaces
4562236b 410 ******************************************************************************/
ab2541b6
AC
411struct dc_stream {
412 const struct dc_sink *sink;
413 struct dc_crtc_timing timing;
8b32076c 414 enum signal_type output_signal;
4562236b 415
ab2541b6 416 enum dc_color_space output_color_space;
4562236b 417
ab2541b6
AC
418 struct rect src; /* composition area */
419 struct rect dst; /* stream addressable area */
4562236b 420
ab2541b6
AC
421 struct audio_info audio_info;
422
423 bool ignore_msa_timing_param;
424
425 struct freesync_context freesync_ctx;
426
427 const struct dc_transfer_func *out_transfer_func;
428 struct colorspace_transform gamut_remap_matrix;
429 struct csc_transform csc_color_matrix;
430
431 /* TODO: dithering */
432 /* TODO: custom INFO packets */
433 /* TODO: ABM info (DMCU) */
434 /* TODO: PSR info */
435 /* TODO: CEA VIC */
436};
4562236b 437
a783e7b5
LE
438struct dc_stream_update {
439
440 struct rect src;
441
442 struct rect dst;
443
444};
445
446
447/*
448 * Setup stream attributes if no stream updates are provided
449 * there will be no impact on the stream parameters
450 *
451 * Set up surface attributes and associate to a stream
452 * The surfaces parameter is an absolute set of all surface active for the stream.
453 * If no surfaces are provided, the stream will be blanked; no memory read.
454 * Any flip related attribute changes must be done through this interface.
455 *
456 * After this call:
457 * Surfaces attributes are programmed and configured to be composed into stream.
458 * This does not trigger a flip. No surface address is programmed.
459 *
460 */
461
462void dc_update_surfaces_and_stream(struct dc *dc,
463 struct dc_surface_update *surface_updates, int surface_count,
464 const struct dc_stream *dc_stream,
465 struct dc_stream_update *stream_update);
466
4562236b 467/*
ab2541b6 468 * Log the current stream state.
4562236b 469 */
ab2541b6
AC
470void dc_stream_log(
471 const struct dc_stream *stream,
4562236b
HW
472 struct dal_logger *dc_logger,
473 enum dc_log_type log_type);
474
ab2541b6
AC
475uint8_t dc_get_current_stream_count(const struct dc *dc);
476struct dc_stream *dc_get_stream_at_index(const struct dc *dc, uint8_t i);
4562236b 477
ab2541b6
AC
478/*
479 * Return the current frame counter.
480 */
481uint32_t dc_stream_get_vblank_counter(const struct dc_stream *stream);
4562236b
HW
482
483/* TODO: Return parsed values rather than direct register read
484 * This has a dependency on the caller (amdgpu_get_crtc_scanoutpos)
485 * being refactored properly to be dce-specific
486 */
81c50963
ST
487bool dc_stream_get_scanoutpos(const struct dc_stream *stream,
488 uint32_t *v_blank_start,
489 uint32_t *v_blank_end,
490 uint32_t *h_position,
491 uint32_t *v_position);
4562236b
HW
492
493/*
ab2541b6 494 * Structure to store surface/stream associations for validation
4562236b
HW
495 */
496struct dc_validation_set {
ab2541b6 497 const struct dc_stream *stream;
4562236b
HW
498 const struct dc_surface *surfaces[MAX_SURFACES];
499 uint8_t surface_count;
500};
501
502/*
503 * This function takes a set of resources and checks that they are cofunctional.
504 *
505 * After this call:
506 * No hardware is programmed for call. Only validation is done.
507 */
508bool dc_validate_resources(
509 const struct dc *dc,
510 const struct dc_validation_set set[],
511 uint8_t set_count);
512
513/*
ab2541b6
AC
514 * This function takes a stream and checks if it is guaranteed to be supported.
515 * Guaranteed means that MAX_COFUNC similar streams are supported.
4562236b
HW
516 *
517 * After this call:
518 * No hardware is programmed for call. Only validation is done.
519 */
520
521bool dc_validate_guaranteed(
522 const struct dc *dc,
ab2541b6 523 const struct dc_stream *stream);
4562236b 524
8122a253
HW
525void dc_resource_validate_ctx_copy_construct(
526 const struct validate_context *src_ctx,
527 struct validate_context *dst_ctx);
528
529void dc_resource_validate_ctx_destruct(struct validate_context *context);
530
4562236b 531/*
ab2541b6
AC
532 * Set up streams and links associated to drive sinks
533 * The streams parameter is an absolute set of all active streams.
4562236b
HW
534 *
535 * After this call:
536 * Phy, Encoder, Timing Generator are programmed and enabled.
ab2541b6 537 * New streams are enabled with blank stream; no memory read.
4562236b 538 */
ab2541b6 539bool dc_commit_streams(
4562236b 540 struct dc *dc,
ab2541b6
AC
541 const struct dc_stream *streams[],
542 uint8_t stream_count);
4562236b
HW
543
544/**
545 * Create a new default stream for the requested sink
546 */
547struct dc_stream *dc_create_stream_for_sink(const struct dc_sink *dc_sink);
548
549void dc_stream_retain(const struct dc_stream *dc_stream);
550void dc_stream_release(const struct dc_stream *dc_stream);
551
552struct dc_stream_status {
ab2541b6
AC
553 int primary_otg_inst;
554 int surface_count;
555 const struct dc_surface *surfaces[MAX_SURFACE_NUM];
556
4562236b
HW
557 /*
558 * link this stream passes through
559 */
560 const struct dc_link *link;
561};
562
563const struct dc_stream_status *dc_stream_get_status(
564 const struct dc_stream *dc_stream);
565
5869b0f6
LE
566enum surface_update_type dc_check_update_surfaces_for_stream(
567 struct dc *dc,
568 struct dc_surface_update *updates,
569 int surface_count,
ee8f63e1 570 struct dc_stream_update *stream_update,
5869b0f6
LE
571 const struct dc_stream_status *stream_status);
572
4562236b
HW
573/*******************************************************************************
574 * Link Interfaces
575 ******************************************************************************/
576
577/*
578 * A link contains one or more sinks and their connected status.
579 * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
580 */
581struct dc_link {
582 const struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
583 unsigned int sink_count;
584 const struct dc_sink *local_sink;
585 unsigned int link_index;
586 enum dc_connection_type type;
587 enum signal_type connector_signal;
588 enum dc_irq_source irq_source_hpd;
589 enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse */
590 /* caps is the same as reported_link_cap. link_traing use
591 * reported_link_cap. Will clean up. TODO
592 */
593 struct dc_link_settings reported_link_cap;
594 struct dc_link_settings verified_link_cap;
595 struct dc_link_settings max_link_setting;
596 struct dc_link_settings cur_link_settings;
597 struct dc_lane_settings cur_lane_setting;
598
599 uint8_t ddc_hw_inst;
600 uint8_t link_enc_hw_inst;
601
602 struct psr_caps psr_caps;
603 bool test_pattern_enabled;
604 union compliance_test_state compliance_test_state;
9fb8de78
AG
605
606 void *priv;
7c7f5b15 607 bool aux_mode;
4562236b
HW
608};
609
610struct dpcd_caps {
611 union dpcd_rev dpcd_rev;
612 union max_lane_count max_ln_count;
613 union max_down_spread max_down_spread;
614
615 /* dongle type (DP converter, CV smart dongle) */
616 enum display_dongle_type dongle_type;
617 /* Dongle's downstream count. */
618 union sink_count sink_count;
619 /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
620 indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
621 bool is_dp_hdmi_s3d_converter;
622
623 bool allow_invalid_MSA_timing_param;
624 bool panel_mode_edp;
625 uint32_t sink_dev_id;
626 uint32_t branch_dev_id;
627 int8_t branch_dev_name[6];
628 int8_t branch_hw_revision;
629};
630
631struct dc_link_status {
632 struct dpcd_caps *dpcd_caps;
633};
634
635const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
636
637/*
638 * Return an enumerated dc_link. dc_link order is constant and determined at
639 * boot time. They cannot be created or destroyed.
640 * Use dc_get_caps() to get number of links.
641 */
642const struct dc_link *dc_get_link_at_index(const struct dc *dc, uint32_t link_index);
643
644/* Return id of physical connector represented by a dc_link at link_index.*/
645const struct graphics_object_id dc_get_link_id_at_index(
646 struct dc *dc, uint32_t link_index);
647
648/* Set backlight level of an embedded panel (eDP, LVDS). */
649bool dc_link_set_backlight_level(const struct dc_link *dc_link, uint32_t level,
650 uint32_t frame_ramp, const struct dc_stream *stream);
651
4562236b
HW
652bool dc_link_set_psr_enable(const struct dc_link *dc_link, bool enable);
653
654bool dc_link_setup_psr(const struct dc_link *dc_link,
655 const struct dc_stream *stream);
656
657/* Request DC to detect if there is a Panel connected.
658 * boot - If this call is during initial boot.
659 * Return false for any type of detection failure or MST detection
660 * true otherwise. True meaning further action is required (status update
661 * and OS notification).
662 */
663bool dc_link_detect(const struct dc_link *dc_link, bool boot);
664
665/* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
666 * Return:
667 * true - Downstream port status changed. DM should call DC to do the
668 * detection.
669 * false - no change in Downstream port status. No further action required
670 * from DM. */
671bool dc_link_handle_hpd_rx_irq(const struct dc_link *dc_link);
672
673struct dc_sink_init_data;
674
675struct dc_sink *dc_link_add_remote_sink(
676 const struct dc_link *dc_link,
677 const uint8_t *edid,
678 int len,
679 struct dc_sink_init_data *init_data);
680
681void dc_link_remove_remote_sink(
682 const struct dc_link *link,
683 const struct dc_sink *sink);
684
685/* Used by diagnostics for virtual link at the moment */
686void dc_link_set_sink(const struct dc_link *link, struct dc_sink *sink);
687
688void dc_link_dp_set_drive_settings(
689 struct dc_link *link,
690 struct link_training_settings *lt_settings);
691
692bool dc_link_dp_perform_link_training(
693 struct dc_link *link,
694 const struct dc_link_settings *link_setting,
695 bool skip_video_pattern);
696
697void dc_link_dp_enable_hpd(const struct dc_link *link);
698
699void dc_link_dp_disable_hpd(const struct dc_link *link);
700
701bool dc_link_dp_set_test_pattern(
702 const struct dc_link *link,
703 enum dp_test_pattern test_pattern,
704 const struct link_training_settings *p_link_settings,
705 const unsigned char *p_custom_pattern,
706 unsigned int cust_pattern_size);
707
708/*******************************************************************************
709 * Sink Interfaces - A sink corresponds to a display output device
710 ******************************************************************************/
711
8c895313 712struct dc_container_id {
713 // 128bit GUID in binary form
714 unsigned char guid[16];
715 // 8 byte port ID -> ELD.PortID
716 unsigned int portId[2];
717 // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
718 unsigned short manufacturerName;
719 // 2 byte product code -> ELD.ProductCode
720 unsigned short productCode;
721};
722
4562236b
HW
723/*
724 * The sink structure contains EDID and other display device properties
725 */
726struct dc_sink {
727 enum signal_type sink_signal;
728 struct dc_edid dc_edid; /* raw edid */
729 struct dc_edid_caps edid_caps; /* parse display caps */
8c895313 730 struct dc_container_id *dc_container_id;
4a9a5d62
ZF
731 uint32_t dongle_max_pix_clk;
732 bool converter_disable_audio;
5c4e9806 733 void *priv;
4562236b
HW
734};
735
736void dc_sink_retain(const struct dc_sink *sink);
737void dc_sink_release(const struct dc_sink *sink);
738
739const struct audio **dc_get_audios(struct dc *dc);
740
741struct dc_sink_init_data {
742 enum signal_type sink_signal;
743 const struct dc_link *link;
744 uint32_t dongle_max_pix_clk;
745 bool converter_disable_audio;
746};
747
748struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
8c895313 749bool dc_sink_get_container_id(struct dc_sink *dc_sink, struct dc_container_id *container_id);
750bool dc_sink_set_container_id(struct dc_sink *dc_sink, const struct dc_container_id *container_id);
4562236b
HW
751
752/*******************************************************************************
ab2541b6 753 * Cursor interfaces - To manages the cursor within a stream
4562236b
HW
754 ******************************************************************************/
755/* TODO: Deprecated once we switch to dc_set_cursor_position */
ab2541b6
AC
756bool dc_stream_set_cursor_attributes(
757 const struct dc_stream *stream,
4562236b
HW
758 const struct dc_cursor_attributes *attributes);
759
ab2541b6
AC
760bool dc_stream_set_cursor_position(
761 const struct dc_stream *stream,
dabb3979 762 struct dc_cursor_position *position);
4562236b
HW
763
764/* Newer interfaces */
765struct dc_cursor {
766 struct dc_plane_address address;
767 struct dc_cursor_attributes attributes;
768};
769
4562236b
HW
770/*******************************************************************************
771 * Interrupt interfaces
772 ******************************************************************************/
773enum dc_irq_source dc_interrupt_to_irq_source(
774 struct dc *dc,
775 uint32_t src_id,
776 uint32_t ext_id);
777void dc_interrupt_set(const struct dc *dc, enum dc_irq_source src, bool enable);
778void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
779enum dc_irq_source dc_get_hpd_irq_source_at_index(
780 struct dc *dc, uint32_t link_index);
781
782/*******************************************************************************
783 * Power Interfaces
784 ******************************************************************************/
785
786void dc_set_power_state(
787 struct dc *dc,
a3621485 788 enum dc_acpi_cm_power_state power_state);
4562236b
HW
789void dc_resume(const struct dc *dc);
790
791/*******************************************************************************
792 * DDC Interfaces
793 ******************************************************************************/
794
795const struct ddc_service *dc_get_ddc_at_index(
796 struct dc *dc, uint32_t link_index);
797
798/*
799 * DPCD access interfaces
800 */
801
7c7f5b15 802bool dc_read_aux_dpcd(
4562236b
HW
803 struct dc *dc,
804 uint32_t link_index,
805 uint32_t address,
806 uint8_t *data,
807 uint32_t size);
808
7c7f5b15 809bool dc_write_aux_dpcd(
4562236b
HW
810 struct dc *dc,
811 uint32_t link_index,
812 uint32_t address,
813 const uint8_t *data,
2b230ea3
ZF
814 uint32_t size);
815
7c7f5b15
AG
816bool dc_read_aux_i2c(
817 struct dc *dc,
818 uint32_t link_index,
819 enum i2c_mot_mode mot,
820 uint32_t address,
821 uint8_t *data,
822 uint32_t size);
823
824bool dc_write_aux_i2c(
825 struct dc *dc,
826 uint32_t link_index,
827 enum i2c_mot_mode mot,
828 uint32_t address,
829 const uint8_t *data,
830 uint32_t size);
831
2b230ea3
ZF
832bool dc_query_ddc_data(
833 struct dc *dc,
834 uint32_t link_index,
835 uint32_t address,
836 uint8_t *write_buf,
837 uint32_t write_size,
838 uint8_t *read_buf,
839 uint32_t read_size);
4562236b
HW
840
841bool dc_submit_i2c(
842 struct dc *dc,
843 uint32_t link_index,
844 struct i2c_command *cmd);
845
5e7773a2 846
4562236b 847#endif /* DC_INTERFACE_H_ */