4aa75fda4944c77e76276f221350a0485033fdc0
[dragonfly.git] / share / man / man4 / bwn.4
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 February 15, 2011
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
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel 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
45 Alternatively, to load the driver as a
46 module at boot time, place the following line in
47 .Xr loader.conf 5 :
48 .Bd -literal -offset indent
49 if_bwn_load="YES"
50 .Ed
51 .Sh DESCRIPTION
52 The
53 .Nm
54 driver provides support for Broadcom BCM43xx based
55 PCI/CardBus network adapters.
56 .Pp
57 It supports
58 .Cm station
59 and
60 .Cm monitor
61 mode operation.
62 Only one virtual interface may be configured at any time.
63 For more information on configuring this device, see
64 .Xr ifconfig 8 .
65 .Pp
66 This driver requires firmware to be loaded before it will work.
67 The
68 .Pa ports/net/bwn-firmware-kmod
69 port needs to be installed before
70 .Xr ifconfig 8
71 will work.
72 Most cases you need to use bwn_v4_ucode module but if you are a
73 LP (low power) PHY user please uses bwn_v4_lp_ucode module.
74 .Sh HARDWARE
75 The
76 .Nm
77 driver supports Broadcom BCM43xx based wireless devices, including:
78 .Bl -column "Apple Airport Extreme" "BCM4306" "Mini PCI" "a/b/g"
79 .It Em "Card" Ta Em "Chip" Ta Em "Bus" Ta Em "Standard"
80 .It "Apple Airport Extreme      BCM4318 PCI     b/g"
81 .It "ASUS WL-138g       BCM4318 PCI     b/g"
82 .It "Buffalo WLI-CB-G54S        BCM4318 CardBus b/g"
83 .It "Dell Wireless 1390 BCM4311 Mini PCI        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
93 Users of older Broadcom chipsets (BCM4301, BCM4303 and BCM4306 rev 2)
94 must use
95 .Xr bwi 4
96 because the v4 version of the firmware does not support these chips.
97 The newer firmware is too big to fit into these old chips.
98 .Sh EXAMPLES
99 Join an existing BSS network (i.e., connect to an access point):
100 .Bd -literal -offset indent
101 ifconfig wlan create wlandev bwn0 inet 192.168.0.20 \e
102     netmask 0xffffff00
103 .Ed
104 .Pp
105 Join 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
110 Join a specific BSS network with 64-bit WEP encryption:
111 .Bd -literal -offset indent
112 ifconfig wlan create wlandev bwn0 ssid my_net \e
113         wepmode on wepkey 0x1234567890 weptxkey 1 up
114 .Ed
115 .Sh LOADER TUNABLES
116 Tunables can be set at the
117 .Xr loader 8
118 prompt before booting the kernel or stored in
119 .Xr loader.conf 5 .
120 .Bl -tag -width indent
121 .It Va hw.bwn.msi_disable
122 This tunable disables MSI support on the hardware.
123 The default value is 0.
124 .It Va hw.bwn.usedma
125 This tunable enables DMA operations on the hardware.
126 If the value is 0, PIO mode would be used.
127 The 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
140 The
141 .Nm
142 driver first appeared in
143 .Fx 8.1 .
144 .Sh AUTHORS
145 .An -nosplit
146 The
147 .Nm
148 driver was written by
149 .An Weongyo Jeong
150 .Aq weongyo@FreeBSD.org .
151 .\".Sh BUGS
152 .\"Some card based on the BCM4306 and BCM4309 chips do not work properly
153 .\"on channel 1, 2 and 3.
154 .Sh CAVEATS
155 Some LP PHY devices have DMA operation problems that in that case try to
156 use PIO mode.