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 233992 2012-04-07 09:05:30Z joel $
  26 .\"
  27 .Dd April 5, 2014
  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 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 if_bwn_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for Broadcom BCM43xx based
  54 PCI/CardBus network adapters.
  55 .Pp
  56 It supports
  57 .Cm station
  58 and
  59 .Cm monitor
  60 mode operation.
  61 Only one virtual interface may be configured at any time.
  62 For more information on configuring this device, see
  63 .Xr ifconfig 8 .
  64 .Pp
  65 This driver requires firmware to be loaded before it will work.
  66 The
  67 .Pa dports/net/bwn-firmware-kmod
  68 port needs to be installed before
  69 .Xr ifconfig 8
  70 will work.
  71 In most cases you need to use the bwn_v4_ucode module but if you are a
  72 LP (low power) PHY user please use the bwn_v4_lp_ucode module.
  73 .Sh HARDWARE
  74 The
  75 .Nm
  76 driver supports Broadcom BCM43xx based wireless devices, including:
  77 .Bl -column "Apple Airport Extreme" "BCM4306" "Mini PCI" "a/b/g"
  78 .It Em "Card" Ta Em "Chip" Ta Em "Bus" Ta Em "Standard"
  79 .It "Apple Airport Extreme      BCM4318 PCI     b/g"
  80 .It "ASUS WL-138g       BCM4318 PCI     b/g"
  81 .It "Buffalo WLI-CB-G54S        BCM4318 CardBus b/g"
  82 .It "Dell Wireless 1390 BCM4311 Mini PCI        b/g"
  83 .It "Dell Wireless 1470 BCM4318 Mini PCI        b/g"
  84 .It "Dell Truemobile 1400       BCM4309 Mini PCI        b/g"
  85 .It "HP Compaq 6715b    BCM4312 PCI     b/g"
  86 .It "HP nx6125  BCM4319 PCI     b/g"
  87 .It "Linksys WPC54G Ver 3       BCM4318 CardBus b/g"
  88 .It "Linksys WPC54GS Ver 2      BCM4318 CardBus b/g"
  89 .It "US Robotics 5411   BCM4318 CardBus b/g"
  90 .El
  91 .\".Pp
  92 .\"Users of older Broadcom chipsets (BCM4301, BCM4303 and BCM4306 rev 2)
  93 .\"must use
  94 .\".Xr bwi 4
  95 .\"because the v4 version of the firmware does not support these chips.
  96 .\"The newer firmware is too big to fit into these old chips.
  97 .Sh EXAMPLES
  98 Join an existing BSS network (i.e., connect to an access point):
  99 .Bd -literal -offset indent
 100 ifconfig wlan create wlandev bwn0 inet 192.168.0.20 \e
 101     netmask 0xffffff00
 102 .Ed
 103 .Pp
 104 Join a specific BSS network with network name
 105 .Dq Li my_net :
 106 .Pp
 107 .Dl "ifconfig wlan create wlandev bwn0 ssid my_net up"
 108 .Pp
 109 Join a specific BSS network with 64-bit WEP encryption:
 110 .Bd -literal -offset indent
 111 ifconfig wlan create wlandev bwn0 ssid my_net \e
 112         wepmode on wepkey 0x1234567890 weptxkey 1 up
 113 .Ed
 114 .Sh LOADER TUNABLES
 115 Tunables can be set at the
 116 .Xr loader 8
 117 prompt before booting the kernel or stored in
 118 .Xr loader.conf 5 .
 119 .Bl -tag -width indent
 120 .It Va hw.bwn.msi.enable
 121 By default, the driver will use MSI if it is supported.
 122 This behavior can be turned off by setting this tunable to 0.
 123 .It Va hw.bwn.usedma
 124 This tunable enables DMA operations on the hardware.
 125 If the value is 0, PIO mode would be used.
 126 The default value is 1.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr arp 4 ,
 130 .\".Xr bwi 4 ,
 131 .Xr cardbus 4 ,
 132 .Xr ifmedia 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.
 156 In that case try to use the PIO mode.