1.\" $OpenBSD: zyd.4,v 1.37 2013/02/14 07:40:42 jmc Exp $ 2.\" 3.\" Copyright (c) 1997, 1998, 1999 4.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Bill Paul. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31.\" THE POSSIBILITY OF SUCH DAMAGE. 32.\" 33.Dd $Mdocdate: February 14 2013 $ 34.Dt ZYD 4 35.Os 36.Sh NAME 37.Nm zyd 38.Nd ZyDAS ZD1211/ZD1211B USB IEEE 802.11b/g wireless network device 39.Sh SYNOPSIS 40.Cd "zyd* at uhub? port ?" 41.Sh DESCRIPTION 42The 43.Nm 44driver provides support for wireless network adapters based around 45the ZyDAS ZD1211 and ZD1211B USB chips. 46.Pp 47These are the modes the 48.Nm 49driver can operate in: 50.Bl -tag -width "IBSS-masterXX" 51.It BSS mode 52Also known as 53.Em infrastructure 54mode, this is used when associating with an access point, through 55which all traffic passes. 56This mode is the default. 57.It monitor mode 58In this mode the driver is able to receive packets without 59associating with an access point. 60This disables the internal receive filter and enables the card to 61capture packets from networks which it wouldn't normally have access to, 62or to scan for access points. 63.El 64.Pp 65The 66.Nm 67driver can be configured to use 68Wired Equivalent Privacy (WEP) or 69Wi-Fi Protected Access (WPA-PSK and WPA2-PSK). 70WPA is the de facto encryption standard for wireless networks. 71It is strongly recommended that WEP 72not be used as the sole mechanism 73to secure wireless communication, 74due to serious weaknesses in it. 75The 76.Nm 77driver relies on the software 802.11 stack for both encryption and decryption 78of data frames. 79.Pp 80The 81.Nm 82driver can be configured at runtime with 83.Xr ifconfig 8 84or on boot with 85.Xr hostname.if 5 . 86.Sh HARDWARE 87The following devices are known to be supported by the 88.Nm 89driver: 90.Pp 91.Bl -tag -width Ds -offset indent -compact 92.It 3COM 3CRUSB10075 93.It Acer WLAN-G-US1 94.It Airlink+ AWLL3025 95.It Airlink 101 AWLL3026 96.It AOpen 802.11g WL54 97.It Asus A9T integrated wireless 98.It Asus WL-159g 99.It Belkin F5D7050 v.4000 100.It Billion BiPAC 3011G 101.It Buffalo WLI-U2-KG54L 102.It CC&C WL-2203B 103.It DrayTek Vigor 550 104.It Edimax EW-7317UG 105.It Edimax EW-7317LDG 106.It Fiberline Networks WL-43OU 107.It iNexQ UR055g 108.It Linksys WUSBF54G 109.It Longshine LCS-8131G3 110.It MSI US54SE 111.It Philips SNU5600 112.It Planet WL-U356 113.It Planex GW-US54GD 114.It Planex GW-US54GXS 115.It Planex GW-US54GZL 116.It Planex GW-US54Mini 117.It Safecom SWMULZ-5400 118.It Sagem XG 760A 119.It Sagem XG 76NA 120.It Sandberg Wireless G54 USB 121.It Sitecom WL-113 122.It Sitecom WL-603 123.It SMC SMCWUSB-G 124.It Sweex wireless USB 54 Mbps 125.It Tekram/Siemens USB adapter 126.It Telegent TG54USB 127.It Trendnet TEW-424UB rev A 128.It Trendnet TEW-429UB 129.It TwinMOS G240 130.It US Robotics 5423 131.It X-Micro XWL-11GUZX 132.It Yakumo QuickWLAN USB 133.It Zonet ZEW2501 134.It ZyXEL G-202 135.It ZyXEL ZyAIR G-220 136.El 137.Sh FILES 138The adapter needs some firmware files, which are loaded on demand by the 139driver when a device is attached: 140.Pp 141.Bl -tag -width Ds -offset indent -compact 142.It Pa /etc/firmware/zd1211 143.It Pa /etc/firmware/zd1211b 144.El 145.Sh EXAMPLES 146The following example scans for available networks: 147.Pp 148.Dl # ifconfig zyd0 scan 149.Pp 150The following 151.Xr hostname.if 5 152example configures zyd0 to join network 153.Dq mynwid , 154using WPA key 155.Dq mywpakey , 156obtaining an IP address using DHCP: 157.Bd -literal -offset indent 158nwid mynwid 159wpakey mywpakey 160dhcp 161.Ed 162.Sh DIAGNOSTICS 163.Bl -diag 164.It "zyd%d: error %d, could not read firmware %s" 165For some reason, the driver was unable to read the firmware image from the 166filesystem. 167The file might be missing or corrupted. 168.It "zyd%d: could not load firmware (error=%d)" 169An error occurred while attempting to upload the firmware to the onboard 170microcontroller unit. 171.It "zyd%d: could not send command (error=%s)" 172An attempt to send a command to the firmware failed. 173.It "zyd%d: sorry, radio %s is not supported yet" 174Support for the specified radio chip is not yet implemented in the driver. 175The device will not attach. 176.It "zyd%d: device version mismatch: 0x%x (only >= 43.30 supported)" 177Early revisions of the ZD1211 chipset are not supported by this driver. 178The device will not attach. 179.It "zyd%d: device timeout" 180A frame dispatched to the hardware for transmission did not complete in time. 181The driver will reset the hardware. 182This should not happen. 183.El 184.Sh SEE ALSO 185.Xr arp 4 , 186.Xr ifmedia 4 , 187.Xr intro 4 , 188.Xr netintro 4 , 189.Xr usb 4 , 190.Xr hostname.if 5 , 191.Xr ifconfig 8 192.Sh AUTHORS 193.An -nosplit 194The 195.Nm 196driver was written by 197.An Florian Stoehr Aq ich@florian-stoehr.de , 198.An Damien Bergamini Aq damien@openbsd.org , 199and 200.An Jonathan Gray Aq jsg@openbsd.org . 201.Sh CAVEATS 202The 203.Nm 204driver does not support a lot of the functionality available in the hardware. 205More work is required to properly support the IBSS and power management 206features. 207