share/man/man4/rtwn.4

   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
  27 To compile this driver into the kernel,
  28 place the following lines in your
  29 kernel 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
  37 Alternatively, to load the driver as a
  38 module at boot time, place the following line in
  39 .Xr loader.conf 5 :
  40 .Bd -literal -offset indent
  41 if_rtwn_load="YES"
  42 .Ed
  43 .Pp
  44 After you have read the license in
  45 .Pa /usr/share/doc/legal/realtek.LICENSE
  46 you will want to add the following lines to
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 legal.realtek.license_ack=1
  50 rtwn-rtl8192cfwU_load="YES"
  51 rtwn-rtl8192cfwU_B_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver supports PCIe wireless network devices based on the Realtek
  57 RTL8188CE chipset.
  58 .Pp
  59 The RTL8188CE is a highly integrated 802.11n adapter that combines a MAC,
  60 a 1T1R capable baseband and an RF in a single chip.
  61 It operates in the 2GHz spectrum only.
  62 .Pp
  63 These are the modes the
  64 .Nm
  65 driver can operate in:
  66 .Bl -tag -width "IBSS-masterXX"
  67 .It BSS mode
  68 Also known as
  69 .Em infrastructure
  70 mode, this is used when associating with an access point, through
  71 which all traffic passes.
  72 This mode is the default.
  73 .It monitor mode
  74 In this mode the driver is able to receive packets without
  75 associating with an access point.
  76 This disables the internal receive filter and enables the card to
  77 capture packets from networks which it wouldn't normally have access to,
  78 or to scan for access points.
  79 .El
  80 .Pp
  81 The
  82 .Nm
  83 driver can be configured to use
  84 Wired Equivalent Privacy (WEP) or
  85 Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
  86 WPA is the current encryption standard for wireless networks.
  87 It is strongly recommended that WEP
  88 not be used as the sole mechanism
  89 to secure wireless communication,
  90 due to serious weaknesses in it.
  91 .Pp
  92 The
  93 .Nm
  94 driver can be configured at runtime with
  95 .Xr ifconfig 8 .
  96 .Sh FILES
  97 The driver needs at least version 1.0 of the following firmware files,
  98 which 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
 105 Join an existing BSS network (i.e., connect to an access point):
 106 .Bd -literal -offset indent
 107 ifconfig wlan create wlandev rtwn0 inet 192.168.0.20 \e
 108     netmask 0xffffff00
 109 .Ed
 110 .Pp
 111 Join 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
 116 Join a specific BSS network with 64-bit WEP encryption:
 117 .Bd -literal -offset indent
 118 ifconfig 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"
 124 For some reason, the driver was unable to read the microcode file from the
 125 filesystem.
 126 The file might be missing or corrupted.
 127 .It "device timeout"
 128 A frame dispatched to the hardware for transmission did not complete in time.
 129 The driver will reset the hardware.
 130 This 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
 142 The
 143 .Nm
 144 driver first appeared in
 145 .Ox 5.8 .
 146 .Sh AUTHORS
 147 The
 148 .Nm
 149 driver was written by
 150 .An -nosplit
 151 .An Stefan Sperling Aq Mt stsp@openbsd.org
 152 and ported by
 153 .An Kevin Lo Aq Mt kevlo@freebsd.org .
 154 It was based on the
 155 .Xr urtwn 4
 156 driver written by
 157 .An Damien Bergamini Aq Mt damien.bergamini@free.fr .
 158 .Sh CAVEATS
 159 The
 160 .Nm
 161 driver does not support any of the 802.11n capabilities offered by the
 162 adapters.
 163 Additional work is required in
 164 .Xr ieee80211 9
 165 before those features can be supported.