xref: /freebsd/share/man/man4/upgt.4 (revision 4262dbc57982383eb61a8b7806de6dd4b7802da8)
1.\" $OpenBSD: upgt.4,v 1.6 2008/04/17 14:01:22 jmc 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 February 18, 2025
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
57driver
58.Sh SYNOPSIS
59To compile this driver into the kernel,
60place the following lines in your
61kernel configuration file:
62.Bd -ragged -offset indent
63.Cd "device ehci"
64.Cd "device uhci"
65.Cd "device ohci"
66.Cd "device usb"
67.Cd "device upgt"
68.Cd "device wlan"
69.Ed
70.Pp
71Alternatively, to load the driver as a
72module at boot time, place the following line in
73.Xr loader.conf 5 :
74.Bd -literal -offset indent
75if_upgt_load="YES"
76.Ed
77.Sh DEPRECATION NOTICE
78The
79.Nm
80driver is slated to be removed in
81.Fx 15.0 .
82.Sh DESCRIPTION
83The
84.Nm
85driver supports the USB 2.0 Conexant/Intersil PrismGT series wireless
86adapters based on the GW3887 chipset.
87.Pp
88These are the modes the
89.Nm
90driver can operate in:
91.Bl -tag -width "IBSS-masterXX"
92.It BSS mode
93Also known as
94.Em infrastructure
95mode, this is used when associating with an access point, through
96which all traffic passes.
97This mode is the default.
98.\" .It IBSS mode
99.\" Also known as
100.\" .Em IEEE ad-hoc
101.\" mode or
102.\" .Em peer-to-peer
103.\" mode.
104.\" This is the standardized method of operating without an access point.
105.\" Stations associate with a service set.
106.\" However, actual connections between stations are peer-to-peer.
107.\" .It Host AP
108.\" In this mode the driver acts as an access point (base station)
109.\" for other cards.
110.It monitor mode
111In this mode the driver is able to receive packets without
112associating with an access point.
113This disables the internal receive filter and enables the card to
114capture packets from networks which it wouldn't normally have access to,
115or to scan for access points.
116.El
117.Pp
118.Nm
119supports software WEP.
120Wired Equivalent Privacy (WEP) is the de facto encryption standard
121for wireless networks.
122It can be typically configured in one of three modes:
123no encryption; 40-bit encryption; or 104-bit encryption.
124Unfortunately, due to serious weaknesses in WEP protocol
125it is strongly recommended that it not be used as the
126sole mechanism to secure wireless communication.
127WEP is not enabled by default.
128.\".Pp
129.\"The transmit speed is user-selectable or can be adapted automatically by the
130.\"driver depending on the received signal strength and on the number of hardware
131.\"transmission retries.
132.Pp
133The
134.Nm
135driver can be configured at runtime with
136.Xr ifconfig 8 .
137.Sh FILES
138.\".Pp
139.\"These firmware files are not free because Conexant/Intersil refuses
140.\"to grant distribution rights.
141.\"As a result, even though
142.\".Ox
143.\"includes the driver, the firmware files cannot be included and
144.\"users have to download these files on their own.
145This driver requires the
146.Nm upgtfw
147firmware to be installed before it will work.
148The firmware files are not publicly available.
149A package of the firmware which can be installed via
150.Xr pkg_add 1
151is available:
152.Bd -literal -offset indent
153http://weongyo.org/project/upgt/upgt-firmware-2.13.1.0.tar.gz
154.Ed
155.Sh HARDWARE
156The
157.Nm
158driver supports USB 2.0 Conexant/Intersil PrismGT series wireless
159adapters based on the GW3887 chipset, among them:
160.Pp
161.Bl -bullet -compact
162.It
163Belkin F5D7050 (version 1000)
164.It
165Cohiba Proto Board
166.It
167D-Link DWL-G120 Cohiba
168.It
169FSC Connect2Air E-5400 USB D1700
170.It
171Gigaset USB Adapter 54
172.It
173Inventel UR045G
174.It
175Netgear WG111v1 (rev2)
176.It
177SMC EZ ConnectG SMC2862W-G
178.It
179Sagem XG703A
180.It
181Spinnaker DUT
182.It
183Spinnaker Proto Board
184.El
185.Sh EXAMPLES
186Join an existing BSS network (i.e., connect to an access point):
187.Bd -literal -offset indent
188ifconfig wlan create wlandev upgt0 inet 192.168.0.20 \e
189    netmask 0xffffff00
190.Ed
191.Pp
192Join a specific BSS network with network name
193.Dq Li my_net :
194.Pp
195.Dl "ifconfig wlan create wlandev upgt0 ssid my_net up"
196.Pp
197Join a specific BSS network with 64-bit WEP encryption:
198.Bd -literal -offset indent
199ifconfig wlan create wlandev upgt0 ssid my_net \e
200        wepmode on wepkey 0x1234567890 weptxkey 1 up
201.Ed
202.Sh SEE ALSO
203.Xr arp 4 ,
204.Xr netintro 4 ,
205.Xr usb 4 ,
206.Xr wlan 4 ,
207.Xr ifconfig 8
208.Sh HISTORY
209The
210.Nm
211driver first appeared in
212.Ox 4.3 .
213.Sh AUTHORS
214.An -nosplit
215The
216.Nm
217driver was written by
218.An Marcus Glocker Aq Mt mglocker@openbsd.org .
219.Pp
220The hardware specification was reverse engineered by the people at
221.Pa http://www.prism54.org .
222.Sh CAVEATS
223The
224.Nm
225driver just supports the USB 2.0 devices (GW3887 chipset) but not the
226USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets.
227Some further efforts would be necessary to add USB 1.0 support to the
228driver.
229