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 December 10, 2016
  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.LICENSE
  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 .It monitor mode
  82 In this mode the driver is able to receive packets without
  83 associating with an access point.
  84 This disables the internal receive filter and enables the card to
  85 capture packets from networks which it wouldn't normally have access to,
  86 or to scan for access points.
  87 .El
  88 .Pp
  89 The
  90 .Nm
  91 driver can be configured to use
  92 Wired Equivalent Privacy (WEP) or
  93 Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
  94 WPA is the de facto encryption standard for wireless networks.
  95 It is strongly recommended that WEP
  96 not be used as the sole mechanism
  97 to secure wireless communication,
  98 due to serious weaknesses in it.
  99 .Pp
 100 The
 101 .Nm
 102 driver can be configured at runtime with
 103 .Xr ifconfig 8 .
 104 .Sh FILES
 105 The driver needs at least version 1.2 of the following firmware file,
 106 which is loaded when an interface is attached:
 107 .Pp
 108 .Bl -tag -width Ds -offset indent -compact
 109 .It Pa /boot/kernel/rsu-rtl8712fw.ko
 110 .El
 111 .Sh HARDWARE
 112 The
 113 .Nm
 114 driver provices support for Realtek RTL8188SU/RTL8192SU USB IEEE 802.11b/g/n
 115 wireless network adapters, including:
 116 .Pp
 117 .Bl -tag -width Ds -offset indent -compact
 118 .It ASUS USB-N10
 119 .It Belkin F7D1101 v1
 120 .It D-Link DWA-131 A1
 121 .It EDUP EP-MS150N(W)
 122 .It Edimax EW-7622UMN
 123 .It Hercules HWGUn-54
 124 .It Hercules HWNUm-300
 125 .It Planex GW-USNano
 126 .It Sitecom WL-349 v1
 127 .It Sitecom WL-353
 128 .It Sweex LW154
 129 .It TRENDnet TEW-646UBH
 130 .It TRENDnet TEW-648UB
 131 .It TRENDnet TEW-649UB
 132 .El
 133 .Sh EXAMPLES
 134 Join an existing BSS network (i.e., connect to an access point):
 135 .Bd -literal -offset indent
 136 ifconfig wlan create wlandev rsu0 inet 192.168.0.20 \e
 137     netmask 0xffffff00
 138 .Ed
 139 .Pp
 140 Join a specific BSS network with network name
 141 .Dq Li my_net :
 142 .Pp
 143 .Dl "ifconfig wlan create wlandev rsu0 ssid my_net up"
 144 .Pp
 145 Join a specific BSS network with 64-bit WEP encryption:
 146 .Bd -literal -offset indent
 147 ifconfig wlan create wlandev rsu0 ssid my_net \e
 148         wepmode on wepkey 0x1234567890 weptxkey 1 up
 149 .Ed
 150 .Sh DIAGNOSTICS
 151 .Bl -diag
 152 .It "%s: failed load firmware of file rsu-rtl8712fw"
 153 For some reason, the driver was unable to read the microcode file from the
 154 filesystem.
 155 The file might be missing or corrupted.
 156 .It "device timeout"
 157 A frame dispatched to the hardware for transmission did not complete in time.
 158 The driver will reset the hardware.
 159 This should not happen.
 160 .El
 161 .Sh SEE ALSO
 162 .Xr intro 1 ,
 163 .Xr netintro 4 ,
 164 .Xr rsufw 4 ,
 165 .Xr usb 4 ,
 166 .Xr wlan 4 ,
 167 .Xr arp 8 ,
 168 .Xr hostapd 8 ,
 169 .Xr ifconfig 8 ,
 170 .Xr wpa_supplicant 8
 171 .Sh HISTORY
 172 The
 173 .Nm
 174 driver first appeared in
 175 .Ox 4.9 and
 176 .Fx 10.0 .
 177 .Sh AUTHORS
 178 .An -nosplit
 179 The
 180 .Nm
 181 driver was written by
 182 .An Damien Bergamini Aq Mt damien@openbsd.org
 183 and ported by
 184 .An Rui Paulo Aq Mt rpaulo@freebsd.org .
 185 The 802.11n support was added by
 186 .An Adrian Chadd Aq Mt adrian@freebsd.org .
 187 .Sh CAVEATS
 188 The
 189 .Nm
 190 driver currently does not support 802.11n transmit aggregation,
 191 either A-MSDU or A-MPDU.
 192 .Pp
 193 The
 194 .Nm
 195 driver does not capture management frames in non-monitor modes;
 196 without this limitation some firmware functions (e.g., 'join bss')
 197 will not work properly.