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.\" 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.\" $FreeBSD$ 19.\" 20.Dd October 28, 2015 21.Dt RTWN 4 22.Os 23.Sh NAME 24.Nm rtwn 25.Nd Realtek RTL8188CE PCIe IEEE 802.11b/g/n wireless network device 26.Sh SYNOPSIS 27To compile this driver into the kernel, 28place the following lines in your 29kernel configuration file: 30.Bd -ragged -offset indent 31.Cd "device rtwn" 32.Cd "device rtwnfw" 33.Cd "device wlan" 34.Cd "device firmware" 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_rtwn_load="YES" 42.Ed 43.Pp 44After you have read the license in 45.Pa /usr/share/doc/legal/realtek.LICENSE 46you will want to add the following lines to 47.Xr loader.conf 5 : 48.Bd -literal -offset indent 49legal.realtek.license_ack=1 50rtwn-rtl8192cfwU_load="YES" 51rtwn-rtl8192cfwU_B_load="YES" 52.Ed 53.Sh DESCRIPTION 54The 55.Nm 56driver supports PCIe wireless network devices based on the Realtek 57RTL8188CE chipset. 58.Pp 59The RTL8188CE is a highly integrated 802.11n adapter that combines a MAC, 60a 1T1R capable baseband and an RF in a single chip. 61It operates in the 2GHz spectrum only. 62.Pp 63These are the modes the 64.Nm 65driver can operate in: 66.Bl -tag -width "IBSS-masterXX" 67.It BSS mode 68Also known as 69.Em infrastructure 70mode, this is used when associating with an access point, through 71which all traffic passes. 72This mode is the default. 73.It monitor mode 74In this mode the driver is able to receive packets without 75associating with an access point. 76This disables the internal receive filter and enables the card to 77capture packets from networks which it wouldn't normally have access to, 78or to scan for access points. 79.El 80.Pp 81The 82.Nm 83driver can be configured to use 84Wired Equivalent Privacy (WEP) or 85Wi-Fi Protected Access (WPA-PSK and WPA2-PSK). 86WPA is the current encryption standard for wireless networks. 87It is strongly recommended that WEP 88not be used as the sole mechanism 89to secure wireless communication, 90due to serious weaknesses in it. 91.Pp 92The 93.Nm 94driver can be configured at runtime with 95.Xr ifconfig 8 . 96.Sh FILES 97The driver needs at least version 1.0 of the following firmware files, 98which are loaded when an interface is brought up: 99.Pp 100.Bl -tag -width Ds -offset indent -compact 101.It Pa /boot/kernel/rtwn-rtl8192cfwU.ko 102.It Pa /boot/kernel/rtwn-rtl8192cfwU_B.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.Sh DIAGNOSTICS 122.Bl -diag 123.It "could not read firmware %s" 124For some reason, the driver was unable to read the microcode file from the 125filesystem. 126The file might be missing or corrupted. 127.It "device timeout" 128A frame dispatched to the hardware for transmission did not complete in time. 129The driver will reset the hardware. 130This should not happen. 131.El 132.Sh SEE ALSO 133.Xr pci 4 , 134.Xr rtwnfw 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.Sh HISTORY 142The 143.Nm 144driver first appeared in 145.Ox 5.8 . 146.Sh AUTHORS 147The 148.Nm 149driver was written by 150.An -nosplit 151.An Stefan Sperling Aq Mt stsp@openbsd.org 152and ported by 153.An Kevin Lo Aq Mt kevlo@freebsd.org . 154It was based on the 155.Xr urtwn 4 156driver written by 157.An Damien Bergamini Aq Mt damien.bergamini@free.fr . 158.Sh CAVEATS 159The 160.Nm 161driver does not support any of the 802.11n capabilities offered by the 162adapters. 163Additional work is required in 164.Xr ieee80211 9 165before those features can be supported. 166