Company Products/Technology Services News/Events Support Spacer Contact Partners Customers
English    日本語
Products Photo

Product Documentation for
Devicescape Universal Wireless Platform

Documentation Home for Devicescape Universal Wireless Platform | Package Guide

Package GuidePreviousNextIndex

 


broadcom-wl package

Information on this package is covered here.

Package
Description
License
broadcom-wl
Wireless tools to support the Broadcom driver (broadcom-drv)

Summary

This is Broadcom's wl command line utility. It can be used to both configure the wl driver (see broadcom-wl-drv package for more information) and to get status information from the driver.

Usage

Command Line Options

Syntax for the wl utility is as follows:

wl [-a|i <adapter>] [-hu] <command> [arguments]

Where -a or -i can be followed by adapter name or number and -h or -u prints a list of commands and description. (-h indicates for "help", -u indicates "usage").

Commands and arguments for the wl utility are described in the following table.

Command
Description and Arguments
aciargs
Get/Set various aci tuning parameters. Choices are:
  • enter - CRS glitch trigger level to start detecting ACI
  • exit - CRS glitch trigger level to exit ACI mode
  • glitch - Seconds interval between ACI scans when glitchcount is continuously high
  • spin - Number in microseconds to delay between RSSI samples
Syntax: wl aciargs [enter x][exit x][spin x][glitch x]
add_ie
Add a vendor proprietary IE to 802.11 management packets
Syntax: wl add_ie <pktflag> length OUI hexdata
<pktflag>:
Bit 0 - Beacons
Bit 1 - Probe Rsp
Bit 2 - Assoc/Reassoc Rsp
Bit 3 - Auth Rsp
Example:
wl add_ie 3 10 00:90:4C 0101050c121a03
adds this IE to beacons and probe responses
addwep
Set an encryption key. The key must be 5, 13 or 16 bytes long, or 10, 26, 32, or 64 hex digits long. The encryption algorithm is automatically selected based on the key size. keytype is accepted only when key length is 16 bytes/32 hex digits and specifies whether AES-OCB or AES-CCM encryption is used.
Default is ccm.
addwep <keyindex> <keydata> [ocb|ccm] [notx] [xx:xx:xx:xx:xx:xx]
aes
Set AES options.
wl aes [options]
The options are:
[on|enable|1] enables AES
[off|disable|0] disables AES
[sw|software] performs AES in software
[hw|hardware] performs AES in hardware
a_mrate
Force a fixed multicast rate for the A PHY:
  • For 802.11a, valid values are (6, 9, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
antdiv
Set antenna diversity for rx:
  • 0 - force use of antenna 0
  • 1 - force use of antenna 1
  • 3 - automatic selection of antenna diversity
ap
Set Access Point (AP) mode:
  • 0 - STA
  • 1 - AP
a_rate
Force a fixed rate for the A PHY:
  • For 802.11a, valid values are (6, 9, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
assoc
Print information about current network association (also known as "status").
assoclist
AP only: Get the list of associated MAC addresses.
atten
Set the transmit attenuation for B band. Arguments: bb radio txctl1.
auto to revert to automatic control
authe_sta_list
Get authenticated STA's MAC address list
authorize
Restrict traffic to 802.1X packets until 802.1X authorization succeeds.
band
Returns or sets the current band
  • auto - auto switch between available bands (default)
  • a - force use of 802.11a band
  • b - force use of 802.11b band
bands
Return the list of available 802.11 bands.
bg_mrate
Force a fixed multicast rate for the B/G PHY:
  • For 802.11b, valid values are (1, 2, 5.5, 11)
  • For 802.11g, valid values are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
bg_rate
Force a fixed rate for the B/G PHY:
  • For 802.11b, valid values are (1, 2, 5.5, 11)
  • For 802.11g, valid values are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
bi
Get/Set the Beacon period (bi stands for "Beacon interval")
bssid
Get the BSSID value, error if STA and not associated.
cap
Driver capabilities
chan_info
Channel information.
chanlist
Return valid channels for the current settings.
channel
Set the channel:
For 802.11b/g (2.4GHz band), valid channels are 1 through 14
For 802.11a (5 GHz band), valid channels are:
36, 40, 44, 48, 52, 56, 60, 64,
100, 104, 108, 112, 116,120, 124, 128, 132, 136, 140,
149, 153, 157, 161,
184, 188, 192, 196, 200, 204, 208, 212, 216
channel_qa
Get last channel quality measurment
channel_qa_start
Start a channel quality measurment
channels
Return valid channels for the current settings.
channels_in_country
Return valid channels for the country specified.
  • Argument 1 is the country abbreviation
  • Argument 2 is the band (a or b)
clk
Set board clock state. Return error for set_clk attempt if the driver is not down
  • 0 sets clock off
  • 1 sets clock on
cmds
Generate a short list of available commands.
constraint
Send an 802.11h Power Constraint IE
Syntax: wl constraint 1-255 db
country
Select Country code for use with 802.11d.
Use either long name or abbreviation from ISO 3166.
Use "wl country list [band(a or b)]" for the list of supported countries
crsuprs
Manufacturing test: set carrier suppression mode.
Syntax is: crsuprs <channel>
Valid argument is a channel number 1-14, or 0 to stop the test.
csa
Send an 802.11h channel switch anouncement
Syntax: wl csa <mode> <WhenInTBTTs> <channel>
curpower
Return current tx power settings
cwmax
Set the cwmax. (integer [256, 2047])
cwmax is the Maximum Contention Window for QoS priotizations. The value specified in cwmax is the upper limit (in milliseconds) for the doubling of the random backoff value. This doubling continues until either the data frame is sent or the cwmax size is reached.
Once cwmax size is reached, retries will continue until a maximum number of retries allowed is reached.
The value for cwmax must be greater than or equal to the value for "cwmin". (cwmax >= cwmin)
cwmin
Set the cwmin. (integer [1, 255])
cwmin is the size of the Minimum Contention Window QoS priotizations. This parameter is input to the algorithm that determines the initial random backoff wait time ("window") for retry of a transmission. The value specified for cwmin is the upper limit (in milliseconds) of a range from which the initial random backoff wait time is determined.
The first random number generated will be a number between 0 and the number specified here.
If the first random backoff wait time expires before the data frame is sent, a retry counter is incremented and the random backoff value (window) is doubled. Doubling will continue until the size of the random backoff value reaches the number defined for cwmax.
The value for cwmin must be lower than the value for "cwmax". (cwmin < cwmax)
deauthenticate
Deauthenticate a STA from the Access Point with optional reason code (AP ONLY)
deauthorize
Do not restrict traffic to 802.1X packets until 802.1X authorization succeeds.
del_ie
Delete a vendor proprietary IE from 802.11 management packets
Syntax: wl del_ie <pktflag> length OUI hexdata
<pktflag>:
Bit 0 - Beacons
Bit 1 - Probe Rsp
Bit 2 - Assoc/Reassoc Rsp
Bit 3 - Auth Rsp
Example: wl del_ie 3 10 00:90:4C 0101050c121a03
disassoc
Disassociate from the current BSS/IBSS.
down
Reset and mark adapter down (disabled).
dtim
Get/Set Delivery Traffic Information Map (DTIM)
dump
Print driver software state and chip registers to stdout.
eap
Restrict traffic to 802.1X packets until 802.1X authorization succeeds:
  • 0 - disable
  • 1 - enable
evm
Start an EVM test on the given channel, or stop EVM test.
  • Argument 1 is channel number 1-14, or "off" or 0 to stop the test.
  • Argument 2 is optional rate (1, 2, 5.5 or 11)
fasttimer
Get/Set High frequency watchdog timeout (tx_power) [15 sec]
fqacurcy
Manufacturing test: set frequency accuracy mode.
Syntax is: fqacurcy <channel>
Valid argument is a channel numbers 1-14, or 0 to stop the test.
frag
Set the fragmentation threshhold. (integer [256, 2346])
frameburst
Disable/Enable frameburst mode.
glacialtimer
Get/Set Very Low frequency watchdog timeout (measurelo) [120 sec]
gmode
Set the 54g Mode.
The syntax and options are:
gmode [LegacyB|Auto||GOnly|BDeferred|Performance|LRS]
gmode_protection
Get G protection mode:
  • 0 - disabled
  • 1 - enabled
gmode_protection_control
Get/Set 11g protection mode control algorithm. The options are:
  • 0 - always off
  • 1 - monitor local association
  • 2 - monitor overlapping BSS)
gmode_protection_cts
Get/Set 11g protection type to CTS:
  • 0 - disable
  • 1 - enable
gmode_protection_override
Get/Set 11g protection mode override:
  • -1 - auto
  • 0 - disable
  • 1 - enable
ignore_bcns
AP only (G mode): Check for beacons without NONERP element.
  • 0 - Examine beacons
  • 1 - Ignore beacons
infra
Set Infrastructure mode:
  • 0 - IBSS
  • 1 - Infra BSS
int
Interrupt Test.
Remember to precede by "wl down" and follow by "wl up"
interference
Get/Set interference mitigation mode. Choices are:
  • 0 - none
  • 1 - non wlan
  • 2 - wlan manual
  • 3 - wlan automatic
isup
Get driver operational state:
  • 0 - down
  • 1 - up
join
Join a specified network SSID.
Join syntax is:
join <ssid> [key xxxxx] [imode bss|ibss] [amode open|shared|wpa|wpapsk|wpanone]
keys
Prints a list of the current WEP keys
lazywds
Set or get "lazy" WDS mode (dynamically grant WDS membership to anyone).
lbt
Loopback Test.
Remember to precede by "wl down" and follow by "wl up"
leap
Set parameters for LEAP authentication:
leap <ssid> <username> <password> [domain]
legacy_erp
Get/Set 11g legacy ERP inclusion:
  • 0 - disable
  • 1 - enable
list_ie
Dump the list of vendor proprietary IEs
locale
OBSOLETE: use "wl country"
Select the country:
Worldwide
Thailand
Israel
Jordan
China
Japan
USA/Canada/ANZ
Europe
USAlow
JapanHigh
All
lrl
Set the long retry limit. (integer [1, 255])
mac
Set or get the list of source MAC address matches.
wl mac xx:xx:xx:xx:xx:xx [xx:xx:xx:xx:xx:xx ...]
To Clear the list: wl mac none
macmode
Set the mode of the MAC list:
  • 0 - Disable MAC address matching.
  • 1 - Deny association to stations on the MAC list.
  • 2 - Allow association to stations on the MAC list.
macreg
Get/Set any MAC registers (include IHR and SB) macreg offset size[2,4] [value]
malloc_dump
Debug malloc information.
measure_req
Send an 802.11h measurement request.
Syntax: wl measure_req <type> <TargetMACAddress>
Measurement types are TPC, Basic, CCA, RPI
Target MAC address format is xx:xx:xx:xx:xx:xx
monitor
Set monitor mode:
  • 0 - disable
  • 1 - enable active monitor mode (interface still operates)
mrate
Force a fixed multicast rate:
  • For 802.11a, valid values are (6, 9, 12, 18, 24, 36, 48, 54)
  • For 802.11b, valid values are (1, 2, 5.5, 11)
  • For 802.11g, valid values are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
msglevel
Set driver console debugging message bitvector type 'wl msglevel ?' for values
noise
Get noise (moving average) right after tx in dBm.
nvget
Get the value of an nvram variable.
nvdump
Print nvram variables to stdout.
nvset
Set an nvram variable name=value (no spaces around '=')
out
Mark adapter down but do not reset hardware(disabled).
On dualband cards, cards must be bandlocked before use.
passive
Puts scan engine into passive mode.
phylist
Return the list of available phytypes.
phyreg
Get/Set a phy register.
phytype
Get phy type
pktcnt
Get the summary of good and bad packets.
plcphdr
Set the plcp header. Valid settings are:
  • long
  • auto
  • debug
powerindex
Set the transmit power for A band. Valid values are 0 - 63.
-1 - default value
prb_resp_timeout
Get/Set probe response timeout
primary_key
Set/Get index of primary key.
PM
Set driver power management mode:
  • 0 - CAM (constantly awake)
  • 1 - PS (power-save)
  • 2 - FAST PS mode
promisc
Set promiscuous mode ethernet address reception:
  • 0 - disable
  • 1 - enable
pwr_percent
Get/Set power output percentage
quiet
Send an 802.11h quiet command.
Syntax:
wl quiet <TBTTsUntilStart>, <DurationInTUs)>,
<OffsetInTUs>
radar
Enable/Disable radar
radio
Set the radio on or off. The options are:
radioreg
Get/Set a radio register.
rand
Get a 2-byte Random Number from the MAC's PRNG.
Syntax: wl rand
rate
Force a fixed rate:
  • For 802.11a, valid values are (6, 9, 12, 18, 24, 36, 48, 54)
  • For 802.11b, valid values are (1, 2, 5.5, 11)
  • For 802.11g, valid values are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54)
  • -1 (which is the default) means automatically determine the best rate
