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: head/share/man/man4/bwn.4 284291 2015-06-12 00:02:31Z brueffer $
  26 .\"
  27 .Dd May 26, 2016
  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 dports/sysutils/devfw-bwn
  69 port needs to be installed before
  70 .Xr ifconfig 8
  71 will work.
  72 In most cases the
  73 .Pa bwn_v4_ucode
  74 kernel module from the port should be used.
  75 However, if an LP (low power) PHY is being used, the
  76 .Pa bwn_v4_lp_ucode
  77 module should be used.
  78 .Sh HARDWARE
  79 The
  80 .Nm
  81 driver supports Broadcom BCM43xx based wireless devices, including:
  82 .Bl -column "Apple Airport Extreme" "BCM4306" "Mini PCI" "a/b/g"
  83 .It Em "Card" Ta Em "Chip" Ta Em "Bus" Ta Em "Standard"
  84 .It "Apple Airport Extreme      BCM4318 PCI     b/g"
  85 .It "ASUS WL-138g       BCM4318 PCI     b/g"
  86 .It "Buffalo WLI-CB-G54S        BCM4318 CardBus b/g"
  87 .It "Dell Wireless 1390 BCM4311 Mini PCI        b/g"
  88 .It "Dell Wireless 1470 BCM4318 Mini PCI        b/g"
  89 .It "Dell Truemobile 1400       BCM4309 Mini PCI        b/g"
  90 .It "HP Compaq 6715b    BCM4312 PCI     b/g"
  91 .It "HP nx6125  BCM4319 PCI     b/g"
  92 .It "Linksys WPC54G Ver 3       BCM4318 CardBus b/g"
  93 .It "Linksys WPC54GS Ver 2      BCM4318 CardBus b/g"
  94 .It "US Robotics 5411   BCM4318 CardBus b/g"
  95 .El
  96 .\".Pp
  97 .\"Users of older Broadcom chipsets (BCM4301, BCM4303 and BCM4306 rev 2)
  98 .\"must use
  99 .\".Xr bwi 4
 100 .\"because the v4 version of the firmware does not support these chips.
 101 .\"The newer firmware is too big to fit into these old chips.
 102 .Sh EXAMPLES
 103 Join an existing BSS network (i.e., connect to an access point):
 104 .Bd -literal -offset indent
 105 ifconfig wlan create wlandev bwn0 inet 192.168.0.20 \e
 106     netmask 0xffffff00
 107 .Ed
 108 .Pp
 109 Join a specific BSS network with network name
 110 .Dq Li my_net :
 111 .Pp
 112 .Dl "ifconfig wlan create wlandev bwn0 ssid my_net up"
 113 .Pp
 114 Join a specific BSS network with 64-bit WEP encryption:
 115 .Bd -literal -offset indent
 116 ifconfig wlan create wlandev bwn0 ssid my_net \e
 117         wepmode on wepkey 0x1234567890 weptxkey 1 up
 118 .Ed
 119 .Sh LOADER TUNABLES
 120 Tunables can be set at the
 121 .Xr loader 8
 122 prompt before booting the kernel or stored in
 123 .Xr loader.conf 5 .
 124 .Bl -tag -width indent
 125 .It Va hw.bwn.msi.enable
 126 By default, the driver will use MSI if it is supported.
 127 This behavior can be turned off by setting this tunable to 0.
 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 bwi 4 ,
 136 .Xr cardbus 4 ,
 137 .Xr ifmedia 4 ,
 138 .Xr intro 4 ,
 139 .Xr pci 4 ,
 140 .Xr wlan 4 ,
 141 .Xr wlan_amrr 4 ,
 142 .Xr ifconfig 8 ,
 143 .Xr wpa_supplicant 8
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 driver first appeared in
 148 .Fx 8.1 .
 149 .Sh AUTHORS
 150 .An -nosplit
 151 The
 152 .Nm
 153 driver was written by
 154 .An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
 155 .\".Sh BUGS
 156 .\"Some card based on the BCM4306 and BCM4309 chips do not work properly
 157 .\"on channel 1, 2 and 3.
 158 .Sh CAVEATS
 159 Some LP PHY devices have DMA operation problems.
 160 In that case try to use the PIO mode.