xref: /freebsd/share/man/man4/otus.4 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\"-
2.\" SPDX-License-Identifier: ISC
3.\"
4.\" Copyright (c) 2015 Adrian Chadd <adrian@FreeBSD.org>
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 10, 2024
19.Dt OTUS 4
20.Os
21.Sh NAME
22.Nm otus
23.Nd Atheros AR9170 USB IEEE 802.11a/b/g/n wireless network driver
24.Sh SYNOPSIS
25To compile this driver into the kernel,
26place the following lines in your kernel configuration file:
27.Bd -ragged -offset indent
28.Cd "device ehci"
29.Cd "device uhci"
30.Cd "device ohci"
31.Cd "device usb"
32.Cd "device otus"
33.Cd "device wlan"
34.Ed
35.Pp
36Alternatively, to load the driver as a module at boot time,
37place the following line in
38.Xr loader.conf 5 :
39.Bd -literal -offset indent
40if_otus_load="YES"
41.Ed
42.Sh DESCRIPTION
43The
44.Nm
45driver supports USB 2.0 wireless network devices based on the Atheros
46AR9170 chipset.
47.Pp
48The Atheros AR9170 is a draft-802.11n adapter that uses an external
49radio to operate in either 2.4GHz only or 2.4GHz and 5GHz.
50.Pp
51The AR9101 radio supports 1T1R operation in 2GHz only.
52.Pp
53The AR9102 radio supports 2T2R operation in 2GHz only.
54.Pp
55The AR9104 radio supports 2T2R operation both 2GHz and 5GHz.
56.Pp
57These are the modes the
58.Nm
59driver can operate in:
60.Bl -tag -width "IBSS-masterXX"
61.It BSS mode
62Also known as
63.Em infrastructure
64mode, this is used when associating with an access point, through
65which all traffic passes.
66This mode is the default.
67.El
68.Pp
69The
70.Nm
71driver can be configured to use
72Wired Equivalent Privacy (WEP) or
73Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
74WPA is the de facto encryption standard for wireless networks.
75It is strongly recommended that WEP
76not be used as the sole mechanism
77to secure wireless communication,
78due to serious weaknesses in it.
79.Pp
80The
81.Nm
82driver can be configured at runtime with
83.Xr ifconfig 8 .
84.Sh HARDWARE
85The
86.Nm
87driver provides support for Atheros AR9170 USB IEEE 802.11b/g/n
88wireless network adapters, including:
89.Pp
90.Bl -bullet -offset indent -compact
91.It
923Com 3CRUSBN275
93.It
94Arcadyan WN7512
95.\" .It AVM FRITZ!WLAN USB Stick N
96.It
97CACE AirPcap \&Nx
98.It
99D-Link DWA-130 rev \&D1
100.It
101D-Link DWA-160 rev A1
102.It
103D-Link DWA-160 rev A2
104.It
105IO-Data WN-GDN/US2
106.It
107NEC Aterm WL300NU-G
108.It
109Netgear WNDA3100
110.It
111Netgear WN111 v2
112.It
113Planex GW-US300
114.It
115SMC Networks SMCWUSB-N2
116.It
117TP-Link TL-WN821N v1, v2
118.It
119Ubiquiti SR71 USB
120.It
121Unex DNUA-81
122.It
123Z-Com UB81
124.It
125Z-Com UB82
126.It
127ZyXEL NWD-271N
128.El
129.Sh FILES
130The driver needs at least version 1.0 of the following firmware files,
131which is loaded when an interface is attached:
132.Pp
133.Bl -tag -width Ds -offset indent -compact
134.It Pa /boot/kernel/otusfw-init.ko
135.It Pa /boot/kernel/otusfw-main.ko
136.El
137.Sh EXAMPLES
138Join an existing BSS network (i.e., connect to an access point):
139.Pp
140.Dl ifconfig wlan create wlandev otus0 inet 192.0.2.20/24
141.Pp
142Join a specific BSS network with network name
143.Ar my_net :
144.Pp
145.Dl ifconfig wlan create wlandev otus0 ssid my_net up
146.Pp
147Join a specific BSS network with 64-bit WEP encryption:
148.Bd -literal -offset indent
149ifconfig wlan create wlandev otus0 ssid my_net \e
150    wepmode on wepkey 0x1234567890 weptxkey 1 up
151.Ed
152.Sh DIAGNOSTICS
153.Bl -diag
154.It "%s: failed load firmware of file otusfw-main"
155For some reason, the driver was unable to read the microcode file from the
156filesystem.
157The file might be missing or corrupted.
158.El
159.Sh SEE ALSO
160.Xr intro 1 ,
161.Xr netintro 4 ,
162.Xr otusfw 4 ,
163.Xr usb 4 ,
164.Xr wlan 4 ,
165.Xr arp 8 ,
166.Xr hostapd 8 ,
167.Xr ifconfig 8 ,
168.Xr wpa_supplicant 8
169.Sh HISTORY
170The
171.Nm
172driver first appeared in
173.Ox 4.6
174and
175.Fx 11 .
176.Sh AUTHORS
177.An -nosplit
178The
179.Nm
180driver was written by
181.An Damien Bergamini Aq Mt damien@openbsd.org
182and ported by
183.An Adrian Chadd Aq Mt adrian@freebsd.org .
184.Sh CAVEATS
185The
186.Nm
187driver only supports 802.11a/b/g operations.
188802.11n operation is not supported at this time.
189