OPTIGA™ Trust M
Host Library Documentation
File List
Here is a list of all files with brief descriptions:
 aes_key_object_confidentiality.hThis file provides the data set for protected update of aes key object with confidentiality
 cbor.hThis file defines APIs, types and data structures used for cbor format coding
 common_utilites.h
 data_object.h
 data_object_confidentiality.hThis file provides the data set for protected update of data object with confidentiality
 ecc_key_object_confidentiality.hThis file provides the data set for protected update of ecc key object with confidentiality
 example_optiga_util_protected_update.hThis file provides the data set for protected update of ecc key object with confidentiality
 ifx_i2c.hThis file defines the API prototype for IFX I2C protocol v2.00 wrapper
 ifx_i2c_config.hThis file defines the structures and macros for the Infineon I2C Protocol
 ifx_i2c_data_link_layer.hThis file defines the API prototype for data link layer of the Infineon I2C Protocol Stack library
 ifx_i2c_physical_layer.hThis file defines the API prototype for physical layer of the Infineon I2C Protocol Stack library
 ifx_i2c_presentation_layer.hModule for the presentation layer of the Infineon I2C Protocol Stack library
 ifx_i2c_transport_layer.hThis file defines the API prototype for transport layer of the Infineon I2C Protocol Stack library
 metadata_object_confidentiality.hThis file provides the data set for protected update of metadata object with confidentiality
 optiga_cmd.hThis file defines APIs, types and data structures used in the Command (cmd) module implementation
 optiga_comms.hThis file implements Optiga comms abstraction layer for IFX I2C Protocol
 optiga_crypt.hThis file implements the prototype declarations of OPTIGA Crypt module
 optiga_example.hThis file defines APIs, types and data structures used in the OPTIGA example
 optiga_lib_common.hThis file provides the prototypes for the commonly used functions and structures of OPTIGA Library
 optiga_lib_common_internal.hThis file provides the prototypes for the commonly used internal functions and structures of OPTIGA Library
 optiga_lib_config.hThis file is defines the compilation switches to build code with required features
 optiga_lib_config_m_v1.hThis file is defines the compilation switches to build code with required features
 optiga_lib_config_m_v3.hThis file is defines the compilation switches to build code with required features
 optiga_lib_logger.hThis file provides the prototypes for the OPTIGA library logger
 optiga_lib_return_codes.hThis file defines the error codes for the all the layers and modules.
OPTIGA host library return value Decoding
The definition of the Error code layering for a 2 byte error code explained below.
Each error code is represented as [AB][CD], where each byte is represented as [ ] and individual alphabets represent a nibble.
A : Error indication Bit 15. Set to 1 indicates error from OPTIGA security chip
B : Layer information Bits [14 - 8]. This indicates the layer from which the error originated. E.g. OPTIGA, PAL, Comms, Util, Crypt etc.
CD : Return code Bits [7 - 0]. This indicates the actual nature of error
 optiga_lib_types.hThis file contains the type definitions for the fundamental data types
 optiga_lib_version.hThis file contains Optiga library version information
 optiga_util.hThis file defines APIs, types and data structures used in the OPTIGA utility module
 pal.hThis file provides the prototype declarations of platform abstraction layer
 examples/tools/protected_update_data_set/include/pal/pal_crypt.hThis file defines APIs, types and data structures used for protected update pal crypt
 optiga/include/optiga/pal/pal_crypt.hThis file provides the prototype declarations of PAL crypt
 pal_file_system.hThis file defines APIs, types and data structures used for protect update tool file system
 pal_gpio.hThis file provides the prototype declarations of PAL GPIO
 pal_i2c.hThis file provides the prototype declarations of PAL I2C
 pal_ifx_i2c_config.hThis file provides the platform abstraction layer extern declarations for IFX I2C
 examples/tools/protected_update_data_set/include/pal/pal_logger.hThis file defines APIs, types and data structures used for protected update logger
 optiga/include/optiga/pal/pal_logger.hThis file provides the prototypes declarations for pal logger
 pal_os_datastore.hThis file provides API prototypes of platform abstraction layer for datastore operations
 pal_os_event.hThis file provides the prototype declarations of PAL OS event
 pal_os_lock.hThis file provides the prototype declarations of PAL OS lock functionalities
 examples/tools/protected_update_data_set/include/pal/pal_os_memory.hThis file defines APIs, for protected update tool memory system
 optiga/include/optiga/pal/pal_os_memory.hThis file provides the prototype declarations of PAL OS MEMORY
 pal_os_timer.hThis file provides the prototype declarations of PAL OS timer functionalities
 protected_update_data_set.hThis file defines APIs, types and data structures used for protected update data set creation
 protected_update_data_set_version.hThis file defines the version for protect update tool version
 rsa_key_object_confidentiality.hThis file provides the data set for protected update of rsa key object with confidentiality
 user_input_parser.hThis file defines APIs, types and data structures used for protected update logger
Copyright © 2021 Infineon Technologies AG