1.\" $OpenBSD: urtwn.4,v 1.20 2013/05/16 10:02:59 sthen Exp $ 2.\" $FreeBSD: src/share/man/man4/urtwn.4,v 1.3 2013/06/26 00:26:08 svnexp Exp $ 3.\" 4.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr> 5.\" 6.\" Permission to use, copy, modify, and distribute this software for any 7.\" purpose with or without fee is hereby granted, provided that the above 8.\" copyright notice and this permission notice appear in all copies. 9.\" 10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17.\" 18.Dd August 19, 2013 19.Dt URTWN 4 20.Os 21.Sh NAME 22.Nm urtwn 23.Nd Realtek RTL8188CU/RTL8192CU USB IEEE 802.11b/g/n wireless network device 24.Sh SYNOPSIS 25To compile this driver into the kernel, 26place the following lines in your 27kernel configuration file: 28.Bd -ragged -offset indent 29.Cd "device ehci" 30.Cd "device uhci" 31.Cd "device ohci" 32.Cd "device usb4bsd" 33.Cd "device urtwn" 34.Cx "device urtwnfw" 35.Cd "device wlan" 36.Ed 37.Pp 38Alternatively, to load the driver as a 39module at boot time, place the following line in 40.Xr loader.conf 5 : 41.Bd -literal -offset indent 42if_urtwn_load="YES" 43urtwn-rtl8192cfwT_load="YES" 44urtwn-rtl8192cfwU_load="YES" 45.Ed 46.Pp 47In both cases, place the following line in 48.Xr loader.conf 5 49to acknowledge the firmware license (see below): 50.Bd -literal -offset indent 51legal.realtek.license_ack=1 52.Ed 53.Sh DESCRIPTION 54The 55.Nm 56driver supports USB 2.0 wireless network devices based on Realtek 57RTL8188CUS, RTL8188CE-VAU, RTL8188RU and RTL8192CU chipsets. 58.Pp 59The RTL8188CUS is a highly integrated 802.11n adapter that combines 60a MAC, a 1T1R capable baseband and an RF in a single chip. 61It operates in the 2GHz spectrum only. 62The RTL8188RU is a high-power variant of the RTL8188CUS. 63The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches 64to the USB interface. 65.Pp 66The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO) 67802.11n adapter that combines a MAC, a 2T2R capable baseband and an 68RF in a single chip. 69It operates in the 2GHz spectrum only. 70.Pp 71The driver needs at least version 1.1p0 of the following firmware files, 72which are loaded when an interface is attached: 73.Pp 74.Bl -tag -width Ds -offset indent -compact 75.It urtwn-rtl8192cfwT 76.It urtwn-rtl8192cfwU 77.El 78.Pp 79For the loaded firmware to be enabled for use the license at 80.Pa /usr/share/doc/legal/realtek/LICENSE 81must be agreed to by adding the following line to 82.Xr loader.conf 5 : 83.Pp 84.Dl "legal.realtek.license_ack=1" 85.Sh FILES 86.Bl -tag -width ".Pa /usr/share/doc/legal/realtek/LICENSE" -compact 87.It Pa /usr/share/doc/legal/realtek/LICENSE 88.Nm 89firmware license 90.El 91.Sh HARDWARE 92The following adapters should work: 93.Pp 94.Bl -tag -width Ds -offset indent -compact 95.It Belkin F7D1102 Surf Wireless Micro 96.It D-Link DWA-131 97.It Edimax EW-7811Un 98.It Netgear WNA1000M 99.It Realtek RTL8192CU 100.It Realtek RTL8188CUS 101.El 102.Sh EXAMPLES 103Join an existing BSS network (i.e., connect to an access point): 104.Bd -literal -offset indent 105ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e 106 netmask 0xffffff00 107.Ed 108.Pp 109Join a specific BSS network with network name 110.Dq Li my_net : 111.Pp 112.Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up" 113.Pp 114Join a specific BSS network with 64-bit WEP encryption: 115.Bd -literal -offset indent 116ifconfig wlan create wlandev urtwn0 ssid my_net \e 117 wepmode on wepkey 0x1234567890 weptxkey 1 up 118.Ed 119.Sh DIAGNOSTICS 120.Bl -diag 121.It "urtwn%d: error %d, could not read firmware %s" 122For some reason, the driver was unable to read the microcode file from the 123filesystem. 124The file might be missing or corrupted. 125.It "urtwn%d: device timeout" 126A frame dispatched to the hardware for transmission did not complete in time. 127The driver will reset the hardware. 128This should not happen. 129.El 130.Sh SEE ALSO 131.Xr ifmedia 4 , 132.Xr intro 4 , 133.Xr netintro 4 , 134.Xr usb 4 , 135.Xr wlan 4 , 136.Xr wlan_ccmp 4 , 137.Xr wlan_tkip 4 , 138.Xr wlan_wep 4 , 139.Xr ifconfig 8 , 140.Xr wpa_supplicant 8 141.Rs 142.%T Realtek 143.%U http://www.realtek.com.tw 144.Re 145.Sh HISTORY 146The 147.Nm 148driver first appeared in 149.Ox 4.9 150and 151.Fx 10.0 . 152.Sh AUTHORS 153The 154.Nm 155driver was written by 156.An Damien Bergamini Aq Mt damien@openbsd.org . 157.Sh CAVEATS 158The 159.Nm 160driver does not support any of the 802.11n capabilities offered by the 161adapters. 162