Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
28struct 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 */
42struct 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 */
49struct 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 */
55struct 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
61struct 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 */
68struct 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/* version_major=1, version_minor=0 */
75struct psp_firmware_header_v1_0 {
76 struct common_firmware_header header;
77 uint32_t ucode_feature_version;
78 uint32_t sos_offset_bytes;
79 uint32_t sos_size_bytes;
80};
81
82/* version_major=1, version_minor=1 */
83struct psp_firmware_header_v1_1 {
84 struct psp_firmware_header_v1_0 v1_0;
85 uint32_t toc_header_version;
86 uint32_t toc_offset_bytes;
87 uint32_t toc_size_bytes;
88 uint32_t kdb_header_version;
89 uint32_t kdb_offset_bytes;
90 uint32_t kdb_size_bytes;
91};
92
93/* version_major=1, version_minor=2 */
94struct psp_firmware_header_v1_2 {
95 struct psp_firmware_header_v1_0 v1_0;
96 uint32_t reserve[3];
97 uint32_t kdb_header_version;
98 uint32_t kdb_offset_bytes;
99 uint32_t kdb_size_bytes;
100};
101
102/* version_major=1, version_minor=3 */
103struct psp_firmware_header_v1_3 {
104 struct psp_firmware_header_v1_1 v1_1;
105 uint32_t spl_header_version;
106 uint32_t spl_offset_bytes;
107 uint32_t spl_size_bytes;
108};
109
110/* version_major=1, version_minor=0 */
111struct ta_firmware_header_v1_0 {
112 struct common_firmware_header header;
113 uint32_t ta_xgmi_ucode_version;
114 uint32_t ta_xgmi_offset_bytes;
115 uint32_t ta_xgmi_size_bytes;
116 uint32_t ta_ras_ucode_version;
117 uint32_t ta_ras_offset_bytes;
118 uint32_t ta_ras_size_bytes;
119 uint32_t ta_hdcp_ucode_version;
120 uint32_t ta_hdcp_offset_bytes;
121 uint32_t ta_hdcp_size_bytes;
122 uint32_t ta_dtm_ucode_version;
123 uint32_t ta_dtm_offset_bytes;
124 uint32_t ta_dtm_size_bytes;
125 uint32_t ta_securedisplay_ucode_version;
126 uint32_t ta_securedisplay_offset_bytes;
127 uint32_t ta_securedisplay_size_bytes;
128};
129
130enum ta_fw_type {
131 TA_FW_TYPE_UNKOWN,
132 TA_FW_TYPE_PSP_ASD,
133 TA_FW_TYPE_PSP_XGMI,
134 TA_FW_TYPE_PSP_RAS,
135 TA_FW_TYPE_PSP_HDCP,
136 TA_FW_TYPE_PSP_DTM,
137 TA_FW_TYPE_PSP_RAP,
138 TA_FW_TYPE_PSP_SECUREDISPLAY,
139};
140
141struct ta_fw_bin_desc {
142 uint32_t fw_type;
143 uint32_t fw_version;
144 uint32_t offset_bytes;
145 uint32_t size_bytes;
146};
147
148/* version_major=2, version_minor=0 */
149struct ta_firmware_header_v2_0 {
150 struct common_firmware_header header;
151 uint32_t ta_fw_bin_count;
152 struct ta_fw_bin_desc ta_fw_bin[];
153};
154
155/* version_major=1, version_minor=0 */
156struct gfx_firmware_header_v1_0 {
157 struct common_firmware_header header;
158 uint32_t ucode_feature_version;
159 uint32_t jt_offset; /* jt location */
160 uint32_t jt_size; /* size of jt */
161};
162
163/* version_major=1, version_minor=0 */
164struct mes_firmware_header_v1_0 {
165 struct common_firmware_header header;
166 uint32_t mes_ucode_version;
167 uint32_t mes_ucode_size_bytes;
168 uint32_t mes_ucode_offset_bytes;
169 uint32_t mes_ucode_data_version;
170 uint32_t mes_ucode_data_size_bytes;
171 uint32_t mes_ucode_data_offset_bytes;
172 uint32_t mes_uc_start_addr_lo;
173 uint32_t mes_uc_start_addr_hi;
174 uint32_t mes_data_start_addr_lo;
175 uint32_t mes_data_start_addr_hi;
176};
177
178/* version_major=1, version_minor=0 */
179struct rlc_firmware_header_v1_0 {
180 struct common_firmware_header header;
181 uint32_t ucode_feature_version;
182 uint32_t save_and_restore_offset;
183 uint32_t clear_state_descriptor_offset;
184 uint32_t avail_scratch_ram_locations;
185 uint32_t master_pkt_description_offset;
186};
187
188/* version_major=2, version_minor=0 */
189struct rlc_firmware_header_v2_0 {
190 struct common_firmware_header header;
191 uint32_t ucode_feature_version;
192 uint32_t jt_offset; /* jt location */
193 uint32_t jt_size; /* size of jt */
194 uint32_t save_and_restore_offset;
195 uint32_t clear_state_descriptor_offset;
196 uint32_t avail_scratch_ram_locations;
197 uint32_t reg_restore_list_size;
198 uint32_t reg_list_format_start;
199 uint32_t reg_list_format_separate_start;
200 uint32_t starting_offsets_start;
201 uint32_t reg_list_format_size_bytes; /* size of reg list format array in bytes */
202 uint32_t reg_list_format_array_offset_bytes; /* payload offset from the start of the header */
203 uint32_t reg_list_size_bytes; /* size of reg list array in bytes */
204 uint32_t reg_list_array_offset_bytes; /* payload offset from the start of the header */
205 uint32_t reg_list_format_separate_size_bytes; /* size of reg list format array in bytes */
206 uint32_t reg_list_format_separate_array_offset_bytes; /* payload offset from the start of the header */
207 uint32_t reg_list_separate_size_bytes; /* size of reg list array in bytes */
208 uint32_t reg_list_separate_array_offset_bytes; /* payload offset from the start of the header */
209};
210
211/* version_major=2, version_minor=1 */
212struct rlc_firmware_header_v2_1 {
213 struct rlc_firmware_header_v2_0 v2_0;
214 uint32_t reg_list_format_direct_reg_list_length; /* length of direct reg list format array */
215 uint32_t save_restore_list_cntl_ucode_ver;
216 uint32_t save_restore_list_cntl_feature_ver;
217 uint32_t save_restore_list_cntl_size_bytes;
218 uint32_t save_restore_list_cntl_offset_bytes;
219 uint32_t save_restore_list_gpm_ucode_ver;
220 uint32_t save_restore_list_gpm_feature_ver;
221 uint32_t save_restore_list_gpm_size_bytes;
222 uint32_t save_restore_list_gpm_offset_bytes;
223 uint32_t save_restore_list_srm_ucode_ver;
224 uint32_t save_restore_list_srm_feature_ver;
225 uint32_t save_restore_list_srm_size_bytes;
226 uint32_t save_restore_list_srm_offset_bytes;
227};
228
229/* version_major=2, version_minor=1 */
230struct rlc_firmware_header_v2_2 {
231 struct rlc_firmware_header_v2_1 v2_1;
232 uint32_t rlc_iram_ucode_size_bytes;
233 uint32_t rlc_iram_ucode_offset_bytes;
234 uint32_t rlc_dram_ucode_size_bytes;
235 uint32_t rlc_dram_ucode_offset_bytes;
236};
237
238/* version_major=1, version_minor=0 */
239struct sdma_firmware_header_v1_0 {
240 struct common_firmware_header header;
241 uint32_t ucode_feature_version;
242 uint32_t ucode_change_version;
243 uint32_t jt_offset; /* jt location */
244 uint32_t jt_size; /* size of jt */
245};
246
247/* version_major=1, version_minor=1 */
248struct sdma_firmware_header_v1_1 {
249 struct sdma_firmware_header_v1_0 v1_0;
250 uint32_t digest_size;
251};
252
253/* gpu info payload */
254struct gpu_info_firmware_v1_0 {
255 uint32_t gc_num_se;
256 uint32_t gc_num_cu_per_sh;
257 uint32_t gc_num_sh_per_se;
258 uint32_t gc_num_rb_per_se;
259 uint32_t gc_num_tccs;
260 uint32_t gc_num_gprs;
261 uint32_t gc_num_max_gs_thds;
262 uint32_t gc_gs_table_depth;
263 uint32_t gc_gsprim_buff_depth;
264 uint32_t gc_parameter_cache_depth;
265 uint32_t gc_double_offchip_lds_buffer;
266 uint32_t gc_wave_size;
267 uint32_t gc_max_waves_per_simd;
268 uint32_t gc_max_scratch_slots_per_cu;
269 uint32_t gc_lds_size;
270};
271
272struct gpu_info_firmware_v1_1 {
273 struct gpu_info_firmware_v1_0 v1_0;
274 uint32_t num_sc_per_sh;
275 uint32_t num_packer_per_sc;
276};
277
278/* gpu info payload
279 * version_major=1, version_minor=1 */
280struct gpu_info_firmware_v1_2 {
281 struct gpu_info_firmware_v1_1 v1_1;
282 struct gpu_info_soc_bounding_box_v1_0 soc_bounding_box;
283};
284
285/* version_major=1, version_minor=0 */
286struct gpu_info_firmware_header_v1_0 {
287 struct common_firmware_header header;
288 uint16_t version_major; /* version */
289 uint16_t version_minor; /* version */
290};
291
292/* version_major=1, version_minor=0 */
293struct dmcu_firmware_header_v1_0 {
294 struct common_firmware_header header;
295 uint32_t intv_offset_bytes; /* interrupt vectors offset from end of header, in bytes */
296 uint32_t intv_size_bytes; /* size of interrupt vectors, in bytes */
297};
298
299/* version_major=1, version_minor=0 */
300struct dmcub_firmware_header_v1_0 {
301 struct common_firmware_header header;
302 uint32_t inst_const_bytes; /* size of instruction region, in bytes */
303 uint32_t bss_data_bytes; /* size of bss/data region, in bytes */
304};
305
306/* header is fixed size */
307union amdgpu_firmware_header {
308 struct common_firmware_header common;
309 struct mc_firmware_header_v1_0 mc;
310 struct smc_firmware_header_v1_0 smc;
311 struct smc_firmware_header_v2_0 smc_v2_0;
312 struct psp_firmware_header_v1_0 psp;
313 struct psp_firmware_header_v1_1 psp_v1_1;
314 struct psp_firmware_header_v1_3 psp_v1_3;
315 struct ta_firmware_header_v1_0 ta;
316 struct ta_firmware_header_v2_0 ta_v2_0;
317 struct gfx_firmware_header_v1_0 gfx;
318 struct rlc_firmware_header_v1_0 rlc;
319 struct rlc_firmware_header_v2_0 rlc_v2_0;
320 struct rlc_firmware_header_v2_1 rlc_v2_1;
321 struct sdma_firmware_header_v1_0 sdma;
322 struct sdma_firmware_header_v1_1 sdma_v1_1;
323 struct gpu_info_firmware_header_v1_0 gpu_info;
324 struct dmcu_firmware_header_v1_0 dmcu;
325 struct dmcub_firmware_header_v1_0 dmcub;
326 uint8_t raw[0x100];
327};
328
329#define UCODE_MAX_TA_PACKAGING ((sizeof(union amdgpu_firmware_header) - sizeof(struct common_firmware_header) - 4) / sizeof(struct ta_fw_bin_desc))
330
331/*
332 * fw loading support
333 */
334enum AMDGPU_UCODE_ID {
335 AMDGPU_UCODE_ID_SDMA0 = 0,
336 AMDGPU_UCODE_ID_SDMA1,
337 AMDGPU_UCODE_ID_SDMA2,
338 AMDGPU_UCODE_ID_SDMA3,
339 AMDGPU_UCODE_ID_SDMA4,
340 AMDGPU_UCODE_ID_SDMA5,
341 AMDGPU_UCODE_ID_SDMA6,
342 AMDGPU_UCODE_ID_SDMA7,
343 AMDGPU_UCODE_ID_CP_CE,
344 AMDGPU_UCODE_ID_CP_PFP,
345 AMDGPU_UCODE_ID_CP_ME,
346 AMDGPU_UCODE_ID_CP_MEC1,
347 AMDGPU_UCODE_ID_CP_MEC1_JT,
348 AMDGPU_UCODE_ID_CP_MEC2,
349 AMDGPU_UCODE_ID_CP_MEC2_JT,
350 AMDGPU_UCODE_ID_CP_MES,
351 AMDGPU_UCODE_ID_CP_MES_DATA,
352 AMDGPU_UCODE_ID_RLC_RESTORE_LIST_CNTL,
353 AMDGPU_UCODE_ID_RLC_RESTORE_LIST_GPM_MEM,
354 AMDGPU_UCODE_ID_RLC_RESTORE_LIST_SRM_MEM,
355 AMDGPU_UCODE_ID_RLC_IRAM,
356 AMDGPU_UCODE_ID_RLC_DRAM,
357 AMDGPU_UCODE_ID_RLC_G,
358 AMDGPU_UCODE_ID_STORAGE,
359 AMDGPU_UCODE_ID_SMC,
360 AMDGPU_UCODE_ID_UVD,
361 AMDGPU_UCODE_ID_UVD1,
362 AMDGPU_UCODE_ID_VCE,
363 AMDGPU_UCODE_ID_VCN,
364 AMDGPU_UCODE_ID_VCN1,
365 AMDGPU_UCODE_ID_DMCU_ERAM,
366 AMDGPU_UCODE_ID_DMCU_INTV,
367 AMDGPU_UCODE_ID_VCN0_RAM,
368 AMDGPU_UCODE_ID_VCN1_RAM,
369 AMDGPU_UCODE_ID_DMCUB,
370 AMDGPU_UCODE_ID_MAXIMUM,
371};
372
373/* engine firmware status */
374enum AMDGPU_UCODE_STATUS {
375 AMDGPU_UCODE_STATUS_INVALID,
376 AMDGPU_UCODE_STATUS_NOT_LOADED,
377 AMDGPU_UCODE_STATUS_LOADED,
378};
379
380enum amdgpu_firmware_load_type {
381 AMDGPU_FW_LOAD_DIRECT = 0,
382 AMDGPU_FW_LOAD_SMU,
383 AMDGPU_FW_LOAD_PSP,
384 AMDGPU_FW_LOAD_RLC_BACKDOOR_AUTO,
385};
386
387/* conform to smu_ucode_xfer_cz.h */
388#define AMDGPU_SDMA0_UCODE_LOADED 0x00000001
389#define AMDGPU_SDMA1_UCODE_LOADED 0x00000002
390#define AMDGPU_CPCE_UCODE_LOADED 0x00000004
391#define AMDGPU_CPPFP_UCODE_LOADED 0x00000008
392#define AMDGPU_CPME_UCODE_LOADED 0x00000010
393#define AMDGPU_CPMEC1_UCODE_LOADED 0x00000020
394#define AMDGPU_CPMEC2_UCODE_LOADED 0x00000040
395#define AMDGPU_CPRLC_UCODE_LOADED 0x00000100
396
397/* amdgpu firmware info */
398struct amdgpu_firmware_info {
399 /* ucode ID */
400 enum AMDGPU_UCODE_ID ucode_id;
401 /* request_firmware */
402 const struct firmware *fw;
403 /* starting mc address */
404 uint64_t mc_addr;
405 /* kernel linear address */
406 void *kaddr;
407 /* ucode_size_bytes */
408 uint32_t ucode_size;
409 /* starting tmr mc address */
410 uint32_t tmr_mc_addr_lo;
411 uint32_t tmr_mc_addr_hi;
412};
413
414struct amdgpu_firmware {
415 struct amdgpu_firmware_info ucode[AMDGPU_UCODE_ID_MAXIMUM];
416 enum amdgpu_firmware_load_type load_type;
417 struct amdgpu_bo *fw_buf;
418 unsigned int fw_size;
419 unsigned int max_ucodes;
420 /* firmwares are loaded by psp instead of smu from vega10 */
421 const struct amdgpu_psp_funcs *funcs;
422 struct amdgpu_bo *rbuf;
423 struct mutex mutex;
424
425 /* gpu info firmware data pointer */
426 const struct firmware *gpu_info_fw;
427
428 void *fw_buf_ptr;
429 uint64_t fw_buf_mc;
430};
431
432void amdgpu_ucode_print_mc_hdr(const struct common_firmware_header *hdr);
433void amdgpu_ucode_print_smc_hdr(const struct common_firmware_header *hdr);
434void amdgpu_ucode_print_gfx_hdr(const struct common_firmware_header *hdr);
435void amdgpu_ucode_print_rlc_hdr(const struct common_firmware_header *hdr);
436void amdgpu_ucode_print_sdma_hdr(const struct common_firmware_header *hdr);
437void amdgpu_ucode_print_psp_hdr(const struct common_firmware_header *hdr);
438void amdgpu_ucode_print_gpu_info_hdr(const struct common_firmware_header *hdr);
439int amdgpu_ucode_validate(const struct firmware *fw);
440bool amdgpu_ucode_hdr_version(union amdgpu_firmware_header *hdr,
441 uint16_t hdr_major, uint16_t hdr_minor);
442
443int amdgpu_ucode_init_bo(struct amdgpu_device *adev);
444int amdgpu_ucode_create_bo(struct amdgpu_device *adev);
445int amdgpu_ucode_sysfs_init(struct amdgpu_device *adev);
446void amdgpu_ucode_free_bo(struct amdgpu_device *adev);
447void amdgpu_ucode_sysfs_fini(struct amdgpu_device *adev);
448
449enum amdgpu_firmware_load_type
450amdgpu_ucode_get_load_type(struct amdgpu_device *adev, int load_type);
451
452#endif