qaGobiApiDcs.h File Reference

Device Connectivity Service API function prototypes. More...

Go to the source code of this file.

Data Structures
struct	DcsUsbPortNames
struct	QosMap
struct	NetStats

Macros
#define	LEN   10
#define	PORTNAM_LEN   32

Functions
ULONG	QCWWAN2kEnumerateDevices (BYTE *pDevicesSize, BYTE *pDevices)
ULONG	QCWWAN2kConnect (CHAR *pDeviceID, CHAR *pDeviceKey)
ULONG	QCWWANDisconnect ()
ULONG	QCWWAN2kGetConnectedDeviceID (ULONG deviceIDSize, CHAR *pDeviceID, ULONG deviceKeySize, CHAR *pDeviceKey)
ULONG	QCWWANEnumerateDevices (BYTE *pDevicesSize, BYTE *pDevices)
ULONG	QCWWANConnect (CHAR *pDeviceID, CHAR *pDeviceKey)
ULONG	SetSDKImagePath (LPCSTR pPath)
ULONG	SLQSGetUsbPortNames (struct DcsUsbPortNames *pUsbPortNames)
ULONG	SLQSStart_AVAgent (BYTE modem_index)
ULONG	SLQSStart (BYTE modem_index, CHAR *sn)
ULONG	SLQSKillSDKProcess ()
ULONG	SLQSGetDeviceMode (BYTE *pDeviceMode)
ULONG	SLQSStartSrv (BYTE action, BYTE mask)
ULONG	SLQSSetLoggingMask (BYTE mask)
ULONG	SLQSGetNetStatistic (struct NetStats *pNetStatistic, BYTE instance)

Detailed Description

Device Connectivity Service API function prototypes.

Macro Definition Documentation

#define LEN   10

#define PORTNAM_LEN   32

This structure contains the SLQSGetUsbPortNames Information

Parameters

AtCmdPort	[OUT] Name of AT command port
NmeaPort	[OUT] Name of NMEA port
DmPort	[OUT] Name of DM port

Note

Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7700/10/50
Timeout: 2 seconds
Port names are limited to 32 characters.

Function Documentation

ULONG QCWWAN2kConnect	(	CHAR *	pDeviceID,
		CHAR *	pDeviceKey
	)

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

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

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]	Device path string
deviceKeySize	Maximum number of characters (including NULL terminator) that the device key array can contain.
pDeviceKey[OUT]	Device key string

Returns

eQCWWAN_ERR_NONE if device found, eQCWWAN_ERR_NO_DEVICE otherwise

Note

Timeout: 2 seconds

ULONG QCWWANConnect	(	CHAR *	pDeviceID,
		CHAR *	pDeviceKey
	)

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

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

none

Returns

eQCWWAN_ERR_NONE

Note

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

Timeout: 2 seconds
This API must be called prior to any other APIs.

ULONG SetSDKImagePath

(

LPCSTR

pPath

)

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

Timeout: None

ULONG SLQSGetDeviceMode

(

BYTE *

pDeviceMode

)

Returns the Device Mode

Parameters

pDeviceMode[OUT]

Pointer to SLQS Device Mode of type eDevState

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 2 seconds

ULONG SLQSGetNetStatistic	(	struct NetStats *	pNetStatistic,
		BYTE	instance
	)

Returns the usbnet statistics for a particular PDN.

Parameters

	pNetStatistic[OUT]	Pointer to the structure NetStats which the value of every member is to be retrieved
[in]	instance	PDP Instance id

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSGetUsbPortNames

(

struct DcsUsbPortNames *

pUsbPortNames

)

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

Timeout: 2 seconds

ULONG SLQSKillSDKProcess

(

)

Kill the SDK process

Parameters

none

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: N/A
This API useful if the application was started with non-root privileges as subsequent attempt to start any application will fail because the SDK requires root permission to access /dev/qcqmi device special files.

ULONG SLQSSetLoggingMask

(

BYTE

mask

)

Limit Syslog messages according to the Mask provided by user

Parameters

mask	Mask 0x01: disable all log Mask 0xFF: enable all log

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSStart	(	BYTE	modem_index,
		CHAR *	sn
	)

Create the SDK process and IPC sockets for the Application and SDK processes to communicate over.

Parameters

[in]	modem_index	0: first modem detected 1: second modem detected 2: third modem detected ... 7: seventh modem detected
[in]	sn	This field is optional, it can be serial number or usb path for multiple modem feature, it can be retrieved from sytem command "dmesg" when specified, the modem_index will be mapping to sn or usb path Please set to NULL when not used

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: N/A

ULONG SLQSStart_AVAgent

(

BYTE

modem_index

)

Create IPC sockets for AirVantage Agent and SDK processes to communicate over

Parameters

none

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: N/A

ULONG SLQSStartSrv	(	BYTE	action,
		BYTE	mask
	)

Registers/deregisters for service with unsolicited notifications

Parameters

action,1	for register, 0 for deregister
mask	Bit mask for unsolicited notifications Bit0 - WDS Bit1 - NAS Bit2 - PDS Bit3 - VOICE

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

see qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 2 seconds API is useful to register for the services which supports unsolicited notifications. Registration/deregistration can be done by using parameter action if action is set then the mask (set bits) will be used for registering service and if action is "0" mask(set bits) will be used to deregister services. For example : bit mask 0x03 - Registers for services WDS and NAS if action is "1" and deregisters WDS and NAS if action is "0".