xref: /freebsd/share/man/man4/ural.4 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\"-
2.\" SPDX-License-Identifier: ISC
3.\"
4.\" Copyright (c) 2005, 2006
5.\"     Damien Bergamini <damien.bergamini@free.fr>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd November 10, 2024
20.Dt URAL 4
21.Os
22.Sh NAME
23.Nm ural
24.Nd Ralink RT2500USB IEEE 802.11a/b/g wireless network driver
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 ural"
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_ural_load="YES"
44.Ed
45.Sh DESCRIPTION
46The
47.Nm
48driver supports USB 2.0 wireless adapters based on the RT2500USB chipset.
49.Pp
50The RT2500USB chipset consists of two integrated chips, a RT2570 MAC/BBP
51and a radio transceiver (the model of which depends on the card revision).
52.Pp
53The RT2522, RT2523, RT2524, RT2525, RT2525e and RT2526 radio transceivers
54operate in the 2.4GHz band (802.11b/g) whereas the RT5222 is a dual-band radio
55transceiver that can operate in the 2.4GHz and 5.2GHz bands (802.11a).
56.Pp
57.Nm
58supports
59.Cm station ,
60.Cm adhoc ,
61.Cm hostap ,
62and
63.Cm monitor
64mode operation.
65Only one virtual interface may be configured at any time.
66For more information on configuring this device, see
67.Xr ifconfig 8 .
68.Sh HARDWARE
69The
70.Nm
71driver supports USB 2.0 wireless adapters based on the Ralink Technology
72RT2500USB chipset, including:
73.Pp
74.Bl -column -compact "Atlantis Land A02-PCM-W54" "Bus"
75.It Em Card Ta Em Bus
76.It "AMIT WL532U" Ta USB
77.It "ASUS WL-167g" Ta USB
78.It "Belkin F5D7050 v2000" Ta USB
79.It "Buffalo WLI-U2-KG54-AI" Ta USB
80.It "CNet CWD-854" Ta USB
81.It "Compex WLU54G 2A1100" Ta USB
82.It "Conceptronic C54RU" Ta USB
83.It "D-Link DWL-G122 b1" Ta USB
84.It "Dynalink WLG25USB" Ta USB
85.It "E-Tech WGUS02" Ta USB
86.It "Gigabyte GN-WBKG" Ta USB
87.It "Hercules HWGUSB2-54" Ta USB
88.It "KCORP LifeStyle KLS-685" Ta USB
89.It "Linksys WUSB54G v4" Ta USB
90.It "Linksys WUSB54GP v4" Ta USB
91.It "MSI MS-6861" Ta USB
92.It "MSI MS-6865" Ta USB
93.It "MSI MS-6869" Ta USB
94.It "NovaTech NV-902" Ta USB
95.It "OvisLink Evo-W54USB" Ta USB
96.It "SerComm UB801R" Ta USB
97.It "SparkLAN WL-685R" Ta USB
98.It "Surecom EP-9001-g" Ta USB
99.It "Sweex LC100060" Ta USB
100.It "Tonze UW-6200C" Ta USB
101.It "Zinwell ZWX-G261" Ta USB
102.It "Zonet ZEW2500P" Ta USB
103.El
104.Pp
105An up to date list can be found at
106.Pa http://ralink.rapla.net/ .
107.Sh EXAMPLES
108Join an existing BSS network (i.e., connect to an access point):
109.Pp
110.Dl ifconfig wlan create wlandev ural0 inet 192.0.2.20/24
111.Pp
112Join a specific BSS network with network name
113.Ar my_net :
114.Pp
115.Dl ifconfig wlan create wlandev ural0 ssid my_net up
116.Pp
117Join a specific BSS network with 64-bit WEP encryption:
118.Bd -literal -offset indent
119ifconfig wlan create wlandev ural0 ssid my_net \e
120    wepmode on wepkey 0x1234567890 weptxkey 1 up
121.Ed
122.Pp
123Join a specific BSS network with 128-bit WEP encryption:
124.Bd -literal -offset indent
125ifconfig wlan create wlandev ural0 wlanmode adhoc ssid my_net \e
126    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
127.Ed
128.Sh DIAGNOSTICS
129.Bl -diag
130.It "ural%d: device timeout"
131The driver will reset the hardware.
132This should not happen.
133.El
134.Sh SEE ALSO
135.Xr intro 4 ,
136.Xr netintro 4 ,
137.Xr usb 4 ,
138.Xr wlan 4 ,
139.Xr wlan_amrr 4 ,
140.Xr wlan_ccmp 4 ,
141.Xr wlan_tkip 4 ,
142.Xr wlan_wep 4 ,
143.Xr wlan_xauth 4 ,
144.Xr networking 7 ,
145.Xr hostapd 8 ,
146.Xr ifconfig 8 ,
147.Xr wpa_supplicant 8
148.Sh HISTORY
149The
150.Nm
151driver first appeared in
152.Ox 3.7
153and
154.Fx 6.0 .
155.Sh AUTHORS
156The original
157.Nm
158driver was written by
159.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
160.Sh BUGS
161Host AP mode doesn't support client power save.
162Clients using power save mode will experience packet loss
163.Pq disabling power saving on the client will fix this .
164