xref: /linux/drivers/gpu/drm/amd/amdgpu/amdgpu_ucode.h (revision 7f71507851fc7764b36a3221839607d3a45c2025)
1 /*
2  * Copyright 2012 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 #ifndef __AMDGPU_UCODE_H__
24 #define __AMDGPU_UCODE_H__
25 
26 #include "amdgpu_socbb.h"
27 
28 struct common_firmware_header {
29 	uint32_t size_bytes; /* size of the entire header+image(s) in bytes */
30 	uint32_t header_size_bytes; /* size of just the header in bytes */
31 	uint16_t header_version_major; /* header version */
32 	uint16_t header_version_minor; /* header version */
33 	uint16_t ip_version_major; /* IP version */
34 	uint16_t ip_version_minor; /* IP version */
35 	uint32_t ucode_version;
36 	uint32_t ucode_size_bytes; /* size of ucode in bytes */
37 	uint32_t ucode_array_offset_bytes; /* payload offset from the start of the header */
38 	uint32_t crc32;  /* crc32 checksum of the payload */
39 };
40 
41 /* version_major=1, version_minor=0 */
42 struct mc_firmware_header_v1_0 {
43 	struct common_firmware_header header;
44 	uint32_t io_debug_size_bytes; /* size of debug array in dwords */
45 	uint32_t io_debug_array_offset_bytes; /* payload offset from the start of the header */
46 };
47 
48 /* version_major=1, version_minor=0 */
49 struct smc_firmware_header_v1_0 {
50 	struct common_firmware_header header;
51 	uint32_t ucode_start_addr;
52 };
53 
54 /* version_major=2, version_minor=0 */
55 struct smc_firmware_header_v2_0 {
56 	struct smc_firmware_header_v1_0 v1_0;
57 	uint32_t ppt_offset_bytes; /* soft pptable offset */
58 	uint32_t ppt_size_bytes; /* soft pptable size */
59 };
60 
61 struct smc_soft_pptable_entry {
62         uint32_t id;
63         uint32_t ppt_offset_bytes;
64         uint32_t ppt_size_bytes;
65 };
66 
67 /* version_major=2, version_minor=1 */
68 struct smc_firmware_header_v2_1 {
69         struct smc_firmware_header_v1_0 v1_0;
70         uint32_t pptable_count;
71         uint32_t pptable_entry_offset;
72 };
73 
74 struct psp_fw_legacy_bin_desc {
75 	uint32_t fw_version;
76 	uint32_t offset_bytes;
77 	uint32_t size_bytes;
78 };
79 
80 /* version_major=1, version_minor=0 */
81 struct psp_firmware_header_v1_0 {
82 	struct common_firmware_header header;
83 	struct psp_fw_legacy_bin_desc sos;
84 };
85 
86 /* version_major=1, version_minor=1 */
87 struct psp_firmware_header_v1_1 {
88 	struct psp_firmware_header_v1_0 v1_0;
89 	struct psp_fw_legacy_bin_desc toc;
90 	struct psp_fw_legacy_bin_desc kdb;
91 };
92 
93 /* version_major=1, version_minor=2 */
94 struct psp_firmware_header_v1_2 {
95 	struct psp_firmware_header_v1_0 v1_0;
96 	struct psp_fw_legacy_bin_desc res;
97 	struct psp_fw_legacy_bin_desc kdb;
98 };
99 
100 /* version_major=1, version_minor=3 */
101 struct psp_firmware_header_v1_3 {
102 	struct psp_firmware_header_v1_1 v1_1;
103 	struct psp_fw_legacy_bin_desc spl;
104 	struct psp_fw_legacy_bin_desc rl;
105 	struct psp_fw_legacy_bin_desc sys_drv_aux;
106 	struct psp_fw_legacy_bin_desc sos_aux;
107 };
108 
109 struct psp_fw_bin_desc {
110 	uint32_t fw_type;
111 	uint32_t fw_version;
112 	uint32_t offset_bytes;
113 	uint32_t size_bytes;
114 };
115 
116 enum psp_fw_type {
117 	PSP_FW_TYPE_UNKOWN,
118 	PSP_FW_TYPE_PSP_SOS,
119 	PSP_FW_TYPE_PSP_SYS_DRV,
120 	PSP_FW_TYPE_PSP_KDB,
121 	PSP_FW_TYPE_PSP_TOC,
122 	PSP_FW_TYPE_PSP_SPL,
123 	PSP_FW_TYPE_PSP_RL,
124 	PSP_FW_TYPE_PSP_SOC_DRV,
125 	PSP_FW_TYPE_PSP_INTF_DRV,
126 	PSP_FW_TYPE_PSP_DBG_DRV,
127 	PSP_FW_TYPE_PSP_RAS_DRV,
128 	PSP_FW_TYPE_PSP_IPKEYMGR_DRV,
129 	PSP_FW_TYPE_MAX_INDEX,
130 };
131 
132 /* version_major=2, version_minor=0 */
133 struct psp_firmware_header_v2_0 {
134 	struct common_firmware_header header;
135 	uint32_t psp_fw_bin_count;
136 	struct psp_fw_bin_desc psp_fw_bin[];
137 };
138 
139 /* version_major=2, version_minor=1 */
140 struct psp_firmware_header_v2_1 {
141 	struct common_firmware_header header;
142 	uint32_t psp_fw_bin_count;
143 	uint32_t psp_aux_fw_bin_index;
144 	struct psp_fw_bin_desc psp_fw_bin[];
145 };
146 
147 /* version_major=1, version_minor=0 */
148 struct ta_firmware_header_v1_0 {
149 	struct common_firmware_header header;
150 	struct psp_fw_legacy_bin_desc xgmi;
151 	struct psp_fw_legacy_bin_desc ras;
152 	struct psp_fw_legacy_bin_desc hdcp;
153 	struct psp_fw_legacy_bin_desc dtm;
154 	struct psp_fw_legacy_bin_desc securedisplay;
155 };
156 
157 enum ta_fw_type {
158 	TA_FW_TYPE_UNKOWN,
159 	TA_FW_TYPE_PSP_ASD,
160 	TA_FW_TYPE_PSP_XGMI,
161 	TA_FW_TYPE_PSP_RAS,
162 	TA_FW_TYPE_PSP_HDCP,
163 	TA_FW_TYPE_PSP_DTM,
164 	TA_FW_TYPE_PSP_RAP,
165 	TA_FW_TYPE_PSP_SECUREDISPLAY,
166 	TA_FW_TYPE_PSP_XGMI_AUX,
167 	TA_FW_TYPE_MAX_INDEX,
168 };
169 
170 /* version_major=2, version_minor=0 */
171 struct ta_firmware_header_v2_0 {
172 	struct common_firmware_header header;
173 	uint32_t ta_fw_bin_count;
174 	struct psp_fw_bin_desc ta_fw_bin[];
175 };
176 
177 /* version_major=1, version_minor=0 */
178 struct gfx_firmware_header_v1_0 {
179 	struct common_firmware_header header;
180 	uint32_t ucode_feature_version;
181 	uint32_t jt_offset; /* jt location */
182 	uint32_t jt_size;  /* size of jt */
183 };
184 
185 /* version_major=2, version_minor=0 */
186 struct gfx_firmware_header_v2_0 {
187 	struct common_firmware_header header;
188 	uint32_t ucode_feature_version;
189 	uint32_t ucode_size_bytes;
190 	uint32_t ucode_offset_bytes;
191 	uint32_t data_size_bytes;
192 	uint32_t data_offset_bytes;
193 	uint32_t ucode_start_addr_lo;
194 	uint32_t ucode_start_addr_hi;
195 };
196 
197 /* version_major=1, version_minor=0 */
198 struct mes_firmware_header_v1_0 {
199 	struct common_firmware_header header;
200 	uint32_t mes_ucode_version;
201 	uint32_t mes_ucode_size_bytes;
202 	uint32_t mes_ucode_offset_bytes;
203 	uint32_t mes_ucode_data_version;
204 	uint32_t mes_ucode_data_size_bytes;
205 	uint32_t mes_ucode_data_offset_bytes;
206 	uint32_t mes_uc_start_addr_lo;
207 	uint32_t mes_uc_start_addr_hi;
208 	uint32_t mes_data_start_addr_lo;
209 	uint32_t mes_data_start_addr_hi;
210 };
211 
212 /* version_major=1, version_minor=0 */
213 struct rlc_firmware_header_v1_0 {
214 	struct common_firmware_header header;
215 	uint32_t ucode_feature_version;
216 	uint32_t save_and_restore_offset;
217 	uint32_t clear_state_descriptor_offset;
218 	uint32_t avail_scratch_ram_locations;
219 	uint32_t master_pkt_description_offset;
220 };
221 
222 /* version_major=2, version_minor=0 */
223 struct rlc_firmware_header_v2_0 {
224 	struct common_firmware_header header;
225 	uint32_t ucode_feature_version;
226 	uint32_t jt_offset; /* jt location */
227 	uint32_t jt_size;  /* size of jt */
228 	uint32_t save_and_restore_offset;
229 	uint32_t clear_state_descriptor_offset;
230 	uint32_t avail_scratch_ram_locations;
231 	uint32_t reg_restore_list_size;
232 	uint32_t reg_list_format_start;
233 	uint32_t reg_list_format_separate_start;
234 	uint32_t starting_offsets_start;
235 	uint32_t reg_list_format_size_bytes; /* size of reg list format array in bytes */
236 	uint32_t reg_list_format_array_offset_bytes; /* payload offset from the start of the header */
237 	uint32_t reg_list_size_bytes; /* size of reg list array in bytes */
238 	uint32_t reg_list_array_offset_bytes; /* payload offset from the start of the header */
239 	uint32_t reg_list_format_separate_size_bytes; /* size of reg list format array in bytes */
240 	uint32_t reg_list_format_separate_array_offset_bytes; /* payload offset from the start of the header */
241 	uint32_t reg_list_separate_size_bytes; /* size of reg list array in bytes */
242 	uint32_t reg_list_separate_array_offset_bytes; /* payload offset from the start of the header */
243 };
244 
245 /* version_major=2, version_minor=1 */
246 struct rlc_firmware_header_v2_1 {
247 	struct rlc_firmware_header_v2_0 v2_0;
248 	uint32_t reg_list_format_direct_reg_list_length; /* length of direct reg list format array */
249 	uint32_t save_restore_list_cntl_ucode_ver;
250 	uint32_t save_restore_list_cntl_feature_ver;
251 	uint32_t save_restore_list_cntl_size_bytes;
252 	uint32_t save_restore_list_cntl_offset_bytes;
253 	uint32_t save_restore_list_gpm_ucode_ver;
254 	uint32_t save_restore_list_gpm_feature_ver;
255 	uint32_t save_restore_list_gpm_size_bytes;
256 	uint32_t save_restore_list_gpm_offset_bytes;
257 	uint32_t save_restore_list_srm_ucode_ver;
258 	uint32_t save_restore_list_srm_feature_ver;
259 	uint32_t save_restore_list_srm_size_bytes;
260 	uint32_t save_restore_list_srm_offset_bytes;
261 };
262 
263 /* version_major=2, version_minor=2 */
264 struct rlc_firmware_header_v2_2 {
265 	struct rlc_firmware_header_v2_1 v2_1;
266 	uint32_t rlc_iram_ucode_size_bytes;
267 	uint32_t rlc_iram_ucode_offset_bytes;
268 	uint32_t rlc_dram_ucode_size_bytes;
269 	uint32_t rlc_dram_ucode_offset_bytes;
270 };
271 
272 /* version_major=2, version_minor=3 */
273 struct rlc_firmware_header_v2_3 {
274     struct rlc_firmware_header_v2_2 v2_2;
275     uint32_t rlcp_ucode_version;
276     uint32_t rlcp_ucode_feature_version;
277     uint32_t rlcp_ucode_size_bytes;
278     uint32_t rlcp_ucode_offset_bytes;
279     uint32_t rlcv_ucode_version;
280     uint32_t rlcv_ucode_feature_version;
281     uint32_t rlcv_ucode_size_bytes;
282     uint32_t rlcv_ucode_offset_bytes;
283 };
284 
285 /* version_major=2, version_minor=4 */
286 struct rlc_firmware_header_v2_4 {
287     struct rlc_firmware_header_v2_3 v2_3;
288     uint32_t global_tap_delays_ucode_size_bytes;
289     uint32_t global_tap_delays_ucode_offset_bytes;
290     uint32_t se0_tap_delays_ucode_size_bytes;
291     uint32_t se0_tap_delays_ucode_offset_bytes;
292     uint32_t se1_tap_delays_ucode_size_bytes;
293     uint32_t se1_tap_delays_ucode_offset_bytes;
294     uint32_t se2_tap_delays_ucode_size_bytes;
295     uint32_t se2_tap_delays_ucode_offset_bytes;
296     uint32_t se3_tap_delays_ucode_size_bytes;
297     uint32_t se3_tap_delays_ucode_offset_bytes;
298 };
299 
300 /* version_major=1, version_minor=0 */
301 struct sdma_firmware_header_v1_0 {
302 	struct common_firmware_header header;
303 	uint32_t ucode_feature_version;
304 	uint32_t ucode_change_version;
305 	uint32_t jt_offset; /* jt location */
306 	uint32_t jt_size; /* size of jt */
307 };
308 
309 /* version_major=1, version_minor=1 */
310 struct sdma_firmware_header_v1_1 {
311 	struct sdma_firmware_header_v1_0 v1_0;
312 	uint32_t digest_size;
313 };
314 
315 /* version_major=2, version_minor=0 */
316 struct sdma_firmware_header_v2_0 {
317 	struct common_firmware_header header;
318 	uint32_t ucode_feature_version;
319 	uint32_t ctx_ucode_size_bytes; /* context thread ucode size */
320 	uint32_t ctx_jt_offset; /* context thread jt location */
321 	uint32_t ctx_jt_size; /* context thread size of jt */
322 	uint32_t ctl_ucode_offset;
323 	uint32_t ctl_ucode_size_bytes; /* control thread ucode size */
324 	uint32_t ctl_jt_offset; /* control thread jt location */
325 	uint32_t ctl_jt_size; /* control thread size of jt */
326 };
327 
328 /* version_major=1, version_minor=0 */
329 struct vpe_firmware_header_v1_0 {
330 	struct common_firmware_header header;
331 	uint32_t ucode_feature_version;
332 	uint32_t ctx_ucode_size_bytes; /* context thread ucode size */
333 	uint32_t ctx_jt_offset; /* context thread jt location */
334 	uint32_t ctx_jt_size; /* context thread size of jt */
335 	uint32_t ctl_ucode_offset;
336 	uint32_t ctl_ucode_size_bytes; /* control thread ucode size */
337 	uint32_t ctl_jt_offset; /* control thread jt location */
338 	uint32_t ctl_jt_size; /* control thread size of jt */
339 };
340 
341 /* version_major=1, version_minor=0 */
342 struct umsch_mm_firmware_header_v1_0 {
343 	struct common_firmware_header header;
344 	uint32_t umsch_mm_ucode_version;
345 	uint32_t umsch_mm_ucode_size_bytes;
346 	uint32_t umsch_mm_ucode_offset_bytes;
347 	uint32_t umsch_mm_ucode_data_version;
348 	uint32_t umsch_mm_ucode_data_size_bytes;
349 	uint32_t umsch_mm_ucode_data_offset_bytes;
350 	uint32_t umsch_mm_irq_start_addr_lo;
351 	uint32_t umsch_mm_irq_start_addr_hi;
352 	uint32_t umsch_mm_uc_start_addr_lo;
353 	uint32_t umsch_mm_uc_start_addr_hi;
354 	uint32_t umsch_mm_data_start_addr_lo;
355 	uint32_t umsch_mm_data_start_addr_hi;
356 };
357 
358 /* version_major=3, version_minor=0 */
359 struct sdma_firmware_header_v3_0 {
360     struct common_firmware_header header;
361     uint32_t ucode_feature_version;
362     uint32_t ucode_offset_bytes;
363     uint32_t ucode_size_bytes;
364 };
365 
366 /* gpu info payload */
367 struct gpu_info_firmware_v1_0 {
368 	uint32_t gc_num_se;
369 	uint32_t gc_num_cu_per_sh;
370 	uint32_t gc_num_sh_per_se;
371 	uint32_t gc_num_rb_per_se;
372 	uint32_t gc_num_tccs;
373 	uint32_t gc_num_gprs;
374 	uint32_t gc_num_max_gs_thds;
375 	uint32_t gc_gs_table_depth;
376 	uint32_t gc_gsprim_buff_depth;
377 	uint32_t gc_parameter_cache_depth;
378 	uint32_t gc_double_offchip_lds_buffer;
379 	uint32_t gc_wave_size;
380 	uint32_t gc_max_waves_per_simd;
381 	uint32_t gc_max_scratch_slots_per_cu;
382 	uint32_t gc_lds_size;
383 };
384 
385 struct gpu_info_firmware_v1_1 {
386 	struct gpu_info_firmware_v1_0 v1_0;
387 	uint32_t num_sc_per_sh;
388 	uint32_t num_packer_per_sc;
389 };
390 
391 /* gpu info payload
392  * version_major=1, version_minor=1 */
393 struct gpu_info_firmware_v1_2 {
394 	struct gpu_info_firmware_v1_1 v1_1;
395 	struct gpu_info_soc_bounding_box_v1_0 soc_bounding_box;
396 };
397 
398 /* version_major=1, version_minor=0 */
399 struct gpu_info_firmware_header_v1_0 {
400 	struct common_firmware_header header;
401 	uint16_t version_major; /* version */
402 	uint16_t version_minor; /* version */
403 };
404 
405 /* version_major=1, version_minor=0 */
406 struct dmcu_firmware_header_v1_0 {
407 	struct common_firmware_header header;
408 	uint32_t intv_offset_bytes; /* interrupt vectors offset from end of header, in bytes */
409 	uint32_t intv_size_bytes;  /* size of interrupt vectors, in bytes */
410 };
411 
412 /* version_major=1, version_minor=0 */
413 struct dmcub_firmware_header_v1_0 {
414 	struct common_firmware_header header;
415 	uint32_t inst_const_bytes; /* size of instruction region, in bytes */
416 	uint32_t bss_data_bytes; /* size of bss/data region, in bytes */
417 };
418 
419 /* version_major=1, version_minor=0 */
420 struct imu_firmware_header_v1_0 {
421     struct common_firmware_header header;
422     uint32_t imu_iram_ucode_size_bytes;
423     uint32_t imu_iram_ucode_offset_bytes;
424     uint32_t imu_dram_ucode_size_bytes;
425     uint32_t imu_dram_ucode_offset_bytes;
426 };
427 
428 /* header is fixed size */
429 union amdgpu_firmware_header {
430 	struct common_firmware_header common;
431 	struct mc_firmware_header_v1_0 mc;
432 	struct smc_firmware_header_v1_0 smc;
433 	struct smc_firmware_header_v2_0 smc_v2_0;
434 	struct psp_firmware_header_v1_0 psp;
435 	struct psp_firmware_header_v1_1 psp_v1_1;
436 	struct psp_firmware_header_v1_3 psp_v1_3;
437 	struct psp_firmware_header_v2_0 psp_v2_0;
438 	struct psp_firmware_header_v2_0 psp_v2_1;
439 	struct ta_firmware_header_v1_0 ta;
440 	struct ta_firmware_header_v2_0 ta_v2_0;
441 	struct gfx_firmware_header_v1_0 gfx;
442 	struct gfx_firmware_header_v2_0 gfx_v2_0;
443 	struct rlc_firmware_header_v1_0 rlc;
444 	struct rlc_firmware_header_v2_0 rlc_v2_0;
445 	struct rlc_firmware_header_v2_1 rlc_v2_1;
446 	struct rlc_firmware_header_v2_2 rlc_v2_2;
447 	struct rlc_firmware_header_v2_3 rlc_v2_3;
448 	struct rlc_firmware_header_v2_4 rlc_v2_4;
449 	struct sdma_firmware_header_v1_0 sdma;
450 	struct sdma_firmware_header_v1_1 sdma_v1_1;
451 	struct sdma_firmware_header_v2_0 sdma_v2_0;
452 	struct sdma_firmware_header_v3_0 sdma_v3_0;
453 	struct gpu_info_firmware_header_v1_0 gpu_info;
454 	struct dmcu_firmware_header_v1_0 dmcu;
455 	struct dmcub_firmware_header_v1_0 dmcub;
456 	struct imu_firmware_header_v1_0 imu;
457 	uint8_t raw[0x100];
458 };
459 
460 #define UCODE_MAX_PSP_PACKAGING (((sizeof(union amdgpu_firmware_header) - sizeof(struct common_firmware_header) - 4) / sizeof(struct psp_fw_bin_desc)) * 2)
461 
462 /*
463  * fw loading support
464  */
465 enum AMDGPU_UCODE_ID {
466 	AMDGPU_UCODE_ID_CAP = 0,
467 	AMDGPU_UCODE_ID_SDMA0,
468 	AMDGPU_UCODE_ID_SDMA1,
469 	AMDGPU_UCODE_ID_SDMA2,
470 	AMDGPU_UCODE_ID_SDMA3,
471 	AMDGPU_UCODE_ID_SDMA4,
472 	AMDGPU_UCODE_ID_SDMA5,
473 	AMDGPU_UCODE_ID_SDMA6,
474 	AMDGPU_UCODE_ID_SDMA7,
475 	AMDGPU_UCODE_ID_SDMA_UCODE_TH0,
476 	AMDGPU_UCODE_ID_SDMA_UCODE_TH1,
477 	AMDGPU_UCODE_ID_SDMA_RS64,
478 	AMDGPU_UCODE_ID_CP_CE,
479 	AMDGPU_UCODE_ID_CP_PFP,
480 	AMDGPU_UCODE_ID_CP_ME,
481 	AMDGPU_UCODE_ID_CP_RS64_PFP,
482 	AMDGPU_UCODE_ID_CP_RS64_ME,
483 	AMDGPU_UCODE_ID_CP_RS64_MEC,
484 	AMDGPU_UCODE_ID_CP_RS64_PFP_P0_STACK,
485 	AMDGPU_UCODE_ID_CP_RS64_PFP_P1_STACK,
486 	AMDGPU_UCODE_ID_CP_RS64_ME_P0_STACK,
487 	AMDGPU_UCODE_ID_CP_RS64_ME_P1_STACK,
488 	AMDGPU_UCODE_ID_CP_RS64_MEC_P0_STACK,
489 	AMDGPU_UCODE_ID_CP_RS64_MEC_P1_STACK,
490 	AMDGPU_UCODE_ID_CP_RS64_MEC_P2_STACK,
491 	AMDGPU_UCODE_ID_CP_RS64_MEC_P3_STACK,
492 	AMDGPU_UCODE_ID_CP_MEC1,
493 	AMDGPU_UCODE_ID_CP_MEC1_JT,
494 	AMDGPU_UCODE_ID_CP_MEC2,
495 	AMDGPU_UCODE_ID_CP_MEC2_JT,
496 	AMDGPU_UCODE_ID_CP_MES,
497 	AMDGPU_UCODE_ID_CP_MES_DATA,
498 	AMDGPU_UCODE_ID_CP_MES1,
499 	AMDGPU_UCODE_ID_CP_MES1_DATA,
500 	AMDGPU_UCODE_ID_IMU_I,
501 	AMDGPU_UCODE_ID_IMU_D,
502 	AMDGPU_UCODE_ID_GLOBAL_TAP_DELAYS,
503 	AMDGPU_UCODE_ID_SE0_TAP_DELAYS,
504 	AMDGPU_UCODE_ID_SE1_TAP_DELAYS,
505 	AMDGPU_UCODE_ID_SE2_TAP_DELAYS,
506 	AMDGPU_UCODE_ID_SE3_TAP_DELAYS,
507 	AMDGPU_UCODE_ID_RLC_RESTORE_LIST_CNTL,
508 	AMDGPU_UCODE_ID_RLC_RESTORE_LIST_GPM_MEM,
509 	AMDGPU_UCODE_ID_RLC_RESTORE_LIST_SRM_MEM,
510 	AMDGPU_UCODE_ID_RLC_IRAM,
511 	AMDGPU_UCODE_ID_RLC_DRAM,
512 	AMDGPU_UCODE_ID_RLC_P,
513 	AMDGPU_UCODE_ID_RLC_V,
514 	AMDGPU_UCODE_ID_RLC_G,
515 	AMDGPU_UCODE_ID_STORAGE,
516 	AMDGPU_UCODE_ID_SMC,
517 	AMDGPU_UCODE_ID_PPTABLE,
518 	AMDGPU_UCODE_ID_UVD,
519 	AMDGPU_UCODE_ID_UVD1,
520 	AMDGPU_UCODE_ID_VCE,
521 	AMDGPU_UCODE_ID_VCN,
522 	AMDGPU_UCODE_ID_VCN1,
523 	AMDGPU_UCODE_ID_DMCU_ERAM,
524 	AMDGPU_UCODE_ID_DMCU_INTV,
525 	AMDGPU_UCODE_ID_VCN0_RAM,
526 	AMDGPU_UCODE_ID_VCN1_RAM,
527 	AMDGPU_UCODE_ID_DMCUB,
528 	AMDGPU_UCODE_ID_VPE_CTX,
529 	AMDGPU_UCODE_ID_VPE_CTL,
530 	AMDGPU_UCODE_ID_VPE,
531 	AMDGPU_UCODE_ID_UMSCH_MM_UCODE,
532 	AMDGPU_UCODE_ID_UMSCH_MM_DATA,
533 	AMDGPU_UCODE_ID_UMSCH_MM_CMD_BUFFER,
534 	AMDGPU_UCODE_ID_P2S_TABLE,
535 	AMDGPU_UCODE_ID_JPEG_RAM,
536 	AMDGPU_UCODE_ID_ISP,
537 	AMDGPU_UCODE_ID_MAXIMUM,
538 };
539 
540 /* engine firmware status */
541 enum AMDGPU_UCODE_STATUS {
542 	AMDGPU_UCODE_STATUS_INVALID,
543 	AMDGPU_UCODE_STATUS_NOT_LOADED,
544 	AMDGPU_UCODE_STATUS_LOADED,
545 };
546 
547 enum amdgpu_firmware_load_type {
548 	AMDGPU_FW_LOAD_DIRECT = 0,
549 	AMDGPU_FW_LOAD_PSP,
550 	AMDGPU_FW_LOAD_SMU,
551 	AMDGPU_FW_LOAD_RLC_BACKDOOR_AUTO,
552 };
553 
554 /* conform to smu_ucode_xfer_cz.h */
555 #define AMDGPU_SDMA0_UCODE_LOADED	0x00000001
556 #define AMDGPU_SDMA1_UCODE_LOADED	0x00000002
557 #define AMDGPU_CPCE_UCODE_LOADED	0x00000004
558 #define AMDGPU_CPPFP_UCODE_LOADED	0x00000008
559 #define AMDGPU_CPME_UCODE_LOADED	0x00000010
560 #define AMDGPU_CPMEC1_UCODE_LOADED	0x00000020
561 #define AMDGPU_CPMEC2_UCODE_LOADED	0x00000040
562 #define AMDGPU_CPRLC_UCODE_LOADED	0x00000100
563 
564 /* amdgpu firmware info */
565 struct amdgpu_firmware_info {
566 	/* ucode ID */
567 	enum AMDGPU_UCODE_ID ucode_id;
568 	/* request_firmware */
569 	const struct firmware *fw;
570 	/* starting mc address */
571 	uint64_t mc_addr;
572 	/* kernel linear address */
573 	void *kaddr;
574 	/* ucode_size_bytes */
575 	uint32_t ucode_size;
576 	/* starting tmr mc address */
577 	uint32_t tmr_mc_addr_lo;
578 	uint32_t tmr_mc_addr_hi;
579 };
580 
581 struct amdgpu_firmware {
582 	struct amdgpu_firmware_info ucode[AMDGPU_UCODE_ID_MAXIMUM];
583 	enum amdgpu_firmware_load_type load_type;
584 	struct amdgpu_bo *fw_buf;
585 	unsigned int fw_size;
586 	unsigned int max_ucodes;
587 	/* firmwares are loaded by psp instead of smu from vega10 */
588 	const struct amdgpu_psp_funcs *funcs;
589 	struct amdgpu_bo *rbuf;
590 	struct mutex mutex;
591 
592 	/* gpu info firmware data pointer */
593 	const struct firmware *gpu_info_fw;
594 
595 	void *fw_buf_ptr;
596 	uint64_t fw_buf_mc;
597 };
598 
599 void amdgpu_ucode_print_mc_hdr(const struct common_firmware_header *hdr);
600 void amdgpu_ucode_print_smc_hdr(const struct common_firmware_header *hdr);
601 void amdgpu_ucode_print_imu_hdr(const struct common_firmware_header *hdr);
602 void amdgpu_ucode_print_gfx_hdr(const struct common_firmware_header *hdr);
603 void amdgpu_ucode_print_rlc_hdr(const struct common_firmware_header *hdr);
604 void amdgpu_ucode_print_sdma_hdr(const struct common_firmware_header *hdr);
605 void amdgpu_ucode_print_psp_hdr(const struct common_firmware_header *hdr);
606 void amdgpu_ucode_print_gpu_info_hdr(const struct common_firmware_header *hdr);
607 __printf(3, 4)
608 int amdgpu_ucode_request(struct amdgpu_device *adev, const struct firmware **fw,
609 			 const char *fmt, ...);
610 void amdgpu_ucode_release(const struct firmware **fw);
611 bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
612 				uint16_t hdr_major, uint16_t hdr_minor);
613 
614 int amdgpu_ucode_init_bo(struct amdgpu_device *adev);
615 int amdgpu_ucode_create_bo(struct amdgpu_device *adev);
616 int amdgpu_ucode_sysfs_init(struct amdgpu_device *adev);
617 void amdgpu_ucode_free_bo(struct amdgpu_device *adev);
618 void amdgpu_ucode_sysfs_fini(struct amdgpu_device *adev);
619 
620 enum amdgpu_firmware_load_type
621 amdgpu_ucode_get_load_type(struct amdgpu_device *adev, int load_type);
622 
623 const char *amdgpu_ucode_name(enum AMDGPU_UCODE_ID ucode_id);
624 
625 void amdgpu_ucode_ip_version_decode(struct amdgpu_device *adev, int block_type, char *ucode_prefix, int len);
626 
627 #endif
628