This file contains definitions, enumerations, structures and forward declarations for SwiApiCmBasic.c file. More...

#include "SwiDataTypes.h"
#include "SwiRcodes.h"

Data Structures
struct	SWI_STRUCT_Logging

struct	SWI_STRUCT_SdkPath

struct	SWI_STRUCT_ApiStartup

struct	SWI_STRUCT_UsbdInfo

struct	SWI_STRUCT_PriInfo

struct	SWI_STRUCT_ModemType

struct	SWI_STRUCT_AirServer

struct	SWI_STRUCT_AirServerExtended

struct	SWI_STRUCT_AirServerList

struct	SWI_STRUCT_AirServerChange

struct	SWI_STRUCT_DeviceInformation_Request

struct	SWI_STRUCT_DeviceInformation_Response

struct	SWI_STRUCT_HeartBeat

struct	SWI_STRUCT_DeviceTime

struct	SWI_STRUCT_FlashImgInfo

struct	SWI_STRUCT_OBJRNGREV_InfoBlock

struct	SWI_STRUCT_ObjRngRev

struct	SWI_STRUCT_RadioPower

struct	SWI_STRUCT_RadioTempState

struct	SWI_STRUCT_RadioBattery

struct	SWI_STRUCT_RadioBandInfo

struct	SWI_STRUCT_RadioBandList

struct	SWI_STRUCT_RadioBandConfig

struct	SWI_STRUCT_UsbPortName

struct	SWI_STRUCT_NVUpdateFromFile

struct	SWI_STRUCT_ApiUnlock

struct	SWI_STRUCT_RDA_SUPPORT

struct	SWI_STRUCT_RM_CONFIG

struct	SWI_STRUCT_RM_CONFIG_SET

struct	SWI_STRUCT_GetSwocCfg

Macros
#define	LENGTH_MaxPPPString 33

#define	LENGTH_IPAddress 16

#define	LENGTH_LogFileName 128

#define	LENGTH_SdkPathName 128

#define	LENGTH_CommPort 7

#define	LENGTH_UsbdVersion 85

#define	LENGTH_UsbdBuildDate 9

#define	LENGTH_BootBuildDate 9

#define	NUMVALUE_WIMAX 80216

#define	MAX_NOTIF_LIST 122

#define	LENGTH_DriverName 100

#define	LENGTH_MacAddress 6

#define	LENGTH_ProductName 20

#define	LENGTH_ModemName 75

#define	LENGTH_HardwareId 50

#define	MAX_NUM_LBS_SV 12

#define	LENGTH_TimeStamp 16

#define	MAX_BAND_GROUPS 50

#define	MAX_BAND_LIST 50

#define	MAX_AIR_SERVERS 50 /* Must be < than a frame. */

#define	LENGTH_ProductStr 16

#define	MAX_OBJRNGINFOBLOCKS 35

#define	LENGTH_PortName 80

#define	LENGTH_ImgInfoVer 85

#define	LENGTH_ImgInfoRelDate 9

#define	LENGTH_ImgInfoProdType 5

#define	LENGTH_ImgInfoImgType 5

#define	SWI_RADIOBANDGROUP_CdmaClass0A 0x0000000000000001ull

#define	SWI_RADIOBANDGROUP_CdmaClass0B 0x0000000000000002ull

#define	SWI_RADIOBANDGROUP_CdmaClass0ABo 0x0000000000000003ull

#define	SWI_RADIOBANDGROUP_CdmaClass1 0x0000000000000004ull

#define	SWI_RADIOBANDGROUP_CdmaClass2 0x0000000000000008ull

#define	SWI_RADIOBANDGROUP_CdmaClass3 0x0000000000000010ull

#define	SWI_RADIOBANDGROUP_CdmaClass4 0x0000000000000020ull

#define	SWI_RADIOBANDGROUP_CdmaClass5 0x0000000000000040ull

#define	SWI_RADIOBANDGROUP_CdmaClass6 0x0000000000000080ull

#define	SWI_RADIOBANDGROUP_CdmaClass7 0x0000000000000100ull

#define	SWI_RADIOBANDGROUP_CdmaClass8 0x0000000000000200ull

#define	SWI_RADIOBANDGROUP_CdmaClass9 0x0000000000000400ull

#define	SWI_RADIOBANDGROUP_CdmaClass10 0x0000000000000800ull

#define	SWI_RADIOBANDGROUP_CdmaClass11 0x0000000000001000ull

#define	SWI_RADIOBANDGROUP_CdmaClass12 0x0000000000002000ull

#define	SWI_RADIOBANDGROUP_CdmaPcsCellular 0x0000000000000007ull

#define	SWI_RADIOBANDGROUP_Gsm450 0x0000000000010000ull

#define	SWI_RADIOBANDGROUP_Gsm480 0x0000000000020000ull

#define	SWI_RADIOBANDGROUP_Gsm750 0x0000000000040000ull

#define	SWI_RADIOBANDGROUP_Gsm850 0x0000000000080000ull

#define	SWI_RADIOBANDGROUP_GsmRGsm900 0x0000000000100000ull

#define	SWI_RADIOBANDGROUP_GsmPcs1900 0x0000000000200000ull

#define	SWI_RADIOBANDGROUP_GsmDcs1800 0x0000000000400000ull

#define	SWI_RADIOBANDGROUP_GsmEGsm900 0x0000000000800000ull

#define	SWI_RADIOBANDGROUP_GsmPGsm900 0x0000000001000000ull

#define	SWI_RADIOBANDGROUP_GsmPcs850 0x0000000000280000ull

#define	SWI_RADIOBANDGROUP_GsmEGsmDcs 0x0000000001C00000ull

#define	SWI_RADIOBANDGROUP_GsmAll 0x0000000001E80000ull

#define	SWI_RADIOBANDGROUP_WcdmaIImt2000 0x0000000100000000ull

#define	SWI_RADIOBANDGROUP_WcdmaIIPcs1900 0x0000000200000000ull

#define	SWI_RADIOBANDGROUP_WcdmaIII1700 0x0000000400000000ull

#define	SWI_RADIOBANDGROUP_WcdmaIV1700 0x0000000800000000ull

#define	SWI_RADIOBANDGROUP_WcdmaV850 0x0000001000000000ull

#define	SWI_RADIOBANDGROUP_WcdmaVI800 0x0000002000000000ull

#define	SWI_RADIOBANDGROUP_WcdmaVII2600 0x0000004000000000ull

#define	SWI_RADIOBANDGROUP_WcdmaVIII900 0x0000008000000000ull

#define	SWI_RADIOBANDGROUP_WcdmaEu 0x0000008100000000ull

#define	SWI_RADIOBANDGROUP_WcdmaIX1700 0x0000010000000000ull

#define	SWI_RADIOBANDGROUP_WcdmaNa 0x0000001200000000ull

#define	SWI_RADIOBANDGROUP_WcdmaGsmEu 0x0000000101C00000ull

#define	SWI_RADIOBANDGROUP_WcdmaGsmNa 0x0000001200280000ull

#define	SWI_RADIOBANDGROUP_WcdmaAustralia 0x0000001100000000ull

#define	SWI_RADIOBANDGROUP_WcdmaAustrailiaGsmEu 0x0000001101C00000ull

#define	SWI_RADIOBANDGROUP_WcdmaJapan 0x0000002100000000ull

#define	SWI_RADIOBANDGROUP_WcdmaAll_EarlyMC8700 0x0000001300000000ull

#define	SWI_RADIOBANDGROUP_WcdmaAll_AC503_MC8700 0x000000b300000000ull

#define	SWI_RADIOBANDGROUP_AutoBand 0xFFFFFFFFFFFFFFFFull

#define	SWI_FILENAME_LEN 8

#define	SWI_API_UNLOCK_PWD_LEN 10

#define	SWI_RDA_NAME_MAX 69

#define	SWI_RDA_VERSION_MAX 32

Typedefs
typedef enum eUpdateFromFileStatus	UpdateFromFileStatus

typedef struct SWI_STRUCT_NVUpdateFromFile	SWI_STRUCT_NVUpdateFromFile

typedef enum eApiUnlockLevel	ApiUnlockLevel

typedef enum eApiUnlockResult	ApiUnlockResult

typedef struct SWI_STRUCT_ApiUnlock	SWI_STRUCT_ApiUnlock

typedef enum SWI_TYPE_RDA_SUPPORT_STATUS	SWI_TYPE_RDA_SUPPORT_STATUS

typedef struct SWI_STRUCT_RDA_SUPPORT	SWI_STRUCT_RDA_SUPPORT

typedef enum SWI_TYPE_REMOVABLE_MEDIA	SWI_TYPE_REMOVABLE_MEDIA

typedef struct SWI_STRUCT_RM_CONFIG	SWI_STRUCT_RM_CONFIG

