- Add manpage for rum(4)
[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.1 2006/12/10 05:03:20 sephe 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-AI
70 .It
71 CNet CWD-854
72 .It
73 Compex WLU54G 2A1100
74 .It
75 Conceptronic C54RU
76 .It
77 D-Link DWL-G122 b1
78 .It
79 Dynalink WLG25USB
80 .It
81 E-Tech WGUS02
82 .It
83 Gigabyte GN-WBKG
84 .It
85 Hercules HWGUSB2-54
86 .It
87 KCORP LifeStyle KLS-685
88 .It
89 Linksys WUSB54G v4
90 .It
91 Linksys WUSB54GP v4
92 .It
93 MSI MS-6861
94 .It
95 MSI MS-6865
96 .It
97 MSI MS-6869
98 .It
99 NovaTech NV-902
100 .It
101 OvisLink Evo-W54USB
102 .It
103 SerComm UB801R
104 .It
105 SparkLAN WL-685R
106 .It
107 Surecom EP-9001-g
108 .It
109 Sweex LC100060
110 .It
111 Tonze UW-6200C
112 .It
113 Zinwell ZWX-G261
114 .It
115 Zonet ZEW2500P
116 .El
117 .Pp
118 An up to date list can be found at
119 .Pa http://ralink.rapla.net/ .
120 .Sh EXAMPLES
121 Join an existing BSS network (i.e., connect to an access point):
122 .Pp
123 .Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00"
124 .Pp
125 Join a specific BSS network with network name
126 .Dq Li my_net :
127 .Pp
128 .Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
129 .Pp
130 Join a specific BSS network with 40-bit WEP encryption:
131 .Bd -literal -offset indent
132 ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
133     wepmode on wepkey 0x1234567890 weptxkey 1
134 .Ed
135 .Pp
136 Join a specific BSS network with 104-bit WEP encryption:
137 .Bd -literal -offset indent
138 ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
139     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
140 .Ed
141 .Sh DIAGNOSTICS
142 .Bl -diag
143 .It "ural%d: device timeout"
144 The driver will reset the hardware.
145 This should not happen.
146 .El
147 .Sh SEE ALSO
148 .Xr arp 4 ,
149 .Xr netintro 4 ,
150 .Xr usb 4 ,
151 .Xr wlan 4 ,
152 .Xr ifconfig 8
153 .Rs
154 .%T "Ralink Technology"
155 .%O http://www.ralinktech.com/
156 .Re
157 .Sh HISTORY
158 The
159 .Nm
160 driver first appeared in
161 .Ox 3.7 .
162 .Sh CAVEATS
163 .Pp
164 The
165 .Nm
166 driver supports automatic adaptation of the transmit speed in IBSS
167 and HostAP operating modes,
168 but it does not work well if there are more than one peer node.
169 .Sh AUTHORS
170 The
171 .Nm
172 driver was written by
173 .An Damien Bergamini Aq damien@FreeBSD.org .