le_sms_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 LE_SMS_INTERFACE_H_INCLUDE_GUARD
#define LE_SMS_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_TIMESTAMP_MAX_LEN 20


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_TIMESTAMP_MAX_BYTES 21


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_TEXT_MAX_LEN 160


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_TEXT_MAX_BYTES 161


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_BINARY_MAX_BYTES 140


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_PDU_MAX_PAYLOAD 140


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_SMS_PDU_MAX_BYTES 176


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SMS_FORMAT_PDU,

    LE_SMS_FORMAT_TEXT,

    LE_SMS_FORMAT_BINARY,

    LE_SMS_FORMAT_UNKNOWN
}
le_sms_Format_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SMS_RX_READ,

    LE_SMS_RX_UNREAD,

    LE_SMS_STORED_SENT,

    LE_SMS_STORED_UNSENT,

    LE_SMS_SENT,

    LE_SMS_SENDING,

    LE_SMS_UNSENT,

    LE_SMS_SENDING_FAILED,

    LE_SMS_STATUS_UNKNOWN
}
le_sms_Status_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SMS_ERROR_ADDR_VACANT,

    LE_SMS_ERROR_ADDR_TRANSLATION_FAILURE,

    LE_SMS_ERROR_NETWORK_RESOURCE_SHORTAGE,

    LE_SMS_ERROR_NETWORK_FAILURE,

    LE_SMS_ERROR_INVALID_TELESERVICE_ID,

    LE_SMS_ERROR_NETWORK_OTHER,

    LE_SMS_ERROR_NO_PAGE_RESPONSE,

    LE_SMS_ERROR_DEST_BUSY,

    LE_SMS_ERROR_NO_ACK,

    LE_SMS_ERROR_DEST_RESOURCE_SHORTAGE,

    LE_SMS_ERROR_SMS_DELIVERY_POSTPONED,

    LE_SMS_ERROR_DEST_OUT_OF_SERV,

    LE_SMS_ERROR_DEST_NOT_AT_ADDR,

    LE_SMS_ERROR_DEST_OTHER,

    LE_SMS_ERROR_RADIO_IF_RESOURCE_SHORTAGE,

    LE_SMS_ERROR_RADIO_IF_INCOMPATABILITY,

    LE_SMS_ERROR_RADIO_IF_OTHER,

    LE_SMS_ERROR_ENCODING,

    LE_SMS_ERROR_SMS_ORIG_DENIED,

    LE_SMS_ERROR_SMS_TERM_DENIED,

    LE_SMS_ERROR_SUPP_SERV_NOT_SUPP,

    LE_SMS_ERROR_SMS_NOT_SUPP,

    LE_SMS_ERROR_MISSING_EXPECTED_PARAM,

    LE_SMS_ERROR_MISSING_MAND_PARAM,

    LE_SMS_ERROR_UNRECOGNIZED_PARAM_VAL,

    LE_SMS_ERROR_UNEXPECTED_PARAM_VAL,

    LE_SMS_ERROR_USER_DATA_SIZE_ERR,

    LE_SMS_ERROR_GENERAL_OTHER,

    LE_SMS_ERROR_3GPP2_PLATFORM_SPECIFIC,

    LE_SMS_ERROR_3GPP2_MAX
}
le_sms_ErrorCode3GPP2_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_SMS_RP_ERROR_UNASSIGNED_NUMBER,

    LE_SMS_RP_ERROR_OPERATOR_DETERMINED_BARRING,

    LE_SMS_RP_ERROR_CALL_BARRED,

    LE_SMS_RP_ERROR_RESERVED,

    LE_SMS_RP_ERROR_SMS_TRANSFER_REJECTED,

    LE_SMS_RP_ERROR_MEMORY_CAP_EXCEEDED,

    LE_SMS_RP_ERROR_DESTINATION_OUT_OF_ORDER,

    LE_SMS_RP_ERROR_UNIDENTIFIED_SUBSCRIBER,

    LE_SMS_RP_ERROR_FACILITY_REJECTED,

    LE_SMS_RP_ERROR_UNKNOWN_SUBSCRIBER,

    LE_SMS_RP_ERROR_NETWORK_OUT_OF_ORDER,

    LE_SMS_RP_ERROR_TEMPORARY_FAILURE,

    LE_SMS_RP_ERROR_CONGESTION,

    LE_SMS_RP_ERROR_RESOURCES_UNAVAILABLE,

    LE_SMS_RP_ERROR_REQUESTED_FACILITY_NOT_SUBSCRIBED,

    LE_SMS_RP_ERROR_REQUESTED_FACILITY_NOT_IMPLEMENTED,

    LE_SMS_RP_ERROR_INVALID_SMS_TRANSFER_REFERENCE_VALUE,

    LE_SMS_RP_ERROR_SEMANTICALLY_INCORRECT_MESSAGE,

    LE_SMS_RP_ERROR_INVALID_MANDATORY_INFO,

    LE_SMS_RP_ERROR_MESSAGE_TYPE_NOT_IMPLEMENTED,

    LE_SMS_RP_ERROR_MESSAGE_NOT_COMPATABLE_WITH_SMS,

    LE_SMS_RP_ERROR_INFO_ELEMENT_NOT_IMPLEMENTED,

    LE_SMS_RP_ERROR_PROTOCOL_ERROR,

    LE_SMS_RP_ERROR_INTERWORKING,

    LE_SMS_TP_ERROR_TELE_INTERWORKING_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_SHORT_MESSAGE_TYPE_0_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_SHORT_MESSAGE_CANNOT_BE_REPLACED,

    LE_SMS_TP_ERROR_UNSPECIFIED_PID_ERROR,

    LE_SMS_TP_ERROR_DCS_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_MESSAGE_CLASS_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_UNSPECIFIED_DCS_ERROR,

    LE_SMS_TP_ERROR_COMMAND_CANNOT_BE_ACTIONED,

    LE_SMS_TP_ERROR_COMMAND_UNSUPPORTED,

    LE_SMS_TP_ERROR_UNSPECIFIED_COMMAND_ERROR,

    LE_SMS_TP_ERROR_TPDU_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_SC_BUSY,

    LE_SMS_TP_ERROR_NO_SC_SUBSCRIPTION,

    LE_SMS_TP_ERROR_SC_SYS_FAILURE,

    LE_SMS_TP_ERROR_INVALID_SME_ADDRESS,

    LE_SMS_TP_ERROR_DESTINATION_SME_BARRED,

    LE_SMS_TP_ERROR_SM_REJECTED_OR_DUPLICATE,

    LE_SMS_TP_ERROR_TP_VPF_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_TP_VP_NOT_SUPPORTED,

    LE_SMS_TP_ERROR_SIM_SMS_STORAGE_FULL,

    LE_SMS_TP_ERROR_NO_SMS_STORAGE_CAP_IN_SIM,

    LE_SMS_TP_ERROR_MS_ERROR,

    LE_SMS_TP_ERROR_MEMORY_CAP_EXCEEDED,

    LE_SMS_TP_ERROR_SIM_APP_TOOLKIT_BUSY,

    LE_SMS_TP_ERROR_SIM_DATA_DOWNLOAD_ERROR,

    LE_SMS_TP_ERROR_UNSPECIFIED_ERROR,

    LE_SMS_ERROR_3GPP_PLATFORM_SPECIFIC,

    LE_SMS_ERROR_3GPP_MAX
}
le_sms_ErrorCode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_Msg* le_sms_MsgRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_MsgList* le_sms_MsgListRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_sms_RxMessageHandler* le_sms_RxMessageHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_sms_CallbackResultFunc_t)
(
    le_sms_MsgRef_t msgRef,
    le_sms_Status_t status,
    void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_sms_RxMessageHandlerFunc_t)
