xref: /freebsd/share/man/man4/zyd.4 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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 September 6, 2007
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
42To compile this driver into the kernel,
43place the following lines in your
44kernel 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
55Alternatively, to load the driver as a
56module at boot time, place the following line in
57.Xr loader.conf 5 :
58.Bd -literal -offset indent
59if_zyd_load="YES"
60.Ed
61.Sh DESCRIPTION
62The
63.Nm
64driver provides support for wireless network adapters based around
65the ZyDAS ZD1211 and ZD1211B USB chips.
66.Pp
67These are the modes the
68.Nm
69driver can operate in:
70.Bl -tag -width "IBSS-masterXX"
71.It BSS mode
72Also known as
73.Em infrastructure
74mode, this is used when associating with an access point, through
75which all traffic passes.
76This mode is the default.
77.It monitor mode
78In this mode the driver is able to receive packets without
79associating with an access point.
80This disables the internal receive filter and enables the card to
81capture packets from networks which it wouldn't normally have access to,
82or to scan for access points.
83.El
84.Pp
85.Nm
86supports software WEP.
87Wired Equivalent Privacy (WEP) is the de facto encryption standard
88for wireless networks.
89It can be typically configured in one of three modes:
90no encryption; 40-bit encryption; or 104-bit encryption.
91Unfortunately, due to serious weaknesses in WEP protocol
92it is strongly recommended that it not be used as the
93sole mechanism to secure wireless communication.
94WEP is not enabled by default.
95.Sh HARDWARE
96The following devices are known to be supported by the
97.Nm
98driver:
99.Pp
100.Bl -tag -width Ds -offset indent -compact
101.It 3COM 3CRUSB10075
102.It Acer WLAN-G-US1
103.It Airlink+ AWLL3025
104.It Airlink 101 AWLL3026
105.It AOpen 802.11g WL54
106.It Asus A9T integrated wirless
107.It Asus WL-159g
108.It Belkin F5D7050 v.4000
109.It Billion BiPAC 3011G
110.It Buffalo WLI-U2-KG54L
111.It CC&C WL-2203B
112.It DrayTek Vigor 550
113.It Edimax EW-7317UG
114.It Edimax EW-7317LDG
115.It Fiberline Networks WL-43OU
116.It iNexQ UR055g
117.It Linksys WUSBF54G
118.It Longshine LCS-8131G3
119.It MSI US54SE
120.It Philips SNU5600
121.It Planet WL-U356
122.It Planex GW-US54GZ
123.It Planex GW-US54GZL
124.It Planex GW-US54Mini
125.It Safecom SWMULZ-5400
126.It Sagem XG 760A
127.It Sagem XG 76NA
128.It Sandberg Wireless G54 USB
129.It Sitecom WL-113
130.It SMC SMCWUSB-G
131.It Sweex wireless USB 54 Mbps
132.It Tekram/Siemens USB adapter
133.It Telegent TG54USB
134.It Trendnet TEW-424UB
135.It Trendnet TEW-429UB
136.It TwinMOS G240
137.It Unicorn WL-54G
138.It US Robotics 5423
139.It X-Micro XWL-11GUZX
140.It Yakumo QuickWLAN USB
141.It Zonet ZEW2501
142.It ZyXEL ZyAIR G-220
143.El
144.Sh EXAMPLES
145The following
146examples configures zyd0 to join whatever network is available on boot,
147using WEP key
148.Dq 0x1deadbeef1 ,
149channel 11:
150.Bd -literal -offset indent
151inet 192.168.1.1 netmask 255.255.255.0 wepkey 0x1deadbeef1 channel 11
152.Ed
153.Pp
154Configure zyd0 for WEP, using hex key
155.Dq 0x1deadbeef1 :
156.Bd -literal -offset indent
157# ifconfig zyd0 wepkey 0x1deadbeef1
158.Ed
159.Pp
160Join an existing BSS network,
161.Dq my_net :
162.Bd -literal -offset indent
163# ifconfig zyd0 192.168.0.2 netmask 0xffffff00 ssid my_net
164.Ed
165.Sh DIAGNOSTICS
166.Bl -diag
167.It "zyd%d: could not load firmware (error=%d)"
168An error occurred while attempting to upload the firmware to the onboard
169microcontroller unit.
170.It "zyd%d: could not send command (error=%s)"
171An attempt to send a command to the firmware failed.
172.It "zyd%d: sorry, radio %s is not supported yet"
173Support for the specified radio chip is not yet implemented in the driver.
174The device will not attach.
175.It "zyd%d: device version mismatch: 0x%x (only >= 43.30 supported)"
176Early revisions of the ZD1211 chipset are not supported by this driver.
177The device will not attach.
178.It "zyd%d: device timeout"
179A frame dispatched to the hardware for transmission did not complete in time.
180The driver will reset the hardware.
181This should not happen.
182.El
183.Sh SEE ALSO
184.Xr arp 4 ,
185.Xr intro 4 ,
186.Xr netintro 4 ,
187.Xr usb 4 ,
188.Xr wlan 4 ,
189.Xr wlan_amrr 4 ,
190.Xr ifconfig 8
191.Sh AUTHORS
192.An -nosplit
193The
194.Nm
195driver was written by
196.An Florian Stoehr Aq ich@florian-stoehr.de ,
197.An Damien Bergamini Aq damien@openbsd.org ,
198and
199.An Jonathan Gray Aq jsg@openbsd.org .
200.Sh CAVEATS
201The
202.Nm
203driver does not support a lot of the functionality available in the hardware.
204More work is required to properly support the IBSS and power management
205features.
206