taf_sms_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_SMS_COMMON_H_INCLUDE_GUARD
#define TAF_SMS_COMMON_H_INCLUDE_GUARD


#include "legato.h"

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

#define IFGEN_TAF_SMS_PROTOCOL_ID "309f1ede5d1a6d7e47a5f3a2e7b5af98"
#define IFGEN_TAF_SMS_MSG_SIZE 193



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_SMSC_ADDR_BYTES 28

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_TIMESTAMP_LEN 20

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_TIMESTAMP_BYTES 21

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_TEXT_LEN 160

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_TEXT_BYTES 161

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_BINARY_BYTES 140

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_UCS2_BYTES 140

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_UCS2_CHARS 70

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_PDU_PAYLOAD 140

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_SMS_PDU_BYTES 176

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_STORAGE_NONE = 0,
    TAF_SMS_STORAGE_NV = 1,
    TAF_SMS_STORAGE_SIM = 2,
    TAF_SMS_STORAGE_HLOS = 3,
    TAF_SMS_STORAGE_UNKNOWN = 4
}
taf_sms_Storage_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_FULL_UNKNOWN = 0,
    TAF_SMS_FULL_HLOS_ALERT = 1,
    TAF_SMS_FULL_HLOS = 2,
    TAF_SMS_FULL_HLOS_STORE_TO_SIM = 3,
    TAF_SMS_FULL_BOTH_HLOS_AND_SIM = 4,
    TAF_SMS_FULL_NV = 5,
    TAF_SMS_FULL_SIM = 6,
    TAF_SMS_FULL_SIM2 = 7
}
taf_sms_StorageFullType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_TYPE_TX = 0,
    TAF_SMS_TYPE_RX = 1,
    TAF_SMS_TYPE_UNKNOWN = 2
}
taf_sms_Type_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_RXSTS_READ = 0,
    TAF_SMS_RXSTS_UNREAD = 1,
    TAF_SMS_RXSTS_UNKNOWN = 2
}
taf_sms_ReadStatus_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_TXSTS_UNSENT = 0,
    TAF_SMS_TXSTS_SENDING = 1,
    TAF_SMS_TXSTS_SENT = 2,
    TAF_SMS_TXSTS_SENDING_FAILED = 3,
    TAF_SMS_TXSTS_SENDING_TIMEOUT = 4,
    TAF_SMS_TXSTS_UNKNOWN = 5
}
taf_sms_SendStatus_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_LKSTS_LOCKED = 0,
    TAF_SMS_LKSTS_UNLOCKED = 1,
    TAF_SMS_LKSTS_UNKNOWN = 2
}
taf_sms_LockStatus_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_SMS_FORMAT_TEXT = 0,
    TAF_SMS_FORMAT_BINARY = 1,
    TAF_SMS_FORMAT_UCS2 = 2,
    TAF_SMS_FORMAT_PDU = 3,
    TAF_SMS_FORMAT_UNKNOWN = 4
}
taf_sms_Format_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_sms_Msg* taf_sms_MsgRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_sms_MsgList* taf_sms_MsgListRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_sms_RxMsgHandler* taf_sms_RxMsgHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_sms_FullStorageEventHandler* taf_sms_FullStorageEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_sms_CallbackResultFunc_t)
(
        taf_sms_MsgRef_t msgRef,
        taf_sms_SendStatus_t status,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_sms_RxMsgHandlerFunc_t)
(
        taf_sms_MsgRef_t msgRef,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_sms_FullStorageHandlerFunc_t)
(
        taf_sms_StorageFullType_t fullType,
        void* contextPtr
);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_InitCommonData
(
    void
);


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


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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_MsgListRef_t ifgen_taf_sms_CreateRxMsgList
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_DeleteList
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_RxMsgHandlerRef_t ifgen_taf_sms_AddRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_RxMsgHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_RemoveRxMsgHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_RxMsgHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_FullStorageEventHandlerRef_t ifgen_taf_sms_AddFullStorageEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_FullStorageHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_RemoveFullStorageEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_FullStorageEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetFirst
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_GetNext
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgListRef_t msgListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_SendStatus_t ifgen_taf_sms_GetSendStatus
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_ReadStatus_t ifgen_taf_sms_GetReadStatus
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_LockStatus_t ifgen_taf_sms_GetLockStatus
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_MsgRef_t ifgen_taf_sms_Create
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetDestination
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        const char* LE_NONNULL dest
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetText
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        const char* LE_NONNULL text
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetBinary
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        const uint8_t* binPtr,
        size_t binSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetUCS2
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        const uint16_t* ucs2Ptr,
        size_t ucs2Size
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetPDU
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        const uint8_t* pduPtr,
        size_t pduSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetCallback
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        taf_sms_CallbackResultFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetPhoneId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        uint8_t phoneId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_Delete
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetPhoneId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        uint8_t* phoneIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetSenderTel
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        char* tel,
        size_t telSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetText
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        char* text,
        size_t textSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetBinary
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        uint8_t* binPtr,
        size_t* binSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetUCS2
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        uint16_t* ucs2Ptr,
        size_t* ucs2SizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetPDU
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef,
        uint8_t* pduPtr,
        size_t* pduSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED size_t ifgen_taf_sms_GetPDULen
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_Type_t ifgen_taf_sms_GetType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_sms_Format_t ifgen_taf_sms_GetFormat
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED size_t ifgen_taf_sms_GetUserdataLen
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_Send
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_DeleteFromStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_DeleteAllFromStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_Storage_t storage
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_MarkRead
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_sms_MarkUnread
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_LockFromStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_UnlockFromStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_EncryptFromStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_MsgRef_t msgRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetSmsCenterAddress
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId,
        char* addr,
        size_t addrSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetSmsCenterAddress
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId,
        const char* LE_NONNULL addr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SetPreferredStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_Storage_t prefStorage
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_GetPreferredStorage
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_sms_Storage_t* prefStoragePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsg
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const uint8_t* dataPtrPtr,
        size_t dataPtrSize,
        uint32_t timeout
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_SendPduMsgEx
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId,
        const uint8_t* dataPtrPtr,
        size_t dataPtrSize,
        uint32_t timeout
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_ActivateCellBroadcast
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_DeactivateCellBroadcast
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_AddCellBroadcastIds
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId,
        uint16_t fromId,
        uint16_t toId
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_sms_RemoveCellBroadcastIds
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint8_t phoneId,
        uint16_t fromId,
        uint16_t toId
);

#endif // TAF_SMS_COMMON_H_INCLUDE_GUARD