plat/intel/soc/common/include/socfpga_fcs.h

/*
 * Copyright (c) 2020-2022, Intel Corporation. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef SOCFPGA_FCS_H
#define SOCFPGA_FCS_H

/* FCS Definitions */

#define FCS_RANDOM_WORD_SIZE			8U
#define FCS_PROV_DATA_WORD_SIZE			44U
#define FCS_SHA384_WORD_SIZE			12U

#define FCS_RANDOM_BYTE_SIZE			(FCS_RANDOM_WORD_SIZE * 4U)
#define FCS_RANDOM_EXT_MAX_WORD_SIZE		1020U
#define FCS_PROV_DATA_BYTE_SIZE			(FCS_PROV_DATA_WORD_SIZE * 4U)
#define FCS_SHA384_BYTE_SIZE			(FCS_SHA384_WORD_SIZE * 4U)

#define FCS_RANDOM_EXT_OFFSET			3

#define FCS_MODE_DECRYPT			0x0
#define FCS_MODE_ENCRYPT			0x1
#define FCS_ENCRYPTION_DATA_0			0x10100
#define FCS_DECRYPTION_DATA_0			0x10102
#define FCS_OWNER_ID_OFFSET			0xC

#define PSGSIGMA_TEARDOWN_MAGIC			0xB852E2A4
#define	PSGSIGMA_SESSION_ID_ONE			0x1
#define PSGSIGMA_UNKNOWN_SESSION		0xFFFFFFFF

#define	RESERVED_AS_ZERO			0x0
/* FCS Single cert */

#define FCS_BIG_CNTR_SEL			0x1

#define FCS_SVN_CNTR_0_SEL			0x2
#define FCS_SVN_CNTR_1_SEL			0x3
#define FCS_SVN_CNTR_2_SEL			0x4
#define FCS_SVN_CNTR_3_SEL			0x5

#define FCS_BIG_CNTR_VAL_MAX			495U
#define FCS_SVN_CNTR_VAL_MAX			64U

/* FCS Attestation Cert Request Parameter */

#define FCS_ALIAS_CERT				0x01
#define FCS_DEV_ID_SELF_SIGN_CERT		0x02
#define FCS_DEV_ID_ENROLL_CERT			0x04
#define FCS_ENROLL_SELF_SIGN_CERT		0x08
#define FCS_PLAT_KEY_CERT			0x10

/* FCS Crypto Service */

#define FCS_CS_KEY_OBJ_MAX_WORD_SIZE		88U
#define FCS_CS_KEY_INFO_MAX_WORD_SIZE		36U
#define FCS_CS_KEY_RESP_STATUS_MASK		0xFF
#define FCS_CS_KEY_RESP_STATUS_OFFSET		16U

#define FCS_CS_FIELD_SIZE_MASK			0xFFFF
#define FCS_CS_FIELD_FLAG_OFFSET		24
#define FCS_CS_FIELD_FLAG_INIT			BIT(0)
#define FCS_CS_FIELD_FLAG_UPDATE		BIT(1)
#define FCS_CS_FIELD_FLAG_FINALIZE		BIT(2)

#define FCS_GET_DIGEST_CMD_MAX_WORD_SIZE	7U
#define FCS_GET_DIGEST_RESP_MAX_WORD_SIZE	19U
#define FCS_MAC_VERIFY_CMD_MAX_WORD_SIZE	23U
#define FCS_MAC_VERIFY_RESP_MAX_WORD_SIZE	4U
#define FCS_SHA_HMAC_CRYPTO_PARAM_SIZE_OFFSET	8U
/* FCS Payload Structure */
typedef struct fcs_rng_payload_t {
	uint32_t session_id;
	uint32_t context_id;
	uint32_t crypto_header;
	uint32_t size;
} fcs_rng_payload;

typedef struct fcs_encrypt_payload_t {
	uint32_t first_word;
	uint32_t src_addr;
	uint32_t src_size;
	uint32_t dst_addr;
	uint32_t dst_size;
} fcs_encrypt_payload;

typedef struct fcs_decrypt_payload_t {
	uint32_t first_word;
	uint32_t owner_id[2];
	uint32_t src_addr;
	uint32_t src_size;
	uint32_t dst_addr;
	uint32_t dst_size;
} fcs_decrypt_payload;

