xref: /freebsd/share/man/man4/otus.4 (revision 05248206f720394d95c2a7475429311df670a2e9)
1.\"
2.\" Copyright (c) 2015 Adrian Chadd <adrian@FreeBSD.org>
3.\"
4.\" Permission to use, copy, modify, and distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd September 25, 2015
17.Dt OTUS 4
18.Os
19.Sh NAME
20.Nm otus
21.Nd Atheros AR9170 USB IEEE 802.11a/b/g/n wireless network device
22.Sh SYNOPSIS
23To compile this driver into the kernel,
24place the following lines in your kernel configuration file:
25.Bd -ragged -offset indent
26.Cd "device ehci"
27.Cd "device uhci"
28.Cd "device ohci"
29.Cd "device usb"
30.Cd "device otus"
31.Cd "device wlan"
32.Ed
33.Pp
34Alternatively, to load the driver as a module at boot time,
35place the following line in
36.Xr loader.conf 5 :
37.Bd -literal -offset indent
38if_otus_load="YES"
39.Ed
40.Sh DESCRIPTION
41The
42.Nm
43driver supports USB 2.0 wireless network devices based on the Atheros
44AR9170 chipset.
45.Pp
46The Atheros AR9170 is a draft-802.11n adapter that uses an external
47radio to operate in either 2.4GHz only or 2.4GHz and 5GHz.
48.Pp
49The AR9101 radio supports 1T1R operation in 2GHz only.
50.Pp
51The AR9102 radio supports 2T2R operation in 2GHz only.
52.Pp
53The AR9104 radio supports 2T2R operation both 2GHz and 5GHz.
54.Pp
55These are the modes the
56.Nm
57driver can operate in:
58.Bl -tag -width "IBSS-masterXX"
59.It BSS mode
60Also known as
61.Em infrastructure
62mode, this is used when associating with an access point, through
63which all traffic passes.
64This mode is the default.
65.El
66.Pp
67The
68.Nm
69driver can be configured to use
70Wired Equivalent Privacy (WEP) or
71Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
72WPA is the de facto encryption standard for wireless networks.
73It is strongly recommended that WEP
74not be used as the sole mechanism
75to secure wireless communication,
76due to serious weaknesses in it.
77.Pp
78The
79.Nm
80driver can be configured at runtime with
81.Xr ifconfig 8 .
82.Sh FILES
83The driver needs at least version 1.0 of the following firmware files,
84which is loaded when an interface is attached:
85.Pp
86.Bl -tag -width Ds -offset indent -compact
87.It Pa /boot/kernel/otusfw-init.ko
88.It Pa /boot/kernel/otusfw-main.ko
89.El
90.Sh HARDWARE
91The
92.Nm
93driver provices support for Atheros AR9170 USB IEEE 802.11b/g/n
94wireless network adapters, including:
95.Pp
96.Bl -tag -width Ds -offset indent -compact
97.It 3Com 3CRUSBN275
98.It Arcadyan WN7512
99.\" .It AVM FRITZ!WLAN USB Stick N
100.It CACE AirPcap \&Nx
101.It D-Link DWA-130 rev \&D1
102.It D-Link DWA-160 rev A1
103.It D-Link DWA-160 rev A2
104.It IO-Data WN-GDN/US2
105.It NEC Aterm WL300NU-G
106.It Netgear WNDA3100
107.It Netgear WN111 v2
108.It Planex GW-US300
109.It SMC Networks SMCWUSB-N2
110.It TP-Link TL-WN821N v1, v2
111.It Ubiquiti SR71 USB
112.It Unex DNUA-81
113.It Z-Com UB81
114.It Z-Com UB82
115.It ZyXEL NWD-271N
116.El
117.Sh EXAMPLES
118Join an existing BSS network (i.e., connect to an access point):
119.Bd -literal -offset indent
120ifconfig wlan create wlandev otus0 inet 192.168.0.20 \e
121    netmask 0xffffff00
122.Ed
123.Pp
124Join a specific BSS network with network name
125.Dq Li my_net :
126.Pp
127.Dl "ifconfig wlan create wlandev otus0 ssid my_net up"
128.Pp
129Join a specific BSS network with 64-bit WEP encryption:
130.Bd -literal -offset indent
131ifconfig wlan create wlandev otus0 ssid my_net \e
132        wepmode on wepkey 0x1234567890 weptxkey 1 up
133.Ed
134.Sh DIAGNOSTICS
135.Bl -diag
136.It "%s: failed load firmware of file otusfw-main"
137For some reason, the driver was unable to read the microcode file from the
138filesystem.
139The file might be missing or corrupted.
140.El
141.Sh SEE ALSO
142.Xr intro 1 ,
143.Xr netintro 4 ,
144.Xr otusfw 4 ,
145.Xr usb 4 ,
146.Xr wlan 4 ,
147.Xr arp 8 ,
148.Xr hostapd 8 ,
149.Xr ifconfig 8 ,
150.Xr wpa_supplicant 8
151.Sh HISTORY
152The
153.Nm
154driver first appeared in
155.Ox 4.6 .
156.Sh AUTHORS
157.An -nosplit
158The
159.Nm
160driver was written by
161.An Damien Bergamini Aq Mt damien@openbsd.org
162and ported by
163.An Adrian Chadd Aq Mt adrian@freebsd.org .
164.Sh CAVEATS
165The
166.Nm
167driver only supports 802.11a/b/g operations.
168802.11n operation is not supported at this time.
169