Linux SDK (lite-qmi)  MBPL_SDK_R25_ENG3
qaGobiApiSms.h
Go to the documentation of this file.
1 
9 /*
10  * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
11  */
12 #ifndef __GOBI_API_SMS_H__
13 #define __GOBI_API_SMS_H__
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #define CONFIG_LEN 0x05
20 #define TIME_STAMP_BUF 0x08
21 #define ABSOLUTE_VALIDITY 0x08
22 #define TIME_DATE_BUF 0x09
23 #define MAX_SMS_ROUTES 0x0A
24 #define NUM_OF_SET 0xFF
25 #define SMS_ASCII_STRING_SIZE 400
26 #define MAXIMUM_SMS_MSG_LEN 160
27 #define SMS_ASCII_STRING_ARRAY_SIZE SMS_ASCII_STRING_SIZE + 1
28 #define SMS_MESSAGE_TIMESTEMP_SIZE 8
29 #define MAX_SMSC_LENGTH 24
30 
31 typedef struct
32 {
33  CHAR data[TIME_DATE_BUF];
35 
36 #define SMS_DEFAULT_TIME_ZONE 0
37 #define SMS_INVALID_TIME_STAMP_VALUE 0xff
38 typedef enum
39 {
40  eTIMESTEMP_START = -1,
41  eTIMESTEMP_YEAR = 0,
42  eTIMESTEMP_MONTH = 1,
43  eTIMESTEMP_DAY = 2,
44  eTIMESTEMP_HOUR = 3,
45  eTIMESTEMP_MINUTE = 4,
46  eTIMESTEMP_SECOND = 5,
47  eTIMESTEMP_TIMEZONE = 6,
48  eTIMESTEMP_END = 7
49 } sEnumTimeStampenum;
50 
51 typedef struct
52 {
53  BYTE data[SMS_MESSAGE_TIMESTEMP_SIZE];
55 
94 typedef struct
95 {
96  ULONG messageFormat;
97  ULONG messageSize;
98  BYTE *pMessage;
99  USHORT messageID;
100  ULONG messageFailureCode;
101  BYTE *pLinktimer;
102  BYTE *pSmsOnIms;
104 
124 {
125  WORD fromServiceId;
126  WORD toServiceId;
127  BYTE selected;
128 };
129 
155  BYTE activated_ind;
156  WORD num_instances;
157  struct BroadcastConfig broadcastConfig[CONFIG_LEN];
159 
178 {
179  WORD serviceCategory;
180  WORD language;
181  BYTE selected;
182 };
183 
209 {
210  BYTE activated_ind;
211  WORD num_instances;
212  struct CDMABroadcastConfig CDMABroadcastConfig[CONFIG_LEN];
214 
295 {
296  BYTE *pMessageSize;
297  BYTE *pMessage;
298  BYTE messageId;
299  CHAR *pDestAddr;
300  CHAR *pCallbackAddr;
301  ULONG textMsgLength;
302  WORD *pTextMsg;
303  BYTE *pPriority;
304  BYTE *pEncodingAlphabet;
305  BYTE *pRelValidity;
306 };
307 
444 {
445  ULONG messageLength;
446  BYTE *pMessage;
447  ULONG *pMessageID;
448  BYTE *pSenderAddrLength;
449  CHAR senderAddr[MAX_SMSC_LENGTH+1];
450  BYTE *pTextMsgLength;
451  USHORT textMsg[MAXIMUM_SMS_MSG_LEN + 2];
452  BYTE *pPriority;
453  BYTE *pPrivacy;
454  BYTE *pLanguage;
455  sms_timestemp mcTimeStamp;
456  sms_timestemp absoluteValidity;
457  BYTE *pRelativeValidity;
458  BYTE *pDisplayMode;
459  BOOL *pUserAcknowledgementReq;
460  BOOL *pReadAcknowledgementReq;
461  BYTE *pAlertPriority;
462  BYTE *pCallbkAddrLength;
463  CHAR *pCallbkAddr;
464 };
465 
614 {
615  ULONG messageLength;
616  BYTE *pMessage;
617  ULONG *pMessageID;
618  BYTE *pSenderAddrLength;
619  CHAR *pSenderAddr;
620  BYTE *pTextMsgLength;
621  WORD *pTextMsg;
622  BYTE *pPriority;
623  BYTE *pPrivacy;
624  BYTE *pLanguage;
625  sms_timestemp mcTimeStamp;
626  sms_timestemp absoluteValidity;
627  BYTE *pRelativeValidity;
628  BYTE *pDisplayMode;
629  BOOL *pUserAcknowledgementReq;
630  BOOL *pReadAcknowledgementReq;
631  BYTE *pAlertPriority;
632  BYTE *pCallbkAddrLength;
633  CHAR *pCallbkAddr;
634  USHORT *pReferenceNum;
635  BYTE *pTotalNum;
636  BYTE *pPartNum;
637  BOOL *pIsUDHPresent;
638 };
639 
666 {
667  ULONG messageSize;
668  CHAR *pDestAddr;
669  CHAR *pTextMsg;
670  CHAR PDUMessage[SMS_ASCII_STRING_SIZE];
671  BYTE alphabet;
672 };
673 
727 {
728  BYTE *pMessage;
729  USHORT MessageLen;
730  BYTE *pSenderAddrLength;
731  CHAR senderAddr[MAX_SMSC_LENGTH+1];
732  BYTE *pTextMsgLength;
733  CHAR textMsg[MAXIMUM_SMS_MSG_LEN+2];
734  BYTE *pScAddrLength;
735  CHAR scAddr[MAX_SMSC_LENGTH+1];
736  sms_DateTime time;
737  sms_DateTime date;
738 };
739 
808 {
809  BYTE *pMessage;
810  USHORT MessageLen;
811  BYTE *pSenderAddrLength;
812  CHAR *pSenderAddr;
813  BYTE *pTextMsgLength;
814  CHAR *pTextMsg;
815  BYTE *pScAddrLength;
816  CHAR *pScAddr;
817  sms_DateTime Time;
818  sms_DateTime Date;
819  BYTE *pReferenceNum;
820  BYTE *pTotalNum;
821  BYTE *pPartNum;
822  BOOL *pIsUDHPresent;
823 };
824 
840 typedef struct _transLayerinfo
841 {
842  BYTE TransType;
843  BYTE TransCap;
845 
868 {
869  BYTE *pRegInd;
870  transLayerInfo *pTransLayerInfo;
872 
894 {
895  BYTE *pRegStatus;
897 
934 typedef struct _getIndicationRegResp
935 {
936  BYTE *pRegTransLayerInfoEvt;
937  BYTE *pRegTransNWRegInfoEvt;
938  BYTE *pRegCallStatInfoEvt;
940 
977 typedef struct _setIndicationRegReq
978 {
979  BYTE *pRegTransLayerInfoEvt;
980  BYTE *pRegTransNWRegInfoEvt;
981  BYTE *pRegCallStatInfoEvt;
983 
1023 typedef struct
1024 {
1025  BYTE messageType;
1026  BYTE messageClass;
1027  BYTE routeStorage;
1028  BYTE receiptAction;
1029 } smsRouteEntry;
1030 
1045 typedef struct
1046 {
1047  WORD numOfRoutes;
1048  smsRouteEntry routeList[MAX_SMS_ROUTES];
1049  BYTE *pTransferStatusReport;
1050 } smsSetRoutesReq;
1051 
1063 typedef struct
1064 {
1065  BYTE msgProtocol;
1067 
1086 typedef struct
1087 {
1088  BYTE storageType;
1089  BYTE *pMessageMode;
1091 
1092 
1107 typedef struct
1108 {
1109  ULONG maxStorageSize;
1110  ULONG freeSlots;
1112 
1134 typedef struct
1135 {
1136  BYTE msgType;
1137  BYTE activeInd;
1138  BYTE msgCount;
1140 
1154 typedef struct
1155 {
1156  BYTE numInstances;
1157  messageWaitingInfoContent msgWaitInfo[NUM_OF_SET];
1159 
1230 typedef struct
1231 {
1232  ULONG messageFormat;
1233  ULONG messageSize;
1234  BYTE *pMessage;
1235  BYTE *pForceOnDC;
1236  BYTE *pServiceOption;
1237  BYTE *pFollowOnDC;
1238  BYTE *pLinktimer;
1239  BYTE *pSmsOnIms;
1240  BYTE *pRetryMessage;
1241  ULONG *pRetryMessageId;
1242  ULONG *pUserData;
1244 
1245 #ifdef __cplusplus
1246 } /* extern "C" { */
1247 #endif
1248 
1249 #endif /* __GOBI_API_SMS_H__ */
Definition: qaGobiApiSms.h:807
Definition: qaGobiApiSms.h:726
struct _getIndicationRegResp getIndicationRegResp
Definition: qaGobiApiSms.h:1134
Definition: qaGobiApiSms.h:51
Definition: qaGobiApiSms.h:1154
Definition: qaGobiApiSms.h:1230
struct _qaQmi3GPPBroadcastCfgInfo qaQmi3GPPBroadcastCfgInfo
Definition: qaGobiApiSms.h:294
Definition: qaGobiApiSms.h:1045
Definition: qaGobiApiSms.h:977
Definition: qaGobiApiSms.h:840
Definition: qaGobiApiSms.h:208
Definition: qaGobiApiSms.h:1086
Definition: qaGobiApiSms.h:94
Definition: qaGobiApiSms.h:665
Definition: qaGobiApiSms.h:154
Definition: qaGobiApiSms.h:893
struct _transLayerinfo transLayerInfo
Definition: qaGobiApiSms.h:1107
Definition: qaGobiApiSms.h:1023
struct _qaQmi3GPP2BroadcastCfgInfo qaQmi3GPP2BroadcastCfgInfo
Definition: qaGobiApiSms.h:443
struct _setIndicationRegReq setIndicationRegReq
Definition: qaGobiApiSms.h:177
Definition: qaGobiApiSms.h:31
struct _getTransLayerInfoResp getTransLayerInfoResp
Definition: qaGobiApiSms.h:613
Definition: qaGobiApiSms.h:867
Definition: qaGobiApiSms.h:123
Definition: qaGobiApiSms.h:934
struct _getTransNWRegInfoResp getTransNWRegInfoResp
Definition: qaGobiApiSms.h:1063