libertas: update README to with ethtool and debugfs information
Marcelo Tosatti
mtosatti at redhat.unroutablecom
Mon Dec 11 15:18:30 EST 2006
Commit: 550e4c915c906a5c751a0ac21b276c4bceef32b8
Parent: 99d1b96627509e9410e0af8239422ede70fbccd8
commit 550e4c915c906a5c751a0ac21b276c4bceef32b8
Author: Marcelo Tosatti <mtosatti at redhat.com>
AuthorDate: Wed Nov 29 06:02:43 2006 -0200
Commit: Marcelo Tosatti <mtosatti at redhat.com>
CommitDate: Wed Nov 29 06:02:43 2006 -0200
libertas: update README to with ethtool and debugfs information
Subject says it all.
Signed-off-by: Marcelo Tosatti <mtosatti at redhat.com>
---
drivers/net/wireless/libertas/README | 197 +++++++++++++++++++---------------
1 files changed, 108 insertions(+), 89 deletions(-)
diff --git a/drivers/net/wireless/libertas/README b/drivers/net/wireless/libertas/README
index 9747dab..041fda5 100644
--- a/drivers/net/wireless/libertas/README
+++ b/drivers/net/wireless/libertas/README
@@ -638,42 +638,39 @@ bcninterval
iwpriv ethX bcninterval (get adhoc beacon interval)
=========================
-4) FOR WLANCONFIG COMMAND
+4) ETHTOOL
=========================
-NAME
-wlanconfig - configure the additional parameters available for the Marvell
- WLAN Linux Driver.
-
-SYNOPSIS
-wlanconfig <ethX> <command> [parameters] ...
-wlanconfig ethX version
-wlanconfig ethX <rdmac|rdbbp|rdrf> <offset>
-wlanconfig ethX <wrmac|wrbbp|wrrf> <offset> <n>
-wlanconfig ethX rdeeprom <offset> <length>
-wlanconfig ethX sleepparams <config values>
-wlanconfig ethX extscan <ssid>
-wlanconfig ethX getscanlist
-Version 4 Command:
-
-Version 5 Command:
-wlanconfig ethX hostcmd <hostcmd.conf> <subevent_get>
-wlanconfig ethX hostcmd <hostcmd.conf> <subevent_set>
+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:
-Version 6 Command:
-wlanconfig ethX setuserscan [ARGS]
-wlanconfig ethX getscantable
-
-Version 8
+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
-DESCRIPTION
+========================
+5) DEBUGFS COMMANDS
+========================
-those commands are used in Marvell specic applicaion called wlanconfig.
+those commands are used via debugfs interface
===========
rdmac
@@ -681,44 +678,38 @@ 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 can be specified either in
- decimal or in hexadecimal (by preceding the number with a "0x").
+ location that is to be read. This parameter must be specified in
+ hexadecimal (its possible to preceed preceding the number with a "0x").
+
+ Path: /debugfs/libertas_wireless/ethX/registers/
Usage:
- wlanconfig ethX rdmac 0xa123
- wlanconfig ethX rdbbp 0x0123
- wlanconfig ethX rdrf 0x0123
-
+ 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 can be
- specified either in decimal or in hexadecimal (by preceding the number
+ location and the value that is to be written. This parameters must
+ be specified in hexadecimal (its possible to preceed the number
with a "0x").
Usage:
- wlanconfig ethX wrmac 0xa123 0xaa
- wlanconfig ethX wrbbp 0x0123 0xaa
- wlanconfig ethX wrrf 0x0123 0xaa
-
-
-
-
-rdeeprom
- To read the EEPROM contents of the card.
-
- Usage:
- wlanconfig ethX rdeeprom 0x00 0x10
+ echo "0xa123 0xaa" > wrmac
+ echo "0xa123 0xaa" > wrbbp
+ echo "0xa123 0xaa" > wrrf
sleepparams
This command is used to set the sleepclock configurations
+
+ Path: /debugfs/libertas_wireless/ethX/
Usage:
- wlanconfig ethX sleepparams get: reads the current sleepclock configuration
-
- wlanconfig ethX sleepparams set p1 p2 p3 p4 p5 p6: writes the sleepclock configuration.
+ 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)
@@ -728,50 +719,88 @@ sleepparams
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: /debugfs/libertas_wireless/ethX/subscribed_events/
+ Each event is represented by a filename. Each filename consists of the
+ following three fields:
+ Value Frequency Subscribed
-hostcmd <hostcmd.conf> <subevent_get>
-hostcmd <hostcmd.conf> <subevent_set>
- This command is used to set the configurations for
- event descriptor interface command.
- hostcmd.conf is a generic configuration file containing multiple configuration enties
- for subscrive event API
- subsvent_get: get subscribed event parameters
- subsvent_set: set subscribed event parameters
+ To read the current values for a given event, do:
+ cat event
+ To set the current values, do:
+ echo "60 2 1" > event
- Usage:
- wlanconfig ethX hostcmd hostcmd.conf subevent_get
- wlanconfig ethX hostcmd hostcmd.conf subevent_set
+ 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: /debugfs/libertas_wireless/ethX/
- Usage: wlanconfig ethX extscan <SSID>
+ Usage: echo "SSID" > extscan
Example:
- wlanconfig ethX extscan LINKSYS-AP
-
- To see the results of use getscanlist command.
+ echo "LINKSYS-AP" > extscan
-getscanlist
- This command is used to get the scan results.
+ To see the results of use getscantable command.
- Usage: wlanconfig ethX getscanlist
-
- Example:
- wlanconfig ethX getscanlist
+getscantable
+ Display the current contents of the driver scan table (ie. get the
+ scan results).
+ Path: /debugfs/libertas_wireless/ethX/
+ Usage:
+ cat getscantable
setuserscan
- Initiate a customized scan and retrieve the results
+ Initiate a customized scan and retrieve the results
+
+
+ Path: /debugfs/libertas_wireless/ethX/
Usage:
- wlanconfig ethX setuserscan [ARGS]
+ echo "[ARGS]" > setuserscan
where [ARGS]:
@@ -793,39 +822,29 @@ setuserscan
Examples:
1) Perform an active scan on channels 1, 6, and 11 in the 'g' band:
- setuserscan chan=1g,6g,11g
+ echo "chan=1g,6g,11g" > setuserscan
2) Perform a passive scan on channel 11 for 20 ms:
- setuserscan chan=11gp dur=20
+ echo "chan=11gp dur=20" > setuserscan
3) Perform an active scan on channels 1, 6, and 11; and a passive scan on
channel 36 in the 'a' band:
- setuserscan chan=1g,6g,11g,36ap
+
+ echo "chan=1g,6g,11g,36ap" > setuserscan
4) Perform an active scan on channel 6 and 36 for a specific SSID:
- setuserscan chan=6g,36a ssid="TestAP"
+ echo "chan=6g,36a ssid="TestAP"" > setuserscan
5) 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:
- setuserscan bssid=00:50:43:20:12:82 keep=1
+ echo "bssid=00:50:43:20:12:82 keep=1" > setuserscan
6) Scan channel 6, for all infrastructure networks, sending two probe
requests. Keep the previous scan table intact. Update any duplicate
BSSID/SSID matches with the new scan data:
- setuserscan chan=6g type=1 probes=2 keep=1
+ echo "chan=6g type=1 probes=2 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.
-
-getscantable
- Display the current contents of the driver scan table
-
- Usage:
- wlanconfig ethX getscantable
-
-
-
-
-
==============================================================================
More information about the Commits-kernel
mailing list