ratedump
Print driver rate selection tunables and per-scb state to stdout based on remote station mac address [xx:xx:xx:xx:xx:xx]
rateparam
Set driver rate selection tunables.
  • Argument 1: tunable ID
  • Argument 2: Tunable value
rateset
Returns or sets the supported and basic rateset, (b) indicates basic
With no arguments, returns the rateset. Arguments are:
rateset "default" | "all" | <arbitrary rateset>
  • default - driver defaults
  • all - all rates are basic rates
  • arbitrary rateset - list of rates
List of rates are in Mbps and each rate is optionally followed by "(b)" or "b" for a Basic rate. Example: 1(b) 2b 5.5 11
At least one rate must be Basic for a legal rateset.
reboot
Reboot platform.
regulatory
Get or set the regulatory domain mode (802.11d). Driver must be down.
restart
Restart driver. Driver must already be down.
revinfo
Get hardware revision information.
rmwep
Remove the encryption key at the specified key index.
roam_delta
Set the roam candidate qualification delta. (integer)
roam_scan_period
Set the roam candidate qualification delta. (integer)
roam_trigger
Set the roam trigger RSSI threshold. (integer)
rm_rep
Get current radio measurement report
rm_req
Request a radio measurement of type basic, cca, or rpi.
Specify a series of measurement types each followed by options.
For example: wl rm_req cca -c 1 -d 50 cca -c 6 cca -c 11
The options are:
  • -t <Number> indicates a numeric token ID for measurement set or measurement
  • -c <Number> indicates channel number
  • -d <Number> indicates duration in TUs (1024 us)
  • -p <Number> indicates parallel flag, measurement starts at the same time as previous
