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.
Enumeration of PnP behaviour.
Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_DeviceReEnum information request.
Enumeration of protocols to be used for firmware download.
Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_FrmDwlProtocol information request.
Enumeration indicates return status of request.
enum SWI_TYPE_Technology |
Enumeration of control and status protocol technology.
Returned by SwiGetDeviceInformation in conjunction with SWI_DEVICEINFORMATION_Technology information request.
SWI_API SWI_RCODE SwiGetAirCardType | ( | SWI_STRUCT_AirCardType * | pAirCardType, | |
U32 | timeout | |||
) |
This function is used to query the modem for its device type.
This is a legacy function. SwiGetAvailAirServers and SwiSelectAirServer should now be used to determine available devices and selecting a device to communicate with.
This function is only supported on GSM devices.
[OUT] | pAirCardType: Card type | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetAvailableFeatures | ( | SWI_STRUCT_AvailFeatures & | sFeatures, | |
U32 | timeout | |||
) |
This function is used to retrieve the modem's available features.
This function replaces SwiGetAvailableFeature.
This function is only supported on GSM devices.
[OUT] | sFeatures: Feature capability. See SWI_STRUCT_AvailFeatures for details. | |
[IN] | timeout Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetBootloaderBuildDate | ( | LPTSTR | lpstrBLBldDate, | |
U32 & | nLength, | |||
U32 | Timeout | |||
) |
This function is used to retrieve the boot loader build date.
[OUT] | lpstrBLBldDate: Pointer to store the build date information | |
[IN/OUT] | nLength: Size of buffer available to store the build date information/required buffer space | |
[IN] | Timeout: Response timeout value in milliseconds |
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiGetBootVersion | ( | LPTSTR | szBVVersion, | |
U32 | sizeBuffer, | |||
U32 | timeout | |||
) |
This function returns the device's firmware loader version in a string.
[OUT] | szBVVersion: 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. | |
[IN] | sizeBuffer: Size of buffer provided for the bootloader version | |
[IN] | timeout: Response timeout value in milliseconds |
SWI_API SWI_RCODE SwiGetDeviceID | ( | LPTSTR | szDeviceID, | |
U32 | sizeBuffer, | |||
U32 | 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.
[OUT] | szDeviceID: A string representing the Device ID (NULL terminated). | |
[IN] | sizeBuffer: Size of buffer provided for the device ID. A buffer of 15 bytes is recommended. | |
[IN] | timeout: Response timeout value in milliseconds |
SWI_API SWI_RCODE SwiGetDeviceInformation | ( | const SWI_STRUCT_DeviceInformation_Request & | sDeviceInformation_Request, | |
SWI_STRUCT_DeviceInformation_Response & | sDeviceInformation_Response, | |||
U32 | 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.
[IN] | sDeviceInformation_Request: struct must be filled out to select type of information returned. | |
[OUT] | sDeviceInformation_Response: struct returned will contain the requested information. | |
[IN] | timeout: Response timeout value in milliseconds. |
SWI_API SWI_RCODE SwiGetFeatureCustomizations | ( | SWI_STRUCT_FeatureCustomizations * | sCustomizations, | |
U32 | timeout | |||
) |
This function is used to retrieve the modem's customizable features.
This function is only supported on GSM devices.
[OUT] | sCustomizations Modem feature customizations. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetFirmwareBuildDate | ( | LPTSTR | szBuildDate, | |
U32 | sizeBuffer, | |||
U32 | timeout | |||
) |
This function returns the date the device's firmware was created.
[OUT] | szBuildDate: Firmware build date. The firmware build date string is in the form of MM/DD/YY. | |
[IN] | sizeBuffer: Size of buffer provided for the firmware build date | |
[IN] | timeout: Response timeout value in milliseconds |
SWI_API SWI_RCODE SwiGetFirmwareVersion | ( | LPTSTR | szFWVersion, | |
U32 | sizeBuffer, | |||
U32 | 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.
[OUT] | szFWVersion: Firmware version (NULL terminated) | |
[IN] | sizeBuffer: Size of buffer provided for the firmware version. | |
[IN] | timeout: Response timeout value in milliseconds |
SWI_API SWI_RCODE SwiGetFlashImgInfo | ( | SWI_STRUCT_FlashImgInfo * | pFlashImgInfo, | |
U32 | timeout | |||
) |
This function is used to retrieve firmware flash information from the device.
[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. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetFPGAVersion | ( | U32 * | major, | |
U32 * | minor, | |||
U32 | timeout | |||
) |
This function is used to retrieve the FPGA version.
This function is only supported on GSM devices.
[OUT] | major: FPGA major version | |
[OUT] | minor: FPGA minor version | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetHardwareVersion | ( | LPTSTR | szHWVersion, | |
U32 | sizeBuffer, | |||
U32 | timeout | |||
) |
This function returns the device's hardware version in a string.
[OUT] | szHWVersion: 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. | |
[IN] | sizeBuffer: Size of buffer provided for the hardware version | |
[IN] | timeout: Response timeout value in milliseconds |
SWI_API SWI_RCODE SwiGetImei | ( | SWI_STRUCT_Imei * | pImei, | |
U32 | timeout | |||
) |
This function is used to fetch the International Mobile Equipment Identity (IMEI) from the modem. The IMEI consists of:
This function is only supported on GSM devices.
[OUT] | pImei: IMEI | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetModemDisable | ( | bool * | pModemDisable, | |
U32 | timeout | |||
) |
This function returns the modem On/Off state.
The modem disable setting will persist though the modem's power may be cycled.
This function is only supported on GSM devices.
[OUT] | pModemDisable: True is returned if the modem is disabled, false otherwise. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetPriInfo | ( | SWI_STRUCT_PriInfo * | pPriInfo, | |
U32 | timeout | |||
) |
This function is used to retrieve PRI information of the device.
[OUT] | pPriInfo: Pointer to a SWI_STRUCT_PriInfo to store the PRI information. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetSerialNumber | ( | SWI_STRUCT_Fsn * | sFsn, | |
U32 | timeout | |||
) |
This function is used to retrieve the Factory Serial Number (FSN). The FSN contains information such as the manufacturing date, a unique serial number for each modem and the hardware version.
This function is only supported on GSM devices.
[OUT] | sFsn: Factory Serial Number | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetUsbdInfo | ( | SWI_STRUCT_UsbdInfo * | pUsbdInfo, | |
U32 | Timeout | |||
) |
This function is used to retrieve the USB descriptor build information.
[OUT] | pUsbd: Structure to store USB descriptor build information |
SWI_API SWI_RCODE SwiHostAppLaunch | ( | U32 | timeout | ) |
This function is used to inform the modem when the host software application has launched.
This function is only supported on GSM devices.
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiModemReset | ( | U32 | timeout = 1000 |
) |
This function is used to perform a hard reset of the modem. The driver will attempt to perform a hardware reset.
Only supported on AirCard 710, AirCard 750, AirCard 775, AirCard 850, and AirCard 860 devices. New devices will ignore this command. Use SwiSoftModemReset to perform a soft reset.
[IN] | timeout: Response timeout value in milliseconds to use (default 1 second). |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiSetHostStartup | ( | bool | bStartup, | |
U32 | timeout | |||
) |
This function controls the radio power state.
This function is similar to SwiSetModemDisable. When called to "shutdown" the radio, the modem will detach from the network and power down the radio. Unlike SwiSetModemDisable, however, this powered down state is NOT persistent across modem power cycles.
When called to "startup" the radio, the modem will power on the radio and attempt to attach to a network (if available).
It is recommended that this function be called with the "shutdown" parameter when the host application shuts down or when the PC enters a suspend state.
It is recommended that this function be called with the "startup" parameter when the host application initially starts up and after resuming from a PC suspend state.
A change in the radio's power state will be signaled with a SWI_NOTIFY_ModemDisabled indication.
This function is only supported on GSM devices.
[IN] | bStartup: Set to true to power up the radio and attempt to attach to a network (if available). Set to false to detach from the network and power down the radio. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiSetModemDisable | ( | const bool | bModemDisable, | |
U32 | timeout | |||
) |
This function can be used to change the modem disable setting on the modem.
The modem disable setting will persist though the modem's power may be cycled. Switching modem state from OFF to ON may result in a modem reset.
This function is only supported on GSM devices.
[IN] | bModemDisable:
| |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiSoftModemReset | ( | ) |
This function is used to perform a soft modem reset.
SWI_NOTIFY_Reset is generated after the reset has completed. Note that the driver may also unload and reload when a modem reset occurs. SWI_NOTIFY_AirServerChange notifications are also generated in this scenario.