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