optiga_lib_config_mtb.h File Reference

#include "cy_pdl.h"
#include "mtb_hal.h"
#include "cybsp.h"

Go to the source code of this file.

Macros
#define	OPTIGA_CRYPT_RANDOM_ENABLED
	OPTIGA CRYPT random number generation feature enable/disable macro.
#define	OPTIGA_CRYPT_HASH_ENABLED
	OPTIGA CRYPT hash feature enable/disable macro.
#define	OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED
	OPTIGA CRYPT ECC generate keypair feature enable/disable macro.
#define	OPTIGA_CRYPT_ECDSA_SIGN_ENABLED
	OPTIGA CRYPT ECDSA signature feature enable/disable macro.
#define	OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED
	OPTIGA CRYPT verify ECDSA signature feature enable/disable macro.
#define	OPTIGA_CRYPT_ECDH_ENABLED
	OPTIGA CRYPT ECDH feature enable/disable macro.
#define	OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED
	OPTIGA CRYPT ECC 521 feature enable/disable macro.
#define	OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED
	OPTIGA CRYPT ECC Brainpool feature enable/disable macro.
#define	OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED
	OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro.
#define	OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED
	OPTIGA CRYPT TLS PRF sha384 feature enable/disable macro.
#define	OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED
	OPTIGA CRYPT TLS PRF sha512 feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED
	OPTIGA CRYPT RSA generate keypair feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_SIGN_ENABLED
	OPTIGA CRYPT RSA sign feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_VERIFY_ENABLED
	OPTIGA CRYPT RSA verify sign feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED
	OPTIGA CRYPT RSA Encrypt feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_DECRYPT_ENABLED
	OPTIGA CRYPT RSA Decrypt feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED
	OPTIGA CRYPT RSA pre-master feature enable/disable macro.
#define	OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED
	OPTIGA CRYPT RSA SSA with SHA512 as digest feature enable/disable macro.
#define	OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED
	OPTIGA CRYPT symmetric encrypt feature enable/disable macro.
#define	OPTIGA_CRYPT_SYM_DECRYPT_ENABLED
	OPTIGA CRYPT symmetric decrypt feature enable/disable macro.
#define	OPTIGA_CRYPT_HMAC_ENABLED
	OPTIGA CRYPT HMAC feature enable/disable macro.
#define	OPTIGA_CRYPT_HKDF_ENABLED
	OPTIGA CRYPT HKDF feature enable/disable macro.
#define	OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED
	OPTIGA CRYPT symmetric generate key feature enable/disable macro.
#define	OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED
	OPTIGA CRYPT generate auth code feature enable/disable macro.
#define	OPTIGA_CRYPT_HMAC_VERIFY_ENABLED
	OPTIGA CRYPT HMAC verify feature enable/disable macro.
#define	OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED
	OPTIGA CRYPT clear AUTO state feature enable/disable macro.
#define	OPTIGA_COMMS_SHIELDED_CONNECTION
	OPTIGA COMMS shielded connection feature. To disable the feature, undefine the macro.
#define	OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL   OPTIGA_COMMS_NO_PROTECTION
	Default reset protection level for OPTIGA CRYPT and UTIL APIs.
#define	OPTIGA_LIB_DEBUG_NULL_CHECK
	NULL parameter check. To disable the check, undefine the macro.
#define	OPTIGA_CMD_MAX_REGISTRATIONS   (0x06)
	Maximum number of instance registration.
#define	OPTIGA_MAX_COMMS_BUFFER_SIZE   (0x615)
	Maximum buffer size required to communicate with OPTIGA.
#define	OPTIGA_PAL_INIT_ENABLED
	Macro to enable logger Enable macro OPTIGA_LIB_ENABLE_UTIL_LOGGING for Util Service layer logging Enable macro OPTIGA_LIB_ENABLE_CRYPT_LOGGING for Crypt Service layer logging Enable macro OPTIGA_LIB_ENABLE_CMD_LOGGING for Command layer logging Enable macro OPTIGA_LIB_ENABLE_COMMS_LOGGING for Communication layer logging.
#define	EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED
	OPTIGA UTIL confidentiality protected update feature enable/disable macro.
#define	EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED
	OPTIGA UTIL key object protected update feature enable/disable macro.
#define	EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED
	OPTIGA UTIL metadata object protected update feature enable/disable macro.
#define	OPTIGA_TRUSTM_SCL   CYBSP_TRUSTM_I2C_SCL
#define	OPTIGA_TRUSTM_SDA   CYBSP_TRUSTM_I2C_SDA
#define	OPTIGA_COMMS_DEFAULT_RESET_TYPE   (1U)
	Default reset type in optiga_comms_open. Cold Reset - (0) : This is applicable if the host platform has GPIO option for RST and VDD. Soft Reset - (1) : This is applicable if the host platform doesn't have GPIO options for VDD and RST. Warm Reset - (2) : This is applicable if the host platform doesn't have GPIO option for VDD. Any other value will lead to error.

Macro Definition Documentation

OPTIGA_CRYPT_RANDOM_ENABLED

#define OPTIGA_CRYPT_RANDOM_ENABLED

OPTIGA CRYPT random number generation feature enable/disable macro.

OPTIGA_CRYPT_HASH_ENABLED

#define OPTIGA_CRYPT_HASH_ENABLED

OPTIGA CRYPT hash feature enable/disable macro.

OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED

#define OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED

OPTIGA CRYPT ECC generate keypair feature enable/disable macro.

OPTIGA_CRYPT_ECDSA_SIGN_ENABLED

#define OPTIGA_CRYPT_ECDSA_SIGN_ENABLED

