blob: 893551de3481dfff1b3556a645d00cf9260500c8 [file] [log] [blame]
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +08001/*
2 * Copyright (c) 2020-2022, Intel Corporation. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef SOCFPGA_FCS_H
8#define SOCFPGA_FCS_H
9
10/* FCS Definitions */
11
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080012#define FCS_RANDOM_WORD_SIZE 8U
13#define FCS_PROV_DATA_WORD_SIZE 44U
14#define FCS_SHA384_WORD_SIZE 12U
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080015
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080016#define FCS_RANDOM_BYTE_SIZE (FCS_RANDOM_WORD_SIZE * 4U)
17#define FCS_RANDOM_EXT_MAX_WORD_SIZE 1020U
18#define FCS_PROV_DATA_BYTE_SIZE (FCS_PROV_DATA_WORD_SIZE * 4U)
19#define FCS_SHA384_BYTE_SIZE (FCS_SHA384_WORD_SIZE * 4U)
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080020
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080021#define FCS_RANDOM_EXT_OFFSET 3
Sieu Mun Tange7a037f2022-05-10 17:18:19 +080022
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080023#define FCS_MODE_DECRYPT 0x0
24#define FCS_MODE_ENCRYPT 0x1
25#define FCS_ENCRYPTION_DATA_0 0x10100
26#define FCS_DECRYPTION_DATA_0 0x10102
27#define FCS_OWNER_ID_OFFSET 0xC
28#define FCS_CRYPTION_CRYPTO_HEADER 0x07000000
29#define FCS_CRYPTION_RESP_WORD_SIZE 4U
30#define FCS_CRYPTION_RESP_SIZE_OFFSET 3U
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080031
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080032#define PSGSIGMA_TEARDOWN_MAGIC 0xB852E2A4
33#define PSGSIGMA_SESSION_ID_ONE 0x1
34#define PSGSIGMA_UNKNOWN_SESSION 0xFFFFFFFF
Sieu Mun Tang2a820b92022-05-11 09:59:55 +080035
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080036#define RESERVED_AS_ZERO 0x0
Sieu Mun Tanga068fdf2022-05-11 10:01:54 +080037/* FCS Single cert */
38
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080039#define FCS_BIG_CNTR_SEL 0x1
Sieu Mun Tanga068fdf2022-05-11 10:01:54 +080040
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080041#define FCS_SVN_CNTR_0_SEL 0x2
42#define FCS_SVN_CNTR_1_SEL 0x3
43#define FCS_SVN_CNTR_2_SEL 0x4
44#define FCS_SVN_CNTR_3_SEL 0x5
Sieu Mun Tanga068fdf2022-05-11 10:01:54 +080045
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080046#define FCS_BIG_CNTR_VAL_MAX 495U
47#define FCS_SVN_CNTR_VAL_MAX 64U
Sieu Mun Tang2a820b92022-05-11 09:59:55 +080048
Sieu Mun Tang28af1652022-05-09 10:48:53 +080049/* FCS Attestation Cert Request Parameter */
50
Boon Khai Ngd2df2042021-08-30 15:05:49 +080051#define FCS_ATTEST_FIRMWARE_CERT 0x01
52#define FCS_ATTEST_DEV_ID_SELF_SIGN_CERT 0x02
53#define FCS_ATTEST_DEV_ID_ENROLL_CERT 0x04
54#define FCS_ATTEST_ENROLL_SELF_SIGN_CERT 0x08
55#define FCS_ATTEST_ALIAS_CERT 0x10
56#define FCS_ATTEST_CERT_MAX_REQ_PARAM 0xFF
Sieu Mun Tang28af1652022-05-09 10:48:53 +080057
Sieu Mun Tangfb1f6e92022-05-09 14:16:14 +080058/* FCS Crypto Service */
59
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080060#define FCS_CS_KEY_OBJ_MAX_WORD_SIZE 88U
61#define FCS_CS_KEY_INFO_MAX_WORD_SIZE 36U
62#define FCS_CS_KEY_RESP_STATUS_MASK 0xFF
63#define FCS_CS_KEY_RESP_STATUS_OFFSET 16U
Sieu Mun Tangfb1f6e92022-05-09 14:16:14 +080064
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080065#define FCS_CS_FIELD_SIZE_MASK 0xFFFF
66#define FCS_CS_FIELD_FLAG_OFFSET 24
67#define FCS_CS_FIELD_FLAG_INIT BIT(0)
68#define FCS_CS_FIELD_FLAG_UPDATE BIT(1)
69#define FCS_CS_FIELD_FLAG_FINALIZE BIT(2)
Sieu Mun Tange7a037f2022-05-10 17:18:19 +080070
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080071#define FCS_AES_MAX_DATA_SIZE 0x10000000 /* 256 MB */
72#define FCS_AES_MIN_DATA_SIZE 0x20 /* 32 Byte */
73#define FCS_AES_CMD_MAX_WORD_SIZE 15U
Sieu Mun Tangb0c1d112022-05-10 17:30:00 +080074
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080075#define FCS_GET_DIGEST_CMD_MAX_WORD_SIZE 7U
76#define FCS_GET_DIGEST_RESP_MAX_WORD_SIZE 19U
77#define FCS_MAC_VERIFY_CMD_MAX_WORD_SIZE 23U
78#define FCS_MAC_VERIFY_RESP_MAX_WORD_SIZE 4U
79#define FCS_SHA_HMAC_CRYPTO_PARAM_SIZE_OFFSET 8U
Sieu Mun Tange2f3ede2022-05-10 17:36:32 +080080
Sieu Mun Tangdcaab772022-05-11 10:16:40 +080081#define FCS_ECDSA_GET_PUBKEY_MAX_WORD_SIZE 5U
82#define FCS_ECDSA_SHA2_DATA_SIGN_CMD_MAX_WORD_SIZE 7U
83#define FCS_ECDSA_SHA2_DATA_SIG_VERIFY_CMD_MAX_WORD_SIZE 43U
Sieu Mun Tang8aa05ad2022-05-10 17:50:30 +080084#define FCS_ECDSA_HASH_SIGN_CMD_MAX_WORD_SIZE 17U
Sieu Mun Tang59357e82022-05-10 17:53:32 +080085#define FCS_ECDSA_HASH_SIG_VERIFY_CMD_MAX_WORD_SIZE 52U
Sieu Mun Tang0675c222022-05-10 17:48:11 +080086#define FCS_ECDH_REQUEST_CMD_MAX_WORD_SIZE 29U
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080087/* FCS Payload Structure */
Sieu Mun Tange7a037f2022-05-10 17:18:19 +080088typedef struct fcs_rng_payload_t {
89 uint32_t session_id;
90 uint32_t context_id;
91 uint32_t crypto_header;
92 uint32_t size;
93} fcs_rng_payload;
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080094
Sieu Mun Tang128d2a72022-05-11 09:49:25 +080095typedef struct fcs_encrypt_payload_t {
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +080096 uint32_t first_word;
97 uint32_t src_addr;
98 uint32_t src_size;
99 uint32_t dst_addr;
100 uint32_t dst_size;
Sieu Mun Tang128d2a72022-05-11 09:49:25 +0800101} fcs_encrypt_payload;
102
103typedef struct fcs_decrypt_payload_t {
104 uint32_t first_word;
105 uint32_t owner_id[2];
106 uint32_t src_addr;
107 uint32_t src_size;
108 uint32_t dst_addr;
109 uint32_t dst_size;
110} fcs_decrypt_payload;
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +0800111
Sieu Mun Tang22322fb2022-05-09 16:05:58 +0800112typedef struct fcs_encrypt_ext_payload_t {
113 uint32_t session_id;
114 uint32_t context_id;
115 uint32_t crypto_header;
116 uint32_t src_addr;
117 uint32_t src_size;
118 uint32_t dst_addr;
119 uint32_t dst_size;
120} fcs_encrypt_ext_payload;
121
122typedef struct fcs_decrypt_ext_payload_t {
123 uint32_t session_id;
124 uint32_t context_id;
125 uint32_t crypto_header;
126 uint32_t owner_id[2];
127 uint32_t src_addr;
128 uint32_t src_size;
129 uint32_t dst_addr;
130 uint32_t dst_size;
131} fcs_decrypt_ext_payload;
132
Sieu Mun Tang2a820b92022-05-11 09:59:55 +0800133typedef struct psgsigma_teardown_msg_t {
134 uint32_t reserved_word;
135 uint32_t magic_word;
136 uint32_t session_id;
137} psgsigma_teardown_msg;
138
Sieu Mun Tanga068fdf2022-05-11 10:01:54 +0800139typedef struct fcs_cntr_set_preauth_payload_t {
140 uint32_t first_word;
141 uint32_t counter_value;
142} fcs_cntr_set_preauth_payload;
Sieu Mun Tang2a820b92022-05-11 09:59:55 +0800143
Sieu Mun Tangfb1f6e92022-05-09 14:16:14 +0800144typedef struct fcs_cs_key_payload_t {
145 uint32_t session_id;
146 uint32_t reserved0;
147 uint32_t reserved1;
148 uint32_t key_id;
149} fcs_cs_key_payload;
150
Sieu Mun Tangd907cc32022-05-10 17:24:05 +0800151typedef struct fcs_crypto_service_data_t {
152 uint32_t session_id;
153 uint32_t context_id;
154 uint32_t key_id;
155 uint32_t crypto_param_size;
156 uint64_t crypto_param;
Sieu Mun Tange77d37d2022-04-28 16:23:20 +0800157 uint8_t is_updated;
Sieu Mun Tangd907cc32022-05-10 17:24:05 +0800158} fcs_crypto_service_data;
159
Sieu Mun Tangb0c1d112022-05-10 17:30:00 +0800160typedef struct fcs_crypto_service_aes_data_t {
161 uint32_t session_id;
162 uint32_t context_id;
163 uint32_t param_size;
164 uint32_t key_id;
165 uint32_t crypto_param[7];
Sieu Mun Tang9bea8152022-04-28 16:15:54 +0800166 uint8_t is_updated;
Sieu Mun Tangb0c1d112022-05-10 17:30:00 +0800167} fcs_crypto_service_aes_data;
168
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +0800169/* Functions Definitions */
170
171uint32_t intel_fcs_random_number_gen(uint64_t addr, uint64_t *ret_size,
172 uint32_t *mbox_error);
Sieu Mun Tange7a037f2022-05-10 17:18:19 +0800173int intel_fcs_random_number_gen_ext(uint32_t session_id, uint32_t context_id,
174 uint32_t size, uint32_t *send_id);
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +0800175uint32_t intel_fcs_send_cert(uint64_t addr, uint64_t size,
176 uint32_t *send_id);
177uint32_t intel_fcs_get_provision_data(uint32_t *send_id);
Sieu Mun Tanga068fdf2022-05-11 10:01:54 +0800178uint32_t intel_fcs_cntr_set_preauth(uint8_t counter_type,
179 int32_t counter_value,
180 uint32_t test_bit,
181 uint32_t *mbox_error);
Sieu Mun Tang128d2a72022-05-11 09:49:25 +0800182uint32_t intel_fcs_encryption(uint32_t src_addr, uint32_t src_size,
183 uint32_t dst_addr, uint32_t dst_size,
184 uint32_t *send_id);
185
186uint32_t intel_fcs_decryption(uint32_t src_addr, uint32_t src_size,
187 uint32_t dst_addr, uint32_t dst_size,
188 uint32_t *send_id);
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +0800189
Sieu Mun Tang22322fb2022-05-09 16:05:58 +0800190int intel_fcs_encryption_ext(uint32_t session_id, uint32_t context_id,
191 uint32_t src_addr, uint32_t src_size,
192 uint32_t dst_addr, uint32_t *dst_size,
193 uint32_t *mbox_error);
194int intel_fcs_decryption_ext(uint32_t sesion_id, uint32_t context_id,
195 uint32_t src_addr, uint32_t src_size,
196 uint32_t dst_addr, uint32_t *dst_size,
197 uint32_t *mbox_error);
198
Sieu Mun Tang2a820b92022-05-11 09:59:55 +0800199int intel_fcs_sigma_teardown(uint32_t session_id, uint32_t *mbox_error);
200int intel_fcs_chip_id(uint32_t *id_low, uint32_t *id_high, uint32_t *mbox_error);
201int intel_fcs_attestation_subkey(uint64_t src_addr, uint32_t src_size,
202 uint64_t dst_addr, uint32_t *dst_size,
203 uint32_t *mbox_error);
204int intel_fcs_get_measurement(uint64_t src_addr, uint32_t src_size,
205 uint64_t dst_addr, uint32_t *dst_size,
206 uint32_t *mbox_error);
Sieu Mun Tanga34b8812022-03-17 03:11:55 +0800207uint32_t intel_fcs_get_rom_patch_sha384(uint64_t addr, uint64_t *ret_size,
208 uint32_t *mbox_error);
209
Sieu Mun Tang28af1652022-05-09 10:48:53 +0800210int intel_fcs_create_cert_on_reload(uint32_t cert_request,
211 uint32_t *mbox_error);
212int intel_fcs_get_attestation_cert(uint32_t cert_request, uint64_t dst_addr,
213 uint32_t *dst_size, uint32_t *mbox_error);
214
Sieu Mun Tang16754e12022-05-09 12:08:42 +0800215int intel_fcs_open_crypto_service_session(uint32_t *session_id,
216 uint32_t *mbox_error);
217int intel_fcs_close_crypto_service_session(uint32_t session_id,
218 uint32_t *mbox_error);
219
Sieu Mun Tangfb1f6e92022-05-09 14:16:14 +0800220int intel_fcs_import_crypto_service_key(uint64_t src_addr, uint32_t src_size,
221 uint32_t *mbox_error);
222int intel_fcs_export_crypto_service_key(uint32_t session_id, uint32_t key_id,
223 uint64_t dst_addr, uint32_t *dst_size,
224 uint32_t *mbox_error);
225int intel_fcs_remove_crypto_service_key(uint32_t session_id, uint32_t key_id,
226 uint32_t *mbox_error);
227int intel_fcs_get_crypto_service_key_info(uint32_t session_id, uint32_t key_id,
228 uint64_t dst_addr, uint32_t *dst_size,
229 uint32_t *mbox_error);
230
Sieu Mun Tangd907cc32022-05-10 17:24:05 +0800231int intel_fcs_get_digest_init(uint32_t session_id, uint32_t context_id,
232 uint32_t key_id, uint32_t param_size,
233 uint64_t param_data, uint32_t *mbox_error);
Sieu Mun Tang527df9f2022-04-28 16:28:48 +0800234int intel_fcs_get_digest_update_finalize(uint32_t session_id, uint32_t context_id,
Sieu Mun Tangd907cc32022-05-10 17:24:05 +0800235 uint32_t src_addr, uint32_t src_size,
236 uint64_t dst_addr, uint32_t *dst_size,
Sieu Mun Tang527df9f2022-04-28 16:28:48 +0800237 uint8_t is_finalised, uint32_t *mbox_error);
Sieu Mun Tangd907cc32022-05-10 17:24:05 +0800238
Sieu Mun Tang583149a2022-05-10 17:27:12 +0800239int intel_fcs_mac_verify_init(uint32_t session_id, uint32_t context_id,
240 uint32_t key_id, uint32_t param_size,
241 uint64_t param_data, uint32_t *mbox_error);
Sieu Mun Tang527df9f2022-04-28 16:28:48 +0800242int intel_fcs_mac_verify_update_finalize(uint32_t session_id, uint32_t context_id,
Sieu Mun Tang583149a2022-05-10 17:27:12 +0800243 uint32_t src_addr, uint32_t src_size,
244 uint64_t dst_addr, uint32_t *dst_size,
Sieu Mun Tang527df9f2022-04-28 16:28:48 +0800245 uint32_t data_size, uint8_t is_finalised,
246 uint32_t *mbox_error);
Sieu Mun Tang583149a2022-05-10 17:27:12 +0800247
Sieu Mun Tang8aa05ad2022-05-10 17:50:30 +0800248int intel_fcs_ecdsa_hash_sign_init(uint32_t session_id, uint32_t context_id,
249 uint32_t key_id, uint32_t param_size,
250 uint64_t param_data, uint32_t *mbox_error);
251int intel_fcs_ecdsa_hash_sign_finalize(uint32_t session_id, uint32_t context_id,
252 uint32_t src_addr, uint32_t src_size,
253 uint64_t dst_addr, uint32_t *dst_size,
254 uint32_t *mbox_error);
255
Sieu Mun Tang59357e82022-05-10 17:53:32 +0800256int intel_fcs_ecdsa_hash_sig_verify_init(uint32_t session_id, uint32_t context_id,
257 uint32_t key_id, uint32_t param_size,
258 uint64_t param_data, uint32_t *mbox_error);
259int intel_fcs_ecdsa_hash_sig_verify_finalize(uint32_t session_id, uint32_t context_id,
260 uint32_t src_addr, uint32_t src_size,
261 uint64_t dst_addr, uint32_t *dst_size,
262 uint32_t *mbox_error);
263
Sieu Mun Tang153ecfb2022-05-10 17:39:26 +0800264int intel_fcs_ecdsa_sha2_data_sign_init(uint32_t session_id,
265 uint32_t context_id, uint32_t key_id,
266 uint32_t param_size, uint64_t param_data,
267 uint32_t *mbox_error);
Sieu Mun Tange77d37d2022-04-28 16:23:20 +0800268int intel_fcs_ecdsa_sha2_data_sign_update_finalize(uint32_t session_id,
Sieu Mun Tang153ecfb2022-05-10 17:39:26 +0800269 uint32_t context_id, uint32_t src_addr,
270 uint32_t src_size, uint64_t dst_addr,
Sieu Mun Tange77d37d2022-04-28 16:23:20 +0800271 uint32_t *dst_size, uint8_t is_finalised,
272 uint32_t *mbox_error);
Sieu Mun Tang153ecfb2022-05-10 17:39:26 +0800273
Sieu Mun Tangdcaab772022-05-11 10:16:40 +0800274int intel_fcs_ecdsa_sha2_data_sig_verify_init(uint32_t session_id,
275 uint32_t context_id, uint32_t key_id,
276 uint32_t param_size, uint64_t param_data,
277 uint32_t *mbox_error);
Sieu Mun Tange77d37d2022-04-28 16:23:20 +0800278int intel_fcs_ecdsa_sha2_data_sig_verify_update_finalize(uint32_t session_id,
Sieu Mun Tangdcaab772022-05-11 10:16:40 +0800279 uint32_t context_id, uint32_t src_addr,
280 uint32_t src_size, uint64_t dst_addr,
281 uint32_t *dst_size, uint32_t data_size,
Sieu Mun Tange77d37d2022-04-28 16:23:20 +0800282 uint8_t is_finalised, uint32_t *mbox_error);
Sieu Mun Tangdcaab772022-05-11 10:16:40 +0800283
Sieu Mun Tange2f3ede2022-05-10 17:36:32 +0800284int intel_fcs_ecdsa_get_pubkey_init(uint32_t session_id, uint32_t context_id,
285 uint32_t key_id, uint32_t param_size,
286 uint64_t param_data, uint32_t *mbox_error);
287int intel_fcs_ecdsa_get_pubkey_finalize(uint32_t session_id, uint32_t context_id,
288 uint64_t dst_addr, uint32_t *dst_size,
289 uint32_t *mbox_error);
290
Sieu Mun Tang0675c222022-05-10 17:48:11 +0800291int intel_fcs_ecdh_request_init(uint32_t session_id, uint32_t context_id,
292 uint32_t key_id, uint32_t param_size,
293 uint64_t param_data, uint32_t *mbox_error);
294int intel_fcs_ecdh_request_finalize(uint32_t session_id, uint32_t context_id,
295 uint32_t src_addr, uint32_t src_size,
296 uint64_t dst_addr, uint32_t *dst_size,
297 uint32_t *mbox_error);
298
Sieu Mun Tangb0c1d112022-05-10 17:30:00 +0800299int intel_fcs_aes_crypt_init(uint32_t session_id, uint32_t context_id,
300 uint32_t key_id, uint64_t param_addr,
301 uint32_t param_size, uint32_t *mbox_error);
Sieu Mun Tang9bea8152022-04-28 16:15:54 +0800302int intel_fcs_aes_crypt_update_finalize(uint32_t session_id,
303 uint32_t context_id, uint64_t src_addr,
304 uint32_t src_size, uint64_t dst_addr,
305 uint32_t dst_size, uint8_t is_finalised,
Sieu Mun Tangb0c1d112022-05-10 17:30:00 +0800306 uint32_t *send_id);
307
Sieu Mun Tang9f22cbf2022-03-02 11:04:09 +0800308#endif /* SOCFPGA_FCS_H */