rssi
Get the current Received Signal Strength Indication (RSSI) value for an AP. You must specify the MAC addrress of the STA.
rssidump
Dump rssi (RSSI) values from aci scans.
rts
Set the RTS threshhold. (integer [0, 2347])
scan
Initiate a scan.
The default is an active scan across all channels for any SSID.
Optional argument: SSID, the SSID to scan.
The options are:
  • -s <SSIDName> or --ssid=<SSIDName>
    Indicates which SSID to scan
  • -t <ScanType> or --scan_type=<ScanType>
    [active|passive] scan type
  • --bss_type=<BSSType>
    [bss/infra|ibss/adhoc] bss type to scan
  • -b <MACAddress> or --bssid=<MACAddress>
    Indicates particular BSSID MAC address to scan, xx:xx:xx:xx:xx:xx
  • -n <NumberOfProbes> or --nprobes=<NumberOfProbes>
    number of probes per scanned channel
  • -a <Number> or --active=<Number>
    dwell time per channel for active scanning
  • -p <Number> or --passive=<Number>
    dwell time per channel for passive scanning
  • -h <Number> or --home=<Number>
    dwell time for the home channel between channel scans
  • -c or --channels=<ListOfChannels>
    comma or space-separated list of channels to scan
scan_channel_time
Get/Set scan channel time.
scan_home_time
Get/Set scan home channel dwell time.
scan_nprobes
Get/Set scan parameter for number of probes to use per channel scanned.
scan_passive_time
Get/Set passive scan channel dwell time.
scanresults
Return results from last scan.
scansuppress
Suppress all scans for testing.
  • 0 - allow scans
  • 1 - suppress scans
