lmic_secure_element_interface.h

Go to the documentation of this file.

/*
 
Module:  lmic_secure_element_interface.h
 
Function:
        The API type
 
Copyright & License:
        See accompanying LICENSE file.
 
Author:
        Terry Moore, MCCI          May 2020
 
*/

 
#ifndef _lmic_secure_element_interface_h_
#define _lmic_secure_element_interface_h_
 
#ifndef _lmic_env_h_
# include "../../lmic/lmic_env.h"
#endif
 
#ifndef _oslmic_types_h_
# include "../../lmic/oslmic_types.h"
#endif

 
LMIC_BEGIN_DECLS

enum LMIC_SecureElement_Error_e {
        LMIC_SecureElement_Error_OK = 0,                        
        LMIC_SecureElement_Error_InvalidParameter,  
        LMIC_SecureElement_Error_Permission,            
        LMIC_SecureElement_Error_NotProvisioned,        
        LMIC_SecureElement_Error_InvalidMIC,            
        LMIC_SecureElement_Error_Implementation,        
};

typedef enum LMIC_SecureElement_Error_e LMIC_SecureElement_Error_t;

typedef struct LMIC_SecureElement_Aes128Key_s {
        uint8_t bytes[16];  
} LMIC_SecureElement_Aes128Key_t;

typedef struct LMIC_SecureElement_EUI_s {
        uint8_t bytes[8];   
} LMIC_SecureElement_EUI_t;

typedef struct LMIC_SecureLElement_JoinRequest_s {
        uint8_t bytes[23];  
} LMIC_SecureElement_JoinRequest_t;

 
enum LMIC_SecureElement_KeySelector_e {
        LMIC_SecureElement_KeySelector_Unicast = 0, 
        LMIC_SecureElement_KeySelector_Mc0,              
        LMIC_SecureElement_KeySelector_Mc1,              
        LMIC_SecureElement_KeySelector_Mc2,              
        LMIC_SecureElement_KeySelector_Mc3,              
        LMIC_SecureElement_KeySelector_AppKey,    
        LMIC_SecureElement_KeySelector_SIZE              
};

typedef uint8_t LMIC_SecureElement_KeySelector_t;

#define LMIC_SecureElement_KeySelector_NAME_MULTISZ_INIT        \
        "Unicast\0"                                                                                      \
        "Mc0\0"                                                                                          \
        "Mc1\0"                                                                                          \
        "Mc2\0"                                                                                          \
        "Mc3\0"

 
enum LMIC_SecureElement_JoinFormat_e {
        LMIC_SecureElement_JoinFormat_JoinRequest10,            
        LMIC_SecureElement_JoinFormat_JoinRequest11,            
        LMIC_SecureElement_JoinFormat_RejoinRequest0,      
        LMIC_SecureElement_JoinFormat_RejoinRequest1,      
        LMIC_SecureElement_JoinFormat_RejoinRequest2,      
        LMIC_SecureElement_JoinFormat_SIZE                                
};

typedef uint8_t LMIC_SecureElement_JoinFormat_t;
 
 
/****************************************************************************\
|          The API function signatures.
\****************************************************************************/



typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_initialize_t(void);

typedef uint8_t LMIC_ABI_STD
LMIC_SecureElement_getRandomU1_t(void);

