xref: /freebsd/share/man/man4/rum.4 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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 September 7, 2007
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 based on the
49Ralink RT2501USB and RT2601USB chipsets.
50.Pp
51Ralink PCI Express Mini Card adapters show up as normal USB 2.0 devices and are
52thus 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 MAC/BBP and
62an 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.
66.Sh HARDWARE
67The
68.Nm
69driver supports USB 2.0 and PCI Express Mini Card wireless
70adapters based on the Ralink RT2501USB and RT2601USB chipsets,
71including:
72.Pp
73.Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
74.It Em Card Ta Em Bus
75.It "3Com Aolynk WUB320g" Ta USB
76.It "Abocom WUG2700 Ta" Ta USB
77.It "Airlink101 AWLL5025" Ta USB
78.It "ASUS WL-167g ver 2" Ta USB
79.It "Belkin F5D7050 ver 3" Ta USB
80.It "Belkin F5D9050 ver 3" Ta USB
81.It "Buffalo WLI-U2-SG54HP" Ta USB
82.It "Buffalo WLI-U2-G54HP" Ta USB
83.It "CNet CWD-854 ver F" Ta USB
84.It "Conceptronic C54RU ver 2" Ta USB
85.It "Corega CG-WLUSB2GO" Ta USB
86.It "D-Link DWL-G122 rev C1" Ta USB
87.It "D-Link WUA-1340" Ta USB
88.It "Digitus DN-7003GR" Ta USB
89.It "Edimax EW-7318USG" Ta USB
90.It "Gigabyte GN-WB01GS" Ta USB
91.It "Gigabyte GN-WI05GS" Ta USB
92.It "Hawking HWUG1" Ta USB
93.It "Hawking HWU54DM" Ta USB
94.It "Hercules HWGUSB2-54-LB" Ta USB
95.It "Hercules HWGUSB2-54V2-AP" Ta USB
96.It "LevelOne WNC-0301USB v3" Ta USB
97.It "Linksys WUSB54G rev C" Ta USB
98.It "Linksys WUSB54GR" Ta USB
99.It "Planex GW-US54HP" Ta USB
100.It "Planex GW-US54Mini2" Ta USB
101.It "Planex GW-USMM" Ta USB
102.It "Senao NUB-3701" Ta USB
103.It "Sitecom WL-113 ver 2" Ta USB
104.It "Sitecom WL-172" Ta USB
105.It "Sweex LW053" Ta USB
106.It "TP-LINK TL-WN321G" Ta USB
107.El
108.Sh EXAMPLES
109Join an existing BSS network (i.e., connect to an access point):
110.Pp
111.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00"
112.Pp
113Join a specific BSS network with network name
114.Dq Li my_net :
115.Pp
116.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
117.Pp
118Join a specific BSS network with 40-bit WEP encryption:
119.Bd -literal -offset indent
120ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
121    wepmode on wepkey 0x1234567890 weptxkey 1
122.Ed
123.Pp
124Join a specific BSS network with 104-bit WEP encryption:
125.Bd -literal -offset indent
126ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
127    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
128.Ed
129.Sh DIAGNOSTICS
130.Bl -diag
131.It "rum%d: could not load 8051 microcode"
132An error occurred while attempting to upload the microcode to the onboard 8051
133microcontroller unit.
134The driver will reset the hardware.
135This should not happen.
136.El
137.Sh SEE ALSO
138.Xr altq 4 ,
139.Xr arp 4 ,
140.Xr netintro 4 ,
141.Xr usb 4 ,
142.Xr wlan 4 ,
143.Xr wlan_amrr 4 ,
144.Xr ifconfig 8
145.Rs
146.%T "Ralink Technology"
147.%O http://www.ralinktech.com/
148.Re
149.Sh HISTORY
150The
151.Nm
152driver first appeared in
153.Ox 4.0 .
154.Sh CAVEATS
155.Pp
156The
157.Nm
158driver supports automatic control of the transmit speed in BSS mode only.
159Therefore the use of a
160.Nm
161adapter in Host AP mode is discouraged.
162.Sh AUTHORS
163The
164.Nm
165driver was written by
166.An Niall O'Higgins Aq niallo@openbsd.org
167and
168.An Damien Bergamini Aq damien@openbsd.org .
169