Functions
void	wlan_init (tWlanCB sWlanCB, tFWPatches sFWPatches, tDriverPatches sDriverPatches, tBootLoaderPatches sBootLoaderPatches, tWlanReadInteruptPin sReadWlanInterruptPin, tWlanInterruptEnable sWlanInterruptEnable, tWlanInterruptDisable sWlanInterruptDisable, tWriteWlanPin sWriteWlanPin)
	Initialize wlan driver.

void	wlan_start (unsigned short usPatchesAvailableAtHost)
	Start WLAN device. This function asserts the enable pin of the device (WLAN_EN), starting the HW initialization process. The function blocked until device Initialization is completed. Function also configure patches (FW, driver or bootloader) and calls appropriate device callbacks.

void	wlan_stop (void)
	Stop WLAN device by putting it into reset state.

long	wlan_connect (unsigned long ulSecType, char ssid, long ssid_len, unsigned char bssid, unsigned char *key, long key_len)
	Connect to AP.

long	wlan_disconnect (void)
	Disconnect connection from AP.

long	wlan_add_profile (unsigned long ulSecType, unsigned char ucSsid, unsigned long ulSsidLen, unsigned char ucBssid, unsigned long ulPriority, unsigned long ulPairwiseCipher_Or_Key, unsigned long ulGroupCipher_TxKeyLen, unsigned long ulKeyMgmt, unsigned char *ucPf_OrKey, unsigned long ulPassPhraseLen)
	When auto start is enabled, the device connects to station from the profiles table. Up to 7 profiles are supported. If several profiles configured the device choose the highest priority profile, within each priority group, device will choose profile based on security policy, signal strength, etc parameters. All the profiles are stored in CC3000 NVMEM.

long	wlan_ioctl_del_profile (unsigned long ulIndex)
	Delete WLAN profile.

long	wlan_set_event_mask (unsigned long ulMask)
	Mask event according to bit mask. In case that event is masked (1), the device will not send the masked event to host.

long	wlan_ioctl_statusget (void)
	get wlan status: disconnected, scanning, connecting or connected

long	wlan_ioctl_set_connection_policy (unsigned long should_connect_to_open_ap, unsigned long should_use_fast_connect, unsigned long ulUseProfiles)
	When auto is enabled, the device tries to connect according the following policy: 1) If fast connect is enabled and last connection is valid, the device will try to connect to it without the scanning procedure (fast). The last connection will be marked as invalid, due to adding/removing profile. 2) If profile exists, the device will try to connect it (Up to seven profiles). 3) If fast and profiles are not found, and open mode is enabled, the device will try to connect to any AP.

long	wlan_ioctl_get_scan_results (unsigned long ulScanTimeout, unsigned char *ucResults)
	Gets entry from scan result table. The scan results are returned one by one, and each entry represents a single AP found in the area. The following is a format of the scan result:

long	wlan_ioctl_set_scan_params (unsigned long uiEnable, unsigned long uiMinDwellTime, unsigned long uiMaxDwellTime, unsigned long uiNumOfProbeRequests, unsigned long uiChannelMask, long iRSSIThreshold, unsigned long uiSNRThreshold, unsigned long uiDefaultTxPower, unsigned long *aiIntervalList)
	start and stop scan procedure. Set scan parameters.

long	wlan_smart_config_start (unsigned long algoEncryptedFlag)
	Start to acquire device profile. The device acquire its own profile, if profile message is found. The acquired AP information is stored in CC3000 EEPROM only in case AES128 encryption is used. In case AES128 encryption is not used, a profile is created by CC3000 internally.

long	wlan_smart_config_stop (void)
	Stop the acquire profile procedure.

long	wlan_smart_config_set_prefix (char *cNewPrefix)
	Configure station ssid prefix. The prefix is used internally in CC3000. It should always be TTT.

long	wlan_smart_config_process (void)
	process the acquired data and store it as a profile. The acquired AP information is stored in CC3000 EEPROM encrypted. The encrypted data is decrypted and stored as a profile. behavior is as defined by connection policy.

Detailed Description

Function Documentation

