xref: /openbsd/share/man/man4/otus.4 (revision 404b540a)
1.\" $OpenBSD: otus.4,v 1.8 2009/09/02 07:00:24 jmc Exp $
2.\"
3.\" Copyright (c) 2009 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.Dd $Mdocdate: September 2 2009 $
18.Os
19.Dt OTUS 4
20.Sh NAME
21.Nm otus
22.Nd Atheros USB IEEE 802.11a/b/g/Draft-N wireless network device
23.Sh SYNOPSIS
24.Cd "otus* at uhub? port ?"
25.Sh DESCRIPTION
26The
27.Nm
28driver supports USB 2.0 wireless network devices based on Atheros
29Communications AR9001U chipset.
30.Pp
31The AR9001U chipset is made of an AR9170 MAC/Baseband
32and an AR9101 (1T2R), AR9102 (2T2R) or AR9104 (dual-band 2T2R)
33Radio.
34.Pp
35These are the modes the
36.Nm
37driver can operate in:
38.Bl -tag -width "IBSS-masterXX"
39.It BSS mode
40Also known as
41.Em infrastructure
42mode, this is used when associating with an access point, through
43which all traffic passes.
44This mode is the default.
45.It monitor mode
46In this mode the driver is able to receive packets without
47associating with an access point.
48This disables the internal receive filter and enables the card to
49capture packets from networks which it wouldn't normally have access to,
50or to scan for access points.
51.El
52.Pp
53The
54.Nm
55driver can be configured to use
56Wired Equivalent Privacy (WEP) or
57Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
58WPA is the de facto encryption standard for wireless networks.
59It is strongly recommended that WEP
60not be used as the sole mechanism
61to secure wireless communication,
62due to serious weaknesses in it.
63.Pp
64The
65.Nm
66driver can be configured at runtime with
67.Xr ifconfig 8
68or on boot with
69.Xr hostname.if 5 .
70.Sh FILES
71The driver needs at least version 1.0 of the following firmware files,
72which are loaded when an interface is attached:
73.Pp
74.Bl -tag -width Ds -offset indent -compact
75.It /etc/firmware/otus-init
76.It /etc/firmware/otus-main
77.El
78.Pp
79Although these firmware files are freely redistributable, their usage
80is restricted.
81A prepackaged version of the firmware, designed to be used with
82.Xr pkg_add 1 ,
83can be found at:
84.Pp
85.Pa http://damien.bergamini.free.fr/packages/openbsd/otus-firmware-1.0.tgz
86.Sh HARDWARE
87The following adapters should work:
88.Pp
89.Bl -tag -width Ds -offset indent -compact
90.It Arcadyan WN7512
91.\" .It AVM FRITZ!WLAN USB Stick N
92.It CACE AirPcap Nx
93.It D-Link DWA-130 rev \&D1
94.It D-Link DWA-160 rev A1
95.It IO-Data WN-GDN/US2
96.It Netgear WNDA3100
97.It Netgear WN111 v2
98.It Planex GW-US300
99.It TP-Link TL-WN821N
100.It Ubiquiti SR71 USB
101.It Unex DNUA-81
102.It Z-Com UB81
103.It Z-Com UB82
104.It ZyXEL NWD-271N
105.El
106.Sh EXAMPLES
107The following
108.Xr hostname.if 5
109example configures otus0 to join whatever network is available on boot,
110using WEP key
111.Dq 0x1deadbeef1 ,
112channel 11, obtaining an IP address using DHCP:
113.Bd -literal -offset indent
114dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
115.Ed
116.Pp
117Configure otus0 to join network
118.Dq my_net
119using WPA-PSK with passphrase
120.Dq my_passphrase :
121.Bd -literal -offset indent
122# ifconfig otus0 nwid my_net wpa wpapsk \e
123	`wpa-psk my_net my_passphrase`
124.Ed
125.Pp
126Return otus0 to its default settings:
127.Bd -literal -offset indent
128# ifconfig otus0 -bssid -chan media autoselect \e
129	nwid "" -nwkey -wpa -wpapsk
130.Ed
131.Pp
132Join an existing BSS network,
133.Dq my_net :
134.Bd -literal -offset indent
135# ifconfig otus0 192.168.1.1 netmask 0xffffff00 nwid my_net
136.Ed
137.Sh DIAGNOSTICS
138.Bl -diag
139.It "otus%d: error %d, could not read firmware %s"
140For some reason, the driver was unable to read the microcode file from the
141filesystem.
142The file might be missing or corrupted.
143.It "otus%d: device timeout"
144A frame dispatched to the hardware for transmission did not complete in time.
145The driver will reset the hardware.
146This should not happen.
147.El
148.Sh SEE ALSO
149.Xr arp 4 ,
150.Xr ifmedia 4 ,
151.Xr intro 4 ,
152.Xr netintro 4 ,
153.Xr usb 4 ,
154.Xr hostname.if 5 ,
155.Xr ifconfig 8 ,
156.Xr wpa-psk 8
157.Pp
158Atheros Communications AR9001U-2NX/AR9001U-2NG/AR9001U-NG:
159.Pa http://www.atheros.com/pt/bulletins/AR9001USBBulletin.pdf
160.Sh HISTORY
161The
162.Nm
163driver first appeared in
164.Ox 4.6 .
165.Sh AUTHORS
166The
167.Nm
168driver was written by
169.An Damien Bergamini Aq damien@openbsd.org
170based on source code licensed under the ISC released in 2008 by Atheros
171Communications for Linux.
172.Sh CAVEATS
173The AVM FRITZ!WLAN USB Stick N adapter is currently not supported.
174.Pp
175The
176.Nm
177driver does not support any of the 802.11n capabilities offered by the
178AR9001U chipset.
179Additional work is required in
180.Xr ieee80211 9
181before those features can be supported.
182