taf_sim_interface.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_SIM_INTERFACE_H_INCLUDE_GUARD
#define TAF_SIM_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Internal includes for this interface
#include "taf_sim_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_sim_DisconnectHandler_t)(void *);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_sim_SetServerDisconnectHandler
(
    taf_sim_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_sim_SetNonExitServerDisconnectHandler
(
    taf_sim_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_NewStateHandlerRef_t taf_sim_AddNewStateHandler
(
    taf_sim_NewStateHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_RemoveNewStateHandler
(
    taf_sim_NewStateHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_AuthenticationResponseHandlerRef_t taf_sim_AddAuthenticationResponseHandler
(
    taf_sim_AuthenticationResponseHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_RemoveAuthenticationResponseHandler
(
    taf_sim_AuthenticationResponseHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool taf_sim_IsPresent
(
    taf_sim_Id_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_States_t taf_sim_GetState
(
    taf_sim_Id_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool taf_sim_IsReady
(
    taf_sim_Id_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetICCID
(
    taf_sim_Id_t slotId,
    char* iccid,
    size_t iccidSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetIMSI
(
    taf_sim_Id_t slotId,
    char* imsi,
    size_t imsiSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetHomeNetworkOperator
(
    taf_sim_Id_t slotId,
    char* nameStr,
    size_t nameStrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetSubscriberPhoneNumber
(
    taf_sim_Id_t slotId,
    char* phoneNumberStr,
    size_t phoneNumberStrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetHomeNetworkMccMnc
(
    taf_sim_Id_t slotId,
    char* mccPtr,
    size_t mccPtrSize,
    char* mncPtr,
    size_t mncPtrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_Id_t taf_sim_GetSelectedCard
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SelectCard
(
    taf_sim_Id_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_EnterPIN
(
    taf_sim_Id_t slotId,
    taf_sim_LockType_t lockType,
    const char* LE_NONNULL pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_ChangePIN
(
    taf_sim_Id_t slotId,
    taf_sim_LockType_t lockType,
    const char* LE_NONNULL oldpin,
    const char* LE_NONNULL newpin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t taf_sim_GetRemainingPINTries
(
    taf_sim_Id_t slotId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetRemainingPUKTries
(
    taf_sim_Id_t slotId,
    uint32_t* remainingPukTriesPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_Unlock
(
    taf_sim_Id_t slotId,
    taf_sim_LockType_t lockType,
    const char* LE_NONNULL pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_Lock
(
    taf_sim_Id_t slotId,
    taf_sim_LockType_t lockType,
    const char* LE_NONNULL pin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_Unblock
(
    taf_sim_Id_t slotId,
    taf_sim_LockType_t lockType,
    const char* LE_NONNULL puk,
    const char* LE_NONNULL newpin
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetEID
(
    taf_sim_Id_t slotId,
    char* eid,
    size_t eidSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SetAutomaticSelection
(
    bool enable
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetAutomaticSelection
(
    bool* enablePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_OpenLogicalChannel
(
    taf_sim_Id_t slotId,
    taf_sim_AppType_t apptype,
    uint8_t* channelPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_CloseLogicalChannel
(
    taf_sim_Id_t slotId,
    uint8_t channel
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SendApduOnChannel
(
    taf_sim_Id_t simId,
    uint8_t channel,
    const uint8_t* commandApduPtr,
    size_t commandApduSize,
    uint8_t* responseApduPtr,
    size_t* responseApduSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SendApdu
(
    taf_sim_Id_t simId,
    const uint8_t* commandApduPtr,
    size_t commandApduSize,
    uint8_t* responseApduPtr,
    size_t* responseApduSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SendCommand
(
    taf_sim_Id_t simId,
    taf_sim_Command_t command,
    const char* LE_NONNULL fileIdentifier,
    uint8_t p1,
    uint8_t p2,
    uint8_t p3,
    const uint8_t* dataPtr,
    size_t dataSize,
    const char* LE_NONNULL path,
    uint8_t* sw1Ptr,
    uint8_t* sw2Ptr,
    uint8_t* responsePtr,
    size_t* responseSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_LocalSwapToEmergencyCallSubscription
(
    taf_sim_Id_t simId,
    taf_sim_Manufacturer_t manufacturer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_LocalSwapToCommercialSubscription
(
    taf_sim_Id_t simId,
    taf_sim_Manufacturer_t manufacturer
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_SetPower
(
    taf_sim_Id_t simId,
    le_onoff_t power
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_Reset
(
    taf_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_IsEmergencyCallSubscriptionSelected
(
    taf_sim_Id_t simId,
    bool* isEcsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_IccidChangeHandlerRef_t taf_sim_AddIccidChangeHandler
(
    taf_sim_IccidChangeHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_RemoveIccidChangeHandler
(
    taf_sim_IccidChangeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_FPLMNListRef_t taf_sim_CreateFPLMNList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_AddFPLMNOperator
(
    taf_sim_FPLMNListRef_t fplmnListRef,
    const char* LE_NONNULL mcc,
    const char* LE_NONNULL mnc
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetFirstFPLMNOperator
(
    taf_sim_FPLMNListRef_t fplmnListRef,
    char* mccPtr,
    size_t mccPtrSize,
    char* mncPtr,
    size_t mncPtrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetNextFPLMNOperator
(
    taf_sim_FPLMNListRef_t fplmnListRef,
    char* mccPtr,
    size_t mccPtrSize,
    char* mncPtr,
    size_t mncPtrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_sim_FPLMNListRef_t taf_sim_ReadFPLMNList
(
    taf_sim_Id_t simId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_sim_DeleteFPLMNList
(
    taf_sim_FPLMNListRef_t fplmnListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_WriteFPLMNList
(
    taf_sim_Id_t simId,
    taf_sim_FPLMNListRef_t fplmnListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_sim_GetSlotCount
(
    int32_t* countPtr
);

#endif // TAF_SIM_INTERFACE_H_INCLUDE_GUARD