share/man/man4/ipw.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 March 13, 2006
  29 .Os
  30 .Dt IPW 4
  31 .Sh NAME
  32 .Nm ipw
  33 .Nd "Intel PRO/Wireless 2100 IEEE 802.11 driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device ipw"
  40 .Cd "device pci"
  41 .Cd "device wlan"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following lines in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 if_ipw_load="YES"
  49 wlan_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver provides support for the
  55 .Tn Intel
  56 PRO/Wireless 2100 MiniPCI network adapter.
  57 .Pp
  58 By default, the
  59 .Nm
  60 driver configures the adapter for BSS operation (aka infrastructure mode).
  61 This mode requires the use of an access point.
  62 .Pp
  63 For more information on configuring this device, see
  64 .Xr ifconfig 8 .
  65 .Pp
  66 .Pp
  67 This driver requires firmware to be loaded before it will work.
  68 You need to install the
  69 .Pa ports/net/ipw-firmware
  70 port before
  71 .Xr ifconfig 8
  72 will work.
  73 .Sh EXAMPLES
  74 Join an existing BSS network (i.e., connect to an access point):
  75 .Pp
  76 .Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00"
  77 .Pp
  78 Join a specific BSS network with network name
  79 .Dq Li my_net :
  80 .Pp
  81 .Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
  82 .Pp
  83 Join a specific BSS network with 40-bit WEP encryption:
  84 .Bd -literal -offset indent
  85 ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
  86     wepmode on wepkey 0x1234567890 weptxkey 1
  87 .Ed
  88 .Pp
  89 Join a specific BSS network with 104-bit WEP encryption:
  90 .Bd -literal -offset indent
  91 ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
  92     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
  93 .Ed
  94 .Sh DIAGNOSTICS
  95 .Bl -diag
  96 .It "ipw%d: device timeout"
  97 The driver will reset the hardware.
  98 This should not happen.
  99 .It "ipw%d: firmware error"
 100 The onboard microcontroller crashes for some reason.
 101 The driver will reset the hardware.
 102 This should not happen.
 103 .It "ipw%d: timeout waiting for firmware initialization to complete"
 104 The onboard microcontroller failed to initialize in time.
 105 This should not happen.
 106 .It "ipw%d: could not load firmware image '%s'"
 107 The driver failed to load the firmware image using the
 108 .Xr firmware 9
 109 subsystem.
 110 Verify that the
 111 .Pa ports/net/ipw-firmware
 112 port is installed correctly.
 113 .It "ipw%d: could not load microcode"
 114 An attempt to upload the microcode image to the onboard microcontroller failed.
 115 This should not happen.
 116 .It "ipw%d: could not load firmware"
 117 An attempt to upload the firmware image to the onboard microcontroller failed.
 118 This should not happen.
 119 .El
 120 .Sh SEE ALSO
 121 .Xr an 4 ,
 122 .Xr ath 4 ,
 123 .Xr iwi 4 ,
 124 .Xr pci 4 ,
 125 .Xr wi 4 ,
 126 .Xr wlan 4 ,
 127 .Xr ifconfig 8
 128 .Rs
 129 .%T The IPW Web Page
 130 .%O http://damien.bergamini.free.fr/ipw/
 131 .Re
 132 .Sh AUTHORS
 133 The
 134 .Nm
 135 driver was written by
 136 .An Damien Bergamini Aq damien@FreeBSD.org .