optiga_lib_config_mtb.h

/**
* \copyright
* MIT License
*
* Copyright (c) 2020 Infineon Technologies AG
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE
*
* \endcopyright
*
* \author Infineon Technologies AG
*
* \file optiga_lib_config_m_v3.h
*
* \brief   This file is defines the compilation switches to build code with required features.
*
* \ingroup grOptigaLibCommon
*
* @{
*/


#ifndef _OPTIGA_LIB_CONFIG_M_V3_H_
#define _OPTIGA_LIB_CONFIG_M_V3_H_

#include "cy_pdl.h"
#include "cyhal.h"
#include "cybsp.h"

#ifdef __cplusplus
extern "C" {
#endif
    
    /** @brief OPTIGA CRYPT random number generation feature enable/disable macro */
    #define OPTIGA_CRYPT_RANDOM_ENABLED
    /** @brief OPTIGA CRYPT hash feature enable/disable macro */
    #define OPTIGA_CRYPT_HASH_ENABLED
    /** @brief OPTIGA CRYPT ECC generate keypair feature enable/disable macro */
    #define OPTIGA_CRYPT_ECC_GENERATE_KEYPAIR_ENABLED
    /** @brief OPTIGA CRYPT ECDSA signature feature enable/disable macro */
    #define OPTIGA_CRYPT_ECDSA_SIGN_ENABLED
    /** @brief OPTIGA CRYPT verify ECDSA signature feature enable/disable macro */
    #define OPTIGA_CRYPT_ECDSA_VERIFY_ENABLED
    /** @brief OPTIGA CRYPT ECDH feature enable/disable macro */
    #define OPTIGA_CRYPT_ECDH_ENABLED
    /** @brief OPTIGA CRYPT ECC 521 feature enable/disable macro */
    #define OPTIGA_CRYPT_ECC_NIST_P_521_ENABLED
    /** @brief OPTIGA CRYPT ECC Brainpool feature enable/disable macro */    
    #define OPTIGA_CRYPT_ECC_BRAINPOOL_P_R1_ENABLED    
    /** @brief OPTIGA CRYPT TLS PRF sha256 feature enable/disable macro */
    #define OPTIGA_CRYPT_TLS_PRF_SHA256_ENABLED
    /** @brief OPTIGA CRYPT TLS PRF sha384 feature enable/disable macro */
    #define OPTIGA_CRYPT_TLS_PRF_SHA384_ENABLED
    /** @brief OPTIGA CRYPT TLS PRF sha512 feature enable/disable macro */
    #define OPTIGA_CRYPT_TLS_PRF_SHA512_ENABLED
    /** @brief OPTIGA CRYPT RSA generate keypair feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_GENERATE_KEYPAIR_ENABLED
    /** @brief OPTIGA CRYPT RSA sign feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_SIGN_ENABLED
    /** @brief OPTIGA CRYPT RSA verify sign feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_VERIFY_ENABLED
    /** @brief OPTIGA CRYPT RSA Encrypt feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_ENCRYPT_ENABLED
    /** @brief OPTIGA CRYPT RSA Decrypt feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_DECRYPT_ENABLED
    /** @brief OPTIGA CRYPT RSA pre-master feature enable/disable macro */
    #define OPTIGA_CRYPT_RSA_PRE_MASTER_SECRET_ENABLED
    /** @brief OPTIGA CRYPT RSA SSA with SHA512 as digest feature enable/disable macro */      
    #define OPTIGA_CRYPT_RSA_SSA_SHA512_ENABLED      
    /** @brief OPTIGA CRYPT symmetric encrypt feature enable/disable macro */
    #define OPTIGA_CRYPT_SYM_ENCRYPT_ENABLED
    /** @brief OPTIGA CRYPT symmetric decrypt feature enable/disable macro */
    #define OPTIGA_CRYPT_SYM_DECRYPT_ENABLED
    /** @brief OPTIGA CRYPT HMAC feature enable/disable macro */
    #define OPTIGA_CRYPT_HMAC_ENABLED
    /** @brief OPTIGA CRYPT HKDF feature enable/disable macro */
    #define OPTIGA_CRYPT_HKDF_ENABLED
    /** @brief OPTIGA CRYPT symmetric generate key feature enable/disable macro */
    #define OPTIGA_CRYPT_SYM_GENERATE_KEY_ENABLED
    /** @brief OPTIGA CRYPT generate auth code feature enable/disable macro */
    #define OPTIGA_CRYPT_GENERATE_AUTH_CODE_ENABLED
    /** @brief OPTIGA CRYPT HMAC verify feature enable/disable macro */
    #define OPTIGA_CRYPT_HMAC_VERIFY_ENABLED
    /** @brief OPTIGA CRYPT clear AUTO state feature enable/disable macro */
    #define OPTIGA_CRYPT_CLEAR_AUTO_STATE_ENABLED   

    /** @brief OPTIGA COMMS shielded connection feature.
     *         To disable the feature, undefine the macro
     */
    //#define OPTIGA_COMMS_SHIELDED_CONNECTION

    /** @brief Default reset protection level for OPTIGA CRYPT and UTIL APIs */
    //#define OPTIGA_COMMS_DEFAULT_PROTECTION_LEVEL           OPTIGA_COMMS_NO_PROTECTION

    
    /** @brief NULL parameter check.
     *         To disable the check, undefine the macro
     */
    #define OPTIGA_LIB_DEBUG_NULL_CHECK
    /** @brief Maximum number of instance registration */
    #define OPTIGA_CMD_MAX_REGISTRATIONS                (0x06)
    /** @brief Maximum buffer size required to communicate with OPTIGA */
    #define OPTIGA_MAX_COMMS_BUFFER_SIZE                (0x615) //1557 in decimal

    /** @brief Macro to enable logger \n
    * Enable macro OPTIGA_LIB_ENABLE_UTIL_LOGGING for Util Service layer logging     \n
    * Enable macro OPTIGA_LIB_ENABLE_CRYPT_LOGGING for Crypt Service layer logging     \n
    * Enable macro OPTIGA_LIB_ENABLE_CMD_LOGGING for Command layer logging     \n
    * Enable macro OPTIGA_LIB_ENABLE_COMMS_LOGGING for Communication layer logging     */
    #define OPTIGA_LIB_ENABLE_LOGGING
    /** @brief Enable macro OPTIGA_PAL_INIT_ENABLED for calling pal_init functionality */
    #define OPTIGA_PAL_INIT_ENABLED
/// @cond
#ifdef OPTIGA_LIB_ENABLE_LOGGING
    /** @brief Macro to enable logger for Util service */
    //#define OPTIGA_LIB_ENABLE_UTIL_LOGGING
    /** @brief Macro to enable logger for Crypt service */
    //#define OPTIGA_LIB_ENABLE_CRYPT_LOGGING
    /** @brief Macro to enable logger for Command layer */
    //#define OPTIGA_LIB_ENABLE_CMD_LOGGING
    /** @brief Macro to enable logger for Communication layer */
    //#define OPTIGA_LIB_ENABLE_COMMS_LOGGING
#endif
/// @endcond

    /* Below are the example macros for protected update not for any feature */
    /** @brief OPTIGA UTIL confidentiality protected update feature enable/disable macro */      
    #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_CONFIDENTIALITY_ENABLED    
    /** @brief OPTIGA UTIL key object protected update feature enable/disable macro */      
    #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_KEY_ENABLED    
    /** @brief OPTIGA UTIL metadata object protected update feature enable/disable macro */      
    #define EXAMPLE_OPTIGA_UTIL_PROTECTED_UPDATE_OBJECT_METADATA_ENABLED    
    

    /* 
     * The following GPIO settings are only ModusToolbox and specific PSoC6 family board relevant
     */
#if defined(CYBSP_TRUSTM_I2C_SCL)
    #define OPTIGA_TRUSTM_SCL        CYBSP_TRUSTM_I2C_SCL
#elif defined(CYBSP_I2C_SCL)
    #define OPTIGA_TRUSTM_SCL        CYBSP_I2C_SCL
#else
    #error "You need to define the OPTIGA_TRUSTM_SCL macro for OPTIGA to know what to use for the communication"
#endif

#if defined(CYBSP_TRUSTM_I2C_SDA)
    #define OPTIGA_TRUSTM_SDA        CYBSP_TRUSTM_I2C_SDA
#elif defined(CYBSP_I2C_SDA)
    #define OPTIGA_TRUSTM_SDA        CYBSP_I2C_SDA
#else
    #error "You need to define the OPTIGA_TRUSTM_SDA macro for OPTIGA to know what to use for the communication"
#endif

#if defined(CYBSP_TRUSTM_RST)
    #define OPTIGA_TRUSTM_RST        CYBSP_TRUSTM_RST
#endif
#if defined(CYBSP_TRUSTM_VDD)
    #define OPTIGA_TRUSTM_VDD        CYBSP_TRUSTM_VDD
#else
    #error "Please define your own OPTIGA_TRUSTM_VDD pin for this example to function. Consult with the Datasheet on how a hybernation feature can be used"
#endif

/** @brief Default reset type in optiga_comms_open.             \n
 *         Cold Reset - (0) : This is applicable if the host platform has GPIO option for RST and VDD.    \n
 *         Soft Reset - (1) : This is applicable if the host platform doesn't have GPIO options for VDD and RST.  \n
 *         Warm Reset - (2) : This is applicable if the host platform doesn't have GPIO option for VDD. \n
 *         Any other value will lead to error
 */
#if defined(CYBSP_TRUSTM_RST) || defined(CYBSP_TRUSTM_VDD)
    #define OPTIGA_COMMS_DEFAULT_RESET_TYPE     (0U)
#elif !defined(CYBSP_TRUSTM_RST) && !defined(CYBSP_TRUSTM_VDD)
    #define OPTIGA_COMMS_DEFAULT_RESET_TYPE     (1U)
#elif defined(CYBSP_TRUSTM_RST) && !defined(CYBSP_TRUSTM_VDD)
    #define OPTIGA_COMMS_DEFAULT_RESET_TYPE     (0U)
#endif


#ifdef __cplusplus
}
#endif

#endif /* _OPTIGA_LIB_CONFIG_M_V3_H_*/

/**
* @}
*/