typedef struct SWI_STRUCT_RM_CONFIG_SET	SWI_STRUCT_RM_CONFIG_SET

Enumerations
enum	SWI_TYPE_Device { SWI_DEVICE_None = 0, SWI_DEVICE_AC550, SWI_DEVICE_AC575, SWI_DEVICE_AC580, SWI_DEVICE_AC595, SWI_DEVICE_AC597, SWI_DEVICE_AC710 = 100, SWI_DEVICE_AC750, SWI_DEVICE_AC775, SWI_DEVICE_AC850, SWI_DEVICE_AC860, SWI_DEVICE_AC875, SWI_DEVICE_AC880, SWI_DEVICE_AC881, SWI_DEVICE_MC5720 = 200, SWI_DEVICE_MC5725, SWI_DEVICE_MC5727, SWI_DEVICE_MC5728, SWI_DEVICE_SL501X, SWI_DEVICE_MC8755 = 300, SWI_DEVICE_MC8765, SWI_DEVICE_MC8775, SWI_DEVICE_MC8780, SWI_DEVICE_MC8781, SWI_DEVICE_MC8785, SWI_DEVICE_MC8790, SWI_DEVICE_MC8791, SWI_DEVICE_MC8700, SWI_DEVICE_MC8704, SWI_DEVICE_MC8705, SWI_DEVICE_MC8777, SWI_DEVICE_MC8790V, SWI_DEVICE_MC8801, SWI_DEVICE_SL8080, SWI_DEVICE_SL8081, SWI_DEVICE_SL8082, SWI_DEVICE_SL8083, SWI_DEVICE_SL8084, SWI_DEVICE_SL8085, SWI_DEVICE_SL8090, SWI_DEVICE_SL8091, SWI_DEVICE_SL8092, SWI_DEVICE_SL8093, SWI_DEVICE_EM5625 = 400, SWI_DEVICE_EM5725, SWI_DEVICE_EM8780 = 500, SWI_DEVICE_EM8781, SWI_DEVICE_M81A, SWI_DEVICE_M81B, SWI_DEVICE_MP555 = 600, SWI_DEVICE_MP595, SWI_DEVICE_MP750 = 700, SWI_DEVICE_MP775, SWI_DEVICE_MP875, SWI_DEVICE_MP880, SWI_DEVICE_MP881, SWI_DEVICE_AC597E = 1000, SWI_DEVICE_AC598E, SWI_DEVICE_AC875E = 1100, SWI_DEVICE_AC880E, SWI_DEVICE_AC881E, SWI_DEVICE_AC885E, SWI_DEVICE_AC886E, SWI_DEVICE_AC595U = 1200, SWI_DEVICE_T598, SWI_DEVICE_T11, SWI_DEVICE_AC802, SWI_DEVICE_AC875U = 1300, SWI_DEVICE_AC880U, SWI_DEVICE_AC881U, SWI_DEVICE_C885, SWI_DEVICE_C886, SWI_DEVICE_C888, SWI_DEVICE_C889, SWI_DEVICE_K888, SWI_DEVICE_K889, SWI_DEVICE_C22, SWI_DEVICE_C23, SWI_DEVICE_K22, SWI_DEVICE_K23, SWI_DEVICE_USB303, SWI_DEVICE_USB304, SWI_DEVICE_USB305, SWI_DEVICE_USB306, SWI_DEVICE_USB307, SWI_DEVICE_USB308, SWI_DEVICE_CHspa = 1399, SWI_DEVICE_MassStorage = 2000, SWI_DEVICE_UNIFIEDPID }

enum	SWI_TYPE_WirelessTech { SWI_WIRELESSTECH_Unknown, SWI_WIRELESSTECH_Cdma, SWI_WIRELESSTECH_Gsm, SWI_WIRELESSTECH_Wifi, SWI_WIRELESSTECH_Wimax }

enum	SWI_TYPE_ProductClass { SWI_PRODUCTCLASS_Unknown, SWI_PRODUCTCLASS_PcCard, SWI_PRODUCTCLASS_Embedded, SWI_PRODUCTCLASS_Mp }

enum	SWI_TYPE_DeviceInformationType { SWI_DEVICEINFORMATION_Technology = 1, SWI_DEVICEINFORMATION_Product, SWI_DEVICEINFORMATION_FrmDwlProtocol, SWI_DEVICEINFORMATION_DeviceReEnum, SWI_DEVICEINFORMATION_CNSsupported }

enum	SWI_TYPE_RequestStatus { SWI_REQUESTSTATUS_SUCCESS, SWI_REQUESTSTATUS_UnknownType, SWI_REQUESTSTATUS_GenFailure }

enum	SWI_TYPE_Technology { SWI_TECHNOLOGY_Unknown, SWI_TECHNOLOGY_CDMA, SWI_TECHNOLOGY_GSM }

enum	SWI_TYPE_FrmDlwProtocol { SWI_FRMDLWPROTOCOL_One, SWI_FRMDLWPROTOCOL_Two }

enum	SWI_TYPE_DeviceReEnum { SWI_DEVICEREENUM_Trigger_Remove, SWI_DEVICEREENUM_Trigger_NoRemove }

enum	SWI_TYPE_CNSsupported { SWI_CNSSUPPORTED_Yes, SWI_CNSSUPPORTED_No }

enum	SWI_TYPE_Month { SWI_MONTH_Jan = 0x01, SWI_MONTH_Feb, SWI_MONTH_Mar, SWI_MONTH_Apr, SWI_MONTH_May, SWI_MONTH_Jun, SWI_MONTH_Jul, SWI_MONTH_Aug, SWI_MONTH_Sep, SWI_MONTH_Oct, SWI_MONTH_Nov, SWI_MONTH_Dec }

enum	SWI_TYPE_WeekDay { SWI_WEEKDAY_Mon, SWI_WEEKDAY_Tue, SWI_WEEKDAY_Wed, SWI_WEEKDAY_Thu, SWI_WEEKDAY_Fri, SWI_WEEKDAY_Sat, SWI_WEEKDAY_Sun }

enum	SWI_TYPE_DaylightSavings { SWI_DAYLIGHTSAVINGS_None, SWI_DAYLIGHTSAVINGS_PlusOneHour, SWI_DAYLIGHTSAVINGS_PlusTwoHour }

enum	TYPE_FlashImgInfo_Result { FLASHIMGINFORESULT_Success, FLASHIMGINFORESULT_UnsupportedImgType, FLASHIMGINFORESULT_ImgNotFound }

enum	SWI_TYPE_ObjIdRngSpecifier { OBJIDRNGSPECIFIER_Cwe, OBJIDRNGSPECIFIER_CweLbs, OBJIDRNGSPECIFIER_Gprs, OBJIDRNGSPECIFIER_Cdma, OBJIDRNGSPECIFIER_Mp, OBJIDRNGSPECIFIER_Umts, OBJIDRNGSPECIFIER_CweDm }

enum	SWI_TYPE_RadioPowerMode { SWI_RADIOPOWERMODE_Low, SWI_RADIOPOWERMODE_Online }

enum	SWI_TYPE_RadioPowerReason { SWI_RADIOPOWERREASON_WDISABLE = 0x0001, SWI_RADIOPOWERREASON_UserRequest = 0x0002, SWI_RADIOPOWERREASON_Temperature = 0x0004, SWI_RADIOPOWERREASON_Battery = 0x0008 }

enum	SWI_TYPE_ModuleReqReason { SWI_MODULEREQREASON_NoReason, SWI_MODULEREQREASON_Temperature, SWI_MODULEREQREASON_Battery, SWI_MODULEREQREASON_Network, SWI_MODULEREQREASON_Other }

enum	SWI_TYPE_RadioTempState { SWI_RADIOTEMPSTATE_Normal, SWI_RADIOTEMPSTATE_HighWarning, SWI_RADIOTEMPSTATE_HighCrit, SWI_RADIOTEMPSTATE_LowCrit }

enum	SWI_TYPE_RadioBatteryState { SWI_RADIOBATTERYSTATE_Normal, SWI_RADIOBATTERYSTATE_LowWarning, SWI_RADIOBATTERYSTATE_LowCrit, SWI_RADIOBATTERYSTATE_HighCrit }

enum	SWI_TYPE_RadioType { SWI_RADIOTYPE_1xrtt, SWI_RADIOTYPE_Evdo, SWI_RADIOTYPE_GsmWcdma }

