xref: /freebsd/share/man/man4/bwn.4 (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
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.Dd December 16, 2017
26.Dt BWN 4
27.Os
28.Sh NAME
29.Nm bwn
30.Nd Broadcom BCM43xx SoftMAC IEEE 802.11 wireless network driver
31.Sh SYNOPSIS
32To compile this driver into the kernel, add the following lines to the kernel
33configuration file:
34.Bd -ragged -offset indent
35.Cd "device bwn"
36.Cd "device bhnd"
37.Cd "device bhndb"
38.Cd "device bhndb_pci"
39.Cd "device bcma"
40.Cd "device siba"
41.Cd "device gpio"
42.Cd "device wlan"
43.Cd "device wlan_amrr"
44.Cd "device firmware"
45.Ed
46.Pp
47To load the driver as a module at boot, add the following lines to
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50if_bwn_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for Broadcom BCM43xx based
56PCI/CardBus network adapters.
57.Pp
58It supports
59.Cm station
60and
61.Cm monitor
62mode operation.
63Only one virtual interface may be configured at any time.
64For more information on configuring this device, see
65.Xr ifconfig 8 .
66.Pp
67This driver requires firmware to be loaded before it will work.
68The
69.Pa ports/net/bwn-firmware-kmod
70port needs to be installed before
71.Xr ifconfig 8
72will work.
73In most cases the
74.Pa bwn_v4_ucode
75kernel module from the port should be used.
76However, if an LP (low power) PHY is being used, the
77.Pa bwn_v4_lp_ucode
78module should be used.
79.Sh HARDWARE
80The
81.Nm
82driver supports Broadcom BCM43xx based wireless devices, including:
83.Bl -column "Apple Airport Extreme" "BCM4306" "Mini PCI" "a/b/g"
84.It Em "Card" Ta Em "Chip" Ta Em "Bus" Ta Em "Standard"
85.It "Apple Airport Extreme	BCM4318	PCI	b/g"
86.It "ASUS WL-138g	BCM4318	PCI	b/g"
87.It "Buffalo WLI-CB-G54S	BCM4318	CardBus	b/g"
88.It "Dell Wireless 1390	BCM4311	Mini PCI	b/g"
89.It "Dell Wireless 1470	BCM4318	Mini PCI	b/g"
90.It "Dell Truemobile 1400	BCM4309	Mini PCI	b/g"
91.It "HP Compaq 6715b	BCM4312	PCI	b/g"
92.It "HP nx6125	BCM4319	PCI	b/g"
93.It "Linksys WPC54G Ver 3	BCM4318	CardBus	b/g"
94.It "Linksys WPC54GS Ver 2	BCM4318	CardBus	b/g"
95.It "US Robotics 5411	BCM4318	CardBus	b/g"
96.El
97.Pp
98Users of older Broadcom chipsets (BCM4301, BCM4303 and BCM4306 rev 2)
99must use
100.Xr bwi 4
101because the v4 version of the firmware does not support these chips.
102The newer firmware is too big to fit into these old chips.
103.Sh EXAMPLES
104Join an existing BSS network (i.e., connect to an access point):
105.Bd -literal -offset indent
106ifconfig wlan create wlandev bwn0 inet 192.168.0.20 \e
107    netmask 0xffffff00
108.Ed
109.Pp
110Join a specific BSS network with network name
111.Dq Li my_net :
112.Pp
113.Dl "ifconfig wlan create wlandev bwn0 ssid my_net up"
114.Pp
115Join a specific BSS network with 64-bit WEP encryption:
116.Bd -literal -offset indent
117ifconfig wlan create wlandev bwn0 ssid my_net \e
118        wepmode on wepkey 0x1234567890 weptxkey 1 up
119.Ed
120.Sh LOADER TUNABLES
121Tunables can be set at the
122.Xr loader 8
123prompt before booting the kernel or stored in
124.Xr loader.conf 5 .
125.Bl -tag -width indent
126.It Va hw.bwn.usedma
127This tunable enables DMA operations on the hardware.
128If the value is 0, PIO mode would be used.
129The default value is 1.
130.El
131.Sh SEE ALSO
132.Xr arp 4 ,
133.Xr bcma 4 ,
134.Xr bhnd 4 ,
135.Xr bhndb 4 ,
136.Xr bwi 4 ,
137.Xr cardbus 4 ,
138.Xr intro 4 ,
139.Xr pci 4 ,
140.Xr siba 4 ,
141.Xr wlan 4 ,
142.Xr wlan_amrr 4 ,
143.Xr ifconfig 8 ,
144.Xr wpa_supplicant 8
145.Sh HISTORY
146The
147.Nm
148driver first appeared in
149.Fx 8.1 .
150The driver was updated to support the common Broadcom
151.Xr bhnd 4
152bus interface in
153.Fx 12.0 .
154.Sh AUTHORS
155.An -nosplit
156The
157.Nm
158driver was written by
159.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
160Support for
161.Xr bhnd 4
162was added by
163.An Landon Fuller Aq Mt landonf@FreeBSD.org .
164.\".Sh BUGS
165.\"Some card based on the BCM4306 and BCM4309 chips do not work properly
166.\"on channel 1, 2 and 3.
167.Sh CAVEATS
168Some LP PHY devices have DMA operation problems that in that case try to
169use PIO mode.
170