xref: /openbsd/share/man/man4/otus.4 (revision 3d8817e4)
1.\" $OpenBSD: otus.4,v 1.18 2011/03/16 20:20:44 deraadt 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: March 16 2011 $
18.Dt OTUS 4
19.Os
20.Sh NAME
21.Nm otus
22.Nd Atheros USB IEEE 802.11a/g/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.Bd -literal -offset 3n
85http://damien.bergamini.free.fr/packages/openbsd/otus-firmware-1.0.tgz
86.Ed
87.Sh HARDWARE
88The following adapters should work:
89.Pp
90.Bl -tag -width Ds -offset indent -compact
91.It 3Com 3CRUSBN275
92.It Arcadyan WN7512
93.\" .It AVM FRITZ!WLAN USB Stick N
94.It CACE AirPcap \&Nx
95.It D-Link DWA-130 rev \&D1
96.It D-Link DWA-160 rev A1
97.It D-Link DWA-160 rev A2
98.It IO-Data WN-GDN/US2
99.It NEC Aterm WL300NU-G
100.It Netgear WNDA3100
101.It Netgear WN111 v2
102.It Planex GW-US300
103.It SMC Networks SMCWUSB-N2
104.It TP-Link TL-WN821N
105.It Ubiquiti SR71 USB
106.It Unex DNUA-81
107.It Z-Com UB81
108.It Z-Com UB82
109.It ZyXEL NWD-271N
110.El
111.Sh EXAMPLES
112The following
113.Xr hostname.if 5
114example configures otus0 to join whatever network is available on boot,
115using WEP key
116.Dq 0x1deadbeef1 ,
117channel 11, obtaining an IP address using DHCP:
118.Bd -literal -offset indent
119dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
120.Ed
121.Pp
122Configure otus0 to join network
123.Dq my_net
124using WPA with passphrase
125.Dq my_passphrase :
126.Bd -literal -offset indent
127# ifconfig otus0 nwid my_net wpakey my_passphrase
128.Ed
129.Pp
130Join an existing BSS network,
131.Dq my_net :
132.Bd -literal -offset indent
133# ifconfig otus0 192.168.1.1 netmask 0xffffff00 nwid my_net
134.Ed
135.Sh DIAGNOSTICS
136.Bl -diag
137.It "otus%d: error %d, could not read firmware %s"
138For some reason, the driver was unable to read the microcode file from the
139filesystem.
140The file might be missing or corrupted.
141.It "otus%d: device timeout"
142A frame dispatched to the hardware for transmission did not complete in time.
143The driver will reset the hardware.
144This should not happen.
145.El
146.Sh SEE ALSO
147.Xr arp 4 ,
148.Xr ifmedia 4 ,
149.Xr intro 4 ,
150.Xr netintro 4 ,
151.Xr usb 4 ,
152.Xr hostname.if 5 ,
153.Xr ifconfig 8
154.Sh HISTORY
155The
156.Nm
157driver first appeared in
158.Ox 4.6 .
159.Sh AUTHORS
160The
161.Nm
162driver was written by
163.An Damien Bergamini Aq damien@openbsd.org
164based on source code licensed under the ISC released in 2008 by Atheros
165Communications for Linux.
166.Sh CAVEATS
167The AVM FRITZ!WLAN USB Stick N adapter is currently not supported.
168.Pp
169The
170.Nm
171driver does not support any of the 802.11n capabilities offered by the
172AR9001U chipset.
173Additional work is required in
174.Xr ieee80211 9
175before those features can be supported.
176