1 /*
2  * Copyright 2016 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 __DC_HUBBUB_DCN10_H__
27 #define __DC_HUBBUB_DCN10_H__
28 
29 #include "core_types.h"
30 #include "dchubbub.h"
31 
32 #define TO_DCN10_HUBBUB(hubbub)\
33 	container_of(hubbub, struct dcn10_hubbub, base)
34 
35 #define HUBBUB_REG_LIST_DCN_COMMON()\
36 	SR(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_A),\
37 	SR(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_A),\
38 	SR(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_B),\
39 	SR(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_B),\
40 	SR(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_C),\
41 	SR(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_C),\
42 	SR(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_D),\
43 	SR(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_D),\
44 	SR(DCHUBBUB_ARB_WATERMARK_CHANGE_CNTL),\
45 	SR(DCHUBBUB_ARB_DRAM_STATE_CNTL),\
46 	SR(DCHUBBUB_ARB_SAT_LEVEL),\
47 	SR(DCHUBBUB_ARB_DF_REQ_OUTSTAND),\
48 	SR(DCHUBBUB_GLOBAL_TIMER_CNTL), \
49 	SR(DCHUBBUB_TEST_DEBUG_INDEX), \
50 	SR(DCHUBBUB_TEST_DEBUG_DATA),\
51 	SR(DCHUBBUB_SOFT_RESET)
52 
53 #define HUBBUB_VM_REG_LIST() \
54 	SR(DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_A),\
55 	SR(DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_B),\
56 	SR(DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_C),\
57 	SR(DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_D)
58 
59 #define HUBBUB_SR_WATERMARK_REG_LIST()\
60 	SR(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_A),\
61 	SR(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_A),\
62 	SR(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_B),\
63 	SR(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_B),\
64 	SR(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_C),\
65 	SR(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_C),\
66 	SR(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_D),\
67 	SR(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_D)
68 
69 #define HUBBUB_REG_LIST_DCN10(id)\
70 	HUBBUB_REG_LIST_DCN_COMMON(), \
71 	HUBBUB_VM_REG_LIST(), \
72 	HUBBUB_SR_WATERMARK_REG_LIST(), \
73 	SR(DCHUBBUB_SDPIF_FB_TOP),\
74 	SR(DCHUBBUB_SDPIF_FB_BASE),\
75 	SR(DCHUBBUB_SDPIF_FB_OFFSET),\
76 	SR(DCHUBBUB_SDPIF_AGP_BASE),\
77 	SR(DCHUBBUB_SDPIF_AGP_BOT),\
78 	SR(DCHUBBUB_SDPIF_AGP_TOP)
79 
80 struct dcn_hubbub_registers {
81 	uint32_t DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_A;
82 	uint32_t DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_A;
83 	uint32_t DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_A;
84 	uint32_t DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_A;
85 	uint32_t DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_A;
86 	uint32_t DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_B;
87 	uint32_t DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_B;
88 	uint32_t DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_B;
89 	uint32_t DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_B;
90 	uint32_t DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_B;
91 	uint32_t DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_C;
92 	uint32_t DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_C;
93 	uint32_t DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_C;
94 	uint32_t DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_C;
95 	uint32_t DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_C;
96 	uint32_t DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_D;
97 	uint32_t DCHUBBUB_ARB_PTE_META_URGENCY_WATERMARK_D;
98 	uint32_t DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_D;
99 	uint32_t DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_D;
100 	uint32_t DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_D;
101 	uint32_t DCHUBBUB_ARB_WATERMARK_CHANGE_CNTL;
102 	uint32_t DCHUBBUB_ARB_SAT_LEVEL;
103 	uint32_t DCHUBBUB_ARB_DF_REQ_OUTSTAND;
104 	uint32_t DCHUBBUB_GLOBAL_TIMER_CNTL;
105 	uint32_t DCHUBBUB_ARB_DRAM_STATE_CNTL;
106 	uint32_t DCHUBBUB_TEST_DEBUG_INDEX;
107 	uint32_t DCHUBBUB_TEST_DEBUG_DATA;
108 	uint32_t DCHUBBUB_SDPIF_FB_TOP;
109 	uint32_t DCHUBBUB_SDPIF_FB_BASE;
110 	uint32_t DCHUBBUB_SDPIF_FB_OFFSET;
111 	uint32_t DCHUBBUB_SDPIF_AGP_BASE;
112 	uint32_t DCHUBBUB_SDPIF_AGP_BOT;
113 	uint32_t DCHUBBUB_SDPIF_AGP_TOP;
114 	uint32_t DCHUBBUB_CRC_CTRL;
115 	uint32_t DCHUBBUB_SOFT_RESET;
116 	uint32_t DCN_VM_FB_LOCATION_BASE;
117 	uint32_t DCN_VM_FB_LOCATION_TOP;
118 	uint32_t DCN_VM_FB_OFFSET;
119 	uint32_t DCN_VM_AGP_BOT;
120 	uint32_t DCN_VM_AGP_TOP;
121 	uint32_t DCN_VM_AGP_BASE;
122 };
123 
124 /* set field name */
125 #define HUBBUB_SF(reg_name, field_name, post_fix)\
126 	.field_name = reg_name ## __ ## field_name ## post_fix
127 
128 #define HUBBUB_MASK_SH_LIST_DCN_COMMON(mask_sh)\
129 		HUBBUB_SF(DCHUBBUB_GLOBAL_TIMER_CNTL, DCHUBBUB_GLOBAL_TIMER_ENABLE, mask_sh), \
130 		HUBBUB_SF(DCHUBBUB_SOFT_RESET, DCHUBBUB_GLOBAL_SOFT_RESET, mask_sh), \
131 		HUBBUB_SF(DCHUBBUB_ARB_WATERMARK_CHANGE_CNTL, DCHUBBUB_ARB_WATERMARK_CHANGE_REQUEST, mask_sh), \
132 		HUBBUB_SF(DCHUBBUB_ARB_WATERMARK_CHANGE_CNTL, DCHUBBUB_ARB_WATERMARK_CHANGE_DONE_INTERRUPT_DISABLE, mask_sh), \
133 		HUBBUB_SF(DCHUBBUB_ARB_DRAM_STATE_CNTL, DCHUBBUB_ARB_ALLOW_SELF_REFRESH_FORCE_VALUE, mask_sh), \
134 		HUBBUB_SF(DCHUBBUB_ARB_DRAM_STATE_CNTL, DCHUBBUB_ARB_ALLOW_SELF_REFRESH_FORCE_ENABLE, mask_sh), \
135 		HUBBUB_SF(DCHUBBUB_ARB_DRAM_STATE_CNTL, DCHUBBUB_ARB_ALLOW_PSTATE_CHANGE_FORCE_VALUE, mask_sh), \
136 		HUBBUB_SF(DCHUBBUB_ARB_DRAM_STATE_CNTL, DCHUBBUB_ARB_ALLOW_PSTATE_CHANGE_FORCE_ENABLE, mask_sh), \
137 		HUBBUB_SF(DCHUBBUB_ARB_SAT_LEVEL, DCHUBBUB_ARB_SAT_LEVEL, mask_sh), \
138 		HUBBUB_SF(DCHUBBUB_ARB_DF_REQ_OUTSTAND, DCHUBBUB_ARB_MIN_REQ_OUTSTAND, mask_sh), \
139 		HUBBUB_SF(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_A, DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_A, mask_sh), \
140 		HUBBUB_SF(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_B, DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_B, mask_sh), \
141 		HUBBUB_SF(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_C, DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_C, mask_sh), \
142 		HUBBUB_SF(DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_D, DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_D, mask_sh), \
143 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_A, DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_A, mask_sh), \
144 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_B, DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_B, mask_sh), \
145 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_C, DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_C, mask_sh), \
146 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_D, DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_D, mask_sh)
147 
148 #define HUBBUB_MASK_SH_LIST_STUTTER(mask_sh) \
149 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_A, DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_A, mask_sh), \
150 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_B, DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_B, mask_sh), \
151 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_C, DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_C, mask_sh), \
152 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_D, DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_D, mask_sh), \
153 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_A, DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_A, mask_sh), \
154 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_B, DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_B, mask_sh), \
155 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_C, DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_C, mask_sh), \
156 		HUBBUB_SF(DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_D, DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_D, mask_sh)
157 
158 #define HUBBUB_MASK_SH_LIST_DCN10(mask_sh)\
159 		HUBBUB_MASK_SH_LIST_DCN_COMMON(mask_sh), \
160 		HUBBUB_MASK_SH_LIST_STUTTER(mask_sh), \
161 		HUBBUB_SF(DCHUBBUB_SDPIF_FB_TOP, SDPIF_FB_TOP, mask_sh), \
162 		HUBBUB_SF(DCHUBBUB_SDPIF_FB_BASE, SDPIF_FB_BASE, mask_sh), \
163 		HUBBUB_SF(DCHUBBUB_SDPIF_FB_OFFSET, SDPIF_FB_OFFSET, mask_sh), \
164 		HUBBUB_SF(DCHUBBUB_SDPIF_AGP_BASE, SDPIF_AGP_BASE, mask_sh), \
165 		HUBBUB_SF(DCHUBBUB_SDPIF_AGP_BOT, SDPIF_AGP_BOT, mask_sh), \
166 		HUBBUB_SF(DCHUBBUB_SDPIF_AGP_TOP, SDPIF_AGP_TOP, mask_sh)
167 
168 #define DCN_HUBBUB_REG_FIELD_LIST(type) \
169 		type DCHUBBUB_GLOBAL_TIMER_ENABLE; \
170 		type DCHUBBUB_ARB_WATERMARK_CHANGE_REQUEST;\
171 		type DCHUBBUB_ARB_WATERMARK_CHANGE_DONE_INTERRUPT_DISABLE;\
172 		type DCHUBBUB_ARB_ALLOW_SELF_REFRESH_FORCE_VALUE;\
173 		type DCHUBBUB_ARB_ALLOW_SELF_REFRESH_FORCE_ENABLE;\
174 		type DCHUBBUB_ARB_ALLOW_PSTATE_CHANGE_FORCE_VALUE;\
175 		type DCHUBBUB_ARB_ALLOW_PSTATE_CHANGE_FORCE_ENABLE;\
176 		type DCHUBBUB_ARB_SAT_LEVEL;\
177 		type DCHUBBUB_ARB_MIN_REQ_OUTSTAND;\
178 		type DCHUBBUB_GLOBAL_TIMER_REFDIV;\
179 		type DCHUBBUB_GLOBAL_SOFT_RESET; \
180 		type SDPIF_FB_TOP;\
181 		type SDPIF_FB_BASE;\
182 		type SDPIF_FB_OFFSET;\
183 		type SDPIF_AGP_BASE;\
184 		type SDPIF_AGP_BOT;\
185 		type SDPIF_AGP_TOP;\
186 		type FB_BASE;\
187 		type FB_TOP;\
188 		type FB_OFFSET;\
189 		type AGP_BOT;\
190 		type AGP_TOP;\
191 		type AGP_BASE;\
192 		type DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_A;\
193 		type DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_B;\
194 		type DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_C;\
195 		type DCHUBBUB_ARB_DATA_URGENCY_WATERMARK_D;\
196 		type DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_A;\
197 		type DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_B;\
198 		type DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_C;\
199 		type DCHUBBUB_ARB_ALLOW_DRAM_CLK_CHANGE_WATERMARK_D
200 
201 #define HUBBUB_STUTTER_REG_FIELD_LIST(type) \
202 		type DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_A;\
203 		type DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_B;\
204 		type DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_C;\
205 		type DCHUBBUB_ARB_ALLOW_SR_ENTER_WATERMARK_D;\
206 		type DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_A;\
207 		type DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_B;\
208 		type DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_C;\
209 		type DCHUBBUB_ARB_ALLOW_SR_EXIT_WATERMARK_D
210 
211 
212 struct dcn_hubbub_shift {
213 	DCN_HUBBUB_REG_FIELD_LIST(uint8_t);
214 	HUBBUB_STUTTER_REG_FIELD_LIST(uint8_t);
215 };
216 
217 struct dcn_hubbub_mask {
218 	DCN_HUBBUB_REG_FIELD_LIST(uint32_t);
219 	HUBBUB_STUTTER_REG_FIELD_LIST(uint32_t);
220 };
221 
222 struct dc;
223 
224 struct dcn10_hubbub {
225 	struct hubbub base;
226 	const struct dcn_hubbub_registers *regs;
227 	const struct dcn_hubbub_shift *shifts;
228 	const struct dcn_hubbub_mask *masks;
229 	unsigned int debug_test_index_pstate;
230 	struct dcn_watermark_set watermarks;
231 };
232 
233 void hubbub1_update_dchub(
234 	struct hubbub *hubbub,
235 	struct dchub_init_data *dh_data);
236 
237 bool hubbub1_verify_allow_pstate_change_high(
238 	struct hubbub *hubbub);
239 
240 void hubbub1_wm_change_req_wa(struct hubbub *hubbub);
241 
242 void hubbub1_program_watermarks(
243 		struct hubbub *hubbub,
244 		struct dcn_watermark_set *watermarks,
245 		unsigned int refclk_mhz,
246 		bool safe_to_lower);
247 
248 void hubbub1_allow_self_refresh_control(struct hubbub *hubbub, bool allow);
249 
250 bool hububu1_is_allow_self_refresh_enabled(struct hubbub *hubub);
251 
252 void hubbub1_toggle_watermark_change_req(
253 		struct hubbub *hubbub);
254 
255 void hubbub1_wm_read_state(struct hubbub *hubbub,
256 		struct dcn_hubbub_wm *wm);
257 
258 void hubbub1_soft_reset(struct hubbub *hubbub, bool reset);
259 void hubbub1_construct(struct hubbub *hubbub,
260 	struct dc_context *ctx,
261 	const struct dcn_hubbub_registers *hubbub_regs,
262 	const struct dcn_hubbub_shift *hubbub_shift,
263 	const struct dcn_hubbub_mask *hubbub_mask);
264 
265 void hubbub1_program_urgent_watermarks(
266 		struct hubbub *hubbub,
267 		struct dcn_watermark_set *watermarks,
268 		unsigned int refclk_mhz,
269 		bool safe_to_lower);
270 void hubbub1_program_stutter_watermarks(
271 		struct hubbub *hubbub,
272 		struct dcn_watermark_set *watermarks,
273 		unsigned int refclk_mhz,
274 		bool safe_to_lower);
275 void hubbub1_program_pstate_watermarks(
276 		struct hubbub *hubbub,
277 		struct dcn_watermark_set *watermarks,
278 		unsigned int refclk_mhz,
279 		bool safe_to_lower);
280 
281 #endif
282