[deliverable/linux.git] / drivers / net / wireless / libertas / README

================================================================================
			README for Libertas

 (c) Copyright © 2003-2006, Marvell International Ltd.
 All Rights Reserved

 This software file (the "File") is distributed by Marvell International
 Ltd. under the terms of the GNU General Public License Version 2, June 1991
 (the "License").  You may use, redistribute and/or modify this File in
 accordance with the terms and conditions of the License, a copy of which
 is available along with the File in the license.txt file or by writing to
 the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 02111-1307 or on the worldwide web at http://www.gnu.org/licenses/gpl.txt.

 THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
 IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
 ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
 this warranty disclaimer.
================================================================================

=====================
DRIVER LOADING
=====================

	o. Copy the firmware image (e.g. usb8388.bin) to /lib/firmware/

	o. Load driver by using the following command:

		insmod usb8388.ko [fw_name=usb8388.bin]

=========================
ETHTOOL
=========================


Use the -i option to retrieve version information from the driver.

# ethtool -i eth0
driver: libertas
version: COMM-USB8388-318.p4
firmware-version: 5.110.7
bus-info:

Use the -e option to read the EEPROM contents of the card.

	Usage:
	ethtool -e ethX [raw on|off] [offset N] [length N]

       -e     retrieves and prints an EEPROM dump for the  specified  ethernet
              device.   When raw is enabled, then it dumps the raw EEPROM data
              to stdout. The length and offset parameters allow  dumping  cer-
              tain portions of the EEPROM.  Default is to dump the entire EEP-
              ROM.

# ethtool -e eth0 offset 0 length 16
Offset          Values
------          ------
0x0000          38 33 30 58 00 00 34 f4 00 00 10 00 00 c4 17 00

========================
DEBUGFS COMMANDS
========================

those commands are used via debugfs interface

===========
rdmac
rdbbp
rdrf
	These commands are used to read the MAC, BBP and RF registers from the
	card.  These commands take one parameter that specifies the offset
	location that is to be read.  This parameter must be specified in
	hexadecimal (its possible to precede preceding the number with a "0x").

	Path: /sys/kernel/debug/libertas_wireless/ethX/registers/

	Usage:
		echo "0xa123" > rdmac ; cat rdmac
		echo "0xa123" > rdbbp ; cat rdbbp
		echo "0xa123" > rdrf ; cat rdrf
wrmac
wrbbp
wrrf
	These commands are used to write the MAC, BBP and RF registers in the
	card.  These commands take two parameters that specify the offset
	location and the value that is to be written. This parameters must
	be specified in hexadecimal (its possible to precede the number
	with a "0x").

	Usage:
		echo "0xa123 0xaa" > wrmac
		echo "0xa123 0xaa" > wrbbp
		echo "0xa123 0xaa" > wrrf

sleepparams
	This command is used to set the sleepclock configurations

	Path: /sys/kernel/debug/libertas_wireless/ethX/

	Usage:
		cat sleepparams: reads the current sleepclock configuration

		echo "p1 p2 p3 p4 p5 p6" > sleepparams: writes the sleepclock configuration.

		where:
			p1 is Sleep clock error in ppm (0-65535)
			p2 is Wakeup offset in usec (0-65535)
			p3 is Clock stabilization time in usec (0-65535)
			p4 is Control periodic calibration (0-2)
			p5 is Control the use of external sleep clock (0-2)
			p6 is reserved for debug (0-65535)

subscribed_events

	The subscribed_events directory contains the interface for the
	subscribed events API.

	Path: /sys/kernel/debug/libertas_wireless/ethX/subscribed_events/

	Each event is represented by a filename. Each filename consists of the
	following three fields:
	Value Frequency Subscribed

	To read the current values for a given event, do:
		cat event
	To set the current values, do:
		echo "60 2 1" > event

	Frequency field specifies the reporting frequency for this event.
	If it is set to 0, then the event is reported only once, and then
	automatically unsubscribed. If it is set to 1, then the event is
	reported every time it occurs. If it is set to N, then the event is
	reported every Nth time it occurs.

	beacon_missed
	Value field specifies the number of consecutive missing beacons which
	triggers the LINK_LOSS event. This event is generated only once after
	which the firmware resets its state. At initialization, the LINK_LOSS
	event is subscribed by default. The default value of MissedBeacons is
	60.

	failure_count
	Value field specifies the consecutive failure count threshold which
	triggers the generation of the MAX_FAIL event. Once this event is
	generated, the consecutive failure count is reset to 0.
	At initialization, the MAX_FAIL event is NOT subscribed by
	default.

	high_rssi
	This event is generated when the average received RSSI in beacons goes
	above a threshold, specified by Value.

	low_rssi
	This event is generated when the average received RSSI in beacons goes
	below a threshold, specified by Value.

	high_snr
	This event is generated when the average received SNR in beacons goes
	above a threshold, specified by Value.

	low_snr
	This event is generated when the average received SNR in beacons goes
	below a threshold, specified by Value.

