1 /*
2  * Copyright 2018 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 __DCN20_DCCG_H__
27 #define __DCN20_DCCG_H__
28 
29 #include "dccg.h"
30 
31 #define DCCG_COMMON_REG_LIST_DCN_BASE() \
32 	SR(DPPCLK_DTO_CTRL),\
33 	DCCG_SRII(DTO_PARAM, DPPCLK, 0),\
34 	DCCG_SRII(DTO_PARAM, DPPCLK, 1),\
35 	DCCG_SRII(DTO_PARAM, DPPCLK, 2),\
36 	DCCG_SRII(DTO_PARAM, DPPCLK, 3),\
37 	SR(REFCLK_CNTL),\
38 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 0),\
39 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 1),\
40 	SR(DISPCLK_FREQ_CHANGE_CNTL)
41 
42 #define DCCG_REG_LIST_DCN2() \
43 	DCCG_COMMON_REG_LIST_DCN_BASE(),\
44 	DCCG_SRII(DTO_PARAM, DPPCLK, 4),\
45 	DCCG_SRII(DTO_PARAM, DPPCLK, 5),\
46 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 2),\
47 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 3),\
48 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 4),\
49 	DCCG_SRII(PIXEL_RATE_CNTL, OTG, 5)
50 
51 #define DCCG_SF(reg_name, field_name, post_fix)\
52 	.field_name = reg_name ## __ ## field_name ## post_fix
53 
54 #define DCCG_SFI(reg_name, field_name, field_prefix, inst, post_fix)\
55 	.field_prefix ## _ ## field_name[inst] = reg_name ## __ ## field_prefix ## inst ## _ ## field_name ## post_fix
56 
57 #define DCCG_SFII(block, reg_name, field_prefix, field_name, inst, post_fix)\
58 	.field_prefix ## _ ## field_name[inst] = block ## inst ## _ ## reg_name ## __ ## field_prefix ## inst ## _ ## field_name ## post_fix
59 
60 #define DCCG_COMMON_MASK_SH_LIST_DCN_COMMON_BASE(mask_sh) \
61 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 0, mask_sh),\
62 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 0, mask_sh),\
63 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 1, mask_sh),\
64 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 1, mask_sh),\
65 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 2, mask_sh),\
66 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 2, mask_sh),\
67 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 3, mask_sh),\
68 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 3, mask_sh),\
69 	DCCG_SF(DPPCLK0_DTO_PARAM, DPPCLK0_DTO_PHASE, mask_sh),\
70 	DCCG_SF(DPPCLK0_DTO_PARAM, DPPCLK0_DTO_MODULO, mask_sh),\
71 	DCCG_SF(REFCLK_CNTL, REFCLK_CLOCK_EN, mask_sh),\
72 	DCCG_SF(REFCLK_CNTL, REFCLK_SRC_SEL, mask_sh),\
73 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DISPCLK_STEP_DELAY, mask_sh),\
74 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DISPCLK_STEP_SIZE, mask_sh),\
75 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DISPCLK_FREQ_RAMP_DONE, mask_sh),\
76 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DISPCLK_MAX_ERRDET_CYCLES, mask_sh),\
77 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DCCG_FIFO_ERRDET_RESET, mask_sh),\
78 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DCCG_FIFO_ERRDET_STATE, mask_sh),\
79 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DCCG_FIFO_ERRDET_OVR_EN, mask_sh),\
80 	DCCG_SF(DISPCLK_FREQ_CHANGE_CNTL, DISPCLK_CHG_FWD_CORR_DISABLE, mask_sh),\
81 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 0, mask_sh),\
82 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 1, mask_sh),\
83 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 0, mask_sh),\
84 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 1, mask_sh)
85 
86 
87 
88 
89 #define DCCG_MASK_SH_LIST_DCN2(mask_sh) \
90 	DCCG_COMMON_MASK_SH_LIST_DCN_COMMON_BASE(mask_sh),\
91 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 4, mask_sh),\
92 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 4, mask_sh),\
93 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 5, mask_sh),\
94 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 5, mask_sh),\
95 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 2, mask_sh),\
96 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 3, mask_sh),\
97 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 4, mask_sh),\
98 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 5, mask_sh),\
99 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 2, mask_sh),\
100 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 3, mask_sh),\
101 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 4, mask_sh),\
102 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 5, mask_sh)
103 
104 #define DCCG_MASK_SH_LIST_DCN2_1(mask_sh) \
105 	DCCG_COMMON_MASK_SH_LIST_DCN_COMMON_BASE(mask_sh),\
106 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 4, mask_sh),\
107 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 4, mask_sh),\
108 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_ENABLE, DPPCLK, 5, mask_sh),\
109 	DCCG_SFI(DPPCLK_DTO_CTRL, DTO_DB_EN, DPPCLK, 5, mask_sh),\
110 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 2, mask_sh),\
111 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, ADD_PIXEL, 3, mask_sh),\
112 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 2, mask_sh),\
113 	DCCG_SFII(OTG, PIXEL_RATE_CNTL, OTG, DROP_PIXEL, 3, mask_sh)
114 
115 
116 #define DCCG_REG_FIELD_LIST(type) \
117 	type DPPCLK0_DTO_PHASE;\
118 	type DPPCLK0_DTO_MODULO;\
119 	type DPPCLK_DTO_ENABLE[6];\
120 	type DPPCLK_DTO_DB_EN[6];\
121 	type REFCLK_CLOCK_EN;\
122 	type REFCLK_SRC_SEL;\
123 	type DISPCLK_STEP_DELAY;\
124 	type DISPCLK_STEP_SIZE;\
125 	type DISPCLK_FREQ_RAMP_DONE;\
126 	type DISPCLK_MAX_ERRDET_CYCLES;\
127 	type DCCG_FIFO_ERRDET_RESET;\
128 	type DCCG_FIFO_ERRDET_STATE;\
129 	type DCCG_FIFO_ERRDET_OVR_EN;\
130 	type DISPCLK_CHG_FWD_CORR_DISABLE;\
131 	type DISPCLK_FREQ_CHANGE_CNTL;\
132 	type OTG_ADD_PIXEL[MAX_PIPES];\
133 	type OTG_DROP_PIXEL[MAX_PIPES];
134 
135 #define DCCG3_REG_FIELD_LIST(type) \
136 	type HDMICHARCLK0_EN;\
137 	type HDMICHARCLK0_SRC_SEL;\
138 	type PHYASYMCLK_FORCE_EN;\
139 	type PHYASYMCLK_FORCE_SRC_SEL;\
140 	type PHYBSYMCLK_FORCE_EN;\
141 	type PHYBSYMCLK_FORCE_SRC_SEL;\
142 	type PHYCSYMCLK_FORCE_EN;\
143 	type PHYCSYMCLK_FORCE_SRC_SEL;
144 
145 #define DCCG31_REG_FIELD_LIST(type) \
146 	type PHYDSYMCLK_FORCE_EN;\
147 	type PHYDSYMCLK_FORCE_SRC_SEL;\
148 	type PHYESYMCLK_FORCE_EN;\
149 	type PHYESYMCLK_FORCE_SRC_SEL;\
150 	type DPSTREAMCLK_PIPE0_EN;\
151 	type DPSTREAMCLK_PIPE1_EN;\
152 	type DPSTREAMCLK_PIPE2_EN;\
153 	type DPSTREAMCLK_PIPE3_EN;\
154 	type HDMISTREAMCLK0_SRC_SEL;\
155 	type HDMISTREAMCLK0_DTO_FORCE_DIS;\
156 	type SYMCLK32_SE0_SRC_SEL;\
157 	type SYMCLK32_SE1_SRC_SEL;\
158 	type SYMCLK32_SE2_SRC_SEL;\
159 	type SYMCLK32_SE3_SRC_SEL;\
160 	type SYMCLK32_SE0_EN;\
161 	type SYMCLK32_SE1_EN;\
162 	type SYMCLK32_SE2_EN;\
163 	type SYMCLK32_SE3_EN;\
164 	type SYMCLK32_LE0_SRC_SEL;\
165 	type SYMCLK32_LE1_SRC_SEL;\
166 	type SYMCLK32_LE0_EN;\
167 	type SYMCLK32_LE1_EN;\
168 	type DTBCLK_DTO_ENABLE[MAX_PIPES];\
169 	type DTBCLKDTO_ENABLE_STATUS[MAX_PIPES];\
170 	type PIPE_DTO_SRC_SEL[MAX_PIPES];\
171 	type DTBCLK_DTO_DIV[MAX_PIPES];\
172 	type DCCG_AUDIO_DTO_SEL;\
173 	type DCCG_AUDIO_DTO0_SOURCE_SEL;\
174 	type DENTIST_DISPCLK_CHG_MODE;\
175 	type DSCCLK0_DTO_PHASE;\
176 	type DSCCLK0_DTO_MODULO;\
177 	type DSCCLK1_DTO_PHASE;\
178 	type DSCCLK1_DTO_MODULO;\
179 	type DSCCLK2_DTO_PHASE;\
180 	type DSCCLK2_DTO_MODULO;\
181 	type DSCCLK0_DTO_ENABLE;\
182 	type DSCCLK1_DTO_ENABLE;\
183 	type DSCCLK2_DTO_ENABLE;\
184 	type SYMCLK32_ROOT_SE0_GATE_DISABLE;\
185 	type SYMCLK32_ROOT_SE1_GATE_DISABLE;\
186 	type SYMCLK32_ROOT_SE2_GATE_DISABLE;\
187 	type SYMCLK32_ROOT_SE3_GATE_DISABLE;\
188 	type SYMCLK32_SE0_GATE_DISABLE;\
189 	type SYMCLK32_SE1_GATE_DISABLE;\
190 	type SYMCLK32_SE2_GATE_DISABLE;\
191 	type SYMCLK32_SE3_GATE_DISABLE;\
192 	type SYMCLK32_ROOT_LE0_GATE_DISABLE;\
193 	type SYMCLK32_ROOT_LE1_GATE_DISABLE;\
194 	type SYMCLK32_LE0_GATE_DISABLE;\
195 	type SYMCLK32_LE1_GATE_DISABLE;\
196 	type DPSTREAMCLK_ROOT_GATE_DISABLE;\
197 	type DPSTREAMCLK_GATE_DISABLE;\
198 	type HDMISTREAMCLK0_DTO_PHASE;\
199 	type HDMISTREAMCLK0_DTO_MODULO;\
200 	type HDMICHARCLK0_GATE_DISABLE;\
201 	type HDMICHARCLK0_ROOT_GATE_DISABLE; \
202 	type PHYASYMCLK_GATE_DISABLE; \
203 	type PHYBSYMCLK_GATE_DISABLE; \
204 	type PHYCSYMCLK_GATE_DISABLE; \
205 	type PHYDSYMCLK_GATE_DISABLE; \
206 	type PHYESYMCLK_GATE_DISABLE;
207 
208 #define DCCG314_REG_FIELD_LIST(type) \
209 	type DSCCLK3_DTO_PHASE;\
210 	type DSCCLK3_DTO_MODULO;\
211 	type DSCCLK3_DTO_ENABLE;
212 
213 #define DCCG32_REG_FIELD_LIST(type) \
214 	type DPSTREAMCLK0_EN;\
215 	type DPSTREAMCLK1_EN;\
216 	type DPSTREAMCLK2_EN;\
217 	type DPSTREAMCLK3_EN;\
218 	type DPSTREAMCLK0_SRC_SEL;\
219 	type DPSTREAMCLK1_SRC_SEL;\
220 	type DPSTREAMCLK2_SRC_SEL;\
221 	type DPSTREAMCLK3_SRC_SEL;\
222 	type HDMISTREAMCLK0_EN;\
223 	type OTG0_PIXEL_RATE_DIVK1;\
224 	type OTG0_PIXEL_RATE_DIVK2;\
225 	type OTG1_PIXEL_RATE_DIVK1;\
226 	type OTG1_PIXEL_RATE_DIVK2;\
227 	type OTG2_PIXEL_RATE_DIVK1;\
228 	type OTG2_PIXEL_RATE_DIVK2;\
229 	type OTG3_PIXEL_RATE_DIVK1;\
230 	type OTG3_PIXEL_RATE_DIVK2;\
231 	type DTBCLK_P0_SRC_SEL;\
232 	type DTBCLK_P0_EN;\
233 	type DTBCLK_P1_SRC_SEL;\
234 	type DTBCLK_P1_EN;\
235 	type DTBCLK_P2_SRC_SEL;\
236 	type DTBCLK_P2_EN;\
237 	type DTBCLK_P3_SRC_SEL;\
238 	type DTBCLK_P3_EN;\
239 	type DENTIST_DISPCLK_CHG_DONE;
240 
241 struct dccg_shift {
242 	DCCG_REG_FIELD_LIST(uint8_t)
243 	DCCG3_REG_FIELD_LIST(uint8_t)
244 	DCCG31_REG_FIELD_LIST(uint8_t)
245 	DCCG314_REG_FIELD_LIST(uint8_t)
246 	DCCG32_REG_FIELD_LIST(uint8_t)
247 };
248 
249 struct dccg_mask {
250 	DCCG_REG_FIELD_LIST(uint32_t)
251 	DCCG3_REG_FIELD_LIST(uint32_t)
252 	DCCG31_REG_FIELD_LIST(uint32_t)
253 	DCCG314_REG_FIELD_LIST(uint32_t)
254 	DCCG32_REG_FIELD_LIST(uint32_t)
255 };
256 
257 struct dccg_registers {
258 	uint32_t DPPCLK_DTO_CTRL;
259 	uint32_t DPPCLK_DTO_PARAM[6];
260 	uint32_t REFCLK_CNTL;
261 	uint32_t DISPCLK_FREQ_CHANGE_CNTL;
262 	uint32_t OTG_PIXEL_RATE_CNTL[MAX_PIPES];
263 	uint32_t HDMICHARCLK_CLOCK_CNTL[6];
264 	uint32_t PHYASYMCLK_CLOCK_CNTL;
265 	uint32_t PHYBSYMCLK_CLOCK_CNTL;
266 	uint32_t PHYCSYMCLK_CLOCK_CNTL;
267 	uint32_t PHYDSYMCLK_CLOCK_CNTL;
268 	uint32_t PHYESYMCLK_CLOCK_CNTL;
269 	uint32_t DTBCLK_DTO_MODULO[MAX_PIPES];
270 	uint32_t DTBCLK_DTO_PHASE[MAX_PIPES];
271 	uint32_t DCCG_AUDIO_DTBCLK_DTO_MODULO;
272 	uint32_t DCCG_AUDIO_DTBCLK_DTO_PHASE;
273 	uint32_t DCCG_AUDIO_DTO_SOURCE;
274 	uint32_t DPSTREAMCLK_CNTL;
275 	uint32_t HDMISTREAMCLK_CNTL;
276 	uint32_t SYMCLK32_SE_CNTL;
277 	uint32_t SYMCLK32_LE_CNTL;
278 	uint32_t DENTIST_DISPCLK_CNTL;
279 	uint32_t DSCCLK_DTO_CTRL;
280 	uint32_t DSCCLK0_DTO_PARAM;
281 	uint32_t DSCCLK1_DTO_PARAM;
282 	uint32_t DSCCLK2_DTO_PARAM;
283 	uint32_t DSCCLK3_DTO_PARAM;
284 	uint32_t DPSTREAMCLK_ROOT_GATE_DISABLE;
285 	uint32_t DPSTREAMCLK_GATE_DISABLE;
286 	uint32_t DCCG_GATE_DISABLE_CNTL;
287 	uint32_t DCCG_GATE_DISABLE_CNTL2;
288 	uint32_t DCCG_GATE_DISABLE_CNTL3;
289 	uint32_t HDMISTREAMCLK0_DTO_PARAM;
290 	uint32_t DCCG_GATE_DISABLE_CNTL4;
291 	uint32_t OTG_PIXEL_RATE_DIV;
292 	uint32_t DTBCLK_P_CNTL;
293 };
294 
295 struct dcn_dccg {
296 	struct dccg base;
297 	const struct dccg_registers *regs;
298 	const struct dccg_shift *dccg_shift;
299 	const struct dccg_mask *dccg_mask;
300 };
301 
302 void dccg2_update_dpp_dto(struct dccg *dccg, int dpp_inst, int req_dppclk);
303 
304 void dccg2_get_dccg_ref_freq(struct dccg *dccg,
305 		unsigned int xtalin_freq_inKhz,
306 		unsigned int *dccg_ref_freq_inKhz);
307 
308 void dccg2_set_fifo_errdet_ovr_en(struct dccg *dccg,
309 		bool en);
310 void dccg2_otg_add_pixel(struct dccg *dccg,
311 		uint32_t otg_inst);
312 void dccg2_otg_drop_pixel(struct dccg *dccg,
313 		uint32_t otg_inst);
314 
315 
316 void dccg2_init(struct dccg *dccg);
317 
318 struct dccg *dccg2_create(
319 	struct dc_context *ctx,
320 	const struct dccg_registers *regs,
321 	const struct dccg_shift *dccg_shift,
322 	const struct dccg_mask *dccg_mask);
323 
324 void dcn_dccg_destroy(struct dccg **dccg);
325 
326 #endif //__DCN20_DCCG_H__
327