1 /* 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 12 #define FCS_RANDOM_WORD_SIZE 8U 13 #define FCS_PROV_DATA_WORD_SIZE 44U 14 #define FCS_SHA384_WORD_SIZE 12U 15 16 #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) 20 21 #define FCS_RANDOM_EXT_OFFSET 3 22 23 #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 31 32 #define PSGSIGMA_TEARDOWN_MAGIC 0xB852E2A4 33 #define PSGSIGMA_SESSION_ID_ONE 0x1 34 #define PSGSIGMA_UNKNOWN_SESSION 0xFFFFFFFF 35 36 #define RESERVED_AS_ZERO 0x0 37 /* FCS Single cert */ 38 39 #define FCS_BIG_CNTR_SEL 0x1 40 41 #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 45 46 #define FCS_BIG_CNTR_VAL_MAX 495U 47 #define FCS_SVN_CNTR_VAL_MAX 64U 48 49 /* FCS Attestation Cert Request Parameter */ 50 51 #define FCS_ALIAS_CERT 0x01 52 #define FCS_DEV_ID_SELF_SIGN_CERT 0x02 53 #define FCS_DEV_ID_ENROLL_CERT 0x04 54 #define FCS_ENROLL_SELF_SIGN_CERT 0x08 55 #define FCS_PLAT_KEY_CERT 0x10 56 57 /* FCS Crypto Service */ 58 59 #define FCS_CS_KEY_OBJ_MAX_WORD_SIZE 88U 60 #define FCS_CS_KEY_INFO_MAX_WORD_SIZE 36U 61 #define FCS_CS_KEY_RESP_STATUS_MASK 0xFF 62 #define FCS_CS_KEY_RESP_STATUS_OFFSET 16U 63 64 #define FCS_CS_FIELD_SIZE_MASK 0xFFFF 65 #define FCS_CS_FIELD_FLAG_OFFSET 24 66 #define FCS_CS_FIELD_FLAG_INIT BIT(0) 67 #define FCS_CS_FIELD_FLAG_UPDATE BIT(1) 68 #define FCS_CS_FIELD_FLAG_FINALIZE BIT(2) 69 70 #define FCS_AES_MAX_DATA_SIZE 0x10000000 /* 256 MB */ 71 #define FCS_AES_MIN_DATA_SIZE 0x20 /* 32 Byte */ 72 #define FCS_AES_CMD_MAX_WORD_SIZE 15U 73 74 #define FCS_GET_DIGEST_CMD_MAX_WORD_SIZE 7U 75 #define FCS_GET_DIGEST_RESP_MAX_WORD_SIZE 19U 76 #define FCS_MAC_VERIFY_CMD_MAX_WORD_SIZE 23U 77 #define FCS_MAC_VERIFY_RESP_MAX_WORD_SIZE 4U 78 #define FCS_SHA_HMAC_CRYPTO_PARAM_SIZE_OFFSET 8U 79 80 #define FCS_ECDSA_GET_PUBKEY_MAX_WORD_SIZE 5U 81 /* FCS Payload Structure */ 82 typedef struct fcs_rng_payload_t { 83 uint32_t session_id; 84 uint32_t context_id; 85 uint32_t crypto_header; 86 uint32_t size; 87 } fcs_rng_payload; 88 89 typedef struct fcs_encrypt_payload_t { 90 uint32_t first_word; 91 uint32_t src_addr; 92 uint32_t src_size; 93 uint32_t dst_addr; 94 uint32_t dst_size; 95 } fcs_encrypt_payload; 96 97 typedef struct fcs_decrypt_payload_t { 98 uint32_t first_word; 99 uint32_t owner_id[2]; 100 uint32_t src_addr; 101 uint32_t src_size; 102 uint32_t dst_addr; 103 uint32_t dst_size; 104 } fcs_decrypt_payload; 105 106 typedef struct fcs_encrypt_ext_payload_t { 107 uint32_t session_id; 108 uint32_t context_id; 109 uint32_t crypto_header; 110 uint32_t src_addr; 111 uint32_t src_size; 112 uint32_t dst_addr; 113 uint32_t dst_size; 114 } fcs_encrypt_ext_payload; 115 116 typedef struct fcs_decrypt_ext_payload_t { 117 uint32_t session_id; 118 uint32_t context_id; 119 uint32_t crypto_header; 120 uint32_t owner_id[2]; 121 uint32_t src_addr; 122 uint32_t src_size; 123 uint32_t dst_addr; 124 uint32_t dst_size; 125 } fcs_decrypt_ext_payload; 126 127 typedef struct psgsigma_teardown_msg_t { 128 uint32_t reserved_word; 129 uint32_t magic_word; 130 uint32_t session_id; 131 } psgsigma_teardown_msg; 132 133 typedef struct fcs_cntr_set_preauth_payload_t { 134 uint32_t first_word; 135 uint32_t counter_value; 136 } fcs_cntr_set_preauth_payload; 137 138 typedef struct fcs_cs_key_payload_t { 139 uint32_t session_id; 140 uint32_t reserved0; 141 uint32_t reserved1; 142 uint32_t key_id; 143 } fcs_cs_key_payload; 144 145 typedef struct fcs_crypto_service_data_t { 146 uint32_t session_id; 147 uint32_t context_id; 148 uint32_t key_id; 149 uint32_t crypto_param_size; 150 uint64_t crypto_param; 151 } fcs_crypto_service_data; 152 153 typedef struct fcs_crypto_service_aes_data_t { 154 uint32_t session_id; 155 uint32_t context_id; 156 uint32_t param_size; 157 uint32_t key_id; 158 uint32_t crypto_param[7]; 159 } fcs_crypto_service_aes_data; 160 161 /* Functions Definitions */ 162 163 uint32_t intel_fcs_random_number_gen(uint64_t addr, uint64_t *ret_size, 164 uint32_t *mbox_error); 165 int intel_fcs_random_number_gen_ext(uint32_t session_id, uint32_t context_id, 166 uint32_t size, uint32_t *send_id); 167 uint32_t intel_fcs_send_cert(uint64_t addr, uint64_t size, 168 uint32_t *send_id); 169 uint32_t intel_fcs_get_provision_data(uint32_t *send_id); 170 uint32_t intel_fcs_cntr_set_preauth(uint8_t counter_type, 171 int32_t counter_value, 172 uint32_t test_bit, 173 uint32_t *mbox_error); 174 uint32_t intel_fcs_encryption(uint32_t src_addr, uint32_t src_size, 175 uint32_t dst_addr, uint32_t dst_size, 176 uint32_t *send_id); 177 178 uint32_t intel_fcs_decryption(uint32_t src_addr, uint32_t src_size, 179 uint32_t dst_addr, uint32_t dst_size, 180 uint32_t *send_id); 181 182 int intel_fcs_encryption_ext(uint32_t session_id, uint32_t context_id, 183 uint32_t src_addr, uint32_t src_size, 184 uint32_t dst_addr, uint32_t *dst_size, 185 uint32_t *mbox_error); 186 int intel_fcs_decryption_ext(uint32_t sesion_id, uint32_t context_id, 187 uint32_t src_addr, uint32_t src_size, 188 uint32_t dst_addr, uint32_t *dst_size, 189 uint32_t *mbox_error); 190 191 int intel_fcs_sigma_teardown(uint32_t session_id, uint32_t *mbox_error); 192 int intel_fcs_chip_id(uint32_t *id_low, uint32_t *id_high, uint32_t *mbox_error); 193 int intel_fcs_attestation_subkey(uint64_t src_addr, uint32_t src_size, 194 uint64_t dst_addr, uint32_t *dst_size, 195 uint32_t *mbox_error); 196 int intel_fcs_get_measurement(uint64_t src_addr, uint32_t src_size, 197 uint64_t dst_addr, uint32_t *dst_size, 198 uint32_t *mbox_error); 199 uint32_t intel_fcs_get_rom_patch_sha384(uint64_t addr, uint64_t *ret_size, 200 uint32_t *mbox_error); 201 202 int intel_fcs_create_cert_on_reload(uint32_t cert_request, 203 uint32_t *mbox_error); 204 int intel_fcs_get_attestation_cert(uint32_t cert_request, uint64_t dst_addr, 205 uint32_t *dst_size, uint32_t *mbox_error); 206 207 int intel_fcs_open_crypto_service_session(uint32_t *session_id, 208 uint32_t *mbox_error); 209 int intel_fcs_close_crypto_service_session(uint32_t session_id, 210 uint32_t *mbox_error); 211 212 int intel_fcs_import_crypto_service_key(uint64_t src_addr, uint32_t src_size, 213 uint32_t *mbox_error); 214 int intel_fcs_export_crypto_service_key(uint32_t session_id, uint32_t key_id, 215 uint64_t dst_addr, uint32_t *dst_size, 216 uint32_t *mbox_error); 217 int intel_fcs_remove_crypto_service_key(uint32_t session_id, uint32_t key_id, 218 uint32_t *mbox_error); 219 int intel_fcs_get_crypto_service_key_info(uint32_t session_id, uint32_t key_id, 220 uint64_t dst_addr, uint32_t *dst_size, 221 uint32_t *mbox_error); 222 223 int intel_fcs_get_digest_init(uint32_t session_id, uint32_t context_id, 224 uint32_t key_id, uint32_t param_size, 225 uint64_t param_data, uint32_t *mbox_error); 226 int intel_fcs_get_digest_finalize(uint32_t session_id, uint32_t context_id, 227 uint32_t src_addr, uint32_t src_size, 228 uint64_t dst_addr, uint32_t *dst_size, 229 uint32_t *mbox_error); 230 231 int intel_fcs_mac_verify_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); 234 int intel_fcs_mac_verify_finalize(uint32_t session_id, uint32_t context_id, 235 uint32_t src_addr, uint32_t src_size, 236 uint64_t dst_addr, uint32_t *dst_size, 237 uint32_t data_size, uint32_t *mbox_error); 238 239 int intel_fcs_ecdsa_get_pubkey_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); 242 int intel_fcs_ecdsa_get_pubkey_finalize(uint32_t session_id, uint32_t context_id, 243 uint64_t dst_addr, uint32_t *dst_size, 244 uint32_t *mbox_error); 245 246 int intel_fcs_aes_crypt_init(uint32_t session_id, uint32_t context_id, 247 uint32_t key_id, uint64_t param_addr, 248 uint32_t param_size, uint32_t *mbox_error); 249 int intel_fcs_aes_crypt_finalize(uint32_t session_id, uint32_t context_id, 250 uint64_t src_addr, uint32_t src_size, 251 uint64_t dst_addr, uint32_t dst_size, 252 uint32_t *send_id); 253 254 #endif /* SOCFPGA_FCS_H */ 255