xref: /freebsd/share/man/man4/rum.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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.Dd November 8, 2018
18.Dt RUM 4
19.Os
20.Sh NAME
21.Nm rum
22.Nd Ralink Technology USB IEEE 802.11a/b/g wireless network device
23.Sh SYNOPSIS
24To compile this driver into the kernel,
25place the following lines in your
26kernel configuration file:
27.Bd -ragged -offset indent
28.Cd "device ehci"
29.Cd "device uhci"
30.Cd "device ohci"
31.Cd "device usb"
32.Cd "device rum"
33.Cd "device wlan"
34.Cd "device wlan_amrr"
35.Ed
36.Pp
37Alternatively, to load the driver as a
38module at boot time, place the following line in
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41if_rum_load="YES"
42.Ed
43.Sh DESCRIPTION
44The
45.Nm
46driver supports USB 2.0 and PCI Express Mini Card wireless adapters
47based on the Ralink RT2501USB and RT2601USB chipsets.
48.Pp
49Ralink PCI Express Mini Card adapters show up as normal USB 2.0
50devices and are thus handled by the
51.Nm
52driver.
53.Pp
54The RT2501USB chipset is the second generation of 802.11a/b/g adapters from
55Ralink.
56It consists of two integrated chips, an RT2571W MAC/BBP and an RT2528 or
57RT5226 radio transceiver.
58.Pp
59The RT2601USB chipset consists of two integrated chips, an RT2671
60MAC/BBP and an RT2527 or RT5225 radio transceiver.
61This chipset uses the MIMO (multiple-input multiple-output) technology
62with multiple antennas to extend the operating range of the adapter
63and to achieve higher throughput.
64.Pp
65All chips have hardware support for WEP, AES-CCM, TKIP, and Michael
66cryptographic operations.
67.Pp
68.Nm
69supports
70.Cm station ,
71.Cm adhoc ,
72.Cm adhoc-demo ,
73.Cm hostap ,
74and
75.Cm monitor
76mode operation.
77Only one virtual interface may be configured at any time.
78For more information on configuring this device, see
79.Xr ifconfig 8 .
80.Sh HARDWARE
81The
82.Nm
83driver supports USB 2.0 wireless
84adapters based on the Ralink RT2501USB and RT2601USB chipsets,
85including:
86.Pp
87.Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
88.It Em Card Ta Em Bus
89.It "3Com Aolynk WUB320g" Ta USB
90.It "Abocom WUG2700 Ta" Ta USB
91.It "Airlink101 AWLL5025" Ta USB
92.It "ASUS WL-167g ver 2" Ta USB
93.It "Belkin F5D7050 ver 3" Ta USB
94.It "Belkin F5D9050 ver 3" Ta USB
95.It "Buffalo WLI-U2-SG54HP" Ta USB
96.It "Buffalo WLI-U2-SG54HG" Ta USB
97.It "Buffalo WLI-U2-G54HP" Ta USB
98.It "Buffalo WLI-UC-G" Ta USB
99.It "CNet CWD-854 ver F" Ta USB
100.It "Conceptronic C54RU ver 2" Ta USB
101.It "Corega CG-WLUSB2GO" Ta USB
102.It "D-Link DWA-110" Ta USB
103.It "D-Link DWA-111" Ta USB
104.It "D-Link DWL-G122 rev C1" Ta USB
105.It "D-Link WUA-1340" Ta USB
106.It "Digitus DN-7003GR" Ta USB
107.It "Edimax EW-7318USG" Ta USB
108.It "Gigabyte GN-WB01GS" Ta USB
109.It "Gigabyte GN-WI05GS" Ta USB
110.It "Hawking HWUG1" Ta USB
111.It "Hawking HWU54DM" Ta USB
112.It "Hercules HWGUSB2-54-LB" Ta USB
113.It "Hercules HWGUSB2-54V2-AP" Ta USB
114.It "LevelOne WNC-0301USB v3" Ta USB
115.It "Linksys WUSB54G rev C" Ta USB
116.It "Linksys WUSB54GR" Ta USB
117.It "Planex GW-US54HP" Ta USB
118.It "Planex GW-US54Mini2" Ta USB
119.It "Planex GW-USMM" Ta USB
120.It "Senao NUB-3701" Ta USB
121.It "Sitecom WL-113 ver 2" Ta USB
122.It "Sitecom WL-172" Ta USB
123.It "Sweex LW053" Ta USB
124.It "TP-LINK TL-WN321G v1/v2/v3" Ta USB
125.El
126.Sh EXAMPLES
127Join an existing BSS network (i.e., connect to an access point):
128.Bd -literal -offset indent
129ifconfig wlan create wlandev rum0 inet 192.168.0.20 \e
130    netmask 0xffffff00
131.Ed
132.Pp
133Join a specific BSS network with network name
134.Dq Li my_net :
135.Pp
136.Dl "ifconfig wlan create wlandev rum0 ssid my_net up"
137.Pp
138Join a specific BSS network with 64-bit WEP encryption:
139.Bd -literal -offset indent
140ifconfig wlan create wlandev rum0 ssid my_net \e
141	wepmode on wepkey 0x1234567890 weptxkey 1 up
142.Ed
143.Pp
144Join a specific BSS network with 128-bit WEP encryption:
145.Bd -literal -offset indent
146ifconfig wlan create wlandev rum0 wlanmode adhoc ssid my_net \e
147    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
148.Ed
149.Sh DIAGNOSTICS
150.Bl -diag
151.It "rum%d: could not load 8051 microcode"
152An error occurred while attempting to upload the microcode to the onboard 8051
153microcontroller unit.
154The driver will reset the hardware.
155This should not happen.
156.El
157.Sh SEE ALSO
158.Xr intro 4 ,
159.Xr netintro 4 ,
160.Xr usb 4 ,
161.Xr wlan 4 ,
162.Xr wlan_amrr 4 ,
163.Xr wlan_ccmp 4 ,
164.Xr wlan_tkip 4 ,
165.Xr wlan_wep 4 ,
166.Xr wlan_xauth 4 ,
167.Xr hostapd 8 ,
168.Xr ifconfig 8 ,
169.Xr wpa_supplicant 8
170.Sh HISTORY
171The
172.Nm
173driver first appeared in
174.Ox 4.0 .
175.Sh AUTHORS
176.An -nosplit
177The original
178.Nm
179driver was written by
180.An Niall O'Higgins Aq Mt niallo@openbsd.org
181and
182.An Damien Bergamini Aq Mt damien@openbsd.org .
183