1fd48d76bd86010f86be39620553d2de83c01b86
[dragonfly.git] / share / man / man4 / iwi.4
1 .\"
2 .\" Copyright (c) 2004, 2005
3 .\"     Damien Bergamini <damien.bergamini@free.fr>.
4 .\" Copyright (c) 2004, 2005
5 .\"     Andrew Atrens <atrens@nortelnetworks.com>.
6 .\"
7 .\" All rights reserved.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice unmodified, this list of conditions, and the following
14 .\"    disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $DragonFly: src/share/man/man4/iwi.4,v 1.10 2007/09/16 19:06:26 swildner Exp $
32 .\"
33 .Dd March 1, 2005
34 .Os
35 .Dt IWI 4
36 .Sh NAME
37 .Nm iwi
38 .Nd Intel(R) PRO/Wireless 2200BG/2915ABG IEEE 802.11 driver
39 .Sh SYNOPSIS
40 .Cd "device iwi"
41 .Cd "device pci"
42 .Cd "device wlan"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for Intel(R) PRO/Wireless 2200BG and 2915ABG MiniPCI
47 network adapters.
48 .Pp
49 By default, the
50 .Nm
51 driver configures the adapter for BSS operation (aka infrastructure mode).
52 This mode requires the use of an access point.
53 .Pp
54 In addition IBSS operation (aka adhoc mode) is also supported. This mode requires
55 special ibss firmware. See
56 .Xr iwicontrol 8
57 for more details on how to load firmware.
58 .Pp
59 For more (general) information on configuring this device, see
60 .Xr ifconfig 8 .
61 .Sh EXAMPLES
62 Join an existing BSS network (ie: connect to an access point):
63 .Pp
64 .Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00"
65 .Pp
66 Join a specific BSS network with network name
67 .Dq Li my_net :
68 .Pp
69 .Dl "ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
70 .Pp
71 Join a specific BSS network with 64 bits WEP encryption:
72 .Bd -literal -offset indent
73 ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
74         wepmode on wepkey 0x1234567890
75 .Ed
76 .Pp
77 Join a specific BSS network with 128bits WEP encryption:
78 .Bd -literal -offset indent
79 ifconfig iwi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
80         wepmode on wepkey 0x01020304050607080910111213
81 .Ed
82 .Pp
83 To join or create an IBSS network, use something like:
84 .Bd -literal -offset indent
85 ifconfig iwi0 192.168.0.20 netmask 0xffffff00 ssid my_net \e
86         mediaopt adhoc
87 .Ed
88 .Pp
89 To debug a network setup, you may wish to enable interface debugging:
90 .Bd -literal -offset indent
91 ifconfig iwi0 down debug up
92 .Ed
93 .Pp
94 To disable debugging, you may simply use:
95 .Bd -literal -offset indent
96 ifconfig iwi0 down -debug up
97 .Ed
98 .Sh WORTH NOTING
99 It's worth noting that in BSS mode if you haven't specified an
100 ssid, the driver will auto-assign an ssid, joining the best
101 network available.
102 .Pp
103 In IBSS mode you must specify an ssid for the driver to join a network.
104 If no network exists with the ssid name you have chosen the driver will
105 auto-create a standalone IBSS network that others may later join. This
106 behaviour is on by default, and may be controlled by -
107 .Bd -literal -offset indent
108 wicontrol iwi0 -c 0     Disables network auto-create behaviour.
109 .Ed
110 .Bd -literal -offset indent
111 wicontrol iwi0 -c 1     Enables network auto-create behaviour.
112 .Ed
113 .Sh DIAGNOSTICS
114 .Bl -diag
115 .It "iwi%d: firmware reset"
116 The driver has reset the firmware. This shouldn't but may occasionally happen.
117 .It "iwi%d: device timeout"
118 The driver will reset the hardware. This should not happen.
119 .El
120 .Sh SEE ALSO
121 .Xr an 4 ,
122 .Xr ifmedia 4 ,
123 .Xr pci 4 ,
124 .Xr wi 4 ,
125 .Xr wlan 4 ,
126 .Xr ifconfig 8 ,
127 .Xr iwicontrol 8 ,
128 .Xr wicontrol 8 ,
129 .Xr wpa_supplicant 8
130 .Sh AUTHORS
131 .An -nosplit
132 The
133 .Nm
134 driver and this man page were derived from those written by
135 .An Damien Bergamini Aq damien.bergamini@free.fr .
136 .Pp
137 .Dx
138 enhancements and IBSS support were written by
139 .An Andrew Atrens Aq atrens@nortel.com .