Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 1 | /* |
Abdul Halim, Muhammad Hadi Asyrafi | 33b89d5 | 2020-06-05 15:12:29 +0800 | [diff] [blame] | 2 | * Copyright (c) 2019-2022, Intel Corporation. All rights reserved. |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
Hadi Asyrafi | 6f8a2b2 | 2019-10-23 18:34:14 +0800 | [diff] [blame] | 7 | #ifndef SOCFPGA_MBOX_H |
| 8 | #define SOCFPGA_MBOX_H |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 9 | |
Ambroise Vincent | a724e43 | 2019-07-23 11:10:27 +0100 | [diff] [blame] | 10 | #include <lib/utils_def.h> |
| 11 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 12 | |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 13 | #define MBOX_OFFSET 0xffa30000 |
| 14 | |
Abdul Halim, Muhammad Hadi Asyrafi | 20a07f3 | 2020-05-18 11:16:48 +0800 | [diff] [blame] | 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 |
Sieu Mun Tang | a068fdf | 2022-05-11 10:01:54 +0800 | [diff] [blame] | 19 | #define MBOX_TEST_BIT BIT(31) |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 20 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 21 | /* Mailbox Shared Memory Register Map */ |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 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 | |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 32 | /* Mailbox SDM doorbell */ |
| 33 | #define MBOX_DOORBELL_TO_SDM 0x400 |
| 34 | #define MBOX_DOORBELL_FROM_SDM 0x480 |
| 35 | |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 36 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 37 | /* Mailbox commands */ |
Tien Hock, Loh | 527234a | 2019-10-30 14:54:25 +0800 | [diff] [blame] | 38 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 39 | #define MBOX_CMD_NOOP 0x00 |
| 40 | #define MBOX_CMD_SYNC 0x01 |
| 41 | #define MBOX_CMD_RESTART 0x02 |
| 42 | #define MBOX_CMD_CANCEL 0x03 |
Sieu Mun Tang | 9f22cbf | 2022-03-02 11:04:09 +0800 | [diff] [blame] | 43 | #define MBOX_CMD_VAB_SRC_CERT 0x0B |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 44 | #define MBOX_CMD_GET_IDCODE 0x10 |
Sieu Mun Tang | 2b8e005 | 2022-04-27 18:57:29 +0800 | [diff] [blame] | 45 | #define MBOX_CMD_GET_USERCODE 0x13 |
Sieu Mun Tang | 2a820b9 | 2022-05-11 09:59:55 +0800 | [diff] [blame] | 46 | #define MBOX_CMD_GET_CHIPID 0x12 |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 47 | #define MBOX_CMD_REBOOT_HPS 0x47 |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 48 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 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 |
Hadi Asyrafi | 593c4c5 | 2019-12-17 19:22:17 +0800 | [diff] [blame] | 54 | |
Kris Chaplin | e768dfa | 2021-06-25 11:31:52 +0100 | [diff] [blame] | 55 | /* HWMON Commands */ |
| 56 | #define MBOX_HWMON_READVOLT 0x18 |
| 57 | #define MBOX_HWMON_READTEMP 0x19 |
| 58 | |
| 59 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 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 | /* RSU Commands */ |
| 67 | #define MBOX_GET_SUBPARTITION_TABLE 0x5A |
| 68 | #define MBOX_RSU_STATUS 0x5B |
| 69 | #define MBOX_RSU_UPDATE 0x5C |
| 70 | #define MBOX_HPS_STAGE_NOTIFY 0x5D |
Hadi Asyrafi | 593c4c5 | 2019-12-17 19:22:17 +0800 | [diff] [blame] | 71 | |
Sieu Mun Tang | 9f22cbf | 2022-03-02 11:04:09 +0800 | [diff] [blame] | 72 | /* FCS Command */ |
| 73 | #define MBOX_FCS_GET_PROVISION 0x7B |
Sieu Mun Tang | a068fdf | 2022-05-11 10:01:54 +0800 | [diff] [blame] | 74 | #define MBOX_FCS_CNTR_SET_PREAUTH 0x7C |
Sieu Mun Tang | 9f22cbf | 2022-03-02 11:04:09 +0800 | [diff] [blame] | 75 | #define MBOX_FCS_ENCRYPT_REQ 0x7E |
| 76 | #define MBOX_FCS_DECRYPT_REQ 0x7F |
| 77 | #define MBOX_FCS_RANDOM_GEN 0x80 |
Sieu Mun Tang | 2a820b9 | 2022-05-11 09:59:55 +0800 | [diff] [blame] | 78 | |
| 79 | /* PSG SIGMA Commands */ |
| 80 | #define MBOX_PSG_SIGMA_TEARDOWN 0xD5 |
| 81 | |
| 82 | /* Attestation Commands */ |
| 83 | #define MBOX_ATTESTATION_SUBKEY 0x182 |
| 84 | #define MBOX_GET_MEASUREMENT 0x183 |
| 85 | |
Sieu Mun Tang | a34b881 | 2022-03-17 03:11:55 +0800 | [diff] [blame] | 86 | /* Miscellaneous commands */ |
| 87 | #define MBOX_GET_ROM_PATCH_SHA384 0x1B0 |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 88 | |
| 89 | /* Mailbox Definitions */ |
| 90 | |
| 91 | #define CMD_DIRECT 0 |
Abdul Halim, Muhammad Hadi Asyrafi | b45f15e | 2020-05-14 15:32:43 +0800 | [diff] [blame] | 92 | #define CMD_INDIRECT 1 |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 93 | #define CMD_CASUAL 0 |
| 94 | #define CMD_URGENT 1 |
| 95 | |
Abdul Halim, Muhammad Hadi Asyrafi | 33b89d5 | 2020-06-05 15:12:29 +0800 | [diff] [blame] | 96 | #define MBOX_WORD_BYTE 4U |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 97 | #define MBOX_RESP_BUFFER_SIZE 16 |
| 98 | #define MBOX_CMD_BUFFER_SIZE 32 |
Hadi Asyrafi | 593c4c5 | 2019-12-17 19:22:17 +0800 | [diff] [blame] | 99 | |
| 100 | /* Execution states for HPS_STAGE_NOTIFY */ |
| 101 | #define HPS_EXECUTION_STATE_FSBL 0 |
| 102 | #define HPS_EXECUTION_STATE_SSBL 1 |
| 103 | #define HPS_EXECUTION_STATE_OS 2 |
| 104 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 105 | /* Status Response */ |
| 106 | #define MBOX_RET_OK 0 |
| 107 | #define MBOX_RET_ERROR -1 |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 108 | #define MBOX_NO_RESPONSE -2 |
| 109 | #define MBOX_WRONG_ID -3 |
Abdul Halim, Muhammad Hadi Asyrafi | 20a07f3 | 2020-05-18 11:16:48 +0800 | [diff] [blame] | 110 | #define MBOX_BUFFER_FULL -4 |
Sieu Mun Tang | fd8a8ad | 2022-05-07 00:50:37 +0800 | [diff] [blame] | 111 | #define MBOX_BUSY -5 |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 112 | #define MBOX_TIMEOUT -2047 |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 113 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 114 | /* Reconfig Status Response */ |
Hadi Asyrafi | 2b9198d | 2019-11-12 15:03:00 +0800 | [diff] [blame] | 115 | #define RECONFIG_STATUS_STATE 0 |
| 116 | #define RECONFIG_STATUS_PIN_STATUS 2 |
| 117 | #define RECONFIG_STATUS_SOFTFUNC_STATUS 3 |
| 118 | #define PIN_STATUS_NSTATUS (U(1) << 31) |
| 119 | #define SOFTFUNC_STATUS_SEU_ERROR (1 << 3) |
| 120 | #define SOFTFUNC_STATUS_INIT_DONE (1 << 1) |
| 121 | #define SOFTFUNC_STATUS_CONF_DONE (1 << 0) |
| 122 | #define MBOX_CFGSTAT_STATE_IDLE 0x00000000 |
| 123 | #define MBOX_CFGSTAT_STATE_CONFIG 0x10000000 |
| 124 | #define MBOX_CFGSTAT_STATE_FAILACK 0x08000000 |
| 125 | #define MBOX_CFGSTAT_STATE_ERROR_INVALID 0xf0000001 |
| 126 | #define MBOX_CFGSTAT_STATE_ERROR_CORRUPT 0xf0000002 |
| 127 | #define MBOX_CFGSTAT_STATE_ERROR_AUTH 0xf0000003 |
| 128 | #define MBOX_CFGSTAT_STATE_ERROR_CORE_IO 0xf0000004 |
| 129 | #define MBOX_CFGSTAT_STATE_ERROR_HARDWARE 0xf0000005 |
| 130 | #define MBOX_CFGSTAT_STATE_ERROR_FAKE 0xf0000006 |
| 131 | #define MBOX_CFGSTAT_STATE_ERROR_BOOT_INFO 0xf0000007 |
| 132 | #define MBOX_CFGSTAT_STATE_ERROR_QSPI_ERROR 0xf0000008 |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 133 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 134 | |
| 135 | /* Mailbox Macros */ |
| 136 | |
Abdul Halim, Muhammad Hadi Asyrafi | 33b89d5 | 2020-06-05 15:12:29 +0800 | [diff] [blame] | 137 | #define MBOX_ENTRY_TO_ADDR(_buf, ptr) (MBOX_OFFSET + (MBOX_##_buf##_BUFFER) \ |
| 138 | + MBOX_WORD_BYTE * (ptr)) |
| 139 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 140 | /* Mailbox interrupt flags and masks */ |
| 141 | #define MBOX_INT_FLAG_COE 0x1 |
| 142 | #define MBOX_INT_FLAG_RIE 0x2 |
| 143 | #define MBOX_INT_FLAG_UAE 0x100 |
| 144 | #define MBOX_COE_BIT(INTERRUPT) ((INTERRUPT) & 0x3) |
| 145 | #define MBOX_UAE_BIT(INTERRUPT) (((INTERRUPT) & (1<<8))) |
| 146 | |
| 147 | /* Mailbox response and status */ |
| 148 | #define MBOX_RESP_ERR(BUFFER) ((BUFFER) & 0x00000fff) |
| 149 | #define MBOX_RESP_LEN(BUFFER) (((BUFFER) & 0x007ff000) >> 12) |
| 150 | #define MBOX_RESP_CLIENT_ID(BUFFER) (((BUFFER) & 0xf0000000) >> 28) |
| 151 | #define MBOX_RESP_JOB_ID(BUFFER) (((BUFFER) & 0x0f000000) >> 24) |
| 152 | #define MBOX_STATUS_UA_MASK (1<<8) |
| 153 | |
| 154 | /* Mailbox command and response */ |
| 155 | #define MBOX_CLIENT_ID_CMD(CLIENT_ID) ((CLIENT_ID) << 28) |
| 156 | #define MBOX_JOB_ID_CMD(JOB_ID) (JOB_ID<<24) |
| 157 | #define MBOX_CMD_LEN_CMD(CMD_LEN) ((CMD_LEN) << 12) |
Abdul Halim, Muhammad Hadi Asyrafi | b45f15e | 2020-05-14 15:32:43 +0800 | [diff] [blame] | 158 | #define MBOX_INDIRECT(val) ((val) << 11) |
Chee Hong Ang | 5bc87bc | 2020-05-11 11:23:21 +0800 | [diff] [blame] | 159 | #define MBOX_CMD_MASK(header) ((header) & 0x7ff) |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 160 | |
Sieu Mun Tang | fd8a8ad | 2022-05-07 00:50:37 +0800 | [diff] [blame] | 161 | /* Mailbox payload */ |
| 162 | #define MBOX_DATA_MAX_LEN 0x3ff |
| 163 | #define MBOX_PAYLOAD_FLAG_BUSY BIT(0) |
| 164 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 165 | /* RSU Macros */ |
| 166 | #define RSU_VERSION_ACMF BIT(8) |
| 167 | #define RSU_VERSION_ACMF_MASK 0xff00 |
| 168 | |
Sieu Mun Tang | bfda95a | 2022-04-27 18:54:10 +0800 | [diff] [blame] | 169 | /* Config Status Macros */ |
| 170 | #define CONFIG_STATUS_WORD_SIZE 16U |
| 171 | #define CONFIG_STATUS_FW_VER_OFFSET 1 |
| 172 | #define CONFIG_STATUS_FW_VER_MASK 0x00FFFFFF |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 173 | |
Sieu Mun Tang | fd8a8ad | 2022-05-07 00:50:37 +0800 | [diff] [blame] | 174 | /* Data structure */ |
| 175 | |
| 176 | typedef struct mailbox_payload { |
| 177 | uint32_t header; |
| 178 | uint32_t data[MBOX_DATA_MAX_LEN]; |
| 179 | } mailbox_payload_t; |
| 180 | |
| 181 | typedef struct mailbox_container { |
| 182 | uint32_t flag; |
| 183 | uint32_t index; |
| 184 | mailbox_payload_t *payload; |
| 185 | } mailbox_container_t; |
| 186 | |
Abdul Halim, Muhammad Hadi Asyrafi | ec164b6 | 2020-05-14 14:53:29 +0800 | [diff] [blame] | 187 | /* Mailbox Function Definitions */ |
| 188 | |
Abdul Halim, Muhammad Hadi Asyrafi | 118ab21 | 2020-10-15 15:27:18 +0800 | [diff] [blame] | 189 | void mailbox_set_int(uint32_t interrupt_input); |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 190 | int mailbox_init(void); |
| 191 | void mailbox_set_qspi_close(void); |
Abdul Halim, Muhammad Hadi Asyrafi | ae4cd3a | 2020-10-06 20:09:53 +0800 | [diff] [blame] | 192 | void mailbox_hps_qspi_enable(void); |
Abdul Halim, Muhammad Hadi Asyrafi | 118ab21 | 2020-10-15 15:27:18 +0800 | [diff] [blame] | 193 | |
| 194 | int mailbox_send_cmd(uint32_t job_id, uint32_t cmd, uint32_t *args, |
| 195 | unsigned int len, uint32_t urgent, uint32_t *response, |
Sieu Mun Tang | 2468266 | 2022-02-19 21:49:48 +0800 | [diff] [blame] | 196 | unsigned int *resp_len); |
Abdul Halim, Muhammad Hadi Asyrafi | 118ab21 | 2020-10-15 15:27:18 +0800 | [diff] [blame] | 197 | int mailbox_send_cmd_async(uint32_t *job_id, uint32_t cmd, uint32_t *args, |
| 198 | unsigned int len, unsigned int indirect); |
| 199 | int mailbox_read_response(uint32_t *job_id, uint32_t *response, |
Sieu Mun Tang | 2468266 | 2022-02-19 21:49:48 +0800 | [diff] [blame] | 200 | unsigned int *resp_len); |
Sieu Mun Tang | fd8a8ad | 2022-05-07 00:50:37 +0800 | [diff] [blame] | 201 | int mailbox_read_response_async(uint32_t *job_id, uint32_t *header, |
| 202 | uint32_t *response, unsigned int *resp_len, |
| 203 | uint8_t ignore_client_id); |
Sieu Mun Tang | 2468266 | 2022-02-19 21:49:48 +0800 | [diff] [blame] | 204 | int iterate_resp(uint32_t mbox_resp_len, uint32_t *resp_buf, |
| 205 | unsigned int *resp_len); |
Abdul Halim, Muhammad Hadi Asyrafi | 118ab21 | 2020-10-15 15:27:18 +0800 | [diff] [blame] | 206 | |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 207 | void mailbox_reset_cold(void); |
Tien Hock, Loh | 527234a | 2019-10-30 14:54:25 +0800 | [diff] [blame] | 208 | void mailbox_clear_response(void); |
| 209 | |
Sieu Mun Tang | 2468266 | 2022-02-19 21:49:48 +0800 | [diff] [blame] | 210 | int intel_mailbox_get_config_status(uint32_t cmd, bool init_done); |
Hadi Asyrafi | 6aeb55d | 2019-12-24 14:43:22 +0800 | [diff] [blame] | 211 | int intel_mailbox_is_fpga_not_ready(void); |
Hadi Asyrafi | 616da77 | 2019-06-27 11:34:03 +0800 | [diff] [blame] | 212 | |
Hadi Asyrafi | 593c4c5 | 2019-12-17 19:22:17 +0800 | [diff] [blame] | 213 | int mailbox_rsu_get_spt_offset(uint32_t *resp_buf, uint32_t resp_buf_len); |
| 214 | int mailbox_rsu_status(uint32_t *resp_buf, uint32_t resp_buf_len); |
Abdul Halim, Muhammad Hadi Asyrafi | d84bfef | 2020-02-25 16:28:10 +0800 | [diff] [blame] | 215 | int mailbox_rsu_update(uint32_t *flash_offset); |
| 216 | int mailbox_hps_stage_notify(uint32_t execution_stage); |
Kris Chaplin | e768dfa | 2021-06-25 11:31:52 +0100 | [diff] [blame] | 217 | int mailbox_hwmon_readtemp(uint32_t chan, uint32_t *resp_buf); |
| 218 | int mailbox_hwmon_readvolt(uint32_t chan, uint32_t *resp_buf); |
Hadi Asyrafi | 593c4c5 | 2019-12-17 19:22:17 +0800 | [diff] [blame] | 219 | |
Hadi Asyrafi | 6f8a2b2 | 2019-10-23 18:34:14 +0800 | [diff] [blame] | 220 | #endif /* SOCFPGA_MBOX_H */ |