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