xref: /freebsd/share/man/man4/rum.4 (revision cbd30a72ca196976c1c700400ecd424baa1b9c16)
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 June 9, 2016
20.Dt RUM 4
21.Os
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
67All chips have hardware support for WEP, AES-CCM, TKIP, and Michael
68cryptographic operations.
69.Pp
70.Nm
71supports
72.Cm station ,
73.Cm adhoc ,
74.Cm adhoc-demo ,
75.Cm hostap ,
76and
77.Cm monitor
78mode operation.
79Only one virtual interface may be configured at any time.
80For more information on configuring this device, see
81.Xr ifconfig 8 .
82.Sh HARDWARE
83The
84.Nm
85driver supports USB 2.0 wireless
86adapters based on the Ralink RT2501USB and RT2601USB chipsets,
87including:
88.Pp
89.Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
90.It Em Card Ta Em Bus
91.It "3Com Aolynk WUB320g" Ta USB
92.It "Abocom WUG2700 Ta" Ta USB
93.It "Airlink101 AWLL5025" Ta USB
94.It "ASUS WL-167g ver 2" Ta USB
95.It "Belkin F5D7050 ver 3" Ta USB
96.It "Belkin F5D9050 ver 3" Ta USB
97.It "Buffalo WLI-U2-SG54HP" Ta USB
98.It "Buffalo WLI-U2-SG54HG" Ta USB
99.It "Buffalo WLI-U2-G54HP" Ta USB
100.It "Buffalo WLI-UC-G" Ta USB
101.It "CNet CWD-854 ver F" Ta USB
102.It "Conceptronic C54RU ver 2" Ta USB
103.It "Corega CG-WLUSB2GO" Ta USB
104.It "D-Link DWA-110" Ta USB
105.It "D-Link DWA-111" Ta USB
106.It "D-Link DWL-G122 rev C1" Ta USB
107.It "D-Link WUA-1340" Ta USB
108.It "Digitus DN-7003GR" Ta USB
109.It "Edimax EW-7318USG" Ta USB
110.It "Gigabyte GN-WB01GS" Ta USB
111.It "Gigabyte GN-WI05GS" Ta USB
112.It "Hawking HWUG1" Ta USB
113.It "Hawking HWU54DM" Ta USB
114.It "Hercules HWGUSB2-54-LB" Ta USB
115.It "Hercules HWGUSB2-54V2-AP" Ta USB
116.It "LevelOne WNC-0301USB v3" Ta USB
117.It "Linksys WUSB54G rev C" Ta USB
118.It "Linksys WUSB54GR" Ta USB
119.It "Planex GW-US54HP" Ta USB
120.It "Planex GW-US54Mini2" Ta USB
121.It "Planex GW-USMM" Ta USB
122.It "Senao NUB-3701" Ta USB
123.It "Sitecom WL-113 ver 2" Ta USB
124.It "Sitecom WL-172" Ta USB
125.It "Sweex LW053" Ta USB
126.It "TP-LINK TL-WN321G" Ta USB
127.El
128.Sh EXAMPLES
129Join an existing BSS network (i.e., connect to an access point):
130.Bd -literal -offset indent
131ifconfig wlan create wlandev rum0 inet 192.168.0.20 \e
132    netmask 0xffffff00
133.Ed
134.Pp
135Join a specific BSS network with network name
136.Dq Li my_net :
137.Pp
138.Dl "ifconfig wlan create wlandev rum0 ssid my_net up"
139.Pp
140Join a specific BSS network with 64-bit WEP encryption:
141.Bd -literal -offset indent
142ifconfig wlan create wlandev rum0 ssid my_net \e
143	wepmode on wepkey 0x1234567890 weptxkey 1 up
144.Ed
145.Pp
146Join a specific BSS network with 128-bit WEP encryption:
147.Bd -literal -offset indent
148ifconfig wlan create wlandev rum0 wlanmode adhoc ssid my_net \e
149    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
150.Ed
151.Sh DIAGNOSTICS
152.Bl -diag
153.It "rum%d: could not load 8051 microcode"
154An error occurred while attempting to upload the microcode to the onboard 8051
155microcontroller unit.
156The driver will reset the hardware.
157This should not happen.
158.El
159.Sh SEE ALSO
160.Xr intro 4 ,
161.Xr netintro 4 ,
162.Xr usb 4 ,
163.Xr wlan 4 ,
164.Xr wlan_amrr 4 ,
165.Xr wlan_ccmp 4 ,
166.Xr wlan_tkip 4 ,
167.Xr wlan_wep 4 ,
168.Xr wlan_xauth 4 ,
169.Xr hostapd 8 ,
170.Xr ifconfig 8 ,
171.Xr wpa_supplicant 8 .
172.Rs
173.%T "Ralink Technology"
174.%U http://www.ralinktech.com/
175.Re
176.Sh HISTORY
177The
178.Nm
179driver first appeared in
180.Ox 4.0 .
181.Sh AUTHORS
182.An -nosplit
183The original
184.Nm
185driver was written by
186.An Niall O'Higgins Aq Mt niallo@openbsd.org
187and
188.An Damien Bergamini Aq Mt damien@openbsd.org .
189