scan_unassoc_time
Get/Set unassociated scan channel dwell time.
scbdump
Print driver scb state to stdout
scb_timeout
AP only: inactivity timeout value for authenticated STAs
set_pmk
Set passphrase for PMK in driver-resident supplicant.
shmem
Get/Set a shared memory location.
shortslot
Get current 11g Short Slot Timing mode. (0=long, 1=short)
shortslot_override
Get/Set 11g Short Slot Timing mode override. (-1=auto, 0=long, 1=short)
shortslot_restrict
Get/Set Access Point (AP) Restriction on associations for 11g Short Slot Timing capable STAs.
  • 0 - Do not restrict association based on ShortSlot capability
  • 1 - Restrict association to STAs with ShortSlot capability
slowtimer
Get/Set Low frequency watchdog timeout (nrssislope) [60 sec]
spect
Get or set 802.11h Spectrum Management mode.
  • 0 - Off
  • 1 - Loose interpretation of spec - may join non-11h APs
  • 2 - Strict interpretation of spec - may not join non-11h APs
srdump
Print contents of SPROM to stdout.
srl
Set the short retry limit. (integer [1, 255])
ssid
Set or get the current SSID.
Setting will initiate an assoication attempt if in infrastructure mode, or join/creation of an IBSS if in IBSS mode, or creation of a BSS if in AP mode.
sta_info
wl sta_info <xx:xx:xx:xx:xx:xx>
status
Print information about current network association (also known as "assoc").
suprates
Returns or sets the 11g override for the supported rateset.
With no arguments, returns the rateset. Arguments are a list of rates, or 0 or -1 to specify an empty rateset to clear the override.
List of rates are in Mbps; for example: 1 2 5.5 11
tkip
Set TKIP options.
wl tkip [options]
  • [on|enable|1] enables TKIP
  • [off|disable|0] disables TKIP
  • [sw|software] performs TKIP in software
  • [hw|hardware] performs TKIP in hardware
