share/man/man4/urtwn.4

   1 .\" $OpenBSD: urtwn.4,v 1.20 2013/05/16 10:02:59 sthen Exp $
   2 .\" $FreeBSD$
   3 .\"
   4 .\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
   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 .Dd October 6, 2013
  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 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver supports USB 2.0 wireless network devices based on Realtek
  47 RTL8188CUS, RTL8188CE-VAU, RTL8188RU and RTL8192CU chipsets.
  48 .Pp
  49 The RTL8188CUS is a highly integrated 802.11n adapter that combines
  50 a MAC, a 1T1R capable baseband and an RF in a single chip.
  51 It operates in the 2GHz spectrum only.
  52 The RTL8188RU is a high-power variant of the RTL8188CUS.
  53 The RTL8188CE-VAU is a PCI Express Mini Card adapter that attaches
  54 to the USB interface.
  55 .Pp
  56 The RTL8192CU is a highly integrated multiple-in, multiple-out (MIMO)
  57 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  58 RF in a single chip.
  59 It operates in the 2GHz spectrum only.
  60 .Sh HARDWARE
  61 The following adapters should work:
  62 .Pp
  63 .Bl -tag -width Ds -offset indent -compact
  64 .It Belkin F7D1102 Surf Wireless Micro
  65 .It D-Link DWA-131
  66 .It Edimax EW-7811Un
  67 .It Netgear WNA1000M
  68 .It Realtek RTL8192CU
  69 .It Realtek RTL8188CUS
  70 .El
  71 .Sh EXAMPLES
  72 Join an existing BSS network (i.e., connect to an access point):
  73 .Bd -literal -offset indent
  74 ifconfig wlan create wlandev urtwn0 inet 192.168.0.20 \e
  75     netmask 0xffffff00
  76 .Ed
  77 .Pp
  78 Join a specific BSS network with network name
  79 .Dq Li my_net :
  80 .Pp
  81 .Dl "ifconfig wlan create wlandev urtwn0 ssid my_net up"
  82 .Pp
  83 Join a specific BSS network with 64-bit WEP encryption:
  84 .Bd -literal -offset indent
  85 ifconfig wlan create wlandev urtwn0 ssid my_net \e
  86         wepmode on wepkey 0x1234567890 weptxkey 1 up
  87 .Ed
  88 .Sh DIAGNOSTICS
  89 .Bl -diag
  90 .It "urtwn%d: error %d, could not read firmware %s"
  91 For some reason, the driver was unable to read the microcode file from the
  92 filesystem.
  93 The file might be missing or corrupted.
  94 .It "urtwn%d: device timeout"
  95 A frame dispatched to the hardware for transmission did not complete in time.
  96 The driver will reset the hardware.
  97 This should not happen.
  98 .El
  99 .Sh SEE ALSO
 100 .Xr intro 4 ,
 101 .Xr netintro 4 ,
 102 .Xr usb 4 ,
 103 .Xr wlan 4 ,
 104 .Xr wlan_ccmp 4 ,
 105 .Xr wlan_tkip 4 ,
 106 .Xr wlan_wep 4 ,
 107 .Xr ifconfig 8 ,
 108 .Xr wpa_supplicant 8
 109 .Rs
 110 .%T Realtek
 111 .%U http://www.realtek.com.tw
 112 .Re
 113 .Sh HISTORY
 114 The
 115 .Nm
 116 driver first appeared in
 117 .Ox 4.9
 118 and
 119 .Fx 10.0 .
 120 .Sh AUTHORS
 121 The
 122 .Nm
 123 driver was written by
 124 .An Damien Bergamini Aq damien@openbsd.org .
 125 .Sh CAVEATS
 126 The
 127 .Nm
 128 driver does not support any of the 802.11n capabilities offered by the
 129 adapters.