m2mb_secure_ms.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_SECURE_MS_API_H
#define  M2M_M2MB_SECURE_MS_API_H
 
 
/* Global declarations ==========================================================================*/
 
#define M2MB_SYSTEM_FILE_ID     (-1)
 
#define M2MB_RAM_FILE_ID        (0)
 
/*    m2mb_secure_ms_open Flags : default are all 0   */
#define M2MB_SECURE_MS_READ                 0x0000
 
#define M2MB_SECURE_MS_WRITE                0x0001  //( (UINT32)1<<0 )
 
#define M2MB_SECURE_MS_CREATE               0x0002  //( (UINT32)1<<1 )
 
#define M2MB_SECURE_MS_ADMIN                0x0004
 
#define M2MB_SECURE_MS_READ_ONLY            0x0008
 
#define M2MB_SECURE_MS_TRUSTED              0x0010
 
#define M2MB_SECURE_MS_ALLOW_COMPARE        0x0020
 
#define M2MB_SECURE_MS_NO_ENCRYPTION        0x0080
 
/* Error Codes ================================================================================= */
  typedef enum
  {
    M2MB_SECURE_MS_ERRNO_NOERROR,
    M2MB_SECURE_MS_ERRNO_IN_USE,
    M2MB_SECURE_MS_ERRNO_NO_ACCESS_RIGHTS,
    M2MB_SECURE_MS_ERRNO_ID_ALREADY_EXIST,
    M2MB_SECURE_MS_ERRNO_ID_DOESNT_EXIST,
    M2MB_SECURE_MS_ERRNO_ILLEGAL_PARAM,
    M2MB_SECURE_MS_ERRNO_OUT_OF_SPACE,
    M2MB_SECURE_MS_ERRNO_INVALID_HANDLE,
    M2MB_SECURE_MS_ERRNO_FAIL_TO_CREATE_HANDLE,
    M2MB_SECURE_MS_ERRNO_INVALID_DATA,
    M2MB_SECURE_MS_ERRNO_CRYPTO_ERR,
    M2MB_SECURE_MS_ERRNO_FILE_SYSTEM_ERR,
    M2MB_SECURE_MS_ERRNO_DATA_ISNT_DEFINED_AS_KEY,
    M2MB_SECURE_MS_ERRNO_FATAL,
    M2MB_SECURE_MS_ERRNO_DELETE_ERR,
    M2MB_SECURE_MS_ERRNO_INCOMPATIBLE_REQ,
    M2MB_SECURE_MS_ERRNO_UNKNOWN = 65535,
    ENUM_TO_INT( M2MB_SECURE_MS_ERRNO_E )
  } M2MB_SECURE_MS_ERRNO_E;
 
/* Global typedefs ==============================================================================*/
 
typedef struct M2MB_SECURE_MS_HANDLE_S *M2MB_SECURE_MS_HANDLE;
 
typedef enum
{
  M2MB_SECURE_MS_GET_STATE,
  M2MB_SECURE_MS_LOCK_TSD,
  M2MB_SECURE_MS_TELIT_FACTORY_RESET,
  M2MB_SECURE_MS_LOCK_CSD,
  M2MB_SECURE_MS_CUSTOMER_FACTORY_RESET
} M2MB_SECURE_MS_MANAGE_REQ_E;
 
typedef enum
{
  M2MB_SECURE_MS_TSD_ACTIVE,
  M2MB_SECURE_MS_CSD_ACTIVE,
  M2MB_SECURE_MS_OSD_ACTIVE
} M2MB_SECURE_MS_MANAGE_STATE_E;
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_manage( M2MB_SECURE_MS_MANAGE_REQ_E     request,
                                     M2MB_SECURE_MS_MANAGE_STATE_E   *state );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_remove_file( INT32 file_id );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_open( M2MB_SECURE_MS_HANDLE *handle, INT32 file_id, UINT16 item_id, UINT16 flags );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_read( M2MB_SECURE_MS_HANDLE handle, UINT32 max_len, UINT8 *data, UINT32 *act_len );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_write( M2MB_SECURE_MS_HANDLE handle, UINT8 *data, UINT32 len );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_compare( M2MB_SECURE_MS_HANDLE handle, UINT8 *data, UINT32 len );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_delete( M2MB_SECURE_MS_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_close( M2MB_SECURE_MS_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_SECURE_MS_ERRNO_E m2mb_secure_ms_errno( M2MB_SECURE_MS_HANDLE handle );
 
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_secure_ms_init( void );
 
#endif /* M2M_M2MB_SECURE_MS_API_H */