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