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