]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/gpu/drm/amd/display/dc/dc.h
drm/qxl: Replace drm_gem_object_reference/unreference() with _get/put()
[linux.git] / drivers / gpu / drm / amd / display / dc / dc.h
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"
30 #include "grph_object_defs.h"
31 #include "logger_types.h"
32 #include "gpio_types.h"
33 #include "link_service_types.h"
34 #include "grph_object_ctrl_defs.h"
35 #include <inc/hw/opp.h>
36
37 #include "inc/hw_sequencer.h"
38 #include "inc/compressor.h"
39 #include "dml/display_mode_lib.h"
40
41 #define DC_VER "3.1.27"
42
43 #define MAX_SURFACES 3
44 #define MAX_STREAMS 6
45 #define MAX_SINKS_PER_LINK 4
46
47
48 /*******************************************************************************
49  * Display Core Interfaces
50  ******************************************************************************/
51 struct dc_caps {
52         uint32_t max_streams;
53         uint32_t max_links;
54         uint32_t max_audios;
55         uint32_t max_slave_planes;
56         uint32_t max_planes;
57         uint32_t max_downscale_ratio;
58         uint32_t i2c_speed_in_khz;
59         unsigned int max_cursor_size;
60         unsigned int max_video_width;
61         int linear_pitch_alignment;
62         bool dcc_const_color;
63         bool dynamic_audio;
64         bool is_apu;
65 };
66
67 struct dc_dcc_surface_param {
68         struct dc_size surface_size;
69         enum surface_pixel_format format;
70         enum swizzle_mode_values swizzle_mode;
71         enum dc_scan_direction scan;
72 };
73
74 struct dc_dcc_setting {
75         unsigned int max_compressed_blk_size;
76         unsigned int max_uncompressed_blk_size;
77         bool independent_64b_blks;
78 };
79
80 struct dc_surface_dcc_cap {
81         union {
82                 struct {
83                         struct dc_dcc_setting rgb;
84                 } grph;
85
86                 struct {
87                         struct dc_dcc_setting luma;
88                         struct dc_dcc_setting chroma;
89                 } video;
90         };
91
92         bool capable;
93         bool const_color_support;
94 };
95
96 struct dc_static_screen_events {
97         bool cursor_update;
98         bool surface_update;
99         bool overlay_update;
100 };
101
102
103 /* Surface update type is used by dc_update_surfaces_and_stream
104  * The update type is determined at the very beginning of the function based
105  * on parameters passed in and decides how much programming (or updating) is
106  * going to be done during the call.
107  *
108  * UPDATE_TYPE_FAST is used for really fast updates that do not require much
109  * logical calculations or hardware register programming. This update MUST be
110  * ISR safe on windows. Currently fast update will only be used to flip surface
111  * address.
112  *
113  * UPDATE_TYPE_MED is used for slower updates which require significant hw
114  * re-programming however do not affect bandwidth consumption or clock
115  * requirements. At present, this is the level at which front end updates
116  * that do not require us to run bw_calcs happen. These are in/out transfer func
117  * updates, viewport offset changes, recout size changes and pixel depth changes.
118  * This update can be done at ISR, but we want to minimize how often this happens.
119  *
120  * UPDATE_TYPE_FULL is slow. Really slow. This requires us to recalculate our
121  * bandwidth and clocks, possibly rearrange some pipes and reprogram anything front
122  * end related. Any time viewport dimensions, recout dimensions, scaling ratios or
123  * gamma need to be adjusted or pipe needs to be turned on (or disconnected) we do
124  * a full update. This cannot be done at ISR level and should be a rare event.
125  * Unless someone is stress testing mpo enter/exit, playing with colour or adjusting
126  * underscan we don't expect to see this call at all.
127  */
128
129 enum surface_update_type {
130         UPDATE_TYPE_FAST, /* super fast, safe to execute in isr */
131         UPDATE_TYPE_MED,  /* ISR safe, most of programming needed, no bw/clk change*/
132         UPDATE_TYPE_FULL, /* may need to shuffle resources */
133 };
134
135 /* Forward declaration*/
136 struct dc;
137 struct dc_plane_state;
138 struct dc_state;
139
140
141 struct dc_cap_funcs {
142         bool (*get_dcc_compression_cap)(const struct dc *dc,
143                         const struct dc_dcc_surface_param *input,
144                         struct dc_surface_dcc_cap *output);
145 };
146
147 struct link_training_settings;
148
149
150 /* Structure to hold configuration flags set by dm at dc creation. */
151 struct dc_config {
152         bool gpu_vm_support;
153         bool disable_disp_pll_sharing;
154 };
155
156 enum dcc_option {
157         DCC_ENABLE = 0,
158         DCC_DISABLE = 1,
159         DCC_HALF_REQ_DISALBE = 2,
160 };
161
162 enum pipe_split_policy {
163         MPC_SPLIT_DYNAMIC = 0,
164         MPC_SPLIT_AVOID = 1,
165         MPC_SPLIT_AVOID_MULT_DISP = 2,
166 };
167
168 enum wm_report_mode {
169         WM_REPORT_DEFAULT = 0,
170         WM_REPORT_OVERRIDE = 1,
171 };
172
173 struct dc_debug {
174         bool surface_visual_confirm;
175         bool sanity_checks;
176         bool max_disp_clk;
177         bool surface_trace;
178         bool timing_trace;
179         bool clock_trace;
180         bool validation_trace;
181
182         /* stutter efficiency related */
183         bool disable_stutter;
184         bool use_max_lb;
185         enum dcc_option disable_dcc;
186         enum pipe_split_policy pipe_split_policy;
187         bool force_single_disp_pipe_split;
188         bool voltage_align_fclk;
189
190         bool disable_dfs_bypass;
191         bool disable_dpp_power_gate;
192         bool disable_hubp_power_gate;
193         bool disable_pplib_wm_range;
194         enum wm_report_mode pplib_wm_report_mode;
195         unsigned int min_disp_clk_khz;
196         int sr_exit_time_dpm0_ns;
197         int sr_enter_plus_exit_time_dpm0_ns;
198         int sr_exit_time_ns;
199         int sr_enter_plus_exit_time_ns;
200         int urgent_latency_ns;
201         int percent_of_ideal_drambw;
202         int dram_clock_change_latency_ns;
203         int always_scale;
204         bool disable_pplib_clock_request;
205         bool disable_clock_gate;
206         bool disable_dmcu;
207         bool disable_psr;
208         bool force_abm_enable;
209         bool disable_hbup_pg;
210         bool disable_dpp_pg;
211         bool disable_stereo_support;
212         bool vsr_support;
213         bool performance_trace;
214 };
215 struct dc_state;
216 struct resource_pool;
217 struct dce_hwseq;
218 struct dc {
219         struct dc_caps caps;
220         struct dc_cap_funcs cap_funcs;
221         struct dc_config config;
222         struct dc_debug debug;
223
224         struct dc_context *ctx;
225
226         uint8_t link_count;
227         struct dc_link *links[MAX_PIPES * 2];
228
229         struct dc_state *current_state;
230         struct resource_pool *res_pool;
231
232         /* Display Engine Clock levels */
233         struct dm_pp_clock_levels sclk_lvls;
234
235         /* Inputs into BW and WM calculations. */
236         struct bw_calcs_dceip *bw_dceip;
237         struct bw_calcs_vbios *bw_vbios;
238 #ifdef CONFIG_DRM_AMD_DC_DCN1_0
239         struct dcn_soc_bounding_box *dcn_soc;
240         struct dcn_ip_params *dcn_ip;
241         struct display_mode_lib dml;
242 #endif
243
244         /* HW functions */
245         struct hw_sequencer_funcs hwss;
246         struct dce_hwseq *hwseq;
247
248         /* temp store of dm_pp_display_configuration
249          * to compare to see if display config changed
250          */
251         struct dm_pp_display_configuration prev_display_config;
252
253         bool optimized_required;
254
255         /* FBC compressor */
256 #if defined(CONFIG_DRM_AMD_DC_FBC)
257         struct compressor *fbc_compressor;
258 #endif
259 };
260
261 enum frame_buffer_mode {
262         FRAME_BUFFER_MODE_LOCAL_ONLY = 0,
263         FRAME_BUFFER_MODE_ZFB_ONLY,
264         FRAME_BUFFER_MODE_MIXED_ZFB_AND_LOCAL,
265 } ;
266
267 struct dchub_init_data {
268         int64_t zfb_phys_addr_base;
269         int64_t zfb_mc_base_addr;
270         uint64_t zfb_size_in_byte;
271         enum frame_buffer_mode fb_mode;
272         bool dchub_initialzied;
273         bool dchub_info_valid;
274 };
275
276 struct dc_init_data {
277         struct hw_asic_id asic_id;
278         void *driver; /* ctx */
279         struct cgs_device *cgs_device;
280
281         int num_virtual_links;
282         /*
283          * If 'vbios_override' not NULL, it will be called instead
284          * of the real VBIOS. Intended use is Diagnostics on FPGA.
285          */
286         struct dc_bios *vbios_override;
287         enum dce_environment dce_environment;
288
289         struct dc_config flags;
290         uint32_t log_mask;
291 #if defined(CONFIG_DRM_AMD_DC_FBC)
292         uint64_t fbc_gpu_addr;
293 #endif
294 };
295
296 struct dc *dc_create(const struct dc_init_data *init_params);
297
298 void dc_destroy(struct dc **dc);
299
300 /*******************************************************************************
301  * Surface Interfaces
302  ******************************************************************************/
303
304 enum {
305         TRANSFER_FUNC_POINTS = 1025
306 };
307
308 // Moved here from color module for linux
309 enum color_transfer_func {
310         transfer_func_unknown,
311         transfer_func_srgb,
312         transfer_func_bt709,
313         transfer_func_pq2084,
314         transfer_func_pq2084_interim,
315         transfer_func_linear_0_1,
316         transfer_func_linear_0_125,
317         transfer_func_dolbyvision,
318         transfer_func_gamma_22,
319         transfer_func_gamma_26
320 };
321
322 struct dc_hdr_static_metadata {
323         /* display chromaticities and white point in units of 0.00001 */
324         unsigned int chromaticity_green_x;
325         unsigned int chromaticity_green_y;
326         unsigned int chromaticity_blue_x;
327         unsigned int chromaticity_blue_y;
328         unsigned int chromaticity_red_x;
329         unsigned int chromaticity_red_y;
330         unsigned int chromaticity_white_point_x;
331         unsigned int chromaticity_white_point_y;
332
333         uint32_t min_luminance;
334         uint32_t max_luminance;
335         uint32_t maximum_content_light_level;
336         uint32_t maximum_frame_average_light_level;
337
338         bool hdr_supported;
339         bool is_hdr;
340 };
341
342 enum dc_transfer_func_type {
343         TF_TYPE_PREDEFINED,
344         TF_TYPE_DISTRIBUTED_POINTS,
345         TF_TYPE_BYPASS,
346 };
347
348 struct dc_transfer_func_distributed_points {
349         struct fixed31_32 red[TRANSFER_FUNC_POINTS];
350         struct fixed31_32 green[TRANSFER_FUNC_POINTS];
351         struct fixed31_32 blue[TRANSFER_FUNC_POINTS];
352
353         uint16_t end_exponent;
354         uint16_t x_point_at_y1_red;
355         uint16_t x_point_at_y1_green;
356         uint16_t x_point_at_y1_blue;
357 };
358
359 enum dc_transfer_func_predefined {
360         TRANSFER_FUNCTION_SRGB,
361         TRANSFER_FUNCTION_BT709,
362         TRANSFER_FUNCTION_PQ,
363         TRANSFER_FUNCTION_LINEAR,
364         TRANSFER_FUNCTION_UNITY,
365 };
366
367 struct dc_transfer_func {
368         struct kref refcount;
369         struct dc_transfer_func_distributed_points tf_pts;
370         enum dc_transfer_func_type type;
371         enum dc_transfer_func_predefined tf;
372         struct dc_context *ctx;
373 };
374
375 /*
376  * This structure is filled in by dc_surface_get_status and contains
377  * the last requested address and the currently active address so the called
378  * can determine if there are any outstanding flips
379  */
380 struct dc_plane_status {
381         struct dc_plane_address requested_address;
382         struct dc_plane_address current_address;
383         bool is_flip_pending;
384         bool is_right_eye;
385 };
386
387 union surface_update_flags {
388
389         struct {
390                 /* Medium updates */
391                 uint32_t dcc_change:1;
392                 uint32_t color_space_change:1;
393                 uint32_t input_tf_change:1;
394                 uint32_t horizontal_mirror_change:1;
395                 uint32_t per_pixel_alpha_change:1;
396                 uint32_t rotation_change:1;
397                 uint32_t swizzle_change:1;
398                 uint32_t scaling_change:1;
399                 uint32_t position_change:1;
400                 uint32_t in_transfer_func:1;
401                 uint32_t input_csc_change:1;
402
403                 /* Full updates */
404                 uint32_t new_plane:1;
405                 uint32_t bpp_change:1;
406                 uint32_t bandwidth_change:1;
407                 uint32_t clock_change:1;
408                 uint32_t stereo_format_change:1;
409                 uint32_t full_update:1;
410         } bits;
411
412         uint32_t raw;
413 };
414
415 struct dc_plane_state {
416         struct dc_plane_address address;
417         struct scaling_taps scaling_quality;
418         struct rect src_rect;
419         struct rect dst_rect;
420         struct rect clip_rect;
421
422         union plane_size plane_size;
423         union dc_tiling_info tiling_info;
424
425         struct dc_plane_dcc_param dcc;
426
427         struct dc_gamma *gamma_correction;
428         struct dc_transfer_func *in_transfer_func;
429         struct dc_bias_and_scale *bias_and_scale;
430         struct csc_transform input_csc_color_matrix;
431         struct fixed31_32 coeff_reduction_factor;
432
433         // TODO: No longer used, remove
434         struct dc_hdr_static_metadata hdr_static_ctx;
435
436         enum dc_color_space color_space;
437         enum color_transfer_func input_tf;
438
439         enum surface_pixel_format format;
440         enum dc_rotation_angle rotation;
441         enum plane_stereo_format stereo_format;
442
443         bool is_tiling_rotated;
444         bool per_pixel_alpha;
445         bool visible;
446         bool flip_immediate;
447         bool horizontal_mirror;
448
449         union surface_update_flags update_flags;
450         /* private to DC core */
451         struct dc_plane_status status;
452         struct dc_context *ctx;
453
454         /* private to dc_surface.c */
455         enum dc_irq_source irq_source;
456         struct kref refcount;
457 };
458
459 struct dc_plane_info {
460         union plane_size plane_size;
461         union dc_tiling_info tiling_info;
462         struct dc_plane_dcc_param dcc;
463         enum surface_pixel_format format;
464         enum dc_rotation_angle rotation;
465         enum plane_stereo_format stereo_format;
466         enum dc_color_space color_space;
467         enum color_transfer_func input_tf;
468         bool horizontal_mirror;
469         bool visible;
470         bool per_pixel_alpha;
471         bool input_csc_enabled;
472 };
473
474 struct dc_scaling_info {
475         struct rect src_rect;
476         struct rect dst_rect;
477         struct rect clip_rect;
478         struct scaling_taps scaling_quality;
479 };
480
481 struct dc_surface_update {
482         struct dc_plane_state *surface;
483
484         /* isr safe update parameters.  null means no updates */
485         struct dc_flip_addrs *flip_addr;
486         struct dc_plane_info *plane_info;
487         struct dc_scaling_info *scaling_info;
488
489         /* following updates require alloc/sleep/spin that is not isr safe,
490          * null means no updates
491          */
492         /* gamma TO BE REMOVED */
493         struct dc_gamma *gamma;
494         enum color_transfer_func color_input_tf;
495         enum color_transfer_func color_output_tf;
496         struct dc_transfer_func *in_transfer_func;
497
498         struct csc_transform *input_csc_color_matrix;
499         struct fixed31_32 *coeff_reduction_factor;
500 };
501
502 /*
503  * Create a new surface with default parameters;
504  */
505 struct dc_plane_state *dc_create_plane_state(struct dc *dc);
506 const struct dc_plane_status *dc_plane_get_status(
507                 const struct dc_plane_state *plane_state);
508
509 void dc_plane_state_retain(struct dc_plane_state *plane_state);
510 void dc_plane_state_release(struct dc_plane_state *plane_state);
511
512 void dc_gamma_retain(struct dc_gamma *dc_gamma);
513 void dc_gamma_release(struct dc_gamma **dc_gamma);
514 struct dc_gamma *dc_create_gamma(void);
515
516 void dc_transfer_func_retain(struct dc_transfer_func *dc_tf);
517 void dc_transfer_func_release(struct dc_transfer_func *dc_tf);
518 struct dc_transfer_func *dc_create_transfer_func(void);
519
520 /*
521  * This structure holds a surface address.  There could be multiple addresses
522  * in cases such as Stereo 3D, Planar YUV, etc.  Other per-flip attributes such
523  * as frame durations and DCC format can also be set.
524  */
525 struct dc_flip_addrs {
526         struct dc_plane_address address;
527         bool flip_immediate;
528         /* TODO: add flip duration for FreeSync */
529 };
530
531 bool dc_post_update_surfaces_to_stream(
532                 struct dc *dc);
533
534 #include "dc_stream.h"
535
536 /*
537  * Structure to store surface/stream associations for validation
538  */
539 struct dc_validation_set {
540         struct dc_stream_state *stream;
541         struct dc_plane_state *plane_states[MAX_SURFACES];
542         uint8_t plane_count;
543 };
544
545 enum dc_status dc_validate_plane(struct dc *dc, const struct dc_plane_state *plane_state);
546
547 enum dc_status dc_validate_global_state(
548                 struct dc *dc,
549                 struct dc_state *new_ctx);
550
551
552 void dc_resource_state_construct(
553                 const struct dc *dc,
554                 struct dc_state *dst_ctx);
555
556 void dc_resource_state_copy_construct(
557                 const struct dc_state *src_ctx,
558                 struct dc_state *dst_ctx);
559
560 void dc_resource_state_copy_construct_current(
561                 const struct dc *dc,
562                 struct dc_state *dst_ctx);
563
564 void dc_resource_state_destruct(struct dc_state *context);
565
566 /*
567  * TODO update to make it about validation sets
568  * Set up streams and links associated to drive sinks
569  * The streams parameter is an absolute set of all active streams.
570  *
571  * After this call:
572  *   Phy, Encoder, Timing Generator are programmed and enabled.
573  *   New streams are enabled with blank stream; no memory read.
574  */
575 bool dc_commit_state(struct dc *dc, struct dc_state *context);
576
577
578 struct dc_state *dc_create_state(void);
579 void dc_retain_state(struct dc_state *context);
580 void dc_release_state(struct dc_state *context);
581
582 /*******************************************************************************
583  * Link Interfaces
584  ******************************************************************************/
585
586 struct dpcd_caps {
587         union dpcd_rev dpcd_rev;
588         union max_lane_count max_ln_count;
589         union max_down_spread max_down_spread;
590
591         /* dongle type (DP converter, CV smart dongle) */
592         enum display_dongle_type dongle_type;
593         /* Dongle's downstream count. */
594         union sink_count sink_count;
595         /* If dongle_type == DISPLAY_DONGLE_DP_HDMI_CONVERTER,
596         indicates 'Frame Sequential-to-lllFrame Pack' conversion capability.*/
597         struct dc_dongle_caps dongle_caps;
598
599         uint32_t sink_dev_id;
600         uint32_t branch_dev_id;
601         int8_t branch_dev_name[6];
602         int8_t branch_hw_revision;
603
604         bool allow_invalid_MSA_timing_param;
605         bool panel_mode_edp;
606         bool dpcd_display_control_capable;
607 };
608
609 #include "dc_link.h"
610
611 /*******************************************************************************
612  * Sink Interfaces - A sink corresponds to a display output device
613  ******************************************************************************/
614
615 struct dc_container_id {
616         // 128bit GUID in binary form
617         unsigned char  guid[16];
618         // 8 byte port ID -> ELD.PortID
619         unsigned int   portId[2];
620         // 128bit GUID in binary formufacturer name -> ELD.ManufacturerName
621         unsigned short manufacturerName;
622         // 2 byte product code -> ELD.ProductCode
623         unsigned short productCode;
624 };
625
626
627
628 /*
629  * The sink structure contains EDID and other display device properties
630  */
631 struct dc_sink {
632         enum signal_type sink_signal;
633         struct dc_edid dc_edid; /* raw edid */
634         struct dc_edid_caps edid_caps; /* parse display caps */
635         struct dc_container_id *dc_container_id;
636         uint32_t dongle_max_pix_clk;
637         void *priv;
638         struct stereo_3d_features features_3d[TIMING_3D_FORMAT_MAX];
639         bool converter_disable_audio;
640
641         /* private to DC core */
642         struct dc_link *link;
643         struct dc_context *ctx;
644
645         /* private to dc_sink.c */
646         struct kref refcount;
647
648 };
649
650 void dc_sink_retain(struct dc_sink *sink);
651 void dc_sink_release(struct dc_sink *sink);
652
653 struct dc_sink_init_data {
654         enum signal_type sink_signal;
655         struct dc_link *link;
656         uint32_t dongle_max_pix_clk;
657         bool converter_disable_audio;
658 };
659
660 struct dc_sink *dc_sink_create(const struct dc_sink_init_data *init_params);
661
662 /* Newer interfaces  */
663 struct dc_cursor {
664         struct dc_plane_address address;
665         struct dc_cursor_attributes attributes;
666 };
667
668 /*******************************************************************************
669  * Interrupt interfaces
670  ******************************************************************************/
671 enum dc_irq_source dc_interrupt_to_irq_source(
672                 struct dc *dc,
673                 uint32_t src_id,
674                 uint32_t ext_id);
675 void dc_interrupt_set(struct dc *dc, enum dc_irq_source src, bool enable);
676 void dc_interrupt_ack(struct dc *dc, enum dc_irq_source src);
677 enum dc_irq_source dc_get_hpd_irq_source_at_index(
678                 struct dc *dc, uint32_t link_index);
679
680 /*******************************************************************************
681  * Power Interfaces
682  ******************************************************************************/
683
684 void dc_set_power_state(
685                 struct dc *dc,
686                 enum dc_acpi_cm_power_state power_state);
687 void dc_resume(struct dc *dc);
688
689 #endif /* DC_INTERFACE_H_ */