extscan
	This command is used to do a specific scan.

	Path: /sys/kernel/debug/libertas_wireless/ethX/

	Usage: echo "SSID" > extscan

	Example:
		echo "LINKSYS-AP" > extscan

	To see the results of use getscantable command.

getscantable

	Display the current contents of the driver scan table (ie. get the
	scan results).

	Path: /sys/kernel/debug/libertas_wireless/ethX/

	Usage:
		cat getscantable

setuserscan
	Initiate a customized scan and retrieve the results


	Path: /sys/kernel/debug/libertas_wireless/ethX/

    Usage:
       echo "[ARGS]" > setuserscan

         where [ARGS]:

      bssid=xx:xx:xx:xx:xx:xx  specify a BSSID filter for the scan
      ssid="[SSID]"            specify a SSID filter for the scan
      keep=[0 or 1]            keep the previous scan results (1), discard (0)
      dur=[scan time]          time to scan for each channel in milliseconds
      type=[1,2,3]             BSS type: 1 (Infra), 2(Adhoc), 3(Any)

    Any combination of the above arguments can be supplied on the command
    line. If dur tokens are absent, the driver default setting will be used.
    The bssid and ssid fields, if blank, will produce an unfiltered scan.
    The type field will default to 3 (Any) and the keep field will default
    to 0 (Discard).

    Examples:
    1) Perform a passive scan on all channels for 20 ms per channel:
            echo "dur=20" > setuserscan

    2) Perform an active scan for a specific SSID:
            echo "ssid="TestAP"" > setuserscan

    3) Scan all available channels (B/G, A bands) for a specific BSSID, keep
       the current scan table intact, update existing or append new scan data:
            echo "bssid=00:50:43:20:12:82 keep=1" > setuserscan

    4) Scan for all infrastructure networks.
       Keep the previous scan table intact. Update any duplicate BSSID/SSID
       matches with the new scan data:
            echo "type=1 keep=1" > setuserscan

    All entries in the scan table (not just the new scan data when keep=1)
    will be displayed upon completion by use of the getscantable ioctl.

hostsleep
	This command is used to enable/disable host sleep.
	Note: Host sleep parameters should be configured using
	"ethtool -s ethX wol X" command before enabling host sleep.

	Path: /sys/kernel/debug/libertas_wireless/ethX/

	Usage:
		cat hostsleep: reads the current hostsleep state
		echo "1" > hostsleep : enable host sleep.
		echo "0" > hostsleep : disable host sleep
Commit	Line	Data
876c9d3a	1	================================================================================
49125454	2	README for Libertas
876c9d3a	3
0e8a5bd9	4	(c) Copyright © 2003-2006, Marvell International Ltd.
876c9d3a MT	5	All Rights Reserved
	6
	7	This software file (the "File") is distributed by Marvell International
	8	Ltd. under the terms of the GNU General Public License Version 2, June 1991
	9	(the "License"). You may use, redistribute and/or modify this File in
	10	accordance with the terms and conditions of the License, a copy of which
	11	is available along with the File in the license.txt file or by writing to
	12	the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
	13	02111-1307 or on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
	14
	15	THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
	16	IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
	17	ARE EXPRESSLY DISCLAIMED. The License provides additional details about
	18	this warranty disclaimer.
	19	================================================================================
	20
	21	=====================
	22	DRIVER LOADING
	23	=====================
	24
	25	o. Copy the firmware image (e.g. usb8388.bin) to /lib/firmware/
	26
	27	o. Load driver by using the following command:
	28
	29	insmod usb8388.ko [fw_name=usb8388.bin]
	30