void wlan_init	(	tWlanCB	sWlanCB,
		tFWPatches	sFWPatches,
		tDriverPatches	sDriverPatches,
		tBootLoaderPatches	sBootLoaderPatches,
		tWlanReadInteruptPin	sReadWlanInterruptPin,
		tWlanInterruptEnable	sWlanInterruptEnable,
		tWlanInterruptDisable	sWlanInterruptDisable,
		tWriteWlanPin	sWriteWlanPin
	)

Initialize wlan driver.

wlan_init

Parameters

sWlanCB	Asynchronous events callback. 0 no event call back. -call back parameters: 1) event_type: HCI_EVNT_WLAN_UNSOL_CONNECT connect event, HCI_EVNT_WLAN_UNSOL_DISCONNECT disconnect event, HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE config done, HCI_EVNT_WLAN_UNSOL_DHCP dhcp report, HCI_EVNT_WLAN_ASYNC_PING_REPORT ping report OR HCI_EVNT_WLAN_KEEPALIVE keepalive. 2) data: pointer to extra data that received by the event (NULL no data). 3) length: data length. -Events with extra data: HCI_EVNT_WLAN_UNSOL_DHCP: 4 bytes IP, 4 bytes Mask, 4 bytes default gateway, 4 bytes DHCP server and 4 bytes for DNS server. HCI_EVNT_WLAN_ASYNC_PING_REPORT: 4 bytes Packets sent, 4 bytes Packets received, 4 bytes Min round time, 4 bytes Max round time and 4 bytes for Avg round time.
sFWPatches	0 no patch or pointer to FW patches
sDriverPatches	0 no patch or pointer to driver patches
sBootLoaderPatches	0 no patch or pointer to bootloader patches
sReadWlanInterruptPin	init callback. the callback read wlan interrupt status.
sWlanInterruptEnable	init callback. the callback enable wlan interrupt.
sWlanInterruptDisable	init callback. the callback disable wlan interrupt.
sWriteWlanPin	init callback. the callback write value to device pin.

Returns: none

See Also: wlan_set_event_mask , wlan_start , wlan_stop

Warning: This function must be called before ANY other wlan driver function

void wlan_start ( unsigned short usPatchesAvailableAtHost )

Start WLAN device. This function asserts the enable pin of the device (WLAN_EN), starting the HW initialization process. The function blocked until device Initialization is completed. Function also configure patches (FW, driver or bootloader) and calls appropriate device callbacks.

wlan_start

Parameters

usPatchesAvailableAtHost - flag to indicate if patches available from host or from EEPROM. Due to the fact the patches are burn to the EEPROM using the patch programmer utility, the patches will be available from the EEPROM and not from the host.

Returns: none

Prior calling the function wlan_init shall be called. This function must be called after wlan_init and before any other wlan API

See Also: wlan_init , wlan_stop

void wlan_stop ( void )

Stop WLAN device by putting it into reset state.

wlan_stop

Parameters

none

Returns: none

See Also: wlan_start

long wlan_connect	(	unsigned long	ulSecType,
		char *	ssid,
		long	ssid_len,
		unsigned char *	bssid,
		unsigned char *	key,
		long	key_len
	)

Connect to AP.

wlan_connect

Parameters

sec_type	security options: WLAN_SEC_UNSEC, WLAN_SEC_WEP (ASCII support only), WLAN_SEC_WPA or WLAN_SEC_WPA2
ssid	up to 32 bytes and is ASCII SSID of the AP
ssid_len	length of the SSID
bssid	6 bytes specified the AP bssid
key	up to 32 bytes specified the AP security key
key_len	key length

Returns: On success, zero is returned. On error, negative is returned. Note that even though a zero is returned on success to trigger connection operation, it does not mean that CCC3000 is already connected. An asynchronous "Connected" event is generated when actual association process finishes and CC3000 is connected to the AP. If DHCP is set, An asynchronous "DHCP" event is generated when DHCP process is finish.

Warning: Please Note that when connection to AP configured with security type WEP, please confirm that the key is set as ASCII and not as HEX.

See Also: wlan_disconnect

long wlan_disconnect ( void )

Disconnect connection from AP.

wlan_disconnect

Returns: 0 disconnected done, other CC3000 already disconnected

See Also: wlan_connect

long wlan_add_profile	(	unsigned long	ulSecType,
		unsigned char *	ucSsid,
		unsigned long	ulSsidLen,
		unsigned char *	ucBssid,
		unsigned long	ulPriority,
		unsigned long	ulPairwiseCipher_Or_Key,
		unsigned long	ulGroupCipher_TxKeyLen,
		unsigned long	ulKeyMgmt,
		unsigned char *	ucPf_OrKey,
		unsigned long	ulPassPhraseLen
	)