OPTIGA CRYPT ECDSA signature feature enable/disable macro.

OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED

#define OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED

OPTIGA CRYPT verify ECDSA signature feature enable/disable macro.

OPTIGA_CRYPT_ECDH_ENABLED

#define OPTIGA_CRYPT_ECDH_ENABLED

OPTIGA CRYPT ECDH feature enable/disable macro.

OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED

#define OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED

OPTIGA CRYPT ECC 521 feature enable/disable macro.

OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED

#define OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED

OPTIGA CRYPT ECC Brainpool feature enable/disable macro.

OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

#define OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro.

OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED

#define OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED

OPTIGA CRYPT TLS PRF sha384 feature enable/disable macro.

OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED

#define OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED

OPTIGA CRYPT TLS PRF sha512 feature enable/disable macro.

OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED

#define OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED

OPTIGA CRYPT RSA generate keypair feature enable/disable macro.

OPTIGA_CRYPT_RSA_SIGN_ENABLED

#define OPTIGA_CRYPT_RSA_SIGN_ENABLED

OPTIGA CRYPT RSA sign feature enable/disable macro.

OPTIGA_CRYPT_RSA_VERIFY_ENABLED

#define OPTIGA_CRYPT_RSA_VERIFY_ENABLED

OPTIGA CRYPT RSA verify sign feature enable/disable macro.

OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

#define OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

OPTIGA CRYPT RSA Encrypt feature enable/disable macro.

OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

#define OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

OPTIGA CRYPT RSA Decrypt feature enable/disable macro.

OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED

#define OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED

OPTIGA CRYPT RSA pre-master feature enable/disable macro.

OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED

#define OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED

OPTIGA CRYPT RSA SSA with SHA512 as digest feature enable/disable macro.

OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED

#define OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED

OPTIGA CRYPT symmetric encrypt feature enable/disable macro.

OPTIGA_CRYPT_SYM_DECRYPT_ENABLED

#define OPTIGA_CRYPT_SYM_DECRYPT_ENABLED

OPTIGA CRYPT symmetric decrypt feature enable/disable macro.

OPTIGA_CRYPT_HMAC_ENABLED

#define OPTIGA_CRYPT_HMAC_ENABLED

OPTIGA CRYPT HMAC feature enable/disable macro.

OPTIGA_CRYPT_HKDF_ENABLED

#define OPTIGA_CRYPT_HKDF_ENABLED

OPTIGA CRYPT HKDF feature enable/disable macro.

OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED

#define OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED

OPTIGA CRYPT symmetric generate key feature enable/disable macro.

OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED

#define OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED

OPTIGA CRYPT generate auth code feature enable/disable macro.

OPTIGA_CRYPT_HMAC_VERIFY_ENABLED

#define OPTIGA_CRYPT_HMAC_VERIFY_ENABLED

OPTIGA CRYPT HMAC verify feature enable/disable macro.

OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED

#define OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED

OPTIGA CRYPT clear AUTO state feature enable/disable macro.

OPTIGA_COMMS_SHIELDED_CONNECTION

#define OPTIGA_COMMS_SHIELDED_CONNECTION

OPTIGA COMMS shielded connection feature. To disable the feature, undefine the macro.

OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL

#define OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL   OPTIGA_COMMS_NO_PROTECTION

Default reset protection level for OPTIGA CRYPT and UTIL APIs.

OPTIGA_LIB_DEBUG_NULL_CHECK

#define OPTIGA_LIB_DEBUG_NULL_CHECK

NULL parameter check. To disable the check, undefine the macro.

OPTIGA_CMD_MAX_REGISTRATIONS

#define OPTIGA_CMD_MAX_REGISTRATIONS   (0x06)

Maximum number of instance registration.

OPTIGA_MAX_COMMS_BUFFER_SIZE

#define OPTIGA_MAX_COMMS_BUFFER_SIZE   (0x615)

Maximum buffer size required to communicate with OPTIGA.

OPTIGA_PAL_INIT_ENABLED

#define OPTIGA_PAL_INIT_ENABLED

Macro to enable logger
Enable macro OPTIGA_LIB_ENABLE_UTIL_LOGGING for Util Service layer logging
Enable macro OPTIGA_LIB_ENABLE_CRYPT_LOGGING for Crypt Service layer logging
Enable macro OPTIGA_LIB_ENABLE_CMD_LOGGING for Command layer logging
Enable macro OPTIGA_LIB_ENABLE_COMMS_LOGGING for Communication layer logging.

Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality

EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED

#define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED

OPTIGA UTIL confidentiality protected update feature enable/disable macro.

EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED

#define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED

OPTIGA UTIL key object protected update feature enable/disable macro.

EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED

#define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED

OPTIGA UTIL metadata object protected update feature enable/disable macro.

OPTIGA_TRUSTM_SCL

#define OPTIGA_TRUSTM_SCL   CYBSP_TRUSTM_I2C_SCL

OPTIGA_TRUSTM_SDA

#define OPTIGA_TRUSTM_SDA   CYBSP_TRUSTM_I2C_SDA

OPTIGA_COMMS_DEFAULT_RESET_TYPE

#define OPTIGA_COMMS_DEFAULT_RESET_TYPE   (1U)

Default reset type in optiga_comms_open.
Cold Reset - (0) : This is applicable if the host platform has GPIO option for RST and VDD.
Soft Reset - (1) : This is applicable if the host platform doesn't have GPIO options for VDD and RST.
Warm Reset - (2) : This is applicable if the host platform doesn't have GPIO option for VDD.
Any other value will lead to error.