xref: /netbsd/share/man/man4/upgt.4 (revision 6550d01e)
1.\" $NetBSD: upgt.4,v 1.4 2010/07/04 21:10:39 wiz Exp $
2.\" $OpenBSD: upgt.4,v 1.14 2010/04/29 09:20:17 jmc Exp $
3.\"
4.\" Copyright (c) 2007 Marcus Glocker <mglocker@openbsd.org>
5.\" Copyright (c) 2005-2007
6.\"     Damien Bergamini <damien.bergamini@free.fr>
7.\"
8.\" Permission to use, copy, modify, and distribute this software for any
9.\" purpose with or without fee is hereby granted, provided that the above
10.\" copyright notice and this permission notice appear in all copies.
11.\"
12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\"
20.\"
21.\"
22.\" Copyright (c) 2006 Theo de Raadt.
23.\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
24.\"
25.\" Redistribution and use in source and binary forms, with or without
26.\" modification, are permitted provided that the following conditions
27.\" are met:
28.\"
29.\" 1. Redistributions of source code must retain the above copyright
30.\"    notice, this list of conditions and the following disclaimer.
31.\" 2. Redistributions in binary form must reproduce the above copyright
32.\"    notice, this list of conditions and the following disclaimer in
33.\"    the documentation and/or other materials provided with the
34.\"    distribution.
35.\" 3. Neither the name of The DragonFly Project nor the names of its
36.\"    contributors may be used to endorse or promote products derived
37.\"    from this software without specific, prior written permission.
38.\"
39.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
42.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
43.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
44.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
45.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
47.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50.\" SUCH DAMAGE.
51.\"
52.Dd July 4, 2010
53.Dt UPGT 4
54.Os
55.Sh NAME
56.Nm upgt
57.Nd Conexant/Intersil PrismGT SoftMAC USB IEEE 802.11b/g wireless network device
58.Sh SYNOPSIS
59.Cd "upgt* at uhub? port ?"
60.Sh DESCRIPTION
61The
62.Nm
63driver supports the USB 2.0 Conexant/Intersil PrismGT series wireless
64adapters based on the GW3887 chipset.
65.Pp
66These are the modes the
67.Nm
68driver can operate in:
69.Bl -tag -width "IBSS-masterXX"
70.It BSS mode
71Also known as
72.Em infrastructure
73mode, this is used when associating with an access point, through
74which all traffic passes.
75This mode is the default.
76.\" .It IBSS mode
77.\" Also known as
78.\" .Em IEEE ad-hoc
79.\" mode or
80.\" .Em peer-to-peer
81.\" mode.
82.\" This is the standardized method of operating without an access point.
83.\" Stations associate with a service set.
84.\" However, actual connections between stations are peer-to-peer.
85.\" .It Host AP
86.\" In this mode the driver acts as an access point (base station)
87.\" for other cards.
88.It monitor mode
89In this mode the driver is able to receive packets without
90associating with an access point.
91This disables the internal receive filter and enables the card to
92capture packets from networks which it wouldn't normally have access to,
93or to scan for access points.
94.El
95.Pp
96The
97.Nm
98driver can be configured to use
99Wired Equivalent Privacy (WEP) or
100Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
101WPA is the de facto encryption standard for wireless networks.
102It is strongly recommended that WEP
103not be used as the sole mechanism
104to secure wireless communication,
105due to serious weaknesses in it.
106The
107.Nm
108driver relies on the software 802.11 stack for both encryption and decryption
109of data frames.
110.Pp
111The
112.Nm
113driver can be configured at runtime with
114.Xr ifconfig 8
115or on boot with
116.Xr ifconfig.if 5 .
117.Sh FILES
118The driver needs a firmware file which is loaded when an interface is
119brought up:
120.Pp
121.Bl -tag -width Ds -offset indent -compact
122.It Pa /libdata/firmware/upgt/upgt-gw3887
123.El
124.Pp
125Currently these firmware files can not be included in
126.Nx
127base system.
128Please download these files and put them into
129the above firmware directory.
130.Pp
131A tar archive file that includes
132.Pa upgt-gw3887
133firmware can be found at:
134.Pp
135.Bd -literal -offset 3n
136http://www.nazgul.ch/upgt/upgt-firmware-1.1.tar.gz
137.Ed
138.Sh HARDWARE
139The following adapters should work:
140.Pp
141.Bl -tag -width Ds -offset indent -compact
142.It Belkin F5D7050 (version 1000)
143.It Cohiba Proto Board
144.It D-Link DWL-G120 Cohiba
145.It D-Link DWL-G122 rev A2
146.It FSC Connect2Air E-5400 USB D1700
147.It Gigaset USB Adapter 54
148.It Inventel UR045G
149.It IOGear GWU513
150.It Linksys WUSB54AG
151.It Linksys WUSB54G ver 2
152.It Medion MD40900
153.It Philips CPWUA054
154.It SMC EZ ConnectG SMC2862W-G
155.It Sagem XG703A
156.It Spinnaker DUT
157.It Spinnaker Proto Board
158.It Thomson SpeedTouch 121g
159.It Willcom / Sharp WS003SH/WS004SH smart phone internal wireless LAN
160.El
161.Sh EXAMPLES
162The following
163.Xr ifconfig.if 5
164example configures upgt0 to join whatever network is available on boot,
165using WEP key
166.Dq 0x1deadbeef1 ,
167channel 11, obtaining an IP address using
168.Xr dhcpcd 8 :
169.Bd -literal -offset indent
170ssid 'my network' nwkey 0x1deadbeef1 chan 11
171dhcp
172.Ed
173.\".Pp
174.\"The following
175.\".Xr ifconfig.if 5
176.\"example creates a host-based access point on boot:
177.\".Bd -literal -offset indent
178.\"inet 192.168.1.1 255.255.255.0 NONE media autoselect \e
179.\"	mediaopt hostap nwid my_net chan 11
180.\".Ed
181.\".Pp
182.\"Configure upgt0 to join network
183.\".Dq my_net
184.\"using WPA-PSK with passphrase
185.\".Dq my_passphrase :
186.\".Bd -literal -offset indent
187.\"# ifconfig upgt0 nwid my_net wpa wpapsk \e
188.\"	`wpa-psk my_net my_passphrase`
189.\".Ed
190.\".Pp
191.\"Return upgt0 to its default settings:
192.\".Bd -literal -offset indent
193.\"# ifconfig upgt0 -bssid -chan media autoselect \e
194.\"	nwid "" -nwkey -wpa -wpapsk
195.\".Ed
196.Pp
197Join an existing BSS network,
198.Dq my_net :
199.Bd -literal -offset indent
200# ifconfig upgt0 192.168.1.1 netmask 0xffffff00 nwid my_net
201.Ed
202.Sh SEE ALSO
203.Xr arp 4 ,
204.Xr ifmedia 4 ,
205.Xr intro 4 ,
206.Xr netintro 4 ,
207.Xr usb 4 ,
208.Xr ifconfig.if 5 ,
209.\".Xr hostapd 8 ,
210.Xr ifconfig 8
211.\".Xr wpa-psk 8
212.Sh HISTORY
213The
214.Nm
215driver first appeared in
216.Ox 4.3 .
217It was ported to
218.Nx
219by FUKAUMI Naoki and first appeared in
220.Nx 6.0 .
221.Sh AUTHORS
222.An -nosplit
223The
224.Nm
225driver was written by
226.An Marcus Glocker Aq mglocker@openbsd.org .
227.Pp
228The hardware specification was reverse engineered by the people at
229.Li http://www.prism54.org/ .
230.Sh BUGS
231The
232.Nm
233driver just supports the USB 2.0 devices (GW3887 chipset) but not the
234USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets.
235Some further efforts would be necessary to add USB 1.0 support to the
236driver.
237