xref: /linux/drivers/gpu/drm/amd/display/dc/dsc/dsc.h (revision face6a3615a649456eb4549f6d474221d877d604)
1 /*
2  * Copyright 2017 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 #ifndef __DAL_DSC_H__
26 #define __DAL_DSC_H__
27 
28 #include "dc_dsc.h"
29 #include "dc_hw_types.h"
30 #include "dc_types.h"
31 /* do not include any other headers
32  * or else it might break Edid Utility functionality.
33  */
34 
35 
36 /* Input parameters for configuring DSC from the outside of DSC */
37 struct dsc_config {
38 	uint32_t pic_width;
39 	uint32_t pic_height;
40 	enum dc_pixel_encoding pixel_encoding;
41 	enum dc_color_depth color_depth;  /* Bits per component */
42 	bool is_odm;
43 	struct dc_dsc_config dc_dsc_cfg;
44 	uint32_t dsc_padding;
45 };
46 
47 
48 /* Output parameters for configuring DSC-related part of OPTC */
49 struct dsc_optc_config {
50 	uint32_t slice_width; /* Slice width in pixels */
51 	uint32_t bytes_per_pixel; /* Bytes per pixel in u3.28 format */
52 	bool is_pixel_format_444; /* 'true' if pixel format is 'RGB 444' or 'Simple YCbCr 4:2:2' (4:2:2 upsampled to 4:4:4)' */
53 };
54 
55 
56 struct dcn_dsc_state {
57 	uint32_t dsc_clock_en;
58 	uint32_t dsc_slice_width;
59 	uint32_t dsc_bits_per_pixel;
60 	uint32_t dsc_slice_height;
61 	uint32_t dsc_pic_width;
62 	uint32_t dsc_pic_height;
63 	uint32_t dsc_slice_bpg_offset;
64 	uint32_t dsc_chunk_size;
65 	uint32_t dsc_fw_en;
66 	uint32_t dsc_opp_source;
67 };
68 
69 struct dcn_dsc_reg_state {
70 	uint32_t dsc_top_control;
71 	uint32_t dscc_interrupt_control_status;
72 };
73 
74 /* DSC encoder capabilities
75  * They differ from the DPCD DSC caps because they are based on AMD DSC encoder caps.
76  */
77 union dsc_enc_slice_caps {
78 	struct {
79 		uint8_t NUM_SLICES_1 : 1;
80 		uint8_t NUM_SLICES_2 : 1;
81 		uint8_t NUM_SLICES_3 : 1; /* This one is not per DSC spec, but our encoder supports it */
82 		uint8_t NUM_SLICES_4 : 1;
83 		uint8_t NUM_SLICES_8 : 1;
84 		uint8_t NUM_SLICES_12 : 1;
85 		uint8_t NUM_SLICES_16 : 1;
86 	} bits;
87 	uint8_t raw;
88 };
89 
90 struct dsc_enc_caps {
91 	uint8_t dsc_version;
92 	union dsc_enc_slice_caps slice_caps;
93 	int32_t lb_bit_depth;
94 	bool is_block_pred_supported;
95 	union dsc_color_formats color_formats;
96 	union dsc_color_depth color_depth;
97 	int32_t max_total_throughput_mps; /* Maximum total throughput with all the slices combined */
98 	int32_t max_slice_width;
99 	uint32_t bpp_increment_div; /* bpp increment divisor, e.g. if 16, it's 1/16th of a bit */
100 	uint32_t edp_sink_max_bits_per_pixel;
101 	bool is_dp;
102 };
103 
104 struct dsc_funcs {
105 	void (*dsc_get_enc_caps)(struct dsc_enc_caps *dsc_enc_caps, int pixel_clock_100Hz);
106 	void (*dsc_read_state)(struct display_stream_compressor *dsc, struct dcn_dsc_state *s);
107 	void (*dsc_read_reg_state)(struct display_stream_compressor *dsc, struct dcn_dsc_reg_state *dccg_reg_state);
108 	bool (*dsc_validate_stream)(struct display_stream_compressor *dsc, const struct dsc_config *dsc_cfg);
109 	void (*dsc_set_config)(struct display_stream_compressor *dsc, const struct dsc_config *dsc_cfg,
110 			struct dsc_optc_config *dsc_optc_cfg);
111 	bool (*dsc_get_packed_pps)(struct display_stream_compressor *dsc, const struct dsc_config *dsc_cfg,
112 			uint8_t *dsc_packed_pps);
113 	void (*dsc_enable)(struct display_stream_compressor *dsc, int opp_pipe);
114 	void (*dsc_disable)(struct display_stream_compressor *dsc);
115 	void (*dsc_disconnect)(struct display_stream_compressor *dsc);
116 	void (*dsc_wait_disconnect_pending_clear)(struct display_stream_compressor *dsc);
117 	void (*dsc_get_single_enc_caps)(struct dsc_enc_caps *dsc_enc_caps, unsigned int max_dscclk_khz);
118 };
119 
120 #endif
121