share/man/man4/rsu.4

   1 .\" $OpenBSD: rsu.4,v 1.11 2013/02/14 07:40:42 jmc 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 July 29 2013
  19 .Dt RSU 4
  20 .Os
  21 .Sh NAME
  22 .Nm rsu
  23 .Nd Realtek RTL8188SU/RTL8192SU 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 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 rsu"
  33 .Cd "device wlan"
  34 .Ed
  35 .Pp
  36 Alternatively, to load the driver as a module at boot time,
  37 place the following line in
  38 .Xr loader.conf 5 :
  39 .Bd -literal -offset indent
  40 if_rsu_load="YES"
  41 .Ed
  42 .Pp
  43 After you have read the license in /usr/share/doc/legal/realtek
  44 you will want to add the following lines to
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 legal.realtek.license_ack=1
  48 rsu-rtl8712fw_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver supports USB 2.0 wireless network devices based on Realtek
  54 RTL8188SU, RTL8191SU and RTL8192SU chipsets.
  55 .Pp
  56 The RTL8188SU 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 .Pp
  60 The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
  61 802.11n adapter that combines a MAC, a 1T2R capable baseband and an
  62 RF in a single chip.
  63 It operates in the 2GHz spectrum only.
  64 .Pp
  65 The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
  66 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  67 RF in a single chip.
  68 It operates in the 2GHz spectrum only.
  69 .Pp
  70 These are the modes the
  71 .Nm
  72 driver can operate in:
  73 .Bl -tag -width "IBSS-masterXX"
  74 .It BSS mode
  75 Also known as
  76 .Em infrastructure
  77 mode, this is used when associating with an access point, through
  78 which all traffic passes.
  79 This mode is the default.
  80 .El
  81 .Pp
  82 The
  83 .Nm
  84 driver can be configured to use
  85 Wired Equivalent Privacy (WEP) or
  86 Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
  87 WPA is the de facto encryption standard for wireless networks.
  88 It is strongly recommended that WEP
  89 not be used as the sole mechanism
  90 to secure wireless communication,
  91 due to serious weaknesses in it.
  92 .Pp
  93 The
  94 .Nm
  95 driver can be configured at runtime with
  96 .Xr ifconfig 8
  97 or on boot with
  98 .Xr hostname 1 .
  99 .Sh FILES
 100 The driver needs at least version 1.2 of the following firmware file,
 101 which is loaded when an interface is attached:
 102 .Pp
 103 .Bl -tag -width Ds -offset indent -compact
 104 .It /boot/kernel/rsu-rtl8712fw.ko
 105 .El
 106 .Sh HARDWARE
 107 The following adapters should work:
 108 .Pp
 109 .Bl -tag -width Ds -offset indent -compact
 110 .It ASUS USB-N10
 111 .It Belkin F7D1101 v1
 112 .It D-Link DWA-131 A1
 113 .It EDUP EP-MS150N(W)
 114 .It Hercules HWGUn-54
 115 .It Hercules HWNUm-300
 116 .It Planex GW-USNano
 117 .It Sitecom WL-349 v1
 118 .It Sitecom WL-353
 119 .It Sweex LW154
 120 .It TRENDnet TEW-648UB
 121 .It TRENDnet TEW-649UB
 122 .El
 123 .Sh EXAMPLES
 124 Join an existing BSS network (i.e., connect to an access point):
 125 .Bd -literal -offset indent
 126 ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
 127     netmask 0xffffff00
 128 .Ed
 129 .Pp
 130 Join a specific BSS network with network name
 131 .Dq Li my_net :
 132 .Pp
 133 .Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
 134 .Pp
 135 Join a specific BSS network with 64-bit WEP encryption:
 136 .Bd -literal -offset indent
 137 ifconfig wlan create wlandev rsu0 ssid my_net \e
 138         wepmode on wepkey 0x1234567890 weptxkey 1 up
 139 .Ed
 140 .Sh DIAGNOSTICS
 141 .Bl -diag
 142 .It "%s: failed load firmware of file rsu-rtl8712fw"
 143 For some reason, the driver was unable to read the microcode file from the
 144 filesystem.
 145 The file might be missing or corrupted.
 146 .It "device timeout"
 147 A frame dispatched to the hardware for transmission did not complete in time.
 148 The driver will reset the hardware.
 149 This should not happen.
 150 .El
 151 .Sh SEE ALSO
 152 .Xr hostname 1 ,
 153 .Xr intro 1 ,
 154 .Xr usb 3 ,
 155 .Xr netintro 4 ,
 156 .Xr rsufw 4 ,
 157 .Xr wlan 4 ,
 158 .Xr arp 8 ,
 159 .Xr ifconfig 8
 160 .Sh HISTORY
 161 The
 162 .Nm
 163 driver first appeared in
 164 .Ox 4.9 and
 165 .Fx 10.0 .
 166 .Sh AUTHORS
 167 .An -nosplit
 168 The
 169 .Nm
 170 driver was written by
 171 .An Damien Bergamini Aq damien@openbsd.org
 172 and ported by
 173 .An Rui Paulo Aq rpaulo@freebsd.org .
 174 .Sh CAVEATS
 175 The
 176 .Nm
 177 driver does not support any of the 802.11n capabilities offered by the
 178 adapters.