OPTIGA™ Trust M
Host Library Documentation
optiga_lib_config_m_v1.h File Reference

This file is defines the compilation switches to build code with required features. More...

Go to the source code of this file.

Macros

#define OPTIGA_CRYPT_RANDOM_ENABLED
 OPTIGA CRYPT random number generation feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_HASH_ENABLED
 OPTIGA CRYPT hash feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED
 OPTIGA CRYPT ECC generate keypair feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_ECDSA_SIGN_ENABLED
 OPTIGA CRYPT ECDSA signature feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED
 OPTIGA CRYPT verify ECDSA signature feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_ECDH_ENABLED
 OPTIGA CRYPT ECDH feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED
 OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED
 OPTIGA CRYPT RSA generate keypair feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_SIGN_ENABLED
 OPTIGA CRYPT RSA sign feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_VERIFY_ENABLED
 OPTIGA CRYPT RSA verify sign feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED
 OPTIGA CRYPT RSA Encrypt feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_DECRYPT_ENABLED
 OPTIGA CRYPT RSA Decrypt feature enable/disable macro. More...
 
#define OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED
 OPTIGA CRYPT RSA pre-master feature enable/disable macro. More...
 
#define OPTIGA_LIB_DEBUG_NULL_CHECK
 NULL parameter check. To disable the check, undefine the macro. More...
 
#define OPTIGA_CMD_MAX_REGISTRATIONS   (0x06)
 Maximum number of instance registration. More...
 
#define OPTIGA_MAX_COMMS_BUFFER_SIZE   (0x615)
 Maximum buffer size required to communicate with OPTIGA. More...
 
#define OPTIGA_LIB_ENABLE_LOGGING
 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
More...
 
#define OPTIGA_PAL_INIT_ENABLED
 Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality. More...
 
#define OPTIGA_COMMS_SHIELDED_CONNECTION
 OPTIGA COMMS shielded connection feature. To disable the feature, undefine the macro. More...
 
#define OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL   OPTIGA_COMMS_NO_PROTECTION
 Default reset protection level for OPTIGA CRYPT and UTIL APIs. More...
 
#define OPTIGA_COMMS_DEFAULT_RESET_TYPE   (0U)
 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. More...
 

Detailed Description

This file is defines the compilation switches to build code with required features.

Author
Infineon Technologies AG

Definition in file optiga_lib_config_m_v1.h.

Macro Definition Documentation

◆ OPTIGA_CMD_MAX_REGISTRATIONS

#define OPTIGA_CMD_MAX_REGISTRATIONS   (0x06)

Maximum number of instance registration.

Definition at line 78 of file optiga_lib_config_m_v1.h.

◆ 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.

Definition at line 109 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_COMMS_DEFAULT_RESET_TYPE

#define OPTIGA_COMMS_DEFAULT_RESET_TYPE   (0U)

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.

Definition at line 117 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_COMMS_SHIELDED_CONNECTION

#define OPTIGA_COMMS_SHIELDED_CONNECTION

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

Definition at line 106 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED

#define OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED

OPTIGA CRYPT ECC generate keypair feature enable/disable macro.

Definition at line 51 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_ECDH_ENABLED

#define OPTIGA_CRYPT_ECDH_ENABLED

OPTIGA CRYPT ECDH feature enable/disable macro.

Definition at line 57 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_ECDSA_SIGN_ENABLED

#define OPTIGA_CRYPT_ECDSA_SIGN_ENABLED

OPTIGA CRYPT ECDSA signature feature enable/disable macro.

Definition at line 53 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED

#define OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED

OPTIGA CRYPT verify ECDSA signature feature enable/disable macro.

Definition at line 55 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_HASH_ENABLED

#define OPTIGA_CRYPT_HASH_ENABLED

OPTIGA CRYPT hash feature enable/disable macro.

Definition at line 49 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RANDOM_ENABLED

#define OPTIGA_CRYPT_RANDOM_ENABLED

OPTIGA CRYPT random number generation feature enable/disable macro.

Definition at line 47 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

#define OPTIGA_CRYPT_RSA_DECRYPT_ENABLED

OPTIGA CRYPT RSA Decrypt feature enable/disable macro.

Definition at line 69 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

#define OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED

OPTIGA CRYPT RSA Encrypt feature enable/disable macro.

Definition at line 67 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED

#define OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED

OPTIGA CRYPT RSA generate keypair feature enable/disable macro.

Definition at line 61 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED

#define OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED

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

Definition at line 71 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_SIGN_ENABLED

#define OPTIGA_CRYPT_RSA_SIGN_ENABLED

OPTIGA CRYPT RSA sign feature enable/disable macro.

Definition at line 63 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_RSA_VERIFY_ENABLED

#define OPTIGA_CRYPT_RSA_VERIFY_ENABLED

OPTIGA CRYPT RSA verify sign feature enable/disable macro.

Definition at line 65 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

#define OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED

OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro.

Definition at line 59 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_LIB_DEBUG_NULL_CHECK

#define OPTIGA_LIB_DEBUG_NULL_CHECK

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

Definition at line 76 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_LIB_ENABLE_LOGGING

#define OPTIGA_LIB_ENABLE_LOGGING

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

Definition at line 87 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_MAX_COMMS_BUFFER_SIZE

#define OPTIGA_MAX_COMMS_BUFFER_SIZE   (0x615)

Maximum buffer size required to communicate with OPTIGA.

Definition at line 80 of file optiga_lib_config_m_v1.h.

◆ OPTIGA_PAL_INIT_ENABLED

#define OPTIGA_PAL_INIT_ENABLED

Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality.

Definition at line 89 of file optiga_lib_config_m_v1.h.