1.\" $OpenBSD: zyd.4,v 1.48 2021/10/24 12:32:42 kn 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: October 24 2021 $ 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 (WPA1 and WPA2). 70WPA2 is the current encryption standard for wireless networks. 71It is strongly recommended that neither WEP nor WPA1 72are used as the sole mechanism to secure wireless communication, 73due to serious weaknesses. 74WPA1 is disabled by default and may be enabled using the option 75.Qq Cm wpaprotos Ar wpa1,wpa2 . 76For standard WPA networks which use pre-shared keys (PSK), 77keys are configured using the 78.Qq Cm wpakey 79option. 80WPA-Enterprise networks require use of the wpa_supplicant package. 81The 82.Nm 83driver relies on the software 802.11 stack for both encryption and decryption 84of data frames. 85.Pp 86The 87.Nm 88driver can be configured at runtime with 89.Xr ifconfig 8 90or on boot with 91.Xr hostname.if 5 . 92.Sh FILES 93The adapter needs some firmware files, which are loaded on demand by the 94driver when a device is attached: 95.Pp 96.Bl -tag -width Ds -offset indent -compact 97.It Pa /etc/firmware/zd1211 98.It Pa /etc/firmware/zd1211b 99.El 100.Sh HARDWARE 101The following devices are known to be supported by the 102.Nm 103driver: 104.Pp 105.Bl -tag -width Ds -offset indent -compact 106.It 3COM 3CRUSB10075 107.It Acer WLAN-G-US1 108.It Airlink+ AWLL3025 109.It Airlink 101 AWLL3026 110.It AOpen 802.11g WL54 111.It Asus A9T integrated wireless 112.It Asus WL-159g 113.It Belkin F5D7050 v.4000 114.It Billion BiPAC 3011G 115.It Buffalo WLI-U2-KG54L 116.It CC&C WL-2203B 117.It DrayTek Vigor 550 118.It Edimax EW-7317UG 119.It Edimax EW-7317LDG 120.It Fiberline Networks WL-43OU 121.It iNexQ UR055g 122.It Linksys WUSBF54G 123.It Longshine LCS-8131G3 124.It MSI US54SE 125.It Philips SNU5600 126.It Planet WL-U356 127.It Planex GW-US54GD 128.It Planex GW-US54GXS 129.It Planex GW-US54GZL 130.It Planex GW-US54Mini 131.It Planex GW-US54ZGL 132.It Safecom SWMULZ-5400 133.It Sagem XG 760A 134.It Sagem XG 76NA 135.It Sandberg Wireless G54 USB 136.It Sitecom WL-113 137.It Sitecom WL-603 138.It SMC SMCWUSB-G 139.It Sweex wireless USB 54 Mbps 140.It Tekram/Siemens USB adapter 141.It Telegent TG54USB 142.It Trendnet TEW-424UB rev A 143.It Trendnet TEW-429UB 144.It TwinMOS G240 145.It US Robotics 5423 146.It X-Micro XWL-11GUZX 147.It Yakumo QuickWLAN USB 148.It Zonet ZEW2501 149.It ZyXEL AG-220 150.It ZyXEL AG-225H v2 151.It ZyXEL G-200 v2 152.It ZyXEL G-202 153.It ZyXEL G-220 154.El 155.Sh EXAMPLES 156The following example scans for available networks: 157.Pp 158.Dl # ifconfig zyd0 scan 159.Pp 160The following 161.Xr hostname.if 5 162example configures zyd0 to join network 163.Dq mynwid , 164using WPA key 165.Dq mywpakey , 166obtaining an IP address using DHCP: 167.Bd -literal -offset indent 168join mynwid wpakey mywpakey 169inet autoconf 170.Ed 171.Sh DIAGNOSTICS 172.Bl -diag 173.It "zyd0: error N, could not read firmware ..." 174For some reason, the driver was unable to read the firmware image from the 175filesystem. 176The file might be missing or corrupted. 177.It "zyd0: could not load firmware (error=N)" 178An error occurred while attempting to upload the firmware to the onboard 179microcontroller unit. 180.It "zyd0: could not send command (error=...)" 181An attempt to send a command to the firmware failed. 182.It "zyd0: sorry, radio ... is not supported yet" 183Support for the specified radio chip is not yet implemented in the driver. 184The device will not attach. 185.It "zyd0: device version mismatch: 0xXXXX (only >= 43.30 supported)" 186Early revisions of the ZD1211 chipset are not supported by this driver. 187The device will not attach. 188.It "zyd0: device timeout" 189A frame dispatched to the hardware for transmission did not complete in time. 190The driver will reset the hardware. 191This should not happen. 192.El 193.Sh SEE ALSO 194.Xr arp 4 , 195.Xr ifmedia 4 , 196.Xr intro 4 , 197.Xr netintro 4 , 198.Xr usb 4 , 199.Xr hostname.if 5 , 200.Xr ifconfig 8 201.Sh AUTHORS 202.An -nosplit 203The 204.Nm 205driver was written by 206.An Florian Stoehr Aq Mt ich@florian-stoehr.de , 207.An Damien Bergamini Aq Mt damien.bergamini@free.fr , 208and 209.An Jonathan Gray Aq Mt jsg@openbsd.org . 210.Sh CAVEATS 211The 212.Nm 213driver does not support a lot of the functionality available in the hardware. 214More work is required to properly support the IBSS and power management 215features. 216