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