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 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_REBOOT_HPS 0x47 47 48 /* Reconfiguration Commands */ 49 #define MBOX_CONFIG_STATUS 0x04 50 #define MBOX_RECONFIG 0x06 51 #define MBOX_RECONFIG_DATA 0x08 52 #define MBOX_RECONFIG_STATUS 0x09 53 54 /* HWMON Commands */ 55 #define MBOX_HWMON_READVOLT 0x18 56 #define MBOX_HWMON_READTEMP 0x19 57 58 59 /* QSPI Commands */ 60 #define MBOX_CMD_QSPI_OPEN 0x32 61 #define MBOX_CMD_QSPI_CLOSE 0x33 62 #define MBOX_CMD_QSPI_SET_CS 0x34 63 #define MBOX_CMD_QSPI_DIRECT 0x3B 64 65 /* RSU Commands */ 66 #define MBOX_GET_SUBPARTITION_TABLE 0x5A 67 #define MBOX_RSU_STATUS 0x5B 68 #define MBOX_RSU_UPDATE 0x5C 69 #define MBOX_HPS_STAGE_NOTIFY 0x5D 70 71 /* FCS Command */ 72 #define MBOX_FCS_GET_PROVISION 0x7B 73 #define MBOX_FCS_ENCRYPT_REQ 0x7E 74 #define MBOX_FCS_DECRYPT_REQ 0x7F 75 #define MBOX_FCS_RANDOM_GEN 0x80 76 /* Miscellaneous commands */ 77 #define MBOX_GET_ROM_PATCH_SHA384 0x1B0 78 79 /* Mailbox Definitions */ 80 81 #define CMD_DIRECT 0 82 #define CMD_INDIRECT 1 83 #define CMD_CASUAL 0 84 #define CMD_URGENT 1 85 86 #define MBOX_WORD_BYTE 4U 87 #define MBOX_RESP_BUFFER_SIZE 16 88 #define MBOX_CMD_BUFFER_SIZE 32 89 90 /* Execution states for HPS_STAGE_NOTIFY */ 91 #define HPS_EXECUTION_STATE_FSBL 0 92 #define HPS_EXECUTION_STATE_SSBL 1 93 #define HPS_EXECUTION_STATE_OS 2 94 95 /* Status Response */ 96 #define MBOX_RET_OK 0 97 #define MBOX_RET_ERROR -1 98 #define MBOX_NO_RESPONSE -2 99 #define MBOX_WRONG_ID -3 100 #define MBOX_BUFFER_FULL -4 101 #define MBOX_TIMEOUT -2047 102 103 /* Reconfig Status Response */ 104 #define RECONFIG_STATUS_STATE 0 105 #define RECONFIG_STATUS_PIN_STATUS 2 106 #define RECONFIG_STATUS_SOFTFUNC_STATUS 3 107 #define PIN_STATUS_NSTATUS (U(1) << 31) 108 #define SOFTFUNC_STATUS_SEU_ERROR (1 << 3) 109 #define SOFTFUNC_STATUS_INIT_DONE (1 << 1) 110 #define SOFTFUNC_STATUS_CONF_DONE (1 << 0) 111 #define MBOX_CFGSTAT_STATE_IDLE 0x00000000 112 #define MBOX_CFGSTAT_STATE_CONFIG 0x10000000 113 #define MBOX_CFGSTAT_STATE_FAILACK 0x08000000 114 #define MBOX_CFGSTAT_STATE_ERROR_INVALID 0xf0000001 115 #define MBOX_CFGSTAT_STATE_ERROR_CORRUPT 0xf0000002 116 #define MBOX_CFGSTAT_STATE_ERROR_AUTH 0xf0000003 117 #define MBOX_CFGSTAT_STATE_ERROR_CORE_IO 0xf0000004 118 #define MBOX_CFGSTAT_STATE_ERROR_HARDWARE 0xf0000005 119 #define MBOX_CFGSTAT_STATE_ERROR_FAKE 0xf0000006 120 #define MBOX_CFGSTAT_STATE_ERROR_BOOT_INFO 0xf0000007 121 #define MBOX_CFGSTAT_STATE_ERROR_QSPI_ERROR 0xf0000008 122 123 124 /* Mailbox Macros */ 125 126 #define MBOX_ENTRY_TO_ADDR(_buf, ptr) (MBOX_OFFSET + (MBOX_##_buf##_BUFFER) \ 127 + MBOX_WORD_BYTE * (ptr)) 128 129 /* Mailbox interrupt flags and masks */ 130 #define MBOX_INT_FLAG_COE 0x1 131 #define MBOX_INT_FLAG_RIE 0x2 132 #define MBOX_INT_FLAG_UAE 0x100 133 #define MBOX_COE_BIT(INTERRUPT) ((INTERRUPT) & 0x3) 134 #define MBOX_UAE_BIT(INTERRUPT) (((INTERRUPT) & (1<<8))) 135 136 /* Mailbox response and status */ 137 #define MBOX_RESP_ERR(BUFFER) ((BUFFER) & 0x00000fff) 138 #define MBOX_RESP_LEN(BUFFER) (((BUFFER) & 0x007ff000) >> 12) 139 #define MBOX_RESP_CLIENT_ID(BUFFER) (((BUFFER) & 0xf0000000) >> 28) 140 #define MBOX_RESP_JOB_ID(BUFFER) (((BUFFER) & 0x0f000000) >> 24) 141 #define MBOX_STATUS_UA_MASK (1<<8) 142 143 /* Mailbox command and response */ 144 #define MBOX_CLIENT_ID_CMD(CLIENT_ID) ((CLIENT_ID) << 28) 145 #define MBOX_JOB_ID_CMD(JOB_ID) (JOB_ID<<24) 146 #define MBOX_CMD_LEN_CMD(CMD_LEN) ((CMD_LEN) << 12) 147 #define MBOX_INDIRECT(val) ((val) << 11) 148 #define MBOX_CMD_MASK(header) ((header) & 0x7ff) 149 150 /* RSU Macros */ 151 #define RSU_VERSION_ACMF BIT(8) 152 #define RSU_VERSION_ACMF_MASK 0xff00 153 154 /* Config Status Macros */ 155 #define CONFIG_STATUS_WORD_SIZE 16U 156 #define CONFIG_STATUS_FW_VER_OFFSET 1 157 #define CONFIG_STATUS_FW_VER_MASK 0x00FFFFFF 158 159 /* Mailbox Function Definitions */ 160 161 void mailbox_set_int(uint32_t interrupt_input); 162 int mailbox_init(void); 163 void mailbox_set_qspi_close(void); 164 void mailbox_hps_qspi_enable(void); 165 166 int mailbox_send_cmd(uint32_t job_id, uint32_t cmd, uint32_t *args, 167 unsigned int len, uint32_t urgent, uint32_t *response, 168 unsigned int *resp_len); 169 int mailbox_send_cmd_async(uint32_t *job_id, uint32_t cmd, uint32_t *args, 170 unsigned int len, unsigned int indirect); 171 int mailbox_read_response(uint32_t *job_id, uint32_t *response, 172 unsigned int *resp_len); 173 int iterate_resp(uint32_t mbox_resp_len, uint32_t *resp_buf, 174 unsigned int *resp_len); 175 176 void mailbox_reset_cold(void); 177 void mailbox_clear_response(void); 178 179 int intel_mailbox_get_config_status(uint32_t cmd, bool init_done); 180 int intel_mailbox_is_fpga_not_ready(void); 181 182 int mailbox_rsu_get_spt_offset(uint32_t *resp_buf, uint32_t resp_buf_len); 183 int mailbox_rsu_status(uint32_t *resp_buf, uint32_t resp_buf_len); 184 int mailbox_rsu_update(uint32_t *flash_offset); 185 int mailbox_hps_stage_notify(uint32_t execution_stage); 186 int mailbox_hwmon_readtemp(uint32_t chan, uint32_t *resp_buf); 187 int mailbox_hwmon_readvolt(uint32_t chan, uint32_t *resp_buf); 188 189 #endif /* SOCFPGA_MBOX_H */ 190