urtwn (4)

Leading comments

Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DI...

(The comments found at the beginning of the groff file "man4/urtwn.4freebsd".)

NAME

urtwn - Realtek RTL8188CU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device

SYNOPSIS

To compile this driver into the kernel, place the following lines in your kernel configuration file:

device ehci device uhci device ohci device usb device urtwn device wlan

Alternatively, to load the driver as a module at boot time, place the following line in loader.conf5:

if_urtwn_load="YES"

In both cases, place the following line in loader.conf5 to acknowledge the firmware license (see below):

legal.realtek.license_ack=1

DESCRIPTION

The ifconfig driver supports USB 2.0 wireless network devices based on Realtek RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.

The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapter that combine a MAC, a 1T1R capable baseband and an RF in a single chip. They operate in the 2GHz spectrum only. The RTL8188RU is a high-power variant of the RTL8188CUS. The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches to the USB interface.

The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO) 802.11n adapter that combines a MAC, a 2T2R capable baseband and an RF in a single chip. It operates in the 2GHz spectrum only.

This driver requires the firmware built with the urtwnfw module to work. For the loaded firmware to be enabled for use the license at /usr/share/doc/legal/realtek must be agreed by adding the following line to loader.conf5:

"legal.realtek.license_ack=1"

FILES

/usr/share/doc/legal/realtek

ifconfig firmware license

HARDWARE

The ifconfig driver supports Realtek RTL8188CU/RTL8188EU/RTL8192CU based USB IEEE 802.11b/g/n wireless network adapters, including:

ASUS USB-N10 NANO

Belkin F7D1102 Surf Wireless Micro

D-Link DWA-125 rev D1

D-Link DWA-131

Edimax EW-7811Un

Netgear WNA1000M

Realtek RTL8192CU

Realtek RTL8188CUS

TP-LINK TL-WN723N v3

TP-LINK TL-WN725N v2

EXAMPLES

Join an existing BSS network (i.e., connect to an access point):

ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \
    netmask 0xffffff00

Join a specific BSS network with network name ``my_net ''

"ifconfig wlan create wlandev urtwn0 ssid my_net up"

Join a specific BSS network with 64-bit WEP encryption:

ifconfig wlan create wlandev urtwn0 ssid my_net \
        wepmode on wepkey 0x1234567890 weptxkey 1 up

DIAGNOSTICS

"urtwn%d: error %d, could not read firmware %s"

For some reason, the driver was unable to read the microcode file from the filesystem. The file might be missing or corrupted.

"urtwn%d: device timeout"

A frame dispatched to the hardware for transmission did not complete in time. The driver will reset the hardware. This should not happen.

SEE ALSO

intro(4), netintro(4), urtwnfw(4), usb(4), wlan(4), wlan_ccmp4, wlan_tkip4, wlan_wep4, ifconfig(8), wpa_supplicant8

Realtek

HISTORY

The ifconfig driver first appeared in Ox 4.9 and Fx 10.0 .

AUTHORS

The ifconfig driver was written by An Damien Bergamini Aq damien@openbsd.org .

CAVEATS

The ifconfig driver does not support any of the 802.11n capabilities offered by the adapters.