2 * Copyright 2016 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
25 #ifndef __AMDGPU_PSP_H__
26 #define __AMDGPU_PSP_H__
29 #include "psp_gfx_if.h"
30 #include "ta_xgmi_if.h"
31 #include "ta_ras_if.h"
32 #include "ta_rap_if.h"
33 #include "ta_secureDisplay_if.h"
35 #define PSP_FENCE_BUFFER_SIZE 0x1000
36 #define PSP_CMD_BUFFER_SIZE 0x1000
37 #define PSP_1_MEG 0x100000
38 #define PSP_TMR_SIZE(adev) ((adev)->asic_type == CHIP_ALDEBARAN ? 0x800000 : 0x400000)
39 #define PSP_TMR_ALIGNMENT 0x100000
40 #define PSP_FW_NAME_LEN 0x24
42 extern const struct attribute_group amdgpu_flash_attr_group;
44 enum psp_shared_mem_size {
45 PSP_ASD_SHARED_MEM_SIZE = 0x0,
46 PSP_XGMI_SHARED_MEM_SIZE = 0x4000,
47 PSP_RAS_SHARED_MEM_SIZE = 0x4000,
48 PSP_HDCP_SHARED_MEM_SIZE = 0x4000,
49 PSP_DTM_SHARED_MEM_SIZE = 0x4000,
50 PSP_RAP_SHARED_MEM_SIZE = 0x4000,
51 PSP_SECUREDISPLAY_SHARED_MEM_SIZE = 0x4000,
60 TA_TYPE_SECUREDISPLAY,
66 struct psp_xgmi_node_info;
67 struct psp_xgmi_topology_info;
70 enum psp_bootloader_cmd {
71 PSP_BL__LOAD_SYSDRV = 0x10000,
72 PSP_BL__LOAD_SOSDRV = 0x20000,
73 PSP_BL__LOAD_KEY_DATABASE = 0x80000,
74 PSP_BL__LOAD_SOCDRV = 0xB0000,
75 PSP_BL__LOAD_DBGDRV = 0xC0000,
76 PSP_BL__LOAD_INTFDRV = 0xD0000,
77 PSP_BL__LOAD_RASDRV = 0xE0000,
78 PSP_BL__DRAM_LONG_TRAIN = 0x100000,
79 PSP_BL__DRAM_SHORT_TRAIN = 0x200000,
80 PSP_BL__LOAD_TOS_SPL_TABLE = 0x10000000,
84 PSP_RING_TYPE__INVALID = 0,
86 * These values map to the way the PSP kernel identifies the
89 PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
90 PSP_RING_TYPE__KM = 2 /* Kernel mode ring (formerly called GPCOM) */
94 enum psp_ring_type ring_type;
95 struct psp_gfx_rb_frame *ring_mem;
96 uint64_t ring_mem_mc_addr;
97 void *ring_mem_handle;
102 /* More registers may will be supported */
103 enum psp_reg_prog_id {
104 PSP_REG_IH_RB_CNTL = 0, /* register IH_RB_CNTL */
105 PSP_REG_IH_RB_CNTL_RING1 = 1, /* register IH_RB_CNTL_RING1 */
106 PSP_REG_IH_RB_CNTL_RING2 = 2, /* register IH_RB_CNTL_RING2 */
111 int (*init_microcode)(struct psp_context *psp);
112 int (*wait_for_bootloader)(struct psp_context *psp);
113 int (*bootloader_load_kdb)(struct psp_context *psp);
114 int (*bootloader_load_spl)(struct psp_context *psp);
115 int (*bootloader_load_sysdrv)(struct psp_context *psp);
116 int (*bootloader_load_soc_drv)(struct psp_context *psp);
117 int (*bootloader_load_intf_drv)(struct psp_context *psp);
118 int (*bootloader_load_dbg_drv)(struct psp_context *psp);
119 int (*bootloader_load_ras_drv)(struct psp_context *psp);
120 int (*bootloader_load_sos)(struct psp_context *psp);
121 int (*ring_create)(struct psp_context *psp,
122 enum psp_ring_type ring_type);
123 int (*ring_stop)(struct psp_context *psp,
124 enum psp_ring_type ring_type);
125 int (*ring_destroy)(struct psp_context *psp,
126 enum psp_ring_type ring_type);
127 bool (*smu_reload_quirk)(struct psp_context *psp);
128 int (*mode1_reset)(struct psp_context *psp);
129 int (*mem_training)(struct psp_context *psp, uint32_t ops);
130 uint32_t (*ring_get_wptr)(struct psp_context *psp);
131 void (*ring_set_wptr)(struct psp_context *psp, uint32_t value);
132 int (*load_usbc_pd_fw)(struct psp_context *psp, uint64_t fw_pri_mc_addr);
133 int (*read_usbc_pd_fw)(struct psp_context *psp, uint32_t *fw_ver);
134 int (*update_spirom)(struct psp_context *psp, uint64_t fw_pri_mc_addr);
135 int (*vbflash_stat)(struct psp_context *psp);
136 int (*fatal_error_recovery_quirk)(struct psp_context *psp);
140 int (*fn_ta_initialize)(struct psp_context *psp);
141 int (*fn_ta_invoke)(struct psp_context *psp, uint32_t ta_cmd_id);
142 int (*fn_ta_terminate)(struct psp_context *psp);
145 #define AMDGPU_XGMI_MAX_CONNECTED_NODES 64
146 struct psp_xgmi_node_info {
149 uint8_t is_sharing_enabled;
150 enum ta_xgmi_assigned_sdma_engine sdma_engine;
154 struct psp_xgmi_topology_info {
156 struct psp_xgmi_node_info nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
159 struct psp_bin_desc {
161 uint32_t feature_version;
166 struct ta_mem_context {
167 struct amdgpu_bo *shared_bo;
168 uint64_t shared_mc_addr;
170 enum psp_shared_mem_size shared_mem_size;
176 uint32_t resp_status;
177 struct ta_mem_context mem_context;
178 struct psp_bin_desc bin_desc;
179 enum psp_gfx_cmd_id ta_load_type;
180 enum ta_type_id ta_type;
183 struct ta_cp_context {
184 struct ta_context context;
188 struct psp_xgmi_context {
189 struct ta_context context;
190 struct psp_xgmi_topology_info top_info;
191 bool supports_extended_data;
194 struct psp_ras_context {
195 struct ta_context context;
196 struct amdgpu_ras *ras;
199 #define MEM_TRAIN_SYSTEM_SIGNATURE 0x54534942
200 #define GDDR6_MEM_TRAINING_DATA_SIZE_IN_BYTES 0x1000
201 #define GDDR6_MEM_TRAINING_OFFSET 0x8000
202 /*Define the VRAM size that will be encroached by BIST training.*/
203 #define GDDR6_MEM_TRAINING_ENCROACHED_SIZE 0x2000000
205 enum psp_memory_training_init_flag {
206 PSP_MEM_TRAIN_NOT_SUPPORT = 0x0,
207 PSP_MEM_TRAIN_SUPPORT = 0x1,
208 PSP_MEM_TRAIN_INIT_FAILED = 0x2,
209 PSP_MEM_TRAIN_RESERVE_SUCCESS = 0x4,
210 PSP_MEM_TRAIN_INIT_SUCCESS = 0x8,
213 enum psp_memory_training_ops {
214 PSP_MEM_TRAIN_SEND_LONG_MSG = 0x1,
215 PSP_MEM_TRAIN_SAVE = 0x2,
216 PSP_MEM_TRAIN_RESTORE = 0x4,
217 PSP_MEM_TRAIN_SEND_SHORT_MSG = 0x8,
218 PSP_MEM_TRAIN_COLD_BOOT = PSP_MEM_TRAIN_SEND_LONG_MSG,
219 PSP_MEM_TRAIN_RESUME = PSP_MEM_TRAIN_SEND_SHORT_MSG,
222 struct psp_memory_training_context {
223 /*training data size*/
227 * cpu virtual address
228 * system memory buffer that used to store the training data.
232 /*vram offset of the p2c training data*/
233 u64 p2c_train_data_offset;
235 /*vram offset of the c2p training data*/
236 u64 c2p_train_data_offset;
237 struct amdgpu_bo *c2p_bo;
239 enum psp_memory_training_init_flag init;
241 bool enable_mem_training;
244 /** PSP runtime DB **/
245 #define PSP_RUNTIME_DB_SIZE_IN_BYTES 0x10000
246 #define PSP_RUNTIME_DB_OFFSET 0x100000
247 #define PSP_RUNTIME_DB_COOKIE_ID 0x0ed5
248 #define PSP_RUNTIME_DB_VER_1 0x0100
249 #define PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT 0x40
251 enum psp_runtime_entry_type {
252 PSP_RUNTIME_ENTRY_TYPE_INVALID = 0x0,
253 PSP_RUNTIME_ENTRY_TYPE_TEST = 0x1,
254 PSP_RUNTIME_ENTRY_TYPE_MGPU_COMMON = 0x2, /* Common mGPU runtime data */
255 PSP_RUNTIME_ENTRY_TYPE_MGPU_WAFL = 0x3, /* WAFL runtime data */
256 PSP_RUNTIME_ENTRY_TYPE_MGPU_XGMI = 0x4, /* XGMI runtime data */
257 PSP_RUNTIME_ENTRY_TYPE_BOOT_CONFIG = 0x5, /* Boot Config runtime data */
258 PSP_RUNTIME_ENTRY_TYPE_PPTABLE_ERR_STATUS = 0x6, /* SCPM validation data */
261 /* PSP runtime DB header */
262 struct psp_runtime_data_header {
263 /* determine the existence of runtime db */
265 /* version of runtime db */
269 /* PSP runtime DB entry */
270 struct psp_runtime_entry {
271 /* type of runtime db entry */
273 /* offset of entry in bytes */
275 /* size of entry in bytes */
279 /* PSP runtime DB directory */
280 struct psp_runtime_data_directory {
281 /* number of valid entries */
282 uint16_t entry_count;
284 struct psp_runtime_entry entry_list[PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT];
287 /* PSP runtime DB boot config feature bitmask */
288 enum psp_runtime_boot_cfg_feature {
289 BOOT_CFG_FEATURE_GECC = 0x1,
290 BOOT_CFG_FEATURE_TWO_STAGE_DRAM_TRAINING = 0x2,
293 /* PSP run time DB SCPM authentication defines */
294 enum psp_runtime_scpm_authentication {
297 SCPM_ENABLE_WITH_SCPM_ERR = 0x2,
300 /* PSP runtime DB boot config entry */
301 struct psp_runtime_boot_cfg_entry {
302 uint32_t boot_cfg_bitmask;
306 /* PSP runtime DB SCPM entry */
307 struct psp_runtime_scpm_entry {
308 enum psp_runtime_scpm_authentication scpm_status;
312 struct amdgpu_device *adev;
313 struct psp_ring km_ring;
314 struct psp_gfx_cmd_resp *cmd;
316 const struct psp_funcs *funcs;
317 const struct ta_funcs *ta_funcs;
319 /* firmware buffer */
320 struct amdgpu_bo *fw_pri_bo;
321 uint64_t fw_pri_mc_addr;
325 const struct firmware *sos_fw;
326 struct psp_bin_desc sys;
327 struct psp_bin_desc sos;
328 struct psp_bin_desc toc;
329 struct psp_bin_desc kdb;
330 struct psp_bin_desc spl;
331 struct psp_bin_desc rl;
332 struct psp_bin_desc soc_drv;
333 struct psp_bin_desc intf_drv;
334 struct psp_bin_desc dbg_drv;
335 struct psp_bin_desc ras_drv;
338 struct amdgpu_bo *tmr_bo;
339 uint64_t tmr_mc_addr;
342 const struct firmware *asd_fw;
345 const struct firmware *toc_fw;
348 const struct firmware *cap_fw;
351 struct amdgpu_bo *fence_buf_bo;
352 uint64_t fence_buf_mc_addr;
356 struct amdgpu_bo *cmd_buf_bo;
357 uint64_t cmd_buf_mc_addr;
358 struct psp_gfx_cmd_resp *cmd_buf_mem;
360 /* fence value associated with cmd buffer */
361 atomic_t fence_value;
362 /* flag to mark whether gfx fw autoload is supported or not */
363 bool autoload_supported;
364 /* flag to mark whether df cstate management centralized to PMFW */
365 bool pmfw_centralized_cstate_management;
367 /* xgmi ta firmware and buffer */
368 const struct firmware *ta_fw;
369 uint32_t ta_fw_version;
371 uint32_t cap_fw_version;
372 uint32_t cap_feature_version;
373 uint32_t cap_ucode_size;
375 struct ta_context asd_context;
376 struct psp_xgmi_context xgmi_context;
377 struct psp_ras_context ras_context;
378 struct ta_cp_context hdcp_context;
379 struct ta_cp_context dtm_context;
380 struct ta_cp_context rap_context;
381 struct ta_cp_context securedisplay_context;
383 struct psp_memory_training_context mem_train_ctx;
385 uint32_t boot_cfg_bitmask;
387 /* firmware upgrades supported */
391 char *vbflash_tmp_buf;
392 size_t vbflash_image_size;
396 struct amdgpu_psp_funcs {
397 bool (*check_fw_loading_status)(struct amdgpu_device *adev,
398 enum AMDGPU_UCODE_ID);
402 #define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
403 #define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
404 #define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
405 #define psp_init_microcode(psp) \
406 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
407 #define psp_bootloader_load_kdb(psp) \
408 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
409 #define psp_bootloader_load_spl(psp) \
410 ((psp)->funcs->bootloader_load_spl ? (psp)->funcs->bootloader_load_spl((psp)) : 0)
411 #define psp_bootloader_load_sysdrv(psp) \
412 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
413 #define psp_bootloader_load_soc_drv(psp) \
414 ((psp)->funcs->bootloader_load_soc_drv ? (psp)->funcs->bootloader_load_soc_drv((psp)) : 0)
415 #define psp_bootloader_load_intf_drv(psp) \
416 ((psp)->funcs->bootloader_load_intf_drv ? (psp)->funcs->bootloader_load_intf_drv((psp)) : 0)
417 #define psp_bootloader_load_dbg_drv(psp) \
418 ((psp)->funcs->bootloader_load_dbg_drv ? (psp)->funcs->bootloader_load_dbg_drv((psp)) : 0)
419 #define psp_bootloader_load_ras_drv(psp) \
420 ((psp)->funcs->bootloader_load_ras_drv ? \
421 (psp)->funcs->bootloader_load_ras_drv((psp)) : 0)
422 #define psp_bootloader_load_sos(psp) \
423 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
424 #define psp_smu_reload_quirk(psp) \
425 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
426 #define psp_mode1_reset(psp) \
427 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
428 #define psp_mem_training(psp, ops) \
429 ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
431 #define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
432 #define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
434 #define psp_load_usbc_pd_fw(psp, fw_pri_mc_addr) \
435 ((psp)->funcs->load_usbc_pd_fw ? \
436 (psp)->funcs->load_usbc_pd_fw((psp), (fw_pri_mc_addr)) : -EINVAL)
438 #define psp_read_usbc_pd_fw(psp, fw_ver) \
439 ((psp)->funcs->read_usbc_pd_fw ? \
440 (psp)->funcs->read_usbc_pd_fw((psp), fw_ver) : -EINVAL)
442 #define psp_update_spirom(psp, fw_pri_mc_addr) \
443 ((psp)->funcs->update_spirom ? \
444 (psp)->funcs->update_spirom((psp), fw_pri_mc_addr) : -EINVAL)
446 #define psp_vbflash_status(psp) \
447 ((psp)->funcs->vbflash_stat ? \
448 (psp)->funcs->vbflash_stat((psp)) : -EINVAL)
450 #define psp_fatal_error_recovery_quirk(psp) \
451 ((psp)->funcs->fatal_error_recovery_quirk ? \
452 (psp)->funcs->fatal_error_recovery_quirk((psp)) : 0)
454 extern const struct amd_ip_funcs psp_ip_funcs;
456 extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
457 extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
458 extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
459 extern const struct amdgpu_ip_block_version psp_v11_0_8_ip_block;
460 extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
461 extern const struct amdgpu_ip_block_version psp_v13_0_ip_block;
462 extern const struct amdgpu_ip_block_version psp_v13_0_4_ip_block;
464 extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
465 uint32_t field_val, uint32_t mask, bool check_changed);
466 extern int psp_wait_for_spirom_update(struct psp_context *psp, uint32_t reg_index,
467 uint32_t field_val, uint32_t mask, uint32_t msec_timeout);
469 int psp_execute_ip_fw_load(struct psp_context *psp,
470 struct amdgpu_firmware_info *ucode);
472 int psp_gpu_reset(struct amdgpu_device *adev);
474 int psp_ta_init_shared_buf(struct psp_context *psp,
475 struct ta_mem_context *mem_ctx);
476 void psp_ta_free_shared_buf(struct ta_mem_context *mem_ctx);
477 int psp_ta_unload(struct psp_context *psp, struct ta_context *context);
478 int psp_ta_load(struct psp_context *psp, struct ta_context *context);
479 int psp_ta_invoke(struct psp_context *psp,
481 struct ta_context *context);
483 int psp_xgmi_initialize(struct psp_context *psp, bool set_extended_data, bool load_ta);
484 int psp_xgmi_terminate(struct psp_context *psp);
485 int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
486 int psp_xgmi_get_hive_id(struct psp_context *psp, uint64_t *hive_id);
487 int psp_xgmi_get_node_id(struct psp_context *psp, uint64_t *node_id);
488 int psp_xgmi_get_topology_info(struct psp_context *psp,
490 struct psp_xgmi_topology_info *topology,
491 bool get_extended_data);
492 int psp_xgmi_set_topology_info(struct psp_context *psp,
494 struct psp_xgmi_topology_info *topology);
495 int psp_ras_initialize(struct psp_context *psp);
496 int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
497 int psp_ras_enable_features(struct psp_context *psp,
498 union ta_ras_cmd_input *info, bool enable);
499 int psp_ras_trigger_error(struct psp_context *psp,
500 struct ta_ras_trigger_error_input *info, uint32_t instance_mask);
501 int psp_ras_terminate(struct psp_context *psp);
503 int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
504 int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
505 int psp_rap_invoke(struct psp_context *psp, uint32_t ta_cmd_id, enum ta_rap_status *status);
506 int psp_securedisplay_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
508 int psp_rlc_autoload_start(struct psp_context *psp);
510 int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
512 int psp_ring_cmd_submit(struct psp_context *psp,
513 uint64_t cmd_buf_mc_addr,
514 uint64_t fence_mc_addr,
516 int psp_init_asd_microcode(struct psp_context *psp,
517 const char *chip_name);
518 int psp_init_toc_microcode(struct psp_context *psp,
519 const char *chip_name);
520 int psp_init_sos_microcode(struct psp_context *psp,
521 const char *chip_name);
522 int psp_init_ta_microcode(struct psp_context *psp,
523 const char *chip_name);
524 int psp_init_cap_microcode(struct psp_context *psp,
525 const char *chip_name);
526 int psp_get_fw_attestation_records_addr(struct psp_context *psp,
527 uint64_t *output_ptr);
529 int psp_load_fw_list(struct psp_context *psp,
530 struct amdgpu_firmware_info **ucode_list, int ucode_count);
531 void psp_copy_fw(struct psp_context *psp, uint8_t *start_addr, uint32_t bin_size);
533 int psp_spatial_partition(struct psp_context *psp, int mode);
535 int is_psp_fw_valid(struct psp_bin_desc bin);
537 int amdgpu_psp_wait_for_bootloader(struct amdgpu_device *adev);