xref: /freebsd/share/man/man4/bwn.4 (revision 050570efa79efcc9cf5adeb545f1a679c8dc377b)
1.\" Copyright (c) 2009 Christian Brueffer
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 12, 2010
28.Dt BWN 4
29.Os
30.Sh NAME
31.Nm bwn
32.Nd Broadcom BCM43xx IEEE 802.11b/g wireless network driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device siba_bwn"
39.Cd "device bwn"
40.Cd "device wlan"
41.Cd "device wlan_amrr"
42.Cd "device firmware"
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_bwn_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver provides support for Broadcom BCM43xx based
55PCI/CardBus network adapters.
56.Pp
57It supports
58.Cm station
59and
60.Cm monitor
61mode operation.
62Only one virtual interface may be configured at any time.
63For more information on configuring this device, see
64.Xr ifconfig 8 .
65.Pp
66This driver requires firmware to be loaded before it will work.
67The
68.Pa ports/net/bwn-firmware-kmod
69port needs to be installed before
70.Xr ifconfig 8
71will work.
72Most cases you need to use bwn_v4_ucode module but if you are a
73LP (low power) PHY user please uses bwn_v4_lp_ucode module.
74.Sh HARDWARE
75The
76.Nm
77driver supports Broadcom BCM43xx based wireless devices, including:
78.Pp
79.Bl -column -compact "Apple Airport Extreme" "BCM4306" "Mini PCI" "a/b/g" -offset 6n
80.It Em "Card	Chip	Bus	Standard"
81.It "Apple Airport Extreme	BCM4318	PCI	b/g"
82.It "ASUS WL-138g	BCM4318	PCI	b/g"
83.It "Buffalo WLI-CB-G54S	BCM4318	CardBus	b/g"
84.It "Dell Wireless 1470	BCM4318	Mini PCI	b/g"
85.It "Dell Truemobile 1400	BCM4309	Mini PCI	b/g"
86.It "HP Compaq 6715b	BCM4312	PCI	b/g"
87.It "HP nx6125	BCM4319	PCI	b/g"
88.It "Linksys WPC54G Ver 3	BCM4318	CardBus	b/g"
89.It "Linksys WPC54GS Ver 2	BCM4318	CardBus	b/g"
90.It "US Robotics 5411	BCM4318	CardBus	b/g"
91.El
92.Pp
93Users of older Broadcom chipsets (BCM4301, BCM4303 and BCM4306 rev 2)
94must use
95.Xr bwi 4
96because the v4 version of the firmware does not support these chips.
97The newer firmware is too big to fit into these old chips.
98.Sh EXAMPLES
99Join an existing BSS network (i.e., connect to an access point):
100.Bd -literal -offset indent
101ifconfig wlan create wlandev bwn0 inet 192.168.0.20 \e
102    netmask 0xffffff00
103.Ed
104.Pp
105Join a specific BSS network with network name
106.Dq Li my_net :
107.Pp
108.Dl "ifconfig wlan create wlandev bwn0 ssid my_net up"
109.Pp
110Join a specific BSS network with 64-bit WEP encryption:
111.Bd -literal -offset indent
112ifconfig wlan create wlandev bwn0 ssid my_net \e
113        wepmode on wepkey 0x1234567890 weptxkey 1 up
114.Ed
115.Sh LOADER TUNABLES
116Tunables can be set at the
117.Xr loader 8
118prompt before booting the kernel or stored in
119.Xr loader.conf 5 .
120.Bl -tag -width indent
121.It Va hw.bwn.msi_disable
122This tunable disables MSI support on the hardware.
123The default value is 0.
124.It Va hw.bwn.usedma
125This tunable enables DMA operations on the hardware.
126If the value is 0, PIO mode would be used.
127The default value is 1.
128.El
129.Sh SEE ALSO
130.Xr arp 4 ,
131.Xr bwi 4 ,
132.Xr cardbus 4 ,
133.Xr intro 4 ,
134.Xr pci 4 ,
135.Xr wlan 4 ,
136.Xr wlan_amrr 4 ,
137.Xr ifconfig 8 ,
138.Xr wpa_supplicant 8
139.Sh HISTORY
140The
141.Nm
142driver first appeared in
143.Fx 8.1 .
144.Sh CAVEATS
145Some LP PHY devices have DMA operation problems that in that case try to
146use PIO mode.
147.Sh AUTHORS
148.An -nosplit
149The
150.Nm
151driver was written by
152.An Weongyo Jeong
153.Aq weongyo@FreeBSD.org .
154.\".Sh BUGS
155.\"Some card based on the BCM4306 and BCM4309 chips do not work properly
156.\"on channel 1, 2 and 3.
157