typedef struct psgsigma_teardown_msg_t {
	uint32_t reserved_word;
	uint32_t magic_word;
	uint32_t session_id;
} psgsigma_teardown_msg;

typedef struct fcs_cntr_set_preauth_payload_t {
	uint32_t first_word;
	uint32_t counter_value;
} fcs_cntr_set_preauth_payload;

typedef struct fcs_cs_key_payload_t {
	uint32_t session_id;
	uint32_t reserved0;
	uint32_t reserved1;
	uint32_t key_id;
} fcs_cs_key_payload;

typedef struct fcs_crypto_service_data_t {
	uint32_t session_id;
	uint32_t context_id;
	uint32_t key_id;
	uint32_t crypto_param_size;
	uint64_t crypto_param;
} fcs_crypto_service_data;

/* Functions Definitions */

uint32_t intel_fcs_random_number_gen(uint64_t addr, uint64_t *ret_size,
				uint32_t *mbox_error);
int intel_fcs_random_number_gen_ext(uint32_t session_id, uint32_t context_id,
				uint32_t size, uint32_t *send_id);
uint32_t intel_fcs_send_cert(uint64_t addr, uint64_t size,
				uint32_t *send_id);
uint32_t intel_fcs_get_provision_data(uint32_t *send_id);
uint32_t intel_fcs_cntr_set_preauth(uint8_t counter_type,
				int32_t counter_value,
				uint32_t test_bit,
				uint32_t *mbox_error);
uint32_t intel_fcs_encryption(uint32_t src_addr, uint32_t src_size,
				uint32_t dst_addr, uint32_t dst_size,
				uint32_t *send_id);

uint32_t intel_fcs_decryption(uint32_t src_addr, uint32_t src_size,
				uint32_t dst_addr, uint32_t dst_size,
				uint32_t *send_id);

int intel_fcs_sigma_teardown(uint32_t session_id, uint32_t *mbox_error);
int intel_fcs_chip_id(uint32_t *id_low, uint32_t *id_high, uint32_t *mbox_error);
int intel_fcs_attestation_subkey(uint64_t src_addr, uint32_t src_size,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t *mbox_error);
int intel_fcs_get_measurement(uint64_t src_addr, uint32_t src_size,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t *mbox_error);
uint32_t intel_fcs_get_rom_patch_sha384(uint64_t addr, uint64_t *ret_size,
				uint32_t *mbox_error);

int intel_fcs_create_cert_on_reload(uint32_t cert_request,
				uint32_t *mbox_error);
int intel_fcs_get_attestation_cert(uint32_t cert_request, uint64_t dst_addr,
				uint32_t *dst_size, uint32_t *mbox_error);

int intel_fcs_open_crypto_service_session(uint32_t *session_id,
				uint32_t *mbox_error);
int intel_fcs_close_crypto_service_session(uint32_t session_id,
				uint32_t *mbox_error);

int intel_fcs_import_crypto_service_key(uint64_t src_addr, uint32_t src_size,
				uint32_t *mbox_error);
int intel_fcs_export_crypto_service_key(uint32_t session_id, uint32_t key_id,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t *mbox_error);
int intel_fcs_remove_crypto_service_key(uint32_t session_id, uint32_t key_id,
				uint32_t *mbox_error);
int intel_fcs_get_crypto_service_key_info(uint32_t session_id, uint32_t key_id,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t *mbox_error);

int intel_fcs_get_digest_init(uint32_t session_id, uint32_t context_id,
				uint32_t key_id, uint32_t param_size,
				uint64_t param_data, uint32_t *mbox_error);
int intel_fcs_get_digest_finalize(uint32_t session_id, uint32_t context_id,
				uint32_t src_addr, uint32_t src_size,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t *mbox_error);

int intel_fcs_mac_verify_init(uint32_t session_id, uint32_t context_id,
				uint32_t key_id, uint32_t param_size,
				uint64_t param_data, uint32_t *mbox_error);
int intel_fcs_mac_verify_finalize(uint32_t session_id, uint32_t context_id,
				uint32_t src_addr, uint32_t src_size,
				uint64_t dst_addr, uint32_t *dst_size,
				uint32_t data_size, uint32_t *mbox_error);

#endif /* SOCFPGA_FCS_H */