optiga_comms.h

Go to the documentation of this file.

 
#ifndef _OPTIGA_COMMS_H_
#define _OPTIGA_COMMS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "optiga/common/optiga_lib_types.h"
#include "optiga/common/optiga_lib_return_codes.h"
#include "optiga/common/optiga_lib_common.h"
 
#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
// Offset for data
#define OPTIGA_COMMS_DATA_OFFSET         (0x05)
// Overhead buffer size for user buffer
#define OPTIGA_COMMS_PRL_OVERHEAD        (0x0D)
#else
#define OPTIGA_COMMS_DATA_OFFSET         (0x00)
#define OPTIGA_COMMS_PRL_OVERHEAD        (0x00)
#endif
 
typedef struct optiga_comms
{
    void * p_comms_ctx;
    void * p_upper_layer_ctx;
    upper_layer_callback_t upper_layer_handler;
    uint8_t instance_init_state;
    uint8_t state;
#ifdef OPTIGA_COMMS_SHIELDED_CONNECTION
    uint8_t protection_level;
    uint8_t protocol_version;
    uint8_t manage_context_operation;
#endif
    void * p_pal_os_event_ctx;
} optiga_comms_t;
 
extern optiga_comms_t optiga_comms;
 
optiga_comms_t * optiga_comms_create(callback_handler_t callback,
                                     void * context);
 
void optiga_comms_destroy(optiga_comms_t * optiga_comms);
 
optiga_lib_status_t optiga_comms_set_callback_context(optiga_comms_t * p_optiga_comms,
                                                      void *context);
 
optiga_lib_status_t optiga_comms_set_callback_handler(optiga_comms_t * p_optiga_comms,
                                                      callback_handler_t handler);
LIBRARY_EXPORTS optiga_lib_status_t optiga_comms_open(optiga_comms_t * p_ctx);
 
 
LIBRARY_EXPORTS optiga_lib_status_t optiga_comms_reset(optiga_comms_t * p_ctx, uint8_t reset_type);
 
LIBRARY_EXPORTS optiga_lib_status_t optiga_comms_transceive(optiga_comms_t * p_ctx,
                                                            const uint8_t * p_tx_data,
                                                            uint16_t tx_data_length,
                                                            uint8_t * p_rx_data,
                                                            uint16_t * p_rx_data_len);
 
LIBRARY_EXPORTS optiga_lib_status_t optiga_comms_close(optiga_comms_t * p_ctx);
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /*_OPTIGA_COMMS_H_*/