typedef uint16_t LMIC_ABI_STD
LMIC_SecureElement_getRandomU2_t(void);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_fillRandomBuffer_t(uint8_t *buffer, uint8_t nBuffer);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_setAppKey_t(const LMIC_SecureElement_Aes128Key_t *pAppKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_getAppKey_t(LMIC_SecureElement_Aes128Key_t *pAppKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_setNwkSKey_t(const LMIC_SecureElement_Aes128Key_t *pNwkSKey, LMIC_SecureElement_KeySelector_t iKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_getNwkSKey_t(LMIC_SecureElement_Aes128Key_t *pNwkSKey, LMIC_SecureElement_KeySelector_t iKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_setAppSKey_t(const LMIC_SecureElement_Aes128Key_t *pAppSKey, LMIC_SecureElement_KeySelector_t iKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_getAppSKey_t(LMIC_SecureElement_Aes128Key_t *pAppSKey, LMIC_SecureElement_KeySelector_t iKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_getDevEUI_t(LMIC_SecureElement_EUI_t *pDevEUI);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_setDevEUI_t(const LMIC_SecureElement_EUI_t *pDevEUI);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_getAppEUI_t(LMIC_SecureElement_EUI_t *pAppEUI);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_setAppEUI_t(const LMIC_SecureElement_EUI_t *pAppEUI);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_createJoinRequest_t(
        uint8_t *pJoinRequestBytes, LMIC_SecureElement_JoinFormat_t joinFormat
);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_decodeJoinAccept_t(
        const uint8_t *pJoinAcceptBytes, uint8_t nJoinAcceptBytes,
        uint8_t *pJoinAcceptClearText,
        LMIC_SecureElement_JoinFormat_t joinFormat
);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_encodeMessage_t(const uint8_t *pMessage, uint8_t nMessage, uint8_t iPayload, uint8_t *pCipherTextBuffer, LMIC_SecureElement_KeySelector_t iKey);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_verifyMIC_t(
        const uint8_t *pPhyPayload,
        uint8_t nPhyPayload,
        uint32_t devAddr,
        uint32_t FCntDown,
        LMIC_SecureElement_KeySelector_t iKey
);

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_decodeMessage_t(
        const uint8_t *pPhyPayload, uint8_t nPhyPayload,
        uint32_t devAddr, uint32_t FCntDown,
        LMIC_SecureElement_KeySelector_t iKey,
        uint8_t *pClearTextBuffer
        );

typedef LMIC_SecureElement_Error_t LMIC_ABI_STD
LMIC_SecureElement_aes128Encrypt_t(const uint8_t *pKey, const uint8_t *pInput, uint8_t *pOutput);
 
/****************************************************************************\
|          The portable API functions.
\****************************************************************************/

#define LMIC_SecureElement_DECLARE_DRIVER_FNS(a_driver)                                                                          \
        LMIC_SecureElement_initialize_t LMIC_SecureElement_##a_driver##_initialize;                              \
        LMIC_SecureElement_getRandomU1_t LMIC_SecureElement_##a_driver##_getRandomU1;                      \
        LMIC_SecureElement_getRandomU2_t LMIC_SecureElement_##a_driver##_getRandomU2;                      \
        LMIC_SecureElement_fillRandomBuffer_t LMIC_SecureElement_##a_driver##_fillRandomBuffer;  \
        LMIC_SecureElement_setAppKey_t LMIC_SecureElement_##a_driver##_setAppKey;                                  \
        LMIC_SecureElement_getAppKey_t LMIC_SecureElement_##a_driver##_getAppKey;                                  \
        LMIC_SecureElement_setAppEUI_t LMIC_SecureElement_##a_driver##_setAppEUI;                                  \
        LMIC_SecureElement_getAppEUI_t LMIC_SecureElement_##a_driver##_getAppEUI;                                  \
        LMIC_SecureElement_setDevEUI_t LMIC_SecureElement_##a_driver##_setDevEUI;                                  \
        LMIC_SecureElement_getDevEUI_t LMIC_SecureElement_##a_driver##_getDevEUI;                                  \
        LMIC_SecureElement_setNwkSKey_t LMIC_SecureElement_##a_driver##_setNwkSKey;                              \
        LMIC_SecureElement_getNwkSKey_t LMIC_SecureElement_##a_driver##_getNwkSKey;                              \
        LMIC_SecureElement_setAppSKey_t LMIC_SecureElement_##a_driver##_setAppSKey;                              \
        LMIC_SecureElement_getAppSKey_t LMIC_SecureElement_##a_driver##_getAppSKey;                              \
        LMIC_SecureElement_createJoinRequest_t LMIC_SecureElement_##a_driver##_createJoinRequest;   \
        LMIC_SecureElement_decodeJoinAccept_t LMIC_SecureElement_##a_driver##_decodeJoinAccept;  \
        LMIC_SecureElement_encodeMessage_t LMIC_SecureElement_##a_driver##_encodeMessage;                  \
        LMIC_SecureElement_verifyMIC_t LMIC_SecureElement_##a_driver##_verifyMIC;                                  \
        LMIC_SecureElement_decodeMessage_t LMIC_SecureElement_##a_driver##_decodeMessage;                  \
        LMIC_SecureElement_aes128Encrypt_t LMIC_SecureElement_##a_driver##_aes128Encrypt
 
LMIC_END_DECLS
 
// end group lmic_se_driver
// end group lmic_se
 
#endif // _lmic_secure_element_interface_h_