diff options
| -rw-r--r-- | share/man/man4/zyd.4 | 393 |
1 files changed, 393 insertions, 0 deletions
diff --git a/share/man/man4/zyd.4 b/share/man/man4/zyd.4 new file mode 100644 index 0000000..0771ab5 --- /dev/null +++ b/share/man/man4/zyd.4 @@ -0,0 +1,393 @@ +.\" $OpenBSD: zyd.4,v 1.22 2007/05/24 02:49:57 cnst Exp $ +.\" $NetBSD: zyd.4,v 1.1 2007/06/09 11:20:55 kiyohara Exp $ +.\" +.\" Copyright (c) 1997, 1998, 1999 +.\" Bill Paul <wpaul@ctr.columbia.edu>. 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. +.\" +.\" $FreeBSD$ +.\" +.Dd May 28, 2007 +.Dt ZYD 4 +.Os +.Sh NAME +.Nm zyd +.Nd ZyDAS ZD1211/ZD1211B USB IEEE 802.11b/g wireless network device +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device ehci" +.Cd "device uhci" +.Cd "device ohci" +.Cd "device usb" +.Cd "device zyd" +.Cd "device wlan" +.Cd "device wlan_amrr" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_zyd_load="YES" +.Ed +.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. +Wired Equivalent Privacy (WEP) is the de facto encryption standard +for wireless networks. +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 HARDWARE +The following devices are known to be supported by the +.Nm +driver: +.Pp +.Bl -column -compact ".Li Atlantis Land A02-PCM-W54" "Bus" +.It Em Card Ta Em Bus +.It Li "3COM 3CRUSB10075" Ta USB +.It Li "Acer WLAN-G-US1" Ta USB +.It Li "Airlink+ AWLL3025" Ta USB +.It Li "Airlink 101 AWLL3026" Ta USB +.It Li "AOpen 802.11g WL54" Ta USB +.It Li "Asus A9T integrated wirless" Ta USB +.It Li "Asus WL-159g" Ta USB +.It Li "Belkin F5D7050 v.4000" Ta USB +.It Li "Billion BiPAC 3011G" Ta USB +.It Li "Buffalo WLI-U2-KG54L" Ta USB +.It Li "CC&C WL-2203B" Ta USB +.It Li "DrayTek Vigor 550" Ta USB +.It Li "Edimax EW-7317UG" Ta USB +.It Li "Edimax EW-7317LDG" Ta USB +.It Li "Fiberline Networks WL-43OU" Ta USB +.It Li "iNexQ UR055g" Ta USB +.It Li "Linksys WUSBF54G" Ta USB +.It Li "Longshine LCS-8131G3" Ta USB +.It Li "MSI US54SE" Ta USB +.It Li "Philips SNU5600" Ta USB +.It Li "Planet WL-U356" Ta USB +.It Li "Planex GW-US54GZ" Ta USB +.It Li "Planex GW-US54GZL" Ta USB +.It Li "Planex GW-US54Mini" Ta USB +.It Li "Safecom SWMULZ-5400" Ta USB +.It Li "Sagem XG 760A" Ta USB +.It Li "Sagem XG 76NA" Ta USB +.It Li "Sandberg Wireless G54 USB" Ta USB +.It Li "Sitecom WL-113" Ta USB +.It Li "SMC SMCWUSB-G" Ta USB +.It Li "Sweex wireless USB 54 Mbps" Ta USB +.It Li "Tekram/Siemens USB adapter" Ta USB +.It Li "Telegent TG54USB" Ta USB +.It Li "Trendnet TEW-424UB" Ta USB +.It Li "Trendnet TEW-429UB" Ta USB +.It Li "TwinMOS G240" Ta USB +.It Li "Unicorn WL-54G" Ta USB +.It Li "US Robotics 5423" Ta USB +.It Li "X-Micro XWL-11GUZX" Ta USB +.It Li "Yakumo QuickWLAN USB" Ta USB +.It Li "Zonet ZEW2501" Ta USB +.It Li "ZyXEL ZyAIR G-220" Ta USB +.El +.Sh EXAMPLES +Join an existing BSS network (i.e., connect to an access point): +.Pp +.Dl "ifconfig zyd0 inet 192.168.0.20 netmask 0xffffff00" +.Pp +Join a specific BSS network with network name +.Dq Li my_net : +.Pp +.Dl "ifconfig zyd0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net" +.Pp +Join a specific BSS network with 40-bit WEP encryption: +.Bd -literal -offset indent +ifconfig zyd0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e + wepmode on wepkey 0x1234567890 weptxkey 1 +.Ed +.Pp +Join a specific BSS network with 104-bit WEP encryption: +.Bd -literal -offset indent +ifconfig zyd0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e + wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.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 intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr wlan 4 , +.Xr wlan_amrr 4 , +.Xr ifconfig 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Florian Stoehr Aq ich@florian-stoehr.de , +.An Damien Bergamini Aq damien@openbsd.org , +and +.An Jonathan Gray Aq 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. +.\" $OpenBSD: zyd.4,v 1.22 2007/05/24 02:49:57 cnst Exp $ +.\" $NetBSD: zyd.4,v 1.1 2007/06/09 11:20:55 kiyohara Exp $ +.\" +.\" Copyright (c) 1997, 1998, 1999 +.\" Bill Paul <wpaul@ctr.columbia.edu>. 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 May 28, 2007 +.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. +Wired Equivalent Privacy (WEP) is the de facto encryption standard +for wireless networks. +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 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 Unicorn WL-54G +.It US Robotics 5423 +.It X-Micro XWL-11GUZX +.It Yakumo QuickWLAN USB +.It Zonet ZEW2501 +.It ZyXEL ZyAIR G-220 +.El +.Sh EXAMPLES +The following +examples 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 wepkey 0x1deadbeef1 channel 11 +.Ed +.Pp +Configure zyd0 for WEP, using hex key +.Dq 0x1deadbeef1 : +.Bd -literal -offset indent +# ifconfig zyd0 wepkey 0x1deadbeef1 +.Ed +.Pp +Join an existing BSS network, +.Dq my_net : +.Bd -literal -offset indent +# ifconfig zyd0 192.168.0.2 netmask 0xffffff00 ssid my_net +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.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 intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr wlan 4 , +.Xr wlan_amrr 4 , +.Xr ifconfig 8 +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Florian Stoehr Aq ich@florian-stoehr.de , +.An Damien Bergamini Aq damien@openbsd.org , +and +.An Jonathan Gray Aq 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. |
