share/man/man4/otus.4

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