xref: /openbsd/share/man/man4/ural.4 (revision 3d8817e4)
1.\" $OpenBSD: ural.4,v 1.13 2010/11/01 17:59:09 jmc Exp $
2.\"
3.\" Copyright (c) 2005-2007
4.\"	Damien Bergamini <damien.bergamini@free.fr>
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: November 1 2010 $
19.Dt URAL 4
20.Os
21.Sh NAME
22.Nm ural
23.Nd Ralink Technology USB IEEE 802.11b/g wireless network device
24.Sh SYNOPSIS
25.Cd "ural* at uhub? port ?"
26.Sh DESCRIPTION
27The
28.Nm
29driver supports USB 2.0 wireless adapters based on the Ralink RT2500USB
30chipset.
31.Pp
32The RT2500USB chipset is the first generation of 802.11b/g adapters from Ralink.
33It consists of two integrated chips, an RT2570 MAC/BBP and an RT2526 radio
34transceiver.
35.Pp
36These are the modes the
37.Nm
38driver can operate in:
39.Bl -tag -width "IBSS-masterXX"
40.It BSS mode
41Also known as
42.Em infrastructure
43mode, this is used when associating with an access point, through
44which all traffic passes.
45This mode is the default.
46.It IBSS mode
47Also known as
48.Em IEEE ad-hoc
49mode or
50.Em peer-to-peer
51mode.
52This is the standardized method of operating without an access point.
53Stations associate with a service set.
54However, actual connections between stations are peer-to-peer.
55.It Host AP
56In this mode the driver acts as an access point (base station)
57for other cards.
58.It monitor mode
59In this mode the driver is able to receive packets without
60associating with an access point.
61This disables the internal receive filter and enables the card to
62capture packets from networks which it wouldn't normally have access to,
63or to scan for access points.
64.El
65.Pp
66The
67.Nm
68driver can be configured to use
69Wired Equivalent Privacy (WEP) or
70Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
71WPA is the de facto encryption standard for wireless networks.
72It is strongly recommended that WEP
73not be used as the sole mechanism
74to secure wireless communication,
75due to serious weaknesses in it.
76The
77.Nm
78driver relies on the software 802.11 stack for both encryption and decryption
79of data frames.
80.Pp
81The transmit speed is user-selectable or can be adapted automatically by the
82driver depending on the number of hardware transmission retries.
83.Pp
84The
85.Nm
86driver can be configured at runtime with
87.Xr ifconfig 8
88or on boot with
89.Xr hostname.if 5 .
90.Sh HARDWARE
91The following adapters should work:
92.Pp
93.Bl -tag -width Ds -offset indent -compact
94.It AMIT WL532U
95.It ASUS WL-167g v1
96.It Belkin F5D7050 v2000
97.It Buffalo WLI-U2-KG54
98.It Buffalo WLI-U2-KG54-AI
99.It Buffalo WLI-U2-KG54-YB
100.It CNet CWD-854
101.It Compex WLU54G 2A1100
102.It Conceptronic C54RU
103.It D-Link DWL-G122 (b1)
104.It Dynalink WLG25USB
105.It E-Tech WGUS02
106.It Eminent EM3035
107.It Gigabyte GN-WBKG
108.It Hercules HWGUSB2-54
109.It KCORP LifeStyle KLS-685
110.It Linksys HU200-TS
111.It Linksys WUSB54G v4
112.It Linksys WUSB54GP v4
113.It MSI MS-6861
114.It MSI MS-6865
115.It MSI MS-6869
116.It Nintendo Wi-Fi USB Connector
117.It Nova Tech NV-902W
118.It OvisLink Evo-W54USB
119.It SerComm UB801R
120.It SparkLAN WL-685R
121.It Sphairon UB801R
122.It Surecom EP-9001-g rev 3A
123.It Sweex LC100060
124.It Tonze UW-6200C
125.It Zaapa ZNWUSB-54
126.It Zinwell ZPlus-G250
127.It Zinwell ZWX-G261
128.It Zonet ZEW2500P
129.El
130.Sh EXAMPLES
131The following
132.Xr hostname.if 5
133example configures ural0 to join whatever network is available on boot,
134using WEP key
135.Dq 0x1deadbeef1 ,
136channel 11, obtaining an IP address using DHCP:
137.Bd -literal -offset indent
138dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
139.Ed
140.Pp
141The following
142.Xr hostname.if 5
143example creates a host-based access point on boot:
144.Bd -literal -offset indent
145inet 192.168.1.1 255.255.255.0 NONE media autoselect \e
146	mediaopt hostap nwid my_net chan 11
147.Ed
148.Pp
149Configure ural0 to join network
150.Dq my_net
151using WPA with passphrase
152.Dq my_passphrase :
153.Bd -literal -offset indent
154# ifconfig ural0 nwid my_net wpakey my_passphrase
155.Ed
156.Pp
157Join an existing BSS network,
158.Dq my_net :
159.Bd -literal -offset indent
160# ifconfig ural0 192.168.1.1 netmask 0xffffff00 nwid my_net
161.Ed
162.Sh DIAGNOSTICS
163.Bl -diag
164.It "ural%d: device timeout"
165A frame dispatched to the hardware for transmission did not complete in time.
166The driver will reset the hardware.
167This should not happen.
168.El
169.Sh SEE ALSO
170.Xr arp 4 ,
171.Xr ifmedia 4 ,
172.Xr intro 4 ,
173.Xr netintro 4 ,
174.Xr usb 4 ,
175.Xr hostname.if 5 ,
176.Xr hostapd 8 ,
177.Xr ifconfig 8
178.Pp
179Ralink Technology:
180.Pa http://www.ralinktech.com/
181.Sh HISTORY
182The
183.Nm
184driver first appeared in
185.Ox 3.7 .
186.Sh AUTHORS
187The
188.Nm
189driver was written by
190.An Damien Bergamini Aq damien@openbsd.org .
191.Sh CAVEATS
192The
193.Nm
194driver supports automatic control of the transmit speed in BSS mode only.
195Therefore the use of an
196.Nm
197adapter in Host AP mode is discouraged.
198.Pp
199Host AP mode doesn't support power saving.
200Clients attempting to use power saving mode may experience significant
201packet loss (disabling power saving on the client will fix this).
202