enum	SWI_TYPE_RadioBand { SWI_RADIOBAND_CdmaClass0 = 0x00, SWI_RADIOBAND_CdmaClass1, SWI_RADIOBAND_CdmaClass2, SWI_RADIOBAND_CdmaClass3, SWI_RADIOBAND_CdmaClass4, SWI_RADIOBAND_CdmaClass5, SWI_RADIOBAND_CdmaClass6, SWI_RADIOBAND_CdmaClass7, SWI_RADIOBAND_CdmaClass8, SWI_RADIOBAND_CdmaClass9, SWI_RADIOBAND_CdmaClass10, SWI_RADIOBAND_CdmaClass11, SWI_RADIOBAND_CdmaClass12, SWI_RADIOBAND_Gsm450 = 0x28, SWI_RADIOBAND_Gsm480, SWI_RADIOBAND_Gsm750, SWI_RADIOBAND_Gsm850, SWI_RADIOBAND_GsmEGsm900, SWI_RADIOBAND_GsmPGsm900, SWI_RADIOBAND_GsmRGsm900, SWI_RADIOBAND_GsmDcs1800, SWI_RADIOBAND_GsmPcs1900, SWI_RADIOBAND_WcdmaIImt2000 = 0x50, SWI_RADIOBAND_WcdmaIIPcs1900, SWI_RADIOBAND_WcdmaIIIDcs1800, SWI_RADIOBAND_WcdmaIV1700, SWI_RADIOBAND_WcdmaV850, SWI_RADIOBAND_WcdmaVI800, SWI_RADIOBAND_WcdmaVII2600, SWI_RADIOBAND_WcdmaVIII900, SWI_RADIOBAND_WcdmaIX1700, SWI_RADIOBAND_Invalid = 0xFF }

enum	eUpdateFromFileStatus { FILE_UPDATE_SUCCESS, FILE_NOT_FOUND, FILE_INCORRECT_SIZE, FILE_INCORRECT_HEADER, FILE_INVALID_REVISION }

enum	eApiUnlockLevel { API_UNLOCK_OEM, API_UNLOCK_SWI }

enum	eApiUnlockResult { API_UNLOCK_SUCCESS, API_UNLOCK_PWD_INVALID }

enum	SWI_TYPE_RDA_SUPPORT_STATUS { RDA_STATUS_NOT_SUPPORTED = 0, RDA_STATUS_DISABLED = 1, RDA_STATUS_ENABLED = 2 }

enum	SWI_TYPE_REMOVABLE_MEDIA { REMOVABLE_MEDIA_MINI_SD = 0x0001, REMOVABLE_MEDIA_MICRO_SD = 0x0002 }

Functions
SWI_API SWI_RCODE	SwiApiStartup (struct SWI_STRUCT_ApiStartup *pOpenParams)

SWI_API SWI_RCODE	SwiTerminateSDK (void)