tkip_countermeasures
Enable or disable TKIP countermeasures (TKIP-enabled Access Point only):
  • 0 - disable
  • 1 - enable
tsc
Print Tx Sequence Couter for key at specified key index.
tssi
Get the tssi value from radio.
txant
Set the transmit antenna:
  • 0 - force use of antenna 0
  • 1 - force use of antenna 1
  • 3 - use the RX antenna selection that was in force during the most recently received good PLCP header
txpathpwr
Turn the tx path power on or off on 2050 radios
txpwr
Set tx power in milliwatts. Range [1, 84]. (Deprecated: Use txpwr1 instead)
txpwr1
Set tx power in in various units. Choose one of the following:
  • -d indicates dbm units (this is the default)
  • -q indicates quarter dbm units
  • -m indicates milliwatt units
Can be combined with:
  • -o specifies to turn on override to disable regulatory and other limitations
Use "wl txpwr -1" to restore defaults
txpwrlimit
Return current tx power limit
ucflags
Get/Set ucode flags
up
Reinitialize and mark adapter up (operational).
upgrade
Upgrade the firmware on an embedded device
ver
Get version information.
wake
Set driver power-save mode sleep state:
  • 0 - core-managed
  • 1 - awake
wds
Set or get the list of WDS member MAC addresses.
Set using a space separated list of MAC addresses.
wl wds xx:xx:xx:xx:xx:xx [xx:xx:xx:xx:xx:xx ...]
wds_remote_mac
Get WDS link remote endpoint's MAC address
wds_wpa_role
Get/Set WDS link local endpoint's WPA role
wds_wpa_role_old
Get WDS link local endpoint's WPA role (Deprecated)
wep
Set WEP options.
wl wep [options]
  • [on|enable|1] enables WEP
  • [off|disable|0] disables WEP
  • [sw|software] performs WEP in software
  • [hw|hardware] performs WEP in hardware
