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