blob: a6a3565b5881bd15ad5322a10a2d6a5b19f79c2a [file] [log] [blame]
Hadi Asyrafi616da772019-06-27 11:34:03 +08001/*
Abdul Halim, Muhammad Hadi Asyrafi33b89d52020-06-05 15:12:29 +08002 * Copyright (c) 2019-2022, Intel Corporation. All rights reserved.
Hadi Asyrafi616da772019-06-27 11:34:03 +08003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
Hadi Asyrafi6f8a2b22019-10-23 18:34:14 +08007#ifndef SOCFPGA_MBOX_H
8#define SOCFPGA_MBOX_H
Hadi Asyrafi616da772019-06-27 11:34:03 +08009
Ambroise Vincenta724e432019-07-23 11:10:27 +010010#include <lib/utils_def.h>
11
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080012
Hadi Asyrafi616da772019-06-27 11:34:03 +080013#define MBOX_OFFSET 0xffa30000
14
Abdul Halim, Muhammad Hadi Asyrafi20a07f32020-05-18 11:16:48 +080015#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
Hadi Asyrafi616da772019-06-27 11:34:03 +080019
Hadi Asyrafi616da772019-06-27 11:34:03 +080020
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080021/* Mailbox Shared Memory Register Map */
Hadi Asyrafi616da772019-06-27 11:34:03 +080022#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 Asyrafi616da772019-06-27 11:34:03 +080032/* Mailbox SDM doorbell */
33#define MBOX_DOORBELL_TO_SDM 0x400
34#define MBOX_DOORBELL_FROM_SDM 0x480
35
Hadi Asyrafi616da772019-06-27 11:34:03 +080036
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080037/* Mailbox commands */
Tien Hock, Loh527234a2019-10-30 14:54:25 +080038
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080039#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 Tang9f22cbf2022-03-02 11:04:09 +080043#define MBOX_CMD_VAB_SRC_CERT 0x0B
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080044#define MBOX_CMD_GET_IDCODE 0x10
45#define MBOX_CMD_REBOOT_HPS 0x47
Hadi Asyrafi616da772019-06-27 11:34:03 +080046
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080047/* Reconfiguration Commands */
48#define MBOX_CONFIG_STATUS 0x04
49#define MBOX_RECONFIG 0x06
50#define MBOX_RECONFIG_DATA 0x08
51#define MBOX_RECONFIG_STATUS 0x09
Hadi Asyrafi593c4c52019-12-17 19:22:17 +080052
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080053/* QSPI Commands */
54#define MBOX_CMD_QSPI_OPEN 0x32
55#define MBOX_CMD_QSPI_CLOSE 0x33
56#define MBOX_CMD_QSPI_SET_CS 0x34
57#define MBOX_CMD_QSPI_DIRECT 0x3B
58
59/* RSU Commands */
60#define MBOX_GET_SUBPARTITION_TABLE 0x5A
61#define MBOX_RSU_STATUS 0x5B
62#define MBOX_RSU_UPDATE 0x5C
63#define MBOX_HPS_STAGE_NOTIFY 0x5D
Hadi Asyrafi593c4c52019-12-17 19:22:17 +080064
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080065/* FCS Command */
66#define MBOX_FCS_GET_PROVISION 0x7B
67#define MBOX_FCS_ENCRYPT_REQ 0x7E
68#define MBOX_FCS_DECRYPT_REQ 0x7F
69#define MBOX_FCS_RANDOM_GEN 0x80
Sieu Mun Tanga34b8812022-03-17 03:11:55 +080070/* Miscellaneous commands */
71#define MBOX_GET_ROM_PATCH_SHA384 0x1B0
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080072
73/* Mailbox Definitions */
74
75#define CMD_DIRECT 0
Abdul Halim, Muhammad Hadi Asyrafib45f15e2020-05-14 15:32:43 +080076#define CMD_INDIRECT 1
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080077#define CMD_CASUAL 0
78#define CMD_URGENT 1
79
Abdul Halim, Muhammad Hadi Asyrafi33b89d52020-06-05 15:12:29 +080080#define MBOX_WORD_BYTE 4U
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080081#define MBOX_RESP_BUFFER_SIZE 16
82#define MBOX_CMD_BUFFER_SIZE 32
Hadi Asyrafi593c4c52019-12-17 19:22:17 +080083
84/* Execution states for HPS_STAGE_NOTIFY */
85#define HPS_EXECUTION_STATE_FSBL 0
86#define HPS_EXECUTION_STATE_SSBL 1
87#define HPS_EXECUTION_STATE_OS 2
88
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080089/* Status Response */
90#define MBOX_RET_OK 0
91#define MBOX_RET_ERROR -1
Hadi Asyrafi616da772019-06-27 11:34:03 +080092#define MBOX_NO_RESPONSE -2
93#define MBOX_WRONG_ID -3
Abdul Halim, Muhammad Hadi Asyrafi20a07f32020-05-18 11:16:48 +080094#define MBOX_BUFFER_FULL -4
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080095#define MBOX_TIMEOUT -2047
Hadi Asyrafi616da772019-06-27 11:34:03 +080096
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +080097/* Reconfig Status Response */
Hadi Asyrafi2b9198d2019-11-12 15:03:00 +080098#define RECONFIG_STATUS_STATE 0
99#define RECONFIG_STATUS_PIN_STATUS 2
100#define RECONFIG_STATUS_SOFTFUNC_STATUS 3
101#define PIN_STATUS_NSTATUS (U(1) << 31)
102#define SOFTFUNC_STATUS_SEU_ERROR (1 << 3)
103#define SOFTFUNC_STATUS_INIT_DONE (1 << 1)
104#define SOFTFUNC_STATUS_CONF_DONE (1 << 0)
105#define MBOX_CFGSTAT_STATE_IDLE 0x00000000
106#define MBOX_CFGSTAT_STATE_CONFIG 0x10000000
107#define MBOX_CFGSTAT_STATE_FAILACK 0x08000000
108#define MBOX_CFGSTAT_STATE_ERROR_INVALID 0xf0000001
109#define MBOX_CFGSTAT_STATE_ERROR_CORRUPT 0xf0000002
110#define MBOX_CFGSTAT_STATE_ERROR_AUTH 0xf0000003
111#define MBOX_CFGSTAT_STATE_ERROR_CORE_IO 0xf0000004
112#define MBOX_CFGSTAT_STATE_ERROR_HARDWARE 0xf0000005
113#define MBOX_CFGSTAT_STATE_ERROR_FAKE 0xf0000006
114#define MBOX_CFGSTAT_STATE_ERROR_BOOT_INFO 0xf0000007
115#define MBOX_CFGSTAT_STATE_ERROR_QSPI_ERROR 0xf0000008
Hadi Asyrafi616da772019-06-27 11:34:03 +0800116
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +0800117
118/* Mailbox Macros */
119
Abdul Halim, Muhammad Hadi Asyrafi33b89d52020-06-05 15:12:29 +0800120#define MBOX_ENTRY_TO_ADDR(_buf, ptr) (MBOX_OFFSET + (MBOX_##_buf##_BUFFER) \
121 + MBOX_WORD_BYTE * (ptr))
122
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +0800123/* Mailbox interrupt flags and masks */
124#define MBOX_INT_FLAG_COE 0x1
125#define MBOX_INT_FLAG_RIE 0x2
126#define MBOX_INT_FLAG_UAE 0x100
127#define MBOX_COE_BIT(INTERRUPT) ((INTERRUPT) & 0x3)
128#define MBOX_UAE_BIT(INTERRUPT) (((INTERRUPT) & (1<<8)))
129
130/* Mailbox response and status */
131#define MBOX_RESP_ERR(BUFFER) ((BUFFER) & 0x00000fff)
132#define MBOX_RESP_LEN(BUFFER) (((BUFFER) & 0x007ff000) >> 12)
133#define MBOX_RESP_CLIENT_ID(BUFFER) (((BUFFER) & 0xf0000000) >> 28)
134#define MBOX_RESP_JOB_ID(BUFFER) (((BUFFER) & 0x0f000000) >> 24)
135#define MBOX_STATUS_UA_MASK (1<<8)
136
137/* Mailbox command and response */
138#define MBOX_CLIENT_ID_CMD(CLIENT_ID) ((CLIENT_ID) << 28)
139#define MBOX_JOB_ID_CMD(JOB_ID) (JOB_ID<<24)
140#define MBOX_CMD_LEN_CMD(CMD_LEN) ((CMD_LEN) << 12)
Abdul Halim, Muhammad Hadi Asyrafib45f15e2020-05-14 15:32:43 +0800141#define MBOX_INDIRECT(val) ((val) << 11)
Chee Hong Ang5bc87bc2020-05-11 11:23:21 +0800142#define MBOX_CMD_MASK(header) ((header) & 0x7ff)
Abdul Halim, Muhammad Hadi Asyrafiec164b62020-05-14 14:53:29 +0800143
144/* RSU Macros */
145#define RSU_VERSION_ACMF BIT(8)
146#define RSU_VERSION_ACMF_MASK 0xff00
147
148
149/* Mailbox Function Definitions */
150
Abdul Halim, Muhammad Hadi Asyrafi118ab212020-10-15 15:27:18 +0800151void mailbox_set_int(uint32_t interrupt_input);
Hadi Asyrafi616da772019-06-27 11:34:03 +0800152int mailbox_init(void);
153void mailbox_set_qspi_close(void);
Abdul Halim, Muhammad Hadi Asyrafiae4cd3a2020-10-06 20:09:53 +0800154void mailbox_hps_qspi_enable(void);
Abdul Halim, Muhammad Hadi Asyrafi118ab212020-10-15 15:27:18 +0800155
156int mailbox_send_cmd(uint32_t job_id, uint32_t cmd, uint32_t *args,
157 unsigned int len, uint32_t urgent, uint32_t *response,
Sieu Mun Tang24682662022-02-19 21:49:48 +0800158 unsigned int *resp_len);
Abdul Halim, Muhammad Hadi Asyrafi118ab212020-10-15 15:27:18 +0800159int mailbox_send_cmd_async(uint32_t *job_id, uint32_t cmd, uint32_t *args,
160 unsigned int len, unsigned int indirect);
161int mailbox_read_response(uint32_t *job_id, uint32_t *response,
Sieu Mun Tang24682662022-02-19 21:49:48 +0800162 unsigned int *resp_len);
163int iterate_resp(uint32_t mbox_resp_len, uint32_t *resp_buf,
164 unsigned int *resp_len);
Abdul Halim, Muhammad Hadi Asyrafi118ab212020-10-15 15:27:18 +0800165
Hadi Asyrafi616da772019-06-27 11:34:03 +0800166void mailbox_reset_cold(void);
Tien Hock, Loh527234a2019-10-30 14:54:25 +0800167void mailbox_clear_response(void);
168
Sieu Mun Tang24682662022-02-19 21:49:48 +0800169int intel_mailbox_get_config_status(uint32_t cmd, bool init_done);
Hadi Asyrafi6aeb55d2019-12-24 14:43:22 +0800170int intel_mailbox_is_fpga_not_ready(void);
Hadi Asyrafi616da772019-06-27 11:34:03 +0800171
Hadi Asyrafi593c4c52019-12-17 19:22:17 +0800172int mailbox_rsu_get_spt_offset(uint32_t *resp_buf, uint32_t resp_buf_len);
173int mailbox_rsu_status(uint32_t *resp_buf, uint32_t resp_buf_len);
Abdul Halim, Muhammad Hadi Asyrafid84bfef2020-02-25 16:28:10 +0800174int mailbox_rsu_update(uint32_t *flash_offset);
175int mailbox_hps_stage_notify(uint32_t execution_stage);
Hadi Asyrafi593c4c52019-12-17 19:22:17 +0800176
Hadi Asyrafi6f8a2b22019-10-23 18:34:14 +0800177#endif /* SOCFPGA_MBOX_H */