xref: /rk3399_ARM-atf/plat/intel/soc/common/include/socfpga_fcs.h (revision 342a0618c7ff89327ac5b34dc0713509ffae609b)
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)
17286b96f4SSieu Mun Tang #define FCS_PROV_DATA_BYTE_SIZE		(FCS_PROV_DATA_WORD_SIZE * 4U)
1877902fcaSSieu Mun Tang #define FCS_SHA384_BYTE_SIZE		(FCS_SHA384_WORD_SIZE * 4U)
19286b96f4SSieu Mun Tang 
2002d3ef33SSieu Mun Tang #define FCS_MODE_DECRYPT		0x0
2102d3ef33SSieu Mun Tang #define FCS_MODE_ENCRYPT		0x1
2202d3ef33SSieu Mun Tang #define FCS_ENCRYPTION_DATA_0		0x10100
2302d3ef33SSieu Mun Tang #define FCS_DECRYPTION_DATA_0		0x10102
2402d3ef33SSieu Mun Tang #define FCS_OWNER_ID_OFFSET		0xC
25286b96f4SSieu Mun Tang 
26d1740831SSieu Mun Tang #define PSGSIGMA_TEARDOWN_MAGIC		0xB852E2A4
27d1740831SSieu Mun Tang #define	PSGSIGMA_SESSION_ID_ONE		0x1
28d1740831SSieu Mun Tang #define PSGSIGMA_UNKNOWN_SESSION	0xFFFFFFFF
29d1740831SSieu Mun Tang 
30d1740831SSieu Mun Tang #define	RESERVED_AS_ZERO		0x0
317facacecSSieu Mun Tang /* FCS Single cert */
327facacecSSieu Mun Tang 
337facacecSSieu Mun Tang #define FCS_BIG_CNTR_SEL		0x1
347facacecSSieu Mun Tang 
357facacecSSieu Mun Tang #define FCS_SVN_CNTR_0_SEL		0x2
367facacecSSieu Mun Tang #define FCS_SVN_CNTR_1_SEL		0x3
377facacecSSieu Mun Tang #define FCS_SVN_CNTR_2_SEL		0x4
387facacecSSieu Mun Tang #define FCS_SVN_CNTR_3_SEL		0x5
397facacecSSieu Mun Tang 
407facacecSSieu Mun Tang #define FCS_BIG_CNTR_VAL_MAX		495U
417facacecSSieu Mun Tang #define FCS_SVN_CNTR_VAL_MAX		64U
42d1740831SSieu Mun Tang 
43581182c1SSieu Mun Tang /* FCS Attestation Cert Request Parameter */
44581182c1SSieu Mun Tang 
45581182c1SSieu Mun Tang #define FCS_ALIAS_CERT			0x01
46581182c1SSieu Mun Tang #define FCS_DEV_ID_SELF_SIGN_CERT	0x02
47581182c1SSieu Mun Tang #define FCS_DEV_ID_ENROLL_CERT		0x04
48581182c1SSieu Mun Tang #define FCS_ENROLL_SELF_SIGN_CERT	0x08
49581182c1SSieu Mun Tang #define FCS_PLAT_KEY_CERT		0x10
50581182c1SSieu Mun Tang 
51*342a0618SSieu Mun Tang /* FCS Crypto Service */
52*342a0618SSieu Mun Tang 
53*342a0618SSieu Mun Tang #define FCS_CS_KEY_OBJ_MAX_WORD_SIZE	88U
54*342a0618SSieu Mun Tang #define FCS_CS_KEY_INFO_MAX_WORD_SIZE	36U
55*342a0618SSieu Mun Tang #define FCS_CS_KEY_RESP_STATUS_MASK	0xFF
56*342a0618SSieu Mun Tang #define FCS_CS_KEY_RESP_STATUS_OFFSET	16U
57*342a0618SSieu Mun Tang 
58286b96f4SSieu Mun Tang /* FCS Payload Structure */
59286b96f4SSieu Mun Tang 
6002d3ef33SSieu Mun Tang typedef struct fcs_encrypt_payload_t {
61286b96f4SSieu Mun Tang 	uint32_t first_word;
62286b96f4SSieu Mun Tang 	uint32_t src_addr;
63286b96f4SSieu Mun Tang 	uint32_t src_size;
64286b96f4SSieu Mun Tang 	uint32_t dst_addr;
65286b96f4SSieu Mun Tang 	uint32_t dst_size;
6602d3ef33SSieu Mun Tang } fcs_encrypt_payload;
6702d3ef33SSieu Mun Tang 
6802d3ef33SSieu Mun Tang typedef struct fcs_decrypt_payload_t {
6902d3ef33SSieu Mun Tang 	uint32_t first_word;
7002d3ef33SSieu Mun Tang 	uint32_t owner_id[2];
7102d3ef33SSieu Mun Tang 	uint32_t src_addr;
7202d3ef33SSieu Mun Tang 	uint32_t src_size;
7302d3ef33SSieu Mun Tang 	uint32_t dst_addr;
7402d3ef33SSieu Mun Tang 	uint32_t dst_size;
7502d3ef33SSieu Mun Tang } fcs_decrypt_payload;
76286b96f4SSieu Mun Tang 
77d1740831SSieu Mun Tang typedef struct psgsigma_teardown_msg_t {
78d1740831SSieu Mun Tang 	uint32_t reserved_word;
79d1740831SSieu Mun Tang 	uint32_t magic_word;
80d1740831SSieu Mun Tang 	uint32_t session_id;
81d1740831SSieu Mun Tang } psgsigma_teardown_msg;
82d1740831SSieu Mun Tang 
837facacecSSieu Mun Tang typedef struct fcs_cntr_set_preauth_payload_t {
847facacecSSieu Mun Tang 	uint32_t first_word;
857facacecSSieu Mun Tang 	uint32_t counter_value;
867facacecSSieu Mun Tang } fcs_cntr_set_preauth_payload;
87d1740831SSieu Mun Tang 
88*342a0618SSieu Mun Tang typedef struct fcs_cs_key_payload_t {
89*342a0618SSieu Mun Tang 	uint32_t session_id;
90*342a0618SSieu Mun Tang 	uint32_t reserved0;
91*342a0618SSieu Mun Tang 	uint32_t reserved1;
92*342a0618SSieu Mun Tang 	uint32_t key_id;
93*342a0618SSieu Mun Tang } fcs_cs_key_payload;
94*342a0618SSieu Mun Tang 
95286b96f4SSieu Mun Tang /* Functions Definitions */
96286b96f4SSieu Mun Tang 
97286b96f4SSieu Mun Tang uint32_t intel_fcs_random_number_gen(uint64_t addr, uint64_t *ret_size,
98286b96f4SSieu Mun Tang 				uint32_t *mbox_error);
99286b96f4SSieu Mun Tang uint32_t intel_fcs_send_cert(uint64_t addr, uint64_t size,
100286b96f4SSieu Mun Tang 				uint32_t *send_id);
101286b96f4SSieu Mun Tang uint32_t intel_fcs_get_provision_data(uint32_t *send_id);
1027facacecSSieu Mun Tang uint32_t intel_fcs_cntr_set_preauth(uint8_t counter_type,
1037facacecSSieu Mun Tang 				int32_t counter_value,
1047facacecSSieu Mun Tang 				uint32_t test_bit,
1057facacecSSieu Mun Tang 				uint32_t *mbox_error);
10602d3ef33SSieu Mun Tang uint32_t intel_fcs_encryption(uint32_t src_addr, uint32_t src_size,
10702d3ef33SSieu Mun Tang 				uint32_t dst_addr, uint32_t dst_size,
10802d3ef33SSieu Mun Tang 				uint32_t *send_id);
10902d3ef33SSieu Mun Tang 
11002d3ef33SSieu Mun Tang uint32_t intel_fcs_decryption(uint32_t src_addr, uint32_t src_size,
11102d3ef33SSieu Mun Tang 				uint32_t dst_addr, uint32_t dst_size,
11202d3ef33SSieu Mun Tang 				uint32_t *send_id);
113286b96f4SSieu Mun Tang 
114d1740831SSieu Mun Tang int intel_fcs_sigma_teardown(uint32_t session_id, uint32_t *mbox_error);
115d1740831SSieu Mun Tang int intel_fcs_chip_id(uint32_t *id_low, uint32_t *id_high, uint32_t *mbox_error);
116d1740831SSieu Mun Tang int intel_fcs_attestation_subkey(uint64_t src_addr, uint32_t src_size,
117d1740831SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
118d1740831SSieu Mun Tang 				uint32_t *mbox_error);
119d1740831SSieu Mun Tang int intel_fcs_get_measurement(uint64_t src_addr, uint32_t src_size,
120d1740831SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
121d1740831SSieu Mun Tang 				uint32_t *mbox_error);
12277902fcaSSieu Mun Tang uint32_t intel_fcs_get_rom_patch_sha384(uint64_t addr, uint64_t *ret_size,
12377902fcaSSieu Mun Tang 				uint32_t *mbox_error);
12477902fcaSSieu Mun Tang 
125581182c1SSieu Mun Tang int intel_fcs_create_cert_on_reload(uint32_t cert_request,
126581182c1SSieu Mun Tang 				uint32_t *mbox_error);
127581182c1SSieu Mun Tang int intel_fcs_get_attestation_cert(uint32_t cert_request, uint64_t dst_addr,
128581182c1SSieu Mun Tang 				uint32_t *dst_size, uint32_t *mbox_error);
129581182c1SSieu Mun Tang 
1306dc00c24SSieu Mun Tang int intel_fcs_open_crypto_service_session(uint32_t *session_id,
1316dc00c24SSieu Mun Tang 				uint32_t *mbox_error);
1326dc00c24SSieu Mun Tang int intel_fcs_close_crypto_service_session(uint32_t session_id,
1336dc00c24SSieu Mun Tang 				uint32_t *mbox_error);
1346dc00c24SSieu Mun Tang 
135*342a0618SSieu Mun Tang int intel_fcs_import_crypto_service_key(uint64_t src_addr, uint32_t src_size,
136*342a0618SSieu Mun Tang 				uint32_t *mbox_error);
137*342a0618SSieu Mun Tang int intel_fcs_export_crypto_service_key(uint32_t session_id, uint32_t key_id,
138*342a0618SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
139*342a0618SSieu Mun Tang 				uint32_t *mbox_error);
140*342a0618SSieu Mun Tang int intel_fcs_remove_crypto_service_key(uint32_t session_id, uint32_t key_id,
141*342a0618SSieu Mun Tang 				uint32_t *mbox_error);
142*342a0618SSieu Mun Tang int intel_fcs_get_crypto_service_key_info(uint32_t session_id, uint32_t key_id,
143*342a0618SSieu Mun Tang 				uint64_t dst_addr, uint32_t *dst_size,
144*342a0618SSieu Mun Tang 				uint32_t *mbox_error);
145*342a0618SSieu Mun Tang 
146286b96f4SSieu Mun Tang #endif /* SOCFPGA_FCS_H */
147