taf_simRsp_common.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */
#ifndef TAF_SIMRSP_COMMON_H_INCLUDE_GUARD
#define TAF_SIMRSP_COMMON_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_sim_common.h"

#define IFGEN_TAF_SIMRSP_PROTOCOL_ID "bd560854534a28c278ac3577550149c1"
#define IFGEN_TAF_SIMRSP_MSG_SIZE 2068



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_EID_LEN 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_EID_BYTES 33

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_MAX_PROFILE 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_NAME_LEN 64

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_NAME_BYTES 65

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_SPN_LEN 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_SMDP_LEN 1024

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_ICCID_LEN 20

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_ICCID_BYTES 21

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_NICKNAME_LEN 64

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_NICKNAME_BYTES 65

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_ACTIVATION_CODE_LEN 256

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_ACTIVATION_CODE_BYTES 257

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_CODE_LEN 256

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SIMRSP_CODE_BYTES 257

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_simRsp_ProfileListNode* taf_simRsp_ProfileListNodeRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_UNKNOWN = -1,
    TAF_SIMRSP_REGULAR = 0,
    TAF_SIMRSP_EMERGENCY = 1
}
taf_simRsp_ProfileType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_NONE = 0,
    TAF_SIMRSP_JPEG = 1,
    TAF_SIMRSP_PNG = 2
}
taf_simRsp_IconType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_TEST = 0,
    TAF_SIMRSP_PROVISIONING = 1,
    TAF_SIMRSP_OPERATIONAL = 2
}
taf_simRsp_ProfileClass_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_PROFILE_DISABLE_NOT_ALLOWED = 0,
    TAF_SIMRSP_PROFILE_DELETE_NOT_ALLOWED = 1,
    TAF_SIMRSP_PROFILE_DELETE_ON_DISABLE = 2
}
taf_simRsp_PolicyRuleType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_DOWNLOAD_ERROR = 0,
    TAF_SIMRSP_DOWNLOAD_INSTALLATION_COMPLETE = 1
}
taf_simRsp_DownloadStatus_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_GENERIC = 1,
    TAF_SIMRSP_SIM = 2,
    TAF_SIMRSP_NETWORK = 3,
    TAF_SIMRSP_MEMORY = 4,
    TAF_SIMRSP_UNSUPPORTED_PROFILE_CLASS = 5,
    TAF_SIMRSP_PPR_NOT_ALLOWED = 6,
    TAF_SIMRSP_END_USER_REJECTION = 7,
    TAF_SIMRSP_END_USER_POSTPONED = 8
}
taf_simRsp_DownloadErrorCause_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SIMRSP_USER_REJECTION = 0,
    TAF_SIMRSP_USER_POSTPONED = 1
}
taf_simRsp_UserConsentReasonType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_simRsp_ProfileDownloadHandler* taf_simRsp_ProfileDownloadHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_simRsp_ProfileUserConsentHandler* taf_simRsp_ProfileUserConsentHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_simRsp_ProfileConfirmationCodeHandler* taf_simRsp_ProfileConfirmationCodeHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_simRsp_ProfileDownloadHandlerFunc_t)
(
        taf_sim_Id_t slotId,
        taf_simRsp_DownloadStatus_t downloadStatus,
        taf_simRsp_DownloadErrorCause_t errorCause,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_simRsp_ProfileUserConsentHandlerFunc_t)
(
        taf_sim_Id_t slotId,
        bool userConsentRequired,
        uint8_t mask,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_simRsp_ProfileConfirmationCodeHandlerFunc_t)
(
        taf_sim_Id_t slotId,
        const char* LE_NONNULL profileName,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_simRsp_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_simRsp_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_simRsp_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileDownloadHandlerRef_t ifgen_taf_simRsp_AddProfileDownloadHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileDownloadHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_simRsp_RemoveProfileDownloadHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileDownloadHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileUserConsentHandlerRef_t ifgen_taf_simRsp_AddProfileUserConsentHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileUserConsentHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_simRsp_RemoveProfileUserConsentHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileUserConsentHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileConfirmationCodeHandlerRef_t ifgen_taf_simRsp_AddProfileConfirmationCodeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileConfirmationCodeHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_simRsp_RemoveProfileConfirmationCodeHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileConfirmationCodeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetEID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        char* eid,
        size_t eidSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_AddProfile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        const char* LE_NONNULL activationCode,
        const char* LE_NONNULL confirmationCode,
        bool userConsentSupported
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_DeleteProfile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        uint32_t profileId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_SetProfile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        uint32_t profileId,
        bool enable
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_UpdateNickName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        uint32_t profileId,
        const char* LE_NONNULL nickName
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetProfileList
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        taf_simRsp_ProfileListNodeRef_t* profileListPtr,
        size_t* profileListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_SetServerAddress
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        const char* LE_NONNULL smdpAdress
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetServerAddress
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        char* smdpAdress,
        size_t smdpAdressSize,
        char* smdsdress,
        size_t smdsdressSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_ProvideUserConsent
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        bool userConsent,
        taf_simRsp_UserConsentReasonType_t reason
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_ProvideConfirmationCode
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sim_Id_t slotId,
        const char* LE_NONNULL code
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileListNodeRef_t ifgen_taf_simRsp_GetProfile
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t index
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED uint32_t ifgen_taf_simRsp_GetProfileIndex
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileType_t ifgen_taf_simRsp_GetProfileType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetIccid
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef,
        char* iccid,
        size_t iccidSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_simRsp_GetProfileActiveStatus
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetNickName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef,
        char* nickName,
        size_t nickNameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef,
        char* name,
        size_t nameSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_simRsp_GetSpn
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef,
        char* spn,
        size_t spnSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_IconType_t ifgen_taf_simRsp_GetIconType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_simRsp_ProfileClass_t ifgen_taf_simRsp_GetProfileClass
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED uint32_t ifgen_taf_simRsp_GetMask
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_simRsp_ProfileListNodeRef_t profileRef
);

#endif // TAF_SIMRSP_COMMON_H_INCLUDE_GUARD