SWI_API SWI_RCODE	SwiGetFirmwareVersion (swi_charp szFWVersion, swi_uint32 sizeBuffer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetFirmwareBuildDate (swi_charp szBuildDate, swi_uint32 sizeBuffer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetHardwareVersion (swi_charp szHWVersion, swi_uint32 sizeBuffer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetBootVersion (swi_charp szBVVersion, swi_uint32 sizeBuffer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetBootloaderBuildDate (swi_charp szBLBldDate, swi_uint32 *nLength, swi_uint32 Timeout)

SWI_API SWI_RCODE	SwiGetRadioPower (struct SWI_STRUCT_RadioPower *pRadioPower, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetRadioPower (struct SWI_STRUCT_RadioPower *pRadioPower, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRadioTempState (struct SWI_STRUCT_RadioTempState *pRadioTemp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRadioBattery (struct SWI_STRUCT_RadioBattery *pRadioBattery, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetCurrentRadioBand (struct SWI_STRUCT_RadioBandList *pRadioBand, swi_int32 timeout)

SWI_API SWI_RCODE	SwiGetRadioBandCfg (struct SWI_STRUCT_RadioBandConfig *pRadioBand, swi_int32 timeout)

SWI_API SWI_RCODE	SwiSetRadioBandCfg (swi_uint64 nRadioBandGroup, swi_int32 timeout)

SWI_API SWI_RCODE	SwiGetUsbdInfo (struct SWI_STRUCT_UsbdInfo *pUsbdInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPriInfo (struct SWI_STRUCT_PriInfo *pPriInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetModemType (struct SWI_STRUCT_ModemType *pSwiModemType, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDeviceTime (struct SWI_STRUCT_DeviceTime *pDeviceTime, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDeviceID (swi_charp pszDeviceID, swi_uint32 sizeBuffer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetFlashImgInfo (struct SWI_STRUCT_FlashImgInfo *pFlashImgInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetObjRngRev (struct SWI_STRUCT_ObjRngRev *ObjRngRevp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetAvailAirServers (struct SWI_STRUCT_AirServerList *sList)

SWI_API SWI_RCODE	SwiGetBootAndHoldMode (swi_bool *pbootnhold, swi_uint32 timeout)

SWI_API void	SwiGetLastError (swi_char *szError, swi_uint32 sizeBuffer)

SWI_API SWI_RCODE	SwiGetUsbPortName (struct SWI_STRUCT_UsbPortName *sPortNamep)

SWI_API SWI_RCODE	SwiNVUpdateFromFile (SWI_STRUCT_NVUpdateFromFile *pNVUpdateFromFile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiApiUnlock (SWI_STRUCT_ApiUnlock *pApiUnlock, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRemoteDiagAgentSupport (SWI_STRUCT_RDA_SUPPORT *psRDA, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetRemoteDiagAgentEnable (swi_uint8 bEnable, swi_uint8 *pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRemovableMediaSupport (SWI_STRUCT_RM_CONFIG *psRM, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetRemovableMediaSupport (const SWI_STRUCT_RM_CONFIG_SET psRM, swi_uint8 pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSoftModemReset (void)

SWI_API SWI_RCODE	SwiResetToBootHold (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetSdkVersion (swi_charp *sdkversionpp)

SWI_API SWI_RCODE	SwiGetDeviceInformation (struct SWI_STRUCT_DeviceInformation_Request sDeviceInformation_Requestp, struct SWI_STRUCT_DeviceInformation_Response sDeviceInformation_Responsep, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetSwocCfg (struct SWI_STRUCT_GetSwocCfg *pSwocCfg, swi_uint32 timeout)

SWI_RCODE	SwiIntSendnWaitUsbPortNameRequest (struct SWI_STRUCT_UsbPortName *sPortNamep)

void	SwiUpkDeviceInformationResp (swi_uint8 paramfieldp, struct SWI_STRUCT_DeviceInformation_Response pDeviceInfo)

void	SwiUpkSwocCfg (swi_uint8 paramfieldp, struct SWI_STRUCT_GetSwocCfg pSwocCfg)

Detailed Description

This file contains definitions, enumerations, structures and forward declarations for SwiApiCmBasic.c file.

Macro Definition Documentation

#define LENGTH_BootBuildDate 9

#define LENGTH_CommPort 7

#define LENGTH_DriverName 100

#define LENGTH_HardwareId 50

#define LENGTH_ImgInfoImgType 5

Maximum image type infor length

#define LENGTH_ImgInfoProdType 5

Maximum product type info length

#define LENGTH_ImgInfoRelDate 9

Maximum release date info length

#define LENGTH_ImgInfoVer 85

Maximum verion info length

#define LENGTH_IPAddress 16

#define LENGTH_LogFileName 128

#define LENGTH_MacAddress 6

#define LENGTH_MaxPPPString 33

#define LENGTH_ModemName 75

#define LENGTH_PortName 80

#define LENGTH_ProductName 20

#define LENGTH_ProductStr 16

#define LENGTH_SdkPathName 128

#define LENGTH_TimeStamp 16

#define LENGTH_UsbdBuildDate 9

#define LENGTH_UsbdVersion 85

#define MAX_AIR_SERVERS 50 /* Must be < than a frame. */

#define MAX_BAND_GROUPS 50

#define MAX_BAND_LIST 50

#define MAX_NOTIF_LIST 122

#define MAX_NUM_LBS_SV 12

#define MAX_OBJRNGINFOBLOCKS 35

#define NUMVALUE_WIMAX 80216

#define SWI_API_UNLOCK_PWD_LEN 10

Max length of API unlock password

#define SWI_FILENAME_LEN 8

Max length of file name in device file system

#define SWI_RADIOBANDGROUP_AutoBand 0xFFFFFFFFFFFFFFFFull

Auto band

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass0A 0x0000000000000001ull

Band Class 0 A-system only (Cellular)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass0ABo 0x0000000000000003ull

Band Class 0 A & B (Cellular)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass0B 0x0000000000000002ull

Band Class 0 B-system only (Cellular)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass1 0x0000000000000004ull

Band Class 1 (US PCS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass10 0x0000000000000800ull

Band Class 10 (Secondary 800 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass11 0x0000000000001000ull

Band Class 11 (400 MHz European PAMR)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass12 0x0000000000002000ull

Band Class 12 (800 MHz PAMR)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass2 0x0000000000000008ull

Band Class 2 (TACS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass3 0x0000000000000010ull

Band Class 3 (JTACS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass4 0x0000000000000020ull

Band Class 4 (Korean PCS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass5 0x0000000000000040ull

Band Class 5 (450 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass6 0x0000000000000080ull

Band Class 6 (2 GHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass7 0x0000000000000100ull

Band Class 7 (700 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass8 0x0000000000000200ull

Band Class 8 (1800 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass9 0x0000000000000400ull

Band Class 9 (900 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaPcsCellular 0x0000000000000007ull

PCS/Cellular

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm450 0x0000000000010000ull

GSM 450

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm480 0x0000000000020000ull

GSM 480

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm750 0x0000000000040000ull

GSM 750

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm850 0x0000000000080000ull

GSM 850

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmAll 0x0000000001E80000ull

GSM All

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmDcs1800 0x0000000000400000ull

GSM DCS 1800

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmEGsm900 0x0000000000800000ull

GSM EGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmEGsmDcs 0x0000000001C00000ull

GSM EGSM/DCS

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmPcs1900 0x0000000000200000ull

GSM PCS 1900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmPcs850 0x0000000000280000ull

GSM 850/PCS

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmPGsm900 0x0000000001000000ull

GSM PGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmRGsm900 0x0000000000100000ull

GSM RGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaAll_AC503_MC8700 0x000000b300000000ull

WCDMA All AC503/MC8700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

WCDMA 2100/1900/850/800/900

#define SWI_RADIOBANDGROUP_WcdmaAll_EarlyMC8700 0x0000001300000000ull

WCDMA All Early MC8700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaAustrailiaGsmEu 0x0000001101C00000ull

WCDMA Australia/GSM EU

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaAustralia 0x0000001100000000ull

WCDMA Australia

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaEu 0x0000008100000000ull

WCDMA EU

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

WCDMA 900/2100

#define SWI_RADIOBANDGROUP_WcdmaGsmEu 0x0000000101C00000ull

WCDMA/GSM EU

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaGsmNa 0x0000001200280000ull

WCDMA/GSM NA

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIII1700 0x0000000400000000ull

WCDMA III 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIImt2000 0x0000000100000000ull

WCDMA I IMT 2000 (EU)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIIPcs1900 0x0000000200000000ull

WCDMA II PCS 1900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIV1700 0x0000000800000000ull

WCDMA IV 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIX1700 0x0000010000000000ull

WCDMA IX 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaJapan 0x0000002100000000ull

WCDMA Japan

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaNa 0x0000001200000000ull

WCDMA NA

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaV850 0x0000001000000000ull

WCDMA V 850

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVI800 0x0000002000000000ull

WCDMA VI 800

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVII2600 0x0000004000000000ull

WCDMA VII 2600

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVIII900 0x0000008000000000ull

WCDMA VIII 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See Also: SWI_STRUCT_RadioBandInfo; SwiGetCurrentRadioBand

#define SWI_RDA_NAME_MAX 69

Max RDA name length

#define SWI_RDA_VERSION_MAX 32

Max RDA version length

Typedef Documentation

typedef enum eApiUnlockLevel ApiUnlockLevel

Enumeration of unlock level.

typedef enum eApiUnlockResult ApiUnlockResult

Enumeration of unlock result.

typedef struct SWI_STRUCT_ApiUnlock SWI_STRUCT_ApiUnlock

This structure contains API unlock configurations.

See Also: ApiUnlockLevel; ApiUnlockResult

typedef struct SWI_STRUCT_NVUpdateFromFile SWI_STRUCT_NVUpdateFromFile

This structure contains NV update from file configurations and results.

typedef struct SWI_STRUCT_RDA_SUPPORT SWI_STRUCT_RDA_SUPPORT

This structure contains Remote Diagnostics Agent Support configurations.

See Also: SWI_TYPE_RDA_SUPPORT_STATUS; ApiUnlockResult

typedef struct SWI_STRUCT_RM_CONFIG SWI_STRUCT_RM_CONFIG

This structure contains Removable Media configurations.

See Also: SWI_TYPE_REMOVABLE_MEDIA; SWI_TYPE_REMOVABLE_MEDIA

typedef struct SWI_STRUCT_RM_CONFIG_SET SWI_STRUCT_RM_CONFIG_SET

This structure contains Removable Media configurations.

See Also: SWI_STRUCT_RM_CONFIG; SWI_TYPE_REMOVABLE_MEDIA

typedef enum SWI_TYPE_RDA_SUPPORT_STATUS SWI_TYPE_RDA_SUPPORT_STATUS

Enumeration of Remote Diagnostics Agent enableing status.

typedef enum SWI_TYPE_REMOVABLE_MEDIA SWI_TYPE_REMOVABLE_MEDIA

Enumeration Removable Media support.

typedef enum eUpdateFromFileStatus UpdateFromFileStatus

Enumeration of NV update from file status

Enumeration Type Documentation

enum eApiUnlockLevel

Enumeration of unlock level.

Enumerator
API_UNLOCK_OEM	OEM unlock
API_UNLOCK_SWI	SWI unlock

enum eApiUnlockResult

Enumeration of unlock result.

Enumerator
API_UNLOCK_SUCCESS	Action succeeded
API_UNLOCK_PWD_INVALID	Invalid password key

enum eUpdateFromFileStatus

Enumeration of NV update from file status

Enumerator
FILE_UPDATE_SUCCESS	Update success
FILE_NOT_FOUND	File not found
FILE_INCORRECT_SIZE	Incorrect size
FILE_INCORRECT_HEADER	Incorrect header
FILE_INVALID_REVISION	Invalid revision

enum SWI_TYPE_CNSsupported

CNS supported by FW application flag.

Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_CNSsupported information request.

See Also: SWI_TYPE_DeviceInformationType; SwiGetDeviceInformation

Enumerator
SWI_CNSSUPPORTED_Yes	0x00 - Modem reset causes PnP device removal/arrival or media disconnect/reconnect notifications on the host platform
SWI_CNSSUPPORTED_No	0x01 - Modem reset does not trigger PnP device removal/arrival or media disconnect/reconnect notifications on the host platform

enum SWI_TYPE_DaylightSavings

Enumeration of daylight savings.

See Also: SWI_STRUCT_DeviceTime

Enumerator
SWI_DAYLIGHTSAVINGS_None	No daylight savings
SWI_DAYLIGHTSAVINGS_PlusOneHour	Plus one hour
SWI_DAYLIGHTSAVINGS_PlusTwoHour	Plus two hours

enum SWI_TYPE_Device

An enumeration of supported device types.

Includes both GSM and CDMA PC cards, embedded devices, and MP line of products.

See Also: SWI_STRUCT_AirServer; See sample code, ConnectApi

Enumerator
SWI_DEVICE_None	Unsupported device
SWI_DEVICE_AC550	AirCard 550 (CDMA)
SWI_DEVICE_AC575	AirCard 575 (CDMA)
SWI_DEVICE_AC580	AirCard 580 (CDMA)
SWI_DEVICE_AC595	AirCard 595 (CDMA)
SWI_DEVICE_AC597	AirCard 597 (CDMA)
SWI_DEVICE_AC710	AirCard 710 (GSM)
SWI_DEVICE_AC750	AirCard 750 (GSM)
SWI_DEVICE_AC775	AirCard 775 (GSM)
SWI_DEVICE_AC850	AirCard 850 (GSM)
SWI_DEVICE_AC860	AirCard 860 (GSM)
SWI_DEVICE_AC875	AirCard 875 (GSM)
SWI_DEVICE_AC880	AirCard 880 (GSM)
SWI_DEVICE_AC881	AirCard 881 (GSM)
SWI_DEVICE_MC5720	MC5720 (CDMA)
SWI_DEVICE_MC5725	MC5725 (CDMA)
SWI_DEVICE_MC5727	MC5727 (CDMA)
SWI_DEVICE_MC5728	MC5728 (CDMA)
SWI_DEVICE_SL501X	SL5010 and SL5011 (CDMA)
SWI_DEVICE_MC8755	MC8775 (GSM)
SWI_DEVICE_MC8765	MC8765 (GSM)
SWI_DEVICE_MC8775	MC8775 (GSM)
SWI_DEVICE_MC8780	MC8780 (GSM)
SWI_DEVICE_MC8781	MC8781 (GSM)
SWI_DEVICE_MC8785	MC8785 (GSM)
SWI_DEVICE_MC8790	MC8790 (GSM)
SWI_DEVICE_MC8791	MC8791 (GSM)
SWI_DEVICE_MC8700	MC8700 (GSM)
SWI_DEVICE_MC8704	MC8704 (GSM)
SWI_DEVICE_MC8705	MC8705 (GSM)
SWI_DEVICE_MC8777	MC8777 (GSM)
SWI_DEVICE_MC8790V	MC8790V (GSM)
SWI_DEVICE_MC8801	MC8801 (GSM)
SWI_DEVICE_SL8080	SL8080 (GSM)
SWI_DEVICE_SL8081	SL8081 (GSM)
SWI_DEVICE_SL8082	SL8082 (GSM)
SWI_DEVICE_SL8083	SL8083 (GSM)
SWI_DEVICE_SL8084	SL8084 (GSM)
SWI_DEVICE_SL8085	SL8085 (GSM)
SWI_DEVICE_SL8090	SL8090 (GSM)
SWI_DEVICE_SL8091	SL8091 (GSM)
SWI_DEVICE_SL8092	SL8092 (GSM)
SWI_DEVICE_SL8093	SL8093 (GSM)
SWI_DEVICE_EM5625	EM5625 (CDMA)
SWI_DEVICE_EM5725	EM5725 (CDMA)
SWI_DEVICE_EM8780	EM8780 (GSM)
SWI_DEVICE_EM8781	EM8781 (GSM)
SWI_DEVICE_M81A	M81A (GSM)
SWI_DEVICE_M81B	M81B (GSM)
SWI_DEVICE_MP555	MP555 (CDMA)
SWI_DEVICE_MP595	MP595 (CDMA)
SWI_DEVICE_MP750	MP750 (GSM)
SWI_DEVICE_MP775	MP775 (GSM)
SWI_DEVICE_MP875	MP875 (GSM)
SWI_DEVICE_MP880	MP880 (GSM)
SWI_DEVICE_MP881	MP881 (GSM)
SWI_DEVICE_AC597E	AirCard 595E (CDMA)
SWI_DEVICE_AC598E	AirCard 598E (CDMA)
SWI_DEVICE_AC875E	AirCard 875E (GSM)
SWI_DEVICE_AC880E	AirCard 880E (GSM)
SWI_DEVICE_AC881E	AirCard 881E (GSM)
SWI_DEVICE_AC885E	AirCard 885E (GSM)
SWI_DEVICE_AC886E	AirCard 886E (GSM)
SWI_DEVICE_AC595U	AirCard 595U (CDMA)
SWI_DEVICE_T598	Tiger 598 (CDMA)
SWI_DEVICE_T11	Tiger 11 (CDMA)
SWI_DEVICE_AC802	Owl (CDMA)
SWI_DEVICE_AC875U	AirCard 875U (GSM)
SWI_DEVICE_AC880U	AirCard 880U (GSM)
SWI_DEVICE_AC881U	AirCard 881U (GSM)
SWI_DEVICE_C885	Compass 885 (GSM)
SWI_DEVICE_C886	Compass 886 (GSM)
SWI_DEVICE_C888	Compass 888 (GSM)
SWI_DEVICE_C889	Compass 889 (GSM)
SWI_DEVICE_K888	Karbon 888 (GSM)
SWI_DEVICE_K889	Karbon 889 (GSM)
SWI_DEVICE_C22	Compass 22 (GSM)
SWI_DEVICE_C23	Compass 33 (GSM)
SWI_DEVICE_K22	Karbon 22 (GSM)
SWI_DEVICE_K23	Karbon 23 (GSM)
SWI_DEVICE_USB303	USB 303 (GSM)
SWI_DEVICE_USB304	USB 304 (GSM)
SWI_DEVICE_USB305	USB 305 (GSM)
SWI_DEVICE_USB306	USB 306 (GSM)
SWI_DEVICE_USB307	USB 307 (GSM)
SWI_DEVICE_USB308	USB 308 (GSM)
SWI_DEVICE_CHspa	Compass HSPA (GSM)
SWI_DEVICE_MassStorage	Mass storage device
SWI_DEVICE_UNIFIEDPID	This must be the last item

enum SWI_TYPE_DeviceInformationType

Enumeration of device information types.

Used by SWI_STRUCT_DeviceInformation_Request and SWI_STRUCT_DeviceInformation_Response to indicate the type of data being requested in SwiGetDeviceInformation.

See Also: SWI_STRUCT_DeviceInformation_Request; SWI_STRUCT_DeviceInformation_Response; SwiGetDeviceInformation

Enumerator
SWI_DEVICEINFORMATION_Technology	Technology type (CDMA, GPRS)
SWI_DEVICEINFORMATION_Product	Product string
SWI_DEVICEINFORMATION_FrmDwlProtocol	Firmware download protocol
SWI_DEVICEINFORMATION_DeviceReEnum	Device re-enumeration
SWI_DEVICEINFORMATION_CNSsupported	CNS supported by FW application

enum SWI_TYPE_DeviceReEnum

Enumeration of protocols to be used for firmware download.

Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_DeviceReEnum information request.

See Also: SWI_TYPE_DeviceInformationType; SwiGetDeviceInformation

Enumerator
SWI_DEVICEREENUM_Trigger_Remove	0x00 - Modem reset causes PnP device removal/arrival or media disconnect/reconnect notifications on the host platform
SWI_DEVICEREENUM_Trigger_NoRemove	0x01 - Modem reset does not trigger PnP device removal/arrival or media disconnect/reconnect notifications on the host platform

enum SWI_TYPE_FrmDlwProtocol

Enumeration of protocols to be used for firmware download.

Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_FrmDwlProtocol information request.

See Also: SWI_TYPE_DeviceInformationType; SwiGetDeviceInformation

Enumerator
SWI_FRMDLWPROTOCOL_One	0x00 - Host must use firmware download protocol 1 to download images to this modem
SWI_FRMDLWPROTOCOL_Two	0x01 - Host must use firmware download protocol 2 to download images to this modem

enum SWI_TYPE_ModuleReqReason

Enumeration of power down request reasons.

This enumeration is used by SWI_STRUCT_RadioPower

See Also: SWI_STRUCT_RadioPower; SWI_NOTIFY_RadioPower

Enumerator
SWI_MODULEREQREASON_NoReason	No reason given (e.g. when no requests are being made Temperature exceeds limit
SWI_MODULEREQREASON_Temperature	Voltage exceeds limit
SWI_MODULEREQREASON_Battery	Network related reason
SWI_MODULEREQREASON_Network	All other reasons
SWI_MODULEREQREASON_Other

enum SWI_TYPE_Month

Enumeration of months of a year

See Also: SWI_STRUCT_DeviceTime

Enumerator
SWI_MONTH_Jan	January
SWI_MONTH_Feb	February
SWI_MONTH_Mar	March
SWI_MONTH_Apr	April
SWI_MONTH_May	May
SWI_MONTH_Jun	June
SWI_MONTH_Jul	July
SWI_MONTH_Aug	August
SWI_MONTH_Sep	September
SWI_MONTH_Oct	October
SWI_MONTH_Nov	November
SWI_MONTH_Dec	December

enum SWI_TYPE_ObjIdRngSpecifier

Enumeration of object ID range specifiers used in SWI_STRUCT_OBJRNGREV_InfoBlock

See Also: SWI_STRUCT_OBJRNGREV_InfoBlock

Enumerator
OBJIDRNGSPECIFIER_Cwe	CWE (0x0000 - 0x0EFF)
OBJIDRNGSPECIFIER_CweLbs	CWE LBS (0x0F00 - 0x0F7F)
OBJIDRNGSPECIFIER_Gprs	GPRS (0x1000 - 0x1FFF)
OBJIDRNGSPECIFIER_Cdma	CDMA (0x1000 - 0x5FFF)
OBJIDRNGSPECIFIER_Mp	MP (0x6000 - 0x6FFF)
OBJIDRNGSPECIFIER_Umts	UMTS (0x7000 - 0x70FF)
OBJIDRNGSPECIFIER_CweDm	CWE DM (0x0F80 - 0x0FFF)

enum SWI_TYPE_ProductClass

An enumeration of product classes

Product classes are broken into the following categories PC Cards (PCMCIA, express cards, USB), embedded modules (MC, EM, M81), and MP.

Supports PC cards, embedded devices, and MP line of products.

See Also: SWI_STRUCT_AirServerExtended; See sample code, ConnectApi

Enumerator
SWI_PRODUCTCLASS_Unknown
SWI_PRODUCTCLASS_PcCard
SWI_PRODUCTCLASS_Embedded
SWI_PRODUCTCLASS_Mp

enum SWI_TYPE_RadioBand

Enumeration of radio bands.

This enumeration is used by SWI_STRUCT_RadioBandInfo and SWI_STRUCT_GmsCellMeasure.

See Also: SWI_STRUCT_RadioBandInfo; SWI_STRUCT_GsmCellMeasure

Enumerator
SWI_RADIOBAND_CdmaClass0	CDMA Band Class 0
SWI_RADIOBAND_CdmaClass1	CDMA Band Class 1
SWI_RADIOBAND_CdmaClass2	CDMA Band Class 2
SWI_RADIOBAND_CdmaClass3	CDMA Band Class 3
SWI_RADIOBAND_CdmaClass4	CDMA Band Class 4
SWI_RADIOBAND_CdmaClass5	CDMA Band Class 5
SWI_RADIOBAND_CdmaClass6	CDMA Band Class 6
SWI_RADIOBAND_CdmaClass7	CDMA Band Class 7
SWI_RADIOBAND_CdmaClass8	CDMA Band Class 8
SWI_RADIOBAND_CdmaClass9	CDMA Band Class 9
SWI_RADIOBAND_CdmaClass10	CDMA Band Class 10
SWI_RADIOBAND_CdmaClass11	CDMA Band Class 11
SWI_RADIOBAND_CdmaClass12	CDMA Band Class 12
SWI_RADIOBAND_Gsm450	GSM 450 Band
SWI_RADIOBAND_Gsm480	GSM 480 Band
SWI_RADIOBAND_Gsm750	GSM 750 Band
SWI_RADIOBAND_Gsm850	GSM 850 Band
SWI_RADIOBAND_GsmEGsm900	GSM E-GSM 900 Band
SWI_RADIOBAND_GsmPGsm900	GSM P-GSM 900 Band
SWI_RADIOBAND_GsmRGsm900	GSM R-GSM 900 Band
SWI_RADIOBAND_GsmDcs1800	GSM DCS 1800 Band
SWI_RADIOBAND_GsmPcs1900	GSM DCS 1900 Band
SWI_RADIOBAND_WcdmaIImt2000	WCDMA I IMT 2000
SWI_RADIOBAND_WcdmaIIPcs1900	WCDMA II PCS 1900
SWI_RADIOBAND_WcdmaIIIDcs1800	WCDMA III DCS 1800
SWI_RADIOBAND_WcdmaIV1700	WCDMA IV 1700
SWI_RADIOBAND_WcdmaV850	WCDMA V 850
SWI_RADIOBAND_WcdmaVI800	WCDMA VI 800
SWI_RADIOBAND_WcdmaVII2600	WCDMA VII 2600
SWI_RADIOBAND_WcdmaVIII900	WCDMA VIII 900
SWI_RADIOBAND_WcdmaIX1700	WCDMA IX 1700
SWI_RADIOBAND_Invalid	Invalid band

enum SWI_TYPE_RadioBatteryState

Enumeration of radio battery states

This enumeration is used by SWI_STRUCT_RadioBattery.

See Also: SWI_STRUCT_RadioBattery; SWI_NOTIFY_RadioBattery

Enumerator
SWI_RADIOBATTERYSTATE_Normal	Normal state
SWI_RADIOBATTERYSTATE_LowWarning	Low battery warning state
SWI_RADIOBATTERYSTATE_LowCrit	Low battery critical state
SWI_RADIOBATTERYSTATE_HighCrit	High battery critical state

enum SWI_TYPE_RadioPowerMode

Enumeration of radio power modes.

This enumeration is used by SWI_STRUCT_RadioPower.

See Also: SWI_STRUCT_RadioPower; SWI_NOTIFY_RadioPower

Enumerator
SWI_RADIOPOWERMODE_Low	Radio is in low power mode
SWI_RADIOPOWERMODE_Online	Radio is online (full power mode)

enum SWI_TYPE_RadioPowerReason

Low power modem reason bit mask values.

Supports PC cards, embedded devices, and MP line of products.

See Also: SWI_STRUCT_RadioPower; SWI_NOTIFY_RadioPower

Enumerator
SWI_RADIOPOWERREASON_WDISABLE	W_DISABLED is asserted User request
SWI_RADIOPOWERREASON_UserRequest	Out of operational temperature range
SWI_RADIOPOWERREASON_Temperature	Out of operational supply voltage range
SWI_RADIOPOWERREASON_Battery

enum SWI_TYPE_RadioTempState

Enumeration of radio temperature states

This enumeration is used by the SWI_STRUCT_RadioTempState structure.

See Also: SWI_STRUCT_RadioTempState; SWI_NOTIFY_RadioTempState; SwiGetRadioTempState

Enumerator
SWI_RADIOTEMPSTATE_Normal	Normal temperature state
SWI_RADIOTEMPSTATE_HighWarning	High temperature warning state
SWI_RADIOTEMPSTATE_HighCrit	High temperature critical state
SWI_RADIOTEMPSTATE_LowCrit	Low temperature critical state

enum SWI_TYPE_RadioType

Enumeration of radio technologies.

See Also: SWI_STRUCT_RadioBandInfo

Enumerator
SWI_RADIOTYPE_1xrtt	1xRTT
SWI_RADIOTYPE_Evdo	EVDO
SWI_RADIOTYPE_GsmWcdma	GSM/WCDMA

enum SWI_TYPE_RDA_SUPPORT_STATUS

Enumeration of Remote Diagnostics Agent enableing status.

Enumerator
RDA_STATUS_NOT_SUPPORTED	Not supported
RDA_STATUS_DISABLED	Disabled (not running)
RDA_STATUS_ENABLED	Enabled

enum SWI_TYPE_REMOVABLE_MEDIA

Enumeration Removable Media support.

Enumerator
REMOVABLE_MEDIA_MINI_SD	Mini-SD supported
REMOVABLE_MEDIA_MICRO_SD	Micro-SD supported

enum SWI_TYPE_RequestStatus

Enumeration indicates return status of request.

Enumerator
SWI_REQUESTSTATUS_SUCCESS
SWI_REQUESTSTATUS_UnknownType
SWI_REQUESTSTATUS_GenFailure

enum SWI_TYPE_Technology

Enumeration of device CNS object technology range.

Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_Technology information request.

See Also: SWI_TYPE_DeviceInformationType; SwiGetDeviceInformation

Enumerator
SWI_TECHNOLOGY_Unknown
SWI_TECHNOLOGY_CDMA
SWI_TECHNOLOGY_GSM

enum SWI_TYPE_WeekDay

Enumeration of days of the week.

See Also: SWI_STRUCT_DeviceTime

Enumerator
SWI_WEEKDAY_Mon	Monday
SWI_WEEKDAY_Tue	Tuesday
SWI_WEEKDAY_Wed	Wednesday
SWI_WEEKDAY_Thu	Thursday
SWI_WEEKDAY_Fri	Friday
SWI_WEEKDAY_Sat	Saturday
SWI_WEEKDAY_Sun	Sunday

enum SWI_TYPE_WirelessTech

An enumeration of wireless mobile technologies

Wireless technologies including CDMA and GSM

See Also: SWI_STRUCT_AirServerExtended; See sample code, ConnectApi

Enumerator
SWI_WIRELESSTECH_Unknown
SWI_WIRELESSTECH_Cdma
SWI_WIRELESSTECH_Gsm
SWI_WIRELESSTECH_Wifi
SWI_WIRELESSTECH_Wimax

enum TYPE_FlashImgInfo_Result

An enumeration of flash image result codes.

Supports PC cards, embedded devices, and MP line of products.

See Also: SWI_STRUCT_FlashImgInfo

Enumerator
FLASHIMGINFORESULT_Success	Action succeeded
FLASHIMGINFORESULT_UnsupportedImgType	Unsupported image type
FLASHIMGINFORESULT_ImgNotFound	Image not found

Function Documentation

SWI_API SWI_RCODE SwiApiStartup ( struct SWI_STRUCT_ApiStartup * pOpenParams )

This function is used to start the API sub-system.

If an error is returned or to re-initialize the API, SwiApiShutdown must be called before calling this function again.

After calling this function, SwiGetAvailAirServers can be called to retrieve a list of air servers (devices). SwiSelectAirServer must be used to commit to a specific device before calling any control and status API functions.

Looking in the system log after a failure may provide more details about the cause

Note: SwiSelectAirServer is not implemented in LinuxSDKV2

Parameters

pOpenParams,: [IN] parameters to initialize the API in different modes

Returns: SWI_RCODE_OK - API initialized successfully; SWI_RCODE_FAILED - The API sub-system was not initialized successfully.; SWI_RCODE_SYSTEM_ERROR - This may be due to limited system resources when the API requested memory from the OS.; SWI_RCODE_BUSY - If another application has the SDK open. Only 1 application at a time is allowed; See SWI_RCODE for other error return codes

SWI_API SWI_RCODE SwiApiUnlock	(	SWI_STRUCT_ApiUnlock *	pApiUnlock,
		swi_uint32	timeout
	)

This function allows the host to unlock access to various password-protected other SWI APIs. Those APIs can be used to configure carrier-specific parameters and to enable limited diagnostic capabilities. Those APIs are required by OEMs and device provisioning applications. This object is not intended for use by end-users..

Typical cases to use this API

Before upload PRL with SwiSetPRL

Parameters

pApiUnlock[IN]	See SWI_STRUCT_ApiUnlock.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetAvailAirServers ( struct SWI_STRUCT_AirServerList * sList )

This function is used to retrieve a list of available air servers.

Air servers are deemed available if the appropriate driver interface, is found. These interfaces must be capable of supporting a control and status command path to the air server. SwiSelectAirServer must be called to bind to the air server before any command and status functions are called.

Air servers locked for exclusive use by an application are also included.

Parameters

[OUT] sList: A structure of type SWI_STRUCT_AirServerList which contains a list of available air servers.

Returns: SWI_RCODE_OK: List of available servers is successfully retrieved.; SWI_RCODE_FAILED: Failed to retrieve the list of available air servers.

See Also: SWI_STRUCT_AirServerList; SwiSelectAirServer; See sample code, ConnectApi

SWI_API SWI_RCODE SwiGetBootAndHoldMode	(	swi_bool *	pbootnhold,
		swi_uint32	timeout
	)

Fetch the boot and hold state of the modem, if it's connected. There is a small window in which this information will be inaccurate if the state of the modem changes while this function is being called. However, the notification called SWI_NOTIFY_AirServerChange will always indicate a change in the execution state of the modem and interested callers should re-issue this Api to learn the modem's new Boot and Hold state, if they are expecting it to change.

Parameters

pbootnhold	[OUT]: TRUE - Modem is operating in boot-and-hold mode FALSE - Modem is executing its application
timeout	[IN]: Function timeout in milliseconds

Returns: SWI_RCODE_OK: pbootnhold contains a valid boolean value; SWI_RCODE_DEVICE_UNAVAIL: The modem is either not connected to the host or the SDK hasn't detected it yet. Wait to receive the notification SWI_NOTIFY_AirServerChange before retrying this request

SWI_API SWI_RCODE SwiGetBootloaderBuildDate	(	swi_charp	szBLBldDate,
		swi_uint32 *	nLength,
		swi_uint32	timeout
	)

This function is used to retrieve the boot loader build date.

Parameters

szBLBldDate,:	[OUT] Pointer to store the build date information
nLength,:	[IN/OUT] Size of buffer available to store the build date information/required buffer space
Timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_SMALL_BUF is returned if the specified buff isn't large enough to store the entire build date information. Check nLength to see the required buffer size.; See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetBootVersion	(	swi_charp	szBVVersion,
		swi_uint32	sizeBuffer,
		swi_uint32	timeout
	)

This function returns the device's firmware loader version in a string.

Parameters

szBVVersion,:	[OUT] Bootloader version (NULL terminated). The version string varies in length. It is recommended that a character string of 80 characters be allocated to store this return value.
sizeBuffer,:	[IN] Size of buffer provided for the bootloader version
timeout,:	[IN] Response timeout value in milliseconds

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetCurrentRadioBand	(	struct SWI_STRUCT_RadioBandList *	pRadioBand,
		swi_int32	timeout
	)

This function is used to determine the current radio band(s) the device is currently using.

This API replaces SwiGetBandInfo.

For GSM/WCDMA devices and CDMA/EVDO devices operating in non-hybrid mode operation, only one band is supported at a time. In these cases, the band info list will only contain a single entry.

Parameters

pRadioBand,:	[OUT] Pointer to a SWI_STRUCT_RadioBandList structure to store the list of current radio bands
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioBandList

SWI_API SWI_RCODE SwiGetDeviceID	(	swi_charp	pszDeviceID,
		swi_uint32	sizeBuffer,
		swi_uint32	timeout
	)

This function returns the device's unique identity as a string. The returned value is the ESN (Electronic Serial Number) or EID (Electronic Identity) of the modem.

The ESN is in the form of an 14-character string of decimal numerals. The string is null terminated (adding a 15th byte to the length). The content of the ESN includes several concatenated components, as specified for GPRS.

Parameters

szDeviceID,:	[OUT] A string representing the Device ID (NULL terminated).
sizeBuffer,:	[IN] Size of buffer provided for the device ID. A buffer of 15 bytes is recommended.
timeout,:	[IN] Response timeout value in milliseconds

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetDeviceInformation	(	struct SWI_STRUCT_DeviceInformation_Request *	sDeviceInformation_Requestp,
		struct SWI_STRUCT_DeviceInformation_Response *	sDeviceInformation_Responsep,
		swi_uint32	timeout
	)

This function is used to get fundamental information from the modem.

The information returned is determined by setting the eDeviceInformationType field of sDeviceInformation_Request.

Parameters

[OUT]	sDeviceInformation_Request: struct must be filled out to select type of information returned.
[IN]	sDeviceInformation_Response: struct returned will contain the requested information.
[IN]	timeout: Response timeout value in milliseconds.

Returns: See SWI_RCODE for additional information.

See Also: SWI_STRUCT_DeviceInformation_Request; SWI_STRUCT_DeviceInformation_Response

SWI_API SWI_RCODE SwiGetDeviceTime	(	struct SWI_STRUCT_DeviceTime *	pDeviceTime,
		swi_uint32	timeout
	)

This function is used to retrieve the system time on the device.

Parameters

pDeviceTime,:	[OUT] Pointer to a SWI_STRUCT_DeviceTime structure to store the system time from the device.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been received.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_DeviceTime

SWI_API SWI_RCODE SwiGetFirmwareBuildDate	(	swi_charp	szBuildDate,
		swi_uint32	sizeBuffer,
		swi_uint32	timeout
	)

This function returns the date the device's firmware was created.

Parameters

szBuildDate,:	[OUT] Firmware build date. The firmware build date string is in the form of MM/DD/YY.
sizeBuffer,:	[IN] Size of buffer provided for the firmware build date
timeout,:	[IN] Response timeout value in milliseconds

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetFirmwareVersion	(	swi_charp	szFWVersion,
		swi_uint32	sizeBuffer,
		swi_uint32	timeout
	)

This function returns the device's firmware version in a string.

The firmware version string varies in length. It is recommended that a character string of 80 characters be allocated to store this return value

Parameters

szFWVersion,:	[OUT] Firmware version (NULL terminated)
sizeBuffer,:	[IN] Size of buffer provided for the firmware version.
timeout,:	[IN] Response timeout value in milliseconds

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetFlashImgInfo	(	struct SWI_STRUCT_FlashImgInfo *	pFlashImgInfo,
		swi_uint32	timeout
	)

This function is used to retrieve firmware flash information from the device.

Parameters

[IN/OUT]	pFlashImgInfo: Pointer to a SWI_STRUCT_FlashImgInfo which specifies the flash image type to retrieve. This structure also contains the flash image information returned from the device. See SWI_STRUCT_FlashImgInfo for additional information.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The device has received the request. See SWI_STRUCT_FlashImgInfo::eResult for actual request result.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_FlashImgInfo

SWI_API SWI_RCODE SwiGetHardwareVersion	(	swi_charp	szHWVersion,
		swi_uint32	sizeBuffer,
		swi_uint32	timeout
	)

This function returns the device's hardware version in a string.

Parameters

szHWVersion,:	[OUT] Hardware version (NULL terminated). The firmware version string varies in length. It is recommended that a character string of 80 characters be allocated to store this return value. The returned string is null terminated.
sizeBuffer,:	[IN] Size of buffer provided for the hardware version
timeout,:	[IN] Response timeout value in milliseconds

Returns: See SWI_RCODE for additional information.

SWI_API void SwiGetLastError	(	swi_char *	szError,
		swi_uint32	sizeBuffer
	)

This function is used to retrieve the last error that occurred during a CnS transaction.

Recommended length for the CnS buffer is 256 bytes.

Parameters

szError,:	[OUT] CnS transaction error
sizeBuffer,:	[IN] length of buffer provided for the CnS transaction error

Returns: None

SWI_API SWI_RCODE SwiGetModemType	(	struct SWI_STRUCT_ModemType *	pSwiModemType,
		swi_uint32	timeout
	)

This function is used to retrieve modem type information.

Parameters

pSwiModemType,:	[IN/OUT] Removable media configuration
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiGetObjRngRev	(	struct SWI_STRUCT_ObjRngRev *	ObjRngRevp,
		swi_uint32	timeout
	)

This function is used to retrieve the object ID range revision on the modem and the API.

Parameters

sObjRngRev,:	[OUT] Object range revision information
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiGetPriInfo	(	struct SWI_STRUCT_PriInfo *	pPriInfo,
		swi_uint32	timeout
	)

This function is used to retrieve PRI information of the device

Parameters

pPriInfo,: [OUT] PRI information timeout: [IN] response timeout value is 1000 milliseconds

Returns: SWI_RCODE_OK - the request has been received.; See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiGetRadioBandCfg	(	struct SWI_STRUCT_RadioBandConfig *	pRadioBand,
		swi_int32	timeout
	)

This function is used to retrieve the current radio band setting of the device along with the list of all the device supported radio bands.

This API replaces SwiGetBandInfo.

Parameters

pRadioBand,:	[OUT] A pointer to a SWI_STRUCT_RadioBandConfig structure to store the current radio band configuration.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioBandConfig

SWI_API SWI_RCODE SwiGetRadioBattery	(	struct SWI_STRUCT_RadioBattery *	pRadioBattery,
		swi_uint32	timeout
	)

This function is used to retrieve the current radio battery state.

Voltage changes can be monitored with SWI_NOTIFY_RadioBattery.

Parameters

pRadioBattery,:	[OUT] A pointer to a SWI_STRUCT_RadioBattery structure to store the current radio battery state.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioBattery; SWI_NOTIFY_RadioBattery

SWI_API SWI_RCODE SwiGetRadioPower	(	struct SWI_STRUCT_RadioPower *	pRadioPower,
		swi_uint32	timeout
	)

This function is used to retrieve the current radio power mode.

Parameters

pRadioPower,:	[OUT] Pointer to a SWI_STRUCT_RadioPower structure to store the current radio power setting.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioPower

SWI_API SWI_RCODE SwiGetRadioTempState	(	struct SWI_STRUCT_RadioTempState *	pRadioTemp,
		swi_uint32	timeout
	)

This function is used to retrieve the current radio temperature state.

UMTS AirCards will always report that the temperature state is normal. Temperature state changes can be monitored with SWI_NOTIFY_RadioTempState.

Parameters

pRadioTemp,:	[OUT] Pointer to a SWI_STRUCT_RadioTempState to store the current radio temperature state.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioTempState; SWI_NOTIFY_RadioTempState

SWI_API SWI_RCODE SwiGetRemoteDiagAgentSupport	(	SWI_STRUCT_RDA_SUPPORT *	psRDA,
		swi_uint32	timeout
	)

This function retrieves the modem's Remote Diagnostics Agent support information.

Parameters

psRDA[OUT]	Contains RDA support information. See SWI_STRUCT_RDA_SUPPORT.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetRemovableMediaSupport	(	SWI_STRUCT_RM_CONFIG *	psRM,
		swi_uint32	timeout
	)

This function retrieves the modem's Removable Media support information

Parameters

psRM[OUT]	Contains RM support information. See SWI_STRUCT_RM_CONFIG.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetSdkVersion ( swi_charp * sdkversionpp )

This function is used to retrieve the version of the SDK.

Parameters

sdkversionpp : [OUT] pointer to pointer to returned string.

Returns: SWI_RCODE_OK: Information successfully retrieved.; See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiGetSwocCfg	(	struct SWI_STRUCT_GetSwocCfg *	pSwocCfg,
		swi_uint32	timeout
	)

This function is used to retrieve Software on Card (SWoC) configuration.

Configuration items returned determine if: -SWoC/TRU-Install feature supported/enabled -SWoC/TRU-Install media in modem mode supported/enabled -bypassing of the SWoC/TRU-Install feature after a software reboot is performed on the device

Some devices require that the OEM level is unlocked before some or all of the request options are attempted.

In order for the ‘SWoC access in modem mode’ feature to be enabled, general overall ‘SWoC’ TRU-Install support must be both supported by the product and currently enabled.

Parameters

pSwocCfg	[IN/OUT]
timeout	[IN]

Returns: SWI_RCODE_OK: SWoC configuration successfully retrieved; See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiGetUsbdInfo	(	struct SWI_STRUCT_UsbdInfo *	pUsbdInfo,
		swi_uint32	timeout
	)

This function is used to retrieve the USB descriptor build information.

Parameters

pUsbd,: [OUT] structure to store USB descriptor build information

Returns: : See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetUsbPortName ( struct SWI_STRUCT_UsbPortName * sPortNamep )

This function is used to retrieve the Port Name for the data port.

Parameters

[OUT] szPortName: Port Names of the device.

Returns: SWI_RCODE_OK: List of available port names is successfully retrieved.; SWI_RCODE_FAILED: Failed to retrieve the list of available port names.

SWI_RCODE SwiIntSendnWaitUsbPortNameRequest ( struct SWI_STRUCT_UsbPortName * sPortNamep )

SWI_API SWI_RCODE SwiNVUpdateFromFile	(	SWI_STRUCT_NVUpdateFromFile *	pNVUpdateFromFile,
		swi_uint32	timeout
	)

This function Forces the modem to perform a NV update from an EFS file.

Note that this function does not return any data via pNVUpdateFromFile. Caller need to set the sizeStruct and szFileName member of pNVUpdateFromFile. The other members of SWI_STRUCT_NVUpdateFromFile are for notification use only.

Parameters

pNVUpdateFromFile[IN]	NV update settings. See SWI_STRUCT_NVUpdateFromFile.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiResetToBootHold ( swi_uint32 timeout )

This function causes the modem to reset into boot and hold operation. Boot and Hold operation is used for upgrading the modem's firmware. For USB-based devices, the driver will unload and reload on a modem reset.

The caller will receive a response very quickly, but receipt of a response does not indicate the modem's entry into boot and hold mode, only that the command was sent to the modem. The caller's next step should be to await a SWI_NOTIFY_AirServerChange message and when it's received, call SwiGetBootAndHoldMode() to determine the modem's operating state

If the modem is already in boot and hold operation when this command is issued, there will be no effect. The modem does not respond to reset requests when operating in boot and hold mode.

Parameters

timeout[IN],: response timeout value in milliseconds

Return: SWI_RCODE_OK - request was successfully sent to the modem SWI_RCODE_REQUEST_TIMEOUT - request timed out See SWI_RCODE for other error return codes

SWI_API SWI_RCODE SwiSetRadioBandCfg	(	swi_uint64	nRadioBandGroup,
		swi_int32	timeout
	)

This function is used to request a new radio band setting.

This API replaces SwiSetBandInfo.

Setting the frequency band may cause a modem reset. The caller should use SwiGetRadioBandCfg to retrieve the list of supported bands before calling SwiSetRadioBandCfg.

Parameters

nRadioBandGroup,:	[IN] A bit mask value which specifies the radio band group to use. See SWI_RADIOBANDGROUP_xxx definitions.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_RADIOBANDGROUP_xxx

SWI_API SWI_RCODE SwiSetRadioPower	(	struct SWI_STRUCT_RadioPower *	pRadioPower,
		swi_uint32	timeout
	)

This function is used to configure the radio power mode.

Parameters

pRadioPower,:	[IN] A pointer to a SWI_STRUCT_RadioPower structure which specifies the new radio power setting.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RadioPower

SWI_API SWI_RCODE SwiSetRemoteDiagAgentEnable	(	swi_uint8	bEnable,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function enables/disables the modem's Remote Diagnostics Agent.

Parameters

bEnable[IN]	Disable = 0, Enable = 1;
pStatus[OUT]	0=Success, 1=Failed unspecified,2=Failed security access denied.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetRemovableMediaSupport	(	const SWI_STRUCT_RM_CONFIG_SET *	psRM,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function sets the modem's Removable Media support information.

Parameters

psRM[IN]	Contains RM support config. See SWI_STRUCT_RM_CONFIG_SET.
pStatus[OUT]	Set status.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSoftModemReset ( void )

This function causes the modem to undergo a soft reset. SWI_NOTIFY_AirServerChange is generated after the reset has completed. Note that the driver may also unload and reload when a modem reset occurs.

This API will return very quickly but this does not indicate that the modem has reset, only that the reset command has been sent to the modem. When the modem finally resets a SWI_NOTIFY_AirServerChange notification will be generated. Callers may want to consider calling SwiGetBootAndHoldMode() to determine the operating state of the modem, however, modem resets generated by this API will always bring the modem back into full operation after the reset is complete

If the modem is already in boot and hold operation when this command is issued, there will be no effect. The modem does not respond to reset requests when operating in boot and hold mode.

Parameters

None

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiTerminateSDK ( void )

Gracefully terminate the SDK process

The SDK process is designed to run forever once it is started, behaving as a daemon under Linux in the truest sense of the word. However in some applications there may be a requirement to shut down the daemon when a particular task has completed and this API allows an application to gracefully shut down the daemon

Parameters

None

Returns: None; SWI_RCODE_OK

void SwiUpkDeviceInformationResp	(	swi_uint8 *	paramfieldp,
		struct SWI_STRUCT_DeviceInformation_Response *	pDeviceInfo
	)

void SwiUpkSwocCfg	(	swi_uint8 *	paramfieldp,
		struct SWI_STRUCT_GetSwocCfg *	pSwocCfg
	)

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation