readme

marvell wifi driver GSPI-8385-LINUX-OMAP1510-5.0.10.p0-144-src.rar

================================================================================
		U S E R  M A N U A L  F O R  I W P R I V 

NAME
	This manual describes the usage of private commands used in Marvell WLAN
	Linux Driver.

SYNOPSIS
	iwpriv <ethX> <command> [sub-command] ...

	iwpriv ethX version
	iwpriv ethX scantype [sub-command]
	iwpriv ethX getSNR <n>
	iwpriv ethX getNF <n>
	iwpriv ethX getRSSI <n>
	iwpriv ethX setrxant <n>
	iwpriv ethX getrxant
	iwpriv ethX settxant <n>
	iwpriv ethX gettxant
	iwpriv ethX authalgs <n>
	iwpriv ethX pre-TBTT <n>
	iwpriv ethX 8021xauthalgs <n>
	iwpriv ethX encryptionmode <n>
	iwpriv ethX setregioncode <n>
	iwpriv ethX getregioncode 
	iwpriv ethX setbcnavg <n>
	iwpriv ethX getbcnavg
	iwpriv ethX setdataavg <n>
	iwpriv ethX setlisteninter <n>
	iwpriv ethX getlisteninter
	iwpriv ethX setmultipledtim <n>
	iwpriv ethX getmultipledtim
	iwpriv ethX atimwindow <n>
	iwpriv ethX deepsleep <n>
	iwpriv ethX hostwakeupcfg <n>
	iwpriv ethX deauth
	iwpriv ethX adhocstop
	iwpriv ethX radioon
	iwpriv ethX radiooff
	iwpriv ethX reasso-on
	iwpriv ethX reasso-off
	iwpriv ethX scanmode  [sub-command]
	iwpriv ethX setwpaie <n>
	iwpriv ethX wlanidle-off
	iwpriv ethX wlanidle-on
	iwpriv ethX setaeskey <n>
	iwpriv ethX getaeskey 
	iwpriv ethX rmaeskey
	iwpriv ethX setband <n>
	iwpriv ethX getband
	iwpriv ethX getcis
	iwpriv ethX getlog
	iwpriv ethX getadhocstatus
	iwpriv ethX adhocgrate <n>
	iwpriv ethX atimgen <n>

Version 4 Command:
	iwpriv ethX inactvityto <n>
	iwpriv ethX sleeppd <n>
	iwpriv ethX enable11d <n>
	iwpriv ethX enable11htpc <n>
	iwpriv ethX setpowercons <n>
	iwpriv ethX setpowercap <n> <m>
	iwpriv ethX bgscan <n>
	iwpriv ethX wmm <n>
	iwpriv ethX tpccfg <n>
	iwpriv ethX powercfg <n>	
	iwpriv ethX setafc <n>
	iwpriv ethX getafc
	iwpriv ethX sdioclock <n>

Version 5 Command:
	iwpriv ethX ledgpio <n>
	iwpriv ethX wmm_qosinfo <n>
	iwpriv ethX scanprobes <n>
	iwpriv ethX lolisteninter <n>
	iwpriv ethX rateadapt <n> <m>
	iwpriv ethX fwwakeupmethod <n>
	iwpriv ethX txcontrol <n>
	iwpriv ethX uapsdnullgen <n>

DESCRIPTION
	Those commands are used to send additional commands to the Marvell WLAN
	card via the Linux device driver.

	The ethX parameter specifies the network device that is to be used to 
		perform this command on. it could be eth0, eth1 etc.

version	
	This is used to get the current version of the driver and the firmware.

scantype	
	This command is used to set the scan type to be used by the driver in 
	the scan command. This setting will not be used while performing a scan
	for a specific SSID, as it is always done with scan type being active. 
	
	where the sub-commands are: - 
			active 	-- to set the scan type to active
			passive -- to set the scan type to passive
			get 	-- to get the scan type set in the driver

getSNR  
	This command gets the average and non average value of Signal to Noise 
	Ratio of Beacon and Data.
	
	where value is:-
			0 	-- Beacon non-average.
	        	1 	-- Beacon average.
	        	2 	-- Data non-average.
	        	3 	-- Data average.

	If no value is given, all four values are returned in the order mentioned
	above.

	Note: This command is available only when STA is connected.

getRSSI	
	This command gets the average and non average value os Receive Signal 
	Strength of Beacon and Data.
	
	where value is:-
			0 	-- Beacon non-average.
	        	1 	-- Beacon average.
	        	2 	-- Data non-average.
	        	3 	-- Data average.

	Note: This command is available only when STA is connected.

getNF   
	This command gets the average and non average value of Noise Floor of 
	Beacon and Data.
	
	where value is:-
			0 	-- Beacon non-average.
	        	1 	-- Beacon average.
	        	2 	-- Data non-average.
	        	3 	-- Data average.

	Note: This command is available only when STA is connected.

setrxant	
	This command is used to set the mode for Rx antenna. 
	
	The options that can be sent are:- 
			1 	-- Antenna 1. 
			2 	-- Antenna 2.
			0xFFFF 	-- Diversity.

	Usage:
		iwpriv ethX setrxant 0x01: select Antenna 1.

getrxant                    
	This command is used to get the mode for Rx antenna.


settxant	
	This command is used to set the mode for Tx antenna.
		The options that can be sent are:- 
			1 	-- Antenna 1. 
			2 	-- Antenna 2.
			0xFFFF 	-- Diversity.
	Usage:
		iwpriv ethX settxant 0x01: select Antenna 1.

gettxant                    
	This command is used to get the mode for Tx antenna.

authalgs	
	This command is used by the WPA supplicant to set the authentication 
	algorithms in the station.

8021xauthalgs
	This command is used by the WPA supplicant to set the 8021.x authentication algorithm type
	station.
	
	where values can be:-
			1 	-- None
			2 	-- LEAP
			4 	-- TLS
			8 	-- TTLs
			16	-- MD5	


encryptionmode
	This command is used by the WPA supplicant to set the encryption algorithm.
		
	where values can be:-
			0 	-- NONE
			1 	-- WEP40
			2 	-- TKIP
			3 	-- CCMP
			4 	-- WEP104

pre-TBTT	
	This command is used to set pre-TBTT time period where value is in microseconds.

setregioncode           
	This command is used to set the region code in the station.
	where value is 'region code' for various regions like
	USA FCC, Canada IC, Spain, France, Europe ETSI,	Japan ...

	Usage:
		iwpriv ethX setregioncode 0x10: set region code to USA (0x10).

getregioncode           
	This command is used to get the region code information set in the 
	station. 

setbcnavg
	Set the weighting factor for calculating RSSI.

getbcnavg
	Get weighting factor for calculating RSSI.

setdataavg
	Set the weighting factor for calculating SNR.

setlisteninter             
	This command is used to set the listen interval in the 
	station.
	
	where the value ranges between 1 - 255

getlisteninter            
	This command is used to get the listen interval value set in the 
	station.

setmultipledtim         
	This command is used to set the multiple dtim value in the 
	station.
		where the value is 1,2,3,4,5,0xfffe
		0xfffe means the firmware will use listen interval in association
		command for waking up

getmultipledtim        
	This command is used to get the multiple dtim value set in the station.

atimwindow         
	This command is used to set the atim value in the 
	station. 

	where the value ranges between 0 - 50

deauth                      
	This command is used to send the de-authentication to the AP with which 
	the station is associated. This command is valid only when 
	station is in Infrastructure mode.

	Note: This command is available only when STA is connected.

reasso-on                  
	This command is used to enable re-association function in dirver.

reasso-off                  
	This command is used to disable re-association function in driver

adhocstop                 
	This command is used to stop beacon transmission from the station and 
	go into idle state in ad-hoc mode.
	
	Note: This command is available only when STA is connected.

radioon                     
	This command is used to turn on the RF antenna.

radiooff                    
	This command is sued to turn off the RF antenna.   

scanmode                 
	This command is used to set the station to scan for either IBSS 
	networks or BSS networks or both BSS and IBSS networks. This 
	command can be used with sub commands,

	where the value for 
			bss 	-- Scan All the BSS networks.
			ibss 	-- Scan All the IBSS networks.
			any 	-- Scan both BSS and IBSS networks.
			
deepsleep                    
	This command is used to configure the station in deepsleep mode.
	
	where the option is:
        		1 	-- Enable deepsleep mode
			0 	-- Disable deepsleep mode. 

	Note: This command is available only when STA is connected.

hostwakeupcfg	
	This command is used to wakeup the host on the given parameters.
		(Condition, GPIO pin , Gap).

	where Condition is:-  
		bit 0 = 1 	-- non unicast data
		bit 1 = 1 	-- unicast data
		bit 2 = 1 	-- mac event
		bit 3 = 1 	-- magic packet
		bit0:31=1	-- cancel host_wakeup_config

	where GPIO is the pin number of GPIO used to wakeup the host.
		It could be 0-7 (GPIO0 to GPIO7) or 0xff (SDIO will be used instead).
		
	where Gap is the gap in milli seconds between wakeup signal and wakeup event.

	Where GPIO and Gap are one byte Hexical data.

	Usage:
		iwpriv eth1 hostwakeupcfg  "2 1 80"		# unicast data
								# GPIO 1
								# gap: 128ms

		iwpriv eth1 hostwakeupcfg  "ffffffff 0 0"	# cancel host wakeup config

	Note: This command is available only when STA is connected.

setwpaie                      
	This command is used by WPA supplicant to send the WPA-IE to the driver. 
	
wlanidle-off                 
	This command is used to get into idle state.

	Note: This command is available only when STA is connected.

wlanidle-on                 
	This command is used to get off the idle state.

	Note: This command is available only when STA is connected.

setaeskey
	This command is used to set the AES key, when the station is in Ad-hoc
	mode.

	where value can be any 16 byte value.

	Usage:
		iwpriv ethX setaeskey 12345678901234567890123456789012

getaeskey
	This command is used to get the AES key, when the station is in Ad-hoc
	mode.

rmaeskey
	This command is used to remove the Ad-Hoc AES key that is previously set.
	It will disable ad-hoc AES as well.

setband              	
	This command is used to set the band.

	where bands are:-
    	   		a
			b
			bg
			abg
	Usage:
		iwpriv ethX setband a: set to a band
		iwpriv ethX setband bg: set to b and g band

getband             			
	This command is used to get the user configured bands.

getcis
	This command is used to read the Card Info Structure Table.
	
getlog
	This command is used to get the 802.11 statistics available in the 
		station.
	
	Note: This command is available only when STA is connected.

getadhocstatus
	This command is used to get the ad-hoc Network Status.

	The various status codes are:
		AdhocStarted
		AdhocJoined
		AdhocIdle
		InfraMode
		AutoUnknownMode

	Note: This command is available only when STA is connected.

adhocgrate
	This command is used to enable(1) g_rate, Disable(0) g_rate 
	and request(2) the status which g_rate is disabled/enabled,
	for Ad-hoc creator.

	where value is:-
		0	-- Disabled
		1	-- Enabled
		2	-- Get

ledgpio
	This command is used to set/get LEDs.

	iwpriv ethX ledgpio <LEDs>
		will set the corresponding LED for the GPIO Line.

	iwpriv ethX ledgpio
		will give u which LEDs are Enabled.

	Usage:
		iwpriv eth1 ledgpio 1 0 2 1 3 4
			will enable 
			LED 1 -> GPIO 0
			LED 2 -> GPIO 1
			LED 3 -> GPIO 4

		iwpriv eth1 ledgpio 
			shows LED information in the format as mentioned above.

	Note: LED0 is invalid
	Note: Maximum Number of LEDs are 16.		
	
inactivityto
	This command is used by the host to set/get the inactivity timeout value, 
	which specifies when WLAN device is put to sleep.
	
	Usage:
		iwpriv ethX inactivityto [<timeout>]

	where the parameter are:
		timeout: timeout value in milliseconds.

	Example:
		iwpriv eth1 inactivityto
			"get the timeout value"

		iwpriv eth1 inactivityto X 
			"set timeout value to X ms"


sleeppd
	This command is used to configure the sleep period of the WLAN device.

	Usage:
		iwpriv ethX sleeppd [<sleep period>]

	where the parameter are:
		Period: sleep period in milliseconds. Range 10~60.

	Example:
		iwpriv eth1 sleeppd 10 
			"set period as 10 ms"
		iwpriv eth1 sleeppd
			"get the sleep period configuration"

enable11d
	This command is used to control 11d
	where value is:-
		1	-- Enabled
		0	-- Disabled
		2	-- Get

enable11htpc
	This command is used to control TPC

	where value is:-
		1	-- Enabled
		0	-- Disabled
		2	-- Get

wmm
	This command is used to control WMM

	where value is:-
		0	-- Disabled
		1	-- Enabled
		2	-- Get

setpowercap	
	This command is used to set the transmit power capability. MinTxPower 
	and MaxTxPower are in dbm units.
	
	Usage:
		iwpriv ethX setpowercap "5 14"
	
	set the minimum transmit power capability as 5 dbm, 
		maximum transmit power capability as 14 dbm.

setpowercons
	This command is used to set the local transmit power constraint. Value 
	is in dbm unit. This command is only used in the Ad-Hoc start.
	
	Usage:
		iwpriv ethX setpowercons 12
	
bgscan
	Enables or disables the Background scan.

	The configuration for bg scan must be set using wlanconfig

	Usage:
		wlanconfig ethX bgscanconfig bg_scan_config.conf
		iwpriv ethX bgscan 0 (disable)
		iwpriv ethX bgscan 1 (enable)
		iwpriv ethX bgscan 2 (display enable or disable)

tpccfg
	Enables or disables automatic transmit power control.