drivers/gpu/drm/amd/amdgpu/amdgpu_psp.h

   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
  48 struct psp_context;
  49 struct psp_xgmi_node_info;
  50 struct psp_xgmi_topology_info;
  51
  52 enum 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
  61 enum 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
  72 struct 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 */
  83 enum 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
  90 struct 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
 114 struct 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
 121 struct psp_xgmi_topology_info {
 122         uint32_t                        num_nodes;
 123         struct psp_xgmi_node_info       nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
 124 };
 125
 126 struct psp_asd_context {
 127         bool                    asd_initialized;
 128         uint32_t                session_id;
 129 };
 130
 131 struct 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
 140 struct 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
 150 struct 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
 159 struct 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
 168 struct 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
 177 struct 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
 192 enum 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
 200 enum 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
 209 struct 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 };
 229
 230 struct psp_context
 231 {
 232         struct amdgpu_device            *adev;
 233         struct psp_ring                 km_ring;
 234         struct psp_gfx_cmd_resp         *cmd;
 235
 236         const struct psp_funcs          *funcs;
 237
 238         /* firmware buffer */
 239         struct amdgpu_bo                *fw_pri_bo;
 240         uint64_t                        fw_pri_mc_addr;
 241         void                            *fw_pri_buf;
 242
 243         /* sos firmware */
 244         const struct firmware           *sos_fw;
 245         uint32_t                        sos_fw_version;
 246         uint32_t                        sos_feature_version;
 247         uint32_t                        sys_bin_size;
 248         uint32_t                        sos_bin_size;
 249         uint32_t                        toc_bin_size;
 250         uint32_t                        kdb_bin_size;
 251         uint32_t                        spl_bin_size;
 252         uint32_t                        rl_bin_size;
 253         uint8_t                         *sys_start_addr;
 254         uint8_t                         *sos_start_addr;
 255         uint8_t                         *toc_start_addr;
 256         uint8_t                         *kdb_start_addr;
 257         uint8_t                         *spl_start_addr;
 258         uint8_t                         *rl_start_addr;
 259
 260         /* tmr buffer */
 261         struct amdgpu_bo                *tmr_bo;
 262         uint64_t                        tmr_mc_addr;
 263
 264         /* asd firmware */
 265         const struct firmware           *asd_fw;
 266         uint32_t                        asd_fw_version;
 267         uint32_t                        asd_feature_version;
 268         uint32_t                        asd_ucode_size;
 269         uint8_t                         *asd_start_addr;
 270
 271         /* toc firmware */
 272         const struct firmware           *toc_fw;
 273         uint32_t                        toc_fw_version;
 274         uint32_t                        toc_feature_version;
 275
 276         /* fence buffer */
 277         struct amdgpu_bo                *fence_buf_bo;
 278         uint64_t                        fence_buf_mc_addr;
 279         void                            *fence_buf;
 280
 281         /* cmd buffer */
 282         struct amdgpu_bo                *cmd_buf_bo;
 283         uint64_t                        cmd_buf_mc_addr;
 284         struct psp_gfx_cmd_resp         *cmd_buf_mem;
 285
 286         /* fence value associated with cmd buffer */
 287         atomic_t                        fence_value;
 288         /* flag to mark whether gfx fw autoload is supported or not */
 289         bool                            autoload_supported;
 290         /* flag to mark whether df cstate management centralized to PMFW */
 291         bool                            pmfw_centralized_cstate_management;
 292
 293         /* xgmi ta firmware and buffer */
 294         const struct firmware           *ta_fw;
 295         uint32_t                        ta_fw_version;
 296         uint32_t                        ta_xgmi_ucode_version;
 297         uint32_t                        ta_xgmi_ucode_size;
 298         uint8_t                         *ta_xgmi_start_addr;
 299         uint32_t                        ta_ras_ucode_version;
 300         uint32_t                        ta_ras_ucode_size;
 301         uint8_t                         *ta_ras_start_addr;
 302
 303         uint32_t                        ta_hdcp_ucode_version;
 304         uint32_t                        ta_hdcp_ucode_size;
 305         uint8_t                         *ta_hdcp_start_addr;
 306
 307         uint32_t                        ta_dtm_ucode_version;
 308         uint32_t                        ta_dtm_ucode_size;
 309         uint8_t                         *ta_dtm_start_addr;
 310
 311         uint32_t                        ta_rap_ucode_version;
 312         uint32_t                        ta_rap_ucode_size;
 313         uint8_t                         *ta_rap_start_addr;
 314
 315         uint32_t                        ta_securedisplay_ucode_version;
 316         uint32_t                        ta_securedisplay_ucode_size;
 317         uint8_t                         *ta_securedisplay_start_addr;
 318
 319         struct psp_asd_context          asd_context;
 320         struct psp_xgmi_context         xgmi_context;
 321         struct psp_ras_context          ras;
 322         struct psp_hdcp_context         hdcp_context;
 323         struct psp_dtm_context          dtm_context;
 324         struct psp_rap_context          rap_context;
 325         struct psp_securedisplay_context        securedisplay_context;
 326         struct mutex                    mutex;
 327         struct psp_memory_training_context mem_train_ctx;
 328 };
 329
 330 struct amdgpu_psp_funcs {
 331         bool (*check_fw_loading_status)(struct amdgpu_device *adev,
 332                                         enum AMDGPU_UCODE_ID);
 333 };
 334
 335
 336 #define psp_ring_init(psp, type) (psp)->funcs->ring_init((psp), (type))
 337 #define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
 338 #define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
 339 #define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
 340 #define psp_init_microcode(psp) \
 341                 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
 342 #define psp_bootloader_load_kdb(psp) \
 343                 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
 344 #define psp_bootloader_load_spl(psp) \
 345                 ((psp)->funcs->bootloader_load_spl ? (psp)->funcs->bootloader_load_spl((psp)) : 0)
 346 #define psp_bootloader_load_sysdrv(psp) \
 347                 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
 348 #define psp_bootloader_load_sos(psp) \
 349                 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
 350 #define psp_smu_reload_quirk(psp) \
 351                 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
 352 #define psp_mode1_reset(psp) \
 353                 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
 354 #define psp_mem_training(psp, ops) \
 355         ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
 356
 357 #define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
 358 #define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
 359
 360 #define psp_load_usbc_pd_fw(psp, dma_addr) \
 361         ((psp)->funcs->load_usbc_pd_fw ? \
 362         (psp)->funcs->load_usbc_pd_fw((psp), (dma_addr)) : -EINVAL)
 363
 364 #define psp_read_usbc_pd_fw(psp, fw_ver) \
 365         ((psp)->funcs->read_usbc_pd_fw ? \
 366         (psp)->funcs->read_usbc_pd_fw((psp), fw_ver) : -EINVAL)
 367
 368 extern const struct amd_ip_funcs psp_ip_funcs;
 369
 370 extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
 371 extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
 372 extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
 373 extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
 374 extern const struct amdgpu_ip_block_version psp_v13_0_ip_block;
 375
 376 extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
 377                         uint32_t field_val, uint32_t mask, bool check_changed);
 378
 379 int psp_gpu_reset(struct amdgpu_device *adev);
 380 int psp_update_vcn_sram(struct amdgpu_device *adev, int inst_idx,
 381                         uint64_t cmd_gpu_addr, int cmd_size);
 382
 383 int psp_xgmi_initialize(struct psp_context *psp);
 384 int psp_xgmi_terminate(struct psp_context *psp);
 385 int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 386 int psp_xgmi_get_hive_id(struct psp_context *psp, uint64_t *hive_id);
 387 int psp_xgmi_get_node_id(struct psp_context *psp, uint64_t *node_id);
 388 int psp_xgmi_get_topology_info(struct psp_context *psp,
 389                                int number_devices,
 390                                struct psp_xgmi_topology_info *topology);
 391 int psp_xgmi_set_topology_info(struct psp_context *psp,
 392                                int number_devices,
 393                                struct psp_xgmi_topology_info *topology);
 394
 395 int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 396 int psp_ras_enable_features(struct psp_context *psp,
 397                 union ta_ras_cmd_input *info, bool enable);
 398 int psp_ras_trigger_error(struct psp_context *psp,
 399                           struct ta_ras_trigger_error_input *info);
 400
 401 int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 402 int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 403 int psp_rap_invoke(struct psp_context *psp, uint32_t ta_cmd_id, enum ta_rap_status *status);
 404 int psp_securedisplay_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 405
 406 int psp_rlc_autoload_start(struct psp_context *psp);
 407
 408 int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
 409                 uint32_t value);
 410 int psp_ring_cmd_submit(struct psp_context *psp,
 411                         uint64_t cmd_buf_mc_addr,
 412                         uint64_t fence_mc_addr,
 413                         int index);
 414 int psp_init_asd_microcode(struct psp_context *psp,
 415                            const char *chip_name);
 416 int psp_init_toc_microcode(struct psp_context *psp,
 417                            const char *chip_name);
 418 int psp_init_sos_microcode(struct psp_context *psp,
 419                            const char *chip_name);
 420 int psp_init_ta_microcode(struct psp_context *psp,
 421                           const char *chip_name);
 422 int psp_get_fw_attestation_records_addr(struct psp_context *psp,
 423                                         uint64_t *output_ptr);
 424
 425 int psp_load_fw_list(struct psp_context *psp,
 426                      struct amdgpu_firmware_info **ucode_list, int ucode_count);
 427 void psp_copy_fw(struct psp_context *psp, uint8_t *start_addr, uint32_t bin_size);
 428
 429 #endif