876c9d3a MT	31	=========================
	32	ETHTOOL
	33	=========================
	34
	35
	36	Use the -i option to retrieve version information from the driver.
	37
	38	# ethtool -i eth0
	39	driver: libertas
	40	version: COMM-USB8388-318.p4
	41	firmware-version: 5.110.7
	42	bus-info:
	43
	44	Use the -e option to read the EEPROM contents of the card.
	45
	46	Usage:
	47	ethtool -e ethX [raw on\|off] [offset N] [length N]
	48
	49	-e retrieves and prints an EEPROM dump for the specified ethernet
	50	device. When raw is enabled, then it dumps the raw EEPROM data
	51	to stdout. The length and offset parameters allow dumping cer-
	52	tain portions of the EEPROM. Default is to dump the entire EEP-
	53	ROM.
	54
	55	# ethtool -e eth0 offset 0 length 16
	56	Offset Values
	57	------ ------
	58	0x0000 38 33 30 58 00 00 34 f4 00 00 10 00 00 c4 17 00
	59
	60	========================
	61	DEBUGFS COMMANDS
	62	========================
	63
	64	those commands are used via debugfs interface
	65
	66	===========
	67	rdmac
	68	rdbbp
	69	rdrf
	70	These commands are used to read the MAC, BBP and RF registers from the
	71	card. These commands take one parameter that specifies the offset
	72	location that is to be read. This parameter must be specified in
25985edc	73	hexadecimal (its possible to precede preceding the number with a "0x").
876c9d3a	74
156f5a78	75	Path: /sys/kernel/debug/libertas_wireless/ethX/registers/
876c9d3a MT	76
	77	Usage:
	78	echo "0xa123" > rdmac ; cat rdmac
	79	echo "0xa123" > rdbbp ; cat rdbbp
	80	echo "0xa123" > rdrf ; cat rdrf
	81	wrmac
	82	wrbbp
	83	wrrf
	84	These commands are used to write the MAC, BBP and RF registers in the
	85	card. These commands take two parameters that specify the offset
	86	location and the value that is to be written. This parameters must
25985edc	87	be specified in hexadecimal (its possible to precede the number
876c9d3a MT	88	with a "0x").
	89
	90	Usage:
	91	echo "0xa123 0xaa" > wrmac
	92	echo "0xa123 0xaa" > wrbbp
	93	echo "0xa123 0xaa" > wrrf
	94
	95	sleepparams
	96	This command is used to set the sleepclock configurations
	97
156f5a78	98	Path: /sys/kernel/debug/libertas_wireless/ethX/
876c9d3a MT	99
	100	Usage:
	101	cat sleepparams: reads the current sleepclock configuration
	102
	103	echo "p1 p2 p3 p4 p5 p6" > sleepparams: writes the sleepclock configuration.
	104
	105	where:
	106	p1 is Sleep clock error in ppm (0-65535)
	107	p2 is Wakeup offset in usec (0-65535)
	108	p3 is Clock stabilization time in usec (0-65535)
	109	p4 is Control periodic calibration (0-2)
	110	p5 is Control the use of external sleep clock (0-2)
	111	p6 is reserved for debug (0-65535)
	112
	113	subscribed_events
	114
	115	The subscribed_events directory contains the interface for the
	116	subscribed events API.
	117
