| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

SwiWwanCmApi.h
1 /*===========================================================================
2 FILE:
3 SwiWwanCmApi.h
4
5 DESCRIPTION:
6 Sierra Wireless WAN Connection Manager API for Gobi
7
8 Copyright (C) 2011 Sierra Wireless Incorporated. All rights reserved.
9 Sierra Wireless Proprietary/GTDR
10
11 /*=========================================================================*/
12 // Definitions
13 /*=========================================================================*/
14
15 #ifndef __SWIWWANCMAPI_H__
16 #define __SWIWWANCMAPI_H__
17
18 #ifdef GOBIAPI_EXPORTS
19 #define SWIIMPORT extern "C" __declspec( dllexport )
20 #else //GOBIAPI_EXPORTS
21 #ifdef __cplusplus
22 /* C++ callable DLL */
23 #define SWIIMPORT extern "C" __declspec( dllimport )
24 #else
25 /* C callable DLL */
26 #define SWIIMPORT __declspec( dllimport )
27 #endif
28 #endif //GOBIAPI_EXPORTS
29
30 // Calling convention for API
31 #define SWICALLBACK __stdcall
32 #define SWICMAPI __stdcall
33
38
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
58
59 // RX/TX Packet counts callback function
60 typedef void (SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX);
61
62 // New NMEA sentence callback function
63 typedef void (SWICALLBACK * tFNNewNMEA)(LPCSTR pNMEA);
64
65 // New NMEA sentence plus mode callback function
66 typedef void (SWICALLBACK * tFNNewNMEAPlus)(LPCSTR pNMEA, ULONG mode);
67
68 // Signal strength information callback function
69 typedef void (SWICALLBACK * tFNSwiSignalStrengthInfo)(
70 INT8 nCdmaRssi,
71 ULONG nCdmaEcio,
72 INT8 nHdrRssi,
73 ULONG nHdrEcio,
74 ULONG nHdrSinr,
75 ULONG nHdrIo,
76 INT8 nGsmRssi,
77 INT8 nWcdmaRssi,
78 ULONG nWcdmaEcio,
79 INT8 nLteRssi,
80 INT8 nLteRsrq,
81 INT16 nLteRsrp,
82 UINT8 nLteSnr
83 );
84
105 typedef void (SWICALLBACK * tFNEcio)(INT8 nEcio, ULONG nRadioIf);
106
127 typedef void (SWICALLBACK * tFNSnir)(ULONG nSnir);
128
157 typedef void (SWICALLBACK * tFNErrorRate)(ULONG nErrorRate, ULONG nRadioIf);
158
174 typedef void (SWICALLBACK * tFNRsrq)(INT8 nRsrq, ULONG nRadioIf);
175
186 typedef void (SWICALLBACK * tFNSwiDeviceRemoval)(ULONG nStatus);
187
206 SWIIMPORT ULONG SWICMAPI SwiSetDeviceRemovalCallback(tFNSwiDeviceRemoval pCallback);
207
229 SWIIMPORT ULONG SWICMAPI SwiSetEcioCallback(tFNEcio pCallback, BYTE nThreshold);
230
252 SWIIMPORT ULONG SWICMAPI SwiSetSnirCallback(tFNSnir pCallback, BYTE nThreshold);
253
266 SWIIMPORT ULONG SWICMAPI SwiSetErrorRateCallback(tFNErrorRate pCallback);
267
289 SWIIMPORT ULONG SWICMAPI SwiSetRsrqCallback(tFNRsrq pCallback, BYTE nThreshold);
290
302 SWIIMPORT ULONG SWICMAPI SwiGoDormant(void);
303
324 SWIIMPORT ULONG SWICMAPI GetRoutes(
325 ULONG* pRouteInstances,
326 BYTE* pRouteList );
327
350 SWIIMPORT ULONG SWICMAPI SetRoutes(
351 ULONG nRouteInstances,
352 BYTE* pRouteList );
353
354
378 SWIIMPORT ULONG SWICMAPI GetIPConfiguration(
379 ULONG * pIPAddress,
380 ULONG * pGatewayAddress,
381 ULONG * pSubnetMask,
382 ULONG * pPrimaryDnsAddress,
383 ULONG * pSecondaryDnsAddress );
384
503 SWIIMPORT ULONG SWICMAPI WCDMADecodeMOTextMsg(
504 BYTE* pMessage,
505 BYTE* pDestAddrLength,
506 CHAR* pDestAdd,
507 BYTE* pTextMsgLength,
508 WCHAR* pTextMsg,
509 BYTE* pScAddrLength,
510 CHAR* pScAddr,
511 BOOLEAN* pRejectDuplicates,
512 BOOLEAN* pStatusReportReq,
513 BOOLEAN* pReplyPath,
514 BYTE* pValidityFormat,
515 BYTE validityPeriod[7],
516 BOOLEAN* pConcatenatedMsg,
517 ULONG* pMsgRefNum,
518 BYTE* pTotalSegments,
519 BYTE* pSegmentNum);
520
617 SWIIMPORT ULONG SWICMAPI WCDMADecodeMTTextMsg(
618 BYTE* pMessage,
619 BYTE* pSenderAddrLength,
620 CHAR* pSenderAddr,
621 BYTE* pTextMsgLength,
622 WCHAR* pTextMsg,
623 BYTE* pScAddrLength,
624 CHAR* pScAddr,
625 BOOLEAN* pMoreMsgSend,
626 BOOLEAN* pReplyPath,
627 BOOLEAN* pStatusReportInd,
628 BYTE scTimeStamp[7],
629 BOOLEAN* pConcatenatedMsg,
630 ULONG* pMsgRefNum,
631 BYTE* pTotalSegments,
632 BYTE* pSegmentNum);
633
771 SWIIMPORT ULONG SWICMAPI CDMADecodeMTTextMsg(
772 ULONG messageLength,
773 BYTE* pMessage,
774 ULONG* pMessageID,
775 BYTE* pSenderAddrLength,
776 CHAR* pSenderAddr,
777 BYTE* pTextMsgLength,
778 WCHAR* pTextMsg,
779 BYTE* pPriority,
780 BYTE* pPrivacy,
781 BYTE* pLanguage,
782 BYTE mcTimeStamp[7],
783 BYTE absoluteValidity[7],
784 BYTE* pRelativeValidity,
785 BYTE* pDisplayMode,
786 BOOL* pUserAcknowledgementReq,
787 BOOL* pReadAcknowledgementReq,
788 BYTE* pAlertPriority,
789 BYTE* pCallbkAddrLength = NULL,
790 CHAR* pCallbkAddr = NULL
791 );
792
920 SWIIMPORT ULONG SWICMAPI WCDMAEncodeMOTextMsg(
921 BYTE* pMessageListSize,
922 BYTE* pMessageList,
923 BYTE messageRefNum,
924 CHAR* pDestAddr,
925 ULONG textMsgLength,
926 WCHAR* pTextMsg,
927 CHAR* pScAddr,
928 BOOLEAN* pRejectDuplicates,
929 BOOLEAN* pStatusReportReq,
930 BOOLEAN* pReplyPath,
931 BYTE* pValidityFormat,
932 BYTE validityPeriod[7],
933 BYTE* pEncodingAlphabet);
934
1024 SWIIMPORT ULONG SWICMAPI CDMAEncodeMOTextMsg(
1025 BYTE* pMessageSize,
1026 BYTE* pMessage,
1027 BYTE messageId,
1028 CHAR* pDestAddr,
1029 CHAR* pCallbackAddr,
1030 ULONG textMsgLength,
1031 WCHAR* pTextMsg,
1032 BYTE* pPriority,
1033 BYTE* pEncodingAlphabet,
1034 BYTE* pRelValidity = NULL);
1035
1064 SWIIMPORT ULONG SWICMAPI LTEDeleteSMS(
1065 ULONG storageType,
1066 ULONG * pMessageIndex,
1067 ULONG * pMessageTag,
1068 ULONG * pMessageMode );
1069
1100 SWIIMPORT ULONG SWICMAPI LTEGetSMSList(
1101 ULONG storageType,
1102 ULONG * pRequestedTag,
1103 ULONG * pMessageListSize,
1104 BYTE * pMessageList,
1105 ULONG * pMessageMode );
1106
1142 SWIIMPORT ULONG SWICMAPI LTEGetSMS(
1143 ULONG storageType,
1144 ULONG messageIndex,
1145 ULONG * pMessageTag,
1146 ULONG * pMessageFormat,
1147 ULONG * pMessageSize,
1148 BYTE * pMessage,
1149 ULONG * pMessageMode );
1150
1179 SWIIMPORT ULONG SWICMAPI LTEModifySMSStatus(
1180 ULONG storageType,
1181 ULONG messageIndex,
1182 ULONG messageTag,
1183 ULONG* pMessageMode );
1184
1188 // Build ID and Version ID)for the image specified by the given fully qualified
1189 // path. Then the Image ID and Build ID can be used for SetImagePreferen
1190 // function to upgrade firmware to the flash.
1199 // cqcn.mbn for Gobi3k,
1219 SWIIMPORT ULONG SWICMAPI GetImageInfo3KW(
1220 WCHAR* pDeviceID,
1221 WCHAR* pDeviceKey,
1222 WCHAR* pFilePath,
1223 BYTE * pImageType,
1224 BYTE * pImageID,
1225 ULONG* pVersionID,
1226 USHORT versionSize,
1227 WCHAR* pVersion );
1228
1273 SWIIMPORT ULONG SWICMAPI SwiGetServingNetwork(
1274 ULONG * pRegistrationState,
1275 ULONG * pCSDomain,
1276 ULONG * pPSDomain,
1277 ULONG * pRAN,
1278 BYTE * pRadioIfacesSize,
1279 BYTE * pRadioIfaces,
1280 ULONG * pRoaming,
1281 WORD * pMCC,
1282 WORD * pMNC,
1283 BYTE nameSize,
1284 CHAR * pName,
1285 WORD* pSID,
1286 WORD* pNID);
1287
1289 //
1303 SWIIMPORT ULONG SWICMAPI GetWiFiState( ULONG * pState );
1304
1306 //
1319 SWIIMPORT ULONG SWICMAPI SetWiFiState( ULONG state );
1320
1334 SWIIMPORT ULONG SWICMAPI InvokeApiCrash(ULONG nCrashMethod);
1335
1372 #ifndef SWI_STRUCT_DEFINED
1373 struct SWI_STRUCT_TcpOpt
1374 {
1380 ULONG nTcpWindowSize;
1381
1383 ULONG nTcpWindowSizeGlobal;
1384
1386 ULONG nTcpWindowSizeGlobalMax;
1387
1390 bool bSackOpts;
1391
1394 ULONG nTcpMaxDupAcks;
1395
1397 ULONG nTcp1323Opts;
1398
1400 ULONG nTcpMaxConnectRetransmissions;
1401 };
1402 #define SWI_STRUCT_DEFINED
1403 #endif
1404
1423 SWIIMPORT ULONG SWICMAPI SwiOptimizeTcp(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt sTcpOpt);
1424
1441 SWIIMPORT ULONG SWICMAPI SwiGetTcpOpt(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt &sTcpOpt);
1442
1462 SWIIMPORT ULONG SWICMAPI LTEGetAGPSConfig(
1463 ULONG * pServerAddress,
1464 ULONG * pServerPort,
1465 ULONG networkMode);
1466
1486 SWIIMPORT ULONG SWICMAPI LTESetAGPSConfig(
1487 ULONG serverAddress,
1488 ULONG serverPort,
1489 ULONG networkMode);
1490
1501 SWIIMPORT ULONG SWICMAPI SetNMEAPlusCallback( tFNNewNMEAPlus pCallback );
1502
1518 SWIIMPORT ULONG SWICMAPI SWIOMADMInitApi();
1519
1532 SWIIMPORT ULONG SWICMAPI SWIOMADMShutdownApi();
1533
1548 SWIIMPORT ULONG SWICMAPI SWIOMADMSessionStart( ULONG sessionType );
1549
1561 SWIIMPORT ULONG SWICMAPI SWIOMADMSessionCancel( UINT8 sessionType);
1562
1580 SWIIMPORT ULONG SWICMAPI SWIOMADMSessionGetInfo(
1581 UINT8 nSessionType,
1582 UINT8 nSessionState );
1583
1597 SWIIMPORT ULONG SWICMAPI SWIOMADMSelection(
1598 UINT8 UserInput );
1599
1618 SWIIMPORT ULONG SWICMAPI SWIOMADMGetSettings(
1619 UINT32 enabled,
1620 UINT8 fwAutoDownload,
1621 UINT8 fwAutoUpdate);
1622
1638 SWIIMPORT ULONG SWICMAPI SWIOMADMSetSettings(
1639 UINT8 fwAutoLoad,
1640 UINT8 fwAutoUpdate );
1641
1653 SWIIMPORT ULONG SWICMAPI SWIOMADMSetEventReport( );
1654
1664 typedef void (SWICALLBACK * tFNSWIOMADMFota)(
1665 UINT8 SessionState,
1666 UINT8 UserInputReq,
1667 UINT16 UserInputTimeout,
1668 UINT32 FWDownloadSize,
1669 UINT32 FWDownloadComplete,
1670 UINT16 UpdateStatus,
1671 UINT8 Severity,
1672 UINT16 VersionLength,
1673 BYTE* Version,
1674 UINT16 NameLength,
1675 BYTE* PackageName,
1676 UINT16 DescriptionLength,
1677 BYTE* Description);
1678
1688 typedef void (SWICALLBACK * tFNSWIOMADMAlert)(
1689 UINT8 SessionState,
1690 UINT8 UserInputReq,
1691 UINT16 UserInputTimeout,
1692 UINT16 AlertMsgLength,
1693 BYTE* AlertMsg );
1694
1708 SWIIMPORT ULONG SWICMAPI SetSWIOMADMFotaCallback( tFNSWIOMADMFota pCallback );
1709
1723 SWIIMPORT ULONG SWICMAPI SetSWIOMADMAlertCallback( tFNSWIOMADMAlert pCallback );
1724
1778 SWIIMPORT ULONG SWICMAPI StartDataSessionLTE(
1779 ULONG * pTechnology,
1780 ULONG * pPrimaryDNSv4,
1781 ULONG * pSecondaryDNSv4,
1782 ULONG * pPrimaryNBNSv4,
1783 ULONG * pSecondaryNBNSv4,
1784 ULONG * pPrimaryDNSv6,
1785 ULONG * pSecondaryDNSv6,
1786 CHAR * pAPNName,
1787 ULONG * pIPAddressv4,
1788 ULONG * pIPAddressv6,
1789 ULONG * pAuthentication,
1790 CHAR * pUsername,
1791 CHAR * pPassword,
1792 ULONG * pSessionId,
1793 ULONG * pFailureReason );
1794
1811 SWIIMPORT ULONG SWICMAPI GetIPAddressLTE(
1812 ULONG * pIPAddressv4,
1813 USHORT * pIPAddressv6,
1814 BYTE * pIPv6prefixlen);
1815
1816 // Current data bearer technology callback function
1817 typedef void (SWICALLBACK * tFNSwiCurrentDataBearer)(
1818 ULONG NetworkType,
1819 ULONG RatMask,
1820 ULONG SoMask );
1821
1832 SWIIMPORT ULONG SWICMAPI SwiSetCurrentDataBearerCallback( tFNSwiCurrentDataBearer pCallback );
1833
1877 SWIIMPORT ULONG SWICMAPI SwiGetCurrentDataBearerTechnology(
1878 ULONG* pNetworkType,
1879 ULONG* pRatMask,
1880 ULONG* pSoMask);
1881
1891 SWIIMPORT ULONG SWICMAPI SwitchModemToBootMode();
1892
1912 SWIIMPORT ULONG SWICMAPI SetRfSarState( ULONG RfSarState );
1913
1933 SWIIMPORT ULONG SWICMAPI GetRfSarState( ULONG * pRfSarState );
1934
2014 SWIIMPORT ULONG SWICMAPI SwiGetSignalStrengthInfo(
2015 INT8* pCdmaRssi,
2016 ULONG* pCdmaEcio,
2017 INT8* pHdrRssi,
2018 ULONG* pHdrEcio,
2019 ULONG* pHdrSinr,
2020 ULONG* pHdrIo,
2021 INT8* pGsmRssi,
2022 INT8* pWcdmaRssi,
2023 ULONG* pWcdmaEcio,
2024 INT8* pLteRssi,
2025 INT8* pLteRsrq,
2026 INT16* pLteRsrp,
2027 UINT8* pLteSnr
2028 );
2029
2040 SWIIMPORT ULONG SWICMAPI SwiSetSignalStrengthInfoCallback( tFNSwiSignalStrengthInfo pCallback );
2041
2064 SWIIMPORT ULONG SWICMAPI SwiGetApn(
2065 BYTE nProfileType,
2066 BYTE nProfileIndex,
2067 BYTE nLength,
2068 CHAR * pApn );
2069
2070
2071 #ifdef __cplusplus
2072 };
2073 #endif
2074 // End of WCM group
2075 #endif // __SWIWWANCMAPI_H__
SWI_STRUCT_TcpOpt::nTcpMaxDupAcks
ULONG nTcpMaxDupAcks
Definition: SwiWwanCmApi.h:1394
SWI_STRUCT_TcpOpt::nTcpWindowSize
ULONG nTcpWindowSize
Definition: SwiWwanCmApi.h:1380
SwiOptimizeTcp
SWIIMPORT ULONG SWICMAPI SwiOptimizeTcp(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt sTcpOpt)
This function is called to optimize Window's TCP stack to improve wireless transfer performance with ...
WCDMADecodeMTTextMsg
SWIIMPORT ULONG SWICMAPI WCDMADecodeMTTextMsg(BYTE *pMessage, BYTE *pSenderAddrLength, CHAR *pSenderAddr, BYTE *pTextMsgLength, WCHAR *pTextMsg, BYTE *pScAddrLength, CHAR *pScAddr, BOOLEAN *pMoreMsgSend, BOOLEAN *pReplyPath, BOOLEAN *pStatusReportInd, BYTE scTimeStamp[7], BOOLEAN *pConcatenatedMsg, ULONG *pMsgRefNum, BYTE *pTotalSegments, BYTE *pSegmentNum)
This function can be used to decode a received WCDMA SMS message read off the device using the GetSMS...
SWI_STRUCT_TcpOpt::nTcpMaxConnectRetransmissions
ULONG nTcpMaxConnectRetransmissions
Definition: SwiWwanCmApi.h:1400
SWIOMADMGetSettings
SWIIMPORT ULONG SWICMAPI SWIOMADMGetSettings(UINT32 enabled, UINT8 fwAutoDownload, UINT8 fwAutoUpdate)
This function gets FOTA settings.
tFNSwiDeviceRemoval
void(SWICALLBACK * tFNSwiDeviceRemoval)(ULONG nStatus)
Device removal callback function.
Definition: SwiWwanCmApi.h:186
tFNPacketTotals
void(SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX)
API Return Codes.
Definition: SwiWwanCmApi.h:60
WCDMADecodeMOTextMsg
SWIIMPORT ULONG SWICMAPI WCDMADecodeMOTextMsg(BYTE *pMessage, BYTE *pDestAddrLength, CHAR *pDestAdd, BYTE *pTextMsgLength, WCHAR *pTextMsg, BYTE *pScAddrLength, CHAR *pScAddr, BOOLEAN *pRejectDuplicates, BOOLEAN *pStatusReportReq, BOOLEAN *pReplyPath, BYTE *pValidityFormat, BYTE validityPeriod[7], BOOLEAN *pConcatenatedMsg, ULONG *pMsgRefNum, BYTE *pTotalSegments, BYTE *pSegmentNum)
This function can be used to decode a WCDMA draft message read from the device using GetSMS() API...
SetRfSarState
SWIIMPORT ULONG SWICMAPI SetRfSarState(ULONG RfSarState)
This function sets the specified RF SAR state.
SwiGetServingNetwork
SWIIMPORT ULONG SWICMAPI SwiGetServingNetwork(ULONG *pRegistrationState, ULONG *pCSDomain, ULONG *pPSDomain, ULONG *pRAN, BYTE *pRadioIfacesSize, BYTE *pRadioIfaces, ULONG *pRoaming, WORD *pMCC, WORD *pMNC, BYTE nameSize, CHAR *pName, WORD *pSID, WORD *pNID)
Gets information regarding the system that currently provides service to the device.
SWI_STRUCT_TcpOpt::nTcpWindowSizeGlobalMax
ULONG nTcpWindowSizeGlobalMax
Definition: SwiWwanCmApi.h:1386
WCDMAEncodeMOTextMsg
SWIIMPORT ULONG SWICMAPI WCDMAEncodeMOTextMsg(BYTE *pMessageListSize, BYTE *pMessageList, BYTE messageRefNum, CHAR *pDestAddr, ULONG textMsgLength, WCHAR *pTextMsg, CHAR *pScAddr, BOOLEAN *pRejectDuplicates, BOOLEAN *pStatusReportReq, BOOLEAN *pReplyPath, BYTE *pValidityFormat, BYTE validityPeriod[7], BYTE *pEncodingAlphabet)
This function can be used to encode an outgoing WCDMA message. The the resulting message can be eithe...
tFNSWIOMADMFota
void(SWICALLBACK * tFNSWIOMADMFota)(UINT8 SessionState, UINT8 UserInputReq, UINT16 UserInputTimeout, UINT32 FWDownloadSize, UINT32 FWDownloadComplete, UINT16 UpdateStatus, UINT8 Severity, UINT16 VersionLength, BYTE *Version, UINT16 NameLength, BYTE *PackageName, UINT16 DescriptionLength, BYTE *Description)
SWIOMA-DM network initiated FOTA callback function.
Definition: SwiWwanCmApi.h:1664
SWIOMADMSessionGetInfo
SWIIMPORT ULONG SWICMAPI SWIOMADMSessionGetInfo(UINT8 nSessionType, UINT8 nSessionState)
This function returns information related to the current (or previous if no session is active) SWIOMA...
SetSWIOMADMFotaCallback
SWIIMPORT ULONG SWICMAPI SetSWIOMADMFotaCallback(tFNSWIOMADMFota pCallback)
This function enables/disables the OMA-DM network initiated FOTA callback function.
SwiGetTcpOpt
SWIIMPORT ULONG SWICMAPI SwiGetTcpOpt(LPCTSTR lpstrInterfaceID, SWI_STRUCT_TcpOpt &sTcpOpt)
This function is called to retrieve the Window's TCP stack optimization values.
LTEGetSMSList
SWIIMPORT ULONG SWICMAPI LTEGetSMSList(ULONG storageType, ULONG *pRequestedTag, ULONG *pMessageListSize, BYTE *pMessageList, ULONG *pMessageMode)
This function returns the list of SMS messages stored on an LTE device.
SwiGetCurrentDataBearerTechnology
SWIIMPORT ULONG SWICMAPI SwiGetCurrentDataBearerTechnology(ULONG *pNetworkType, ULONG *pRatMask, ULONG *pSoMask)
This function returns the current data bearer technology.
SWI_STRUCT_TcpOpt::bSackOpts
bool bSackOpts
Definition: SwiWwanCmApi.h:1390
SwiGoDormant
SWIIMPORT ULONG SWICMAPI SwiGoDormant(void)
This command forces the device to drop the traffic channel. The channel may be reactivated the n...
tFNErrorRate
void(SWICALLBACK * tFNErrorRate)(ULONG nErrorRate, ULONG nRadioIf)
Error rate callback function.
Definition: SwiWwanCmApi.h:157
SWIOMADMSessionStart
SWIIMPORT ULONG SWICMAPI SWIOMADMSessionStart(ULONG sessionType)
This function starts an SWIOMA-DM session.
SwiGetSignalStrengthInfo
SWIIMPORT ULONG SWICMAPI SwiGetSignalStrengthInfo(INT8 *pCdmaRssi, ULONG *pCdmaEcio, INT8 *pHdrRssi, ULONG *pHdrEcio, ULONG *pHdrSinr, ULONG *pHdrIo, INT8 *pGsmRssi, INT8 *pWcdmaRssi, ULONG *pWcdmaEcio, INT8 *pLteRssi, INT8 *pLteRsrq, INT16 *pLteRsrp, UINT8 *pLteSnr)
This function returns information regarding the signal strength.
GetRoutes
SWIIMPORT ULONG SWICMAPI GetRoutes(ULONG *pRouteInstances, BYTE *pRouteList)
This function queries the behavior used to route new MT messages to MSM memory storage and WMS client...
GetIPAddressLTE
SWIIMPORT ULONG SWICMAPI GetIPAddressLTE(ULONG *pIPAddressv4, USHORT *pIPAddressv6, BYTE *pIPv6prefixlen)
This function returns the current packet data session IP address(es)
tFNSWIOMADMAlert
void(SWICALLBACK * tFNSWIOMADMAlert)(UINT8 SessionState, UINT8 UserInputReq, UINT16 UserInputTimeout, UINT16 AlertMsgLength, BYTE *AlertMsg)
SWIOMA-DM network initiated alert callback function.
Definition: SwiWwanCmApi.h:1688
SetSWIOMADMAlertCallback
SWIIMPORT ULONG SWICMAPI SetSWIOMADMAlertCallback(tFNSWIOMADMAlert pCallback)
This function enables/disables the OMA-DM network initiated alert callback function.
LTEDeleteSMS
SWIIMPORT ULONG SWICMAPI LTEDeleteSMS(ULONG storageType, ULONG *pMessageIndex, ULONG *pMessageTag, ULONG *pMessageMode)
This function deletes one or more SMS messages from the device memory of an LTE device.
SWIOMADMShutdownApi
SWIIMPORT ULONG SWICMAPI SWIOMADMShutdownApi()
This function cleans up SWIOMA-DM resources.
GetRfSarState
SWIIMPORT ULONG SWICMAPI GetRfSarState(ULONG *pRfSarState)
This function gets the specified RF SAR state.
LTEModifySMSStatus
SWIIMPORT ULONG SWICMAPI LTEModifySMSStatus(ULONG storageType, ULONG messageIndex, ULONG messageTag, ULONG *pMessageMode)
This function modifies the status of an SMS message saved in storage on an LTE device.
SWIOMADMSetEventReport
SWIIMPORT ULONG SWICMAPI SWIOMADMSetEventReport()
This function set enables event reporting.
SWIOMADMSelection
SWIIMPORT ULONG SWICMAPI SWIOMADMSelection(UINT8 UserInput)
This function sends the specified SWIOMA-DM selection for the current network initiated session...
tFNSnir
void(SWICALLBACK * tFNSnir)(ULONG nSnir)
SNIR callback function.
Definition: SwiWwanCmApi.h:127
SwiSetErrorRateCallback
SWIIMPORT ULONG SWICMAPI SwiSetErrorRateCallback(tFNErrorRate pCallback)
This function enables/disables the error rate callback function.
SwiSetEcioCallback
SWIIMPORT ULONG SWICMAPI SwiSetEcioCallback(tFNEcio pCallback, BYTE nThreshold)
This function enables/disables the ECIO callback function.
SwiSetSignalStrengthInfoCallback
SWIIMPORT ULONG SWICMAPI SwiSetSignalStrengthInfoCallback(tFNSwiSignalStrengthInfo pCallback)
This function enables/disables the signal strength info callback function.
tFNRsrq
void(SWICALLBACK * tFNRsrq)(INT8 nRsrq, ULONG nRadioIf)
RSRQ callback function.
Definition: SwiWwanCmApi.h:174
SWI_STRUCT_TcpOpt
This structure contains TCP optimization parameters.
Definition: SwiWwanCmApi.h:1373
SetWiFiState
SWIIMPORT ULONG SWICMAPI SetWiFiState(ULONG state)
This function sets the WiFi positioning state.
SwiSetDeviceRemovalCallback
SWIIMPORT ULONG SWICMAPI SwiSetDeviceRemovalCallback(tFNSwiDeviceRemoval pCallback)
This function enables/disables the device removal callback function.
SwiSetRsrqCallback
SWIIMPORT ULONG SWICMAPI SwiSetRsrqCallback(tFNRsrq pCallback, BYTE nThreshold)
This function enables/disables the RSRQ callback function.
GetIPConfiguration
SWIIMPORT ULONG SWICMAPI GetIPConfiguration(ULONG *pIPAddress, ULONG *pGatewayAddress, ULONG *pSubnetMask, ULONG *pPrimaryDnsAddress, ULONG *pSecondaryDnsAddress)
This function returns IP configuration data for the current packet data session.
SWIOMADMInitApi
SWIIMPORT ULONG SWICMAPI SWIOMADMInitApi()
This function initializes the API for SWIOMA-DM functionality.
LTEGetSMS
SWIIMPORT ULONG SWICMAPI LTEGetSMS(ULONG storageType, ULONG messageIndex, ULONG *pMessageTag, ULONG *pMessageFormat, ULONG *pMessageSize, BYTE *pMessage, ULONG *pMessageMode)
This function returns an SMS message from the device memory of an LTE device.
SwiSetSnirCallback
SWIIMPORT ULONG SWICMAPI SwiSetSnirCallback(tFNSnir pCallback, BYTE nThreshold)
This function enables/disables the SNIR callback function.
CDMAEncodeMOTextMsg
SWIIMPORT ULONG SWICMAPI CDMAEncodeMOTextMsg(BYTE *pMessageSize, BYTE *pMessage, BYTE messageId, CHAR *pDestAddr, CHAR *pCallbackAddr, ULONG textMsgLength, WCHAR *pTextMsg, BYTE *pPriority, BYTE *pEncodingAlphabet, BYTE *pRelValidity=NULL)
This function can be used to encode an outgoing CDMA message. The the resulting message can be either...
SWIOMADMSessionCancel
SWIIMPORT ULONG SWICMAPI SWIOMADMSessionCancel(UINT8 sessionType)
This function cancels an ongoing SWIOMA-DM session.
SetRoutes
SWIIMPORT ULONG SWICMAPI SetRoutes(ULONG nRouteInstances, BYTE *pRouteList)
This function sets the routing action taken upon receipt of incoming the WMS message per message cate...
SwiSetCurrentDataBearerCallback
SWIIMPORT ULONG SWICMAPI SwiSetCurrentDataBearerCallback(tFNSwiCurrentDataBearer pCallback)
This function enables/disables the current data bearer status callback function.
SWIOMADMSetSettings
SWIIMPORT ULONG SWICMAPI SWIOMADMSetSettings(UINT8 fwAutoLoad, UINT8 fwAutoUpdate)
This function sets FOTA settings.
LTEGetAGPSConfig
SWIIMPORT ULONG SWICMAPI LTEGetAGPSConfig(ULONG *pServerAddress, ULONG *pServerPort, ULONG networkMode)
This function returns the configuration used by the MSM GPS to perform fixes while in 2 MS-Based mode...
GetWiFiState
SWIIMPORT ULONG SWICMAPI GetWiFiState(ULONG *pState)
This function returns the WiFi positioning state.
SetNMEAPlusCallback
SWIIMPORT ULONG SWICMAPI SetNMEAPlusCallback(tFNNewNMEAPlus pCallback)
This function enables/disables the NMEA sentence plus mode callback function.
StartDataSessionLTE
SWIIMPORT ULONG SWICMAPI StartDataSessionLTE(ULONG *pTechnology, ULONG *pPrimaryDNSv4, ULONG *pSecondaryDNSv4, ULONG *pPrimaryNBNSv4, ULONG *pSecondaryNBNSv4, ULONG *pPrimaryDNSv6, ULONG *pSecondaryDNSv6, CHAR *pAPNName, ULONG *pIPAddressv4, ULONG *pIPAddressv6, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId, ULONG *pFailureReason)
These functions activate a packet data session on an LTE device.
SWI_STRUCT_TcpOpt::nTcpWindowSizeGlobal
ULONG nTcpWindowSizeGlobal
Definition: SwiWwanCmApi.h:1383
LTESetAGPSConfig
SWIIMPORT ULONG SWICMAPI LTESetAGPSConfig(ULONG serverAddress, ULONG serverPort, ULONG networkMode)
This function sets the default configuration used by the MSM GPS to perform MS-based fixes...
InvokeApiCrash
SWIIMPORT ULONG SWICMAPI InvokeApiCrash(ULONG nCrashMethod)
This function instructs the API to generate a fatal exception.
GetImageInfo3KW
SWIIMPORT ULONG SWICMAPI GetImageInfo3KW(WCHAR *pDeviceID, WCHAR *pDeviceKey, WCHAR *pFilePath, BYTE *pImageType, BYTE *pImageID, ULONG *pVersionID, USHORT versionSize, WCHAR *pVersion)
This function can be used to get image information (including Image ID,.
SWI_STRUCT_TcpOpt::nTcp1323Opts
ULONG nTcp1323Opts
Definition: SwiWwanCmApi.h:1397
tFNEcio
void(SWICALLBACK * tFNEcio)(INT8 nEcio, ULONG nRadioIf)
ECIO callback function.
Definition: SwiWwanCmApi.h:105
CDMADecodeMTTextMsg
SWIIMPORT ULONG SWICMAPI CDMADecodeMTTextMsg(ULONG messageLength, BYTE *pMessage, ULONG *pMessageID, BYTE *pSenderAddrLength, CHAR *pSenderAddr, BYTE *pTextMsgLength, WCHAR *pTextMsg, BYTE *pPriority, BYTE *pPrivacy, BYTE *pLanguage, BYTE mcTimeStamp[7], BYTE absoluteValidity[7], BYTE *pRelativeValidity, BYTE *pDisplayMode, BOOL *pUserAcknowledgementReq, BOOL *pReadAcknowledgementReq, BYTE *pAlertPriority, BYTE *pCallbkAddrLength=NULL, CHAR *pCallbkAddr=NULL)
This function can be used to decode a received CDMA SMS message read off the device using the GetSMS(...
SwiGetApn
SWIIMPORT ULONG SWICMAPI SwiGetApn(BYTE nProfileType, BYTE nProfileIndex, BYTE nLength, CHAR *pApn)
This function gets the APN information from a configured profile.
SwitchModemToBootMode
SWIIMPORT ULONG SWICMAPI SwitchModemToBootMode()
This function switches the modem from application mode to boot & hold mode.