xref: /linux/drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h (revision 2c1ed907520c50326b8f604907a8478b27881a2e)
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_HUBP_H__
27 #define __DAL_HUBP_H__
28 
29 /**
30  * DOC: overview
31  *
32  * Display Controller Hub (DCHUB) is the gateway between the Scalable Data Port
33  * (SDP) and DCN. This component has multiple features, such as memory
34  * arbitration, rotation, and cursor manipulation.
35  *
36  * There is one HUBP allocated per pipe, which fetches data and converts
37  * different pixel formats (i.e. ARGB8888, NV12, etc) into linear, interleaved
38  * and fixed-depth streams of pixel data.
39  */
40 
41 #include "mem_input.h"
42 #include "cursor_reg_cache.h"
43 
44 #include "dml2/dml21/inc/dml_top_dchub_registers.h"
45 #include "dml2/dml21/inc/dml_top_types.h"
46 
47 #define OPP_ID_INVALID 0xf
48 #define MAX_TTU 0xffffff
49 
50 enum cursor_pitch {
51 	CURSOR_PITCH_64_PIXELS = 0,
52 	CURSOR_PITCH_128_PIXELS,
53 	CURSOR_PITCH_256_PIXELS
54 };
55 
56 enum cursor_lines_per_chunk {
57 	CURSOR_LINE_PER_CHUNK_1 = 0, /* new for DCN2 */
58 	CURSOR_LINE_PER_CHUNK_2 = 1,
59 	CURSOR_LINE_PER_CHUNK_4,
60 	CURSOR_LINE_PER_CHUNK_8,
61 	CURSOR_LINE_PER_CHUNK_16
62 };
63 
64 enum hubp_ind_block_size {
65 	hubp_ind_block_unconstrained = 0,
66 	hubp_ind_block_64b,
67 	hubp_ind_block_128b,
68 	hubp_ind_block_64b_no_128bcl,
69 };
70 
71 enum hubp_3dlut_fl_mode {
72 	hubp_3dlut_fl_mode_disable = 0,
73 	hubp_3dlut_fl_mode_native_1 = 1,
74 	hubp_3dlut_fl_mode_native_2 = 2,
75 	hubp_3dlut_fl_mode_transform = 3
76 };
77 
78 enum hubp_3dlut_fl_format {
79 	hubp_3dlut_fl_format_unorm_12msb_bitslice = 0,
80 	hubp_3dlut_fl_format_unorm_12lsb_bitslice = 1,
81 	hubp_3dlut_fl_format_float_fp1_5_10 = 2
82 };
83 
84 enum hubp_3dlut_fl_addressing_mode {
85 	hubp_3dlut_fl_addressing_mode_sw_linear = 0,
86 	hubp_3dlut_fl_addressing_mode_simple_linear = 1
87 };
88 
89 enum hubp_3dlut_fl_width {
90 	hubp_3dlut_fl_width_17 = 17,
91 	hubp_3dlut_fl_width_33 = 33,
92 	hubp_3dlut_fl_width_transformed = 4916
93 };
94 
95 enum hubp_3dlut_fl_crossbar_bit_slice {
96 	hubp_3dlut_fl_crossbar_bit_slice_0_15 = 0,
97 	hubp_3dlut_fl_crossbar_bit_slice_16_31 = 1,
98 	hubp_3dlut_fl_crossbar_bit_slice_32_47 = 2,
99 	hubp_3dlut_fl_crossbar_bit_slice_48_63 = 3
100 };
101 
102 struct hubp {
103 	const struct hubp_funcs *funcs;
104 	struct dc_context *ctx;
105 	struct dc_plane_address request_address;
106 	int inst;
107 
108 	/* run time states */
109 	int opp_id;
110 	int mpcc_id;
111 	struct dc_cursor_attributes curs_attr;
112 	struct dc_cursor_position curs_pos;
113 	bool power_gated;
114 
115 	struct cursor_position_cache_hubp  pos;
116 	struct cursor_attribute_cache_hubp att;
117 	struct cursor_rect cur_rect;
118 };
119 
120 struct surface_flip_registers {
121 	uint32_t DCSURF_SURFACE_CONTROL;
122 	uint32_t DCSURF_PRIMARY_META_SURFACE_ADDRESS_HIGH;
123 	uint32_t DCSURF_PRIMARY_META_SURFACE_ADDRESS;
124 	uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_HIGH;
125 	uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS;
126 	uint32_t DCSURF_PRIMARY_META_SURFACE_ADDRESS_HIGH_C;
127 	uint32_t DCSURF_PRIMARY_META_SURFACE_ADDRESS_C;
128 	uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_HIGH_C;
129 	uint32_t DCSURF_PRIMARY_SURFACE_ADDRESS_C;
130 	uint32_t DCSURF_SECONDARY_META_SURFACE_ADDRESS_HIGH;
131 	uint32_t DCSURF_SECONDARY_META_SURFACE_ADDRESS;
132 	uint32_t DCSURF_SECONDARY_SURFACE_ADDRESS_HIGH;
133 	uint32_t DCSURF_SECONDARY_SURFACE_ADDRESS;
134 	bool tmz_surface;
135 	bool immediate;
136 	uint8_t vmid;
137 	bool grph_stereo;
138 };
139 
140 struct hubp_funcs {
141 	void (*hubp_setup)(
142 			struct hubp *hubp,
143 			struct _vcs_dpi_display_dlg_regs_st *dlg_regs,
144 			struct _vcs_dpi_display_ttu_regs_st *ttu_regs,
145 			struct _vcs_dpi_display_rq_regs_st *rq_regs,
146 			struct _vcs_dpi_display_pipe_dest_params_st *pipe_dest);
147 
148 	void (*hubp_setup2)(
149 		struct hubp *hubp,
150 		struct dml2_dchub_per_pipe_register_set *pipe_regs,
151 		union dml2_global_sync_programming *pipe_global_sync,
152 		struct dc_crtc_timing *timing);
153 
154 	void (*hubp_setup_interdependent)(
155 			struct hubp *hubp,
156 			struct _vcs_dpi_display_dlg_regs_st *dlg_regs,
157 			struct _vcs_dpi_display_ttu_regs_st *ttu_regs);
158 
159 	void (*hubp_setup_interdependent2)(
160 		struct hubp *hubp,
161 		struct dml2_dchub_per_pipe_register_set *pipe_regs);
162 
163 	void (*dcc_control)(struct hubp *hubp, bool enable,
164 			enum hubp_ind_block_size blk_size);
165 
166 	void (*hubp_reset)(struct hubp *hubp);
167 
168 	void (*mem_program_viewport)(
169 			struct hubp *hubp,
170 			const struct rect *viewport,
171 			const struct rect *viewport_c);
172 
173 	bool (*hubp_program_surface_flip_and_addr)(
174 		struct hubp *hubp,
175 		const struct dc_plane_address *address,
176 		bool flip_immediate);
177 
178 	void (*hubp_program_pte_vm)(
179 		struct hubp *hubp,
180 		enum surface_pixel_format format,
181 		struct dc_tiling_info *tiling_info,
182 		enum dc_rotation_angle rotation);
183 
184 	void (*hubp_set_vm_system_aperture_settings)(
185 			struct hubp *hubp,
186 			struct vm_system_aperture_param *apt);
187 
188 	void (*hubp_set_vm_context0_settings)(
189 			struct hubp *hubp,
190 			const struct vm_context0_param *vm0);
191 
192 	void (*hubp_program_surface_config)(
193 		struct hubp *hubp,
194 		enum surface_pixel_format format,
195 		struct dc_tiling_info *tiling_info,
196 		struct plane_size *plane_size,
197 		enum dc_rotation_angle rotation,
198 		struct dc_plane_dcc_param *dcc,
199 		bool horizontal_mirror,
200 		unsigned int compa_level);
201 
202 	bool (*hubp_is_flip_pending)(struct hubp *hubp);
203 
204 	void (*set_blank)(struct hubp *hubp, bool blank);
205 	void (*set_blank_regs)(struct hubp *hubp, bool blank);
206 	void (*phantom_hubp_post_enable)(struct hubp *hubp);
207 	void (*set_hubp_blank_en)(struct hubp *hubp, bool blank);
208 
209 	void (*set_cursor_attributes)(
210 			struct hubp *hubp,
211 			const struct dc_cursor_attributes *attr);
212 
213 	void (*set_cursor_position)(
214 			struct hubp *hubp,
215 			const struct dc_cursor_position *pos,
216 			const struct dc_cursor_mi_param *param);
217 
218 	void (*hubp_disconnect)(struct hubp *hubp);
219 
220 	void (*hubp_clk_cntl)(struct hubp *hubp, bool enable);
221 	void (*hubp_vtg_sel)(struct hubp *hubp, uint32_t otg_inst);
222 	void (*hubp_read_state)(struct hubp *hubp);
223 	void (*hubp_clear_underflow)(struct hubp *hubp);
224 	void (*hubp_disable_control)(struct hubp *hubp, bool disable_hubp);
225 	unsigned int (*hubp_get_underflow_status)(struct hubp *hubp);
226 	void (*hubp_init)(struct hubp *hubp);
227 
228 	void (*dmdata_set_attributes)(
229 			struct hubp *hubp,
230 			const struct dc_dmdata_attributes *attr);
231 
232 	void (*dmdata_load)(
233 			struct hubp *hubp,
234 			uint32_t dmdata_sw_size,
235 			const uint32_t *dmdata_sw_data);
236 	bool (*dmdata_status_done)(struct hubp *hubp);
237 	void (*hubp_enable_tripleBuffer)(
238 		struct hubp *hubp,
239 		bool enable);
240 
241 	bool (*hubp_is_triplebuffer_enabled)(
242 		struct hubp *hubp);
243 
244 	void (*hubp_set_flip_control_surface_gsl)(
245 		struct hubp *hubp,
246 		bool enable);
247 
248 	void (*validate_dml_output)(
249 			struct hubp *hubp,
250 			struct dc_context *ctx,
251 			struct _vcs_dpi_display_rq_regs_st *dml_rq_regs,
252 			struct _vcs_dpi_display_dlg_regs_st *dml_dlg_attr,
253 			struct _vcs_dpi_display_ttu_regs_st *dml_ttu_attr);
254 	void (*set_unbounded_requesting)(
255 		struct hubp *hubp,
256 		bool enable);
257 	bool (*hubp_in_blank)(struct hubp *hubp);
258 	void (*hubp_soft_reset)(struct hubp *hubp, bool reset);
259 
260 	void (*hubp_set_flip_int)(struct hubp *hubp);
261 
262 	void (*hubp_update_force_pstate_disallow)(struct hubp *hubp, bool allow);
263 	void (*hubp_update_force_cursor_pstate_disallow)(struct hubp *hubp, bool allow);
264 	void (*hubp_update_mall_sel)(struct hubp *hubp, uint32_t mall_sel, bool c_cursor);
265 	void (*hubp_prepare_subvp_buffering)(struct hubp *hubp, bool enable);
266 	void (*hubp_surface_update_lock)(struct hubp *hubp,
267 			bool lock);
268 
269 	void (*program_extended_blank)(struct hubp *hubp,
270 			unsigned int min_dst_y_next_start_optimized);
271 
272 	void (*hubp_wait_pipe_read_start)(struct hubp *hubp);
273 	void (*hubp_program_mcache_id_and_split_coordinate)(struct hubp *hubp, struct dml2_hubp_pipe_mcache_regs *mcache_regs);
274 	void (*hubp_update_3dlut_fl_bias_scale)(struct hubp *hubp, uint16_t bias, uint16_t scale);
275 	void (*hubp_program_3dlut_fl_mode)(struct hubp *hubp,
276 			enum hubp_3dlut_fl_mode mode);
277 	void (*hubp_program_3dlut_fl_format)(struct hubp *hubp,
278 			enum hubp_3dlut_fl_format format);
279 	void (*hubp_program_3dlut_fl_addr)(struct hubp *hubp,
280 		const struct dc_plane_address address);
281 	void (*hubp_program_3dlut_fl_dlg_param)(struct hubp *hubp, int refcyc_per_3dlut_group);
282 	void (*hubp_enable_3dlut_fl)(struct hubp *hubp, bool enable);
283 	void (*hubp_program_3dlut_fl_addressing_mode)(struct hubp *hubp, enum hubp_3dlut_fl_addressing_mode addr_mode);
284 	void (*hubp_program_3dlut_fl_width)(struct hubp *hubp, enum hubp_3dlut_fl_width width);
285 	void (*hubp_program_3dlut_fl_tmz_protected)(struct hubp *hubp, bool protection_enabled);
286 	void (*hubp_program_3dlut_fl_crossbar)(struct hubp *hubp,
287 			enum hubp_3dlut_fl_crossbar_bit_slice bit_slice_y_g,
288 			enum hubp_3dlut_fl_crossbar_bit_slice bit_slice_cb_b,
289 			enum hubp_3dlut_fl_crossbar_bit_slice bit_slice_cr_r);
290 	int (*hubp_get_3dlut_fl_done)(struct hubp *hubp);
291 	void (*hubp_clear_tiling)(struct hubp *hubp);
292 };
293 
294 #endif
295