share/man/man4/urtwn.4

   1 .\"
   2 .\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $FreeBSD: head/share/man/man4/urtwn.4 257408 2013-10-31 01:57:05Z kevlo $
  17 .\"
  18 .Dd March 16, 2014
  19 .Dt URTWN 4
  20 .Os
  21 .Sh NAME
  22 .Nm urtwn
  23 .Nd Realtek RTL8188CU/RTL8192CU USB IEEE 802.11b/g/n wireless network device
  24 .Sh SYNOPSIS
  25 To compile this driver into the kernel,
  26 place the following lines in your
  27 kernel configuration file:
  28 .Bd -ragged -offset indent
  29 .Cd "device ehci"
  30 .Cd "device uhci"
  31 .Cd "device ohci"
  32 .Cd "device usb"
  33 .Cd "device urtwn"
  34 .Cd "device wlan"
  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_urtwn_load="YES"
  42 .Ed
  43 .Pp
  44 In both cases, place the following line in
  45 .Xr loader.conf 5
  46 to acknowledge the firmware license (see below):
  47 .Bd -literal -offset indent
  48 legal.realtek.license_ack=1
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver supports USB 2.0 wireless network devices based on Realtek
  54 RTL8188CUS, RTL8188CE-VAU, RTL8188RU and RTL8192CU chipsets.
  55 .Pp
  56 The RTL8188CUS is a highly integrated 802.11n adapter that combines
  57 a MAC, a 1T1R capable baseband and an RF in a single chip.
  58 It operates in the 2GHz spectrum only.
  59 The RTL8188RU is a high-power variant of the RTL8188CUS.
  60 The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
  61 to the USB interface.
  62 .Pp
  63 The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
  64 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  65 RF in a single chip.
  66 It operates in the 2GHz spectrum only.
  67 .Pp
  68 This driver requires the firmware built with the
  69 .Xr urtwnfw 4
  70 module to work.
  71 For the loaded firmware to be enabled for use the license at
  72 .Pa /usr/share/doc/legal/realtek/LICENSE
  73 must be agreed to by adding the following line to
  74 .Xr loader.conf 5 :
  75 .Pp
  76 .Dl "legal.realtek.license_ack=1"
  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 following adapters should work:
  85 .Pp
  86 .Bl -tag -width Ds -offset indent -compact
  87 .It Belkin F7D1102 Surf Wireless Micro
  88 .It D-Link DWA-131
  89 .It Edimax EW-7811Un
  90 .It Netgear WNA1000M
  91 .It Realtek RTL8192CU
  92 .It Realtek RTL8188CUS
  93 .El
  94 .Sh EXAMPLES
  95 Join an existing BSS network (i.e., connect to an access point):
  96 .Bd -literal -offset indent
  97 ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
  98     netmask 0xffffff00
  99 .Ed
 100 .Pp
 101 Join a specific BSS network with network name
 102 .Dq Li my_net :
 103 .Pp
 104 .Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
 105 .Pp
 106 Join a specific BSS network with 64-bit WEP encryption:
 107 .Bd -literal -offset indent
 108 ifconfig wlan create wlandev urtwn0 ssid my_net \e
 109         wepmode on wepkey 0x1234567890 weptxkey 1 up
 110 .Ed
 111 .Sh DIAGNOSTICS
 112 .Bl -diag
 113 .It "urtwn%d: error %d, could not read firmware %s"
 114 For some reason, the driver was unable to read the microcode file from the
 115 filesystem.
 116 The file might be missing or corrupted.
 117 .It "urtwn%d: device timeout"
 118 A frame dispatched to the hardware for transmission did not complete in time.
 119 The driver will reset the hardware.
 120 This should not happen.
 121 .El
 122 .Sh SEE ALSO
 123 .Xr ifmedia 4 ,
 124 .Xr intro 4 ,
 125 .Xr netintro 4 ,
 126 .Xr urtwnfw 4 ,
 127 .Xr usb 4 ,
 128 .Xr wlan 4 ,
 129 .Xr wlan_ccmp 4 ,
 130 .Xr wlan_tkip 4 ,
 131 .Xr wlan_wep 4 ,
 132 .Xr ifconfig 8 ,
 133 .Xr wpa_supplicant 8
 134 .Rs
 135 .%T Realtek
 136 .%O http://www.realtek.com.tw
 137 .Re
 138 .Sh HISTORY
 139 The
 140 .Nm
 141 driver first appeared in
 142 .Ox 4.9
 143 and
 144 .Fx 10.0 .
 145 .Sh AUTHORS
 146 The
 147 .Nm
 148 driver was written by
 149 .An Damien Bergamini Aq Mt damien@openbsd.org .
 150 .Sh CAVEATS
 151 The
 152 .Nm
 153 driver does not support any of the 802.11n capabilities offered by the
 154 adapters.