.\" $OpenBSD: zyd.4,v 1.22 2007/05/24 02:49:57 cnst Exp $ .\" $NetBSD: zyd.4,v 1.7 2019/03/24 13:31:31 gson Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul . All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. All advertising materials mentioning features or use of this software .\" must display the following acknowledgement: .\" This product includes software developed by Bill Paul. .\" 4. Neither the name of the author nor the names of any co-contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF .\" THE POSSIBILITY OF SUCH DAMAGE. .\" .Dd March 24, 2019 .Dt ZYD 4 .Os .Sh NAME .Nm zyd .Nd ZyDAS ZD1211/ZD1211B USB IEEE 802.11b/g wireless network device .Sh SYNOPSIS .Cd "zyd* at uhub? port ?" .Sh DESCRIPTION The .Nm driver provides support for wireless network adapters based around the ZyDAS ZD1211 and ZD1211B USB chips. .Pp These are the modes the .Nm driver can operate in: .Bl -tag -width "IBSS-masterXX" .It BSS mode Also known as .Em infrastructure mode, this is used when associating with an access point, through which all traffic passes. This mode is the default. .It monitor mode In this mode the driver is able to receive packets without associating with an access point. This disables the internal receive filter and enables the card to capture packets from networks which it wouldn't normally have access to, or to scan for access points. .El .Pp .Nm supports software WEP. It can be typically configured in one of three modes: no encryption; 40-bit encryption; or 104-bit encryption. Unfortunately, due to serious weaknesses in WEP protocol it is strongly recommended that it not be used as the sole mechanism to secure wireless communication. WEP is not enabled by default. .Sh CONFIGURATION The .Nm driver can be configured at runtime with .Xr ifconfig 8 or on boot with .Xr ifconfig.if 5 using the following parameters: .Bl -tag -width Ds .It Cm bssid Ar bssid Set the desired BSSID. .It Fl bssid Unset the desired BSSID. The interface will automatically select a BSSID in this mode, which is the default. .It Cm chan Ar n Set the channel (radio frequency) to be used by the driver based on the given channel ID .Ar n . .It Fl chan Unset the desired channel to be used by the driver. The driver will automatically select a channel in this mode, which is the default. .It Cm media Ar media The .Nm driver supports the following .Ar media types: .Pp .Bl -tag -width autoselect -compact .It Cm autoselect Enable autoselection of the media type and options. .It Cm DS1 Set 802.11b DS 1Mbps operation. .It Cm DS2 Set 802.11b DS 2Mbps operation. .It Cm DS5 Set 802.11b DS 5.5Mbps operation. .It Cm DS11 Set 802.11b DS 11Mbps operation. .El .It Cm mediaopt Ar opts The .Nm driver supports the following media options: .Bl -tag -width ibss .It Cm ibss Select Independent Basic Service Set (IBSS) operation. .El .It Fl mediaopt Ar opts Disable the specified media options on the driver and return it to the default mode of operation (BSS). .It Cm nwid Ar id Set the network ID. The .Ar id can either be any text string up to 32 characters in length, or a series of hexadecimal digits up to 64 digits. An empty .Ar id string allows the interface to connect to any available access points. By default the .Nm driver uses an empty string. Note that network ID is synonymous with Extended Service Set ID (ESSID). .It Fl nwid Set the network ID to the empty string to allow the interface to connect to any available access point. .It Cm nwkey Ar key Enable WEP encryption using the specified .Ar key . The .Ar key can either be a string, a series of hexadecimal digits (preceded by .Sq 0x ) , or a set of keys of the form .Dq n:k1,k2,k3,k4 , where .Sq n specifies which of the keys will be used for transmitted packets, and the four keys, .Dq k1 through .Dq k4 , are configured as WEP keys. If a set of keys is specified, a comma .Pq Sq \&, within the key must be escaped with a backslash. Note that if multiple keys are used, their order must be the same within the network. .Nm is capable of using both 40-bit (5 characters or 10 hexadecimal digits) or 104-bit (13 characters or 26 hexadecimal digits) keys. .It Fl nwkey Disable WEP encryption. This is the default mode of operation. .El .Sh HARDWARE The following devices are known to be supported by the .Nm driver: .Pp .Bl -tag -width Ds -offset indent -compact .It 3COM 3CRUSB10075 .It Acer WLAN-G-US1 .It Airlink+ AWLL3025 .It Airlink 101 AWLL3026 .It AOpen 802.11g WL54 .It Asus A9T integrated wirless .It Asus WL-159g .It Belkin F5D7050 v.4000 .It Billion BiPAC 3011G .It Buffalo WLI-U2-KG54L .It CC&C WL-2203B .It DrayTek Vigor 550 .It Edimax EW-7317UG .It Edimax EW-7317LDG .It Fiberline Networks WL-43OU .It iNexQ UR055g .It Linksys WUSBF54G .It Longshine LCS-8131G3 .It MSI US54SE .It Philips SNU5600 .It Planet WL-U356 .It Planex GW-US54GZ .It Planex GW-US54GZL .It Planex GW-US54Mini .It Safecom SWMULZ-5400 .It Sagem XG 760A .It Sagem XG 76NA .It Sandberg Wireless G54 USB .It Sitecom WL-113 .It SMC SMCWUSB-G .It Sweex wireless USB 54 Mbps .It Tekram/Siemens USB adapter .It Telegent TG54USB .It Trendnet TEW-424UB .It Trendnet TEW-429UB .It TwinMOS G240 .It US Robotics 5423 .It X-Micro XWL-11GUZX .It Yakumo QuickWLAN USB .It Zonet ZEW2501 .It ZyXEL ZyAIR G-220 .El .Sh FILES The adapter needs some firmware files, which are loaded on demand by the driver when a device is attached: .Pp .Bl -tag -width Ds -offset indent -compact .It Pa /libdata/firmware/zyd/zyd-zd1211 .It Pa /libdata/firmware/zyd/zyd-zd1211b .El See .Xr firmload 9 for how to change this. .Sh EXAMPLES The following .Xr ifconfig.if 5 example configures zyd0 to join whatever network is available on boot, using WEP key .Dq 0x1deadbeef1 , channel 11: .Bd -literal -offset indent inet 192.168.1.1 netmask 255.255.255.0 nwkey 0x1deadbeef1 chan 11 .Ed .Pp Configure zyd0 for WEP, using hex key .Dq 0x1deadbeef1 : .Bd -literal -offset indent # ifconfig zyd0 nwkey 0x1deadbeef1 .Ed .Pp Return zyd0 to its default settings: .Bd -literal -offset indent # ifconfig zyd0 -bssid -chan media autoselect \e nwid "" -nwkey .Ed .Pp Join an existing BSS network, .Dq my_net : .Bd -literal -offset indent # ifconfig zyd0 192.168.0.2 netmask 0xffffff00 nwid my_net .Ed .Sh DIAGNOSTICS .Bl -diag .It "zyd%d: could not read firmware file %s (error=%d)" For some reason, the driver was unable to read the firmware file from the filesystem. The file might be missing or corrupted. .It "zyd%d: could not load firmware (error=%d)" An error occurred while attempting to upload the firmware to the onboard microcontroller unit. .It "zyd%d: could not send command (error=%s)" An attempt to send a command to the firmware failed. .It "zyd%d: sorry, radio %s is not supported yet" Support for the specified radio chip is not yet implemented in the driver. The device will not attach. .It "zyd%d: device version mismatch: 0x%x (only >= 43.30 supported)" Early revisions of the ZD1211 chipset are not supported by this driver. The device will not attach. .It "zyd%d: device timeout" A frame dispatched to the hardware for transmission did not complete in time. The driver will reset the hardware. This should not happen. .El .Sh SEE ALSO .Xr arp 4 , .Xr ifmedia 4 , .Xr intro 4 , .Xr netintro 4 , .Xr usb 4 , .Xr ifconfig.if 5 , .Xr ifconfig 8 , .Xr firmload 9 .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Florian Stoehr Aq Mt ich@florian-stoehr.de , .An Damien Bergamini Aq Mt damien@openbsd.org , and .An Jonathan Gray Aq Mt jsg@openbsd.org . .Sh CAVEATS The .Nm driver does not support a lot of the functionality available in the hardware. More work is required to properly support the IBSS and power management features.