1.\" $OpenBSD: upgt.4,v 1.6 2008/04/17 14:01:22 jmc Exp $ 2.\" $FreeBSD$ 3.\" 4.\" Copyright (c) 2007 Marcus Glocker <mglocker@openbsd.org> 5.\" Copyright (c) 2005-2007 6.\" Damien Bergamini <damien.bergamini@free.fr> 7.\" 8.\" Permission to use, copy, modify, and distribute this software for any 9.\" purpose with or without fee is hereby granted, provided that the above 10.\" copyright notice and this permission notice appear in all copies. 11.\" 12.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 13.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 14.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 15.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 16.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 19.\" 20.\" 21.\" 22.\" Copyright (c) 2006 Theo de Raadt. 23.\" Copyright (c) 2006 The DragonFly Project. All rights reserved. 24.\" 25.\" Redistribution and use in source and binary forms, with or without 26.\" modification, are permitted provided that the following conditions 27.\" are met: 28.\" 29.\" 1. Redistributions of source code must retain the above copyright 30.\" notice, this list of conditions and the following disclaimer. 31.\" 2. Redistributions in binary form must reproduce the above copyright 32.\" notice, this list of conditions and the following disclaimer in 33.\" the documentation and/or other materials provided with the 34.\" distribution. 35.\" 3. Neither the name of The DragonFly Project nor the names of its 36.\" contributors may be used to endorse or promote products derived 37.\" from this software without specific, prior written permission. 38.\" 39.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 40.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 41.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 42.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 43.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 44.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 45.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 47.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 48.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 49.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50.\" SUCH DAMAGE. 51.\" 52.Dd April 17, 2008 53.Dt UPGT 4 54.Os 55.Sh NAME 56.Nm upgt 57.Nd Conexant/Intersil PrismGT SoftMAC USB IEEE 802.11b/g wireless network 58device 59.Sh SYNOPSIS 60To compile this driver into the kernel, 61place the following lines in your 62kernel configuration file: 63.Bd -ragged -offset indent 64.Cd "device ehci" 65.Cd "device uhci" 66.Cd "device ohci" 67.Cd "device usb" 68.Cd "device upgt" 69.Cd "device wlan" 70.Ed 71.Pp 72Alternatively, to load the driver as a 73module at boot time, place the following line in 74.Xr loader.conf 5 : 75.Bd -literal -offset indent 76if_upgt_load="YES" 77.Ed 78.Sh DESCRIPTION 79The 80.Nm 81driver supports the USB 2.0 Conexant/Intersil PrismGT series wireless 82adapters based on the GW3887 chipset. 83.Pp 84These are the modes the 85.Nm 86driver can operate in: 87.Bl -tag -width "IBSS-masterXX" 88.It BSS mode 89Also known as 90.Em infrastructure 91mode, this is used when associating with an access point, through 92which all traffic passes. 93This mode is the default. 94.\" .It IBSS mode 95.\" Also known as 96.\" .Em IEEE ad-hoc 97.\" mode or 98.\" .Em peer-to-peer 99.\" mode. 100.\" This is the standardized method of operating without an access point. 101.\" Stations associate with a service set. 102.\" However, actual connections between stations are peer-to-peer. 103.\" .It Host AP 104.\" In this mode the driver acts as an access point (base station) 105.\" for other cards. 106.It monitor mode 107In this mode the driver is able to receive packets without 108associating with an access point. 109This disables the internal receive filter and enables the card to 110capture packets from networks which it wouldn't normally have access to, 111or to scan for access points. 112.El 113.Pp 114.Nm 115supports software WEP. 116Wired Equivalent Privacy (WEP) is the de facto encryption standard 117for wireless networks. 118It can be typically configured in one of three modes: 119no encryption; 40-bit encryption; or 104-bit encryption. 120Unfortunately, due to serious weaknesses in WEP protocol 121it is strongly recommended that it not be used as the 122sole mechanism to secure wireless communication. 123WEP is not enabled by default. 124.\".Pp 125.\"The transmit speed is user-selectable or can be adapted automatically by the 126.\"driver depending on the received signal strength and on the number of hardware 127.\"transmission retries. 128.Pp 129The 130.Nm 131driver can be configured at runtime with 132.Xr ifconfig 8 . 133.Sh FILES 134.\".Pp 135.\"These firmware files are not free because Conexant/Intersil refuses 136.\"to grant distribution rights. 137.\"As a result, even though 138.\".Ox 139.\"includes the driver, the firmware files cannot be included and 140.\"users have to download these files on their own. 141This driver requires the 142.Nm upgtfw 143firmware to be installed before it will work. 144The firmware files are not publicly available. 145A package of the firmware which can be installed via 146.Xr pkg_add 1 147is available: 148.Bd -literal -offset indent 149http://weongyo.org/project/upgt/upgt-firmware-2.13.1.0.tar.gz 150.Ed 151.Sh HARDWARE 152The 153.Nm 154driver supports USB 2.0 Conexant/Intersil PrismGT series wireless 155adapters based on the GW3887 chipset, among them: 156.Pp 157.Bl -bullet -compact 158.It 159Belkin F5D7050 (version 1000) 160.It 161Cohiba Proto Board 162.It 163D-Link DWL-G120 Cohiba 164.It 165FSC Connect2Air E-5400 USB D1700 166.It 167Gigaset USB Adapter 54 168.It 169Inventel UR045G 170.It 171SMC EZ ConnectG SMC2862W-G 172.It 173Sagem XG703A 174.It 175Spinnaker DUT 176.It 177Spinnaker Proto Board 178.El 179.Sh EXAMPLES 180Join an existing BSS network (i.e., connect to an access point): 181.Bd -literal -offset indent 182ifconfig wlan create wlandev upgt0 inet 192.168.0.20 \e 183 netmask 0xffffff00 184.Ed 185.Pp 186Join a specific BSS network with network name 187.Dq Li my_net : 188.Pp 189.Dl "ifconfig wlan create wlandev upgt0 ssid my_net up" 190.Pp 191Join a specific BSS network with 64-bit WEP encryption: 192.Bd -literal -offset indent 193ifconfig wlan create wlandev upgt0 ssid my_net \e 194 wepmode on wepkey 0x1234567890 weptxkey 1 up 195.Ed 196.Sh SEE ALSO 197.Xr arp 4 , 198.Xr netintro 4 , 199.Xr usb 4 , 200.Xr wlan 4 , 201.Xr ifconfig 8 202.Sh HISTORY 203The 204.Nm 205driver first appeared in 206.Ox 4.3 . 207.Sh AUTHORS 208.An -nosplit 209The 210.Nm 211driver was written by 212.An Marcus Glocker Aq mglocker@openbsd.org . 213.Pp 214The hardware specification was reverse engineered by the people at 215.Pa http://www.prism54.org . 216.Sh CAVEATS 217The 218.Nm 219driver just supports the USB 2.0 devices (GW3887 chipset) but not the 220USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets. 221Some further efforts would be necessary to add USB 1.0 support to the 222driver. 223