components/modemServices/platformAdaptor/interfaces/inc/pa_sms.h

Go to the documentation of this file.

#ifndef LEGATO_PASMS_INCLUDE_GUARD
#define LEGATO_PASMS_INCLUDE_GUARD


#include "legato.h"
#include "le_mdm_defs.h"

//--------------------------------------------------------------------------------------------------
// Symbol and Enum definitions.
//--------------------------------------------------------------------------------------------------


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    PA_SMS_SMS_DELIVER       = 0, 
    PA_SMS_SMS_SUBMIT        = 1, 
    PA_SMS_SMS_STATUS_REPORT = 2, 
    PA_SMS_PDU               = 3  
}
pa_sms_MsgType_t;


//--------------------------------------------------------------------------------------------------
// APIs.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    le_sms_msg_Status_t status;                           
    char                oa[LE_SMS_TEL_NMBR_MAX_LEN];      
    char                scts[LE_SMS_TIMESTAMP_MAX_LEN];   
    le_sms_msg_Format_t format;                           
    uint8_t             data[LE_SMS_TEXT_MAX_LEN];        
    uint32_t            dataLen;                          
}
pa_sms_SmsDeliver_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    le_sms_msg_Status_t status;                           
    char                da[LE_SMS_TEL_NMBR_MAX_LEN];      
    uint8_t             data[LE_SMS_TEXT_MAX_LEN];        
    uint32_t            dataLen;                          
}
pa_sms_SmsSubmit_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    le_sms_msg_Status_t status;                           
    uint8_t             data[LE_SMS_PDU_MAX_LEN];         
    uint32_t            dataLen;                          
}
pa_sms_Pdu_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    pa_sms_MsgType_t  type;                       
    union {                                       
        pa_sms_SmsDeliver_t       smsDeliver;
        pa_sms_SmsSubmit_t        smsSubmit;
        pa_sms_Pdu_t              pdu;
    };
}
pa_sms_Message_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*pa_sms_NewMsgHdlrFunc_t)
(
    uint32_t* msgRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_SetNewMsgHandler
(
    pa_sms_NewMsgHdlrFunc_t msgHandler   

);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_ClearNewMsgHandler
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int32_t pa_sms_SendPduMsg
(
    uint32_t       length, 
    const uint8_t* dataPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_RdPDUMsgFromMem
(
    uint32_t        index,        
    pa_sms_Pdu_t*   msgPtr        
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_ListMsgFromMem
(
    le_sms_msg_Status_t    status, 
    uint32_t*              numPtr, 
    uint32_t*              idxPtr  

);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_DelMsgFromMem
(
    uint32_t  index   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_DelAllMsg
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_sms_ChangeMessageStatus
(
    uint32_t             index, 
    le_sms_msg_Status_t  status 
);

#endif // LEGATO_PASMS_INCLUDE_GUARD