2 * Copyright 2016 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.
30 #include "fixed31_32.h"
31 #include "signal_types.h"
33 /******************************************************************************
34 * Data types for Virtual HW Layer of DAL3.
35 * (see DAL3 design documents for HW Layer definition)
37 * The intended uses are:
38 * 1. Generation pseudocode sequences for HW programming.
39 * 2. Implementation of real HW programming by HW Sequencer of DAL3.
41 * Note: do *not* add any types which are *not* used for HW programming - this
42 * will ensure separation of Logic layer from HW layer.
43 ******************************************************************************/
59 #define PHYSICAL_ADDRESS_LOC union large_integer
61 enum dc_plane_addr_type {
62 PLN_ADDR_TYPE_GRAPHICS = 0,
63 PLN_ADDR_TYPE_GRPH_STEREO,
64 PLN_ADDR_TYPE_VIDEO_PROGRESSIVE,
67 struct dc_plane_address {
68 enum dc_plane_addr_type type;
72 PHYSICAL_ADDRESS_LOC addr;
73 PHYSICAL_ADDRESS_LOC meta_addr;
74 union large_integer dcc_const_color;
79 PHYSICAL_ADDRESS_LOC left_addr;
80 PHYSICAL_ADDRESS_LOC left_meta_addr;
81 union large_integer left_dcc_const_color;
83 PHYSICAL_ADDRESS_LOC right_addr;
84 PHYSICAL_ADDRESS_LOC right_meta_addr;
85 union large_integer right_dcc_const_color;
91 PHYSICAL_ADDRESS_LOC luma_addr;
92 PHYSICAL_ADDRESS_LOC luma_meta_addr;
93 union large_integer luma_dcc_const_color;
95 PHYSICAL_ADDRESS_LOC chroma_addr;
96 PHYSICAL_ADDRESS_LOC chroma_meta_addr;
97 union large_integer chroma_dcc_const_color;
115 /* Grph or Video will be selected
116 * based on format above:
117 * Use Video structure if
118 * format >= DalPixelFormat_VideoBegin
119 * else use Grph structure
122 struct rect surface_size;
123 /* Graphic surface pitch in pixels.
124 * In LINEAR_GENERAL mode, pitch
125 * is 32 pixel aligned.
131 struct rect luma_size;
132 /* Graphic surface pitch in pixels.
133 * In LINEAR_GENERAL mode, pitch is
138 struct rect chroma_size;
139 /* Graphic surface pitch in pixels.
140 * In LINEAR_GENERAL mode, pitch is
147 struct dc_plane_dcc_param {
153 bool independent_64b_blks;
158 bool independent_64b_blks_l;
161 bool independent_64b_blks_c;
166 /*Displayable pixel format in fb*/
167 enum surface_pixel_format {
168 SURFACE_PIXEL_FORMAT_GRPH_BEGIN = 0,
169 /*TOBE REMOVED paletta 256 colors*/
170 SURFACE_PIXEL_FORMAT_GRPH_PALETA_256_COLORS =
171 SURFACE_PIXEL_FORMAT_GRPH_BEGIN,
173 SURFACE_PIXEL_FORMAT_GRPH_ARGB1555,
175 SURFACE_PIXEL_FORMAT_GRPH_RGB565,
177 SURFACE_PIXEL_FORMAT_GRPH_ARGB8888,
179 SURFACE_PIXEL_FORMAT_GRPH_ABGR8888,
181 SURFACE_PIXEL_FORMAT_GRPH_ARGB2101010,
183 SURFACE_PIXEL_FORMAT_GRPH_ABGR2101010,
184 /*TOBE REMOVED swaped, XR_BIAS has no differance
185 * for pixel layout than previous and we can
186 * delete this after discusion*/
187 SURFACE_PIXEL_FORMAT_GRPH_ABGR2101010_XR_BIAS,
189 SURFACE_PIXEL_FORMAT_GRPH_ARGB16161616,
191 SURFACE_PIXEL_FORMAT_GRPH_ARGB16161616F,
193 SURFACE_PIXEL_FORMAT_GRPH_ABGR16161616F,
194 /*grow graphics here if necessary */
195 SURFACE_PIXEL_FORMAT_VIDEO_AYCrCb8888,
196 SURFACE_PIXEL_FORMAT_VIDEO_BEGIN,
197 SURFACE_PIXEL_FORMAT_VIDEO_420_YCbCr =
198 SURFACE_PIXEL_FORMAT_VIDEO_BEGIN,
199 SURFACE_PIXEL_FORMAT_VIDEO_420_YCrCb,
200 SURFACE_PIXEL_FORMAT_VIDEO_420_10bpc_YCbCr,
201 SURFACE_PIXEL_FORMAT_VIDEO_420_10bpc_YCrCb,
202 SURFACE_PIXEL_FORMAT_SUBSAMPLE_END,
203 SURFACE_PIXEL_FORMAT_INVALID
205 /*grow 444 video here if necessary */
213 PIXEL_FORMAT_UNINITIALIZED,
216 PIXEL_FORMAT_ARGB8888,
217 PIXEL_FORMAT_ARGB2101010,
218 PIXEL_FORMAT_ARGB2101010_XRBIAS,
221 PIXEL_FORMAT_420BPP8,
222 PIXEL_FORMAT_420BPP10,
223 /*end of pixel format definition*/
224 PIXEL_FORMAT_INVALID,
226 PIXEL_FORMAT_GRPH_BEGIN = PIXEL_FORMAT_INDEX8,
227 PIXEL_FORMAT_GRPH_END = PIXEL_FORMAT_FP16,
228 PIXEL_FORMAT_VIDEO_BEGIN = PIXEL_FORMAT_420BPP8,
229 PIXEL_FORMAT_VIDEO_END = PIXEL_FORMAT_420BPP10,
233 enum tile_split_values {
234 DC_DISPLAY_MICRO_TILING = 0x0,
235 DC_THIN_MICRO_TILING = 0x1,
236 DC_DEPTH_MICRO_TILING = 0x2,
237 DC_ROTATED_MICRO_TILING = 0x3,
240 /* TODO: These values come from hardware spec. We need to readdress this
241 * if they ever change.
243 enum array_mode_values {
244 DC_ARRAY_LINEAR_GENERAL = 0,
245 DC_ARRAY_LINEAR_ALLIGNED,
246 DC_ARRAY_1D_TILED_THIN1,
247 DC_ARRAY_1D_TILED_THICK,
248 DC_ARRAY_2D_TILED_THIN1,
249 DC_ARRAY_PRT_TILED_THIN1,
250 DC_ARRAY_PRT_2D_TILED_THIN1,
251 DC_ARRAY_2D_TILED_THICK,
252 DC_ARRAY_2D_TILED_X_THICK,
253 DC_ARRAY_PRT_TILED_THICK,
254 DC_ARRAY_PRT_2D_TILED_THICK,
255 DC_ARRAY_PRT_3D_TILED_THIN1,
256 DC_ARRAY_3D_TILED_THIN1,
257 DC_ARRAY_3D_TILED_THICK,
258 DC_ARRAY_3D_TILED_X_THICK,
259 DC_ARRAY_PRT_3D_TILED_THICK,
262 enum tile_mode_values {
263 DC_ADDR_SURF_MICRO_TILING_DISPLAY = 0x0,
264 DC_ADDR_SURF_MICRO_TILING_NON_DISPLAY = 0x1,
267 enum swizzle_mode_values {
295 union dc_tiling_info {
298 /* Specifies the number of memory banks for tiling
300 * Only applies to 2D and 3D tiling modes.
301 * POSSIBLE VALUES: 2,4,8,16
303 unsigned int num_banks;
304 /* Specifies the number of tiles in the x direction
305 * to be incorporated into the same bank.
306 * Only applies to 2D and 3D tiling modes.
307 * POSSIBLE VALUES: 1,2,4,8
309 unsigned int bank_width;
310 unsigned int bank_width_c;
311 /* Specifies the number of tiles in the y direction to
312 * be incorporated into the same bank.
313 * Only applies to 2D and 3D tiling modes.
314 * POSSIBLE VALUES: 1,2,4,8
316 unsigned int bank_height;
317 unsigned int bank_height_c;
318 /* Specifies the macro tile aspect ratio. Only applies
319 * to 2D and 3D tiling modes.
321 unsigned int tile_aspect;
322 unsigned int tile_aspect_c;
323 /* Specifies the number of bytes that will be stored
324 * contiguously for each tile.
325 * If the tile data requires more storage than this
326 * amount, it is split into multiple slices.
327 * This field must not be larger than
328 * GB_ADDR_CONFIG.DRAM_ROW_SIZE.
329 * Only applies to 2D and 3D tiling modes.
330 * For color render targets, TILE_SPLIT >= 256B.
332 enum tile_split_values tile_split;
333 enum tile_split_values tile_split_c;
334 /* Specifies the addressing within a tile.
335 * 0x0 - DISPLAY_MICRO_TILING
336 * 0x1 - THIN_MICRO_TILING
337 * 0x2 - DEPTH_MICRO_TILING
338 * 0x3 - ROTATED_MICRO_TILING
340 enum tile_mode_values tile_mode;
341 enum tile_mode_values tile_mode_c;
342 /* Specifies the number of pipes and how they are
343 * interleaved in the surface.
344 * Refer to memory addressing document for complete
345 * details and constraints.
347 unsigned int pipe_config;
348 /* Specifies the tiling mode of the surface.
349 * THIN tiles use an 8x8x1 tile size.
350 * THICK tiles use an 8x8x4 tile size.
351 * 2D tiling modes rotate banks for successive Z slices
352 * 3D tiling modes rotate pipes and banks for Z slices
353 * Refer to memory addressing document for complete
354 * details and constraints.
356 enum array_mode_values array_mode;
360 unsigned int num_pipes;
361 unsigned int num_banks;
362 unsigned int pipe_interleave;
363 unsigned int num_shader_engines;
364 unsigned int num_rb_per_se;
365 unsigned int max_compressed_frags;
368 enum swizzle_mode_values swizzle;
376 enum dc_rotation_angle {
377 ROTATION_ANGLE_0 = 0,
384 enum dc_scan_direction {
385 SCAN_DIRECTION_UNKNOWN = 0,
386 SCAN_DIRECTION_HORIZONTAL = 1, /* 0, 180 rotation */
387 SCAN_DIRECTION_VERTICAL = 2, /* 90, 270 rotation */
390 struct dc_cursor_position {
398 * This parameter indicates whether HW cursor should be enabled
404 struct dc_cursor_mi_param {
405 unsigned int pixel_clk_khz;
406 unsigned int ref_clk_khz;
407 struct rect viewport;
408 struct fixed31_32 h_scale_ratio;
409 struct fixed31_32 v_scale_ratio;
410 enum dc_rotation_angle rotation;
414 /* IPP related types */
417 GAMMA_RGB_256_ENTRIES = 256,
418 GAMMA_RGB_FLOAT_1024_ENTRIES = 1024,
419 GAMMA_CS_TFM_1D_ENTRIES = 4096,
420 GAMMA_CUSTOM_ENTRIES = 4096,
421 GAMMA_MAX_ENTRIES = 4096
426 GAMMA_RGB_FLOAT_1024 = 2,
431 struct dc_csc_transform {
433 bool enable_adjustment;
437 struct kref refcount;
438 enum dc_gamma_type type;
439 unsigned int num_entries;
441 struct dc_gamma_entries {
442 struct fixed31_32 red[GAMMA_MAX_ENTRIES];
443 struct fixed31_32 green[GAMMA_MAX_ENTRIES];
444 struct fixed31_32 blue[GAMMA_MAX_ENTRIES];
447 /* private to DC core */
448 struct dc_context *ctx;
453 /* Used by both ipp amd opp functions*/
454 /* TODO: to be consolidated with enum color_space */
457 * This enum is for programming CURSOR_MODE register field. What this register
458 * should be programmed to depends on OS requested cursor shape flags and what
459 * we stored in the cursor surface.
461 enum dc_cursor_color_format {
463 CURSOR_MODE_COLOR_1BIT_AND,
464 CURSOR_MODE_COLOR_PRE_MULTIPLIED_ALPHA,
465 CURSOR_MODE_COLOR_UN_PRE_MULTIPLIED_ALPHA
469 * This is all the parameters required by DAL in order to update the cursor
470 * attributes, including the new cursor image surface address, size, hotspot
471 * location, color format, etc.
474 union dc_cursor_attribute_flags {
476 uint32_t ENABLE_MAGNIFICATION:1;
477 uint32_t INVERSE_TRANSPARENT_CLAMPING:1;
478 uint32_t HORIZONTAL_MIRROR:1;
479 uint32_t VERTICAL_MIRROR:1;
480 uint32_t INVERT_PIXEL_DATA:1;
481 uint32_t ZERO_EXPANSION:1;
482 uint32_t MIN_MAX_INVERT:1;
483 uint32_t RESERVED:25;
488 struct dc_cursor_attributes {
489 PHYSICAL_ADDRESS_LOC address;
492 /* Width and height should correspond to cursor surface width x heigh */
496 enum dc_cursor_color_format color_format;
497 uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
499 /* In case we support HW Cursor rotation in the future */
500 enum dc_rotation_angle rotation_angle;
502 union dc_cursor_attribute_flags attribute_flags;
505 struct dpp_cursor_attributes {
512 enum dc_color_space {
516 COLOR_SPACE_SRGB_LIMITED,
517 COLOR_SPACE_MSREF_SCRGB,
518 COLOR_SPACE_YCBCR601,
519 COLOR_SPACE_YCBCR709,
520 COLOR_SPACE_XV_YCC_709,
521 COLOR_SPACE_XV_YCC_601,
522 COLOR_SPACE_YCBCR601_LIMITED,
523 COLOR_SPACE_YCBCR709_LIMITED,
524 COLOR_SPACE_2020_RGB_FULLRANGE,
525 COLOR_SPACE_2020_RGB_LIMITEDRANGE,
526 COLOR_SPACE_2020_YCBCR,
527 COLOR_SPACE_ADOBERGB,
529 COLOR_SPACE_DISPLAYNATIVE,
530 COLOR_SPACE_DOLBYVISION,
532 COLOR_SPACE_CUSTOMPOINTS,
535 enum dc_dither_option {
536 DITHER_OPTION_DEFAULT,
537 DITHER_OPTION_DISABLE,
541 DITHER_OPTION_SPATIAL6_FRAME_RANDOM,
542 DITHER_OPTION_SPATIAL8_FRAME_RANDOM,
543 DITHER_OPTION_SPATIAL10_FRAME_RANDOM,
544 DITHER_OPTION_SPATIAL6,
545 DITHER_OPTION_SPATIAL8,
546 DITHER_OPTION_SPATIAL10,
549 DITHER_OPTION_TRUN10,
550 DITHER_OPTION_TRUN10_SPATIAL8,
551 DITHER_OPTION_TRUN10_SPATIAL6,
552 DITHER_OPTION_TRUN10_FM8,
553 DITHER_OPTION_TRUN10_FM6,
554 DITHER_OPTION_TRUN10_SPATIAL8_FM6,
555 DITHER_OPTION_SPATIAL10_FM8,
556 DITHER_OPTION_SPATIAL10_FM6,
557 DITHER_OPTION_TRUN8_SPATIAL6,
558 DITHER_OPTION_TRUN8_FM6,
559 DITHER_OPTION_SPATIAL8_FM6,
560 DITHER_OPTION_MAX = DITHER_OPTION_SPATIAL8_FM6,
561 DITHER_OPTION_INVALID
564 enum dc_quantization_range {
565 QUANTIZATION_RANGE_UNKNOWN,
566 QUANTIZATION_RANGE_FULL,
567 QUANTIZATION_RANGE_LIMITED
572 /* used in struct dc_plane_state */
573 struct scaling_taps {
580 enum dc_timing_standard {
581 DC_TIMING_STANDARD_UNDEFINED,
582 DC_TIMING_STANDARD_DMT,
583 DC_TIMING_STANDARD_GTF,
584 DC_TIMING_STANDARD_CVT,
585 DC_TIMING_STANDARD_CVT_RB,
586 DC_TIMING_STANDARD_CEA770,
587 DC_TIMING_STANDARD_CEA861,
588 DC_TIMING_STANDARD_HDMI,
589 DC_TIMING_STANDARD_TV_NTSC,
590 DC_TIMING_STANDARD_TV_NTSC_J,
591 DC_TIMING_STANDARD_TV_PAL,
592 DC_TIMING_STANDARD_TV_PAL_M,
593 DC_TIMING_STANDARD_TV_PAL_CN,
594 DC_TIMING_STANDARD_TV_SECAM,
595 DC_TIMING_STANDARD_EXPLICIT,
596 /*!< For explicit timings from EDID, VBIOS, etc.*/
597 DC_TIMING_STANDARD_USER_OVERRIDE,
598 /*!< For mode timing override by user*/
599 DC_TIMING_STANDARD_MAX
602 enum dc_color_depth {
603 COLOR_DEPTH_UNDEFINED,
613 enum dc_pixel_encoding {
614 PIXEL_ENCODING_UNDEFINED,
616 PIXEL_ENCODING_YCBCR422,
617 PIXEL_ENCODING_YCBCR444,
618 PIXEL_ENCODING_YCBCR420,
622 enum dc_aspect_ratio {
623 ASPECT_RATIO_NO_DATA,
627 ASPECT_RATIO_256_135,
632 SCANNING_TYPE_NODATA = 0,
633 SCANNING_TYPE_OVERSCAN,
634 SCANNING_TYPE_UNDERSCAN,
635 SCANNING_TYPE_FUTURE,
636 SCANNING_TYPE_UNDEFINED
639 struct dc_crtc_timing_flags {
640 uint32_t INTERLACE :1;
641 uint32_t HSYNC_POSITIVE_POLARITY :1; /* when set to 1,
642 it is positive polarity --reversed with dal1 or video bios define*/
643 uint32_t VSYNC_POSITIVE_POLARITY :1; /* when set to 1,
644 it is positive polarity --reversed with dal1 or video bios define*/
646 uint32_t HORZ_COUNT_BY_TWO:1;
648 uint32_t EXCLUSIVE_3D :1; /* if this bit set,
649 timing can be driven in 3D format only
650 and there is no corresponding 2D timing*/
651 uint32_t RIGHT_EYE_3D_POLARITY :1; /* 1 - means right eye polarity
652 (right eye = '1', left eye = '0') */
653 uint32_t SUB_SAMPLE_3D :1; /* 1 - means left/right images subsampled
654 when mixed into 3D image. 0 - means summation (3D timing is doubled)*/
655 uint32_t USE_IN_3D_VIEW_ONLY :1; /* Do not use this timing in 2D View,
656 because corresponding 2D timing also present in the list*/
657 uint32_t STEREO_3D_PREFERENCE :1; /* Means this is 2D timing
658 and we want to match priority of corresponding 3D timing*/
661 uint32_t YCBCR420 :1; /* TODO: shouldn't need this flag, should be a separate pixel format */
662 uint32_t DTD_COUNTER :5; /* values 1 to 16 */
664 uint32_t FORCE_HDR :1;
666 /* HDMI 2.0 - Support scrambling for TMDS character
667 * rates less than or equal to 340Mcsc */
668 uint32_t LTE_340MCSC_SCRAMBLE:1;
672 enum dc_timing_3d_format {
673 TIMING_3D_FORMAT_NONE,
674 TIMING_3D_FORMAT_FRAME_ALTERNATE, /* No stereosync at all*/
675 TIMING_3D_FORMAT_INBAND_FA, /* Inband Frame Alternate (DVI/DP)*/
676 TIMING_3D_FORMAT_DP_HDMI_INBAND_FA, /* Inband FA to HDMI Frame Pack*/
677 /* for active DP-HDMI dongle*/
678 TIMING_3D_FORMAT_SIDEBAND_FA, /* Sideband Frame Alternate (eDP)*/
679 TIMING_3D_FORMAT_HW_FRAME_PACKING,
680 TIMING_3D_FORMAT_SW_FRAME_PACKING,
681 TIMING_3D_FORMAT_ROW_INTERLEAVE,
682 TIMING_3D_FORMAT_COLUMN_INTERLEAVE,
683 TIMING_3D_FORMAT_PIXEL_INTERLEAVE,
684 TIMING_3D_FORMAT_SIDE_BY_SIDE,
685 TIMING_3D_FORMAT_TOP_AND_BOTTOM,
686 TIMING_3D_FORMAT_SBS_SW_PACKED,
687 /* Side-by-side, packed by application/driver into 2D frame*/
688 TIMING_3D_FORMAT_TB_SW_PACKED,
689 /* Top-and-bottom, packed by application/driver into 2D frame*/
691 TIMING_3D_FORMAT_MAX,
695 TRIGGER_DELAY_NEXT_PIXEL = 0,
696 TRIGGER_DELAY_NEXT_LINE,
700 CRTC_EVENT_VSYNC_RISING = 0,
701 CRTC_EVENT_VSYNC_FALLING
704 struct crtc_trigger_info {
706 struct dc_stream_state *event_source;
707 enum crtc_event event;
708 enum trigger_delay delay;
717 struct dc_crtc_timing_adjust {
718 uint32_t v_total_min;
719 uint32_t v_total_max;
722 struct dc_crtc_timing {
724 uint32_t h_border_left;
725 uint32_t h_addressable;
726 uint32_t h_border_right;
727 uint32_t h_front_porch;
728 uint32_t h_sync_width;
731 uint32_t v_border_top;
732 uint32_t v_addressable;
733 uint32_t v_border_bottom;
734 uint32_t v_front_porch;
735 uint32_t v_sync_width;
737 uint32_t pix_clk_khz;
741 enum dc_timing_3d_format timing_3d_format;
742 enum dc_color_depth display_color_depth;
743 enum dc_pixel_encoding pixel_encoding;
744 enum dc_aspect_ratio aspect_ratio;
745 enum scanning_type scan_type;
747 struct dc_crtc_timing_flags flags;
750 #define MAX_TG_COLOR_VALUE 0x3FF
752 /* Maximum 10 bits color value */
758 #endif /* DC_HW_TYPES_H */