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 November 19, 2014
  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
  44 .Pa /usr/share/doc/legal/realtek
  45 you will want to add the following lines to
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 legal.realtek.license_ack=1
  49 rsu-rtl8712fw_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver supports USB 2.0 wireless network devices based on Realtek
  55 RTL8188SU, RTL8191SU and RTL8192SU chipsets.
  56 .Pp
  57 The RTL8188SU is a highly integrated 802.11n adapter that combines
  58 a MAC, a 1T1R capable baseband and an RF in a single chip.
  59 It operates in the 2GHz spectrum only.
  60 .Pp
  61 The RTL8191SU is a highly integrated multiple-in, single-out (MISO)
  62 802.11n adapter that combines a MAC, a 1T2R capable baseband and an
  63 RF in a single chip.
  64 It operates in the 2GHz spectrum only.
  65 .Pp
  66 The RTL8192SU is a highly integrated multiple-in, multiple-out (MIMO)
  67 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
  68 RF in a single chip.
  69 It operates in the 2GHz spectrum only.
  70 .Pp
  71 These are the modes the
  72 .Nm
  73 driver can operate in:
  74 .Bl -tag -width "IBSS-masterXX"
  75 .It BSS mode
  76 Also known as
  77 .Em infrastructure
  78 mode, this is used when associating with an access point, through
  79 which all traffic passes.
  80 This mode is the default.
  81 .El
  82 .Pp
  83 The
  84 .Nm
  85 driver can be configured to use
  86 Wired Equivalent Privacy (WEP) or
  87 Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
  88 WPA is the de facto encryption standard for wireless networks.
  89 It is strongly recommended that WEP
  90 not be used as the sole mechanism
  91 to secure wireless communication,
  92 due to serious weaknesses in it.
  93 .Pp
  94 The
  95 .Nm
  96 driver can be configured at runtime with
  97 .Xr ifconfig 8 .
  98 .Sh FILES
  99 The driver needs at least version 1.2 of the following firmware file,
 100 which is loaded when an interface is attached:
 101 .Pp
 102 .Bl -tag -width Ds -offset indent -compact
 103 .It Pa /boot/kernel/rsu-rtl8712fw.ko
 104 .El
 105 .Sh HARDWARE
 106 The
 107 .Nm
 108 driver provices support for Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n
 109 wireless network adapters, including:
 110 .Pp
 111 .Bl -tag -width Ds -offset indent -compact
 112 .It ASUS USB-N10
 113 .It Belkin F7D1101 v1
 114 .It D-Link DWA-131 A1
 115 .It EDUP EP-MS150N(W)
 116 .It Hercules HWGUn-54
 117 .It Hercules HWNUm-300
 118 .It Planex GW-USNano
 119 .It Sitecom WL-349 v1
 120 .It Sitecom WL-353
 121 .It Sweex LW154
 122 .It TRENDnet TEW-646UBH
 123 .It TRENDnet TEW-648UB
 124 .It TRENDnet TEW-649UB
 125 .El
 126 .Sh EXAMPLES
 127 Join an existing BSS network (i.e., connect to an access point):
 128 .Bd -literal -offset indent
 129 ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
 130     netmask 0xffffff00
 131 .Ed
 132 .Pp
 133 Join a specific BSS network with network name
 134 .Dq Li my_net :
 135 .Pp
 136 .Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
 137 .Pp
 138 Join a specific BSS network with 64-bit WEP encryption:
 139 .Bd -literal -offset indent
 140 ifconfig wlan create wlandev rsu0 ssid my_net \e
 141         wepmode on wepkey 0x1234567890 weptxkey 1 up
 142 .Ed
 143 .Sh DIAGNOSTICS
 144 .Bl -diag
 145 .It "%s: failed load firmware of file rsu-rtl8712fw"
 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 "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 1 ,
 156 .Xr netintro 4 ,
 157 .Xr rsufw 4 ,
 158 .Xr usb 4 ,
 159 .Xr wlan 4 ,
 160 .Xr arp 8 ,
 161 .Xr hostapd 8 ,
 162 .Xr ifconfig 8 ,
 163 .Xr wpa_supplicant 8
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 driver first appeared in
 168 .Ox 4.9 and
 169 .Fx 10.0 .
 170 .Sh AUTHORS
 171 .An -nosplit
 172 The
 173 .Nm
 174 driver was written by
 175 .An Damien Bergamini Aq Mt damien@openbsd.org
 176 and ported by
 177 .An Rui Paulo Aq Mt rpaulo@freebsd.org .
 178 .Sh CAVEATS
 179 The
 180 .Nm
 181 driver does not support any of the 802.11n capabilities offered by the
 182 adapters.