wepstatus
Set or get WEP status:
wepstatus [on|off]
wet
Get/Set wireless ethernet bridging mode
wme
Set WMM (Wireless Multimedia Extensions) mode.
  • 0 - off
  • 1 - on
WMM (formerly WME) extends QoS, which originally applied to access point only, by enabling priority differentiation of media types on the client.
With WMM enabled, QoS prioritization and coordination of wireless medium access is on. With WMM enabled, QoS settings on the Access Point (AP) control downstream traffic flowing from the access point to client station and the upstream traffic flowing from the station to the AP.
Disabling WMM will deactivate QoS control of station parameters on upstream traffic flowing from the station to the AP. With WMM disabled, you can still set some parameters on the downstream traffic flowing from the access point to the client station (AP EDCA parameters).
wme-ac
WMM access category to determine priority of media being transmitted by client station (STA) or Access Point (AP).
Syntax:
wl wme-ac sta/ap [vo, vi, be, bk] [ecwmax, ecwmin, txop, aifsn, acm] value
  • vo - Voice access category. Highest priority queue, minimum delay. Time-sensitive data such as VoIP and streaming media are automatically sent to this queue.
  • vi - Video access category. High priority queue, minimum delay. Time-sensitive video data is automatically sent to this queue.
  • be - Best effort access category. Medium priority queue, medium throughput and delay. Most traditional IP data is sent to this queue.
  • bk - background - Lowest priority queue, high throughput. Bulk data that requires maximum throughput and is not time-sensitive is sent to this queue (FTP data, for example).
  • txop -
  • aifsn - The Arbitration Inter-Frame Spacing (AIFs) specifies a wait time (in milliseconds) for data frames.
wpa_auth
Bitvector of WPA authorization modes:
  • 1 - WPA NONE
  • 2 - WPA-802.1X/WPA-Professional
  • 4 - WPA-PSK/WPA-Personal
  • 8 - CCKM (WPA)
  • 16 - CCKM (WPA2)
  • 64 - WPA2-802.1X/WPA2-Professional
  • 128 - WPA2-PSK/WPA2-Personal
  • 0 - disable WPA
wsec
Wireless security bit vector:
  • 1 - WEP enabled
  • 2 - TKIP enabled
  • 4 - AES enabled
  • 8 - WSEC in software
wsec_restrict
Drop unencrypted packets if WSEC is enabled:
  • 0 - disable
  • 1 - enable
wsec_test
Generate wsec errors:
  • wsec_test <test_type> <keyindex|xx:xx:xx:xx:xx:xx>
  • type "wl wsec_test ?" for test_types

Building the Package

Follow standard instructions for building kernel modules in the Devicescape Developer Guide topic on "Building the Packages", see subtopic: "Building a Kernel Module from a Source RPM"

Licensing

Broadcom

Related Packages

Required

broadcom-wl-drv package

Suggested

None

Package GuidePreviousNextIndex