When auto start is enabled, the device connects to station from the profiles table. Up to 7 profiles are supported. If several profiles configured the device choose the highest priority profile, within each priority group, device will choose profile based on security policy, signal strength, etc parameters. All the profiles are stored in CC3000 NVMEM.

wlan_add_profile

Parameters

ulSecType	WLAN_SEC_UNSEC,WLAN_SEC_WEP,WLAN_SEC_WPA,WLAN_SEC_WPA2
ucSsid	ssid SSID up to 32 bytes
ulSsidLen	ssid length
ucBssid	bssid 6 bytes
ulPriority	ulPriority profile priority. Lowest priority:0.
ulPairwiseCipher_Or_TxKeyLen	key length for WEP security
ulGroupCipher_TxKeyIndex	key index
ulKeyMgmt	KEY management
ucPf_OrKey	security key
ulPassPhraseLen	security key length for WPA

Returns: On success, zero is returned. On error, -1 is returned

See Also: wlan_ioctl_del_profile

long wlan_ioctl_del_profile ( unsigned long ulIndex )

Delete WLAN profile.

wlan_ioctl_del_profile

Parameters

index number of profile to delete

Returns: On success, zero is returned. On error, -1 is returned

In order to delete all stored profile, set index to 255.

See Also: wlan_add_profile

long wlan_set_event_mask ( unsigned long ulMask )

Mask event according to bit mask. In case that event is masked (1), the device will not send the masked event to host.

wlan_set_event_mask

Parameters

mask mask option: HCI_EVNT_WLAN_UNSOL_CONNECT connect event HCI_EVNT_WLAN_UNSOL_DISCONNECT disconnect event HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE smart config done HCI_EVNT_WLAN_UNSOL_INIT init done HCI_EVNT_WLAN_UNSOL_DHCP dhcp event report HCI_EVNT_WLAN_ASYNC_PING_REPORT ping report HCI_EVNT_WLAN_KEEPALIVE keepalive HCI_EVNT_WLAN_TX_COMPLETE - disable information on end of transmission Saved: no.

Returns: On success, zero is returned. On error, -1 is returned

long wlan_ioctl_statusget ( void )

get wlan status: disconnected, scanning, connecting or connected

wlan_ioctl_statusget

Parameters

none

Returns: WLAN_STATUS_DISCONNECTED, WLAN_STATUS_SCANING, STATUS_CONNECTING or WLAN_STATUS_CONNECTED

long wlan_ioctl_set_connection_policy	(	unsigned long	should_connect_to_open_ap,
		unsigned long	should_use_fast_connect,
		unsigned long	ulUseProfiles
	)

When auto is enabled, the device tries to connect according the following policy: 1) If fast connect is enabled and last connection is valid, the device will try to connect to it without the scanning procedure (fast). The last connection will be marked as invalid, due to adding/removing profile. 2) If profile exists, the device will try to connect it (Up to seven profiles). 3) If fast and profiles are not found, and open mode is enabled, the device will try to connect to any AP.

wlan_ioctl_set_connection_policy

Parameters

should_connect_to_open_ap	enable(1), disable(0) connect to any available AP. This parameter corresponds to the configuration of item # 3 in the brief description.
should_use_fast_connect	enable(1), disable(0). if enabled, tries to connect to the last connected AP. This parameter corresponds to the configuration of item # 1 in the brief description.
auto_start	enable(1), disable(0) auto connect after reset and periodically reconnect if needed. This configuration configures option 2 in the above description.

Returns

On success, zero is returned. On error, -1 is returned

        * Note that the policy settings are stored in the CC3000 NVMEM.

See Also: wlan_add_profile , wlan_ioctl_del_profile

long wlan_ioctl_get_scan_results	(	unsigned long	ulScanTimeout,
		unsigned char *	ucResults
	)

Gets entry from scan result table. The scan results are returned one by one, and each entry represents a single AP found in the area. The following is a format of the scan result:

wlan_ioctl_get_scan_results

Parameters

[in]	scan_timeout	parameter not supported
[out]	ucResults	scan result (_wlan_full_scan_results_args_t)

