xref: /openbsd/share/man/man4/otus.4 (revision 5a38ef86)
1.\" $OpenBSD: otus.4,v 1.35 2021/10/24 12:32:42 kn 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: October 24 2021 $
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 (WPA1 and WPA2).
58WPA2 is the current encryption standard for wireless networks.
59It is strongly recommended that neither WEP nor WPA1
60are used as the sole mechanism to secure wireless communication,
61due to serious weaknesses.
62WPA1 is disabled by default and may be enabled using the option
63.Qq Cm wpaprotos Ar wpa1,wpa2 .
64For standard WPA networks which use pre-shared keys (PSK),
65keys are configured using the
66.Qq Cm wpakey
67option.
68WPA-Enterprise networks require use of the wpa_supplicant package.
69.Qq Cm wpaprotos Ar wpa1,wpa2 .
70For standard WPA networks which use pre-shared keys (PSK),
71keys are configured using the
72.Qq Cm wpakey
73option.
74WPA-Enterprise networks require use of the wpa_supplicant package.
75.Pp
76The
77.Nm
78driver can be configured at runtime with
79.Xr ifconfig 8
80or on boot with
81.Xr hostname.if 5 .
82.Sh FILES
83The driver needs at least version 1.0 of the following firmware files,
84which are loaded when an interface is attached:
85.Pp
86.Bl -tag -width Ds -offset indent -compact
87.It Pa /etc/firmware/otus-init
88.It Pa /etc/firmware/otus-main
89.El
90.Pp
91Although these firmware files are freely redistributable, their usage
92is restricted.
93A prepackaged version of the firmware can be installed using
94.Xr fw_update 1 .
95.Sh HARDWARE
96The following adapters should work:
97.Pp
98.Bl -tag -width Ds -offset indent -compact
99.It 3Com 3CRUSBN275
100.It Arcadyan WN7512
101.\" .It AVM FRITZ!WLAN USB Stick N
102.It CACE AirPcap \&Nx
103.It D-Link DWA-130 rev \&D1
104.It D-Link DWA-160 rev A1
105.It D-Link DWA-160 rev A2
106.It IO-Data WN-GDN/US2
107.It NEC Aterm WL300NU-G
108.It Netgear WNDA3100
109.It Netgear WN111 v2
110.It Planex GW-US300
111.It SMC Networks SMCWUSB-N2
112.It TP-Link TL-WN821N v1, v2
113.It Ubiquiti SR71 USB
114.It Unex DNUA-81
115.It Z-Com UB81
116.It Z-Com UB82
117.It ZyXEL NWD-271N
118.El
119.Sh EXAMPLES
120The following example scans for available networks:
121.Pp
122.Dl # ifconfig otus0 scan
123.Pp
124The following
125.Xr hostname.if 5
126example configures otus0 to join network
127.Dq mynwid ,
128using WPA key
129.Dq mywpakey ,
130obtaining an IP address using DHCP:
131.Bd -literal -offset indent
132join mynwid wpakey mywpakey
133inet autoconf
134.Ed
135.Sh DIAGNOSTICS
136.Bl -diag
137.It "otus0: error N, could not read firmware ..."
138For some reason, the driver was unable to read the microcode file from the
139filesystem.
140The file might be missing or corrupted.
141.It "otus0: 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 Mt damien.bergamini@free.fr
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.Pp
177This driver does not support powersave mode.
178