blob: 87675f032949e07a06bff886f4a61f81d12d0de9 [file] [log] [blame]
Harry Wentland45622362017-09-12 15:58:20 -04001/*
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"
Harry Wentland45622362017-09-12 15:58:20 -040030#include "grph_object_defs.h"
31#include "logger_types.h"
32#include "gpio_types.h"
33#include "link_service_types.h"
34
Harry Wentland091a97e2016-12-06 12:25:52 -050035#define MAX_SURFACES 3
Aric Cyrab2541b2016-12-29 15:27:12 -050036#define MAX_STREAMS 6
Harry Wentland45622362017-09-12 15:58:20 -040037#define MAX_SINKS_PER_LINK 4
38
39/*******************************************************************************
40 * Display Core Interfaces
41 ******************************************************************************/
42
43struct dc_caps {
Aric Cyrab2541b2016-12-29 15:27:12 -050044 uint32_t max_streams;
Harry Wentland45622362017-09-12 15:58:20 -040045 uint32_t max_links;
46 uint32_t max_audios;
47 uint32_t max_slave_planes;
Alex Deucherd4e13b02017-06-15 16:24:01 -040048 uint32_t max_surfaces;
Harry Wentland45622362017-09-12 15:58:20 -040049 uint32_t max_downscale_ratio;
50 uint32_t i2c_speed_in_khz;
Tony Chenga37656b2017-02-08 22:13:52 -050051
52 unsigned int max_cursor_size;
Harry Wentland45622362017-09-12 15:58:20 -040053};
54
55
56struct dc_dcc_surface_param {
57 enum surface_pixel_format format;
58 struct dc_size surface_size;
Alex Deucher2c8ad2d2017-06-15 16:20:24 -040059 enum swizzle_mode_values swizzle_mode;
Harry Wentland45622362017-09-12 15:58:20 -040060 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
Sylvia Tsai94267b32017-04-21 15:29:55 -040085struct dc_static_screen_events {
86 bool cursor_update;
87 bool surface_update;
88 bool overlay_update;
89};
90
Harry Wentland45622362017-09-12 15:58:20 -040091/* Forward declaration*/
92struct dc;
93struct dc_surface;
94struct validate_context;
95
96struct dc_cap_funcs {
97 int i;
98};
99
100struct dc_stream_funcs {
101 bool (*adjust_vmin_vmax)(struct dc *dc,
102 const struct dc_stream **stream,
103 int num_streams,
104 int vmin,
105 int vmax);
Eric Cook72ada5f2017-04-18 15:24:50 -0400106 bool (*get_crtc_position)(struct dc *dc,
107 const struct dc_stream **stream,
108 int num_streams,
109 unsigned int *v_pos,
110 unsigned int *nom_v_pos);
111
Harry Wentland45622362017-09-12 15:58:20 -0400112
113 void (*stream_update_scaling)(const struct dc *dc,
114 const struct dc_stream *dc_stream,
115 const struct rect *src,
116 const struct rect *dst);
Sylvia Tsai94267b32017-04-21 15:29:55 -0400117
Harry Wentland45622362017-09-12 15:58:20 -0400118 bool (*set_gamut_remap)(struct dc *dc,
119 const struct dc_stream **stream, int num_streams);
Sylvia Tsai94267b32017-04-21 15:29:55 -0400120
121 void (*set_static_screen_events)(struct dc *dc,
122 const struct dc_stream **stream,
123 int num_streams,
124 const struct dc_static_screen_events *events);
Ding Wang529cad02017-04-25 10:03:27 -0400125
126 void (*set_dither_option)(const struct dc_stream *stream,
127 enum dc_dither_option option);
Harry Wentland45622362017-09-12 15:58:20 -0400128};
129
130struct link_training_settings;
131
132struct dc_link_funcs {
133 void (*set_drive_settings)(struct dc *dc,
Hersen Wubf5cda32017-01-04 10:22:35 -0500134 struct link_training_settings *lt_settings,
135 const struct dc_link *link);
Harry Wentland45622362017-09-12 15:58:20 -0400136 void (*perform_link_training)(struct dc *dc,
137 struct dc_link_settings *link_setting,
138 bool skip_video_pattern);
139 void (*set_preferred_link_settings)(struct dc *dc,
Zeyu Fan88639162016-12-23 16:53:12 -0500140 struct dc_link_settings *link_setting,
141 const struct dc_link *link);
Harry Wentland45622362017-09-12 15:58:20 -0400142 void (*enable_hpd)(const struct dc_link *link);
143 void (*disable_hpd)(const struct dc_link *link);
144 void (*set_test_pattern)(
145 const struct dc_link *link,
146 enum dp_test_pattern test_pattern,
147 const struct link_training_settings *p_link_settings,
148 const unsigned char *p_custom_pattern,
149 unsigned int cust_pattern_size);
150};
151
152/* Structure to hold configuration flags set by dm at dc creation. */
153struct dc_config {
154 bool gpu_vm_support;
155 bool disable_disp_pll_sharing;
156};
157
158struct dc_debug {
159 bool surface_visual_confirm;
160 bool max_disp_clk;
Harry Wentland45622362017-09-12 15:58:20 -0400161 bool surface_trace;
Yongqiang Sun94749802016-12-08 09:47:11 -0500162 bool timing_trace;
Harry Wentland45622362017-09-12 15:58:20 -0400163 bool validation_trace;
164 bool disable_stutter;
165 bool disable_dcc;
166 bool disable_dfs_bypass;
Alex Deucher2c8ad2d2017-06-15 16:20:24 -0400167 bool disable_pplib_clock_request;
Harry Wentland45622362017-09-12 15:58:20 -0400168 bool disable_clock_gate;
Yongqiang Sunaa66df52016-12-15 10:50:48 -0500169 bool disable_dmcu;
Anthony Koo70814f62017-01-27 17:50:03 -0500170 bool force_abm_enable;
Harry Wentland45622362017-09-12 15:58:20 -0400171};
172
173struct dc {
174 struct dc_caps caps;
175 struct dc_cap_funcs cap_funcs;
176 struct dc_stream_funcs stream_funcs;
177 struct dc_link_funcs link_funcs;
178 struct dc_config config;
179 struct dc_debug debug;
180};
181
Alex Deucher2c8ad2d2017-06-15 16:20:24 -0400182enum frame_buffer_mode {
183 FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
184 FRAME_BUFFER_MODE_ZFB_ONLY,
185 FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
186} ;
187
188struct dchub_init_data {
189 bool dchub_initialzied;
190 bool dchub_info_valid;
191 int64_t zfb_phys_addr_base;
192 int64_t zfb_mc_base_addr;
193 uint64_t zfb_size_in_byte;
194 enum frame_buffer_mode fb_mode;
195};
Alex Deucher2c8ad2d2017-06-15 16:20:24 -0400196
Harry Wentland45622362017-09-12 15:58:20 -0400197struct dc_init_data {
198 struct hw_asic_id asic_id;
199 void *driver; /* ctx */
200 struct cgs_device *cgs_device;
201
202 int num_virtual_links;
203 /*
204 * If 'vbios_override' not NULL, it will be called instead
205 * of the real VBIOS. Intended use is Diagnostics on FPGA.
206 */
207 struct dc_bios *vbios_override;
208 enum dce_environment dce_environment;
209
210 struct dc_config flags;
211};
212
213struct dc *dc_create(const struct dc_init_data *init_params);
214
215void dc_destroy(struct dc **dc);
216
Alex Deucher2c8ad2d2017-06-15 16:20:24 -0400217bool dc_init_dchub(struct dc *dc, struct dchub_init_data *dh_data);
Alex Deucher2c8ad2d2017-06-15 16:20:24 -0400218
Harry Wentland45622362017-09-12 15:58:20 -0400219/*******************************************************************************
220 * Surface Interfaces
221 ******************************************************************************/
222
223enum {
Anthony Koofb735a92016-12-13 13:59:41 -0500224 TRANSFER_FUNC_POINTS = 1025
Harry Wentland45622362017-09-12 15:58:20 -0400225};
226
Andrew Wong1646a6fe2016-12-22 15:41:30 -0500227struct dc_hdr_static_metadata {
Amy Zhang70063a52017-02-16 11:04:48 -0500228 bool hdr_supported;
Andrew Wong1646a6fe2016-12-22 15:41:30 -0500229 bool is_hdr;
230
231 /* display chromaticities and white point in units of 0.00001 */
232 unsigned int chromaticity_green_x;
233 unsigned int chromaticity_green_y;
234 unsigned int chromaticity_blue_x;
235 unsigned int chromaticity_blue_y;
236 unsigned int chromaticity_red_x;
237 unsigned int chromaticity_red_y;
238 unsigned int chromaticity_white_point_x;
239 unsigned int chromaticity_white_point_y;
240
241 uint32_t min_luminance;
242 uint32_t max_luminance;
243 uint32_t maximum_content_light_level;
244 uint32_t maximum_frame_average_light_level;
245};
246
Anthony Koofb735a92016-12-13 13:59:41 -0500247enum dc_transfer_func_type {
248 TF_TYPE_PREDEFINED,
249 TF_TYPE_DISTRIBUTED_POINTS,
Amy Zhang70063a52017-02-16 11:04:48 -0500250 TF_TYPE_BYPASS
Anthony Koofb735a92016-12-13 13:59:41 -0500251};
252
253struct dc_transfer_func_distributed_points {
Amy Zhangfcd2f4b2017-01-05 17:12:20 -0500254 struct fixed31_32 red[TRANSFER_FUNC_POINTS];
255 struct fixed31_32 green[TRANSFER_FUNC_POINTS];
256 struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
257
Anthony Koofb735a92016-12-13 13:59:41 -0500258 uint16_t end_exponent;
Amy Zhangfcd2f4b2017-01-05 17:12:20 -0500259 uint16_t x_point_at_y1_red;
260 uint16_t x_point_at_y1_green;
261 uint16_t x_point_at_y1_blue;
Anthony Koofb735a92016-12-13 13:59:41 -0500262};
263
264enum dc_transfer_func_predefined {
265 TRANSFER_FUNCTION_SRGB,
266 TRANSFER_FUNCTION_BT709,
Anthony Koo90e508b2016-12-15 12:09:46 -0500267 TRANSFER_FUNCTION_PQ,
Anthony Koofb735a92016-12-13 13:59:41 -0500268 TRANSFER_FUNCTION_LINEAR,
269};
270
271struct dc_transfer_func {
272 enum dc_transfer_func_type type;
273 enum dc_transfer_func_predefined tf;
274 struct dc_transfer_func_distributed_points tf_pts;
275};
276
Harry Wentland45622362017-09-12 15:58:20 -0400277struct dc_surface {
278 bool visible;
279 bool flip_immediate;
280 struct dc_plane_address address;
281
282 struct scaling_taps scaling_quality;
283 struct rect src_rect;
284 struct rect dst_rect;
285 struct rect clip_rect;
286
287 union plane_size plane_size;
288 union dc_tiling_info tiling_info;
289 struct dc_plane_dcc_param dcc;
290 enum dc_color_space color_space;
291
292 enum surface_pixel_format format;
293 enum dc_rotation_angle rotation;
294 bool horizontal_mirror;
295 enum plane_stereo_format stereo_format;
296
Andrew Wong1646a6fe2016-12-22 15:41:30 -0500297 struct dc_hdr_static_metadata hdr_static_ctx;
298
Harry Wentland45622362017-09-12 15:58:20 -0400299 const struct dc_gamma *gamma_correction;
Anthony Koofb735a92016-12-13 13:59:41 -0500300 const struct dc_transfer_func *in_transfer_func;
Harry Wentland45622362017-09-12 15:58:20 -0400301};
302
303struct dc_plane_info {
304 union plane_size plane_size;
305 union dc_tiling_info tiling_info;
Leon Elazar9cd09bf2016-12-19 12:00:05 -0500306 struct dc_plane_dcc_param dcc;
Harry Wentland45622362017-09-12 15:58:20 -0400307 enum surface_pixel_format format;
308 enum dc_rotation_angle rotation;
309 bool horizontal_mirror;
310 enum plane_stereo_format stereo_format;
311 enum dc_color_space color_space; /*todo: wrong place, fits in scaling info*/
312 bool visible;
313};
314
315struct dc_scaling_info {
316 struct rect src_rect;
317 struct rect dst_rect;
318 struct rect clip_rect;
319 struct scaling_taps scaling_quality;
320};
321
322struct dc_surface_update {
323 const struct dc_surface *surface;
324
325 /* isr safe update parameters. null means no updates */
326 struct dc_flip_addrs *flip_addr;
327 struct dc_plane_info *plane_info;
328 struct dc_scaling_info *scaling_info;
329 /* following updates require alloc/sleep/spin that is not isr safe,
330 * null means no updates
331 */
Anthony Koofb735a92016-12-13 13:59:41 -0500332 /* gamma TO BE REMOVED */
Harry Wentland45622362017-09-12 15:58:20 -0400333 struct dc_gamma *gamma;
Andrew Wong1646a6fe2016-12-22 15:41:30 -0500334 struct dc_hdr_static_metadata *hdr_static_metadata;
Anthony Koofb735a92016-12-13 13:59:41 -0500335 struct dc_transfer_func *in_transfer_func;
336 struct dc_transfer_func *out_transfer_func;
337
Harry Wentland45622362017-09-12 15:58:20 -0400338
339};
340/*
341 * This structure is filled in by dc_surface_get_status and contains
342 * the last requested address and the currently active address so the called
343 * can determine if there are any outstanding flips
344 */
345struct dc_surface_status {
346 struct dc_plane_address requested_address;
347 struct dc_plane_address current_address;
348 bool is_flip_pending;
349};
350
351/*
352 * Create a new surface with default parameters;
353 */
354struct dc_surface *dc_create_surface(const struct dc *dc);
355const struct dc_surface_status *dc_surface_get_status(
356 const struct dc_surface *dc_surface);
357
358void dc_surface_retain(const struct dc_surface *dc_surface);
359void dc_surface_release(const struct dc_surface *dc_surface);
360
Amy Zhang89e89632016-12-12 10:32:24 -0500361void dc_gamma_retain(const struct dc_gamma *dc_gamma);
Yongqiang Sunaff20232016-12-23 10:18:08 -0500362void dc_gamma_release(const struct dc_gamma **dc_gamma);
Harry Wentland45622362017-09-12 15:58:20 -0400363struct dc_gamma *dc_create_gamma(void);
364
Anthony Koofb735a92016-12-13 13:59:41 -0500365void dc_transfer_func_retain(const struct dc_transfer_func *dc_tf);
366void dc_transfer_func_release(const struct dc_transfer_func *dc_tf);
Anthony Koo90e508b2016-12-15 12:09:46 -0500367struct dc_transfer_func *dc_create_transfer_func(void);
Anthony Koofb735a92016-12-13 13:59:41 -0500368
Harry Wentland45622362017-09-12 15:58:20 -0400369/*
370 * This structure holds a surface address. There could be multiple addresses
371 * in cases such as Stereo 3D, Planar YUV, etc. Other per-flip attributes such
372 * as frame durations and DCC format can also be set.
373 */
374struct dc_flip_addrs {
375 struct dc_plane_address address;
376 bool flip_immediate;
Harry Wentland45622362017-09-12 15:58:20 -0400377 /* TODO: add flip duration for FreeSync */
378};
379
380/*
381 * Optimized flip address update function.
382 *
383 * After this call:
384 * Surface addresses and flip attributes are programmed.
385 * Surface flip occur at next configured time (h_sync or v_sync flip)
386 */
387void dc_flip_surface_addrs(struct dc *dc,
388 const struct dc_surface *const surfaces[],
389 struct dc_flip_addrs flip_addrs[],
390 uint32_t count);
391
392/*
Aric Cyrab2541b2016-12-29 15:27:12 -0500393 * Set up surface attributes and associate to a stream
394 * The surfaces parameter is an absolute set of all surface active for the stream.
395 * If no surfaces are provided, the stream will be blanked; no memory read.
Harry Wentland45622362017-09-12 15:58:20 -0400396 * Any flip related attribute changes must be done through this interface.
397 *
398 * After this call:
Aric Cyrab2541b2016-12-29 15:27:12 -0500399 * Surfaces attributes are programmed and configured to be composed into stream.
Harry Wentland45622362017-09-12 15:58:20 -0400400 * This does not trigger a flip. No surface address is programmed.
401 */
402
Aric Cyrab2541b2016-12-29 15:27:12 -0500403bool dc_commit_surfaces_to_stream(
Harry Wentland45622362017-09-12 15:58:20 -0400404 struct dc *dc,
405 const struct dc_surface **dc_surfaces,
406 uint8_t surface_count,
Aric Cyrab2541b2016-12-29 15:27:12 -0500407 const struct dc_stream *stream);
Harry Wentland45622362017-09-12 15:58:20 -0400408
Aric Cyrab2541b2016-12-29 15:27:12 -0500409bool dc_pre_update_surfaces_to_stream(
Harry Wentland45622362017-09-12 15:58:20 -0400410 struct dc *dc,
411 const struct dc_surface *const *new_surfaces,
412 uint8_t new_surface_count,
Aric Cyrab2541b2016-12-29 15:27:12 -0500413 const struct dc_stream *stream);
Harry Wentland45622362017-09-12 15:58:20 -0400414
Aric Cyrab2541b2016-12-29 15:27:12 -0500415bool dc_post_update_surfaces_to_stream(
Harry Wentland45622362017-09-12 15:58:20 -0400416 struct dc *dc);
417
Aric Cyrab2541b2016-12-29 15:27:12 -0500418void dc_update_surfaces_for_stream(struct dc *dc, struct dc_surface_update *updates,
419 int surface_count, const struct dc_stream *stream);
Harry Wentland45622362017-09-12 15:58:20 -0400420
Leon Elazar5869b0f2017-03-01 12:30:11 -0500421enum surface_update_type {
422 UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
423 UPDATE_TYPE_MED, /* a lot of programming needed. may need to alloc */
424 UPDATE_TYPE_FULL, /* may need to shuffle resources */
425};
426
Harry Wentland45622362017-09-12 15:58:20 -0400427/*******************************************************************************
428 * Stream Interfaces
429 ******************************************************************************/
430struct dc_stream {
431 const struct dc_sink *sink;
432 struct dc_crtc_timing timing;
Sylvia Tsai8b320762017-04-04 17:28:17 -0400433 enum signal_type output_signal;
Harry Wentland45622362017-09-12 15:58:20 -0400434
435 enum dc_color_space output_color_space;
Ding Wangb92033b2017-04-12 15:29:13 -0400436 enum dc_dither_option dither_option;
Harry Wentland45622362017-09-12 15:58:20 -0400437
Aric Cyrab2541b2016-12-29 15:27:12 -0500438 struct rect src; /* composition area */
Harry Wentland45622362017-09-12 15:58:20 -0400439 struct rect dst; /* stream addressable area */
440
441 struct audio_info audio_info;
442
443 bool ignore_msa_timing_param;
444
445 struct freesync_context freesync_ctx;
446
Anthony Koo90e508b2016-12-15 12:09:46 -0500447 const struct dc_transfer_func *out_transfer_func;
Harry Wentland45622362017-09-12 15:58:20 -0400448 struct colorspace_transform gamut_remap_matrix;
449 struct csc_transform csc_color_matrix;
Anthony Koo90e508b2016-12-15 12:09:46 -0500450
Harry Wentland45622362017-09-12 15:58:20 -0400451 /* TODO: custom INFO packets */
452 /* TODO: ABM info (DMCU) */
453 /* TODO: PSR info */
454 /* TODO: CEA VIC */
455};
456
Leon Elazara783e7b2017-03-09 14:38:15 -0500457struct dc_stream_update {
458
459 struct rect src;
460
461 struct rect dst;
462
463};
464
465
466/*
467 * Setup stream attributes if no stream updates are provided
468 * there will be no impact on the stream parameters
469 *
470 * Set up surface attributes and associate to a stream
471 * The surfaces parameter is an absolute set of all surface active for the stream.
472 * If no surfaces are provided, the stream will be blanked; no memory read.
473 * Any flip related attribute changes must be done through this interface.
474 *
475 * After this call:
476 * Surfaces attributes are programmed and configured to be composed into stream.
477 * This does not trigger a flip. No surface address is programmed.
478 *
479 */
480
481void dc_update_surfaces_and_stream(struct dc *dc,
482 struct dc_surface_update *surface_updates, int surface_count,
483 const struct dc_stream *dc_stream,
484 struct dc_stream_update *stream_update);
485
Aric Cyrab2541b2016-12-29 15:27:12 -0500486/*
487 * Log the current stream state.
488 */
489void dc_stream_log(
490 const struct dc_stream *stream,
491 struct dal_logger *dc_logger,
492 enum dc_log_type log_type);
493
494uint8_t dc_get_current_stream_count(const struct dc *dc);
495struct dc_stream *dc_get_stream_at_index(const struct dc *dc, uint8_t i);
496
497/*
498 * Return the current frame counter.
499 */
500uint32_t dc_stream_get_vblank_counter(const struct dc_stream *stream);
501
502/* TODO: Return parsed values rather than direct register read
503 * This has a dependency on the caller (amdgpu_get_crtc_scanoutpos)
504 * being refactored properly to be dce-specific
505 */
Sylvia Tsai81c50962017-04-11 15:15:28 -0400506bool dc_stream_get_scanoutpos(const struct dc_stream *stream,
507 uint32_t *v_blank_start,
508 uint32_t *v_blank_end,
509 uint32_t *h_position,
510 uint32_t *v_position);
Aric Cyrab2541b2016-12-29 15:27:12 -0500511
512/*
513 * Structure to store surface/stream associations for validation
514 */
515struct dc_validation_set {
516 const struct dc_stream *stream;
517 const struct dc_surface *surfaces[MAX_SURFACES];
518 uint8_t surface_count;
519};
520
521/*
522 * This function takes a set of resources and checks that they are cofunctional.
523 *
524 * After this call:
525 * No hardware is programmed for call. Only validation is done.
526 */
Harry Wentland07d72b32017-03-29 11:22:05 -0400527struct validate_context *dc_get_validate_context(
528 const struct dc *dc,
529 const struct dc_validation_set set[],
530 uint8_t set_count);
531
Aric Cyrab2541b2016-12-29 15:27:12 -0500532bool dc_validate_resources(
533 const struct dc *dc,
534 const struct dc_validation_set set[],
535 uint8_t set_count);
536
537/*
538 * This function takes a stream and checks if it is guaranteed to be supported.
539 * Guaranteed means that MAX_COFUNC similar streams are supported.
540 *
541 * After this call:
542 * No hardware is programmed for call. Only validation is done.
543 */
544
545bool dc_validate_guaranteed(
546 const struct dc *dc,
547 const struct dc_stream *stream);
548
Harry Wentland8122a252017-03-29 11:15:14 -0400549void dc_resource_validate_ctx_copy_construct(
550 const struct validate_context *src_ctx,
551 struct validate_context *dst_ctx);
552
553void dc_resource_validate_ctx_destruct(struct validate_context *context);
554
Aric Cyrab2541b2016-12-29 15:27:12 -0500555/*
556 * Set up streams and links associated to drive sinks
557 * The streams parameter is an absolute set of all active streams.
558 *
559 * After this call:
560 * Phy, Encoder, Timing Generator are programmed and enabled.
561 * New streams are enabled with blank stream; no memory read.
562 */
563bool dc_commit_streams(
564 struct dc *dc,
565 const struct dc_stream *streams[],
566 uint8_t stream_count);
567
Harry Wentland45622362017-09-12 15:58:20 -0400568/**
569 * Create a new default stream for the requested sink
570 */
571struct dc_stream *dc_create_stream_for_sink(const struct dc_sink *dc_sink);
572
573void dc_stream_retain(const struct dc_stream *dc_stream);
574void dc_stream_release(const struct dc_stream *dc_stream);
575
576struct dc_stream_status {
Aric Cyrab2541b2016-12-29 15:27:12 -0500577 int primary_otg_inst;
578 int surface_count;
579 const struct dc_surface *surfaces[MAX_SURFACE_NUM];
580
Harry Wentland45622362017-09-12 15:58:20 -0400581 /*
582 * link this stream passes through
583 */
584 const struct dc_link *link;
585};
586
587const struct dc_stream_status *dc_stream_get_status(
588 const struct dc_stream *dc_stream);
589
Leon Elazar5869b0f2017-03-01 12:30:11 -0500590enum surface_update_type dc_check_update_surfaces_for_stream(
591 struct dc *dc,
592 struct dc_surface_update *updates,
593 int surface_count,
Leon Elazaree8f63e2017-03-14 11:54:31 -0400594 struct dc_stream_update *stream_update,
Leon Elazar5869b0f2017-03-01 12:30:11 -0500595 const struct dc_stream_status *stream_status);
596
Harry Wentland45622362017-09-12 15:58:20 -0400597/*******************************************************************************
598 * Link Interfaces
599 ******************************************************************************/
600
601/*
602 * A link contains one or more sinks and their connected status.
603 * The currently active signal type (HDMI, DP-SST, DP-MST) is also reported.
604 */
605struct dc_link {
606 const struct dc_sink *remote_sinks[MAX_SINKS_PER_LINK];
607 unsigned int sink_count;
608 const struct dc_sink *local_sink;
609 unsigned int link_index;
610 enum dc_connection_type type;
611 enum signal_type connector_signal;
612 enum dc_irq_source irq_source_hpd;
613 enum dc_irq_source irq_source_hpd_rx;/* aka DP Short Pulse */
614 /* caps is the same as reported_link_cap. link_traing use
615 * reported_link_cap. Will clean up. TODO
616 */
617 struct dc_link_settings reported_link_cap;
618 struct dc_link_settings verified_link_cap;
619 struct dc_link_settings max_link_setting;
620 struct dc_link_settings cur_link_settings;
621 struct dc_lane_settings cur_lane_setting;
622
623 uint8_t ddc_hw_inst;
624 uint8_t link_enc_hw_inst;
625
Harry Wentland45622362017-09-12 15:58:20 -0400626 bool test_pattern_enabled;
627 union compliance_test_state compliance_test_state;
Andrey Grodzovsky9fb8de72017-02-14 13:50:17 -0500628
629 void *priv;
Andrey Grodzovsky7c7f5b12017-03-28 16:57:52 -0400630 bool aux_mode;
Harry Wentland45622362017-09-12 15:58:20 -0400631};
632
633struct dpcd_caps {
634 union dpcd_rev dpcd_rev;
635 union max_lane_count max_ln_count;
636 union max_down_spread max_down_spread;
637
638 /* dongle type (DP converter, CV smart dongle) */
639 enum display_dongle_type dongle_type;
640 /* Dongle's downstream count. */
641 union sink_count sink_count;
642 /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
643 indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
Charlene Liu03f5c682017-04-21 17:15:40 -0400644 struct dc_dongle_caps dongle_caps;
Harry Wentland45622362017-09-12 15:58:20 -0400645
646 bool allow_invalid_MSA_timing_param;
647 bool panel_mode_edp;
648 uint32_t sink_dev_id;
649 uint32_t branch_dev_id;
650 int8_t branch_dev_name[6];
651 int8_t branch_hw_revision;
652};
653
654struct dc_link_status {
655 struct dpcd_caps *dpcd_caps;
656};
657
658const struct dc_link_status *dc_link_get_status(const struct dc_link *dc_link);
659
660/*
661 * Return an enumerated dc_link. dc_link order is constant and determined at
662 * boot time. They cannot be created or destroyed.
663 * Use dc_get_caps() to get number of links.
664 */
665const struct dc_link *dc_get_link_at_index(const struct dc *dc, uint32_t link_index);
666
667/* Return id of physical connector represented by a dc_link at link_index.*/
668const struct graphics_object_id dc_get_link_id_at_index(
669 struct dc *dc, uint32_t link_index);
670
671/* Set backlight level of an embedded panel (eDP, LVDS). */
672bool dc_link_set_backlight_level(const struct dc_link *dc_link, uint32_t level,
673 uint32_t frame_ramp, const struct dc_stream *stream);
674
Harry Wentland45622362017-09-12 15:58:20 -0400675bool dc_link_set_psr_enable(const struct dc_link *dc_link, bool enable);
676
677bool dc_link_setup_psr(const struct dc_link *dc_link,
Sylvia Tsai94267b32017-04-21 15:29:55 -0400678 const struct dc_stream *stream, struct psr_config *psr_config);
Harry Wentland45622362017-09-12 15:58:20 -0400679
680/* Request DC to detect if there is a Panel connected.
681 * boot - If this call is during initial boot.
682 * Return false for any type of detection failure or MST detection
683 * true otherwise. True meaning further action is required (status update
684 * and OS notification).
685 */
686bool dc_link_detect(const struct dc_link *dc_link, bool boot);
687
688/* Notify DC about DP RX Interrupt (aka Short Pulse Interrupt).
689 * Return:
690 * true - Downstream port status changed. DM should call DC to do the
691 * detection.
692 * false - no change in Downstream port status. No further action required
693 * from DM. */
694bool dc_link_handle_hpd_rx_irq(const struct dc_link *dc_link);
695
696struct dc_sink_init_data;
697
698struct dc_sink *dc_link_add_remote_sink(
699 const struct dc_link *dc_link,
700 const uint8_t *edid,
701 int len,
702 struct dc_sink_init_data *init_data);
703
704void dc_link_remove_remote_sink(
705 const struct dc_link *link,
706 const struct dc_sink *sink);
707
708/* Used by diagnostics for virtual link at the moment */
709void dc_link_set_sink(const struct dc_link *link, struct dc_sink *sink);
710
711void dc_link_dp_set_drive_settings(
Zeyu Fand27383a2017-04-21 10:55:01 -0400712 const struct dc_link *link,
Harry Wentland45622362017-09-12 15:58:20 -0400713 struct link_training_settings *lt_settings);
714
715bool dc_link_dp_perform_link_training(
716 struct dc_link *link,
717 const struct dc_link_settings *link_setting,
718 bool skip_video_pattern);
719
720void dc_link_dp_enable_hpd(const struct dc_link *link);
721
722void dc_link_dp_disable_hpd(const struct dc_link *link);
723
724bool dc_link_dp_set_test_pattern(
725 const struct dc_link *link,
726 enum dp_test_pattern test_pattern,
727 const struct link_training_settings *p_link_settings,
728 const unsigned char *p_custom_pattern,
729 unsigned int cust_pattern_size);
730
731/*******************************************************************************
732 * Sink Interfaces - A sink corresponds to a display output device
733 ******************************************************************************/
734
xhdu8c895312017-03-21 11:05:32 -0400735struct dc_container_id {
736 // 128bit GUID in binary form
737 unsigned char guid[16];
738 // 8 byte port ID -> ELD.PortID
739 unsigned int portId[2];
740 // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
741 unsigned short manufacturerName;
742 // 2 byte product code -> ELD.ProductCode
743 unsigned short productCode;
744};
745
Harry Wentland45622362017-09-12 15:58:20 -0400746/*
747 * The sink structure contains EDID and other display device properties
748 */
749struct dc_sink {
750 enum signal_type sink_signal;
751 struct dc_edid dc_edid; /* raw edid */
752 struct dc_edid_caps edid_caps; /* parse display caps */
xhdu8c895312017-03-21 11:05:32 -0400753 struct dc_container_id *dc_container_id;
Zeyu Fan4a9a5d62017-03-07 11:48:50 -0500754 uint32_t dongle_max_pix_clk;
755 bool converter_disable_audio;
Andrey Grodzovsky5c4e980642017-02-14 15:47:24 -0500756 void *priv;
Harry Wentland45622362017-09-12 15:58:20 -0400757};
758
759void dc_sink_retain(const struct dc_sink *sink);
760void dc_sink_release(const struct dc_sink *sink);
761
762const struct audio **dc_get_audios(struct dc *dc);
763
764struct dc_sink_init_data {
765 enum signal_type sink_signal;
766 const struct dc_link *link;
767 uint32_t dongle_max_pix_clk;
768 bool converter_disable_audio;
769};
770
771struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
xhdu8c895312017-03-21 11:05:32 -0400772bool dc_sink_get_container_id(struct dc_sink *dc_sink, struct dc_container_id *container_id);
773bool dc_sink_set_container_id(struct dc_sink *dc_sink, const struct dc_container_id *container_id);
Harry Wentland45622362017-09-12 15:58:20 -0400774
775/*******************************************************************************
Aric Cyrab2541b2016-12-29 15:27:12 -0500776 * Cursor interfaces - To manages the cursor within a stream
Harry Wentland45622362017-09-12 15:58:20 -0400777 ******************************************************************************/
778/* TODO: Deprecated once we switch to dc_set_cursor_position */
Aric Cyrab2541b2016-12-29 15:27:12 -0500779bool dc_stream_set_cursor_attributes(
780 const struct dc_stream *stream,
Harry Wentland45622362017-09-12 15:58:20 -0400781 const struct dc_cursor_attributes *attributes);
782
Aric Cyrab2541b2016-12-29 15:27:12 -0500783bool dc_stream_set_cursor_position(
784 const struct dc_stream *stream,
Dmytro Laktyushkinbeb16b62017-04-21 09:34:09 -0400785 const struct dc_cursor_position *position);
Harry Wentland45622362017-09-12 15:58:20 -0400786
787/* Newer interfaces */
788struct dc_cursor {
789 struct dc_plane_address address;
790 struct dc_cursor_attributes attributes;
791};
792
Harry Wentland45622362017-09-12 15:58:20 -0400793/*******************************************************************************
794 * Interrupt interfaces
795 ******************************************************************************/
796enum dc_irq_source dc_interrupt_to_irq_source(
797 struct dc *dc,
798 uint32_t src_id,
799 uint32_t ext_id);
800void dc_interrupt_set(const struct dc *dc, enum dc_irq_source src, bool enable);
801void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
802enum dc_irq_source dc_get_hpd_irq_source_at_index(
803 struct dc *dc, uint32_t link_index);
804
805/*******************************************************************************
806 * Power Interfaces
807 ******************************************************************************/
808
809void dc_set_power_state(
810 struct dc *dc,
Andrey Grodzovskya3621482017-04-20 15:59:25 -0400811 enum dc_acpi_cm_power_state power_state);
Harry Wentland45622362017-09-12 15:58:20 -0400812void dc_resume(const struct dc *dc);
813
814/*******************************************************************************
815 * DDC Interfaces
816 ******************************************************************************/
817
818const struct ddc_service *dc_get_ddc_at_index(
819 struct dc *dc, uint32_t link_index);
820
821/*
822 * DPCD access interfaces
823 */
824
Andrey Grodzovsky7c7f5b12017-03-28 16:57:52 -0400825bool dc_read_aux_dpcd(
Harry Wentland45622362017-09-12 15:58:20 -0400826 struct dc *dc,
827 uint32_t link_index,
828 uint32_t address,
829 uint8_t *data,
830 uint32_t size);
831
Andrey Grodzovsky7c7f5b12017-03-28 16:57:52 -0400832bool dc_write_aux_dpcd(
Harry Wentland45622362017-09-12 15:58:20 -0400833 struct dc *dc,
834 uint32_t link_index,
835 uint32_t address,
836 const uint8_t *data,
Zeyu Fan2b230ea2017-02-16 16:15:30 -0500837 uint32_t size);
838
Andrey Grodzovsky7c7f5b12017-03-28 16:57:52 -0400839bool dc_read_aux_i2c(
840 struct dc *dc,
841 uint32_t link_index,
842 enum i2c_mot_mode mot,
843 uint32_t address,
844 uint8_t *data,
845 uint32_t size);
846
847bool dc_write_aux_i2c(
848 struct dc *dc,
849 uint32_t link_index,
850 enum i2c_mot_mode mot,
851 uint32_t address,
852 const uint8_t *data,
853 uint32_t size);
854
Zeyu Fan2b230ea2017-02-16 16:15:30 -0500855bool dc_query_ddc_data(
856 struct dc *dc,
857 uint32_t link_index,
858 uint32_t address,
859 uint8_t *write_buf,
860 uint32_t write_size,
861 uint8_t *read_buf,
862 uint32_t read_size);
Harry Wentland45622362017-09-12 15:58:20 -0400863
864bool dc_submit_i2c(
865 struct dc *dc,
866 uint32_t link_index,
867 struct i2c_command *cmd);
868
Anthony Koo5e7773a2017-01-23 16:55:20 -0500869
Harry Wentland45622362017-09-12 15:58:20 -0400870#endif /* DC_INTERFACE_H_ */