GNU Linux-libre 4.19.245-gnu1
[releases.git] / drivers / gpu / drm / amd / display / dc / inc / hw / opp.h
1 /*
2  * Copyright 2012-15 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 __DAL_OPP_H__
27 #define __DAL_OPP_H__
28
29 #include "hw_shared.h"
30 #include "dc_hw_types.h"
31 #include "transform.h"
32 #include "mpc.h"
33
34 struct fixed31_32;
35
36 /* TODO: Need cleanup */
37 enum clamping_range {
38         CLAMPING_FULL_RANGE = 0,           /* No Clamping */
39         CLAMPING_LIMITED_RANGE_8BPC,   /* 8  bpc: Clamping 1  to FE */
40         CLAMPING_LIMITED_RANGE_10BPC, /* 10 bpc: Clamping 4  to 3FB */
41         CLAMPING_LIMITED_RANGE_12BPC, /* 12 bpc: Clamping 10 to FEF */
42         /* Use programmable clampping value on FMT_CLAMP_COMPONENT_R/G/B. */
43         CLAMPING_LIMITED_RANGE_PROGRAMMABLE
44 };
45
46 struct clamping_and_pixel_encoding_params {
47         enum dc_pixel_encoding pixel_encoding; /* Pixel Encoding */
48         enum clamping_range clamping_level; /* Clamping identifier */
49         enum dc_color_depth c_depth; /* Deep color use. */
50 };
51
52 struct bit_depth_reduction_params {
53         struct {
54                 /* truncate/round */
55                 /* trunc/round enabled*/
56                 uint32_t TRUNCATE_ENABLED:1;
57                 /* 2 bits: 0=6 bpc, 1=8 bpc, 2 = 10bpc*/
58                 uint32_t TRUNCATE_DEPTH:2;
59                 /* truncate or round*/
60                 uint32_t TRUNCATE_MODE:1;
61
62                 /* spatial dither */
63                 /* Spatial Bit Depth Reduction enabled*/
64                 uint32_t SPATIAL_DITHER_ENABLED:1;
65                 /* 2 bits: 0=6 bpc, 1 = 8 bpc, 2 = 10bpc*/
66                 uint32_t SPATIAL_DITHER_DEPTH:2;
67                 /* 0-3 to select patterns*/
68                 uint32_t SPATIAL_DITHER_MODE:2;
69                 /* Enable RGB random dithering*/
70                 uint32_t RGB_RANDOM:1;
71                 /* Enable Frame random dithering*/
72                 uint32_t FRAME_RANDOM:1;
73                 /* Enable HighPass random dithering*/
74                 uint32_t HIGHPASS_RANDOM:1;
75
76                 /* temporal dither*/
77                  /* frame modulation enabled*/
78                 uint32_t FRAME_MODULATION_ENABLED:1;
79                 /* same as for trunc/spatial*/
80                 uint32_t FRAME_MODULATION_DEPTH:2;
81                 /* 2/4 gray levels*/
82                 uint32_t TEMPORAL_LEVEL:1;
83                 uint32_t FRC25:2;
84                 uint32_t FRC50:2;
85                 uint32_t FRC75:2;
86         } flags;
87
88         uint32_t r_seed_value;
89         uint32_t b_seed_value;
90         uint32_t g_seed_value;
91         enum dc_pixel_encoding pixel_encoding;
92 };
93
94 enum wide_gamut_regamma_mode {
95         /*  0x0  - BITS2:0 Bypass */
96         WIDE_GAMUT_REGAMMA_MODE_GRAPHICS_BYPASS,
97         /*  0x1  - Fixed curve sRGB 2.4 */
98         WIDE_GAMUT_REGAMMA_MODE_GRAPHICS_SRGB24,
99         /*  0x2  - Fixed curve xvYCC 2.22 */
100         WIDE_GAMUT_REGAMMA_MODE_GRAPHICS_XYYCC22,
101         /*  0x3  - Programmable control A */
102         WIDE_GAMUT_REGAMMA_MODE_GRAPHICS_MATRIX_A,
103         /*  0x4  - Programmable control B */
104         WIDE_GAMUT_REGAMMA_MODE_GRAPHICS_MATRIX_B,
105         /*  0x0  - BITS6:4 Bypass */
106         WIDE_GAMUT_REGAMMA_MODE_OVL_BYPASS,
107         /*  0x1  - Fixed curve sRGB 2.4 */
108         WIDE_GAMUT_REGAMMA_MODE_OVL_SRGB24,
109         /*  0x2  - Fixed curve xvYCC 2.22 */
110         WIDE_GAMUT_REGAMMA_MODE_OVL_XYYCC22,
111         /*  0x3  - Programmable control A */
112         WIDE_GAMUT_REGAMMA_MODE_OVL_MATRIX_A,
113         /*  0x4  - Programmable control B */
114         WIDE_GAMUT_REGAMMA_MODE_OVL_MATRIX_B
115 };
116
117 struct gamma_pixel {
118         struct fixed31_32 r;
119         struct fixed31_32 g;
120         struct fixed31_32 b;
121 };
122
123 enum channel_name {
124         CHANNEL_NAME_RED,
125         CHANNEL_NAME_GREEN,
126         CHANNEL_NAME_BLUE
127 };
128
129 struct custom_float_format {
130         uint32_t mantissa_bits;
131         uint32_t exponenta_bits;
132         bool sign;
133 };
134
135 struct custom_float_value {
136         uint32_t mantissa;
137         uint32_t exponenta;
138         uint32_t value;
139         bool negative;
140 };
141
142 struct hw_x_point {
143         uint32_t custom_float_x;
144         struct fixed31_32 x;
145         struct fixed31_32 regamma_y_red;
146         struct fixed31_32 regamma_y_green;
147         struct fixed31_32 regamma_y_blue;
148
149 };
150
151 struct pwl_float_data_ex {
152         struct fixed31_32 r;
153         struct fixed31_32 g;
154         struct fixed31_32 b;
155         struct fixed31_32 delta_r;
156         struct fixed31_32 delta_g;
157         struct fixed31_32 delta_b;
158 };
159
160 enum hw_point_position {
161         /* hw point sits between left and right sw points */
162         HW_POINT_POSITION_MIDDLE,
163         /* hw point lays left from left (smaller) sw point */
164         HW_POINT_POSITION_LEFT,
165         /* hw point lays stays from right (bigger) sw point */
166         HW_POINT_POSITION_RIGHT
167 };
168
169 struct gamma_point {
170         int32_t left_index;
171         int32_t right_index;
172         enum hw_point_position pos;
173         struct fixed31_32 coeff;
174 };
175
176 struct pixel_gamma_point {
177         struct gamma_point r;
178         struct gamma_point g;
179         struct gamma_point b;
180 };
181
182 struct gamma_coefficients {
183         struct fixed31_32 a0[3];
184         struct fixed31_32 a1[3];
185         struct fixed31_32 a2[3];
186         struct fixed31_32 a3[3];
187         struct fixed31_32 user_gamma[3];
188         struct fixed31_32 user_contrast;
189         struct fixed31_32 user_brightness;
190 };
191
192 struct pwl_float_data {
193         struct fixed31_32 r;
194         struct fixed31_32 g;
195         struct fixed31_32 b;
196 };
197
198 struct mpc_tree_cfg {
199         int num_pipes;
200         int dpp[MAX_PIPES];
201         int mpcc[MAX_PIPES];
202 };
203
204 struct output_pixel_processor {
205         struct dc_context *ctx;
206         uint32_t inst;
207         struct pwl_params regamma_params;
208         struct mpc_tree mpc_tree_params;
209         bool mpcc_disconnect_pending[MAX_PIPES];
210         const struct opp_funcs *funcs;
211 };
212
213 enum fmt_stereo_action {
214         FMT_STEREO_ACTION_ENABLE = 0,
215         FMT_STEREO_ACTION_DISABLE,
216         FMT_STEREO_ACTION_UPDATE_POLARITY
217 };
218
219 struct opp_grph_csc_adjustment {
220         //enum grph_color_adjust_option color_adjust_option;
221         enum dc_color_space c_space;
222         enum dc_color_depth color_depth; /* clean up to uint32_t */
223         enum graphics_csc_adjust_type   csc_adjust_type;
224         int32_t adjust_divider;
225         int32_t grph_cont;
226         int32_t grph_sat;
227         int32_t grph_bright;
228         int32_t grph_hue;
229 };
230
231 /* Underlay related types */
232
233 struct hw_adjustment_range {
234         int32_t hw_default;
235         int32_t min;
236         int32_t max;
237         int32_t step;
238         uint32_t divider; /* (actually HW range is min/divider; divider !=0) */
239 };
240
241 enum ovl_csc_adjust_item {
242         OVERLAY_BRIGHTNESS = 0,
243         OVERLAY_GAMMA,
244         OVERLAY_CONTRAST,
245         OVERLAY_SATURATION,
246         OVERLAY_HUE,
247         OVERLAY_ALPHA,
248         OVERLAY_ALPHA_PER_PIX,
249         OVERLAY_COLOR_TEMPERATURE
250 };
251
252 enum oppbuf_display_segmentation {
253         OPPBUF_DISPLAY_SEGMENTATION_1_SEGMENT = 0,
254         OPPBUF_DISPLAY_SEGMENTATION_2_SEGMENT = 1,
255         OPPBUF_DISPLAY_SEGMENTATION_4_SEGMENT = 2,
256         OPPBUF_DISPLAY_SEGMENTATION_4_SEGMENT_SPLIT_LEFT = 3,
257         OPPBUF_DISPLAY_SEGMENTATION_4_SEGMENT_SPLIT_RIGHT = 4
258 };
259
260 struct oppbuf_params {
261         uint32_t active_width;
262         enum oppbuf_display_segmentation mso_segmentation;
263         uint32_t mso_overlap_pixel_num;
264         uint32_t pixel_repetition;
265 };
266
267 struct opp_funcs {
268
269
270         /* FORMATTER RELATED */
271
272         void (*opp_program_fmt)(
273                         struct output_pixel_processor *opp,
274                         struct bit_depth_reduction_params *fmt_bit_depth,
275                         struct clamping_and_pixel_encoding_params *clamping);
276
277         void (*opp_set_dyn_expansion)(
278                 struct output_pixel_processor *opp,
279                 enum dc_color_space color_sp,
280                 enum dc_color_depth color_dpth,
281                 enum signal_type signal);
282
283         void (*opp_program_bit_depth_reduction)(
284                 struct output_pixel_processor *opp,
285                 const struct bit_depth_reduction_params *params);
286
287         /* underlay related */
288         void (*opp_get_underlay_adjustment_range)(
289                         struct output_pixel_processor *opp,
290                         enum ovl_csc_adjust_item overlay_adjust_item,
291                         struct hw_adjustment_range *range);
292
293         void (*opp_destroy)(struct output_pixel_processor **opp);
294
295         void (*opp_program_stereo)(
296                 struct output_pixel_processor *opp,
297                 bool enable,
298                 const struct dc_crtc_timing *timing);
299
300         void (*opp_pipe_clock_control)(
301                         struct output_pixel_processor *opp,
302                         bool enable);
303
304 };
305
306 #endif