xref: /openbsd/share/man/man4/upgt.4 (revision 73471bf0)
1.\" $OpenBSD: upgt.4,v 1.29 2021/10/24 12:32:42 kn 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: October 24 2021 $
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 device
57.Sh SYNOPSIS
58.Cd "upgt* at uhub? port ?"
59.Sh DESCRIPTION
60The
61.Nm
62driver supports the USB 2.0 Conexant/Intersil PrismGT series wireless
63adapters based on the GW3887 chipset.
64.Pp
65These are the modes the
66.Nm
67driver can operate in:
68.Bl -tag -width "IBSS-masterXX"
69.It BSS mode
70Also known as
71.Em infrastructure
72mode, this is used when associating with an access point, through
73which all traffic passes.
74This mode is the default.
75.It monitor mode
76In this mode the driver is able to receive packets without
77associating with an access point.
78This disables the internal receive filter and enables the card to
79capture packets from networks which it wouldn't normally have access to,
80or to scan for access points.
81.El
82.Pp
83The
84.Nm
85driver can be configured to use
86Wired Equivalent Privacy (WEP) or
87Wi-Fi Protected Access (WPA1 and WPA2).
88WPA2 is the current encryption standard for wireless networks.
89It is strongly recommended that neither WEP nor WPA1
90are used as the sole mechanism to secure wireless communication,
91due to serious weaknesses.
92WPA1 is disabled by default and may be enabled using the option
93.Qq Cm wpaprotos Ar wpa1,wpa2 .
94For standard WPA networks which use pre-shared keys (PSK),
95keys are configured using the
96.Qq Cm wpakey
97option.
98WPA-Enterprise networks require use of the wpa_supplicant package.
99The
100.Nm
101driver relies on the software 802.11 stack for both encryption and decryption
102of data frames.
103.Pp
104The
105.Nm
106driver can be configured at runtime with
107.Xr ifconfig 8
108or on boot with
109.Xr hostname.if 5 .
110.Sh FILES
111The driver needs a firmware file which is loaded when an interface is
112brought up:
113.Pp
114.Bl -tag -width Ds -offset indent -compact
115.It Pa /etc/firmware/upgt-gw3887
116.El
117.\".Pp
118.\"These firmware files are not free because Conexant/Intersil refuses
119.\"to grant distribution rights.
120.\"As a result, even though
121.\".Ox
122.\"includes the driver, the firmware files cannot be included and
123.\"users have to download these files on their own.
124.Pp
125A prepackaged version of the firmware can be installed using
126.Xr fw_update 1 .
127.Sh HARDWARE
128The following adapters should work:
129.Pp
130.Bl -tag -width Ds -offset indent -compact
131.It Belkin F5D7050 (version 1000)
132.It Cohiba Proto Board
133.It D-Link DWL-G120 Cohiba
134.It D-Link DWL-G122 rev A2
135.It FSC Connect2Air E-5400 USB D1700
136.It Gigaset USB Adapter 54
137.It Inventel UR045G
138.It IOGear GWU513
139.It Linksys WUSB54AG
140.It Linksys WUSB54G ver 2
141.It Medion MD40900
142.It Philips CPWUA054
143.It SMC EZ ConnectG SMC2862W-G
144.It Sagem XG703A
145.It Spinnaker DUT
146.It Spinnaker Proto Board
147.It Thomson SpeedTouch 121g
148.El
149.Sh EXAMPLES
150The following example scans for available networks:
151.Pp
152.Dl # ifconfig upgt0 scan
153.Pp
154The following
155.Xr hostname.if 5
156example configures upgt0 to join network
157.Dq mynwid ,
158using WPA key
159.Dq mywpakey ,
160obtaining an IP address using DHCP:
161.Bd -literal -offset indent
162join mynwid wpakey mywpakey
163inet autoconf
164.Ed
165.Sh SEE ALSO
166.Xr arp 4 ,
167.Xr ifmedia 4 ,
168.Xr intro 4 ,
169.Xr netintro 4 ,
170.Xr usb 4 ,
171.Xr hostname.if 5 ,
172.\".Xr hostapd 8 ,
173.Xr ifconfig 8
174.Sh HISTORY
175The
176.Nm
177driver first appeared in
178.Ox 4.3 .
179.Sh AUTHORS
180.An -nosplit
181The
182.Nm
183driver was written by
184.An Marcus Glocker Aq Mt mglocker@openbsd.org .
185.Pp
186The hardware specification was reverse engineered by the people at
187.Lk http://www.prism54.org .
188.Sh CAVEATS
189The
190.Nm
191driver just supports the USB 2.0 devices (GW3887 chipset) but not the
192USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets.
193Some further efforts would be necessary to add USB 1.0 support to the
194driver.
195.Pp
196This driver does not support powersave mode.
197