share/man/man4/uath.4

   1 .\"
   2 .\" Copyright (c) 2006
   3 .\"     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 .\" $FreeBSD$
  18 .\"
  19 .Dd April 7, 2009
  20 .Dt UATH 4
  21 .Os
  22 .Sh NAME
  23 .Nm uath
  24 .Nd Atheros USB IEEE 802.11a/b/g wireless network device
  25 .Sh SYNOPSIS
  26 To compile this driver into the kernel,
  27 place the following lines in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device ehci"
  31 .Cd "device uhci"
  32 .Cd "device ohci"
  33 .Cd "device usb"
  34 .Cd "device uath"
  35 .Cd "device wlan"
  36 .Ed
  37 .Pp
  38 Alternatively, to load the driver as a
  39 module at boot time, place the following line in
  40 .Xr loader.conf 5 :
  41 .Bd -literal -offset indent
  42 if_uath_load="YES"
  43 .Ed
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 driver supports USB 2.0 wireless network devices based on Atheros
  48 Communications fifth generation AR5005UG and AR5005UX chipsets.
  49 .Pp
  50 The AR5005UG chipset is made of an AR5523 multiprotocol MAC/baseband processor
  51 and an AR2112 Radio-on-a-Chip that can operate between 2300 and 2500 MHz
  52 (802.11b/g).
  53 .Pp
  54 The AR5005UX chipset is made of an AR5523 multiprotocol MAC/baseband processor
  55 and an AR5112 dual band Radio-on-a-Chip that can operate between 2300 and
  56 2500 MHz (802.11b/g) or 4900 and 5850 MHz (802.11a).
  57 .Pp
  58 The AR5005UG and AR5005UX chipsets both have an integrated 32-bit MIPS
  59 R4000-class processor that runs a firmware and manages, among other things,
  60 the automatic control of the transmit rate and the calibration of the radio.
  61 .Pp
  62 .Nm
  63 supports
  64 .Cm station ,
  65 and
  66 .Cm monitor
  67 mode operation.
  68 Only one virtual interface may be configured at any time.
  69 For more information on configuring this device, see
  70 .Xr ifconfig 8 .
  71 .Sh FIRMWARE
  72 .Nm
  73 requires firmware that is downloaded to the device.
  74 This is normally done by the
  75 .Xr uathload 8
  76 utility that is launched by
  77 .Xr devd 8
  78 when the device is inserted.
  79 .Xr uathload
  80 includes the firmware in the binary program.
  81 This firmware is licensed for general use and is included in the base system.
  82 .Sh HARDWARE
  83 The
  84 .Nm
  85 driver should work with the following adapters:
  86 .Pp
  87 .Bl -column -compact "TRENDware International TEW-444UB" "AR5005UX" -offset 6n
  88 .It Em "Adapter Chipset"
  89 .\".It Belkin F6D3050   AR5005UX
  90 .It Li "Compex WLU108AG" Ta AR5005UX
  91 .It Li "Compex WLU108G" Ta AR5005UG
  92 .\".It Li "D-Link DWL-AG132" Ta AR5005UX
  93 .It Li "D-Link DWL-G132" Ta AR5005UG
  94 .\".It Li "Edimax EW-7315Ug" Ta AR5005UG (AR2414???)
  95 .\".It Li "Lancom USB-54ag" Ta AR5005UX
  96 .\".It Li "NEC WL54TU" Ta AR5005UX
  97 .It Li "IODATA WN-G54/US" Ta AR5005UG
  98 .It Li "MELCO WLI-U2-KAMG54" Ta AR5005UX
  99 .It Li "Netgear WG111T" Ta AR5005UG
 100 .It Li "Netgear WG111U" Ta AR5005UX
 101 .It Li "Netgear WPN111" Ta AR5005UG
 102 .It Li "Olitec 000544" Ta AR5005UG
 103 .It Li "PLANET WDL-U357" Ta AR5005UX
 104 .\".It Li "Senao WUB-8004" Ta AR5005UX
 105 .It Li "Siemens Gigaset 108" Ta AR5005UG
 106 .It Li "SMC SMCWUSBT-G" Ta AR5005UG
 107 .It Li "SMC SMCWUSBT-G2" Ta AR5005UG
 108 .\".It Li "SparkLAN WL-685GS" Ta AR5005UG
 109 .It Li "SparkLAN WL-785A" Ta AR5005UX
 110 .It Li "TP-Link TL-WN620G" Ta AR5005UG
 111 .It Li "TRENDware International TEW-444UB" Ta AR5005UG
 112 .It Li "TRENDware International TEW-504UB" Ta AR5005UX
 113 .It Li "Unex Technology UR054ag" Ta AR5005UX
 114 .\".It Li "Wistron NeWeb DCUA-81" Ta AR5005UX
 115 .\".It Li "Wistron NeWeb DRUA-81" Ta AR5005UG
 116 .\".It Li "Wistron NeWeb DRUA-82" Ta AR5005UX
 117 .\".It Li "ZyXEL G-200 v2" Ta AR5005UG
 118 .It Li "ZyXEL XtremeMIMO M-202" Ta AR5005UX
 119 .El
 120 .Pp
 121 An up to date list can be found at
 122 .Pa http://customerproducts.atheros.com/customerproducts/default.asp .
 123 .Sh EXAMPLES
 124 Join an existing BSS network (i.e., connect to an access point):
 125 .Bd -literal -offset indent
 126 ifconfig wlan create wlandev uath0 inet 192.168.0.20 \e
 127     netmask 0xffffff00
 128 .Ed
 129 .Pp
 130 Join a specific BSS network with network name
 131 .Dq Li my_net :
 132 .Pp
 133 .Dl "ifconfig wlan create wlandev uath0 ssid my_net up"
 134 .Pp
 135 Join a specific BSS network with 64-bit WEP encryption:
 136 .Bd -literal -offset indent
 137 ifconfig wlan create wlandev uath0 ssid my_net \e
 138         wepmode on wepkey 0x1234567890 weptxkey 1 up
 139 .Ed
 140 .Pp
 141 Join a specific BSS network with 128-bit WEP encryption:
 142 .Bd -literal -offset indent
 143 ifconfig wlan create wlandev uath0 wlanmode adhoc ssid my_net \e
 144     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 145 .Ed
 146 .Sh DIAGNOSTICS
 147 .Bl -diag
 148 .It "uath%d: could not send command (error=%s)"
 149 An attempt to send a command to the firmware failed.
 150 .It "uath%d: timeout waiting for command reply"
 151 A read command was sent to the firmware but the firmware failed to reply in
 152 time.
 153 .It "uath%d: device timeout"
 154 A frame dispatched to the hardware for transmission did not complete in time.
 155 The driver will reset the hardware.
 156 This should not happen.
 157 .El
 158 .Sh SEE ALSO
 159 .Xr netintro 4 ,
 160 .Xr usb 4 ,
 161 .Xr wlan 4 ,
 162 .Xr wlan_ccmp 4 ,
 163 .Xr wlan_tkip 4 ,
 164 .Xr wlan_wep 4 ,
 165 .Xr devd 8 ,
 166 .Xr ifconfig 8 ,
 167 .Xr uathload 8 ,
 168 .Xr wpa_supplicant 8
 169 .Sh HISTORY
 170 The
 171 .Nm
 172 driver first appeared in
 173 .Ox 4.0 .
 174 .Sh AUTHORS
 175 .An -nosplit
 176 The
 177 .Nm
 178 driver was written by
 179 .An Weongyo Jeong Aq weongyo@FreeBSD.org
 180 and
 181 .An Sam Leffler Aq sam@FreeBSD.org .
 182 It is distantly related to a driver written by
 183 .An Damien Bergamini Aq damien@openbsd.org .
 184 .Sh CAVEATS
 185 Atheros proprietary 108 Mbps mode (aka Super AG mode) is not supported.
 186 .Pp
 187 Dual-band adapters are presently not working;
 188 to workaround, restriction operation to 2.4GHz channels.