1.\" $OpenBSD: zyd.4,v 1.43 2014/02/15 20:28:19 tedu 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 15 2014 $ 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 current 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 Planex GW-US54ZGL 118.It Safecom SWMULZ-5400 119.It Sagem XG 760A 120.It Sagem XG 76NA 121.It Sandberg Wireless G54 USB 122.It Sitecom WL-113 123.It Sitecom WL-603 124.It SMC SMCWUSB-G 125.It Sweex wireless USB 54 Mbps 126.It Tekram/Siemens USB adapter 127.It Telegent TG54USB 128.It Trendnet TEW-424UB rev A 129.It Trendnet TEW-429UB 130.It TwinMOS G240 131.It US Robotics 5423 132.It X-Micro XWL-11GUZX 133.It Yakumo QuickWLAN USB 134.It Zonet ZEW2501 135.It ZyXEL AG-220 136.It ZyXEL AG-225H v2 137.It ZyXEL G-200 v2 138.It ZyXEL G-202 139.It ZyXEL G-220 140.El 141.Sh FILES 142The adapter needs some firmware files, which are loaded on demand by the 143driver when a device is attached: 144.Pp 145.Bl -tag -width Ds -offset indent -compact 146.It Pa /etc/firmware/zd1211 147.It Pa /etc/firmware/zd1211b 148.El 149.Sh EXAMPLES 150The following example scans for available networks: 151.Pp 152.Dl # ifconfig zyd0 scan 153.Pp 154The following 155.Xr hostname.if 5 156example configures zyd0 to join network 157.Dq mynwid , 158using WPA key 159.Dq mywpakey , 160obtaining an IP address using DHCP: 161.Bd -literal -offset indent 162nwid mynwid 163wpakey mywpakey 164dhcp 165.Ed 166.Sh DIAGNOSTICS 167.Bl -diag 168.It "zyd0: error N, could not read firmware ..." 169For some reason, the driver was unable to read the firmware image from the 170filesystem. 171The file might be missing or corrupted. 172.It "zyd0: could not load firmware (error=N)" 173An error occurred while attempting to upload the firmware to the onboard 174microcontroller unit. 175.It "zyd0: could not send command (error=...)" 176An attempt to send a command to the firmware failed. 177.It "zyd0: sorry, radio ... is not supported yet" 178Support for the specified radio chip is not yet implemented in the driver. 179The device will not attach. 180.It "zyd0: device version mismatch: 0xXXXX (only >= 43.30 supported)" 181Early revisions of the ZD1211 chipset are not supported by this driver. 182The device will not attach. 183.It "zyd0: device timeout" 184A frame dispatched to the hardware for transmission did not complete in time. 185The driver will reset the hardware. 186This should not happen. 187.El 188.Sh SEE ALSO 189.Xr arp 4 , 190.Xr ifmedia 4 , 191.Xr intro 4 , 192.Xr netintro 4 , 193.Xr usb 4 , 194.Xr hostname.if 5 , 195.Xr ifconfig 8 196.Sh AUTHORS 197.An -nosplit 198The 199.Nm 200driver was written by 201.An Florian Stoehr Aq Mt ich@florian-stoehr.de , 202.An Damien Bergamini Aq Mt damien.bergamini@free.fr , 203and 204.An Jonathan Gray Aq Mt jsg@openbsd.org . 205.Sh CAVEATS 206The 207.Nm 208driver does not support a lot of the functionality available in the hardware. 209More work is required to properly support the IBSS and power management 210features. 211