xref: /rk3399_ARM-atf/plat/intel/soc/common/include/socfpga_fcs.h (revision d2fee94afa6ba7e76508e6bead7eb2936c5eafb8)
1286b96f4SSieu Mun Tang /*
2286b96f4SSieu Mun Tang  * Copyright (c) 2020-2022, Intel Corporation. All rights reserved.
3286b96f4SSieu Mun Tang  *
4286b96f4SSieu Mun Tang  * SPDX-License-Identifier: BSD-3-Clause
5286b96f4SSieu Mun Tang  */
6286b96f4SSieu Mun Tang 
7286b96f4SSieu Mun Tang #ifndef SOCFPGA_FCS_H
8286b96f4SSieu Mun Tang #define SOCFPGA_FCS_H
9286b96f4SSieu Mun Tang 
10286b96f4SSieu Mun Tang /* FCS Definitions */
11286b96f4SSieu Mun Tang 
12286b96f4SSieu Mun Tang #define FCS_RANDOM_WORD_SIZE			8U
13286b96f4SSieu Mun Tang #define FCS_PROV_DATA_WORD_SIZE			44U
1477902fcaSSieu Mun Tang #define FCS_SHA384_WORD_SIZE			12U
15286b96f4SSieu Mun Tang 
16286b96f4SSieu Mun Tang #define FCS_RANDOM_BYTE_SIZE			(FCS_RANDOM_WORD_SIZE * 4U)
1724f9dc8aSSieu Mun Tang #define FCS_RANDOM_EXT_MAX_WORD_SIZE		1020U
18286b96f4SSieu Mun Tang #define FCS_PROV_DATA_BYTE_SIZE			(FCS_PROV_DATA_WORD_SIZE * 4U)
1977902fcaSSieu Mun Tang #define FCS_SHA384_BYTE_SIZE			(FCS_SHA384_WORD_SIZE * 4U)
20286b96f4SSieu Mun Tang 
2124f9dc8aSSieu Mun Tang #define FCS_RANDOM_EXT_OFFSET			3
2224f9dc8aSSieu Mun Tang 
2302d3ef33SSieu Mun Tang #define FCS_MODE_DECRYPT			0x0
2402d3ef33SSieu Mun Tang #define FCS_MODE_ENCRYPT			0x1
2502d3ef33SSieu Mun Tang #define FCS_ENCRYPTION_DATA_0			0x10100
2602d3ef33SSieu Mun Tang #define FCS_DECRYPTION_DATA_0			0x10102
2702d3ef33SSieu Mun Tang #define FCS_OWNER_ID_OFFSET			0xC
28537ff052SSieu Mun Tang #define FCS_CRYPTION_CRYPTO_HEADER		0x07000000
29537ff052SSieu Mun Tang #define FCS_CRYPTION_RESP_WORD_SIZE		4U
30537ff052SSieu Mun Tang #define FCS_CRYPTION_RESP_SIZE_OFFSET		3U
31286b96f4SSieu Mun Tang 
32d1740831SSieu Mun Tang #define PSGSIGMA_TEARDOWN_MAGIC			0xB852E2A4
33d1740831SSieu Mun Tang #define	PSGSIGMA_SESSION_ID_ONE			0x1
34d1740831SSieu Mun Tang #define PSGSIGMA_UNKNOWN_SESSION		0xFFFFFFFF
35d1740831SSieu Mun Tang 
36d1740831SSieu Mun Tang #define	RESERVED_AS_ZERO			0x0
377facacecSSieu Mun Tang /* FCS Single cert */
387facacecSSieu Mun Tang 
397facacecSSieu Mun Tang #define FCS_BIG_CNTR_SEL			0x1
407facacecSSieu Mun Tang 
417facacecSSieu Mun Tang #define FCS_SVN_CNTR_0_SEL			0x2
427facacecSSieu Mun Tang #define FCS_SVN_CNTR_1_SEL			0x3
437facacecSSieu Mun Tang #define FCS_SVN_CNTR_2_SEL			0x4
447facacecSSieu Mun Tang #define FCS_SVN_CNTR_3_SEL			0x5
457facacecSSieu Mun Tang 
467facacecSSieu Mun Tang #define FCS_BIG_CNTR_VAL_MAX			495U
477facacecSSieu Mun Tang #define FCS_SVN_CNTR_VAL_MAX			64U
48d1740831SSieu Mun Tang 
49581182c1SSieu Mun Tang /* FCS Attestation Cert Request Parameter */
50581182c1SSieu Mun Tang 
51581182c1SSieu Mun Tang #define FCS_ALIAS_CERT				0x01
52581182c1SSieu Mun Tang #define FCS_DEV_ID_SELF_SIGN_CERT		0x02
53581182c1SSieu Mun Tang #define FCS_DEV_ID_ENROLL_CERT			0x04
54581182c1SSieu Mun Tang #define FCS_ENROLL_SELF_SIGN_CERT		0x08
55581182c1SSieu Mun Tang #define FCS_PLAT_KEY_CERT			0x10
56581182c1SSieu Mun Tang 
57342a0618SSieu Mun Tang /* FCS Crypto Service */
58342a0618SSieu Mun Tang 
59342a0618SSieu Mun Tang #define FCS_CS_KEY_OBJ_MAX_WORD_SIZE		88U
60342a0618SSieu Mun Tang #define FCS_CS_KEY_INFO_MAX_WORD_SIZE		36U
61342a0618SSieu Mun Tang #define FCS_CS_KEY_RESP_STATUS_MASK		0xFF
62342a0618SSieu Mun Tang #define FCS_CS_KEY_RESP_STATUS_OFFSET		16U
63342a0618SSieu Mun Tang 
6424f9dc8aSSieu Mun Tang #define FCS_CS_FIELD_SIZE_MASK			0xFFFF
6524f9dc8aSSieu Mun Tang #define FCS_CS_FIELD_FLAG_OFFSET		24
6624f9dc8aSSieu Mun Tang #define FCS_CS_FIELD_FLAG_INIT			BIT(0)
6724f9dc8aSSieu Mun Tang #define FCS_CS_FIELD_FLAG_UPDATE		BIT(1)
6824f9dc8aSSieu Mun Tang #define FCS_CS_FIELD_FLAG_FINALIZE		BIT(2)
6924f9dc8aSSieu Mun Tang 
706726390eSSieu Mun Tang #define FCS_AES_MAX_DATA_SIZE			0x10000000	/* 256 MB */
716726390eSSieu Mun Tang #define FCS_AES_MIN_DATA_SIZE			0x20		/* 32 Byte */
726726390eSSieu Mun Tang #define FCS_AES_CMD_MAX_WORD_SIZE		15U
736726390eSSieu Mun Tang 
747e8249a2SSieu Mun Tang #define FCS_GET_DIGEST_CMD_MAX_WORD_SIZE	7U
757e8249a2SSieu Mun Tang #define FCS_GET_DIGEST_RESP_MAX_WORD_SIZE	19U
76c05ea296SSieu Mun Tang #define FCS_MAC_VERIFY_CMD_MAX_WORD_SIZE	23U
77c05ea296SSieu Mun Tang #define FCS_MAC_VERIFY_RESP_MAX_WORD_SIZE	4U
787e8249a2SSieu Mun Tang #define FCS_SHA_HMAC_CRYPTO_PARAM_SIZE_OFFSET	8U
79*d2fee94aSSieu Mun Tang 
80*d2fee94aSSieu Mun Tang #define FCS_ECDSA_GET_PUBKEY_MAX_WORD_SIZE	5U
81286b96f4SSieu Mun Tang /* FCS Payload Structure */
8224f9dc8aSSieu Mun Tang typedef struct fcs_rng_payload_t {
8324f9dc8aSSieu Mun Tang 	uint32_t session_id;
8424f9dc8aSSieu Mun Tang 	uint32_t context_id;
8524f9dc8aSSieu Mun Tang 	uint32_t crypto_header;
8624f9dc8aSSieu Mun Tang 	uint32_t size;
8724f9dc8aSSieu Mun Tang } fcs_rng_payload;
88286b96f4SSieu Mun Tang 
8902d3ef33SSieu Mun Tang typedef struct fcs_encrypt_payload_t {
90286b96f4SSieu Mun Tang 	uint32_t first_word;
91286b96f4SSieu Mun Tang 	uint32_t src_addr;
92286b96f4SSieu Mun Tang 	uint32_t src_size;
93286b96f4SSieu Mun Tang 	uint32_t dst_addr;
94286b96f4SSieu Mun Tang 	uint32_t dst_size;
9502d3ef33SSieu Mun Tang } fcs_encrypt_payload;
9602d3ef33SSieu Mun Tang 
9702d3ef33SSieu Mun Tang typedef struct fcs_decrypt_payload_t {
9802d3ef33SSieu Mun Tang 	uint32_t first_word;
9902d3ef33SSieu Mun Tang 	uint32_t owner_id[2];
10002d3ef33SSieu Mun Tang 	uint32_t src_addr;
10102d3ef33SSieu Mun Tang 	uint32_t src_size;
10202d3ef33SSieu Mun Tang 	uint32_t dst_addr;
10302d3ef33SSieu Mun Tang 	uint32_t dst_size;
10402d3ef33SSieu Mun Tang } fcs_decrypt_payload;
105286b96f4SSieu Mun Tang 
106537ff052SSieu Mun Tang typedef struct fcs_encrypt_ext_payload_t {
107537ff052SSieu Mun Tang 	uint32_t session_id;
108537ff052SSieu Mun Tang 	uint32_t context_id;
109537ff052SSieu Mun Tang 	uint32_t crypto_header;
110537ff052SSieu Mun Tang 	uint32_t src_addr;
111537ff052SSieu Mun Tang 	uint32_t src_size;
112537ff052SSieu Mun Tang 	uint32_t dst_addr;
113537ff052SSieu Mun Tang 	uint32_t dst_size;
114537ff052SSieu Mun Tang } fcs_encrypt_ext_payload;
115537ff052SSieu Mun Tang 
116537ff052SSieu Mun Tang typedef struct fcs_decrypt_ext_payload_t {
117537ff052SSieu Mun Tang 	uint32_t session_id;
118537ff052SSieu Mun Tang 	uint32_t context_id;
119537ff052SSieu Mun Tang 	uint32_t crypto_header;
120537ff052SSieu Mun Tang 	uint32_t owner_id[2];
121537ff052SSieu Mun Tang 	uint32_t src_addr;
122537ff052SSieu Mun Tang 	uint32_t src_size;
123537ff052SSieu Mun Tang 	uint32_t dst_addr;
124537ff052SSieu Mun Tang 	uint32_t dst_size;
125537ff052SSieu Mun Tang } fcs_decrypt_ext_payload;
126537ff052SSieu Mun Tang 
127d1740831SSieu Mun Tang typedef struct psgsigma_teardown_msg_t {
128d1740831SSieu Mun Tang 	uint32_t reserved_word;
129d1740831SSieu Mun Tang 	uint32_t magic_word;
130d1740831SSieu Mun Tang 	uint32_t session_id;
131d1740831SSieu Mun Tang } psgsigma_teardown_msg;
132d1740831SSieu Mun Tang 
1337facacecSSieu Mun Tang typedef struct fcs_cntr_set_preauth_payload_t {
1347facacecSSieu Mun Tang 	uint32_t first_word;
1357facacecSSieu Mun Tang 	uint32_t counter_value;
1367facacecSSieu Mun Tang } fcs_cntr_set_preauth_payload;
137d1740831SSieu Mun Tang 
138342a0618SSieu Mun Tang typedef struct fcs_cs_key_payload_t {
139342a0618SSieu Mun Tang 	uint32_t session_id;
140342a0618SSieu Mun Tang 	uint32_t reserved0;
141342a0618SSieu Mun Tang 	uint32_t reserved1;
142342a0618SSieu Mun Tang 	uint32_t key_id;
143342a0618SSieu Mun Tang } fcs_cs_key_payload;
144342a0618SSieu Mun Tang 
1457e8249a2SSieu Mun Tang typedef struct fcs_crypto_service_data_t {
1467e8249a2SSieu Mun Tang 	uint32_t session_id;
1477e8249a2SSieu Mun Tang 	uint32_t context_id;
1487e8249a2SSieu Mun Tang 	uint32_t key_id;
1497e8249a2SSieu Mun Tang 	uint32_t crypto_param_size;
1507e8249a2SSieu Mun Tang 	uint64_t crypto_param;
1517e8249a2SSieu Mun Tang } fcs_crypto_service_data;
1527e8249a2SSieu Mun Tang 
1536726390eSSieu Mun Tang typedef struct fcs_crypto_service_aes_data_t {
1546726390eSSieu Mun Tang 	uint32_t session_id;
1556726390eSSieu Mun Tang 	uint32_t context_id;
1566726390eSSieu Mun Tang 	uint32_t param_size;
1576726390eSSieu Mun Tang 	uint32_t key_id;
1586726390eSSieu Mun Tang 	uint32_t crypto_param[7];
1596726390eSSieu Mun Tang } fcs_crypto_service_aes_data;
1606726390eSSieu Mun Tang 
161286b96f4SSieu Mun Tang /* Functions Definitions */
162286b96f4SSieu Mun Tang 
163286b96f4SSieu Mun Tang uint32_t intel_fcs_random_number_gen(uint64_t addr, uint64_t *ret_size,
164286b96f4SSieu Mun Tang 				uint32_t *mbox_error);
16524f9dc8aSSieu Mun Tang int intel_fcs_random_number_gen_ext(uint32_t session_id, uint32_t context_id,
16624f9dc8aSSieu Mun Tang 				uint32_t size, uint32_t *send_id);
167286b96f4SSieu Mun Tang uint32_t intel_fcs_send_cert(uint64_t addr, uint64_t size,
168286b96f4SSieu Mun Tang 				uint32_t *send_id);
169286b96f4SSieu Mun Tang uint32_t intel_fcs_get_provision_data(uint32_t *send_id);
1707facacecSSieu Mun Tang uint32_t intel_fcs_cntr_set_preauth(uint8_t counter_type,
1717facacecSSieu Mun Tang 				int32_t counter_value,
1727facacecSSieu Mun Tang 				uint32_t test_bit,
1737facacecSSieu Mun Tang 				uint32_t *mbox_error);
17402d3ef33SSieu Mun Tang uint32_t intel_fcs_encryption(uint32_t src_addr, uint32_t src_size,
17502d3ef33SSieu Mun Tang 				uint32_t dst_addr, uint32_t dst_size,
17602d3ef33SSieu Mun Tang 				uint32_t *send_id);
17702d3ef33SSieu Mun Tang 
17802d3ef33SSieu Mun Tang uint32_t intel_fcs_decryption(uint32_t src_addr, uint32_t src_size,
17902d3ef33SSieu Mun Tang 				uint32_t dst_addr, uint32_t dst_size,
18002d3ef33SSieu Mun Tang 				uint32_t *send_id);
181286b96f4SSieu Mun Tang 
182537ff052SSieu Mun Tang int intel_fcs_encryption_ext(uint32_t session_id, uint32_t context_id,
183537ff052SSieu Mun Tang 				uint32_t src_addr, uint32_t src_size,
184537ff052SSieu Mun Tang 				uint32_t dst_addr, uint32_t *dst_size,
185537ff052SSieu Mun Tang 				uint32_t *mbox_error);
186537ff052SSieu Mun Tang int intel_fcs_decryption_ext(uint32_t sesion_id, uint32_t context_id,
187537ff052SSieu Mun Tang 				uint32_t src_addr, uint32_t src_size,
188537ff052SSieu Mun Tang 				uint32_t dst_addr, uint32_t *dst_size,
189537ff052SSieu Mun Tang 				uint32_t *mbox_error);
190537ff052SSieu Mun Tang 
191d1740831SSieu Mun Tang int intel_fcs_sigma_teardown(uint32_t session_id, uint32_t *mbox_error);
192d1740831SSieu Mun Tang int intel_fcs_chip_id(uint32_t *id_low, uint32_t *id_high, uint32_t *mbox_error);
193d1740831SSieu Mun Tang int intel_fcs_attestation_subkey(uint64_t src_addr, uint32_t src_size,
194d1740831SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
195d1740831SSieu Mun Tang 				uint32_t *mbox_error);
196d1740831SSieu Mun Tang int intel_fcs_get_measurement(uint64_t src_addr, uint32_t src_size,
197d1740831SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
198d1740831SSieu Mun Tang 				uint32_t *mbox_error);
19977902fcaSSieu Mun Tang uint32_t intel_fcs_get_rom_patch_sha384(uint64_t addr, uint64_t *ret_size,
20077902fcaSSieu Mun Tang 				uint32_t *mbox_error);
20177902fcaSSieu Mun Tang 
202581182c1SSieu Mun Tang int intel_fcs_create_cert_on_reload(uint32_t cert_request,
203581182c1SSieu Mun Tang 				uint32_t *mbox_error);
204581182c1SSieu Mun Tang int intel_fcs_get_attestation_cert(uint32_t cert_request, uint64_t dst_addr,
205581182c1SSieu Mun Tang 				uint32_t *dst_size, uint32_t *mbox_error);
206581182c1SSieu Mun Tang 
2076dc00c24SSieu Mun Tang int intel_fcs_open_crypto_service_session(uint32_t *session_id,
2086dc00c24SSieu Mun Tang 				uint32_t *mbox_error);
2096dc00c24SSieu Mun Tang int intel_fcs_close_crypto_service_session(uint32_t session_id,
2106dc00c24SSieu Mun Tang 				uint32_t *mbox_error);
2116dc00c24SSieu Mun Tang 
212342a0618SSieu Mun Tang int intel_fcs_import_crypto_service_key(uint64_t src_addr, uint32_t src_size,
213342a0618SSieu Mun Tang 				uint32_t *mbox_error);
214342a0618SSieu Mun Tang int intel_fcs_export_crypto_service_key(uint32_t session_id, uint32_t key_id,
215342a0618SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
216342a0618SSieu Mun Tang 				uint32_t *mbox_error);
217342a0618SSieu Mun Tang int intel_fcs_remove_crypto_service_key(uint32_t session_id, uint32_t key_id,
218342a0618SSieu Mun Tang 				uint32_t *mbox_error);
219342a0618SSieu Mun Tang int intel_fcs_get_crypto_service_key_info(uint32_t session_id, uint32_t key_id,
220342a0618SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
221342a0618SSieu Mun Tang 				uint32_t *mbox_error);
222342a0618SSieu Mun Tang 
2237e8249a2SSieu Mun Tang int intel_fcs_get_digest_init(uint32_t session_id, uint32_t context_id,
2247e8249a2SSieu Mun Tang 				uint32_t key_id, uint32_t param_size,
2257e8249a2SSieu Mun Tang 				uint64_t param_data, uint32_t *mbox_error);
2267e8249a2SSieu Mun Tang int intel_fcs_get_digest_finalize(uint32_t session_id, uint32_t context_id,
2277e8249a2SSieu Mun Tang 				uint32_t src_addr, uint32_t src_size,
2287e8249a2SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
2297e8249a2SSieu Mun Tang 				uint32_t *mbox_error);
2307e8249a2SSieu Mun Tang 
231c05ea296SSieu Mun Tang int intel_fcs_mac_verify_init(uint32_t session_id, uint32_t context_id,
232c05ea296SSieu Mun Tang 				uint32_t key_id, uint32_t param_size,
233c05ea296SSieu Mun Tang 				uint64_t param_data, uint32_t *mbox_error);
234c05ea296SSieu Mun Tang int intel_fcs_mac_verify_finalize(uint32_t session_id, uint32_t context_id,
235c05ea296SSieu Mun Tang 				uint32_t src_addr, uint32_t src_size,
236c05ea296SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
237c05ea296SSieu Mun Tang 				uint32_t data_size, uint32_t *mbox_error);
238c05ea296SSieu Mun Tang 
239*d2fee94aSSieu Mun Tang int intel_fcs_ecdsa_get_pubkey_init(uint32_t session_id, uint32_t context_id,
240*d2fee94aSSieu Mun Tang 				uint32_t key_id, uint32_t param_size,
241*d2fee94aSSieu Mun Tang 				uint64_t param_data, uint32_t *mbox_error);
242*d2fee94aSSieu Mun Tang int intel_fcs_ecdsa_get_pubkey_finalize(uint32_t session_id, uint32_t context_id,
243*d2fee94aSSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
244*d2fee94aSSieu Mun Tang 				uint32_t *mbox_error);
245*d2fee94aSSieu Mun Tang 
2466726390eSSieu Mun Tang int intel_fcs_aes_crypt_init(uint32_t session_id, uint32_t context_id,
2476726390eSSieu Mun Tang 				uint32_t key_id, uint64_t param_addr,
2486726390eSSieu Mun Tang 				uint32_t param_size, uint32_t *mbox_error);
2496726390eSSieu Mun Tang int intel_fcs_aes_crypt_finalize(uint32_t session_id, uint32_t context_id,
2506726390eSSieu Mun Tang 				uint64_t src_addr, uint32_t src_size,
2516726390eSSieu Mun Tang 				uint64_t dst_addr, uint32_t dst_size,
2526726390eSSieu Mun Tang 				uint32_t *send_id);
2536726390eSSieu Mun Tang 
254286b96f4SSieu Mun Tang #endif /* SOCFPGA_FCS_H */
255