1.\" $OpenBSD: uath.4,v 1.24 2011/09/03 22:59:08 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: September 3 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. 64Wired Equivalent Privacy (WEP) is the de facto encryption standard 65for wireless networks. 66It can be typically configured in one of three modes: 67no encryption; 40-bit encryption; or 104-bit encryption. 68Unfortunately, due to serious weaknesses in WEP protocol 69it is strongly recommended that it not be used as the 70sole mechanism to secure wireless communication. 71WEP is not enabled by default. 72.Pp 73The 74.Nm 75driver can be configured at runtime with 76.Xr ifconfig 8 77or on boot with 78.Xr hostname.if 5 . 79.Sh FILES 80The following firmware file is loaded when a device is plugged: 81.Pp 82.Bl -tag -width Ds -offset indent -compact 83.It /etc/firmware/uath-ar5523 84.El 85.Pp 86This firmware file is not freely redistributable. 87.Pp 88A prepackaged version of the firmware, designed to be used with 89.Xr pkg_add 1 , 90can be found at: 91.Bd -literal -offset 3n 92http://firmware.openbsd.org/firmware/uath-firmware-1.0p0.tgz 93.Ed 94.Sh HARDWARE 95The following adapters should work: 96.Bl -column "TRENDware International TEW-444UB" "AR5005UX" -offset 6n 97.It Em Adapter Ta Em Chipset 98.\".It Belkin F6D3050 AR5005UX 99.It Li "Compex WLU108AG" Ta AR5005UX 100.It Li "Compex WLU108G" Ta AR5005UG 101.\".It Li "D-Link DWL-AG132" Ta AR5005UX 102.It Li "D-Link DWL-G132" Ta AR5005UG 103.\".It Li "Edimax EW-7315Ug" Ta AR5005UG (AR2414???) 104.\".It Li "Lancom USB-54ag" Ta AR5005UX 105.\".It Li "NEC WL54TU" Ta AR5005UX 106.It Li "IODATA WN-G54/US" Ta AR5005UG 107.It Li "MELCO WLI-U2-KAMG54" Ta AR5005UX 108.It Li "Netgear WG111T" Ta AR5005UG 109.It Li "Netgear WG111U" Ta AR5005UX 110.It Li "Netgear WPN111" Ta AR5005UG 111.It Li "Olitec 000544" Ta AR5005UG 112.It Li "Philips SNU6500" Ta AR5005UG 113.It Li "PLANET WDL-U357" Ta AR5005UX 114.\".It Li "Senao WUB-8004" Ta AR5005UX 115.It Li "Siemens Gigaset 108" Ta AR5005UG 116.It Li "SMC SMCWUSBT-G" Ta AR5005UG 117.It Li "SMC SMCWUSBT-G2" Ta AR5005UG 118.\".It Li "SparkLAN WL-685GS" Ta AR5005UG 119.It Li "SparkLAN WL-785A" Ta AR5005UX 120.It Li "TP-Link TL-WN620G" Ta AR5005UG 121.It Li "TRENDware International TEW-444UB" Ta AR5005UG 122.It Li "TRENDware International TEW-504UB" Ta AR5005UX 123.It Li "Unex Technology UR054ag" Ta AR5005UX 124.\".It Li "Wistron NeWeb DCUA-81" Ta AR5005UX 125.\".It Li "Wistron NeWeb DRUA-81" Ta AR5005UG 126.\".It Li "Wistron NeWeb DRUA-82" Ta AR5005UX 127.\".It Li "ZyXEL G-200 v2" Ta AR5005UG 128.It Li "ZyXEL XtremeMIMO M-202" Ta AR5005UX 129.El 130.Sh EXAMPLES 131The following 132.Xr hostname.if 5 133example configures uath0 to join whatever network is available on boot, 134using WEP key 135.Dq 0x1deadbeef1 , 136channel 11, obtaining an IP address using DHCP: 137.Bd -literal -offset indent 138dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11 139.Ed 140.Pp 141Configure uath0 for WEP, using hex key 142.Dq 0x1deadbeef1 : 143.Bd -literal -offset indent 144# ifconfig uath0 nwkey 0x1deadbeef1 145.Ed 146.Pp 147Return uath0 to its default settings: 148.Bd -literal -offset indent 149# ifconfig uath0 -bssid -chan media autoselect \e 150 nwid "" -nwkey 151.Ed 152.Pp 153Join an existing BSS network, 154.Dq my_net : 155.Bd -literal -offset indent 156# ifconfig uath0 192.168.1.1 netmask 0xffffff00 nwid my_net 157.Ed 158.Sh DIAGNOSTICS 159.Bl -diag 160.It "uath%d: error %d, could not read firmware %s" 161For some reason, the driver was unable to read the firmware image from the 162filesystem. 163The file might be missing or corrupted. 164.It "uath%d: could not load firmware (error=%s)" 165An error occurred while attempting to upload the firmware to the onboard 166MIPS R4000 processor. 167.It "uath%d: could not initialize adapter (error=%d)" 168The firmware was uploaded successfully but did not initialize properly or 169in time. 170.It "uath%d: could not send command (error=%s)" 171An attempt to send a command to the firmware failed. 172.It "uath%d: timeout waiting for command reply" 173A read command was sent to the firmware but the firmware failed to reply in 174time. 175.It "uath%d: device timeout" 176A frame dispatched to the hardware for transmission did not complete in time. 177The driver will reset the hardware. 178This should not happen. 179.El 180.Sh SEE ALSO 181.Xr arp 4 , 182.Xr ifmedia 4 , 183.Xr intro 4 , 184.Xr netintro 4 , 185.Xr usb 4 , 186.Xr hostname.if 5 , 187.Xr ifconfig 8 188.Sh HISTORY 189The 190.Nm 191driver first appeared in 192.Ox 4.0 . 193.Sh AUTHORS 194The 195.Nm 196driver was written by 197.An Damien Bergamini Aq damien@openbsd.org . 198.Sh CAVEATS 199Atheros Communications refuses to release any documentation for their products. 200Atheros proprietary 108 Mbps mode (aka Super AG mode) is not supported. 201.Pp 202The 203.Nm 204driver does not attempt to do any regulation of radio frequencies. 205