1.\" $OpenBSD: rtwn.4,v 1.2 2015/07/09 11:28:53 stsp Exp $ 2.\" 3.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr> 4.\" Copyright (c) 2015 Stefan Sperling <stsp@openbsd.org> 5.\" Copyright (c) 2016 Andriy Voskoboinyk <avos@freebsd.org> 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.\" $FreeBSD$ 20.\" 21.Dd October 17, 2016 22.Dt RTWN 4 23.Os 24.Sh NAME 25.Nm rtwn 26.Nd Realtek IEEE 802.11 wireless network driver 27.Sh SYNOPSIS 28.Cd "options RTWN_DEBUG" 29.Cd "options RTWN_WITHOUT_UCODE" 30.Pp 31To compile this driver into the kernel, 32place the following lines in your 33kernel configuration file: 34.Bd -ragged -offset indent 35.Cd "device rtwn" 36.Cd "device rtwnfw" 37.Cd "device rtwn_usb" 38.Cd "device rtwn_pci" 39.Cd "device wlan" 40.Cd "device firmware" 41.Ed 42.Pp 43Alternatively, to load the driver as a 44module at boot time, place following lines in 45.Xr loader.conf 5 : 46.Bd -literal -offset indent 47if_rtwn_load="YES" 48if_rtwn_pci_load="YES" 49if_rtwn_usb_load="YES" 50.Ed 51.Sh DESCRIPTION 52The 53.Nm 54driver provides support for wireless network devices based on 55the Realtek RTL8192C, RTL8188E, RTL8812A and RTL8821A programming APIs. 56These APIs are used by a wide variety of chips; most chips with USB 57and some with PCI interface are supported. 58.Pp 59To enable use for PCI/PCIe systems, see the rtwn_pci(4) driver; 60for USB devices, use the rtwn_usb(4) driver. 61.Pp 62The driver supports 63.Cm station , 64.Cm adhoc , 65.Cm hostap 66and 67.Cm monitor 68mode operation. 69There are no limitations for number of 70.Cm monitor 71mode 72virtual interfaces; in addition to any other virtual interface 73one 74.Cm station 75interface can be added (Note: RTL8821AU supports two non-monitor 76mode interfaces at the same time). 77.Pp 78All chips have hardware support for WEP, AES-CCM and TKIP encryption. 79.Pp 80The 81.Nm 82driver can be configured at runtime with 83.Xr ifconfig 8 . 84.Sh FILES 85.Bl -tag -width ".Pa /usr/share/doc/legal/realtek.LICENSE" -compact 86.It Pa /usr/share/doc/legal/realtek.LICENSE 87.Nm 88firmware license 89.El 90.Pp 91The driver (if not compiled with 92.Cd options RTWN_WITHOUT_UCODE 93) may use following firmware files, which are loaded 94when an interface is brought up: 95.Bl -tag -width Ds -offset indent -compact 96.It Pa /boot/kernel/rtwn-rtl8188eufw.ko 97.It Pa /boot/kernel/rtwn-rtl8192cfwE_B.ko 98.It Pa /boot/kernel/rtwn-rtl8192cfwE.ko 99.It Pa /boot/kernel/rtwn-rtl8192cfwT.ko 100.It Pa /boot/kernel/rtwn-rtl8192cfwU.ko 101.It Pa /boot/kernel/rtwn-rtl8812aufw.ko 102.It Pa /boot/kernel/rtwn-rtl8821aufw.ko 103.El 104.Sh EXAMPLES 105Join an existing BSS network (i.e., connect to an access point): 106.Bd -literal -offset indent 107ifconfig wlan create wlandev rtwn0 inet 192.168.0.20 \e 108 netmask 0xffffff00 109.Ed 110.Pp 111Join a specific BSS network with network name 112.Dq Li my_net : 113.Pp 114.Dl "ifconfig wlan create wlandev rtwn0 ssid my_net up" 115.Pp 116Join a specific BSS network with 64-bit WEP encryption: 117.Bd -literal -offset indent 118ifconfig wlan create wlandev rtwn0 ssid my_net \e 119 wepmode on wepkey 0x1234567890 weptxkey 1 up 120.Ed 121.Pp 122Create an IBSS network with 128-bit WEP encryption on the channel 4: 123.Bd -literal -offset indent 124ifconfig wlan create wlandev rtwn0 wlanmode adhoc ssid my_net \e 125 wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 \e 126 channel 4 127.Ed 128.Pp 129Join/create an 802.11b IBSS network with network name 130.Dq Li my_net : 131.Bd -literal -offset indent 132ifconfig wlan0 create wlandev rtwn0 wlanmode adhoc 133ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e 134 mode 11b 135.Ed 136.Pp 137Create a host-based access point: 138.Bd -literal -offset indent 139ifconfig wlan0 create wlandev rtwn0 wlanmode hostap 140ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap 141.Ed 142.Sh LOADER TUNABLES 143Tunables can be set at the 144.Xr loader 8 145prompt before booting the kernel or stored in 146.Xr loader.conf 5 . 147.Bl -tag -width indent 148.It Va dev.rtwn.%d.hwcrypto 149This tunable controls how key slots are assigned: 150.br 1510 - disable h/w crypto support. Features that require access 152to frame contents (e.g., TCP/UDP/IP Rx checksum validation) 153will not work; 154.br 1551 - use h/w crypto support for pairwise keys only; 156.br 1572 - use h/w crypto support for all keys; may not work for 158multi-vap configurations. 159.br 160By default it is set to 1. 161.It Va dev.rtwn.%d.ratectl 162This tunable switches between rate control implementations: 163.br 1640 - no rate control; 165.br 1661 - driver sends 'tx complete' reports to net80211; algorithm 167is controlled via net80211; 168.br 1692 - firmware-based rate control. 170.br 171By default it is set to 1; however driver may choose another 172algorithm in case if it is not implemented 173.br 174Currently selected algorithm is reported via 175.Em Va dev.rtwn.%d.ratectl_selected 176read-only OID. 177.El 178.Sh DIAGNOSTICS 179.Bl -diag 180.It "rtwn%d: could not read efuse byte at address 0x%x" 181.It "rtwn%d: %s: cannot read rom, error %d" 182There was an error while reading ROM; device attach will be aborted. 183This should not happen. 184.It "rtwn%d: failed loadfirmware of file %s" 185For some reason, the driver was unable to read the microcode file from the 186filesystem. 187The file might be missing or corrupted. 188The driver will disable firmware-dependent features. 189.It "rtwn%d: wrong firmware size (%zu)" 190.It "rtwn%d: %s: failed to upload firmware %s (error %d)" 191.It "rtwn%d: timeout waiting for firmware readiness" 192Firmware upload failed; the file might be corrupted. 193The driver will disable firmware-dependent features. 194This should not happen. 195.It "rtwn%d: device timeout" 196A frame dispatched to the hardware for transmission did not complete in time. 197The driver will reset the hardware. 198This should not happen. 199.El 200.Sh SEE ALSO 201.Xr intro 4 , 202.Xr netintro 4 , 203.Xr rtwn_pci 4 , 204.Xr rtwn_usb 4 , 205.Xr rtwnfw 4 , 206.Xr wlan 4 , 207.Xr wlan_amrr 4 , 208.Xr wlan_ccmp 4 , 209.Xr wlan_tkip 4 , 210.Xr wlan_wep 4 , 211.Xr wlan_xauth 4 , 212.Xr hostapd 4 , 213.Xr ifconfig 8 , 214.Xr wpa_supplicant 8 215.Sh HISTORY 216The 217.Cm urtwn 218driver first appeared in 219.Ox 4.9 220and 221.Fx 10.0 ; 222the 223.Nm 224driver first appeared in 225.Ox 5.8 . 226.Sh AUTHORS 227The 228.Nm 229driver was initially written by 230.An -nosplit 231.An Stefan Sperling Aq Mt stsp@openbsd.org 232and ported by 233.An Kevin Lo Aq Mt kevlo@freebsd.org . 234It was based on the 235.Cm urtwn 236driver written by 237.An Damien Bergamini Aq Mt damien.bergamini@free.fr . 238.Sh BUGS 239The 240.Nm 241driver currently does not implement firmware-based rate control. 242