xref: /dragonfly/share/man/man4/rum.4 (revision 8e9b4bd4) 
1.\" $OpenBSD: rum.4,v 1.16 2006/10/19 16:53:48 jsg Exp $
2.\" $DragonFly: src/share/man/man4/rum.4,v 1.8 2007/09/16 19:06:26 swildner Exp $
3.\"
4.\" Copyright (c) 2005, 2006
5.\"	Damien Bergamini <damien.bergamini@free.fr>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd November 26, 2006
20.Os
21.Dt RUM 4
22.Sh NAME
23.Nm rum
24.Nd "Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver"
25.Sh SYNOPSIS
26To compile this driver into the kernel,
27place the following lines in your
28kernel 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 rum"
35.Cd "device wlan"
36.Cd "device wlan_ratectl_onoe"
37.Ed
38.Pp
39Alternatively, to load the driver as a
40module at boot time, place the following line in
41.Xr loader.conf 5 :
42.Bd -literal -offset indent
43if_rum_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver supports USB 2.0 and and PCI Express Mini Card wireless adapters based on
49the Ralink RT2501USB and RT2601USB chipsets.
50.Pp
51Ralink PCI Express Mini Card adapters show up as normal USB 2.0 devices and
52are thus handled by the
53.Nm
54driver.
55.Pp
56The RT2501USB chipset is the second generation of 802.11a/b/g adapters
57from Ralink.
58It consists of two integrated chips,
59an RT2571W MAC/BBP and an RT2528 or RT5226 radio transceiver.
60.Pp
61The RT2601USB chipset consists of two integrated chips,
62an RT2671 MAC/BBP and an RT2527 or RT5225 radio transceiver.
63This chipset uses the MIMO (multiple-input multiple-output) technology with
64multiple antennas to extend the operating range of the adapter and to achieve
65higher throughput.
66MIMO is the basis of the forthcoming IEEE 802.11n standard.
67.Sh HARDWARE
68The
69.Nm
70driver supports the following adapters:
71.Pp
72.Bl -bullet -compact
73.It
743Com Aolynk WUB320g
75.It
76Abocom WUG2700
77.It
78Airlink101 AWLL5025
79.It
80ASUS WL-167g ver 2
81.It
82Belkin F5D7050 ver 3
83.It
84Belkin F5D9050 ver 3
85.It
86Buffalo WLI-U2-SG54HP
87.It
88Buffalo WLI-U2-G54HP
89.It
90CNet CWD-854 ver F
91.It
92Conceptronic C54RU ver 2
93.It
94Corega CG-WLUSB2GO
95.It
96D-Link DWL-G122 rev C1
97.It
98D-Link WUA-1340
99.It
100Digitus DN-7003GR
101.It
102Edimax EW-7318USG
103.It
104Gigabyte GN-WB01GS
105.It
106Gigabyte GN-WI05GS
107.It
108Hawking HWUG1
109.It
110Hawking HWU54DM
111.It
112Hercules HWGUSB2-54-LB
113.It
114Hercules HWGUSB2-54V2-AP
115.It
116LevelOne WNC-0301USB v3
117.It
118Linksys WUSB54G rev C
119.It
120Linksys WUSB54GR
121.It
122Planex GW-US54HP
123.It
124Planex GW-US54Mini2
125.It
126Planex GW-USMM
127.It
128Senao NUB-3701
129.It
130Sitecom WL-113 ver 2
131.It
132Sitecom WL-172
133.It
134Sweex LW053
135.It
136TP-LINK TL-WN321G
137.El
138.Sh EXAMPLES
139Join an existing BSS network (i.e., connect to an access point):
140.Pp
141.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00"
142.Pp
143Join a specific BSS network with network name
144.Dq Li my_net :
145.Pp
146.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
147.Pp
148Join a specific BSS network with 40-bit WEP encryption:
149.Bd -literal -offset indent
150ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
151    wepmode on wepkey 0x1234567890 weptxkey 1
152.Ed
153.Pp
154Join a specific BSS network with 104-bit WEP encryption:
155.Bd -literal -offset indent
156ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
157    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
158.Ed
159.Sh DIAGNOSTICS
160.Bl -diag
161.It "rum%d: could not load 8051 microcode"
162An error occurred while attempting to upload the microcode to the onboard 8051
163microcontroller unit.
164.It "rum%d: device timeout"
165The driver will reset the hardware.
166This should not happen.
167.El
168.Sh SEE ALSO
169.Xr arp 4 ,
170.Xr ifmedia 4 ,
171.Xr netintro 4 ,
172.Xr usb 4 ,
173.Xr wlan 4 ,
174.Xr wlan_ratectl 4 ,
175.Xr hostapd 8 ,
176.Xr ifconfig 8 ,
177.Xr wpa_supplicant 8
178.Rs
179.%T "Ralink Technology"
180.%O http://www.ralinktech.com/
181.Re
182.Sh HISTORY
183The
184.Nm
185driver first appeared in
186.Ox 4.0 .
187.Sh CAVEATS
188The
189.Nm
190driver supports automatic adaptation of the transmit speed in IBSS
191and HostAP operating modes,
192but it does not work well if there are more than one peer node.
193.Sh AUTHORS
194.An -nosplit
195The
196.Nm
197driver was written by
198.An Niall O'Higgins Aq niallo@openbsd.org
199and
200.An Damien Bergamini Aq damien@openbsd.org .
201