xref: /freebsd/share/man/man4/rum.4 (revision 721351876cd4d3a8a700f62d2061331fa951a488)
1.\"
2.\" Copyright (c) 2005-2007
3.\"	Damien Bergamini <damien.bergamini@free.fr>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.\" $FreeBSD$
18.\"
19.Dd April 13, 2008
20.Os
21.Dt RUM 4
22.Sh NAME
23.Nm rum
24.Nd Ralink Technology USB IEEE 802.11a/b/g wireless network device
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_amrr"
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 PCI Express Mini Card wireless adapters
49based on the Ralink RT2501USB and RT2601USB chipsets.
50.Pp
51Ralink PCI Express Mini Card adapters show up as normal USB 2.0
52devices and are thus handled by the
53.Nm
54driver.
55.Pp
56The RT2501USB chipset is the second generation of 802.11a/b/g adapters from
57Ralink.
58It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 or
59RT5226 radio transceiver.
60.Pp
61The RT2601USB chipset consists of two integrated chips, an RT2671
62MAC/BBP and an RT2527 or RT5225 radio transceiver.
63This chipset uses the MIMO (multiple-input multiple-output) technology
64with multiple antennas to extend the operating range of the adapter
65and to achieve higher throughput.
66.Pp
67.Nm
68supports
69.Cm station ,
70.Cm adhoc ,
71.Cm hostap ,
72and
73.Cm monitor
74mode operation.
75Only one virtual interface may be configured at any time.
76For more information on configuring this device, see
77.Xr ifconfig 8 .
78.Sh HARDWARE
79The
80.Nm
81driver supports USB 2.0 wireless
82adapters based on the Ralink RT2501USB and RT2601USB chipsets,
83including:
84.Pp
85.Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
86.It Em Card Ta Em Bus
87.It "3Com Aolynk WUB320g" Ta USB
88.It "Abocom WUG2700 Ta" Ta USB
89.It "Airlink101 AWLL5025" Ta USB
90.It "ASUS WL-167g ver 2" Ta USB
91.It "Belkin F5D7050 ver 3" Ta USB
92.It "Belkin F5D9050 ver 3" Ta USB
93.It "Buffalo WLI-U2-SG54HP" Ta USB
94.It "Buffalo WLI-U2-G54HP" Ta USB
95.It "CNet CWD-854 ver F" Ta USB
96.It "Conceptronic C54RU ver 2" Ta USB
97.It "Corega CG-WLUSB2GO" Ta USB
98.It "D-Link DWL-G122 rev C1" Ta USB
99.It "D-Link WUA-1340" Ta USB
100.It "Digitus DN-7003GR" Ta USB
101.It "Edimax EW-7318USG" Ta USB
102.It "Gigabyte GN-WB01GS" Ta USB
103.It "Gigabyte GN-WI05GS" Ta USB
104.It "Hawking HWUG1" Ta USB
105.It "Hawking HWU54DM" Ta USB
106.It "Hercules HWGUSB2-54-LB" Ta USB
107.It "Hercules HWGUSB2-54V2-AP" Ta USB
108.It "LevelOne WNC-0301USB v3" Ta USB
109.It "Linksys WUSB54G rev C" Ta USB
110.It "Linksys WUSB54GR" Ta USB
111.It "Planex GW-US54HP" Ta USB
112.It "Planex GW-US54Mini2" Ta USB
113.It "Planex GW-USMM" Ta USB
114.It "Senao NUB-3701" Ta USB
115.It "Sitecom WL-113 ver 2" Ta USB
116.It "Sitecom WL-172" Ta USB
117.It "Sweex LW053" Ta USB
118.It "TP-LINK TL-WN321G" Ta USB
119.El
120.Sh EXAMPLES
121Join an existing BSS network (i.e., connect to an access point):
122.Pp
123.Bd -literal -offset indent
124ifconfig wlan create wlandev rum0 inet 192.168.0.20 \e
125    netmask 0xffffff00
126.Ed
127.Pp
128Join a specific BSS network with network name
129.Dq Li my_net :
130.Pp
131.Dl "ifconfig wlan create wlandev rum0 ssid my_net up"
132.Pp
133Join a specific BSS network with 64-bit WEP encryption:
134.Bd -literal -offset indent
135ifconfig wlan create wlandev rum0 ssid my_net \e
136	wepmode on wepkey 0x1234567890 weptxkey 1 up
137.Ed
138.Pp
139Join a specific BSS network with 128-bit WEP encryption:
140.Bd -literal -offset indent
141ifconfig wlan create wlandev rum0 wlanmode adhoc ssid my_net \e
142    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
143.Ed
144.Sh DIAGNOSTICS
145.Bl -diag
146.It "rum%d: could not load 8051 microcode"
147An error occurred while attempting to upload the microcode to the onboard 8051
148microcontroller unit.
149The driver will reset the hardware.
150This should not happen.
151.El
152.Sh SEE ALSO
153.Xr intro 4 ,
154.Xr netintro 4 ,
155.Xr usb 4 ,
156.Xr wlan 4 ,
157.Xr wlan_amrr 4 ,
158.Xr wlan_ccmp 4 ,
159.Xr wlan_tkip 4 ,
160.Xr wlan_wep 4 ,
161.Xr wlan_xauth 4 ,
162.Xr ifconfig 8 ,
163.Xr hostapd 8 ,
164.Xr wpa_supplicant 8 .
165.Rs
166.%T "Ralink Technology"
167.%O http://www.ralinktech.com/
168.Re
169.Sh HISTORY
170The
171.Nm
172driver first appeared in
173.Ox 4.0 .
174.Sh AUTHORS
175The original
176.Nm
177driver was written by
178.An Niall O'Higgins Aq niallo@openbsd.org
179and
180.An Damien Bergamini Aq damien@openbsd.org .
181