1 /* 2 * Copyright (c) 2019-2022, Intel Corporation. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef SOCFPGA_MBOX_H 8 #define SOCFPGA_MBOX_H 9 10 #include <lib/utils_def.h> 11 12 13 #define MBOX_OFFSET 0xffa30000 14 15 #define MBOX_ATF_CLIENT_ID 0x1U 16 #define MBOX_MAX_JOB_ID 0xFU 17 #define MBOX_MAX_IND_JOB_ID (MBOX_MAX_JOB_ID - 1U) 18 #define MBOX_JOB_ID MBOX_MAX_JOB_ID 19 #define MBOX_TEST_BIT BIT(31) 20 21 /* Mailbox Shared Memory Register Map */ 22 #define MBOX_CIN 0x00 23 #define MBOX_ROUT 0x04 24 #define MBOX_URG 0x08 25 #define MBOX_INT 0x0C 26 #define MBOX_COUT 0x20 27 #define MBOX_RIN 0x24 28 #define MBOX_STATUS 0x2C 29 #define MBOX_CMD_BUFFER 0x40 30 #define MBOX_RESP_BUFFER 0xC0 31 32 /* Mailbox SDM doorbell */ 33 #define MBOX_DOORBELL_TO_SDM 0x400 34 #define MBOX_DOORBELL_FROM_SDM 0x480 35 36 37 /* Mailbox commands */ 38 39 #define MBOX_CMD_NOOP 0x00 40 #define MBOX_CMD_SYNC 0x01 41 #define MBOX_CMD_RESTART 0x02 42 #define MBOX_CMD_CANCEL 0x03 43 #define MBOX_CMD_VAB_SRC_CERT 0x0B 44 #define MBOX_CMD_GET_IDCODE 0x10 45 #define MBOX_CMD_GET_USERCODE 0x13 46 #define MBOX_CMD_GET_CHIPID 0x12 47 #define MBOX_CMD_REBOOT_HPS 0x47 48 49 /* Reconfiguration Commands */ 50 #define MBOX_CONFIG_STATUS 0x04 51 #define MBOX_RECONFIG 0x06 52 #define MBOX_RECONFIG_DATA 0x08 53 #define MBOX_RECONFIG_STATUS 0x09 54 55 /* HWMON Commands */ 56 #define MBOX_HWMON_READVOLT 0x18 57 #define MBOX_HWMON_READTEMP 0x19 58 59 60 /* QSPI Commands */ 61 #define MBOX_CMD_QSPI_OPEN 0x32 62 #define MBOX_CMD_QSPI_CLOSE 0x33 63 #define MBOX_CMD_QSPI_SET_CS 0x34 64 #define MBOX_CMD_QSPI_DIRECT 0x3B 65 66 /* SEU Commands */ 67 #define MBOX_CMD_SEU_ERR_READ 0x3C 68 69 /* RSU Commands */ 70 #define MBOX_GET_SUBPARTITION_TABLE 0x5A 71 #define MBOX_RSU_STATUS 0x5B 72 #define MBOX_RSU_UPDATE 0x5C 73 #define MBOX_HPS_STAGE_NOTIFY 0x5D 74 75 /* FCS Command */ 76 #define MBOX_FCS_GET_PROVISION 0x7B 77 #define MBOX_FCS_CNTR_SET_PREAUTH 0x7C 78 #define MBOX_FCS_ENCRYPT_REQ 0x7E 79 #define MBOX_FCS_DECRYPT_REQ 0x7F 80 #define MBOX_FCS_RANDOM_GEN 0x80 81 #define MBOX_FCS_AES_CRYPT_REQ 0x81 82 #define MBOX_FCS_GET_DIGEST_REQ 0x82 83 #define MBOX_FCS_MAC_VERIFY_REQ 0x83 84 #define MBOX_FCS_ECDSA_HASH_SIGN_REQ 0x84 85 #define MBOX_FCS_ECDSA_SHA2_DATA_SIGN_REQ 0x85 86 #define MBOX_FCS_ECDSA_HASH_SIG_VERIFY 0x86 87 #define MBOX_FCS_ECDSA_SHA2_DATA_SIGN_VERIFY 0x87 88 #define MBOX_FCS_ECDSA_GET_PUBKEY 0x88 89 #define MBOX_FCS_ECDH_REQUEST 0x89 90 #define MBOX_FCS_OPEN_CS_SESSION 0xA0 91 #define MBOX_FCS_CLOSE_CS_SESSION 0xA1 92 #define MBOX_FCS_IMPORT_CS_KEY 0xA5 93 #define MBOX_FCS_EXPORT_CS_KEY 0xA6 94 #define MBOX_FCS_REMOVE_CS_KEY 0xA7 95 #define MBOX_FCS_GET_CS_KEY_INFO 0xA8 96 97 /* PSG SIGMA Commands */ 98 #define MBOX_PSG_SIGMA_TEARDOWN 0xD5 99 100 /* Attestation Commands */ 101 #define MBOX_CREATE_CERT_ON_RELOAD 0x180 102 #define MBOX_GET_ATTESTATION_CERT 0x181 103 #define MBOX_ATTESTATION_SUBKEY 0x182 104 #define MBOX_GET_MEASUREMENT 0x183 105 106 /* Miscellaneous commands */ 107 #define MBOX_GET_ROM_PATCH_SHA384 0x1B0 108 109 /* Mailbox Definitions */ 110 111 #define CMD_DIRECT 0 112 #define CMD_INDIRECT 1 113 #define CMD_CASUAL 0 114 #define CMD_URGENT 1 115 116 #define MBOX_WORD_BYTE 4U 117 #define MBOX_RESP_BUFFER_SIZE 16 118 #define MBOX_CMD_BUFFER_SIZE 32 119 #define MBOX_INC_HEADER_MAX_WORD_SIZE 1024U 120 121 /* Execution states for HPS_STAGE_NOTIFY */ 122 #define HPS_EXECUTION_STATE_FSBL 0 123 #define HPS_EXECUTION_STATE_SSBL 1 124 #define HPS_EXECUTION_STATE_OS 2 125 126 /* Status Response */ 127 #define MBOX_RET_OK 0 128 #define MBOX_RET_ERROR -1 129 #define MBOX_NO_RESPONSE -2 130 #define MBOX_WRONG_ID -3 131 #define MBOX_BUFFER_FULL -4 132 #define MBOX_BUSY -5 133 #define MBOX_TIMEOUT -2047 134 135 /* Key Status */ 136 #define MBOX_RET_SDOS_DECRYPTION_ERROR_102 -258 137 #define MBOX_RET_SDOS_DECRYPTION_ERROR_103 -259 138 139 /* Reconfig Status Response */ 140 #define RECONFIG_STATUS_STATE 0 141 #define RECONFIG_STATUS_PIN_STATUS 2 142 #define RECONFIG_STATUS_SOFTFUNC_STATUS 3 143 #define PIN_STATUS_NSTATUS (U(1) << 31) 144 #define SOFTFUNC_STATUS_SEU_ERROR (1 << 3) 145 #define SOFTFUNC_STATUS_INIT_DONE (1 << 1) 146 #define SOFTFUNC_STATUS_CONF_DONE (1 << 0) 147 #define MBOX_CFGSTAT_STATE_IDLE 0x00000000 148 #define MBOX_CFGSTAT_STATE_CONFIG 0x10000000 149 #define MBOX_CFGSTAT_VAB_BS_PREAUTH 0x20000000 150 #define MBOX_CFGSTAT_STATE_FAILACK 0x08000000 151 #define MBOX_CFGSTAT_STATE_ERROR_INVALID 0xf0000001 152 #define MBOX_CFGSTAT_STATE_ERROR_CORRUPT 0xf0000002 153 #define MBOX_CFGSTAT_STATE_ERROR_AUTH 0xf0000003 154 #define MBOX_CFGSTAT_STATE_ERROR_CORE_IO 0xf0000004 155 #define MBOX_CFGSTAT_STATE_ERROR_HARDWARE 0xf0000005 156 #define MBOX_CFGSTAT_STATE_ERROR_FAKE 0xf0000006 157 #define MBOX_CFGSTAT_STATE_ERROR_BOOT_INFO 0xf0000007 158 #define MBOX_CFGSTAT_STATE_ERROR_QSPI_ERROR 0xf0000008 159 160 161 /* Mailbox Macros */ 162 163 #define MBOX_ENTRY_TO_ADDR(_buf, ptr) (MBOX_OFFSET + (MBOX_##_buf##_BUFFER) \ 164 + MBOX_WORD_BYTE * (ptr)) 165 166 /* Mailbox interrupt flags and masks */ 167 #define MBOX_INT_FLAG_COE 0x1 168 #define MBOX_INT_FLAG_RIE 0x2 169 #define MBOX_INT_FLAG_UAE 0x100 170 #define MBOX_COE_BIT(INTERRUPT) ((INTERRUPT) & 0x3) 171 #define MBOX_UAE_BIT(INTERRUPT) (((INTERRUPT) & (1<<8))) 172 173 /* Mailbox response and status */ 174 #define MBOX_RESP_ERR(BUFFER) ((BUFFER) & 0x000007ff) 175 #define MBOX_RESP_LEN(BUFFER) (((BUFFER) & 0x007ff000) >> 12) 176 #define MBOX_RESP_CLIENT_ID(BUFFER) (((BUFFER) & 0xf0000000) >> 28) 177 #define MBOX_RESP_JOB_ID(BUFFER) (((BUFFER) & 0x0f000000) >> 24) 178 #define MBOX_STATUS_UA_MASK (1<<8) 179 180 /* Mailbox command and response */ 181 #define MBOX_CLIENT_ID_CMD(CLIENT_ID) ((CLIENT_ID) << 28) 182 #define MBOX_JOB_ID_CMD(JOB_ID) (JOB_ID<<24) 183 #define MBOX_CMD_LEN_CMD(CMD_LEN) ((CMD_LEN) << 12) 184 #define MBOX_INDIRECT(val) ((val) << 11) 185 #define MBOX_CMD_MASK(header) ((header) & 0x7ff) 186 187 /* Mailbox payload */ 188 #define MBOX_DATA_MAX_LEN 0x3ff 189 #define MBOX_PAYLOAD_FLAG_BUSY BIT(0) 190 191 /* RSU Macros */ 192 #define RSU_VERSION_ACMF BIT(8) 193 #define RSU_VERSION_ACMF_MASK 0xff00 194 195 /* Config Status Macros */ 196 #define CONFIG_STATUS_WORD_SIZE 16U 197 #define CONFIG_STATUS_FW_VER_OFFSET 1 198 #define CONFIG_STATUS_FW_VER_MASK 0x00FFFFFF 199 200 /* Data structure */ 201 202 typedef struct mailbox_payload { 203 uint32_t header; 204 uint32_t data[MBOX_DATA_MAX_LEN]; 205 } mailbox_payload_t; 206 207 typedef struct mailbox_container { 208 uint32_t flag; 209 uint32_t index; 210 mailbox_payload_t *payload; 211 } mailbox_container_t; 212 213 /* Mailbox Function Definitions */ 214 215 void mailbox_set_int(uint32_t interrupt_input); 216 int mailbox_init(void); 217 void mailbox_set_qspi_close(void); 218 void mailbox_hps_qspi_enable(void); 219 220 int mailbox_send_cmd(uint32_t job_id, uint32_t cmd, uint32_t *args, 221 unsigned int len, uint32_t urgent, uint32_t *response, 222 unsigned int *resp_len); 223 int mailbox_send_cmd_async(uint32_t *job_id, uint32_t cmd, uint32_t *args, 224 unsigned int len, unsigned int indirect); 225 int mailbox_send_cmd_async_ext(uint32_t header_cmd, uint32_t *args, 226 unsigned int len); 227 int mailbox_read_response(uint32_t *job_id, uint32_t *response, 228 unsigned int *resp_len); 229 int mailbox_read_response_async(uint32_t *job_id, uint32_t *header, 230 uint32_t *response, unsigned int *resp_len, 231 uint8_t ignore_client_id); 232 int iterate_resp(uint32_t mbox_resp_len, uint32_t *resp_buf, 233 unsigned int *resp_len); 234 235 void mailbox_reset_cold(void); 236 void mailbox_clear_response(void); 237 238 int intel_mailbox_get_config_status(uint32_t cmd, bool init_done); 239 int intel_mailbox_is_fpga_not_ready(void); 240 241 int mailbox_rsu_get_spt_offset(uint32_t *resp_buf, uint32_t resp_buf_len); 242 int mailbox_rsu_status(uint32_t *resp_buf, uint32_t resp_buf_len); 243 int mailbox_rsu_update(uint32_t *flash_offset); 244 int mailbox_hps_stage_notify(uint32_t execution_stage); 245 int mailbox_hwmon_readtemp(uint32_t chan, uint32_t *resp_buf); 246 int mailbox_hwmon_readvolt(uint32_t chan, uint32_t *resp_buf); 247 int mailbox_seu_err_status(uint32_t *resp_buf, uint32_t resp_buf_len); 248 249 #endif /* SOCFPGA_MBOX_H */ 250