Add an ifmedia(4) reference to the manpages of all drivers that support
[dragonfly.git] / share / man / man4 / ural.4
1 .\" Copyright (c) 2005, 2006
2 .\"     Damien Bergamini <damien.bergamini@free.fr>
3 .\"
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .\" $FreeBSD: src/share/man/man4/ural.4,v 1.11 2006/10/07 18:18:40 flz Exp $
17 .\" $DragonFly: src/share/man/man4/ural.4,v 1.4 2007/02/25 12:03:07 swildner Exp $
18 .\"
19 .Dd November 26, 2006
20 .Os
21 .Dt URAL 4
22 .Sh NAME
23 .Nm ural
24 .Nd "Ralink Technology RT2500USB IEEE 802.11 driver"
25 .Sh SYNOPSIS
26 To compile this driver into the kernel,
27 place the following lines in your
28 kernel configuration file:
29 .Bd -ragged -offset indent
30 .Cd "device ehci"
31 .Cd "device uhci"
32 .Cd "device ohci"
33 .Cd "device usb"
34 .Cd "device ural"
35 .Cd "device wlan"
36 .Cd "device wlan_ratectl_onoe"
37 .Ed
38 .Pp
39 Alternatively, to load the driver as a
40 module at boot time, place the following line in
41 .Xr loader.conf 5 :
42 .Bd -literal -offset indent
43 if_ural_load="YES"
44 .Ed
45 .Sh DESCRIPTION
46 The
47 .Nm
48 driver supports USB 2.0 wireless adapters based on the RT2500USB chipset.
49 .Pp
50 The RT2500USB chipset consists of two integrated chips, a RT2570 MAC/BBP
51 and a radio transceiver (the model of which depends on the card revision).
52 .Pp
53 The RT2522, RT2523, RT2524, RT2525, RT2525e and RT2526 radio transceivers
54 operate in the 2.4GHz band (802.11b/g) whereas the RT5222 is a dual-band radio
55 transceiver that can operate in the 2.4GHz and 5.2GHz bands (802.11a).
56 .Sh HARDWARE
57 The
58 .Nm
59 driver supports the following adapters:
60 .Pp
61 .Bl -bullet -compact
62 .It
63 AMIT WL532U
64 .It
65 ASUS WL-167g
66 .It
67 Belkin F5D7050 v2000
68 .It
69 Buffalo WLI-U2-KG54
70 .It
71 Buffalo WLI-U2-KG54-AI
72 .It
73 Buffalo WLI-U2-KG54-YB
74 .It
75 CNet CWD-854
76 .It
77 Compex WLU54G 2A1100
78 .It
79 Conceptronic C54RU
80 .It
81 D-Link DWL-G122 b1
82 .It
83 Dynalink WLG25USB
84 .It
85 E-Tech WGUS02
86 .It
87 Eminent 3035
88 .It
89 Gigabyte GN-WBKG
90 .It
91 Hercules HWGUSB2-54
92 .It
93 KCORP LifeStyle KLS-685
94 .It
95 Linksys HU200-TS
96 .It
97 Linksys WUSB54G v4
98 .It
99 Linksys WUSB54GP v4
100 .It
101 MSI MS-6861
102 .It
103 MSI MS-6865
104 .It
105 MSI MS-6869
106 .It
107 Nintendo Wi-Fi USB Connector
108 .It
109 NovaTech NV-902
110 .It
111 OvisLink Evo-W54USB
112 .It
113 SerComm UB801R
114 .It
115 SparkLAN WL-685R
116 .It
117 Sphairon UB801R
118 .It
119 Surecom EP-9001-g
120 .It
121 Sweex LC100060
122 .It
123 Tonze UW-6200C
124 .It
125 Zaapa ZNWUSB-54
126 .It
127 Zinwell ZPlus-G250
128 .It
129 Zinwell ZWX-G261
130 .It
131 Zonet ZEW2500P
132 .El
133 .Pp
134 An up to date list can be found at
135 .Pa http://ralink.rapla.net/ .
136 .Sh EXAMPLES
137 Join an existing BSS network (i.e., connect to an access point):
138 .Pp
139 .Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00"
140 .Pp
141 Join a specific BSS network with network name
142 .Dq Li my_net :
143 .Pp
144 .Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
145 .Pp
146 Join a specific BSS network with 40-bit WEP encryption:
147 .Bd -literal -offset indent
148 ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
149     wepmode on wepkey 0x1234567890 weptxkey 1
150 .Ed
151 .Pp
152 Join a specific BSS network with 104-bit WEP encryption:
153 .Bd -literal -offset indent
154 ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
155     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
156 .Ed
157 .Sh DIAGNOSTICS
158 .Bl -diag
159 .It "ural%d: device timeout"
160 The driver will reset the hardware.
161 This should not happen.
162 .El
163 .Sh SEE ALSO
164 .Xr arp 4 ,
165 .Xr ifmedia 4 ,
166 .Xr netintro 4 ,
167 .Xr usb 4 ,
168 .Xr wlan 4 ,
169 .Xr ifconfig 8
170 .Rs
171 .%T "Ralink Technology"
172 .%O http://www.ralinktech.com/
173 .Re
174 .Sh HISTORY
175 The
176 .Nm
177 driver first appeared in
178 .Ox 3.7 .
179 .Sh CAVEATS
180 The
181 .Nm
182 driver supports automatic adaptation of the transmit speed in IBSS
183 and HostAP operating modes,
184 but it does not work well if there are more than one peer node.
185 .Sh AUTHORS
186 The
187 .Nm
188 driver was written by
189 .An Damien Bergamini Aq damien@FreeBSD.org .