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 May 3, 2014
  18 .Dt URTWN 4
  19 .Os
  20 .Sh NAME
  21 .Nm urtwn
  22 .Nd Realtek RTL8188CU/RTL8188EU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel,
  25 place the following lines in your
  26 kernel configuration file:
  27 .Bd -ragged -offset indent
  28 .Cd "device ehci"
  29 .Cd "device uhci"
  30 .Cd "device ohci"
  31 .Cd "device usb"
  32 .Cd "device urtwn"
  33 .Cd "device wlan"
  34 .Ed
  35 .Pp
  36 Alternatively, to load the driver as a
  37 module at boot time, place the following line in
  38 .Xr loader.conf 5 :
  39 .Bd -literal -offset indent
  40 if_urtwn_load="YES"
  41 .Ed
  42 .Pp
  43 In both cases, place the following line in
  44 .Xr loader.conf 5
  45 to acknowledge the firmware license (see below):
  46 .Bd -literal -offset indent
  47 legal.realtek.license_ack=1
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver supports USB 2.0 wireless network devices based on Realtek
  53 RTL8188CUS, RTL8188CE-VAU, RTL8188EUS, RTL8188RU and RTL8192CU chipsets.
  54 .Pp
  55 The RTL8188CUS and RTL8188EUS are highly integrated 802.11n adapter that
  56 combine a MAC, a 1T1R capable baseband and an RF in a single chip.
  57 They operate in the 2GHz spectrum only.
  58 The RTL8188RU is a high-power variant of the RTL8188CUS.
  59 The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
  60 to the USB interface.
  61 .Pp
  62 The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
  63 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  64 RF in a single chip.
  65 It operates in the 2GHz spectrum only.
  66 .Pp
  67 This driver requires the firmware built with the
  68 .Nm urtwnfw
  69 module to work.
  70 For the loaded firmware to be enabled for use the license at
  71 .Pa /usr/share/doc/legal/realtek
  72 must be agreed by adding the following line to
  73 .Xr loader.conf 5 :
  74 .Pp
  75 .Dl "legal.realtek.license_ack=1"
  76 .Sh FILES
  77 .Bl -tag -width ".Pa /usr/share/doc/legal/realtek" -compact
  78 .It Pa /usr/share/doc/legal/realtek
  79 .Nm
  80 firmware license
  81 .El
  82 .Sh HARDWARE
  83 The
  84 .Nm
  85 driver supports Realtek RTL8188CU/RTL8188EU/RTL8192CU based USB
  86 IEEE 802.11b/g/n wireless network adapters, including:
  87 .Pp
  88 .Bl -tag -width Ds -offset indent -compact
  89 .It ASUS USB-N10 NANO
  90 .It Belkin F7D1102 Surf Wireless Micro
  91 .It D-Link DWA-131
  92 .It Edimax EW-7811Un
  93 .It Netgear WNA1000M
  94 .It Realtek RTL8192CU
  95 .It Realtek RTL8188CUS
  96 .It TP-LINK TL-WN723N v3
  97 .It TP-LINK TL-WN725N v2
  98 .El
  99 .Sh EXAMPLES
 100 Join an existing BSS network (i.e., connect to an access point):
 101 .Bd -literal -offset indent
 102 ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
 103     netmask 0xffffff00
 104 .Ed
 105 .Pp
 106 Join a specific BSS network with network name
 107 .Dq Li my_net :
 108 .Pp
 109 .Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
 110 .Pp
 111 Join a specific BSS network with 64-bit WEP encryption:
 112 .Bd -literal -offset indent
 113 ifconfig wlan create wlandev urtwn0 ssid my_net \e
 114         wepmode on wepkey 0x1234567890 weptxkey 1 up
 115 .Ed
 116 .Sh DIAGNOSTICS
 117 .Bl -diag
 118 .It "urtwn%d: error %d, could not read firmware %s"
 119 For some reason, the driver was unable to read the microcode file from the
 120 filesystem.
 121 The file might be missing or corrupted.
 122 .It "urtwn%d: device timeout"
 123 A frame dispatched to the hardware for transmission did not complete in time.
 124 The driver will reset the hardware.
 125 This should not happen.
 126 .El
 127 .Sh SEE ALSO
 128 .Xr intro 4 ,
 129 .Xr netintro 4 ,
 130 .Xr urtwnfw 4 ,
 131 .Xr usb 4 ,
 132 .Xr wlan 4 ,
 133 .Xr wlan_ccmp 4 ,
 134 .Xr wlan_tkip 4 ,
 135 .Xr wlan_wep 4 ,
 136 .Xr ifconfig 8 ,
 137 .Xr wpa_supplicant 8
 138 .Rs
 139 .%T Realtek
 140 .%U http://www.realtek.com.tw
 141 .Re
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 driver first appeared in
 146 .Ox 4.9
 147 and
 148 .Fx 10.0 .
 149 .Sh AUTHORS
 150 The
 151 .Nm
 152 driver was written by
 153 .An Damien Bergamini Aq damien@openbsd.org .
 154 .Sh CAVEATS
 155 The
 156 .Nm
 157 driver does not support any of the 802.11n capabilities offered by the
 158 adapters.