Loading...
1/*
2 * Copyright 2016 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 * Author: Huang Rui
23 *
24 */
25#ifndef __AMDGPU_PSP_H__
26#define __AMDGPU_PSP_H__
27
28#include "amdgpu.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"
34
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
41
42extern const struct attribute_group amdgpu_flash_attr_group;
43
44enum 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,
52};
53
54enum ta_type_id {
55 TA_TYPE_XGMI = 1,
56 TA_TYPE_RAS,
57 TA_TYPE_HDCP,
58 TA_TYPE_DTM,
59 TA_TYPE_RAP,
60 TA_TYPE_SECUREDISPLAY,
61
62 TA_TYPE_MAX_INDEX,
63};
64
65struct psp_context;
66struct psp_xgmi_node_info;
67struct psp_xgmi_topology_info;
68struct psp_bin_desc;
69
70enum 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,
81};
82
83enum psp_ring_type {
84 PSP_RING_TYPE__INVALID = 0,
85 /*
86 * These values map to the way the PSP kernel identifies the
87 * rings.
88 */
89 PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
90 PSP_RING_TYPE__KM = 2 /* Kernel mode ring (formerly called GPCOM) */
91};
92
93struct psp_ring {
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;
98 uint32_t ring_size;
99 uint32_t ring_wptr;
100};
101
102/* More registers may will be supported */
103enum 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 */
107 PSP_REG_LAST
108};
109
110struct psp_funcs {
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);
137 int (*query_boot_status)(struct psp_context *psp);
138};
139
140struct ta_funcs {
141 int (*fn_ta_initialize)(struct psp_context *psp);
142 int (*fn_ta_invoke)(struct psp_context *psp, uint32_t ta_cmd_id);
143 int (*fn_ta_terminate)(struct psp_context *psp);
144};
145
146#define AMDGPU_XGMI_MAX_CONNECTED_NODES 64
147struct psp_xgmi_node_info {
148 uint64_t node_id;
149 uint8_t num_hops;
150 uint8_t is_sharing_enabled;
151 enum ta_xgmi_assigned_sdma_engine sdma_engine;
152 uint8_t num_links;
153 struct xgmi_connected_port_num port_num[TA_XGMI__MAX_PORT_NUM];
154};
155
156struct psp_xgmi_topology_info {
157 uint32_t num_nodes;
158 struct psp_xgmi_node_info nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
159};
160
161struct psp_bin_desc {
162 uint32_t fw_version;
163 uint32_t feature_version;
164 uint32_t size_bytes;
165 uint8_t *start_addr;
166};
167
168struct ta_mem_context {
169 struct amdgpu_bo *shared_bo;
170 uint64_t shared_mc_addr;
171 void *shared_buf;
172 enum psp_shared_mem_size shared_mem_size;
173};
174
175struct ta_context {
176 bool initialized;
177 uint32_t session_id;
178 uint32_t resp_status;
179 struct ta_mem_context mem_context;
180 struct psp_bin_desc bin_desc;
181 enum psp_gfx_cmd_id ta_load_type;
182 enum ta_type_id ta_type;
183};
184
185struct ta_cp_context {
186 struct ta_context context;
187 struct mutex mutex;
188};
189
190struct psp_xgmi_context {
191 struct ta_context context;
192 struct psp_xgmi_topology_info top_info;
193 bool supports_extended_data;
194 uint8_t xgmi_ta_caps;
195};
196
197struct psp_ras_context {
198 struct ta_context context;
199 struct amdgpu_ras *ras;
200};
201
202#define MEM_TRAIN_SYSTEM_SIGNATURE 0x54534942
203#define GDDR6_MEM_TRAINING_DATA_SIZE_IN_BYTES 0x1000
204#define GDDR6_MEM_TRAINING_OFFSET 0x8000
205/*Define the VRAM size that will be encroached by BIST training.*/
206#define GDDR6_MEM_TRAINING_ENCROACHED_SIZE 0x2000000
207
208enum psp_memory_training_init_flag {
209 PSP_MEM_TRAIN_NOT_SUPPORT = 0x0,
210 PSP_MEM_TRAIN_SUPPORT = 0x1,
211 PSP_MEM_TRAIN_INIT_FAILED = 0x2,
212 PSP_MEM_TRAIN_RESERVE_SUCCESS = 0x4,
213 PSP_MEM_TRAIN_INIT_SUCCESS = 0x8,
214};
215
216enum psp_memory_training_ops {
217 PSP_MEM_TRAIN_SEND_LONG_MSG = 0x1,
218 PSP_MEM_TRAIN_SAVE = 0x2,
219 PSP_MEM_TRAIN_RESTORE = 0x4,
220 PSP_MEM_TRAIN_SEND_SHORT_MSG = 0x8,
221 PSP_MEM_TRAIN_COLD_BOOT = PSP_MEM_TRAIN_SEND_LONG_MSG,
222 PSP_MEM_TRAIN_RESUME = PSP_MEM_TRAIN_SEND_SHORT_MSG,
223};
224
225struct psp_memory_training_context {
226 /*training data size*/
227 u64 train_data_size;
228 /*
229 * sys_cache
230 * cpu virtual address
231 * system memory buffer that used to store the training data.
232 */
233 void *sys_cache;
234
235 /*vram offset of the p2c training data*/
236 u64 p2c_train_data_offset;
237
238 /*vram offset of the c2p training data*/
239 u64 c2p_train_data_offset;
240 struct amdgpu_bo *c2p_bo;
241
242 enum psp_memory_training_init_flag init;
243 u32 training_cnt;
244 bool enable_mem_training;
245};
246
247/** PSP runtime DB **/
248#define PSP_RUNTIME_DB_SIZE_IN_BYTES 0x10000
249#define PSP_RUNTIME_DB_OFFSET 0x100000
250#define PSP_RUNTIME_DB_COOKIE_ID 0x0ed5
251#define PSP_RUNTIME_DB_VER_1 0x0100
252#define PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT 0x40
253
254enum psp_runtime_entry_type {
255 PSP_RUNTIME_ENTRY_TYPE_INVALID = 0x0,
256 PSP_RUNTIME_ENTRY_TYPE_TEST = 0x1,
257 PSP_RUNTIME_ENTRY_TYPE_MGPU_COMMON = 0x2, /* Common mGPU runtime data */
258 PSP_RUNTIME_ENTRY_TYPE_MGPU_WAFL = 0x3, /* WAFL runtime data */
259 PSP_RUNTIME_ENTRY_TYPE_MGPU_XGMI = 0x4, /* XGMI runtime data */
260 PSP_RUNTIME_ENTRY_TYPE_BOOT_CONFIG = 0x5, /* Boot Config runtime data */
261 PSP_RUNTIME_ENTRY_TYPE_PPTABLE_ERR_STATUS = 0x6, /* SCPM validation data */
262};
263
264/* PSP runtime DB header */
265struct psp_runtime_data_header {
266 /* determine the existence of runtime db */
267 uint16_t cookie;
268 /* version of runtime db */
269 uint16_t version;
270};
271
272/* PSP runtime DB entry */
273struct psp_runtime_entry {
274 /* type of runtime db entry */
275 uint32_t entry_type;
276 /* offset of entry in bytes */
277 uint16_t offset;
278 /* size of entry in bytes */
279 uint16_t size;
280};
281
282/* PSP runtime DB directory */
283struct psp_runtime_data_directory {
284 /* number of valid entries */
285 uint16_t entry_count;
286 /* db entries*/
287 struct psp_runtime_entry entry_list[PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT];
288};
289
290/* PSP runtime DB boot config feature bitmask */
291enum psp_runtime_boot_cfg_feature {
292 BOOT_CFG_FEATURE_GECC = 0x1,
293 BOOT_CFG_FEATURE_TWO_STAGE_DRAM_TRAINING = 0x2,
294};
295
296/* PSP run time DB SCPM authentication defines */
297enum psp_runtime_scpm_authentication {
298 SCPM_DISABLE = 0x0,
299 SCPM_ENABLE = 0x1,
300 SCPM_ENABLE_WITH_SCPM_ERR = 0x2,
301};
302
303/* PSP runtime DB boot config entry */
304struct psp_runtime_boot_cfg_entry {
305 uint32_t boot_cfg_bitmask;
306 uint32_t reserved;
307};
308
309/* PSP runtime DB SCPM entry */
310struct psp_runtime_scpm_entry {
311 enum psp_runtime_scpm_authentication scpm_status;
312};
313
314struct psp_context {
315 struct amdgpu_device *adev;
316 struct psp_ring km_ring;
317 struct psp_gfx_cmd_resp *cmd;
318
319 const struct psp_funcs *funcs;
320 const struct ta_funcs *ta_funcs;
321
322 /* firmware buffer */
323 struct amdgpu_bo *fw_pri_bo;
324 uint64_t fw_pri_mc_addr;
325 void *fw_pri_buf;
326
327 /* sos firmware */
328 const struct firmware *sos_fw;
329 struct psp_bin_desc sys;
330 struct psp_bin_desc sos;
331 struct psp_bin_desc toc;
332 struct psp_bin_desc kdb;
333 struct psp_bin_desc spl;
334 struct psp_bin_desc rl;
335 struct psp_bin_desc soc_drv;
336 struct psp_bin_desc intf_drv;
337 struct psp_bin_desc dbg_drv;
338 struct psp_bin_desc ras_drv;
339
340 /* tmr buffer */
341 struct amdgpu_bo *tmr_bo;
342 uint64_t tmr_mc_addr;
343
344 /* asd firmware */
345 const struct firmware *asd_fw;
346
347 /* toc firmware */
348 const struct firmware *toc_fw;
349
350 /* cap firmware */
351 const struct firmware *cap_fw;
352
353 /* fence buffer */
354 struct amdgpu_bo *fence_buf_bo;
355 uint64_t fence_buf_mc_addr;
356 void *fence_buf;
357
358 /* cmd buffer */
359 struct amdgpu_bo *cmd_buf_bo;
360 uint64_t cmd_buf_mc_addr;
361 struct psp_gfx_cmd_resp *cmd_buf_mem;
362
363 /* fence value associated with cmd buffer */
364 atomic_t fence_value;
365 /* flag to mark whether gfx fw autoload is supported or not */
366 bool autoload_supported;
367 /* flag to mark whether df cstate management centralized to PMFW */
368 bool pmfw_centralized_cstate_management;
369
370 /* xgmi ta firmware and buffer */
371 const struct firmware *ta_fw;
372 uint32_t ta_fw_version;
373
374 uint32_t cap_fw_version;
375 uint32_t cap_feature_version;
376 uint32_t cap_ucode_size;
377
378 struct ta_context asd_context;
379 struct psp_xgmi_context xgmi_context;
380 struct psp_ras_context ras_context;
381 struct ta_cp_context hdcp_context;
382 struct ta_cp_context dtm_context;
383 struct ta_cp_context rap_context;
384 struct ta_cp_context securedisplay_context;
385 struct mutex mutex;
386 struct psp_memory_training_context mem_train_ctx;
387
388 uint32_t boot_cfg_bitmask;
389
390 /* firmware upgrades supported */
391 bool sup_pd_fw_up;
392 bool sup_ifwi_up;
393
394 char *vbflash_tmp_buf;
395 size_t vbflash_image_size;
396 bool vbflash_done;
397};
398
399struct amdgpu_psp_funcs {
400 bool (*check_fw_loading_status)(struct amdgpu_device *adev,
401 enum AMDGPU_UCODE_ID);
402};
403
404
405#define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
406#define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
407#define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
408#define psp_init_microcode(psp) \
409 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
410#define psp_bootloader_load_kdb(psp) \
411 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
412#define psp_bootloader_load_spl(psp) \
413 ((psp)->funcs->bootloader_load_spl ? (psp)->funcs->bootloader_load_spl((psp)) : 0)
414#define psp_bootloader_load_sysdrv(psp) \
415 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
416#define psp_bootloader_load_soc_drv(psp) \
417 ((psp)->funcs->bootloader_load_soc_drv ? (psp)->funcs->bootloader_load_soc_drv((psp)) : 0)
418#define psp_bootloader_load_intf_drv(psp) \
419 ((psp)->funcs->bootloader_load_intf_drv ? (psp)->funcs->bootloader_load_intf_drv((psp)) : 0)
420#define psp_bootloader_load_dbg_drv(psp) \
421 ((psp)->funcs->bootloader_load_dbg_drv ? (psp)->funcs->bootloader_load_dbg_drv((psp)) : 0)
422#define psp_bootloader_load_ras_drv(psp) \
423 ((psp)->funcs->bootloader_load_ras_drv ? \
424 (psp)->funcs->bootloader_load_ras_drv((psp)) : 0)
425#define psp_bootloader_load_sos(psp) \
426 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
427#define psp_smu_reload_quirk(psp) \
428 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
429#define psp_mode1_reset(psp) \
430 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
431#define psp_mem_training(psp, ops) \
432 ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
433
434#define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
435#define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
436
437#define psp_load_usbc_pd_fw(psp, fw_pri_mc_addr) \
438 ((psp)->funcs->load_usbc_pd_fw ? \
439 (psp)->funcs->load_usbc_pd_fw((psp), (fw_pri_mc_addr)) : -EINVAL)
440
441#define psp_read_usbc_pd_fw(psp, fw_ver) \
442 ((psp)->funcs->read_usbc_pd_fw ? \
443 (psp)->funcs->read_usbc_pd_fw((psp), fw_ver) : -EINVAL)
444
445#define psp_update_spirom(psp, fw_pri_mc_addr) \
446 ((psp)->funcs->update_spirom ? \
447 (psp)->funcs->update_spirom((psp), fw_pri_mc_addr) : -EINVAL)
448
449#define psp_vbflash_status(psp) \
450 ((psp)->funcs->vbflash_stat ? \
451 (psp)->funcs->vbflash_stat((psp)) : -EINVAL)
452
453#define psp_fatal_error_recovery_quirk(psp) \
454 ((psp)->funcs->fatal_error_recovery_quirk ? \
455 (psp)->funcs->fatal_error_recovery_quirk((psp)) : 0)
456
457extern const struct amd_ip_funcs psp_ip_funcs;
458
459extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
460extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
461extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
462extern const struct amdgpu_ip_block_version psp_v11_0_8_ip_block;
463extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
464extern const struct amdgpu_ip_block_version psp_v13_0_ip_block;
465extern const struct amdgpu_ip_block_version psp_v13_0_4_ip_block;
466
467extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
468 uint32_t field_val, uint32_t mask, bool check_changed);
469extern int psp_wait_for_spirom_update(struct psp_context *psp, uint32_t reg_index,
470 uint32_t field_val, uint32_t mask, uint32_t msec_timeout);
471
472int psp_execute_ip_fw_load(struct psp_context *psp,
473 struct amdgpu_firmware_info *ucode);
474
475int psp_gpu_reset(struct amdgpu_device *adev);
476
477int psp_ta_init_shared_buf(struct psp_context *psp,
478 struct ta_mem_context *mem_ctx);
479void psp_ta_free_shared_buf(struct ta_mem_context *mem_ctx);
480int psp_ta_unload(struct psp_context *psp, struct ta_context *context);
481int psp_ta_load(struct psp_context *psp, struct ta_context *context);
482int psp_ta_invoke(struct psp_context *psp,
483 uint32_t ta_cmd_id,
484 struct ta_context *context);
485
486int psp_xgmi_initialize(struct psp_context *psp, bool set_extended_data, bool load_ta);
487int psp_xgmi_terminate(struct psp_context *psp);
488int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
489int psp_xgmi_get_hive_id(struct psp_context *psp, uint64_t *hive_id);
490int psp_xgmi_get_node_id(struct psp_context *psp, uint64_t *node_id);
491int psp_xgmi_get_topology_info(struct psp_context *psp,
492 int number_devices,
493 struct psp_xgmi_topology_info *topology,
494 bool get_extended_data);
495int psp_xgmi_set_topology_info(struct psp_context *psp,
496 int number_devices,
497 struct psp_xgmi_topology_info *topology);
498int psp_ras_initialize(struct psp_context *psp);
499int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
500int psp_ras_enable_features(struct psp_context *psp,
501 union ta_ras_cmd_input *info, bool enable);
502int psp_ras_trigger_error(struct psp_context *psp,
503 struct ta_ras_trigger_error_input *info, uint32_t instance_mask);
504int psp_ras_terminate(struct psp_context *psp);
505
506int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
507int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
508int psp_rap_invoke(struct psp_context *psp, uint32_t ta_cmd_id, enum ta_rap_status *status);
509int psp_securedisplay_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
510
511int psp_rlc_autoload_start(struct psp_context *psp);
512
513int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
514 uint32_t value);
515int psp_ring_cmd_submit(struct psp_context *psp,
516 uint64_t cmd_buf_mc_addr,
517 uint64_t fence_mc_addr,
518 int index);
519int psp_init_asd_microcode(struct psp_context *psp,
520 const char *chip_name);
521int psp_init_toc_microcode(struct psp_context *psp,
522 const char *chip_name);
523int psp_init_sos_microcode(struct psp_context *psp,
524 const char *chip_name);
525int psp_init_ta_microcode(struct psp_context *psp,
526 const char *chip_name);
527int psp_init_cap_microcode(struct psp_context *psp,
528 const char *chip_name);
529int psp_get_fw_attestation_records_addr(struct psp_context *psp,
530 uint64_t *output_ptr);
531
532int psp_load_fw_list(struct psp_context *psp,
533 struct amdgpu_firmware_info **ucode_list, int ucode_count);
534void psp_copy_fw(struct psp_context *psp, uint8_t *start_addr, uint32_t bin_size);
535
536int psp_spatial_partition(struct psp_context *psp, int mode);
537
538int is_psp_fw_valid(struct psp_bin_desc bin);
539
540int amdgpu_psp_wait_for_bootloader(struct amdgpu_device *adev);
541
542int amdgpu_psp_query_boot_status(struct amdgpu_device *adev);
543
544#endif
1/*
2 * Copyright 2016 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 * Author: Huang Rui
23 *
24 */
25#ifndef __AMDGPU_PSP_H__
26#define __AMDGPU_PSP_H__
27
28#include "amdgpu.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"
34
35#define PSP_FENCE_BUFFER_SIZE 0x1000
36#define PSP_CMD_BUFFER_SIZE 0x1000
37#define PSP_XGMI_SHARED_MEM_SIZE 0x4000
38#define PSP_RAS_SHARED_MEM_SIZE 0x4000
39#define PSP_1_MEG 0x100000
40#define PSP_TMR_SIZE(adev) ((adev)->asic_type == CHIP_ALDEBARAN ? 0x800000 : 0x400000)
41#define PSP_HDCP_SHARED_MEM_SIZE 0x4000
42#define PSP_DTM_SHARED_MEM_SIZE 0x4000
43#define PSP_RAP_SHARED_MEM_SIZE 0x4000
44#define PSP_SECUREDISPLAY_SHARED_MEM_SIZE 0x4000
45#define PSP_SHARED_MEM_SIZE 0x4000
46#define PSP_FW_NAME_LEN 0x24
47
48struct psp_context;
49struct psp_xgmi_node_info;
50struct psp_xgmi_topology_info;
51
52enum psp_bootloader_cmd {
53 PSP_BL__LOAD_SYSDRV = 0x10000,
54 PSP_BL__LOAD_SOSDRV = 0x20000,
55 PSP_BL__LOAD_KEY_DATABASE = 0x80000,
56 PSP_BL__DRAM_LONG_TRAIN = 0x100000,
57 PSP_BL__DRAM_SHORT_TRAIN = 0x200000,
58 PSP_BL__LOAD_TOS_SPL_TABLE = 0x10000000,
59};
60
61enum psp_ring_type
62{
63 PSP_RING_TYPE__INVALID = 0,
64 /*
65 * These values map to the way the PSP kernel identifies the
66 * rings.
67 */
68 PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
69 PSP_RING_TYPE__KM = 2 /* Kernel mode ring (formerly called GPCOM) */
70};
71
72struct psp_ring
73{
74 enum psp_ring_type ring_type;
75 struct psp_gfx_rb_frame *ring_mem;
76 uint64_t ring_mem_mc_addr;
77 void *ring_mem_handle;
78 uint32_t ring_size;
79 uint32_t ring_wptr;
80};
81
82/* More registers may will be supported */
83enum psp_reg_prog_id {
84 PSP_REG_IH_RB_CNTL = 0, /* register IH_RB_CNTL */
85 PSP_REG_IH_RB_CNTL_RING1 = 1, /* register IH_RB_CNTL_RING1 */
86 PSP_REG_IH_RB_CNTL_RING2 = 2, /* register IH_RB_CNTL_RING2 */
87 PSP_REG_LAST
88};
89
90struct psp_funcs
91{
92 int (*init_microcode)(struct psp_context *psp);
93 int (*bootloader_load_kdb)(struct psp_context *psp);
94 int (*bootloader_load_spl)(struct psp_context *psp);
95 int (*bootloader_load_sysdrv)(struct psp_context *psp);
96 int (*bootloader_load_sos)(struct psp_context *psp);
97 int (*ring_init)(struct psp_context *psp, enum psp_ring_type ring_type);
98 int (*ring_create)(struct psp_context *psp,
99 enum psp_ring_type ring_type);
100 int (*ring_stop)(struct psp_context *psp,
101 enum psp_ring_type ring_type);
102 int (*ring_destroy)(struct psp_context *psp,
103 enum psp_ring_type ring_type);
104 bool (*smu_reload_quirk)(struct psp_context *psp);
105 int (*mode1_reset)(struct psp_context *psp);
106 int (*mem_training)(struct psp_context *psp, uint32_t ops);
107 uint32_t (*ring_get_wptr)(struct psp_context *psp);
108 void (*ring_set_wptr)(struct psp_context *psp, uint32_t value);
109 int (*load_usbc_pd_fw)(struct psp_context *psp, dma_addr_t dma_addr);
110 int (*read_usbc_pd_fw)(struct psp_context *psp, uint32_t *fw_ver);
111};
112
113#define AMDGPU_XGMI_MAX_CONNECTED_NODES 64
114struct psp_xgmi_node_info {
115 uint64_t node_id;
116 uint8_t num_hops;
117 uint8_t is_sharing_enabled;
118 enum ta_xgmi_assigned_sdma_engine sdma_engine;
119};
120
121struct psp_xgmi_topology_info {
122 uint32_t num_nodes;
123 struct psp_xgmi_node_info nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
124};
125
126struct psp_asd_context {
127 bool asd_initialized;
128 uint32_t session_id;
129};
130
131struct psp_xgmi_context {
132 uint8_t initialized;
133 uint32_t session_id;
134 struct amdgpu_bo *xgmi_shared_bo;
135 uint64_t xgmi_shared_mc_addr;
136 void *xgmi_shared_buf;
137 struct psp_xgmi_topology_info top_info;
138};
139
140struct psp_ras_context {
141 /*ras fw*/
142 bool ras_initialized;
143 uint32_t session_id;
144 struct amdgpu_bo *ras_shared_bo;
145 uint64_t ras_shared_mc_addr;
146 void *ras_shared_buf;
147 struct amdgpu_ras *ras;
148};
149
150struct psp_hdcp_context {
151 bool hdcp_initialized;
152 uint32_t session_id;
153 struct amdgpu_bo *hdcp_shared_bo;
154 uint64_t hdcp_shared_mc_addr;
155 void *hdcp_shared_buf;
156 struct mutex mutex;
157};
158
159struct psp_dtm_context {
160 bool dtm_initialized;
161 uint32_t session_id;
162 struct amdgpu_bo *dtm_shared_bo;
163 uint64_t dtm_shared_mc_addr;
164 void *dtm_shared_buf;
165 struct mutex mutex;
166};
167
168struct psp_rap_context {
169 bool rap_initialized;
170 uint32_t session_id;
171 struct amdgpu_bo *rap_shared_bo;
172 uint64_t rap_shared_mc_addr;
173 void *rap_shared_buf;
174 struct mutex mutex;
175};
176
177struct psp_securedisplay_context {
178 bool securedisplay_initialized;
179 uint32_t session_id;
180 struct amdgpu_bo *securedisplay_shared_bo;
181 uint64_t securedisplay_shared_mc_addr;
182 void *securedisplay_shared_buf;
183 struct mutex mutex;
184};
185
186#define MEM_TRAIN_SYSTEM_SIGNATURE 0x54534942
187#define GDDR6_MEM_TRAINING_DATA_SIZE_IN_BYTES 0x1000
188#define GDDR6_MEM_TRAINING_OFFSET 0x8000
189/*Define the VRAM size that will be encroached by BIST training.*/
190#define GDDR6_MEM_TRAINING_ENCROACHED_SIZE 0x2000000
191
192enum psp_memory_training_init_flag {
193 PSP_MEM_TRAIN_NOT_SUPPORT = 0x0,
194 PSP_MEM_TRAIN_SUPPORT = 0x1,
195 PSP_MEM_TRAIN_INIT_FAILED = 0x2,
196 PSP_MEM_TRAIN_RESERVE_SUCCESS = 0x4,
197 PSP_MEM_TRAIN_INIT_SUCCESS = 0x8,
198};
199
200enum psp_memory_training_ops {
201 PSP_MEM_TRAIN_SEND_LONG_MSG = 0x1,
202 PSP_MEM_TRAIN_SAVE = 0x2,
203 PSP_MEM_TRAIN_RESTORE = 0x4,
204 PSP_MEM_TRAIN_SEND_SHORT_MSG = 0x8,
205 PSP_MEM_TRAIN_COLD_BOOT = PSP_MEM_TRAIN_SEND_LONG_MSG,
206 PSP_MEM_TRAIN_RESUME = PSP_MEM_TRAIN_SEND_SHORT_MSG,
207};
208
209struct psp_memory_training_context {
210 /*training data size*/
211 u64 train_data_size;
212 /*
213 * sys_cache
214 * cpu virtual address
215 * system memory buffer that used to store the training data.
216 */
217 void *sys_cache;
218
219 /*vram offset of the p2c training data*/
220 u64 p2c_train_data_offset;
221
222 /*vram offset of the c2p training data*/
223 u64 c2p_train_data_offset;
224 struct amdgpu_bo *c2p_bo;
225
226 enum psp_memory_training_init_flag init;
227 u32 training_cnt;
228 bool enable_mem_training;
229};
230
231/** PSP runtime DB **/
232#define PSP_RUNTIME_DB_SIZE_IN_BYTES 0x10000
233#define PSP_RUNTIME_DB_OFFSET 0x100000
234#define PSP_RUNTIME_DB_COOKIE_ID 0x0ed5
235#define PSP_RUNTIME_DB_VER_1 0x0100
236#define PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT 0x40
237
238enum psp_runtime_entry_type {
239 PSP_RUNTIME_ENTRY_TYPE_INVALID = 0x0,
240 PSP_RUNTIME_ENTRY_TYPE_TEST = 0x1,
241 PSP_RUNTIME_ENTRY_TYPE_MGPU_COMMON = 0x2, /* Common mGPU runtime data */
242 PSP_RUNTIME_ENTRY_TYPE_MGPU_WAFL = 0x3, /* WAFL runtime data */
243 PSP_RUNTIME_ENTRY_TYPE_MGPU_XGMI = 0x4, /* XGMI runtime data */
244 PSP_RUNTIME_ENTRY_TYPE_BOOT_CONFIG = 0x5, /* Boot Config runtime data */
245};
246
247/* PSP runtime DB header */
248struct psp_runtime_data_header {
249 /* determine the existence of runtime db */
250 uint16_t cookie;
251 /* version of runtime db */
252 uint16_t version;
253};
254
255/* PSP runtime DB entry */
256struct psp_runtime_entry {
257 /* type of runtime db entry */
258 uint32_t entry_type;
259 /* offset of entry in bytes */
260 uint16_t offset;
261 /* size of entry in bytes */
262 uint16_t size;
263};
264
265/* PSP runtime DB directory */
266struct psp_runtime_data_directory {
267 /* number of valid entries */
268 uint16_t entry_count;
269 /* db entries*/
270 struct psp_runtime_entry entry_list[PSP_RUNTIME_DB_DIAG_ENTRY_MAX_COUNT];
271};
272
273/* PSP runtime DB boot config feature bitmask */
274enum psp_runtime_boot_cfg_feature {
275 BOOT_CFG_FEATURE_GECC = 0x1,
276 BOOT_CFG_FEATURE_TWO_STAGE_DRAM_TRAINING = 0x2,
277};
278
279/* PSP runtime DB boot config entry */
280struct psp_runtime_boot_cfg_entry {
281 uint32_t boot_cfg_bitmask;
282 uint32_t reserved;
283};
284
285struct psp_context
286{
287 struct amdgpu_device *adev;
288 struct psp_ring km_ring;
289 struct psp_gfx_cmd_resp *cmd;
290
291 const struct psp_funcs *funcs;
292
293 /* firmware buffer */
294 struct amdgpu_bo *fw_pri_bo;
295 uint64_t fw_pri_mc_addr;
296 void *fw_pri_buf;
297
298 /* sos firmware */
299 const struct firmware *sos_fw;
300 uint32_t sos_fw_version;
301 uint32_t sos_feature_version;
302 uint32_t sys_bin_size;
303 uint32_t sos_bin_size;
304 uint32_t toc_bin_size;
305 uint32_t kdb_bin_size;
306 uint32_t spl_bin_size;
307 uint32_t rl_bin_size;
308 uint8_t *sys_start_addr;
309 uint8_t *sos_start_addr;
310 uint8_t *toc_start_addr;
311 uint8_t *kdb_start_addr;
312 uint8_t *spl_start_addr;
313 uint8_t *rl_start_addr;
314
315 /* tmr buffer */
316 struct amdgpu_bo *tmr_bo;
317 uint64_t tmr_mc_addr;
318
319 /* asd firmware */
320 const struct firmware *asd_fw;
321 uint32_t asd_fw_version;
322 uint32_t asd_feature_version;
323 uint32_t asd_ucode_size;
324 uint8_t *asd_start_addr;
325
326 /* toc firmware */
327 const struct firmware *toc_fw;
328 uint32_t toc_fw_version;
329 uint32_t toc_feature_version;
330
331 /* fence buffer */
332 struct amdgpu_bo *fence_buf_bo;
333 uint64_t fence_buf_mc_addr;
334 void *fence_buf;
335
336 /* cmd buffer */
337 struct amdgpu_bo *cmd_buf_bo;
338 uint64_t cmd_buf_mc_addr;
339 struct psp_gfx_cmd_resp *cmd_buf_mem;
340
341 /* fence value associated with cmd buffer */
342 atomic_t fence_value;
343 /* flag to mark whether gfx fw autoload is supported or not */
344 bool autoload_supported;
345 /* flag to mark whether df cstate management centralized to PMFW */
346 bool pmfw_centralized_cstate_management;
347
348 /* xgmi ta firmware and buffer */
349 const struct firmware *ta_fw;
350 uint32_t ta_fw_version;
351 uint32_t ta_xgmi_ucode_version;
352 uint32_t ta_xgmi_ucode_size;
353 uint8_t *ta_xgmi_start_addr;
354 uint32_t ta_ras_ucode_version;
355 uint32_t ta_ras_ucode_size;
356 uint8_t *ta_ras_start_addr;
357
358 uint32_t ta_hdcp_ucode_version;
359 uint32_t ta_hdcp_ucode_size;
360 uint8_t *ta_hdcp_start_addr;
361
362 uint32_t ta_dtm_ucode_version;
363 uint32_t ta_dtm_ucode_size;
364 uint8_t *ta_dtm_start_addr;
365
366 uint32_t ta_rap_ucode_version;
367 uint32_t ta_rap_ucode_size;
368 uint8_t *ta_rap_start_addr;
369
370 uint32_t ta_securedisplay_ucode_version;
371 uint32_t ta_securedisplay_ucode_size;
372 uint8_t *ta_securedisplay_start_addr;
373
374 struct psp_asd_context asd_context;
375 struct psp_xgmi_context xgmi_context;
376 struct psp_ras_context ras;
377 struct psp_hdcp_context hdcp_context;
378 struct psp_dtm_context dtm_context;
379 struct psp_rap_context rap_context;
380 struct psp_securedisplay_context securedisplay_context;
381 struct mutex mutex;
382 struct psp_memory_training_context mem_train_ctx;
383
384 uint32_t boot_cfg_bitmask;
385};
386
387struct amdgpu_psp_funcs {
388 bool (*check_fw_loading_status)(struct amdgpu_device *adev,
389 enum AMDGPU_UCODE_ID);
390};
391
392
393#define psp_ring_init(psp, type) (psp)->funcs->ring_init((psp), (type))
394#define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
395#define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
396#define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
397#define psp_init_microcode(psp) \
398 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
399#define psp_bootloader_load_kdb(psp) \
400 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
401#define psp_bootloader_load_spl(psp) \
402 ((psp)->funcs->bootloader_load_spl ? (psp)->funcs->bootloader_load_spl((psp)) : 0)
403#define psp_bootloader_load_sysdrv(psp) \
404 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
405#define psp_bootloader_load_sos(psp) \
406 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
407#define psp_smu_reload_quirk(psp) \
408 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
409#define psp_mode1_reset(psp) \
410 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
411#define psp_mem_training(psp, ops) \
412 ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
413
414#define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
415#define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
416
417#define psp_load_usbc_pd_fw(psp, dma_addr) \
418 ((psp)->funcs->load_usbc_pd_fw ? \
419 (psp)->funcs->load_usbc_pd_fw((psp), (dma_addr)) : -EINVAL)
420
421#define psp_read_usbc_pd_fw(psp, fw_ver) \
422 ((psp)->funcs->read_usbc_pd_fw ? \
423 (psp)->funcs->read_usbc_pd_fw((psp), fw_ver) : -EINVAL)
424
425extern const struct amd_ip_funcs psp_ip_funcs;
426
427extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
428extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
429extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
430extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
431extern const struct amdgpu_ip_block_version psp_v13_0_ip_block;
432
433extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
434 uint32_t field_val, uint32_t mask, bool check_changed);
435
436int psp_gpu_reset(struct amdgpu_device *adev);
437int psp_update_vcn_sram(struct amdgpu_device *adev, int inst_idx,
438 uint64_t cmd_gpu_addr, int cmd_size);
439
440int psp_xgmi_initialize(struct psp_context *psp);
441int psp_xgmi_terminate(struct psp_context *psp);
442int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
443int psp_xgmi_get_hive_id(struct psp_context *psp, uint64_t *hive_id);
444int psp_xgmi_get_node_id(struct psp_context *psp, uint64_t *node_id);
445int psp_xgmi_get_topology_info(struct psp_context *psp,
446 int number_devices,
447 struct psp_xgmi_topology_info *topology);
448int psp_xgmi_set_topology_info(struct psp_context *psp,
449 int number_devices,
450 struct psp_xgmi_topology_info *topology);
451
452int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
453int psp_ras_enable_features(struct psp_context *psp,
454 union ta_ras_cmd_input *info, bool enable);
455int psp_ras_trigger_error(struct psp_context *psp,
456 struct ta_ras_trigger_error_input *info);
457
458int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
459int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
460int psp_rap_invoke(struct psp_context *psp, uint32_t ta_cmd_id, enum ta_rap_status *status);
461int psp_securedisplay_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
462
463int psp_rlc_autoload_start(struct psp_context *psp);
464
465int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
466 uint32_t value);
467int psp_ring_cmd_submit(struct psp_context *psp,
468 uint64_t cmd_buf_mc_addr,
469 uint64_t fence_mc_addr,
470 int index);
471int psp_init_asd_microcode(struct psp_context *psp,
472 const char *chip_name);
473int psp_init_toc_microcode(struct psp_context *psp,
474 const char *chip_name);
475int psp_init_sos_microcode(struct psp_context *psp,
476 const char *chip_name);
477int psp_init_ta_microcode(struct psp_context *psp,
478 const char *chip_name);
479int psp_get_fw_attestation_records_addr(struct psp_context *psp,
480 uint64_t *output_ptr);
481
482int psp_load_fw_list(struct psp_context *psp,
483 struct amdgpu_firmware_info **ucode_list, int ucode_count);
484void psp_copy_fw(struct psp_context *psp, uint8_t *start_addr, uint32_t bin_size);
485
486#endif