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