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

   1 /*
   2  * Copyright 2017 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  */
  23
  24 #ifndef _PSP_TEE_GFX_IF_H_
  25 #define _PSP_TEE_GFX_IF_H_
  26
  27 #define PSP_GFX_CMD_BUF_VERSION     0x00000001
  28
  29 #define GFX_CMD_STATUS_MASK         0x0000FFFF
  30 #define GFX_CMD_ID_MASK             0x000F0000
  31 #define GFX_CMD_RESERVED_MASK       0x7FF00000
  32 #define GFX_CMD_RESPONSE_MASK       0x80000000
  33
  34 /* TEE Gfx Command IDs for the register interface.
  35 *  Command ID must be between 0x00010000 and 0x000F0000.
  36 */
  37 enum psp_gfx_crtl_cmd_id
  38 {
  39     GFX_CTRL_CMD_ID_INIT_RBI_RING   = 0x00010000,   /* initialize RBI ring */
  40     GFX_CTRL_CMD_ID_INIT_GPCOM_RING = 0x00020000,   /* initialize GPCOM ring */
  41     GFX_CTRL_CMD_ID_DESTROY_RINGS   = 0x00030000,   /* destroy rings */
  42     GFX_CTRL_CMD_ID_CAN_INIT_RINGS  = 0x00040000,   /* is it allowed to initialized the rings */
  43     GFX_CTRL_CMD_ID_ENABLE_INT      = 0x00050000,   /* enable PSP-to-Gfx interrupt */
  44     GFX_CTRL_CMD_ID_DISABLE_INT     = 0x00060000,   /* disable PSP-to-Gfx interrupt */
  45     GFX_CTRL_CMD_ID_MODE1_RST       = 0x00070000,   /* trigger the Mode 1 reset */
  46     GFX_CTRL_CMD_ID_GBR_IH_SET      = 0x00080000,   /* set Gbr IH_RB_CNTL registers */
  47     GFX_CTRL_CMD_ID_CONSUME_CMD     = 0x000A0000,   /* send interrupt to psp for updating write pointer of vf */
  48     GFX_CTRL_CMD_ID_DESTROY_GPCOM_RING = 0x000C0000, /* destroy GPCOM ring */
  49
  50     GFX_CTRL_CMD_ID_MAX             = 0x000F0000,   /* max command ID */
  51 };
  52
  53
  54 /*-----------------------------------------------------------------------------
  55     NOTE:   All physical addresses used in this interface are actually
  56             GPU Virtual Addresses.
  57 */
  58
  59
  60 /* Control registers of the TEE Gfx interface. These are located in
  61 *  SRBM-to-PSP mailbox registers (total 8 registers).
  62 */
  63 struct psp_gfx_ctrl
  64 {
  65     volatile uint32_t   cmd_resp;         /* +0   Command/Response register for Gfx commands */
  66     volatile uint32_t   rbi_wptr;         /* +4   Write pointer (index) of RBI ring */
  67     volatile uint32_t   rbi_rptr;         /* +8   Read pointer (index) of RBI ring */
  68     volatile uint32_t   gpcom_wptr;       /* +12  Write pointer (index) of GPCOM ring */
  69     volatile uint32_t   gpcom_rptr;       /* +16  Read pointer (index) of GPCOM ring */
  70     volatile uint32_t   ring_addr_lo;     /* +20  bits [31:0] of GPU Virtual of ring buffer (VMID=0)*/
  71     volatile uint32_t   ring_addr_hi;     /* +24  bits [63:32] of GPU Virtual of ring buffer (VMID=0) */
  72     volatile uint32_t   ring_buf_size;    /* +28  Ring buffer size (in bytes) */
  73
  74 };
  75
  76
  77 /* Response flag is set in the command when command is completed by PSP.
  78 *  Used in the GFX_CTRL.CmdResp.
  79 *  When PSP GFX I/F is initialized, the flag is set.
  80 */
  81 #define GFX_FLAG_RESPONSE               0x80000000
  82
  83 /* Gbr IH registers ID */
  84 enum ih_reg_id {
  85         IH_RB           = 0,            // IH_RB_CNTL
  86         IH_RB_RNG1      = 1,            // IH_RB_CNTL_RING1
  87         IH_RB_RNG2      = 2,            // IH_RB_CNTL_RING2
  88 };
  89
  90 /* Command to setup Gibraltar IH register */
  91 struct psp_gfx_cmd_gbr_ih_reg {
  92         uint32_t                reg_value;      /* Value to be set to the IH_RB_CNTL... register*/
  93         enum ih_reg_id          reg_id;         /* ID of the register */
  94 };
  95
  96 /* TEE Gfx Command IDs for the ring buffer interface. */
  97 enum psp_gfx_cmd_id
  98 {
  99     GFX_CMD_ID_LOAD_TA      = 0x00000001,   /* load TA */
 100     GFX_CMD_ID_UNLOAD_TA    = 0x00000002,   /* unload TA */
 101     GFX_CMD_ID_INVOKE_CMD   = 0x00000003,   /* send command to TA */
 102     GFX_CMD_ID_LOAD_ASD     = 0x00000004,   /* load ASD Driver */
 103     GFX_CMD_ID_SETUP_TMR    = 0x00000005,   /* setup TMR region */
 104     GFX_CMD_ID_LOAD_IP_FW   = 0x00000006,   /* load HW IP FW */
 105     GFX_CMD_ID_DESTROY_TMR  = 0x00000007,   /* destroy TMR region */
 106     GFX_CMD_ID_SAVE_RESTORE = 0x00000008,   /* save/restore HW IP FW */
 107     GFX_CMD_ID_SETUP_VMR    = 0x00000009,   /* setup VMR region */
 108     GFX_CMD_ID_DESTROY_VMR  = 0x0000000A,   /* destroy VMR region */
 109     GFX_CMD_ID_PROG_REG     = 0x0000000B,   /* program regs */
 110     /* IDs upto 0x1F are reserved for older programs (Raven, Vega 10/12/20) */
 111     GFX_CMD_ID_LOAD_TOC     = 0x00000020,   /* Load TOC and obtain TMR size */
 112     GFX_CMD_ID_AUTOLOAD_RLC = 0x00000021,   /* Indicates all graphics fw loaded, start RLC autoload */
 113 };
 114
 115 /* Command to load Trusted Application binary into PSP OS. */
 116 struct psp_gfx_cmd_load_ta
 117 {
 118     uint32_t        app_phy_addr_lo;        /* bits [31:0] of the GPU Virtual address of the TA binary (must be 4 KB aligned) */
 119     uint32_t        app_phy_addr_hi;        /* bits [63:32] of the GPU Virtual address of the TA binary */
 120     uint32_t        app_len;                /* length of the TA binary in bytes */
 121     uint32_t        cmd_buf_phy_addr_lo;    /* bits [31:0] of the GPU Virtual address of CMD buffer (must be 4 KB aligned) */
 122     uint32_t        cmd_buf_phy_addr_hi;    /* bits [63:32] of the GPU Virtual address of CMD buffer */
 123     uint32_t        cmd_buf_len;            /* length of the CMD buffer in bytes; must be multiple of 4 KB */
 124
 125     /* Note: CmdBufLen can be set to 0. In this case no persistent CMD buffer is provided
 126     *       for the TA. Each InvokeCommand can have dinamically mapped CMD buffer instead
 127     *       of using global persistent buffer.
 128     */
 129 };
 130
 131
 132 /* Command to Unload Trusted Application binary from PSP OS. */
 133 struct psp_gfx_cmd_unload_ta
 134 {
 135     uint32_t        session_id;          /* Session ID of the loaded TA to be unloaded */
 136
 137 };
 138
 139
 140 /* Shared buffers for InvokeCommand.
 141 */
 142 struct psp_gfx_buf_desc
 143 {
 144     uint32_t        buf_phy_addr_lo;       /* bits [31:0] of GPU Virtual address of the buffer (must be 4 KB aligned) */
 145     uint32_t        buf_phy_addr_hi;       /* bits [63:32] of GPU Virtual address of the buffer */
 146     uint32_t        buf_size;              /* buffer size in bytes (must be multiple of 4 KB and no bigger than 64 MB) */
 147
 148 };
 149
 150 /* Max number of descriptors for one shared buffer (in how many different
 151 *  physical locations one shared buffer can be stored). If buffer is too much
 152 *  fragmented, error will be returned.
 153 */
 154 #define GFX_BUF_MAX_DESC        64
 155
 156 struct psp_gfx_buf_list
 157 {
 158     uint32_t                num_desc;                    /* number of buffer descriptors in the list */
 159     uint32_t                total_size;                  /* total size of all buffers in the list in bytes (must be multiple of 4 KB) */
 160     struct psp_gfx_buf_desc buf_desc[GFX_BUF_MAX_DESC];  /* list of buffer descriptors */
 161
 162     /* total 776 bytes */
 163 };
 164
 165 /* Command to execute InvokeCommand entry point of the TA. */
 166 struct psp_gfx_cmd_invoke_cmd
 167 {
 168     uint32_t                session_id;           /* Session ID of the TA to be executed */
 169     uint32_t                ta_cmd_id;            /* Command ID to be sent to TA */
 170     struct psp_gfx_buf_list buf;                  /* one indirect buffer (scatter/gather list) */
 171
 172 };
 173
 174
 175 /* Command to setup TMR region. */
 176 struct psp_gfx_cmd_setup_tmr
 177 {
 178     uint32_t        buf_phy_addr_lo;       /* bits [31:0] of GPU Virtual address of TMR buffer (must be 4 KB aligned) */
 179     uint32_t        buf_phy_addr_hi;       /* bits [63:32] of GPU Virtual address of TMR buffer */
 180     uint32_t        buf_size;              /* buffer size in bytes (must be multiple of 4 KB) */
 181
 182 };
 183
 184
 185 /* FW types for GFX_CMD_ID_LOAD_IP_FW command. Limit 31. */
 186 enum psp_gfx_fw_type {
 187         GFX_FW_TYPE_NONE        = 0,    /* */
 188         GFX_FW_TYPE_CP_ME       = 1,    /* CP-ME                    VG + RV */
 189         GFX_FW_TYPE_CP_PFP      = 2,    /* CP-PFP                   VG + RV */
 190         GFX_FW_TYPE_CP_CE       = 3,    /* CP-CE                    VG + RV */
 191         GFX_FW_TYPE_CP_MEC      = 4,    /* CP-MEC FW                VG + RV */
 192         GFX_FW_TYPE_CP_MEC_ME1  = 5,    /* CP-MEC Jump Table 1      VG + RV */
 193         GFX_FW_TYPE_CP_MEC_ME2  = 6,    /* CP-MEC Jump Table 2      VG      */
 194         GFX_FW_TYPE_RLC_V       = 7,    /* RLC-V                    VG      */
 195         GFX_FW_TYPE_RLC_G       = 8,    /* RLC-G                    VG + RV */
 196         GFX_FW_TYPE_SDMA0       = 9,    /* SDMA0                    VG + RV */
 197         GFX_FW_TYPE_SDMA1       = 10,   /* SDMA1                    VG      */
 198         GFX_FW_TYPE_DMCU_ERAM   = 11,   /* DMCU-ERAM                VG + RV */
 199         GFX_FW_TYPE_DMCU_ISR    = 12,   /* DMCU-ISR                 VG + RV */
 200         GFX_FW_TYPE_VCN         = 13,   /* VCN                           RV */
 201         GFX_FW_TYPE_UVD         = 14,   /* UVD                      VG      */
 202         GFX_FW_TYPE_VCE         = 15,   /* VCE                      VG      */
 203         GFX_FW_TYPE_ISP         = 16,   /* ISP                           RV */
 204         GFX_FW_TYPE_ACP         = 17,   /* ACP                           RV */
 205         GFX_FW_TYPE_SMU         = 18,   /* SMU                      VG      */
 206         GFX_FW_TYPE_MMSCH       = 19,   /* MMSCH                    VG      */
 207         GFX_FW_TYPE_RLC_RESTORE_LIST_GPM_MEM        = 20,   /* RLC GPM                  VG + RV */
 208         GFX_FW_TYPE_RLC_RESTORE_LIST_SRM_MEM        = 21,   /* RLC SRM                  VG + RV */
 209         GFX_FW_TYPE_RLC_RESTORE_LIST_SRM_CNTL       = 22,   /* RLC CNTL                 VG + RV */
 210         GFX_FW_TYPE_UVD1        = 23,   /* UVD1                     VG-20   */
 211         GFX_FW_TYPE_TOC         = 24,   /* TOC                      NV-10   */
 212         GFX_FW_TYPE_RLC_P                           = 25,   /* RLC P                    NV      */
 213         GFX_FW_TYPE_RLX6                            = 26,   /* RLX6                     NV      */
 214         GFX_FW_TYPE_GLOBAL_TAP_DELAYS               = 27,   /* GLOBAL TAP DELAYS        NV      */
 215         GFX_FW_TYPE_SE0_TAP_DELAYS                  = 28,   /* SE0 TAP DELAYS           NV      */
 216         GFX_FW_TYPE_SE1_TAP_DELAYS                  = 29,   /* SE1 TAP DELAYS           NV      */
 217         GFX_FW_TYPE_GLOBAL_SE0_SE1_SKEW_DELAYS      = 30,   /* GLOBAL SE0/1 SKEW DELAYS NV      */
 218         GFX_FW_TYPE_SDMA0_JT                        = 31,   /* SDMA0 JT                 NV      */
 219         GFX_FW_TYPE_SDMA1_JT                        = 32,   /* SDNA1 JT                 NV      */
 220         GFX_FW_TYPE_CP_MES                          = 33,   /* CP MES                   NV      */
 221         GFX_FW_TYPE_MES_STACK                       = 34,   /* MES STACK                NV      */
 222         GFX_FW_TYPE_RLC_SRM_DRAM_SR                 = 35,   /* RLC SRM DRAM             NV      */
 223         GFX_FW_TYPE_RLCG_SCRATCH_SR                 = 36,   /* RLCG SCRATCH             NV      */
 224         GFX_FW_TYPE_RLCP_SCRATCH_SR                 = 37,   /* RLCP SCRATCH             NV      */
 225         GFX_FW_TYPE_RLCV_SCRATCH_SR                 = 38,   /* RLCV SCRATCH             NV      */
 226         GFX_FW_TYPE_RLX6_DRAM_SR                    = 39,   /* RLX6 DRAM                NV      */
 227         GFX_FW_TYPE_SDMA0_PG_CONTEXT                = 40,   /* SDMA0 PG CONTEXT         NV      */
 228         GFX_FW_TYPE_SDMA1_PG_CONTEXT                = 41,   /* SDMA1 PG CONTEXT         NV      */
 229         GFX_FW_TYPE_GLOBAL_MUX_SELECT_RAM           = 42,   /* GLOBAL MUX SEL RAM       NV      */
 230         GFX_FW_TYPE_SE0_MUX_SELECT_RAM              = 43,   /* SE0 MUX SEL RAM          NV      */
 231         GFX_FW_TYPE_SE1_MUX_SELECT_RAM              = 44,   /* SE1 MUX SEL RAM          NV      */
 232         GFX_FW_TYPE_ACCUM_CTRL_RAM                  = 45,   /* ACCUM CTRL RAM           NV      */
 233         GFX_FW_TYPE_RLCP_CAM                        = 46,   /* RLCP CAM                 NV      */
 234         GFX_FW_TYPE_RLC_SPP_CAM_EXT                 = 47,   /* RLC SPP CAM EXT          NV      */
 235         GFX_FW_TYPE_RLX6_DRAM_BOOT                  = 48,   /* RLX6 DRAM BOOT           NV      */
 236         GFX_FW_TYPE_VCN0_RAM                        = 49,   /* VCN_RAM  NV */
 237         GFX_FW_TYPE_VCN1_RAM                        = 50,   /* VCN_RAM  NV */
 238         GFX_FW_TYPE_MAX
 239 };
 240
 241 /* Command to load HW IP FW. */
 242 struct psp_gfx_cmd_load_ip_fw
 243 {
 244     uint32_t                fw_phy_addr_lo;    /* bits [31:0] of GPU Virtual address of FW location (must be 4 KB aligned) */
 245     uint32_t                fw_phy_addr_hi;    /* bits [63:32] of GPU Virtual address of FW location */
 246     uint32_t                fw_size;           /* FW buffer size in bytes */
 247     enum psp_gfx_fw_type    fw_type;           /* FW type */
 248
 249 };
 250
 251 /* Command to save/restore HW IP FW. */
 252 struct psp_gfx_cmd_save_restore_ip_fw
 253 {
 254     uint32_t                save_fw;              /* if set, command is used for saving fw otherwise for resetoring*/
 255     uint32_t                save_restore_addr_lo; /* bits [31:0] of FB address of GART memory used as save/restore buffer (must be 4 KB aligned) */
 256     uint32_t                save_restore_addr_hi; /* bits [63:32] of FB address of GART memory used as save/restore buffer */
 257     uint32_t                buf_size;             /* Size of the save/restore buffer in bytes */
 258     enum psp_gfx_fw_type    fw_type;              /* FW type */
 259 };
 260
 261 /* Command to setup register program */
 262 struct psp_gfx_cmd_reg_prog {
 263         uint32_t        reg_value;
 264         uint32_t        reg_id;
 265 };
 266
 267 /* Command to load TOC */
 268 struct psp_gfx_cmd_load_toc
 269 {
 270     uint32_t        toc_phy_addr_lo;        /* bits [31:0] of GPU Virtual address of FW location (must be 4 KB aligned) */
 271     uint32_t        toc_phy_addr_hi;        /* bits [63:32] of GPU Virtual address of FW location */
 272     uint32_t        toc_size;               /* FW buffer size in bytes */
 273 };
 274
 275 /* All GFX ring buffer commands. */
 276 union psp_gfx_commands
 277 {
 278     struct psp_gfx_cmd_load_ta          cmd_load_ta;
 279     struct psp_gfx_cmd_unload_ta        cmd_unload_ta;
 280     struct psp_gfx_cmd_invoke_cmd       cmd_invoke_cmd;
 281     struct psp_gfx_cmd_setup_tmr        cmd_setup_tmr;
 282     struct psp_gfx_cmd_load_ip_fw       cmd_load_ip_fw;
 283     struct psp_gfx_cmd_save_restore_ip_fw cmd_save_restore_ip_fw;
 284     struct psp_gfx_cmd_reg_prog       cmd_setup_reg_prog;
 285     struct psp_gfx_cmd_setup_tmr        cmd_setup_vmr;
 286     struct psp_gfx_cmd_load_toc         cmd_load_toc;
 287 };
 288
 289 /* Structure of GFX Response buffer.
 290 * For GPCOM I/F it is part of GFX_CMD_RESP buffer, for RBI
 291 * it is separate buffer.
 292 */
 293 struct psp_gfx_resp
 294 {
 295     uint32_t    status;         /* +0  status of command execution */
 296     uint32_t    session_id;     /* +4  session ID in response to LoadTa command */
 297     uint32_t    fw_addr_lo;     /* +8  bits [31:0] of FW address within TMR (in response to cmd_load_ip_fw command) */
 298     uint32_t    fw_addr_hi;     /* +12 bits [63:32] of FW address within TMR (in response to cmd_load_ip_fw command) */
 299     uint32_t    tmr_size;       /* +16 size of the TMR to be reserved including MM fw and Gfx fw in response to cmd_load_toc command */
 300
 301     uint32_t    reserved[3];
 302
 303     /* total 32 bytes */
 304 };
 305
 306 /* Structure of Command buffer pointed by psp_gfx_rb_frame.cmd_buf_addr_hi
 307 *  and psp_gfx_rb_frame.cmd_buf_addr_lo.
 308 */
 309 struct psp_gfx_cmd_resp
 310 {
 311     uint32_t        buf_size;           /* +0  total size of the buffer in bytes */
 312     uint32_t        buf_version;        /* +4  version of the buffer strusture; must be PSP_GFX_CMD_BUF_VERSION */
 313     uint32_t        cmd_id;             /* +8  command ID */
 314
 315     /* These fields are used for RBI only. They are all 0 in GPCOM commands
 316     */
 317     uint32_t        resp_buf_addr_lo;   /* +12 bits [31:0] of GPU Virtual address of response buffer (must be 4 KB aligned) */
 318     uint32_t        resp_buf_addr_hi;   /* +16 bits [63:32] of GPU Virtual address of response buffer */
 319     uint32_t        resp_offset;        /* +20 offset within response buffer */
 320     uint32_t        resp_buf_size;      /* +24 total size of the response buffer in bytes */
 321
 322     union psp_gfx_commands  cmd;        /* +28 command specific structures */
 323
 324     uint8_t         reserved_1[864 - sizeof(union psp_gfx_commands) - 28];
 325
 326     /* Note: Resp is part of this buffer for GPCOM ring. For RBI ring the response
 327     *        is separate buffer pointed by resp_buf_addr_hi and resp_buf_addr_lo.
 328     */
 329     struct psp_gfx_resp     resp;       /* +864 response */
 330
 331     uint8_t         reserved_2[1024 - 864 - sizeof(struct psp_gfx_resp)];
 332
 333     /* total size 1024 bytes */
 334 };
 335
 336
 337 #define FRAME_TYPE_DESTROY          1   /* frame sent by KMD driver when UMD Scheduler context is destroyed*/
 338
 339 /* Structure of the Ring Buffer Frame */
 340 struct psp_gfx_rb_frame
 341 {
 342     uint32_t    cmd_buf_addr_lo;    /* +0  bits [31:0] of GPU Virtual address of command buffer (must be 4 KB aligned) */
 343     uint32_t    cmd_buf_addr_hi;    /* +4  bits [63:32] of GPU Virtual address of command buffer */
 344     uint32_t    cmd_buf_size;       /* +8  command buffer size in bytes */
 345     uint32_t    fence_addr_lo;      /* +12 bits [31:0] of GPU Virtual address of Fence for this frame */
 346     uint32_t    fence_addr_hi;      /* +16 bits [63:32] of GPU Virtual address of Fence for this frame */
 347     uint32_t    fence_value;        /* +20 Fence value */
 348     uint32_t    sid_lo;             /* +24 bits [31:0] of SID value (used only for RBI frames) */
 349     uint32_t    sid_hi;             /* +28 bits [63:32] of SID value (used only for RBI frames) */
 350     uint8_t     vmid;               /* +32 VMID value used for mapping of all addresses for this frame */
 351     uint8_t     frame_type;         /* +33 1: destory context frame, 0: all other frames; used only for RBI frames */
 352     uint8_t     reserved1[2];       /* +34 reserved, must be 0 */
 353     uint32_t    reserved2[7];       /* +36 reserved, must be 0 */
 354                 /* total 64 bytes */
 355 };
 356
 357 #endif /* _PSP_TEE_GFX_IF_H_ */