share/man/man4/urtwn.4

   1 .\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
   2 .\"
   3 .\" Permission to use, copy, modify, and distribute this software for any
   4 .\" purpose with or without fee is hereby granted, provided that the above
   5 .\" copyright notice and this permission notice appear in all copies.
   6 .\"
   7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  14 .\"
  15 .\" $FreeBSD$
  16 .\"
  17 .Dd June 9, 2016
  18 .Dt URTWN 4
  19 .Os
  20 .Sh NAME
  21 .Nm urtwn
  22 .Nd Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
  23 .Sh SYNOPSIS
  24 .Cd "options URTWN_WITHOUT_UCODE"
  25 .Pp
  26 To compile this driver into the kernel,
  27 place the following lines in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device ehci"
  31 .Cd "device uhci"
  32 .Cd "device ohci"
  33 .Cd "device usb"
  34 .Cd "device urtwn"
  35 .Cd "device wlan"
  36 .Ed
  37 .Pp
  38 Alternatively, to load the driver as a
  39 module at boot time, place the following line in
  40 .Xr loader.conf 5 :
  41 .Bd -literal -offset indent
  42 if_urtwn_load="YES"
  43 .Ed
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 driver supports USB 2.0 wireless network devices based on Realtek
  48 RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
  49 .Pp
  50 The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapters that
  51 combine a MAC, a 1T1R capable baseband and an RF in a single chip.
  52 They operate in the 2GHz spectrum only.
  53 The RTL8188RU is a high-power variant of the RTL8188CUS.
  54 The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
  55 to the USB interface.
  56 .Pp
  57 The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
  58 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  59 RF in a single chip.
  60 It operates in the 2GHz spectrum only.
  61 .Pp
  62 All chips have hardware support for  WEP, AES-CCM and TKIP encryption.
  63 .Pp
  64 The driver supports
  65 .Cm station ,
  66 .Cm adhoc ,
  67 .Cm hostap ,
  68 and
  69 .Cm monitor
  70 mode operation.
  71 Only one virtual interface may be configured at any time.
  72 .Pp
  73 This driver may use the firmware built with the
  74 .Nm urtwnfw
  75 module for some additional features
  76 (when URTWN_WITHOUT_UCODE kernel option is not set).
  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
  81 firmware license
  82 .El
  83 .Sh HARDWARE
  84 The
  85 .Nm
  86 driver supports Realtek RTL8188CU/RTL8188RU/RTL8188EU/RTL8192CU based USB
  87 IEEE 802.11b/g/n wireless network adapters, including:
  88 .Pp
  89 .Bl -tag -width Ds -offset indent -compact
  90 .It Alfa AWUS036NHR v2
  91 .It ASUS USB-N10 NANO
  92 .It Belkin F7D1102 Surf Wireless Micro
  93 .It D-Link DWA-123 rev D1
  94 .It D-Link DWA-125 rev D1
  95 .It D-Link DWA-131
  96 .It Edimax EW-7811Un
  97 .It Elecom WDC-150SU2M
  98 .It Netgear WNA1000M
  99 .It Realtek RTL8192CU
 100 .It Realtek RTL8188CUS
 101 .It TP-LINK TL-WN723N v3
 102 .It TP-LINK TL-WN725N v2
 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 urtwn0 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 urtwn0 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 urtwn0 ssid my_net \e
 119         wepmode on wepkey 0x1234567890 weptxkey 1 up
 120 .Ed
 121 .Pp
 122 Create an IBSS network with 128-bit WEP encryption on the channel 4:
 123 .Bd -literal -offset indent
 124 ifconfig wlan0 create wlandev urtwn0 wlanmode adhoc ssid my_net \e
 125         wepmode on wepkey 0x01020304050607080910111213 weptxkey 1 \e
 126         channel 4
 127 .Ed
 128 .Pp
 129 Join/create an 802.11b IBSS network with network name
 130 .Dq Li my_net :
 131 .Bd -literal -offset indent
 132 ifconfig wlan0 create wlandev urtwn0 wlanmode adhoc
 133 ifconfig wlan0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 134         mode 11b
 135 .Ed
 136 .Pp
 137 Create an 802.11g host-based access point:
 138 .Bd -literal -offset indent
 139 ifconfig wlan0 create wlandev urtwn0 wlanmode hostap
 140 ifconfig wlan0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 141         mode 11g
 142 .Ed
 143 .Sh DIAGNOSTICS
 144 .Bl -diag
 145 .It "urtwn%d: error %d, could not read firmware %s"
 146 For some reason, the driver was unable to read the microcode file from the
 147 filesystem.
 148 The file might be missing or corrupted.
 149 .It "urtwn%d: device timeout"
 150 A frame dispatched to the hardware for transmission did not complete in time.
 151 The driver will reset the hardware.
 152 This should not happen.
 153 .El
 154 .Sh SEE ALSO
 155 .Xr intro 4 ,
 156 .Xr netintro 4 ,
 157 .Xr urtwnfw 4 ,
 158 .Xr usb 4 ,
 159 .Xr wlan 4 ,
 160 .Xr wlan_amrr 4 ,
 161 .Xr wlan_ccmp 4 ,
 162 .Xr wlan_tkip 4 ,
 163 .Xr wlan_wep 4 ,
 164 .Xr ifconfig 8 ,
 165 .Xr wpa_supplicant 8
 166 .Rs
 167 .%T Realtek
 168 .%U http://www.realtek.com.tw
 169 .Re
 170 .Sh HISTORY
 171 The
 172 .Nm
 173 driver first appeared in
 174 .Ox 4.9
 175 and
 176 .Fx 10.0 .
 177 .Sh AUTHORS
 178 The
 179 .Nm
 180 driver was written by
 181 .An Damien Bergamini Aq Mt damien@openbsd.org .
 182 .Sh CAVEATS
 183 The
 184 .Nm
 185 driver currently does not support A-MPDU 802.11n transmit aggregation.
 186 .Pp
 187 For non-RTL8188EUS chips
 188 .Dq "rate control"
 189 algorithm is absent; this may result in increased packet loss in noisy
 190 networks.