Add a manual page for the new bwi(4) driver (Broadcom BCM430x/4318
[dragonfly.git] / share / man / man4 / bwi.4
blob0b2fd858ff069a17af9544fafe474eca4955d026
1 .\"
2 .\" Copyright (c) 2006 The DragonFly Project.  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 .\" 
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in
12 .\"    the documentation and/or other materials provided with the
13 .\"    distribution.
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\"    contributors may be used to endorse or promote products derived
16 .\"    from this software without specific, prior written permission.
17 .\" 
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $DragonFly: src/share/man/man4/bwi.4,v 1.1 2007/09/16 18:26:18 swildner Exp $
32 .\"
33 .Dd September 16, 2007
34 .Dt BWI 4
35 .Os
36 .Sh NAME
37 .Nm bwi
38 .Nd Broadcom BCM430x/4318 IEEE 802.11b/g wireless network driver
39 .Sh SYNOPSIS
40 To load the driver as a module at boot time, place the
41 following line in
42 .Pa /boot/loader.conf :
43 .Bd -literal -offset indent
44 if_bwi_load="YES"
45 .Ed
46 .Sh DESCRIPTION
47 The
48 .Nm
49 driver provides support for Broadcom BCM430x/4318 wireless network adapters.
50 For more information on configuring this device, see
51 .Xr ifconfig 8 .
52 .Ss MIB Variables
53 The following per-interface variables are implemented in the
54 .Va hw.bwi Ns Em X
55 branch of the
56 .Xr sysctl 3
57 MIB.
58 .Bl -tag -width ".Va fw_version"
59 .It Va debug
60 Debug flags.
61 .It Va dwell_time
62 Channel dwell time during scan (msec).
63 .It Va fw_version
64 Firmware version.
65 .El
66 .Sh HARDWARE
67 The following cards are among those supported by the
68 .Nm
69 driver:
70 .Pp
71 .Bl -column -compact "Buffalo WLI-PCI-G54S" "BCM4318" "CardBus" "b/g" -offset 6n
72 .Em "Card       Chip    Bus     Standard"
73 Linksys WPC54Gv3        BCM4318 CardBus b/g
74 Buffalo WLI-PCI-G54S    BCM4306 PCI     b/g
75 Dell Wireless 1470      BCM4318 Mini PCI        b/g
76 Dell Truemobile 1400    BCM4309 Mini PCI        b/g
77 .El
78 .Sh FILES
79 The firmware for the adapter is not shipped with
80 .Dx
81 and must be obtained separately.
82 An archive with firmware files that are known to work can be found at:
83 .Bd -literal -offset indent
84 http://leaf.dragonflybsd.org/~sephe/bwi/v3.tbz
85 .Ed
86 .Pp
87 The firmware files have to reside in
88 .Pa /etc/firmware/bwi
89 and will be loaded when the interface is brought up.
90 .Sh SEE ALSO
91 .Xr arp 4 ,
92 .Xr cardbus 4 ,
93 .Xr ifmedia 4 ,
94 .Xr pci 4 ,
95 .Xr ifconfig 8
96 .Sh HISTORY
97 The
98 .Nm
99 driver first appeared in
100 .Dx 1.11 .
101 .Sh AUTHORS
102 .An -nosplit
105 driver was written by
106 .An Sepherosa Ziehau .
108 The hardware specification was reverse engineered by the people at
109 .Pa http://bcm-specs.sipsolutions.net .
110 Thanks go also to johill and mb on the #bcm-specs channel.