1.\" $OpenBSD: uath.4,v 1.25 2011/10/22 20:05:54 jmc Exp $ 2.\" 3.\" Copyright (c) 2006 4.\" Damien Bergamini <damien.bergamini@free.fr> 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 $Mdocdate: October 22 2011 $ 19.Dt UATH 4 20.Os 21.Sh NAME 22.Nm uath 23.Nd Atheros USB IEEE 802.11a/b/g wireless network device 24.Sh SYNOPSIS 25.Cd "uath* at uhub? port ?" 26.Sh DESCRIPTION 27The 28.Nm 29driver supports USB 2.0 wireless network devices based on Atheros 30Communications fifth generation AR5005UG and AR5005UX chipsets. 31.Pp 32The AR5005UG chipset is made of an AR5523 multiprotocol MAC/baseband processor 33and an AR2112 Radio-on-a-Chip that can operate between 2300 and 2500 MHz 34(802.11b/g). 35.Pp 36The AR5005UX chipset is made of an AR5523 multiprotocol MAC/baseband processor 37and an AR5112 dual band Radio-on-a-Chip that can operate between 2300 and 382500 MHz (802.11b/g) or 4900 and 5850 MHz (802.11a). 39.Pp 40The AR5005UG and AR5005UX chipsets both have an integrated 32-bit MIPS 41R4000-class processor that runs a firmware and manages, among other things, 42the automatic control of the transmit rate and the calibration of the radio. 43.Pp 44These are the modes the 45.Nm 46driver can operate in: 47.Bl -tag -width "IBSS-masterXX" 48.It BSS mode 49Also known as 50.Em infrastructure 51mode, this is used when associating with an access point, through 52which all traffic passes. 53This mode is the default. 54.It monitor mode 55In this mode the driver is able to receive packets without 56associating with an access point. 57This disables the internal receive filter and enables the card to 58capture packets from networks which it wouldn't normally have access to, 59or to scan for access points. 60.El 61.Pp 62.Nm 63supports hardware WEP. 64It can be typically configured in one of three modes: 65no encryption; 40-bit encryption; or 104-bit encryption. 66It is strongly recommended that WEP 67not be used as the sole mechanism 68to secure wireless communication, 69due to serious weaknesses in it. 70.Pp 71The 72.Nm 73driver can be configured at runtime with 74.Xr ifconfig 8 75or on boot with 76.Xr hostname.if 5 . 77.Sh FILES 78The following firmware file is loaded when a device is plugged: 79.Pp 80.Bl -tag -width Ds -offset indent -compact 81.It /etc/firmware/uath-ar5523 82.El 83.Pp 84This firmware file is not freely redistributable. 85.Pp 86A prepackaged version of the firmware, designed to be used with 87.Xr pkg_add 1 , 88can be found at: 89.Bd -literal -offset 3n 90http://firmware.openbsd.org/firmware/uath-firmware-1.0p0.tgz 91.Ed 92.Sh HARDWARE 93The following adapters should work: 94.Bl -column "TRENDware International TEW-444UB" "AR5005UX" -offset 6n 95.It Em Adapter Ta Em Chipset 96.\".It Belkin F6D3050 AR5005UX 97.It Li "Compex WLU108AG" Ta AR5005UX 98.It Li "Compex WLU108G" Ta AR5005UG 99.\".It Li "D-Link DWL-AG132" Ta AR5005UX 100.It Li "D-Link DWL-G132" Ta AR5005UG 101.\".It Li "Edimax EW-7315Ug" Ta AR5005UG (AR2414???) 102.\".It Li "Lancom USB-54ag" Ta AR5005UX 103.\".It Li "NEC WL54TU" Ta AR5005UX 104.It Li "IODATA WN-G54/US" Ta AR5005UG 105.It Li "MELCO WLI-U2-KAMG54" Ta AR5005UX 106.It Li "Netgear WG111T" Ta AR5005UG 107.It Li "Netgear WG111U" Ta AR5005UX 108.It Li "Netgear WPN111" Ta AR5005UG 109.It Li "Olitec 000544" Ta AR5005UG 110.It Li "Philips SNU6500" Ta AR5005UG 111.It Li "PLANET WDL-U357" Ta AR5005UX 112.\".It Li "Senao WUB-8004" Ta AR5005UX 113.It Li "Siemens Gigaset 108" Ta AR5005UG 114.It Li "SMC SMCWUSBT-G" Ta AR5005UG 115.It Li "SMC SMCWUSBT-G2" Ta AR5005UG 116.\".It Li "SparkLAN WL-685GS" Ta AR5005UG 117.It Li "SparkLAN WL-785A" Ta AR5005UX 118.It Li "TP-Link TL-WN620G" Ta AR5005UG 119.It Li "TRENDware International TEW-444UB" Ta AR5005UG 120.It Li "TRENDware International TEW-504UB" Ta AR5005UX 121.It Li "Unex Technology UR054ag" Ta AR5005UX 122.\".It Li "Wistron NeWeb DCUA-81" Ta AR5005UX 123.\".It Li "Wistron NeWeb DRUA-81" Ta AR5005UG 124.\".It Li "Wistron NeWeb DRUA-82" Ta AR5005UX 125.\".It Li "ZyXEL G-200 v2" Ta AR5005UG 126.It Li "ZyXEL XtremeMIMO M-202" Ta AR5005UX 127.El 128.Sh EXAMPLES 129The following 130.Xr hostname.if 5 131example configures uath0 to join whatever network is available on boot, 132using WEP key 133.Dq 0x1deadbeef1 , 134channel 11, obtaining an IP address using DHCP: 135.Bd -literal -offset indent 136dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11 137.Ed 138.Pp 139Configure uath0 for WEP, using hex key 140.Dq 0x1deadbeef1 : 141.Bd -literal -offset indent 142# ifconfig uath0 nwkey 0x1deadbeef1 143.Ed 144.Pp 145Return uath0 to its default settings: 146.Bd -literal -offset indent 147# ifconfig uath0 -bssid -chan media autoselect \e 148 nwid "" -nwkey 149.Ed 150.Pp 151Join an existing BSS network, 152.Dq my_net : 153.Bd -literal -offset indent 154# ifconfig uath0 192.168.1.1 netmask 0xffffff00 nwid my_net 155.Ed 156.Sh DIAGNOSTICS 157.Bl -diag 158.It "uath%d: error %d, could not read firmware %s" 159For some reason, the driver was unable to read the firmware image from the 160filesystem. 161The file might be missing or corrupted. 162.It "uath%d: could not load firmware (error=%s)" 163An error occurred while attempting to upload the firmware to the onboard 164MIPS R4000 processor. 165.It "uath%d: could not initialize adapter (error=%d)" 166The firmware was uploaded successfully but did not initialize properly or 167in time. 168.It "uath%d: could not send command (error=%s)" 169An attempt to send a command to the firmware failed. 170.It "uath%d: timeout waiting for command reply" 171A read command was sent to the firmware but the firmware failed to reply in 172time. 173.It "uath%d: device timeout" 174A frame dispatched to the hardware for transmission did not complete in time. 175The driver will reset the hardware. 176This should not happen. 177.El 178.Sh SEE ALSO 179.Xr arp 4 , 180.Xr ifmedia 4 , 181.Xr intro 4 , 182.Xr netintro 4 , 183.Xr usb 4 , 184.Xr hostname.if 5 , 185.Xr ifconfig 8 186.Sh HISTORY 187The 188.Nm 189driver first appeared in 190.Ox 4.0 . 191.Sh AUTHORS 192The 193.Nm 194driver was written by 195.An Damien Bergamini Aq damien@openbsd.org . 196.Sh CAVEATS 197Atheros Communications refuses to release any documentation for their products. 198Atheros proprietary 108 Mbps mode (aka Super AG mode) is not supported. 199.Pp 200The 201.Nm 202driver does not attempt to do any regulation of radio frequencies. 203