ifx_i2c_config.h

Go to the documentation of this file.

#ifndef _IFX_I2C_CONFIG_H_
#define _IFX_I2C_CONFIG_H_

#ifdef __cplusplus
extern "C" {
#endif

#ifdef IFX_I2C_CONFIG_EXTERNAL
    #include "ifx_i2c_config_external.h"
#else
// Protocol Stack Includes
#include "pal_i2c.h"
#include "pal_gpio.h"
#include "pal_os_timer.h"
#include "pal_os_datastore.h"
#include "optiga_lib_config.h"
#include "optiga_lib_logger.h"

#define IFX_I2C_BASE_ADDR           (0x30)

#define PL_POLLING_INVERVAL_US      (1000U)

#define PL_POLLING_MAX_CNT          (200U)

#define PL_DATA_POLLING_INVERVAL_US (5000U)

#define PL_GUARD_TIME_INTERVAL_US   (50U)

#ifdef IFX_I2C_FRAME_SIZE
    #if (IFX_I2C_FRAME_SIZE > 277) || (IFX_I2C_FRAME_SIZE < 16)
        #error "unsupported value"
    #endif
#else
    #define IFX_I2C_FRAME_SIZE          (19U)
#endif

#define TL_HEADER_SIZE              (1U)

#define DL_HEADER_SIZE              (5U)

#define DL_TRANS_REPEAT             (3U)

#define PL_TRANS_TIMEOUT_MS         (10U)

#define TL_MAX_EXIT_TIMEOUT         (180U)

#define RESET_LOW_TIME_MSEC         (2000U)

#define STARTUP_TIME_MSEC           (12000U)

#define IFX_I2C_STACK_SUCCESS       (0x0000)

#define IFX_I2C_STACK_BUSY          (0x0001)

#define IFX_I2C_STACK_ERROR         (0x0102)

#define IFX_I2C_STACK_MEM_ERROR     (0x0104)

#define IFX_I2C_FATAL_ERROR         (0x0106)

#define IFX_I2C_HANDSHAKE_ERROR     (0x0107)

#define IFX_I2C_SESSION_ERROR       (0x0108)

#define IFX_I2C_DL_HEADER_OFFSET    (0U)

#define IFX_I2C_TL_HEADER_OFFSET    (IFX_I2C_DL_HEADER_OFFSET + 3)

#define IFX_I2C_LOG_PL              (0U)

#define IFX_I2C_LOG_DL              (0U)

#define IFX_I2C_LOG_TL              (0U)

#define IFX_I2C_LOG_PRL             (0U)

#define IFX_I2C_LOG_ID_PL           (0x00)

#define IFX_I2C_LOG_ID_DL           (0x01)

#define IFX_I2C_LOG_ID_TL           (0x02)

#define IFX_I2C_LOG_ID_PRL          (0x03)

#define IFX_I2C_LOG_ID_PAL          (0x04)


#if defined IFX_I2C_PRESENTATION_LAYER_TRANSPARENT
    #define IFX_I2C_TL_ENABLE              (1U)

    #define IFX_I2C_PRESENCE_BIT           (0x08)
    #define IFX_I2C_PRL_MAC_SIZE           (0x08)
    #define IFX_I2C_PRL_HEADER_SIZE        (0x05)
    #define IFX_I2C_PRL_OVERHEAD_SIZE      (IFX_I2C_PRL_HEADER_SIZE + IFX_I2C_PRL_MAC_SIZE)
    #define IFX_I2C_DATA_OFFSET            (IFX_I2C_PRL_HEADER_SIZE)
    #define IFX_I2C_PRESENCE_BIT_CHECK     (0x08)
#endif

#if defined OPTIGA_COMMS_SHIELDED_CONNECTION
    #define IFX_I2C_PRL_ENABLED            (1U)
    #define IFX_I2C_TL_ENABLE              (1U)

    #define IFX_I2C_PRESENCE_BIT           (0x08)
    #define IFX_I2C_PRL_MAC_SIZE           (0x08)
    #define IFX_I2C_PRL_HEADER_SIZE        (0x05)
    #define IFX_I2C_PRL_OVERHEAD_SIZE      (IFX_I2C_PRL_HEADER_SIZE + IFX_I2C_PRL_MAC_SIZE)
    #define IFX_I2C_DATA_OFFSET            (IFX_I2C_PRL_HEADER_SIZE)
    #define IFX_I2C_PRESENCE_BIT_CHECK     (0x08)
#else
    #define IFX_I2C_PRESENCE_BIT           (0x00)
    #define IFX_I2C_PRL_MAC_SIZE           (0x00)
    #define IFX_I2C_PRL_HEADER_SIZE        (0x00)
    #define IFX_I2C_PRL_OVERHEAD_SIZE      (IFX_I2C_PRL_HEADER_SIZE + IFX_I2C_PRL_MAC_SIZE)
    #define IFX_I2C_DATA_OFFSET            (IFX_I2C_PRL_HEADER_SIZE)
    #define IFX_I2C_PRESENCE_BIT_CHECK     (0x00)
#endif

#define PROTOCOL_VERSION_PRE_SHARED_SECRET   (0x01)

#define IFX_I2C_SESSION_CONTEXT_RESTORE    (0x11)

#define IFX_I2C_SESSION_CONTEXT_SAVE       (0x22)

#define IFX_I2C_SESSION_CONTEXT_NONE       (0x33)

#define NO_PROTECTION               (0x00)

#define MASTER_PROTECTION           (0x01)

#define SLAVE_PROTECTION            (0x02)

#define FULL_PROTECTION             (0x03)

#define RE_ESTABLISH                (0x80)


typedef struct ifx_i2c_context ifx_i2c_context_t;

typedef void ( * ifx_i2c_event_handler_t)(struct ifx_i2c_context * p_ctx,
                                          optiga_lib_status_t event,
                                          const uint8_t * data,
                                          uint16_t data_len);

typedef struct ifx_i2c_pl
{
    // Physical Layer low level interface variables

    uint8_t buffer[IFX_I2C_FRAME_SIZE + 1];
    uint16_t buffer_tx_len;
    uint16_t buffer_rx_len;
    uint8_t  register_action;
    uint8_t  i2c_cmd;
    uint16_t retry_counter;

    // Physical Layer high level interface variables

    uint8_t   frame_action;
    uint8_t   frame_state ;
    uint8_t * p_tx_frame;
    uint16_t  tx_frame_len;
    // Upper layer handler
    ifx_i2c_event_handler_t upper_layer_event_handler;

    // Physical Layer negotiation/soft reset variables

    uint8_t   negotiate_state;
    uint8_t   request_soft_reset;
} ifx_i2c_pl_t;

typedef struct ifx_i2c_dl
{
    // Data Link layer internal state variables

    uint8_t state;
    uint8_t tx_seq_nr;
    // Rx sequence number
    uint8_t rx_seq_nr;
    uint8_t action_rx_only;
    uint8_t retransmit_counter;
    uint8_t error;
    uint8_t resynced;
    uint32_t data_poll_timeout;
    uint16_t tx_buffer_size;
    uint16_t rx_buffer_size;
    uint8_t * p_tx_frame_buffer;
    uint8_t * p_rx_frame_buffer;
    uint32_t frame_start_time;
    // Upper layer Event handler
    ifx_i2c_event_handler_t upper_layer_event_handler;
} ifx_i2c_dl_t;

typedef struct ifx_i2c_tl
{
    // Transport Layer state and buffer

    uint8_t  state;
    uint8_t * p_actual_packet;
    uint16_t total_recv_length;
    uint16_t actual_packet_length;
    uint16_t packet_offset;
    uint16_t max_packet_length;
    uint8_t * p_recv_packet_buffer;
    uint16_t * p_recv_packet_buffer_length;
    uint32_t api_start_time;
    uint8_t chaining_error_count;
    uint8_t master_chaining_error_count;
    uint8_t previous_chaining;
    uint8_t transmission_completed;
    optiga_lib_status_t error_event;
    uint8_t payload_offset;
    uint8_t tx_payload_offset;
    uint8_t initialization_state;

    ifx_i2c_event_handler_t upper_layer_event_handler;
} ifx_i2c_tl_t;

#if defined OPTIGA_COMMS_SHIELDED_CONNECTION

typedef struct ifx_i2c_prl_manage_context
{
    uint8_t session_key[40];
    uint8_t decryption_failure_counter;
    uint8_t data_retransmit_counter;
    uint8_t negotiation_state;
    uint8_t stored_context_flag;
    uint32_t master_sequence_number;
    uint32_t save_slave_sequence_number;
}ifx_i2c_prl_manage_context_t;

typedef struct ifx_i2c_datastore_config
{
    uint8_t  protocol_version;
    uint16_t datastore_shared_secret_id;
    uint16_t datastore_manage_context_id;
    uint16_t shared_secret_length;
} ifx_i2c_datastore_config_t;


typedef struct ifx_i2c_prl
{
    // Presentation layer state
    uint8_t state;
    // Handshake state
    uint8_t hs_state;
    uint8_t negotiation_state;
    uint8_t mc_state;
    uint32_t master_sequence_number;
    uint32_t slave_sequence_number;
    uint32_t save_slave_sequence_number;
    uint8_t * p_actual_payload;
    uint16_t actual_payload_length;
    uint8_t * p_recv_payload_buffer;
    uint16_t * p_recv_payload_buffer_length;
    uint8_t sctr;
    uint8_t saved_sctr;
    uint8_t alert_type;
    uint8_t prl_header_offset;
    uint8_t session_key[40];
    uint8_t random[32];
    uint8_t prl_txrx_buffer[58];
    uint16_t prl_txrx_receive_length;
    uint8_t associate_data[8];
    uint16_t prl_receive_length;
    uint8_t decryption_failure_counter;
    uint8_t data_retransmit_counter;
    optiga_lib_status_t return_status;
    uint8_t restore_context_flag;
    //Context to be stored
    ifx_i2c_prl_manage_context_t prl_saved_ctx;
    // Upper layer Event handler
    ifx_i2c_event_handler_t upper_layer_event_handler;
    // Trans repeat status
    uint8_t trans_repeat_status;
}ifx_i2c_prl_t;
#endif

typedef struct ifx_i2c_context
{
    uint8_t slave_address;
    uint16_t frequency;
    uint16_t frame_size;
    pal_gpio_t * p_slave_vdd_pin;
    pal_gpio_t * p_slave_reset_pin;
    pal_i2c_t * p_pal_i2c_ctx;
#if defined OPTIGA_COMMS_SHIELDED_CONNECTION
    ifx_i2c_datastore_config_t * ifx_i2c_datastore_config;
#endif
    upper_layer_callback_t upper_layer_event_handler;
    void * p_upper_layer_ctx;
    uint8_t * p_upper_layer_rx_buffer;
    uint16_t * p_upper_layer_rx_buffer_len;

    uint8_t state;
    uint8_t status;
    uint8_t reset_state;
    optiga_lib_status_t close_state;
    uint8_t reset_type;
    uint8_t do_pal_init;
#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
    // protection level:
    //0(master unprotected and slave unprotected),1(master protected and slave unprotected),
    //2(master unprotected and slave protected),3(master protected and slave protected),
    //255(re-negotiate)
    uint8_t protection_level;
    uint8_t protocol_version;
    uint8_t manage_context_operation;
#endif
    ifx_i2c_tl_t tl;
    ifx_i2c_dl_t dl;
    ifx_i2c_pl_t pl;
#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
    ifx_i2c_prl_t prl;
#endif
    uint8_t tx_frame_buffer[IFX_I2C_FRAME_SIZE+1];
    uint8_t rx_frame_buffer[IFX_I2C_FRAME_SIZE+1];
    void * pal_os_event_ctx;

} ifx_i2c_context_t;

extern ifx_i2c_context_t ifx_i2c_context_0;

#if defined (OPTIGA_LIB_ENABLE_LOGGING) && defined (OPTIGA_LIB_ENABLE_COMMS_LOGGING)

#define OPTIGA_COMMS_LOG_MESSAGE(msg) \
{\
    optiga_lib_print_message(msg,OPTIGA_COMMUNICATION_LAYER,OPTIGA_COMMUNICATION_LAYER_COLOR);\
}

#define OPTIGA_COMMS_LOG_STATUS(return_value)                                 \
{                                                       \
    if (OPTIGA_LIB_SUCCESS != return_value)                                 \
    {                                                     \
        optiga_lib_print_status(OPTIGA_COMMUNICATION_LAYER,OPTIGA_ERROR_COLOR,return_value);        \
    }                                                     \
    else                                                  \
    {                                                     \
        optiga_lib_print_status(OPTIGA_COMMUNICATION_LAYER,OPTIGA_COMMUNICATION_LAYER_COLOR,return_value);  \
    }                                                     \
}

#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION

#define OPTIGA_IFXI2C_LOG_TRANSMIT_HEX_DATA(array,array_len,p_ifx_i2c_ctx)              \
{                                                 \
  if (0 != frame_len)                                       \
  {                                               \
    if (((((ifx_i2c_context_t * )p_ifx_i2c_ctx)->protection_level & 0x0F) == 0x01) ||       \
      ((((ifx_i2c_context_t * )p_ifx_i2c_ctx)->protection_level & 0x0F) == 0x03))       \
      {                                             \
        optiga_lib_print_array_hex_format(array,array_len,OPTIGA_PROTECTED_DATA_COLOR);  \
      }                                             \
      else                                          \
      {                                             \
        optiga_lib_print_array_hex_format(array,array_len,OPTIGA_UNPROTECTED_DATA_COLOR);\
      }                                             \
  }                                               \
}

#define OPTIGA_IFXI2C_LOG_RECEIVE_HEX_DATA(array,array_len,p_ifx_i2c_ctx) \
{\
    if (((((ifx_i2c_context_t * )p_ifx_i2c_ctx)->protection_level & 0x0F) == 0x02) || \
        ((((ifx_i2c_context_t * )p_ifx_i2c_ctx)->protection_level & 0x0F) == 0x03)) \
        { \
            optiga_lib_print_array_hex_format(array,array_len,OPTIGA_PROTECTED_DATA_COLOR); \
        } \
        else \
        { \
            optiga_lib_print_array_hex_format(array,array_len,OPTIGA_UNPROTECTED_DATA_COLOR); \
        } \
}
#else

#define OPTIGA_IFXI2C_LOG_TRANSMIT_HEX_DATA(array,array_len,p_ifx_i2c_ctx) \
{\
    OPTIGA_COMMS_LOG_MESSAGE("");\
    optiga_lib_print_array_hex_format(array,array_len,OPTIGA_UNPROTECTED_DATA_COLOR);\
}

#define OPTIGA_IFXI2C_LOG_RECEIVE_HEX_DATA(array,array_len,p_ifx_i2c_ctx) \
{\
    OPTIGA_COMMS_LOG_MESSAGE("");\
    optiga_lib_print_array_hex_format(array,array_len,OPTIGA_UNPROTECTED_DATA_COLOR);\
}

#endif

#else

#define OPTIGA_IFXI2C_LOG_TRANSMIT_HEX_DATA(array,array_len,p_ifx_i2c_ctx) {}
#define OPTIGA_IFXI2C_LOG_RECEIVE_HEX_DATA(array,array_len,p_ifx_i2c_ctx) {}
#define OPTIGA_COMMS_LOG_MESSAGE(msg) {}
#define OPTIGA_COMMS_LOG_STATUS(return_value) {}
#endif

#endif

#ifdef __cplusplus
}
#endif
#endif /* _IFX_I2C_CONFIG_H_ */