Returns

On success, zero is returned. On error, -1 is returned

     - 4 Bytes: number of networks found
    - 4 Bytes: The status of the scan: 0 - aged results,
               1 - results valid, 2 - no results
    - 42 bytes: Result entry, where the bytes are arranged as  follows:

                                    - 1 bit isValid - is result valid or not
                            - 7 bits rssi - RSSI value;      
           - 2 bits: securityMode - security mode of the AP:
                     0 - Open, 1 - WEP, 2 WPA, 3 WPA2
                            - 6 bits: SSID name length
                            - 2 bytes: the time at which the entry has entered into 
                      scans result table
                            - 32 bytes: SSID name
           - 6 bytes:       BSSID

scan_timeout, is not supported on this version.

See Also: wlan_ioctl_set_scan_params

long wlan_ioctl_set_scan_params	(	unsigned long	uiEnable,
		unsigned long	uiMinDwellTime,
		unsigned long	uiMaxDwellTime,
		unsigned long	uiNumOfProbeRequests,
		unsigned long	uiChannelMask,
		long	iRSSIThreshold,
		unsigned long	uiSNRThreshold,
		unsigned long	uiDefaultTxPower,
		unsigned long *	aiIntervalList
	)

start and stop scan procedure. Set scan parameters.

wlan_ioctl_set_scan_params

Parameters

uiEnable	- start/stop application scan: 1 = start scan with default interval value of 10 min. in order to set a different scan interval value apply the value in milliseconds. minimum 1 second. 0=stop). Wlan reset (wlan_stop() wlan_start()) is needed when changing scan interval value. Saved: No
uiMinDwellTime	minimum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 20)
uiMaxDwellTime	maximum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 30)
uiNumOfProbeRequests	max probe request between dwell time. Saved: yes. Recommended Value: 5 (Default:2)
uiChannelMask	bitwise, up to 13 channels (0x1fff). Saved: yes. Default: 0x7ff
uiRSSIThreshold	RSSI threshold. Saved: yes (Default: -80)
uiSNRThreshold	NSR threshold. Saved: yes (Default: 0)
uiDefaultTxPower	probe Tx power. Saved: yes (Default: 205)
aiIntervalList	pointer to array with 16 entries (16 channels) each entry (unsigned long) holds timeout between periodic scan (connection scan) - in milliseconds. Saved: yes. Default 2000ms.

Returns: On success, zero is returned. On error, -1 is returned

uiDefaultTxPower, is not supported on this version.

See Also: wlan_ioctl_get_scan_results

long wlan_smart_config_start ( unsigned long algoEncryptedFlag )

Start to acquire device profile. The device acquire its own profile, if profile message is found. The acquired AP information is stored in CC3000 EEPROM only in case AES128 encryption is used. In case AES128 encryption is not used, a profile is created by CC3000 internally.

wlan_smart_config_start

Parameters

algoEncryptedFlag indicates whether the information is encrypted

Returns: On success, zero is returned. On error, -1 is returned

An asynchronous event - Smart Config Done will be generated as soon as the process finishes successfully.

See Also: wlan_smart_config_set_prefix , wlan_smart_config_stop

long wlan_smart_config_stop ( void )

Stop the acquire profile procedure.

wlan_smart_config_stop

Parameters

algoEncryptedFlag indicates whether the information is encrypted

Returns: On success, zero is returned. On error, -1 is returned

See Also: wlan_smart_config_start , wlan_smart_config_set_prefix

long wlan_smart_config_set_prefix ( char * cNewPrefix )

Configure station ssid prefix. The prefix is used internally in CC3000. It should always be TTT.

wlan_smart_config_set_prefix

Parameters

newPrefix 3 bytes identify the SSID prefix for the Smart Config.

Returns: On success, zero is returned. On error, -1 is returned

The prefix is stored in CC3000 NVMEM

See Also: wlan_smart_config_start , wlan_smart_config_stop

long wlan_smart_config_process ( void )

process the acquired data and store it as a profile. The acquired AP information is stored in CC3000 EEPROM encrypted. The encrypted data is decrypted and stored as a profile. behavior is as defined by connection policy.

wlan_smart_config_process

Parameters

none

Returns: On success, zero is returned. On error, -1 is returned

Functions

Detailed Description

Function Documentation