m2mb_sim.h

Go to the documentation of this file.

/* $version: 252203  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_SIM_API_H
#define  M2M_M2MB_SIM_API_H
 
 
/* Global declarations ==========================================================================*/
 
#define MAX_APDU_SIZE ( 300 )
 
/* Global typedefs ==============================================================================*/
 
typedef HANDLE M2MB_SIM_HANDLE;
 
typedef enum
{
  M2MB_SIM_SUCCESS,
  M2MB_SIM_GENERIC_FAILURE,
} M2MB_SIM_ERRNO_E;
 
typedef enum
{
  M2MB_SIM_REMOTE_EVENT_RESP,
  M2MB_SIM_REMOTE_APDU_RESP,
  M2MB_SIM_REMOTE_CONNECT_IND,
  M2MB_SIM_REMOTE_APDU_IND,
  M2MB_SIM_REMOTE_INIT_IND,
  /* indication of switching to VSIM */
  M2MB_SIM_PROF01_SET_IND,
  /* indication of switching back to physical SIM */
  M2MB_SIM_PROF00_SET_IND,
  /* indication of executing SIM personalization */
  M2MB_SIM_EXECUTE_CRYPTO_IND
} M2MB_SIM_IND_E;
 
typedef enum
{
  /* SIM type selection */
  M2MB_SIM_LOCAL_SIM,
  M2MB_SIM_REMOTE_SIM
} M2MB_SIM_SELECTION_E;
 
typedef enum
{
  M2MB_SIM_EUICC_EXECUTE_APDU_REQ = 0x01,
  M2MB_SIM_EUICC_EXECUTE_APDU_RESP = 0x02,
  M2MB_SIM_EUICC_INIT = 0x03,
  M2MB_SIM_EUICC_RESET = 0x04,
  M2MB_SIM_EUICC_EXECUTE_CRYPTO = 0x05
} M2MB_SIMOS_MSGTYPE_E;
 
typedef struct
{
  UINT32 pdu_size;
  UINT8 pdu[MAX_APDU_SIZE];
} M2MB_SIM_INCOMING_APDU_T;
 
/* used to provide personalization file: FFU */
typedef struct
{
  UINT32 perso_data_size;
  UINT8 *perso_data;
} M2MB_SIM_PERSO_DATA_T;
 
/* message to be sent to Sim OS; handle simHandle should be known by task */
typedef struct
{
  M2MB_SIMOS_MSGTYPE_E MsgType;
  M2MB_SIM_HANDLE simHandle;
  UINT32 pdu_size;
  UINT8 *pdu;
} M2MB_SIMOS_REQ_T;
 
 
typedef void ( *m2mb_sim_ind_callback )( M2MB_SIM_HANDLE h, M2MB_SIM_IND_E sim_event, UINT16 resp_size, void *resp_struct, void *userdata );
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_init( M2MB_SIM_HANDLE *h, m2mb_sim_ind_callback callback, void *userdata );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_send_remote_apdu_req( M2MB_SIM_HANDLE h, UINT8 *apduCommand, UINT16 cmdApduLen );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_select_sim( M2MB_SIM_HANDLE h, M2MB_SIM_SELECTION_E simSelection );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_send_remote_apdu_resp( M2MB_SIM_HANDLE h, UINT8 SW1, UINT8 SW2, UINT8 *apduResponse,
                                              UINT16 respLen, UINT8 SIMStatus );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_send_crypto_resp( M2MB_SIM_HANDLE h, UINT8 *pData, UINT16 datalen, M2MB_RESULT_E cryptoResult );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_sim_send_remote_reset_req( M2MB_SIM_HANDLE h );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
 
M2MB_RESULT_E m2mb_sim_send_remote_watchdog_kick_req( M2MB_SIM_HANDLE h, UINT32 wdTimeoutX );
 
 
#endif