qaGobiApiDcs.h File Reference
Device Connectivity Service API function prototypes.
More...
Go to the source code of this file.
Detailed Description
Device Connectivity Service API function prototypes.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
Define Documentation
This structure contains the SLQSGetUsbPortNames Information
- Parameters:
-
| AtCmdPort | [OUT]
|
| NmeaPort | [OUT]
|
| DmPort | [OUT]
|
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7700/10/50
Timeout: 2 seconds
Port names are limited to 32 characters.
Enumeration Type Documentation
An enumeration of eAPI_DCS_GET_DEVICE_MODE states
- Enumerator:
DCS_DEVICE_MODE_DISCONNECTED |
|
DCS_DEVICE_MODE_READY |
|
DCS_DEVICE_MODE_BOOT_READY |
|
Function Documentation
Connects the Connection Manager API to the first detected QC WWAN device. This function MUST be called after QCWWAN2kEnumerateDevices has been called.
- Parameters:
-
| pDeviceID[IN] |
- Device path pertaining to the device for which the API is being invoked e.g. /dev/qcqmi0.
|
| pDeviceKey[IN] |
- Device key pertaining to the device for which the API is being invoked
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_ERR_NO_DEVICE otherwise
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
ULONG QCWWAN2kEnumerateDevices |
( |
BYTE * |
pDevicesSize, |
|
|
BYTE * |
pDevices | |
|
) |
| | |
Enumerates the QC WWAN devices currently attached to the host. This API MUST be called before any other API.
- Parameters:
-
| pDeviceSize[IN/OUT] |
- Upon input, maximum number of elements that the device array can contain.
- Upon successful output, actual number of elements in the device array.
|
| pDevices[IN/OUT] |
- Device array; array elements are structures with the following elements:
CHAR deviceID[256] - Device path (e.g. /dev/qcqmi0)
CHAR deviceKey[16] - Device key stored in the device (e.g. A1000004B01051)
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_ERR_NO_DEVICE on otherwise
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
ULONG QCWWAN2kGetConnectedDeviceID |
( |
ULONG |
deviceIDSize, |
|
|
CHAR * |
pDeviceID, |
|
|
ULONG |
deviceKeySize, |
|
|
CHAR * |
pDeviceKey | |
|
) |
| | |
Returns the device ID and device key of the currently connected QC WWAN device.
- Parameters:
-
| deviceIDSize |
- Maximum number of characters (including NULL terminator) that the device ID array can contain.
|
| pDeviceID[OUT] |
|
| deviceKeySize |
- Maximum number of characters (including NULL terminator) that the device key array can contain.
|
| pDeviceKey[OUT] |
|
- Returns:
- eQCWWAN_ERR_NONE if device found, eQCWWAN_ERR_NO_DEVICE otherwise
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
Enumerates the QC WWAN devices currently attached to the host. This API MUST be called before any other API.
- Parameters:
-
| pDeviceID[IN] |
- Device path pertaining to the device for which the API is being invoked e.g. /dev/qcqmi0.
|
| pDeviceKey[IN] |
- Device key pertaining to the device for which the API is being invoked
|
- Returns:
- eQCWWAN_ERR_NONE if device found, eQCWWAN_ERR_NO_DEVICE otherwise
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
This API is deprecated; use QCWWAN2kConnect instead
ULONG QCWWANDisconnect |
( |
|
) |
|
Disconnects the Connection Manager API from a previously connected QC device. This function de-registers all the callback functions that have been registered.
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
ULONG QCWWANEnumerateDevices |
( |
BYTE * |
pDevicesSize, |
|
|
BYTE * |
pDevices | |
|
) |
| | |
Enumerates the QC WWAN devices currently attached to the host. This API is deprecated; use QCWWAN2kEnumerateDevices instead.
- Parameters:
-
| pDeviceSize[IN/OUT] |
- Upon input, maximum number of elements that the device array can contain.
- Upon successful output, actual number of elements in the device array.
|
| pDevices[IN/OUT] |
- Device array; array elements are structures with the following elements:
CHAR deviceID[256] - Device path (e.g. /dev/qcqmi0)
CHAR deviceKey[16] - Device key stored in the device
|
- Returns:
- eQCWWAN_ERR_NONE
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: 2 seconds
This API must be called prior to any other APIs.
Set the location of the SLQS executable
- Parameters:
-
| pPath[IN] | - Pointer to fully qualified path of SLQS executable (includes the executable file’s name) |
- Returns:
- eQCWWAN_ERR_NONE
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7750
Timeout: None
ULONG SLQSGetDeviceMode |
( |
BYTE * |
pDeviceMode |
) |
|
Returns the Device Mode
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA/UMTS
Device Supported: MC83x5, MC7700/10/50
Timeout: 2 seconds
Returns the Usb Port Names currently in use.
- Parameters:
-
| pUsbPortNames[OUT] |
- Pointer to SLQS Usb Port Names Information
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA/UMTS
Device Supported: MC83x5, MC7700/10/50
Timeout: 2 seconds
ULONG SLQSKillSDKProcess |
( |
|
) |
|
Kill the SDK process
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA/UMTS
Device Supported: MC83x5, MC7700/10/50
Timeout: N/A
This API useful if the application was started with non root priveleges as subsequent attempt to start any application will fail because the SDK requires root permission to access /dev/qcqmi device special files.
Create the SDK process and IPC sockets for the Application and SDK processes to communicate over.
- Parameters:
-
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- see qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: CDMA/UMTS
Device Supported: MC83x5, MC7700/10/50
Timeout: N/A