xref: /openbsd-src/share/man/man4/upgt.4 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\" $OpenBSD: upgt.4,v 1.16 2011/06/09 14:21:12 deraadt Exp $
2.\"
3.\" Copyright (c) 2007 Marcus Glocker <mglocker@openbsd.org>
4.\" Copyright (c) 2005-2007
5.\"     Damien Bergamini <damien.bergamini@free.fr>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.\"
20.\"
21.\" Copyright (c) 2006 Theo de Raadt.
22.\" Copyright (c) 2006 The DragonFly Project.  All rights reserved.
23.\"
24.\" Redistribution and use in source and binary forms, with or without
25.\" modification, are permitted provided that the following conditions
26.\" are met:
27.\"
28.\" 1. Redistributions of source code must retain the above copyright
29.\"    notice, this list of conditions and the following disclaimer.
30.\" 2. Redistributions in binary form must reproduce the above copyright
31.\"    notice, this list of conditions and the following disclaimer in
32.\"    the documentation and/or other materials provided with the
33.\"    distribution.
34.\" 3. Neither the name of The DragonFly Project nor the names of its
35.\"    contributors may be used to endorse or promote products derived
36.\"    from this software without specific, prior written permission.
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
39.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
40.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
41.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
42.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
43.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
44.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
46.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49.\" SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: June 9 2011 $
52.Dt UPGT 4
53.Os
54.Sh NAME
55.Nm upgt
56.Nd Conexant/Intersil PrismGT SoftMAC USB IEEE 802.11b/g wireless network
57device
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 hostname.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 /etc/firmware/upgt-gw3887
123.El
124.\".Pp
125.\"These firmware files are not free because Conexant/Intersil refuses
126.\"to grant distribution rights.
127.\"As a result, even though
128.\".Ox
129.\"includes the driver, the firmware files cannot be included and
130.\"users have to download these files on their own.
131.Pp
132A prepackaged version of the firmware, designed to be used with
133.Xr pkg_add 1 ,
134can be found at:
135.Bd -literal -offset 3n
136http://firmware.openbsd.org/firmware/upgt-firmware-1.1.tgz
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.El
160.Sh EXAMPLES
161The following
162.Xr hostname.if 5
163example configures upgt0 to join whatever network is available on boot,
164using WEP key
165.Dq 0x1deadbeef1 ,
166channel 11, obtaining an IP address using DHCP:
167.Bd -literal -offset indent
168dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
169.\".Ed
170.\".Pp
171.\"The following
172.\".Xr hostname.if 5
173.\"example creates a host-based access point on boot:
174.\".Bd -literal -offset indent
175.\"inet 192.168.1.1 255.255.255.0 NONE media autoselect \e
176.\"	mediaopt hostap nwid my_net chan 11
177.Ed
178.Pp
179Configure upgt0 to join network
180.Dq my_net
181using WPA with passphrase
182.Dq my_passphrase :
183.Bd -literal -offset indent
184# ifconfig upgt0 nwid my_net wpakey my_passphrase
185.Ed
186.Pp
187Join an existing BSS network,
188.Dq my_net :
189.Bd -literal -offset indent
190# ifconfig upgt0 192.168.1.1 netmask 0xffffff00 nwid my_net
191.Ed
192.Sh SEE ALSO
193.Xr arp 4 ,
194.Xr ifmedia 4 ,
195.Xr intro 4 ,
196.Xr netintro 4 ,
197.Xr usb 4 ,
198.Xr hostname.if 5 ,
199.\".Xr hostapd 8 ,
200.Xr ifconfig 8
201.Sh HISTORY
202The
203.Nm
204driver first appeared in
205.Ox 4.3 .
206.Sh AUTHORS
207.An -nosplit
208The
209.Nm
210driver was written by
211.An Marcus Glocker Aq mglocker@openbsd.org .
212.Pp
213The hardware specification was reverse engineered by the people at
214.Pa http://www.prism54.org .
215.Sh CAVEATS
216The
217.Nm
218driver just supports the USB 2.0 devices (GW3887 chipset) but not the
219USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets.
220Some further efforts would be necessary to add USB 1.0 support to the
221driver.
222