(
    le_sms_MsgRef_t msgRef,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_RxMessageHandlerRef_t le_sms_AddRxMessageHandler
(
    le_sms_RxMessageHandlerFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_RemoveRxMessageHandler
(
    le_sms_RxMessageHandlerRef_t addHandlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgRef_t le_sms_Create
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_SetDestination
(
    le_sms_MsgRef_t msgRef,

    const char* dest
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_SetText
(
    le_sms_MsgRef_t msgRef,

    const char* text
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_SetBinary
(
    le_sms_MsgRef_t msgRef,

    const uint8_t* binPtr,

    size_t binNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_SetPDU
(
    le_sms_MsgRef_t msgRef,

    const uint8_t* pduPtr,

    size_t pduNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_Send
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_ErrorCode3GPP2_t le_sms_Get3GPP2ErrorCode
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_GetErrorCode
(
    le_sms_MsgRef_t msgRef,

    le_sms_ErrorCode_t* rpCausePtr,

    le_sms_ErrorCode_t* tpCausePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t le_sms_GetPlatformSpecificErrorCode
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgRef_t le_sms_SendText
(
    const char* destStr,

    const char* textStr,

    le_sms_CallbackResultFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgRef_t le_sms_SendPdu
(
    const uint8_t* pduPtr,

    size_t pduNumElements,

    le_sms_CallbackResultFunc_t handlerPtr,

    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_Delete
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_Format_t le_sms_GetFormat
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetSenderTel
(
    le_sms_MsgRef_t msgRef,

    char* tel,

    size_t telNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetTimeStamp
(
    le_sms_MsgRef_t msgRef,

    char* timestamp,

    size_t timestampNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_sms_GetUserdataLen
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetText
(
    le_sms_MsgRef_t msgRef,

    char* text,

    size_t textNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetBinary
(
    le_sms_MsgRef_t msgRef,

    uint8_t* binPtr,

    size_t* binNumElementsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetPDU
(
    le_sms_MsgRef_t msgRef,

    uint8_t* pduPtr,

    size_t* pduNumElementsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_sms_GetPDULen
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_DeleteFromStorage
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgListRef_t le_sms_CreateRxMsgList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_DeleteList
(
    le_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgRef_t le_sms_GetFirst
(
    le_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_MsgRef_t le_sms_GetNext
(
    le_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_sms_Status_t le_sms_GetStatus
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_MarkRead
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_sms_MarkUnread
(
    le_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_GetSmsCenterAddress
(
    char* tel,

    size_t telNumElements
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_sms_SetSmsCenterAddress
(
    const char* tel
);


#endif // LE_SMS_INTERFACE_H_INCLUDE_GUARD