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