share/man/man4/iwn.4

   1 .\" Copyright (c) 2004-2006
   2 .\"     Damien Bergamini <damien.bergamini@free.fr>. 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 unmodified, this list of conditions, and the following
   9 .\"    disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 25, 2009
  29 .Os
  30 .Dt IWN 4
  31 .Sh NAME
  32 .Nm iwn
  33 .Nd "Intel Wireless WiFi Link 4965/5000 IEEE 802.11n driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 include the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device iwn"
  40 .Cd "device pci"
  41 .Cd "device wlan"
  42 .Cd "device firmware"
  43 .Ed
  44 .Pp
  45 You also need to select a firmware for your device.
  46 Choose one from:
  47 .Bd -ragged -offset indent
  48 .Cd "device iwn4965fw"
  49 .Cd "device iwn5000fw"
  50 .Cd "device iwn5100fw"
  51 .Ed
  52 .Pp
  53 Or you can use
  54 .Bd -ragged -offset indent
  55 .Cd "device iwnfw"
  56 .Ed
  57 .Pp
  58 to include them all.
  59 .Pp
  60 Alternatively, to load the driver as a
  61 module at boot time, place the following lines in
  62 .Xr loader.conf 5 :
  63 .Bd -literal -offset indent
  64 if_iwn_load="YES"
  65 iwn4965fw_load="YES"
  66 iwn5000fw_load="YES"
  67 iwn5100fw_load="YES"
  68 .Ed
  69 .Sh DESCRIPTION
  70 The
  71 .Nm
  72 driver provides support for
  73 .Tn Intel
  74 Wireless WiFi Link 4965 and 5000 series of PCI-Express network adapters.
  75 .Nm
  76 supports
  77 .Cm station ,
  78 .Cm adhoc ,
  79 and
  80 .Cm monitor
  81 mode operation.
  82 Only one virtual interface may be configured at any time.
  83 For more information on configuring this device, see
  84 .Xr ifconfig 8 .
  85 .Pp
  86 This driver requires the firmware built with the
  87 .Nm iwnfw
  88 module to work.
  89 .Sh EXAMPLES
  90 Join an existing BSS network (i.e., connect to an access point):
  91 .Pp
  92 .Bd -literal -offset indent
  93 ifconfig wlan create wlandev iwn0 inet 192.168.0.20 \e
  94     netmask 0xffffff00
  95 .Ed
  96 .Pp
  97 Join a specific BSS network with network name
  98 .Dq Li my_net :
  99 .Pp
 100 .Dl "ifconfig wlan create wlandev iwn0 ssid my_net up"
 101 .Pp
 102 Join a specific BSS network with 64-bit WEP encryption:
 103 .Bd -literal -offset indent
 104 ifconfig wlan create wlandev iwn0 ssid my_net \e
 105         wepmode on wepkey 0x1234567890 weptxkey 1 up
 106 .Ed
 107 .Pp
 108 Join a specific BSS network with 128-bit WEP encryption:
 109 .Bd -literal -offset indent
 110 ifconfig wlan create wlandev iwn0 wlanmode adhoc ssid my_net \e
 111     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 112 .Ed
 113 .Sh DIAGNOSTICS
 114 .Bl -diag
 115 .It "iwn%d: device timeout"
 116 The driver will reset the hardware.
 117 This should not happen.
 118 .It "iwn%d: firmware error"
 119 The onboard microcontroller crashed for some reason.
 120 The driver will reset the hardware.
 121 This should not happen.
 122 .It "iwn%d: timeout waiting for firmware initialization to complete"
 123 The onboard microcontroller failed to initialize in time.
 124 This should not happen.
 125 .It "iwn%d: could not load firmware image '%s'"
 126 The driver failed to load the firmware image using the
 127 .Xr firmware 9
 128 subsystem.
 129 Verify the
 130 .Xr iwnfw 4
 131 firmware module is present.
 132 .It "iwn%d: could not load boot firmware"
 133 An attempt to upload the boot firmware image to the onboard microcontroller
 134 failed.
 135 This should not happen.
 136 .It "iwn%d: could not load microcode"
 137 An attempt to upload the microcode image to the onboard microcontroller failed.
 138 This should not happen.
 139 .It "iwn%d: could not load main firmware"
 140 An attempt to upload the main firmware image to the onboard microcontroller
 141 failed.
 142 This should not happen.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr iwnfw 4 ,
 146 .Xr pci 4 ,
 147 .Xr wlan 4 ,
 148 .Xr wlan_ccmp 4 ,
 149 .Xr wlan_tkip 4 ,
 150 .Xr wlan_wep 4 ,
 151 .Xr ifconfig 8 ,
 152 .Xr wpa_supplicant 8
 153 .Sh AUTHORS
 154 The original
 155 .Nm
 156 driver was written by
 157 .An Damien Bergamini Aq damien.bergamini@free.fr