qaGobiApiSms.h

Go to the documentation of this file.

/*
 *  Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_SMS_H__
#define __GOBI_API_SMS_H__

#ifdef __cplusplus
extern "C" {
#endif

#define CONFIG_LEN         0x05
#define TIME_STAMP_BUF     0x08
#define ABSOLUTE_VALIDITY  0x08
#define TIME_DATE_BUF      0x09
#define MAX_SMS_ROUTES     0x0A
#define NUM_OF_SET         0xFF
#define SMS_ASCII_STRING_SIZE 400
#define MAXIMUM_SMS_MSG_LEN  160
#define SMS_ASCII_STRING_ARRAY_SIZE SMS_ASCII_STRING_SIZE + 1
#define SMS_MESSAGE_TIMESTEMP_SIZE 8
#define MAX_SMSC_LENGTH 24

typedef struct
{
    CHAR  data[TIME_DATE_BUF];
}sms_DateTime;

#define SMS_DEFAULT_TIME_ZONE 0
#define SMS_INVALID_TIME_STAMP_VALUE 0xff
typedef enum 
{
  eTIMESTEMP_START = -1,
  eTIMESTEMP_YEAR = 0,
  eTIMESTEMP_MONTH = 1,
  eTIMESTEMP_DAY = 2,
  eTIMESTEMP_HOUR = 3,
  eTIMESTEMP_MINUTE = 4,
  eTIMESTEMP_SECOND = 5,
  eTIMESTEMP_TIMEZONE = 6,
  eTIMESTEMP_END = 7
} sEnumTimeStampenum;

typedef struct
{
    BYTE data[SMS_MESSAGE_TIMESTEMP_SIZE];
}sms_timestemp;

ULONG SLQSDeleteSMS(
    ULONG storageType,
    ULONG *pMessageIndex,
    ULONG *pMessageTag,
    BYTE  *pMessageMode );

ULONG SLQSGetSMS(
    ULONG storageType,
    ULONG messageIndex,
    ULONG *pMessageTag,
    ULONG *pMessageFormat,
    ULONG *pMessageSize,
    BYTE  *pMessage,
    BYTE  *pMessageMode );

ULONG SendSMS(
    ULONG messageFormat,
    ULONG messageSize,
    BYTE  *pMessage,
    ULONG *pMessageFailureCode,
    BYTE  *pSmsOnIms);

typedef struct
{
    ULONG  messageFormat;
    ULONG  messageSize;
    BYTE   *pMessage;
    USHORT messageID;
    ULONG  messageFailureCode;
    BYTE   *pLinktimer;
    BYTE   *pSmsOnIms;
}slqssendsmsparams_s;

ULONG SLQSSendSMS( slqssendsmsparams_s *pSendSmsParams );

ULONG GetSMSCAddress(
    BYTE addressSize,
    CHAR *pSMSCAddress,
    BYTE typeSize,
    CHAR *pSMSCType );

ULONG SetSMSCAddress(
    CHAR *pSMSCAddress,
    CHAR *pSMSCType );

ULONG SaveSMS(
    ULONG storageType,
    ULONG messageFormat,
    ULONG messageSize,
    BYTE  *pMessage,
    ULONG *pMessageIndex );

ULONG SLQSGetSMSList(
    ULONG storageType,
    ULONG *pRequestedTag,
    ULONG *pMessageListSize,
    BYTE  *pMessageList,
    BYTE  *pMessageMode );

ULONG SLQSModifySMSStatus(
    ULONG storageType,
    ULONG messageIndex,
    ULONG messageTag,
    BYTE  *pMessageMode );

struct BroadcastConfig
{
    WORD fromServiceId;
    WORD toServiceId;
    BYTE selected;
};

typedef struct _qaQmi3GPPBroadcastCfgInfo {
    BYTE                   activated_ind;
    WORD                   num_instances;
    struct BroadcastConfig broadcastConfig[CONFIG_LEN];
} qaQmi3GPPBroadcastCfgInfo;

struct CDMABroadcastConfig
{
    WORD serviceCategory;
    WORD language;
    BYTE selected;
};

typedef struct _qaQmi3GPP2BroadcastCfgInfo
{
    BYTE                       activated_ind;
    WORD                       num_instances;
    struct CDMABroadcastConfig CDMABroadcastConfig[CONFIG_LEN];
} qaQmi3GPP2BroadcastCfgInfo;

ULONG SLQSGetSmsBroadcastConfig(
    BYTE mode,
    qaQmi3GPPBroadcastCfgInfo  *pBroadcastConfig,
    qaQmi3GPP2BroadcastCfgInfo *pCDMABroadcastConfig );

ULONG SLQSSetSmsBroadcastConfig(
    BYTE                       mode,
    qaQmi3GPPBroadcastCfgInfo  *pBroadcastConfig,
    qaQmi3GPP2BroadcastCfgInfo *pCDMABroadcastConfig );

ULONG SLQSSetSmsBroadcastActivation(
    BYTE mode,
    BYTE broadcastActivate );

struct cdmaMsgEncodingParams
{
    BYTE    *pMessageSize;
    BYTE    *pMessage;
    BYTE     messageId;
    CHAR    *pDestAddr;
    CHAR    *pCallbackAddr;
    ULONG    textMsgLength;
    WORD    *pTextMsg;
    BYTE    *pPriority;
    BYTE    *pEncodingAlphabet;
    BYTE    *pRelValidity;
};

ULONG SLQSCDMAEncodeMOTextMsg(
    struct cdmaMsgEncodingParams *pCdmaMsgEncodingParams );
struct cdmaMsgDecodingParams
{
    ULONG  messageLength;
    BYTE  *pMessage;
    ULONG *pMessageID;
    BYTE  *pSenderAddrLength;
    CHAR  senderAddr[MAX_SMSC_LENGTH+1];
    BYTE  *pTextMsgLength;
    USHORT  textMsg[MAXIMUM_SMS_MSG_LEN + 2];
    BYTE  *pPriority;
    BYTE  *pPrivacy;
    BYTE  *pLanguage;
    sms_timestemp mcTimeStamp;
    sms_timestemp absoluteValidity;
    BYTE  *pRelativeValidity;
    BYTE  *pDisplayMode;
    BOOL  *pUserAcknowledgementReq;
    BOOL  *pReadAcknowledgementReq;
    BYTE  *pAlertPriority;
    BYTE  *pCallbkAddrLength;
    CHAR  *pCallbkAddr;
};

 ULONG SLQSCDMADecodeMTTextMsg(
     struct cdmaMsgDecodingParams *pCdmaMsgDecodingParams );

struct cdmaMsgDecodingParamsExt
{
    ULONG  messageLength;
    BYTE  *pMessage;
    ULONG *pMessageID;
    BYTE  *pSenderAddrLength;
    CHAR  *pSenderAddr;
    BYTE  *pTextMsgLength;
    WORD  *pTextMsg;
    BYTE  *pPriority;
    BYTE  *pPrivacy;
    BYTE  *pLanguage;
    sms_timestemp mcTimeStamp;
    sms_timestemp absoluteValidity;
    BYTE  *pRelativeValidity;
    BYTE  *pDisplayMode;
    BOOL  *pUserAcknowledgementReq;
    BOOL  *pReadAcknowledgementReq;
    BYTE  *pAlertPriority;
    BYTE  *pCallbkAddrLength;
    CHAR  *pCallbkAddr;
    USHORT  *pReferenceNum;
    BYTE  *pTotalNum;
    BYTE  *pPartNum;
    BOOL  *pIsUDHPresent;
};

ULONG SLQSCDMADecodeMTTextMsgExt(
    struct cdmaMsgDecodingParamsExt *pCdmaMsgDecodingParamsExt );

struct wcdmaMsgEncodingParams
{
    ULONG messageSize;
    CHAR  *pDestAddr;
    CHAR  *pTextMsg;
    CHAR  PDUMessage[SMS_ASCII_STRING_SIZE];
    BYTE  alphabet;
};

ULONG SLQSWCDMAEncodeMOTextMsg(
    struct wcdmaMsgEncodingParams *pWcdmaMsgEncodingParams);

struct wcdmaMsgDecodingParams
{
    BYTE   *pMessage;
    USHORT  MessageLen;
    BYTE   *pSenderAddrLength;
    CHAR   senderAddr[MAX_SMSC_LENGTH+1];
    BYTE   *pTextMsgLength;
    CHAR   textMsg[MAXIMUM_SMS_MSG_LEN+2];
    BYTE   *pScAddrLength;
    CHAR   scAddr[MAX_SMSC_LENGTH+1];
    sms_DateTime   time;
    sms_DateTime   date;
};

ULONG SLQSWCDMADecodeMTTextMsg(
    struct wcdmaMsgDecodingParams *pWcdmaMsgDecodingParams);

struct wcdmaLongMsgDecodingParams
{
    BYTE  *pMessage;
    USHORT MessageLen;
    BYTE  *pSenderAddrLength;
    CHAR  *pSenderAddr;
    BYTE  *pTextMsgLength;
    CHAR  *pTextMsg;
    BYTE  *pScAddrLength;
    CHAR  *pScAddr;
    sms_DateTime  Time;
    sms_DateTime  Date;
    BYTE  *pReferenceNum;
    BYTE  *pTotalNum;
    BYTE  *pPartNum;
    BOOL  *pIsUDHPresent;
};

ULONG SLQSWCDMADecodeLongTextMsg(
    struct wcdmaLongMsgDecodingParams *pWcdmaLongMsgDecodingParams);

typedef struct _transLayerinfo
{
    BYTE TransType;
    BYTE TransCap;
} transLayerInfo;

typedef struct _getTransLayerInfoResp
{
    BYTE           *pRegInd;
    transLayerInfo *pTransLayerInfo;
} getTransLayerInfoResp;

ULONG SLQSGetTransLayerInfo (
    getTransLayerInfoResp  *pGetTransLayerInfoResp );

typedef struct _getTransNWRegInfoResp
{
    BYTE *pRegStatus;
 } getTransNWRegInfoResp;

ULONG SLQSGetTransNWRegInfo (
    getTransNWRegInfoResp *pGetTransNWRegInfoResp );

typedef struct _getIndicationRegResp
{
    BYTE *pRegTransLayerInfoEvt;
    BYTE *pRegTransNWRegInfoEvt;
    BYTE *pRegCallStatInfoEvt;
 } getIndicationRegResp;

ULONG SLQSGetIndicationRegister (
    getIndicationRegResp *pGetIndicationRegInfo );

typedef struct _setIndicationRegReq
{
    BYTE *pRegTransLayerInfoEvt;
    BYTE *pRegTransNWRegInfoEvt;
    BYTE *pRegCallStatInfoEvt;
 } setIndicationRegReq;

ULONG SLQSSetIndicationRegister (
    setIndicationRegReq *pSetIndicationRegReq );

typedef struct
{
    BYTE messageType;
    BYTE messageClass;
    BYTE routeStorage;
    BYTE receiptAction;
} smsRouteEntry;

typedef struct
{
    WORD          numOfRoutes;
    smsRouteEntry routeList[MAX_SMS_ROUTES];
    BYTE          *pTransferStatusReport;
} smsSetRoutesReq;

ULONG SLQSSmsSetRoutes (smsSetRoutesReq *pSetRoutesReq);

typedef struct
{
    BYTE msgProtocol;
} smsMsgprotocolResp;

ULONG SLQSSmsGetMessageProtocol ( smsMsgprotocolResp *pMessageProtocol );

typedef struct
{
    BYTE storageType;
    BYTE *pMessageMode;
} smsMaxStorageSizeReq;


typedef struct
{
    ULONG maxStorageSize;
    ULONG freeSlots;
} smsMaxStorageSizeResp;

ULONG SLQSSmsGetMaxStorageSize(
    smsMaxStorageSizeReq *pMaxStorageSizeReq,
    smsMaxStorageSizeResp *pMaxStorageSizeResp );

typedef struct
{
    BYTE msgType;
    BYTE activeInd;
    BYTE msgCount;
} messageWaitingInfoContent;

typedef struct
{
    BYTE                      numInstances;
    messageWaitingInfoContent msgWaitInfo[NUM_OF_SET];
} getMsgWaitingInfo;

ULONG SLQSGetMessageWaiting (
    getMsgWaitingInfo  *pGetMsgWaitingInfoResp );

typedef struct
{
    ULONG messageFormat;
    ULONG messageSize;
    BYTE  *pMessage;
    BYTE  *pForceOnDC;
    BYTE  *pServiceOption;
    BYTE  *pFollowOnDC;
    BYTE  *pLinktimer;
    BYTE  *pSmsOnIms;
    BYTE  *pRetryMessage;
    ULONG *pRetryMessageId;
    ULONG *pUserData;
}slqssendasyncsmsparams_s;

ULONG SLQSSendAsyncSMS( slqssendasyncsmsparams_s *pSendSmsParams );

ULONG SLQSSetSmsStorage( BYTE smsStorage );

ULONG SLQSSwiGetSMSStorage( ULONG *pSmsStorage );

ULONG SLQSSendLongSMS(
    ULONG messageFormat,
    ULONG messageSize,
    CHAR  *pMessage,
    BYTE  encodingScheme,
    ULONG *pMessageFailureCode,
    CHAR  *pMobileNum ,
    BYTE  *pSmsOnIMS);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_SMS_H__ */