share/man/man4/iwn.4

   1 .\" $NetBSD: iwn.4,v 1.6 2009/03/09 19:24:28 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 2007,2008
   4 .\"     Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
   5 .\"
   6 .\" Permission to use, copy, modify, and distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .Dd May 18, 2009
  19 .Dt IWN 4
  20 .Os
  21 .Sh NAME
  22 .Nm iwn
  23 .Nd Intel Wireless 4965AGN IEEE 802.11 driver
  24 .Sh SYNOPSIS
  25 .Cd "iwn* at pci? dev ? function ?"
  26 .Sh DESCRIPTION
  27 The
  28 .Nm
  29 driver provides support for
  30 .Tn Intel
  31 Wireless WiFi Link 4965AGN Mini PCI Express network adapters.
  32 .Pp
  33 By default, the
  34 .Nm
  35 driver configures the adapter for BSS operation (aka infrastructure mode).
  36 This mode requires the use of an access point.
  37 .Pp
  38 For more information on configuring this device, see
  39 .Xr ifconfig 8 .
  40 .Sh CONFIGURATION
  41 The
  42 .Nm
  43 driver can be configured at runtime with
  44 .Xr ifconfig 8
  45 using the following parameters:
  46 .Bl -tag -width Ds
  47 .It Cm bssid Ar bssid
  48 Set the desired BSSID.
  49 .It Fl bssid
  50 Unset the desired BSSID.
  51 The interface will automatically select a BSSID in this mode, which is
  52 the default.
  53 .It Cm chan Ar n
  54 Set the channel (radio frequency) to be used by the driver based on
  55 the given channel ID
  56 .Ar n .
  57 .It Fl chan
  58 Unset the desired channel to be used by the driver.
  59 The driver will automatically select a channel in this mode, which is
  60 the default.
  61 .It Cm media Ar media
  62 The
  63 .Nm
  64 driver supports the following
  65 .Ar media
  66 types:
  67 .Pp
  68 .Bl -tag -width autoselect -compact
  69 .It Cm autoselect
  70 Enable autoselection of the media type and options.
  71 .El
  72 .It Cm mediaopt Ar opts
  73 The
  74 .Nm
  75 driver supports the following media options:
  76 .Pp
  77 .Bl -tag -width monitor -compact
  78 .It Cm monitor
  79 Select monitor mode.
  80 .El
  81 .It Fl mediaopt Ar opts
  82 Disable the specified media options on the driver and return it to the
  83 default mode of operation (BSS).
  84 .It Cm mode Ar mode
  85 The
  86 .Nm
  87 driver supports the following modes:
  88 .Pp
  89 .Bl -tag -width 11b -compact
  90 .It Cm 11a
  91 Force 802.11a operation.
  92 .It Cm 11b
  93 Force 802.11b operation.
  94 .It Cm 11g
  95 Force 802.11g operation.
  96 .El
  97 .It Cm nwid Ar id
  98 Set the network ID.
  99 The
 100 .Ar id
 101 can either be any text string up to 32 characters in length,
 102 or a series of hexadecimal digits up to 64 digits.
 103 An empty
 104 .Ar id
 105 string allows the interface to connect to any available access points.
 106 By default the
 107 .Nm
 108 driver uses an empty string.
 109 Note that network ID is synonymous with Extended Service Set ID (ESSID).
 110 .It Cm nwkey Ar key
 111 Enable WEP encryption using the specified
 112 .Ar key .
 113 The
 114 .Ar key
 115 can either be a string, a series of hexadecimal digits (preceded by
 116 .Sq 0x ) ,
 117 or a set of keys of the form
 118 .Dq n:k1,k2,k3,k4 ,
 119 where
 120 .Sq n
 121 specifies which of the keys will be used for transmitted packets,
 122 and the four keys,
 123 .Dq k1
 124 through
 125 .Dq k4 ,
 126 are configured as WEP keys.
 127 If a set of keys is specified, a comma
 128 .Pq Sq \&,
 129 within the key must be escaped with a backslash.
 130 Note that if multiple keys are used, their order must be the same within
 131 the network.
 132 .Nm
 133 is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
 134 or 104-bit (13 characters or 26 hexadecimal digits) keys.
 135 .It Fl nwkey
 136 Disable WEP encryption.
 137 This is the default mode of operation.
 138 .El
 139 .Sh EXAMPLES
 140 The following
 141 .\" .Xr hostname.if 5 ,
 142 example configures iwn0 to join whatever network is available on boot,
 143 using WEP key
 144 .Dq 0x1deadbeef1 ,
 145 channel 11, obtaining an IP address using DHCP:
 146 .Bd -literal -offset indent
 147 dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
 148 .Ed
 149 .Pp
 150 Configure iwn0 for WEP, using hex key
 151 .Dq 0x1deadbeef1 :
 152 .Bd -literal -offset indent
 153 # ifconfig iwn0 nwkey 0x1deadbeef1
 154 .Ed
 155 .Pp
 156 Return iwn0 to its default settings:
 157 .Bd -literal -offset indent
 158 # ifconfig iwn0 -bssid -chan media autoselect \e
 159         nwid "" -nwkey
 160 .Ed
 161 .Pp
 162 Join an existing BSS network,
 163 .Dq my_net :
 164 .Bd -literal -offset indent
 165 # ifconfig iwn0 192.168.1.1 netmask 0xffffff00 nwid my_net
 166 .Ed
 167 .Sh DIAGNOSTICS
 168 .Bl -diag
 169 .It "iwn%d: device timeout"
 170 A frame dispatched to the hardware for transmission did not complete in time.
 171 The driver will reset the hardware.
 172 This should not happen.
 173 .It "iwn%d: fatal firmware error"
 174 For some reason, the firmware crashed.
 175 The driver will reset the hardware.
 176 This should not happen.
 177 .It "iwn%d: radio is disabled by hardware switch"
 178 The radio transmitter is off and thus no packet can go out.
 179 The driver will reset the hardware.
 180 Make sure the laptop radio switch is on.
 181 .It "iwn%d: error %d, could not read firmware %s"
 182 For some reason, the driver was unable to read the firmware image from the
 183 filesystem.
 184 The file might be missing or corrupted.
 185 .It "iwn%d: firmware file too short: %d bytes"
 186 The firmware image is corrupted and can't be loaded into the adapter.
 187 .It "iwn%d: could not load firmware"
 188 An attempt to load the firmware into the adapter failed.
 189 The driver will reset the hardware.
 190 .El
 191 .Sh SEE ALSO
 192 .Xr arp 4 ,
 193 .Xr ifmedia 4 ,
 194 .Xr intro 4 ,
 195 .Xr netintro 4 ,
 196 .Xr pci 4 ,
 197 .\" .Xr hostname.if 5 ,
 198 .Xr ifconfig 8
 199 .Sh AUTHORS
 200 The
 201 .Nm
 202 driver and this man page were written by
 203 .An Damien Bergamini Aq damien.bergamini@free.fr .