156f5a78	118	Path: /sys/kernel/debug/libertas_wireless/ethX/subscribed_events/
876c9d3a MT	119
	120	Each event is represented by a filename. Each filename consists of the
	121	following three fields:
	122	Value Frequency Subscribed
	123
	124	To read the current values for a given event, do:
	125	cat event
	126	To set the current values, do:
	127	echo "60 2 1" > event
	128
	129	Frequency field specifies the reporting frequency for this event.
	130	If it is set to 0, then the event is reported only once, and then
	131	automatically unsubscribed. If it is set to 1, then the event is
	132	reported every time it occurs. If it is set to N, then the event is
	133	reported every Nth time it occurs.
	134
	135	beacon_missed
	136	Value field specifies the number of consecutive missing beacons which
	137	triggers the LINK_LOSS event. This event is generated only once after
	138	which the firmware resets its state. At initialization, the LINK_LOSS
	139	event is subscribed by default. The default value of MissedBeacons is
	140	60.
	141
	142	failure_count
	143	Value field specifies the consecutive failure count threshold which
	144	triggers the generation of the MAX_FAIL event. Once this event is
	145	generated, the consecutive failure count is reset to 0.
	146	At initialization, the MAX_FAIL event is NOT subscribed by
	147	default.
	148
	149	high_rssi
	150	This event is generated when the average received RSSI in beacons goes
	151	above a threshold, specified by Value.
	152
	153	low_rssi
	154	This event is generated when the average received RSSI in beacons goes
	155	below a threshold, specified by Value.
	156
	157	high_snr
	158	This event is generated when the average received SNR in beacons goes
	159	above a threshold, specified by Value.
	160
	161	low_snr
	162	This event is generated when the average received SNR in beacons goes
	163	below a threshold, specified by Value.
	164
	165	extscan
	166	This command is used to do a specific scan.
	167
156f5a78	168	Path: /sys/kernel/debug/libertas_wireless/ethX/
876c9d3a MT	169
	170	Usage: echo "SSID" > extscan
	171
	172	Example:
	173	echo "LINKSYS-AP" > extscan
	174
	175	To see the results of use getscantable command.
	176
	177	getscantable
	178
	179	Display the current contents of the driver scan table (ie. get the
	180	scan results).
	181
156f5a78	182	Path: /sys/kernel/debug/libertas_wireless/ethX/
876c9d3a MT	183
	184	Usage:
	185	cat getscantable
	186
	187	setuserscan
	188	Initiate a customized scan and retrieve the results
	189
	190
156f5a78	191	Path: /sys/kernel/debug/libertas_wireless/ethX/
876c9d3a MT	192
	193	Usage:
	194	echo "[ARGS]" > setuserscan
	195
	196	where [ARGS]:
	197
876c9d3a MT	198	bssid=xx:xx:xx:xx:xx:xx specify a BSSID filter for the scan
	199	ssid="[SSID]" specify a SSID filter for the scan
	200	keep=[0 or 1] keep the previous scan results (1), discard (0)
	201	dur=[scan time] time to scan for each channel in milliseconds
876c9d3a MT	202	type=[1,2,3] BSS type: 1 (Infra), 2(Adhoc), 3(Any)
876c9d3a MT	203
dd1d12da	204	Any combination of the above arguments can be supplied on the command
a7d0adae HS	205	line. If dur tokens are absent, the driver default setting will be used.
	206	The bssid and ssid fields, if blank, will produce an unfiltered scan.
	207	The type field will default to 3 (Any) and the keep field will default
	208	to 0 (Discard).
876c9d3a MT	209
876c9d3a MT	210	Examples:
a7d0adae HS	211	1) Perform a passive scan on all channels for 20 ms per channel:
a7d0adae HS	212	echo "dur=20" > setuserscan
876c9d3a	213
a7d0adae HS	214	2) Perform an active scan for a specific SSID:
a7d0adae HS	215	echo "ssid="TestAP"" > setuserscan
876c9d3a	216
a7d0adae	217	3) Scan all available channels (B/G, A bands) for a specific BSSID, keep
876c9d3a MT	218	the current scan table intact, update existing or append new scan data:
	219	echo "bssid=00:50:43:20:12:82 keep=1" > setuserscan
	220
a7d0adae	221	4) Scan for all infrastructure networks.
dd1d12da HS	222	Keep the previous scan table intact. Update any duplicate BSSID/SSID
dd1d12da HS	223	matches with the new scan data:
a7d0adae	224	echo "type=1 keep=1" > setuserscan
876c9d3a MT	225
	226	All entries in the scan table (not just the new scan data when keep=1)
	227	will be displayed upon completion by use of the getscantable ioctl.
	228
1311843c AK	229	hostsleep
	230	This command is used to enable/disable host sleep.
	231	Note: Host sleep parameters should be configured using
	232	"ethtool -s ethX wol X" command before enabling host sleep.
	233
	234	Path: /sys/kernel/debug/libertas_wireless/ethX/
	235
	236	Usage:
	237	cat hostsleep: reads the current hostsleep state
	238	echo "1" > hostsleep : enable host sleep.
	239	echo "0" > hostsleep : disable host sleep
	240