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
  33 #define PSP_FENCE_BUFFER_SIZE   0x1000
  34 #define PSP_CMD_BUFFER_SIZE     0x1000
  35 #define PSP_XGMI_SHARED_MEM_SIZE 0x4000
  36 #define PSP_RAS_SHARED_MEM_SIZE 0x4000
  37 #define PSP_1_MEG               0x100000
  38 #define PSP_TMR_SIZE    0x400000
  39 #define PSP_HDCP_SHARED_MEM_SIZE        0x4000
  40 #define PSP_DTM_SHARED_MEM_SIZE 0x4000
  41 #define PSP_SHARED_MEM_SIZE             0x4000
  42
  43 struct psp_context;
  44 struct psp_xgmi_node_info;
  45 struct psp_xgmi_topology_info;
  46
  47 enum psp_bootloader_cmd {
  48         PSP_BL__LOAD_SYSDRV             = 0x10000,
  49         PSP_BL__LOAD_SOSDRV             = 0x20000,
  50         PSP_BL__LOAD_KEY_DATABASE       = 0x80000,
  51         PSP_BL__DRAM_LONG_TRAIN         = 0x100000,
  52         PSP_BL__DRAM_SHORT_TRAIN        = 0x200000,
  53 };
  54
  55 enum psp_ring_type
  56 {
  57         PSP_RING_TYPE__INVALID = 0,
  58         /*
  59          * These values map to the way the PSP kernel identifies the
  60          * rings.
  61          */
  62         PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
  63         PSP_RING_TYPE__KM = 2  /* Kernel mode ring (formerly called GPCOM) */
  64 };
  65
  66 struct psp_ring
  67 {
  68         enum psp_ring_type              ring_type;
  69         struct psp_gfx_rb_frame         *ring_mem;
  70         uint64_t                        ring_mem_mc_addr;
  71         void                            *ring_mem_handle;
  72         uint32_t                        ring_size;
  73 };
  74
  75 /* More registers may will be supported */
  76 enum psp_reg_prog_id {
  77         PSP_REG_IH_RB_CNTL        = 0,  /* register IH_RB_CNTL */
  78         PSP_REG_IH_RB_CNTL_RING1  = 1,  /* register IH_RB_CNTL_RING1 */
  79         PSP_REG_IH_RB_CNTL_RING2  = 2,  /* register IH_RB_CNTL_RING2 */
  80         PSP_REG_LAST
  81 };
  82
  83 struct psp_funcs
  84 {
  85         int (*init_microcode)(struct psp_context *psp);
  86         int (*bootloader_load_kdb)(struct psp_context *psp);
  87         int (*bootloader_load_sysdrv)(struct psp_context *psp);
  88         int (*bootloader_load_sos)(struct psp_context *psp);
  89         int (*ring_init)(struct psp_context *psp, enum psp_ring_type ring_type);
  90         int (*ring_create)(struct psp_context *psp,
  91                            enum psp_ring_type ring_type);
  92         int (*ring_stop)(struct psp_context *psp,
  93                             enum psp_ring_type ring_type);
  94         int (*ring_destroy)(struct psp_context *psp,
  95                             enum psp_ring_type ring_type);
  96         bool (*compare_sram_data)(struct psp_context *psp,
  97                                   struct amdgpu_firmware_info *ucode,
  98                                   enum AMDGPU_UCODE_ID ucode_type);
  99         bool (*smu_reload_quirk)(struct psp_context *psp);
 100         int (*mode1_reset)(struct psp_context *psp);
 101         int (*xgmi_get_node_id)(struct psp_context *psp, uint64_t *node_id);
 102         int (*xgmi_get_hive_id)(struct psp_context *psp, uint64_t *hive_id);
 103         int (*xgmi_get_topology_info)(struct psp_context *psp, int number_devices,
 104                                       struct psp_xgmi_topology_info *topology);
 105         int (*xgmi_set_topology_info)(struct psp_context *psp, int number_devices,
 106                                       struct psp_xgmi_topology_info *topology);
 107         bool (*support_vmr_ring)(struct psp_context *psp);
 108         int (*ras_trigger_error)(struct psp_context *psp,
 109                         struct ta_ras_trigger_error_input *info);
 110         int (*ras_cure_posion)(struct psp_context *psp, uint64_t *mode_ptr);
 111         int (*rlc_autoload_start)(struct psp_context *psp);
 112         int (*mem_training_init)(struct psp_context *psp);
 113         void (*mem_training_fini)(struct psp_context *psp);
 114         int (*mem_training)(struct psp_context *psp, uint32_t ops);
 115         uint32_t (*ring_get_wptr)(struct psp_context *psp);
 116         void (*ring_set_wptr)(struct psp_context *psp, uint32_t value);
 117 };
 118
 119 #define AMDGPU_XGMI_MAX_CONNECTED_NODES         64
 120 struct psp_xgmi_node_info {
 121         uint64_t                                node_id;
 122         uint8_t                                 num_hops;
 123         uint8_t                                 is_sharing_enabled;
 124         enum ta_xgmi_assigned_sdma_engine       sdma_engine;
 125 };
 126
 127 struct psp_xgmi_topology_info {
 128         uint32_t                        num_nodes;
 129         struct psp_xgmi_node_info       nodes[AMDGPU_XGMI_MAX_CONNECTED_NODES];
 130 };
 131
 132 struct psp_asd_context {
 133         bool                    asd_initialized;
 134         uint32_t                session_id;
 135 };
 136
 137 struct psp_xgmi_context {
 138         uint8_t                         initialized;
 139         uint32_t                        session_id;
 140         struct amdgpu_bo                *xgmi_shared_bo;
 141         uint64_t                        xgmi_shared_mc_addr;
 142         void                            *xgmi_shared_buf;
 143         struct psp_xgmi_topology_info   top_info;
 144 };
 145
 146 struct psp_ras_context {
 147         /*ras fw*/
 148         bool                    ras_initialized;
 149         uint32_t                session_id;
 150         struct amdgpu_bo        *ras_shared_bo;
 151         uint64_t                ras_shared_mc_addr;
 152         void                    *ras_shared_buf;
 153         struct amdgpu_ras       *ras;
 154 };
 155
 156 struct psp_hdcp_context {
 157         bool                    hdcp_initialized;
 158         uint32_t                session_id;
 159         struct amdgpu_bo        *hdcp_shared_bo;
 160         uint64_t                hdcp_shared_mc_addr;
 161         void                    *hdcp_shared_buf;
 162 };
 163
 164 struct psp_dtm_context {
 165         bool                    dtm_initialized;
 166         uint32_t                session_id;
 167         struct amdgpu_bo        *dtm_shared_bo;
 168         uint64_t                dtm_shared_mc_addr;
 169         void                    *dtm_shared_buf;
 170 };
 171
 172 #define MEM_TRAIN_SYSTEM_SIGNATURE              0x54534942
 173 #define GDDR6_MEM_TRAINING_DATA_SIZE_IN_BYTES   0x1000
 174 #define GDDR6_MEM_TRAINING_OFFSET               0x8000
 175
 176 enum psp_memory_training_init_flag {
 177         PSP_MEM_TRAIN_NOT_SUPPORT       = 0x0,
 178         PSP_MEM_TRAIN_SUPPORT           = 0x1,
 179         PSP_MEM_TRAIN_INIT_FAILED       = 0x2,
 180         PSP_MEM_TRAIN_RESERVE_SUCCESS   = 0x4,
 181         PSP_MEM_TRAIN_INIT_SUCCESS      = 0x8,
 182 };
 183
 184 enum psp_memory_training_ops {
 185         PSP_MEM_TRAIN_SEND_LONG_MSG     = 0x1,
 186         PSP_MEM_TRAIN_SAVE              = 0x2,
 187         PSP_MEM_TRAIN_RESTORE           = 0x4,
 188         PSP_MEM_TRAIN_SEND_SHORT_MSG    = 0x8,
 189         PSP_MEM_TRAIN_COLD_BOOT         = PSP_MEM_TRAIN_SEND_LONG_MSG,
 190         PSP_MEM_TRAIN_RESUME            = PSP_MEM_TRAIN_SEND_SHORT_MSG,
 191 };
 192
 193 struct psp_memory_training_context {
 194         /*training data size*/
 195         u64 train_data_size;
 196         /*
 197          * sys_cache
 198          * cpu virtual address
 199          * system memory buffer that used to store the training data.
 200          */
 201         void *sys_cache;
 202
 203         /*vram offset of the p2c training data*/
 204         u64 p2c_train_data_offset;
 205
 206         /*vram offset of the c2p training data*/
 207         u64 c2p_train_data_offset;
 208         struct amdgpu_bo *c2p_bo;
 209
 210         enum psp_memory_training_init_flag init;
 211         u32 training_cnt;
 212 };
 213
 214 struct psp_context
 215 {
 216         struct amdgpu_device            *adev;
 217         struct psp_ring                 km_ring;
 218         struct psp_gfx_cmd_resp         *cmd;
 219
 220         const struct psp_funcs          *funcs;
 221
 222         /* firmware buffer */
 223         struct amdgpu_bo                *fw_pri_bo;
 224         uint64_t                        fw_pri_mc_addr;
 225         void                            *fw_pri_buf;
 226
 227         /* sos firmware */
 228         const struct firmware           *sos_fw;
 229         uint32_t                        sos_fw_version;
 230         uint32_t                        sos_feature_version;
 231         uint32_t                        sys_bin_size;
 232         uint32_t                        sos_bin_size;
 233         uint32_t                        toc_bin_size;
 234         uint32_t                        kdb_bin_size;
 235         uint8_t                         *sys_start_addr;
 236         uint8_t                         *sos_start_addr;
 237         uint8_t                         *toc_start_addr;
 238         uint8_t                         *kdb_start_addr;
 239
 240         /* tmr buffer */
 241         struct amdgpu_bo                *tmr_bo;
 242         uint64_t                        tmr_mc_addr;
 243
 244         /* asd firmware */
 245         const struct firmware           *asd_fw;
 246         uint32_t                        asd_fw_version;
 247         uint32_t                        asd_feature_version;
 248         uint32_t                        asd_ucode_size;
 249         uint8_t                         *asd_start_addr;
 250
 251         /* fence buffer */
 252         struct amdgpu_bo                *fence_buf_bo;
 253         uint64_t                        fence_buf_mc_addr;
 254         void                            *fence_buf;
 255
 256         /* cmd buffer */
 257         struct amdgpu_bo                *cmd_buf_bo;
 258         uint64_t                        cmd_buf_mc_addr;
 259         struct psp_gfx_cmd_resp         *cmd_buf_mem;
 260
 261         /* fence value associated with cmd buffer */
 262         atomic_t                        fence_value;
 263         /* flag to mark whether gfx fw autoload is supported or not */
 264         bool                            autoload_supported;
 265
 266         /* xgmi ta firmware and buffer */
 267         const struct firmware           *ta_fw;
 268         uint32_t                        ta_fw_version;
 269         uint32_t                        ta_xgmi_ucode_version;
 270         uint32_t                        ta_xgmi_ucode_size;
 271         uint8_t                         *ta_xgmi_start_addr;
 272         uint32_t                        ta_ras_ucode_version;
 273         uint32_t                        ta_ras_ucode_size;
 274         uint8_t                         *ta_ras_start_addr;
 275
 276         uint32_t                        ta_hdcp_ucode_version;
 277         uint32_t                        ta_hdcp_ucode_size;
 278         uint8_t                         *ta_hdcp_start_addr;
 279
 280         uint32_t                        ta_dtm_ucode_version;
 281         uint32_t                        ta_dtm_ucode_size;
 282         uint8_t                         *ta_dtm_start_addr;
 283
 284         struct psp_asd_context          asd_context;
 285         struct psp_xgmi_context         xgmi_context;
 286         struct psp_ras_context          ras;
 287         struct psp_hdcp_context         hdcp_context;
 288         struct psp_dtm_context          dtm_context;
 289         struct mutex                    mutex;
 290         struct psp_memory_training_context mem_train_ctx;
 291 };
 292
 293 struct amdgpu_psp_funcs {
 294         bool (*check_fw_loading_status)(struct amdgpu_device *adev,
 295                                         enum AMDGPU_UCODE_ID);
 296 };
 297
 298
 299 #define psp_ring_init(psp, type) (psp)->funcs->ring_init((psp), (type))
 300 #define psp_ring_create(psp, type) (psp)->funcs->ring_create((psp), (type))
 301 #define psp_ring_stop(psp, type) (psp)->funcs->ring_stop((psp), (type))
 302 #define psp_ring_destroy(psp, type) ((psp)->funcs->ring_destroy((psp), (type)))
 303 #define psp_compare_sram_data(psp, ucode, type) \
 304                 (psp)->funcs->compare_sram_data((psp), (ucode), (type))
 305 #define psp_init_microcode(psp) \
 306                 ((psp)->funcs->init_microcode ? (psp)->funcs->init_microcode((psp)) : 0)
 307 #define psp_bootloader_load_kdb(psp) \
 308                 ((psp)->funcs->bootloader_load_kdb ? (psp)->funcs->bootloader_load_kdb((psp)) : 0)
 309 #define psp_bootloader_load_sysdrv(psp) \
 310                 ((psp)->funcs->bootloader_load_sysdrv ? (psp)->funcs->bootloader_load_sysdrv((psp)) : 0)
 311 #define psp_bootloader_load_sos(psp) \
 312                 ((psp)->funcs->bootloader_load_sos ? (psp)->funcs->bootloader_load_sos((psp)) : 0)
 313 #define psp_smu_reload_quirk(psp) \
 314                 ((psp)->funcs->smu_reload_quirk ? (psp)->funcs->smu_reload_quirk((psp)) : false)
 315 #define psp_support_vmr_ring(psp) \
 316                 ((psp)->funcs->support_vmr_ring ? (psp)->funcs->support_vmr_ring((psp)) : false)
 317 #define psp_mode1_reset(psp) \
 318                 ((psp)->funcs->mode1_reset ? (psp)->funcs->mode1_reset((psp)) : false)
 319 #define psp_xgmi_get_node_id(psp, node_id) \
 320                 ((psp)->funcs->xgmi_get_node_id ? (psp)->funcs->xgmi_get_node_id((psp), (node_id)) : -EINVAL)
 321 #define psp_xgmi_get_hive_id(psp, hive_id) \
 322                 ((psp)->funcs->xgmi_get_hive_id ? (psp)->funcs->xgmi_get_hive_id((psp), (hive_id)) : -EINVAL)
 323 #define psp_xgmi_get_topology_info(psp, num_device, topology) \
 324                 ((psp)->funcs->xgmi_get_topology_info ? \
 325                 (psp)->funcs->xgmi_get_topology_info((psp), (num_device), (topology)) : -EINVAL)
 326 #define psp_xgmi_set_topology_info(psp, num_device, topology) \
 327                 ((psp)->funcs->xgmi_set_topology_info ?  \
 328                 (psp)->funcs->xgmi_set_topology_info((psp), (num_device), (topology)) : -EINVAL)
 329 #define psp_rlc_autoload(psp) \
 330                 ((psp)->funcs->rlc_autoload_start ? (psp)->funcs->rlc_autoload_start((psp)) : 0)
 331 #define psp_mem_training_init(psp) \
 332         ((psp)->funcs->mem_training_init ? (psp)->funcs->mem_training_init((psp)) : 0)
 333 #define psp_mem_training_fini(psp) \
 334         ((psp)->funcs->mem_training_fini ? (psp)->funcs->mem_training_fini((psp)) : 0)
 335 #define psp_mem_training(psp, ops) \
 336         ((psp)->funcs->mem_training ? (psp)->funcs->mem_training((psp), (ops)) : 0)
 337
 338 #define amdgpu_psp_check_fw_loading_status(adev, i) (adev)->firmware.funcs->check_fw_loading_status((adev), (i))
 339
 340 #define psp_ras_trigger_error(psp, info) \
 341         ((psp)->funcs->ras_trigger_error ? \
 342         (psp)->funcs->ras_trigger_error((psp), (info)) : -EINVAL)
 343 #define psp_ras_cure_posion(psp, addr) \
 344         ((psp)->funcs->ras_cure_posion ? \
 345         (psp)->funcs->ras_cure_posion(psp, (addr)) : -EINVAL)
 346
 347 #define psp_ring_get_wptr(psp) (psp)->funcs->ring_get_wptr((psp))
 348 #define psp_ring_set_wptr(psp, value) (psp)->funcs->ring_set_wptr((psp), (value))
 349
 350 extern const struct amd_ip_funcs psp_ip_funcs;
 351
 352 extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
 353 extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
 354                         uint32_t field_val, uint32_t mask, bool check_changed);
 355
 356 extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
 357 extern const struct amdgpu_ip_block_version psp_v12_0_ip_block;
 358
 359 int psp_gpu_reset(struct amdgpu_device *adev);
 360 int psp_update_vcn_sram(struct amdgpu_device *adev, int inst_idx,
 361                         uint64_t cmd_gpu_addr, int cmd_size);
 362
 363 int psp_xgmi_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 364
 365 int psp_ras_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 366 int psp_ras_enable_features(struct psp_context *psp,
 367                 union ta_ras_cmd_input *info, bool enable);
 368 int psp_hdcp_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 369 int psp_dtm_invoke(struct psp_context *psp, uint32_t ta_cmd_id);
 370
 371 int psp_rlc_autoload_start(struct psp_context *psp);
 372
 373 extern const struct amdgpu_ip_block_version psp_v11_0_ip_block;
 374 int psp_reg_program(struct psp_context *psp, enum psp_reg_prog_id reg,
 375                 uint32_t value);
 376 int psp_ring_cmd_submit(struct psp_context *psp,
 377                         uint64_t cmd_buf_mc_addr,
 378                         uint64_t fence_mc_addr,
 379                         int index);
 380 #endif