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_HADDRV = PSP_BL__LOAD_DBGDRV,
77 PSP_BL__LOAD_INTFDRV = 0xD0000,
78 PSP_BL__LOAD_RASDRV = 0xE0000,
79 PSP_BL__LOAD_IPKEYMGRDRV = 0xF0000,
80 PSP_BL__DRAM_LONG_TRAIN = 0x100000,
81 PSP_BL__DRAM_SHORT_TRAIN = 0x200000,
82 PSP_BL__LOAD_TOS_SPL_TABLE = 0x10000000,
86 PSP_RING_TYPE__INVALID = 0,
88 * These values map to the way the PSP kernel identifies the
91 PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
92 PSP_RING_TYPE__KM = 2 /* Kernel mode ring (formerly called GPCOM) */
96 enum psp_ring_type ring_type;
97 struct psp_gfx_rb_frame *ring_mem;
98 uint64_t ring_mem_mc_addr;
99 void *ring_mem_handle;
104 /* More registers may will be supported */
105 enum psp_reg_prog_id {
106 PSP_REG_IH_RB_CNTL = 0, /* register IH_RB_CNTL */
107 PSP_REG_IH_RB_CNTL_RING1 = 1, /* register IH_RB_CNTL_RING1 */
108 PSP_REG_IH_RB_CNTL_RING2 = 2, /* register IH_RB_CNTL_RING2 */
113 int (*init_microcode)(struct psp_context *psp);
114 int (*wait_for_bootloader)(struct psp_context *psp);
115 int (*bootloader_load_kdb)(struct psp_context *psp);
116 int (*bootloader_load_spl)(struct psp_context *psp);
117 int (*bootloader_load_sysdrv)(struct psp_context *psp);
118 int (*bootloader_load_soc_drv)(struct psp_context *psp);
119 int (*bootloader_load_intf_drv)(struct psp_context *psp);
120 int (*bootloader_load_dbg_drv)(struct psp_context *psp);
121 int (*bootloader_load_ras_drv)(struct psp_context *psp);
122 int (*bootloader_load_ipkeymgr_drv)(struct psp_context *psp);
123 int (*bootloader_load_sos)(struct psp_context *psp);
124 int (*ring_create)(struct psp_context *psp,
125 enum psp_ring_type ring_type);
126 int (*ring_stop)(struct psp_context *psp,
127 enum psp_ring_type ring_type);
128 int (*ring_destroy)(struct psp_context *psp,
129 enum psp_ring_type ring_type);
130 bool (*smu_reload_quirk)(struct psp_context *psp);
131 int (*mode1_reset)(struct psp_context *psp);
132 int (*mem_training)(struct psp_context *psp, uint32_t ops);
133 uint32_t (*ring_get_wptr)(struct psp_context *psp);
134 void (*ring_set_wptr)(struct psp_context *psp, uint32_t value);
135 int (*load_usbc_pd_fw)(struct psp_context *psp, uint64_t fw_pri_mc_addr);
136 int (*read_usbc_pd_fw)(struct psp_context *psp, uint32_t *fw_ver);
137 int (*update_spirom)(struct psp_context *psp, uint64_t fw_pri_mc_addr);
138 int (*vbflash_stat)(struct psp_context *psp);
139 int (*fatal_error_recovery_quirk)(struct psp_context *psp);
140 bool (*get_ras_capability)(struct psp_context *psp);
144 int (*fn_ta_initialize)(struct psp_context *psp);
145 int (*fn_ta_invoke)(struct psp_context *psp, uint32_t ta_cmd_id);
146 int (*fn_ta_terminate)(struct psp_context *psp);
149 #define AMDGPU_XGMI_MAX_CONNECTED_NODES 64
150 struct psp_xgmi_node_info {
153 uint8_t is_sharing_enabled;
154 enum ta_xgmi_assigned_sdma_engine sdma_engine;
156 struct xgmi_connected_port_num port_num[TA_XGMI__MAX_PORT_NUM];
159 struct psp_xgmi_topology_info {
161 struct psp_xgmi_node_info nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
164 struct psp_bin_desc {
166 uint32_t feature_version;
171 struct ta_mem_context {
172 struct amdgpu_bo *shared_bo;
173 uint64_t shared_mc_addr;
175 enum psp_shared_mem_size shared_mem_size;
181 uint32_t resp_status;
182 struct ta_mem_context mem_context;
183 struct psp_bin_desc bin_desc;
184 enum psp_gfx_cmd_id ta_load_type;
185 enum ta_type_id ta_type;
188 struct ta_cp_context {
189 struct ta_context context;
193 struct psp_xgmi_context {
194 struct ta_context context;
195 struct psp_xgmi_topology_info top_info;
196 bool supports_extended_data;
197 uint8_t xgmi_ta_caps;
200 struct psp_ras_context {
201 struct ta_context context;
202 struct amdgpu_ras *ras;
206 #define MEM_TRAIN_SYSTEM_SIGNATURE 0x54534942
207 #define GDDR6_MEM_TRAINING_DATA_SIZE_IN_BYTES 0x1000
208 #define GDDR6_MEM_TRAINING_OFFSET 0x8000
209 /*Define the VRAM size that will be encroached by BIST training.*/
210 #define BIST_MEM_TRAINING_ENCROACHED_SIZE 0x2000000
212 enum psp_memory_training_init_flag {
213 PSP_MEM_TRAIN_NOT_SUPPORT = 0x0,
214 PSP_MEM_TRAIN_SUPPORT = 0x1,
215 PSP_MEM_TRAIN_INIT_FAILED = 0x2,
216 PSP_MEM_TRAIN_RESERVE_SUCCESS = 0x4,
217 PSP_MEM_TRAIN_INIT_SUCCESS = 0x8,
220 enum psp_memory_training_ops {
221 PSP_MEM_TRAIN_SEND_LONG_MSG = 0x1,
222 PSP_MEM_TRAIN_SAVE = 0x2,
223 PSP_MEM_TRAIN_RESTORE = 0x4,
224 PSP_MEM_TRAIN_SEND_SHORT_MSG = 0x8,
225 PSP_MEM_TRAIN_COLD_BOOT = PSP_MEM_TRAIN_SEND_LONG_MSG,
226 PSP_MEM_TRAIN_RESUME = PSP_MEM_TRAIN_SEND_SHORT_MSG,
229 struct psp_memory_training_context {
230 /*training data size*/
234 * cpu virtual address
235 * system memory buffer that used to store the training data.
239 /*vram offset of the p2c training data*/
240 u64 p2c_train_data_offset;
242 /*vram offset of the c2p training data*/
243 u64 c2p_train_data_offset;
244 struct amdgpu_bo *c2p_bo;
246 enum psp_memory_training_init_flag init;
248 bool enable_mem_training;
251 /** PSP runtime DB **/
252 #define PSP_RUNTIME_DB_SIZE_IN_BYTES 0x10000
253 #define PSP_RUNTIME_DB_OFFSET 0x100000
254 #define PSP_RUNTIME_DB_COOKIE_ID 0x0ed5
255 #define PSP_RUNTIME_DB_VER_1 0x0100
256 #define PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT 0x40
258 enum psp_runtime_entry_type {
259 PSP_RUNTIME_ENTRY_TYPE_INVALID = 0x0,
260 PSP_RUNTIME_ENTRY_TYPE_TEST = 0x1,
261 PSP_RUNTIME_ENTRY_TYPE_MGPU_COMMON = 0x2, /* Common mGPU runtime data */
262 PSP_RUNTIME_ENTRY_TYPE_MGPU_WAFL = 0x3, /* WAFL runtime data */
263 PSP_RUNTIME_ENTRY_TYPE_MGPU_XGMI = 0x4, /* XGMI runtime data */
264 PSP_RUNTIME_ENTRY_TYPE_BOOT_CONFIG = 0x5, /* Boot Config runtime data */
265 PSP_RUNTIME_ENTRY_TYPE_PPTABLE_ERR_STATUS = 0x6, /* SCPM validation data */
268 /* PSP runtime DB header */
269 struct psp_runtime_data_header {
270 /* determine the existence of runtime db */
272 /* version of runtime db */
276 /* PSP runtime DB entry */
277 struct psp_runtime_entry {
278 /* type of runtime db entry */
280 /* offset of entry in bytes */
282 /* size of entry in bytes */
286 /* PSP runtime DB directory */
287 struct psp_runtime_data_directory {
288 /* number of valid entries */
289 uint16_t entry_count;
291 struct psp_runtime_entry entry_list[PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT];
294 /* PSP runtime DB boot config feature bitmask */
295 enum psp_runtime_boot_cfg_feature {
296 BOOT_CFG_FEATURE_GECC = 0x1,
297 BOOT_CFG_FEATURE_TWO_STAGE_DRAM_TRAINING = 0x2,
300 /* PSP run time DB SCPM authentication defines */
301 enum psp_runtime_scpm_authentication {
304 SCPM_ENABLE_WITH_SCPM_ERR = 0x2,
307 /* PSP runtime DB boot config entry */
308 struct psp_runtime_boot_cfg_entry {
309 uint32_t boot_cfg_bitmask;
313 /* PSP runtime DB SCPM entry */
314 struct psp_runtime_scpm_entry {
315 enum psp_runtime_scpm_authentication scpm_status;
319 struct amdgpu_device *adev;
320 struct psp_ring km_ring;
321 struct psp_gfx_cmd_resp *cmd;
323 const struct psp_funcs *funcs;
324 const struct ta_funcs *ta_funcs;
326 /* firmware buffer */
327 struct amdgpu_bo *fw_pri_bo;
328 uint64_t fw_pri_mc_addr;
332 const struct firmware *sos_fw;
333 struct psp_bin_desc sys;
334 struct psp_bin_desc sos;
335 struct psp_bin_desc toc;
336 struct psp_bin_desc kdb;
337 struct psp_bin_desc spl;
338 struct psp_bin_desc rl;
339 struct psp_bin_desc soc_drv;
340 struct psp_bin_desc intf_drv;
341 struct psp_bin_desc dbg_drv;
342 struct psp_bin_desc ras_drv;
343 struct psp_bin_desc ipkeymgr_drv;
346 struct amdgpu_bo *tmr_bo;
347 uint64_t tmr_mc_addr;
350 const struct firmware *asd_fw;
353 const struct firmware *toc_fw;
356 const struct firmware *cap_fw;
359 struct amdgpu_bo *fence_buf_bo;
360 uint64_t fence_buf_mc_addr;
364 struct amdgpu_bo *cmd_buf_bo;
365 uint64_t cmd_buf_mc_addr;
366 struct psp_gfx_cmd_resp *cmd_buf_mem;
368 /* fence value associated with cmd buffer */
369 atomic_t fence_value;
370 /* flag to mark whether gfx fw autoload is supported or not */
371 bool autoload_supported;
372 /* flag to mark whether psp use runtime TMR or boottime TMR */
374 /* flag to mark whether df cstate management centralized to PMFW */
375 bool pmfw_centralized_cstate_management;
377 /* xgmi ta firmware and buffer */
378 const struct firmware *ta_fw;
379 uint32_t ta_fw_version;
381 uint32_t cap_fw_version;
382 uint32_t cap_feature_version;
383 uint32_t cap_ucode_size;
385 struct ta_context asd_context;
386 struct psp_xgmi_context xgmi_context;
387 struct psp_ras_context ras_context;
388 struct ta_cp_context hdcp_context;
389 struct ta_cp_context dtm_context;
390 struct ta_cp_context rap_context;
391 struct ta_cp_context securedisplay_context;
393 struct psp_memory_training_context mem_train_ctx;
395 uint32_t boot_cfg_bitmask;
397 /* firmware upgrades supported */
401 char *vbflash_tmp_buf;
402 size_t vbflash_image_size;
406 struct amdgpu_psp_funcs {
407 bool (*check_fw_loading_status)(struct amdgpu_device *adev,
408 enum AMDGPU_UCODE_ID);
412 #define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
413 #define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
414 #define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
415 #define psp_init_microcode(psp) \
416 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
417 #define psp_bootloader_load_kdb(psp) \
418 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
419 #define psp_bootloader_load_spl(psp) \
420 ((psp)->funcs->bootloader_load_spl ? (psp)->funcs->bootloader_load_spl((psp)) : 0)
421 #define psp_bootloader_load_sysdrv(psp) \
422 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
423 #define psp_bootloader_load_soc_drv(psp) \
424 ((psp)->funcs->bootloader_load_soc_drv ? (psp)->funcs->bootloader_load_soc_drv((psp)) : 0)
425 #define psp_bootloader_load_intf_drv(psp) \
426 ((psp)->funcs->bootloader_load_intf_drv ? (psp)->funcs->bootloader_load_intf_drv((psp)) : 0)
427 #define psp_bootloader_load_dbg_drv(psp) \
428 ((psp)->funcs->bootloader_load_dbg_drv ? (psp)->funcs->bootloader_load_dbg_drv((psp)) : 0)
429 #define psp_bootloader_load_ras_drv(psp) \
430 ((psp)->funcs->bootloader_load_ras_drv ? \
431 (psp)->funcs->bootloader_load_ras_drv((psp)) : 0)
432 #define psp_bootloader_load_ipkeymgr_drv(psp) \
433 ((psp)->funcs->bootloader_load_ipkeymgr_drv ? \
434 (psp)->funcs->bootloader_load_ipkeymgr_drv((psp)) : 0)
435 #define psp_bootloader_load_sos(psp) \
436 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
437 #define psp_smu_reload_quirk(psp) \
438 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
439 #define psp_mode1_reset(psp) \
440 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
441 #define psp_mem_training(psp, ops) \
442 ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
444 #define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
445 #define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
447 #define psp_load_usbc_pd_fw(psp, fw_pri_mc_addr) \
448 ((psp)->funcs->load_usbc_pd_fw ? \
449 (psp)->funcs->load_usbc_pd_fw((psp), (fw_pri_mc_addr)) : -EINVAL)
451 #define psp_read_usbc_pd_fw(psp, fw_ver) \
452 ((psp)->funcs->read_usbc_pd_fw ? \
453 (psp)->funcs->read_usbc_pd_fw((psp), fw_ver) : -EINVAL)
455 #define psp_update_spirom(psp, fw_pri_mc_addr) \
456 ((psp)->funcs->update_spirom ? \
457 (psp)->funcs->update_spirom((psp), fw_pri_mc_addr) : -EINVAL)
459 #define psp_vbflash_status(psp) \
460 ((psp)->funcs->vbflash_stat ? \
461 (psp)->funcs->vbflash_stat((psp)) : -EINVAL)
463 #define psp_fatal_error_recovery_quirk(psp) \
464 ((psp)->funcs->fatal_error_recovery_quirk ? \
465 (psp)->funcs->fatal_error_recovery_quirk((psp)) : 0)
467 extern const struct amd_ip_funcs psp_ip_funcs;
469 extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
470 extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
471 extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
472 extern const struct amdgpu_ip_block_version psp_v11_0_8_ip_block;
473 extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
474 extern const struct amdgpu_ip_block_version psp_v13_0_ip_block;
475 extern const struct amdgpu_ip_block_version psp_v13_0_4_ip_block;
476 extern const struct amdgpu_ip_block_version psp_v14_0_ip_block;
478 extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
479 uint32_t field_val, uint32_t mask, bool check_changed);
480 extern int psp_wait_for_spirom_update(struct psp_context *psp, uint32_t reg_index,
481 uint32_t field_val, uint32_t mask, uint32_t msec_timeout);
483 int psp_execute_ip_fw_load(struct psp_context *psp,
484 struct amdgpu_firmware_info *ucode);
486 int psp_gpu_reset(struct amdgpu_device *adev);
488 int psp_ta_init_shared_buf(struct psp_context *psp,
489 struct ta_mem_context *mem_ctx);
490 void psp_ta_free_shared_buf(struct ta_mem_context *mem_ctx);
491 int psp_ta_unload(struct psp_context *psp, struct ta_context *context);
492 int psp_ta_load(struct psp_context *psp, struct ta_context *context);
493 int psp_ta_invoke(struct psp_context *psp,
495 struct ta_context *context);
497 int psp_xgmi_initialize(struct psp_context *psp, bool set_extended_data, bool load_ta);
498 int psp_xgmi_terminate(struct psp_context *psp);
499 int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
500 int psp_xgmi_get_hive_id(struct psp_context *psp, uint64_t *hive_id);
501 int psp_xgmi_get_node_id(struct psp_context *psp, uint64_t *node_id);
502 int psp_xgmi_get_topology_info(struct psp_context *psp,
504 struct psp_xgmi_topology_info *topology,
505 bool get_extended_data);
506 int psp_xgmi_set_topology_info(struct psp_context *psp,
508 struct psp_xgmi_topology_info *topology);
509 int psp_ras_initialize(struct psp_context *psp);
510 int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
511 int psp_ras_enable_features(struct psp_context *psp,
512 union ta_ras_cmd_input *info, bool enable);
513 int psp_ras_trigger_error(struct psp_context *psp,
514 struct ta_ras_trigger_error_input *info, uint32_t instance_mask);
515 int psp_ras_terminate(struct psp_context *psp);
516 int psp_ras_query_address(struct psp_context *psp,
517 struct ta_ras_query_address_input *addr_in,
518 struct ta_ras_query_address_output *addr_out);
520 int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
521 int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
522 int psp_rap_invoke(struct psp_context *psp, uint32_t ta_cmd_id, enum ta_rap_status *status);
523 int psp_securedisplay_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
525 int psp_rlc_autoload_start(struct psp_context *psp);
527 int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
529 int psp_ring_cmd_submit(struct psp_context *psp,
530 uint64_t cmd_buf_mc_addr,
531 uint64_t fence_mc_addr,
533 int psp_init_asd_microcode(struct psp_context *psp,
534 const char *chip_name);
535 int psp_init_toc_microcode(struct psp_context *psp,
536 const char *chip_name);
537 int psp_init_sos_microcode(struct psp_context *psp,
538 const char *chip_name);
539 int psp_init_ta_microcode(struct psp_context *psp,
540 const char *chip_name);
541 int psp_init_cap_microcode(struct psp_context *psp,
542 const char *chip_name);
543 int psp_get_fw_attestation_records_addr(struct psp_context *psp,
544 uint64_t *output_ptr);
546 int psp_load_fw_list(struct psp_context *psp,
547 struct amdgpu_firmware_info **ucode_list, int ucode_count);
548 void psp_copy_fw(struct psp_context *psp, uint8_t *start_addr, uint32_t bin_size);
550 int psp_spatial_partition(struct psp_context *psp, int mode);
552 int is_psp_fw_valid(struct psp_bin_desc bin);
554 int amdgpu_psp_wait_for_bootloader(struct amdgpu_device *adev);
555 bool amdgpu_psp_get_ras_capability(struct psp_context *psp);