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