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 .Bl -column "TRENDware International TEW-444UB" "AR5005UX"
  87 .It Em "Adapter" Ta Em "Chipset"
  88 .\".It Belkin F6D3050   AR5005UX
  89 .It Li "Compex WLU108AG" Ta AR5005UX
  90 .It Li "Compex WLU108G" Ta AR5005UG
  91 .\".It Li "D-Link DWL-AG132" Ta AR5005UX
  92 .It Li "D-Link DWL-G132" Ta AR5005UG
  93 .\".It Li "Edimax EW-7315Ug" Ta AR5005UG (AR2414???)
  94 .\".It Li "Lancom USB-54ag" Ta AR5005UX
  95 .\".It Li "NEC WL54TU" Ta AR5005UX
  96 .It Li "IODATA WN-G54/US" Ta AR5005UG
  97 .It Li "MELCO WLI-U2-KAMG54" Ta AR5005UX
  98 .It Li "Netgear WG111T" Ta AR5005UG
  99 .It Li "Netgear WG111U" Ta AR5005UX
 100 .It Li "Netgear WPN111" Ta AR5005UG
 101 .It Li "Olitec 000544" Ta AR5005UG
 102 .It Li "PLANET WDL-U357" Ta AR5005UX
 103 .\".It Li "Senao WUB-8004" Ta AR5005UX
 104 .It Li "Siemens Gigaset 108" Ta AR5005UG
 105 .It Li "SMC SMCWUSBT-G" Ta AR5005UG
 106 .It Li "SMC SMCWUSBT-G2" Ta AR5005UG
 107 .\".It Li "SparkLAN WL-685GS" Ta AR5005UG
 108 .It Li "SparkLAN WL-785A" Ta AR5005UX
 109 .It Li "TP-Link TL-WN620G" Ta AR5005UG
 110 .It Li "TRENDware International TEW-444UB" Ta AR5005UG
 111 .It Li "TRENDware International TEW-504UB" Ta AR5005UX
 112 .It Li "Unex Technology UR054ag" Ta AR5005UX
 113 .\".It Li "Wistron NeWeb DCUA-81" Ta AR5005UX
 114 .\".It Li "Wistron NeWeb DRUA-81" Ta AR5005UG
 115 .\".It Li "Wistron NeWeb DRUA-82" Ta AR5005UX
 116 .\".It Li "ZyXEL G-200 v2" Ta AR5005UG
 117 .It Li "ZyXEL XtremeMIMO M-202" Ta AR5005UX
 118 .El
 119 .Pp
 120 An up to date list can be found at
 121 .Pa http://customerproducts.atheros.com/customerproducts/default.asp .
 122 .Sh EXAMPLES
 123 Join an existing BSS network (i.e., connect to an access point):
 124 .Bd -literal -offset indent
 125 ifconfig wlan create wlandev uath0 inet 192.168.0.20 \e
 126     netmask 0xffffff00
 127 .Ed
 128 .Pp
 129 Join a specific BSS network with network name
 130 .Dq Li my_net :
 131 .Pp
 132 .Dl "ifconfig wlan create wlandev uath0 ssid my_net up"
 133 .Pp
 134 Join a specific BSS network with 64-bit WEP encryption:
 135 .Bd -literal -offset indent
 136 ifconfig wlan create wlandev uath0 ssid my_net \e
 137         wepmode on wepkey 0x1234567890 weptxkey 1 up
 138 .Ed
 139 .Pp
 140 Join a specific BSS network with 128-bit WEP encryption:
 141 .Bd -literal -offset indent
 142 ifconfig wlan create wlandev uath0 wlanmode adhoc ssid my_net \e
 143     wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
 144 .Ed
 145 .Sh DIAGNOSTICS
 146 .Bl -diag
 147 .It "uath%d: could not send command (error=%s)"
 148 An attempt to send a command to the firmware failed.
 149 .It "uath%d: timeout waiting for command reply"
 150 A read command was sent to the firmware but the firmware failed to reply in
 151 time.
 152 .It "uath%d: device timeout"
 153 A frame dispatched to the hardware for transmission did not complete in time.
 154 The driver will reset the hardware.
 155 This should not happen.
 156 .El
 157 .Sh SEE ALSO
 158 .Xr netintro 4 ,
 159 .Xr usb 4 ,
 160 .Xr wlan 4 ,
 161 .Xr wlan_ccmp 4 ,
 162 .Xr wlan_tkip 4 ,
 163 .Xr wlan_wep 4 ,
 164 .Xr devd 8 ,
 165 .Xr ifconfig 8 ,
 166 .Xr uathload 8 ,
 167 .Xr wpa_supplicant 8
 168 .Sh HISTORY
 169 The
 170 .Nm
 171 driver first appeared in
 172 .Ox 4.0 .
 173 .Sh AUTHORS
 174 .An -nosplit
 175 The
 176 .Nm
 177 driver was written by
 178 .An Weongyo Jeong Aq weongyo@FreeBSD.org
 179 and
 180 .An Sam Leffler Aq sam@FreeBSD.org .
 181 It is distantly related to a driver written by
 182 .An Damien Bergamini Aq damien@openbsd.org .
 183 .Sh CAVEATS
 184 Atheros proprietary 108 Mbps mode (aka Super AG mode) is not supported.
 185 .Pp
 186 Dual-band adapters are presently not working;
 187 to workaround, restriction operation to 2.4GHz channels.