share/man/man4/zyd.4

   1 .\" $OpenBSD: zyd.4,v 1.22 2007/05/24 02:49:57 cnst Exp $
   2 .\" $NetBSD: zyd.4,v 1.1 2007/06/09 11:20:55 kiyohara Exp $
   3 .\" $FreeBSD$
   4 .\"
   5 .\" Copyright (c) 1997, 1998, 1999
   6 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\" This product includes software developed by Bill Paul.
  19 .\" 4. Neither the name of the author nor the names of any co-contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"   without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  27 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  33 .\" THE POSSIBILITY OF SUCH DAMAGE.
  34 .\"
  35 .Dd October 2, 2009
  36 .Dt ZYD 4
  37 .Os
  38 .Sh NAME
  39 .Nm zyd
  40 .Nd ZyDAS ZD1211/ZD1211B USB IEEE 802.11b/g wireless network device
  41 .Sh SYNOPSIS
  42 To compile this driver into the kernel,
  43 place the following lines in your
  44 kernel configuration file:
  45 .Bd -ragged -offset indent
  46 .Cd "device ehci"
  47 .Cd "device uhci"
  48 .Cd "device ohci"
  49 .Cd "device usb"
  50 .Cd "device zyd"
  51 .Cd "device wlan"
  52 .Cd "device wlan_amrr"
  53 .Ed
  54 .Pp
  55 Alternatively, to load the driver as a
  56 module at boot time, place the following line in
  57 .Xr loader.conf 5 :
  58 .Bd -literal -offset indent
  59 if_zyd_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for wireless network adapters based around
  65 the ZyDAS ZD1211 and ZD1211B USB chips.
  66 .Pp
  67 .Nm
  68 supports
  69 .Cm station
  70 and
  71 .Cm monitor
  72 mode operation.
  73 Only one virtual interface may be configured at any time.
  74 For more information on configuring this device, see
  75 .Xr ifconfig 8 .
  76 .Sh HARDWARE
  77 The following devices are known to be supported by the
  78 .Nm
  79 driver:
  80 .Pp
  81 .Bl -tag -width Ds -offset indent -compact
  82 .It 3COM 3CRUSB10075
  83 .It Acer WLAN-G-US1
  84 .It Airlink+ AWLL3025
  85 .It Airlink 101 AWLL3026
  86 .It AOpen 802.11g WL54
  87 .It Asus A9T integrated wireless
  88 .It Asus WL-159g
  89 .It Belkin F5D7050 v.4000
  90 .It Billion BiPAC 3011G
  91 .It Buffalo WLI-U2-KG54L
  92 .It CC&C WL-2203B
  93 .It DrayTek Vigor 550
  94 .It Edimax EW-7317UG
  95 .It Edimax EW-7317LDG
  96 .It Fiberline Networks WL-43OU
  97 .It iNexQ UR055g
  98 .It Linksys WUSBF54G
  99 .It Longshine LCS-8131G3
 100 .It MSI US54SE
 101 .It MyTek MWU-201 USB adapter
 102 .It Philips SNU5600
 103 .It Planet WL-U356
 104 .It Planex GW-US54GZ
 105 .It Planex GW-US54GZL
 106 .It Planex GW-US54Mini
 107 .It Safecom SWMULZ-5400
 108 .It Sagem XG 760A
 109 .It Sagem XG 76NA
 110 .It Sandberg Wireless G54 USB
 111 .It Sitecom WL-113
 112 .It SMC SMCWUSB-G
 113 .It Sweex wireless USB 54 Mbps
 114 .It Tekram/Siemens USB adapter
 115 .It Telegent TG54USB
 116 .It Trendnet TEW-424UB rev A
 117 .It Trendnet TEW-429UB
 118 .It TwinMOS G240
 119 .It Unicorn WL-54G
 120 .It US Robotics 5423
 121 .It X-Micro XWL-11GUZX
 122 .It Yakumo QuickWLAN USB
 123 .It Zonet ZEW2501
 124 .It ZyXEL ZyAIR G-220
 125 .El
 126 .Sh EXAMPLES
 127 The following
 128 example configures zyd0 to join any BSS network using WEP key
 129 .Dq 0x1deadbeef1 ,
 130 channel 11:
 131 .Bd -literal -offset indent
 132 ifconfig wlan create wlandev zyd0 channel 11 \e
 133     wepmode on wepkey 0x1deadbeef1 weptxkey 1 \e
 134     inet 192.168.1.1 netmask 255.255.255.0
 135 .Ed
 136 .Pp
 137 Join an existing BSS network,
 138 .Dq my_net :
 139 .Bd -literal -offset indent
 140 ifconfig wlan create wlandev zyd0 192.168.0.2 \e
 141     netmask 0xffffff00 ssid my_net
 142 .Ed
 143 .Sh DIAGNOSTICS
 144 .Bl -diag
 145 .It "zyd%d: could not load firmware (error=%d)"
 146 An error occurred while attempting to upload the firmware to the onboard
 147 microcontroller unit.
 148 .It "zyd%d: could not send command (error=%s)"
 149 An attempt to send a command to the firmware failed.
 150 .It "zyd%d: sorry, radio %s is not supported yet"
 151 Support for the specified radio chip is not yet implemented in the driver.
 152 The device will not attach.
 153 .It "zyd%d: device version mismatch: 0x%x (only >= 43.30 supported)"
 154 Early revisions of the ZD1211 chipset are not supported by this driver.
 155 The device will not attach.
 156 .It "zyd%d: device timeout"
 157 A frame dispatched to the hardware for transmission did not complete in time.
 158 The driver will reset the hardware.
 159 This should not happen.
 160 .El
 161 .Sh SEE ALSO
 162 .Xr intro 4 ,
 163 .Xr netintro 4 ,
 164 .Xr usb 4 ,
 165 .Xr wlan 4 ,
 166 .Xr wlan_amrr 4 ,
 167 .Xr wlan_ccmp 4 ,
 168 .Xr wlan_tkip 4 ,
 169 .Xr wlan_wep 4 ,
 170 .Xr ifconfig 8 ,
 171 .Xr wpa_supplicant 8
 172 .Sh AUTHORS
 173 .An -nosplit
 174 The original
 175 .Nm
 176 driver was written by
 177 .An Florian Stoehr Aq ich@florian-stoehr.de ,
 178 .An Damien Bergamini Aq damien@openbsd.org ,
 179 and
 180 .An Jonathan Gray Aq jsg@openbsd.org .
 181 .Sh CAVEATS
 182 The
 183 .Nm
 184 driver does not support a lot of the functionality available in the hardware.
 185 More work is required to properly support the IBSS and power management
 186 features.