1/*
2 * Copyright 2014 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 */
23
24#ifndef __AMDGPU_RLC_H__
25#define __AMDGPU_RLC_H__
26
27#include "clearstate_defs.h"
28
29#define AMDGPU_MAX_RLC_INSTANCES 8
30
31/* firmware ID used in rlc toc */
32typedef enum _FIRMWARE_ID_ {
33 FIRMWARE_ID_INVALID = 0,
34 FIRMWARE_ID_RLC_G_UCODE = 1,
35 FIRMWARE_ID_RLC_TOC = 2,
36 FIRMWARE_ID_RLCG_SCRATCH = 3,
37 FIRMWARE_ID_RLC_SRM_ARAM = 4,
38 FIRMWARE_ID_RLC_SRM_INDEX_ADDR = 5,
39 FIRMWARE_ID_RLC_SRM_INDEX_DATA = 6,
40 FIRMWARE_ID_RLC_P_UCODE = 7,
41 FIRMWARE_ID_RLC_V_UCODE = 8,
42 FIRMWARE_ID_RLX6_UCODE = 9,
43 FIRMWARE_ID_RLX6_DRAM_BOOT = 10,
44 FIRMWARE_ID_GLOBAL_TAP_DELAYS = 11,
45 FIRMWARE_ID_SE0_TAP_DELAYS = 12,
46 FIRMWARE_ID_SE1_TAP_DELAYS = 13,
47 FIRMWARE_ID_GLOBAL_SE0_SE1_SKEW_DELAYS = 14,
48 FIRMWARE_ID_SDMA0_UCODE = 15,
49 FIRMWARE_ID_SDMA0_JT = 16,
50 FIRMWARE_ID_SDMA1_UCODE = 17,
51 FIRMWARE_ID_SDMA1_JT = 18,
52 FIRMWARE_ID_CP_CE = 19,
53 FIRMWARE_ID_CP_PFP = 20,
54 FIRMWARE_ID_CP_ME = 21,
55 FIRMWARE_ID_CP_MEC = 22,
56 FIRMWARE_ID_CP_MES = 23,
57 FIRMWARE_ID_MES_STACK = 24,
58 FIRMWARE_ID_RLC_SRM_DRAM_SR = 25,
59 FIRMWARE_ID_RLCG_SCRATCH_SR = 26,
60 FIRMWARE_ID_RLCP_SCRATCH_SR = 27,
61 FIRMWARE_ID_RLCV_SCRATCH_SR = 28,
62 FIRMWARE_ID_RLX6_DRAM_SR = 29,
63 FIRMWARE_ID_SDMA0_PG_CONTEXT = 30,
64 FIRMWARE_ID_SDMA1_PG_CONTEXT = 31,
65 FIRMWARE_ID_GLOBAL_MUX_SELECT_RAM = 32,
66 FIRMWARE_ID_SE0_MUX_SELECT_RAM = 33,
67 FIRMWARE_ID_SE1_MUX_SELECT_RAM = 34,
68 FIRMWARE_ID_ACCUM_CTRL_RAM = 35,
69 FIRMWARE_ID_RLCP_CAM = 36,
70 FIRMWARE_ID_RLC_SPP_CAM_EXT = 37,
71 FIRMWARE_ID_MAX = 38,
72} FIRMWARE_ID;
73
74typedef enum _SOC21_FIRMWARE_ID_ {
75 SOC21_FIRMWARE_ID_INVALID = 0,
76 SOC21_FIRMWARE_ID_RLC_G_UCODE = 1,
77 SOC21_FIRMWARE_ID_RLC_TOC = 2,
78 SOC21_FIRMWARE_ID_RLCG_SCRATCH = 3,
79 SOC21_FIRMWARE_ID_RLC_SRM_ARAM = 4,
80 SOC21_FIRMWARE_ID_RLC_P_UCODE = 5,
81 SOC21_FIRMWARE_ID_RLC_V_UCODE = 6,
82 SOC21_FIRMWARE_ID_RLX6_UCODE = 7,
83 SOC21_FIRMWARE_ID_RLX6_UCODE_CORE1 = 8,
84 SOC21_FIRMWARE_ID_RLX6_DRAM_BOOT = 9,
85 SOC21_FIRMWARE_ID_RLX6_DRAM_BOOT_CORE1 = 10,
86 SOC21_FIRMWARE_ID_SDMA_UCODE_TH0 = 11,
87 SOC21_FIRMWARE_ID_SDMA_UCODE_TH1 = 12,
88 SOC21_FIRMWARE_ID_CP_PFP = 13,
89 SOC21_FIRMWARE_ID_CP_ME = 14,
90 SOC21_FIRMWARE_ID_CP_MEC = 15,
91 SOC21_FIRMWARE_ID_RS64_MES_P0 = 16,
92 SOC21_FIRMWARE_ID_RS64_MES_P1 = 17,
93 SOC21_FIRMWARE_ID_RS64_PFP = 18,
94 SOC21_FIRMWARE_ID_RS64_ME = 19,
95 SOC21_FIRMWARE_ID_RS64_MEC = 20,
96 SOC21_FIRMWARE_ID_RS64_MES_P0_STACK = 21,
97 SOC21_FIRMWARE_ID_RS64_MES_P1_STACK = 22,
98 SOC21_FIRMWARE_ID_RS64_PFP_P0_STACK = 23,
99 SOC21_FIRMWARE_ID_RS64_PFP_P1_STACK = 24,
100 SOC21_FIRMWARE_ID_RS64_ME_P0_STACK = 25,
101 SOC21_FIRMWARE_ID_RS64_ME_P1_STACK = 26,
102 SOC21_FIRMWARE_ID_RS64_MEC_P0_STACK = 27,
103 SOC21_FIRMWARE_ID_RS64_MEC_P1_STACK = 28,
104 SOC21_FIRMWARE_ID_RS64_MEC_P2_STACK = 29,
105 SOC21_FIRMWARE_ID_RS64_MEC_P3_STACK = 30,
106 SOC21_FIRMWARE_ID_RLC_SRM_DRAM_SR = 31,
107 SOC21_FIRMWARE_ID_RLCG_SCRATCH_SR = 32,
108 SOC21_FIRMWARE_ID_RLCP_SCRATCH_SR = 33,
109 SOC21_FIRMWARE_ID_RLCV_SCRATCH_SR = 34,
110 SOC21_FIRMWARE_ID_RLX6_DRAM_SR = 35,
111 SOC21_FIRMWARE_ID_RLX6_DRAM_SR_CORE1 = 36,
112 SOC21_FIRMWARE_ID_MAX = 37
113} SOC21_FIRMWARE_ID;
114
115typedef enum _SOC24_FIRMWARE_ID_ {
116 SOC24_FIRMWARE_ID_INVALID = 0,
117 SOC24_FIRMWARE_ID_RLC_G_UCODE = 1,
118 SOC24_FIRMWARE_ID_RLC_TOC = 2,
119 SOC24_FIRMWARE_ID_RLCG_SCRATCH = 3,
120 SOC24_FIRMWARE_ID_RLC_SRM_ARAM = 4,
121 SOC24_FIRMWARE_ID_RLC_P_UCODE = 5,
122 SOC24_FIRMWARE_ID_RLC_V_UCODE = 6,
123 SOC24_FIRMWARE_ID_RLX6_UCODE = 7,
124 SOC24_FIRMWARE_ID_RLX6_UCODE_CORE1 = 8,
125 SOC24_FIRMWARE_ID_RLX6_DRAM_BOOT = 9,
126 SOC24_FIRMWARE_ID_RLX6_DRAM_BOOT_CORE1 = 10,
127 SOC24_FIRMWARE_ID_SDMA_UCODE_TH0 = 11,
128 SOC24_FIRMWARE_ID_SDMA_UCODE_TH1 = 12,
129 SOC24_FIRMWARE_ID_CP_PFP = 13,
130 SOC24_FIRMWARE_ID_CP_ME = 14,
131 SOC24_FIRMWARE_ID_CP_MEC = 15,
132 SOC24_FIRMWARE_ID_RS64_MES_P0 = 16,
133 SOC24_FIRMWARE_ID_RS64_MES_P1 = 17,
134 SOC24_FIRMWARE_ID_RS64_PFP = 18,
135 SOC24_FIRMWARE_ID_RS64_ME = 19,
136 SOC24_FIRMWARE_ID_RS64_MEC = 20,
137 SOC24_FIRMWARE_ID_RS64_MES_P0_STACK = 21,
138 SOC24_FIRMWARE_ID_RS64_MES_P1_STACK = 22,
139 SOC24_FIRMWARE_ID_RS64_PFP_P0_STACK = 23,
140 SOC24_FIRMWARE_ID_RS64_PFP_P1_STACK = 24,
141 SOC24_FIRMWARE_ID_RS64_ME_P0_STACK = 25,
142 SOC24_FIRMWARE_ID_RS64_ME_P1_STACK = 26,
143 SOC24_FIRMWARE_ID_RS64_MEC_P0_STACK = 27,
144 SOC24_FIRMWARE_ID_RS64_MEC_P1_STACK = 28,
145 SOC24_FIRMWARE_ID_RS64_MEC_P2_STACK = 29,
146 SOC24_FIRMWARE_ID_RS64_MEC_P3_STACK = 30,
147 SOC24_FIRMWARE_ID_RLC_SRM_DRAM_SR = 31,
148 SOC24_FIRMWARE_ID_RLCG_SCRATCH_SR = 32,
149 SOC24_FIRMWARE_ID_RLCP_SCRATCH_SR = 33,
150 SOC24_FIRMWARE_ID_RLCV_SCRATCH_SR = 34,
151 SOC24_FIRMWARE_ID_RLX6_DRAM_SR = 35,
152 SOC24_FIRMWARE_ID_RLX6_DRAM_SR_CORE1 = 36,
153 SOC24_FIRMWARE_ID_RLCDEBUGLOG = 37,
154 SOC24_FIRMWARE_ID_SRIOV_DEBUG = 38,
155 SOC24_FIRMWARE_ID_SRIOV_CSA_RLC = 39,
156 SOC24_FIRMWARE_ID_SRIOV_CSA_SDMA = 40,
157 SOC24_FIRMWARE_ID_SRIOV_CSA_CP = 41,
158 SOC24_FIRMWARE_ID_UMF_ZONE_PAD = 42,
159 SOC24_FIRMWARE_ID_MAX = 43
160} SOC24_FIRMWARE_ID;
161
162typedef struct _RLC_TABLE_OF_CONTENT {
163 union {
164 unsigned int DW0;
165 struct {
166 unsigned int offset : 25;
167 unsigned int id : 7;
168 };
169 };
170
171 union {
172 unsigned int DW1;
173 struct {
174 unsigned int load_at_boot : 1;
175 unsigned int load_at_vddgfx : 1;
176 unsigned int load_at_reset : 1;
177 unsigned int memory_destination : 2;
178 unsigned int vfflr_image_code : 4;
179 unsigned int load_mode_direct : 1;
180 unsigned int save_for_vddgfx : 1;
181 unsigned int save_for_vfflr : 1;
182 unsigned int reserved : 1;
183 unsigned int signed_source : 1;
184 unsigned int size : 18;
185 };
186 };
187
188 union {
189 unsigned int DW2;
190 struct {
191 unsigned int indirect_addr_reg : 16;
192 unsigned int index : 16;
193 };
194 };
195
196 union {
197 unsigned int DW3;
198 struct {
199 unsigned int indirect_data_reg : 16;
200 unsigned int indirect_start_offset : 16;
201 };
202 };
203} RLC_TABLE_OF_CONTENT;
204
205typedef struct _RLC_TABLE_OF_CONTENT_V2 {
206 union {
207 unsigned int DW0;
208 struct {
209 uint32_t offset : 25;
210 uint32_t id : 7;
211 };
212 };
213
214 union {
215 unsigned int DW1;
216 struct {
217 uint32_t reserved0 : 1;
218 uint32_t reserved1 : 1;
219 uint32_t reserved2 : 1;
220 uint32_t memory_destination : 2;
221 uint32_t vfflr_image_code : 4;
222 uint32_t reserved9 : 1;
223 uint32_t reserved10 : 1;
224 uint32_t reserved11 : 1;
225 uint32_t size_x16 : 1;
226 uint32_t reserved13 : 1;
227 uint32_t size : 18;
228 };
229 };
230} RLC_TABLE_OF_CONTENT_V2;
231
232#define RLC_TOC_MAX_SIZE 64
233
234struct amdgpu_rlc_funcs {
235 bool (*is_rlc_enabled)(struct amdgpu_device *adev);
236 void (*set_safe_mode)(struct amdgpu_device *adev, int xcc_id);
237 void (*unset_safe_mode)(struct amdgpu_device *adev, int xcc_id);
238 int (*init)(struct amdgpu_device *adev);
239 u32 (*get_csb_size)(struct amdgpu_device *adev);
240
241 /**
242 * @get_csb_buffer: Get the clear state to be put into the hardware.
243 *
244 * The parameter adev is used to get the CS data and other gfx info,
245 * and buffer is the RLC CS pointer
246 *
247 * Sometimes, the user space puts a request to clear the state in the
248 * command buffer; this function provides the clear state that gets put
249 * into the hardware. Note that the driver programs Clear State
250 * Indirect Buffer (CSB) explicitly when it sets up the kernel rings,
251 * and it also provides a pointer to it which is used by the firmware
252 * to load the clear state in some cases.
253 */
254 void (*get_csb_buffer)(struct amdgpu_device *adev, u32 *buffer);
255 int (*get_cp_table_num)(struct amdgpu_device *adev);
256 int (*resume)(struct amdgpu_device *adev);
257 void (*stop)(struct amdgpu_device *adev);
258 void (*reset)(struct amdgpu_device *adev);
259 void (*start)(struct amdgpu_device *adev);
260 void (*update_spm_vmid)(struct amdgpu_device *adev, struct amdgpu_ring *ring, unsigned vmid);
261 bool (*is_rlcg_access_range)(struct amdgpu_device *adev, uint32_t reg);
262};
263
264struct amdgpu_rlcg_reg_access_ctrl {
265 uint32_t scratch_reg0;
266 uint32_t scratch_reg1;
267 uint32_t scratch_reg2;
268 uint32_t scratch_reg3;
269 uint32_t grbm_cntl;
270 uint32_t grbm_idx;
271 uint32_t spare_int;
272};
273
274struct amdgpu_rlc {
275 /* for power gating */
276 struct amdgpu_bo *save_restore_obj;
277 uint64_t save_restore_gpu_addr;
278 uint32_t *sr_ptr;
279 const u32 *reg_list;
280 u32 reg_list_size;
281 /* for clear state */
282 struct amdgpu_bo *clear_state_obj;
283 uint64_t clear_state_gpu_addr;
284 uint32_t *cs_ptr;
285 const struct cs_section_def *cs_data;
286 u32 clear_state_size;
287 /* for cp tables */
288 struct amdgpu_bo *cp_table_obj;
289 uint64_t cp_table_gpu_addr;
290 uint32_t *cp_table_ptr;
291 u32 cp_table_size;
292
293 /* safe mode for updating CG/PG state */
294 bool in_safe_mode[AMDGPU_MAX_RLC_INSTANCES];
295 const struct amdgpu_rlc_funcs *funcs;
296
297 /* for firmware data */
298 u32 save_and_restore_offset;
299 u32 clear_state_descriptor_offset;
300 u32 avail_scratch_ram_locations;
301 u32 reg_restore_list_size;
302 u32 reg_list_format_start;
303 u32 reg_list_format_separate_start;
304 u32 starting_offsets_start;
305 u32 reg_list_format_size_bytes;
306 u32 reg_list_size_bytes;
307 u32 reg_list_format_direct_reg_list_length;
308 u32 save_restore_list_cntl_size_bytes;
309 u32 save_restore_list_gpm_size_bytes;
310 u32 save_restore_list_srm_size_bytes;
311 u32 rlc_iram_ucode_size_bytes;
312 u32 rlc_dram_ucode_size_bytes;
313 u32 rlcp_ucode_size_bytes;
314 u32 rlcv_ucode_size_bytes;
315 u32 global_tap_delays_ucode_size_bytes;
316 u32 se0_tap_delays_ucode_size_bytes;
317 u32 se1_tap_delays_ucode_size_bytes;
318 u32 se2_tap_delays_ucode_size_bytes;
319 u32 se3_tap_delays_ucode_size_bytes;
320
321 u32 *register_list_format;
322 u32 *register_restore;
323 u8 *save_restore_list_cntl;
324 u8 *save_restore_list_gpm;
325 u8 *save_restore_list_srm;
326 u8 *rlc_iram_ucode;
327 u8 *rlc_dram_ucode;
328 u8 *rlcp_ucode;
329 u8 *rlcv_ucode;
330 u8 *global_tap_delays_ucode;
331 u8 *se0_tap_delays_ucode;
332 u8 *se1_tap_delays_ucode;
333 u8 *se2_tap_delays_ucode;
334 u8 *se3_tap_delays_ucode;
335
336 bool is_rlc_v2_1;
337
338 /* for rlc autoload */
339 struct amdgpu_bo *rlc_autoload_bo;
340 u64 rlc_autoload_gpu_addr;
341 void *rlc_autoload_ptr;
342
343 /* rlc toc buffer */
344 struct amdgpu_bo *rlc_toc_bo;
345 uint64_t rlc_toc_gpu_addr;
346 void *rlc_toc_buf;
347
348 bool rlcg_reg_access_supported;
349 /* registers for rlcg indirect reg access */
350 struct amdgpu_rlcg_reg_access_ctrl reg_access_ctrl[AMDGPU_MAX_RLC_INSTANCES];
351};
352
353void amdgpu_gfx_rlc_enter_safe_mode(struct amdgpu_device *adev, int xcc_id);
354void amdgpu_gfx_rlc_exit_safe_mode(struct amdgpu_device *adev, int xcc_id);
355int amdgpu_gfx_rlc_init_sr(struct amdgpu_device *adev, u32 dws);
356int amdgpu_gfx_rlc_init_csb(struct amdgpu_device *adev);
357int amdgpu_gfx_rlc_init_cpt(struct amdgpu_device *adev);
358void amdgpu_gfx_rlc_setup_cp_table(struct amdgpu_device *adev);
359void amdgpu_gfx_rlc_fini(struct amdgpu_device *adev);
360int amdgpu_gfx_rlc_init_microcode(struct amdgpu_device *adev,
361 uint16_t version_major,
362 uint16_t version_minor);
363#endif
364

source code of linux/drivers/gpu/drm/amd/amdgpu/amdgpu_rlc.h