share/man/man4/rtw.4

   1 .\"     $NetBSD: rtw.4,v 1.3 2005/09/09 14:11:39 drochner Exp $
   2 .\"     $OpenBSD: rtw.4,v 1.18 2005/06/09 09:03:38 jmc Exp $
   3 .\"
   4 .\" Copyright (c) 2004 Jonathan Gray <jsg@openbsd.org>
   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 26, 2008
  19 .Dt RTW 4
  20 .Os
  21 .Sh NAME
  22 .Nm rtw
  23 .Nd Realtek RTL8180L IEEE 802.11b wireless network driver
  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 rtw"
  30 .Cd "device wlan"
  31 .Cd "device wlan_wep"
  32 .Cd "device wlan_ratectl_onoe"
  33 .Ed
  34 .Pp
  35 Alternatively, to load the driver as a
  36 module at boot time, place the following line in
  37 .Xr loader.conf 5 :
  38 .Bd -literal -offset indent
  39 if_rtw_load="YES"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver supports PCI/CardBus 802.11b wireless adapters based on the
  45 Realtek RTL8180L.
  46 .Pp
  47 A variety of radio transceivers can be found in these devices, including
  48 the Philips SA2400A, Maxim MAX2820, and GCT GRF5101, though not all of them
  49 are currently supported.
  50 .Pp
  51 These are the modes the
  52 .Nm
  53 driver can operate in:
  54 .Bl -tag -width "monitor mode"
  55 .It BSS mode
  56 Also known as
  57 .Em infrastructure
  58 mode, this is used when associating with an access point, through
  59 which all traffic passes.
  60 This mode is the default.
  61 .It IBSS mode
  62 Also known as
  63 .Em IEEE ad-hoc
  64 mode or
  65 .Em peer-to-peer
  66 mode.
  67 This is the standardized method of operating without an access point.
  68 Stations associate with a service set.
  69 However, actual connections between stations are peer-to-peer.
  70 .It Host AP
  71 In this mode the driver acts as an access point (base station)
  72 for other cards.
  73 .It monitor mode
  74 In this mode the driver is able to receive packets without
  75 associating with an access point.
  76 This disables the internal receive filter and enables the card to
  77 capture packets from networks which it wouldn't normally have access to,
  78 or to scan for access points.
  79 .El
  80 .Pp
  81 .Nm
  82 supports software WEP.
  83 Wired Equivalent Privacy (WEP) is the de facto encryption standard
  84 for wireless networks.
  85 It can be typically configured in one of three modes:
  86 no encryption; 40-bit encryption; or 104-bit encryption.
  87 Unfortunately, due to serious weaknesses in WEP protocol
  88 it is strongly recommended that it not be used as the
  89 sole mechanism to secure wireless communication.
  90 WEP is not enabled by default.
  91 .Sh CONFIGURATION
  92 The
  93 .Nm
  94 driver can be configured at runtime with
  95 .Xr ifconfig 8
  96 using the following parameters:
  97 .Bl -tag -width ".Fl mediaopt Ar opts"
  98 .It Cm bssid Ar bssid
  99 Set the desired BSSID.
 100 .It Fl bssid
 101 Unset the desired BSSID.
 102 The interface will automatically select a BSSID in this mode, which is
 103 the default.
 104 .It Cm chan Ar n
 105 Set the channel (radio frequency) to be used by the driver based on
 106 the given channel ID
 107 .Ar n .
 108 .It Fl chan
 109 Unset the desired channel to be used by the driver.
 110 The driver will automatically select a channel in this mode, which is
 111 the default.
 112 .It Cm media Ar media
 113 The
 114 .Nm
 115 driver supports the following
 116 .Ar media
 117 types:
 118 .Pp
 119 .Bl -tag -width ".Cm autoselect" -compact
 120 .It Cm autoselect
 121 Enable autoselection of the media type and options.
 122 .It Cm DS1
 123 Set 802.11b DS 1Mbps operation.
 124 .It Cm DS2
 125 Set 802.11b DS 2Mbps operation.
 126 .It Cm DS5
 127 Set 802.11b DS 5.5Mbps operation.
 128 .It Cm DS11
 129 Set 802.11b DS 11Mbps operation.
 130 .El
 131 .It Cm mediaopt Ar opts
 132 The
 133 .Nm
 134 driver supports the following media options:
 135 .Pp
 136 .Bl -tag -width ".Cm monitor" -compact
 137 .It Cm hostap
 138 Select Host AP operation.
 139 .It Cm ibss
 140 Select IBSS operation.
 141 .It Cm monitor
 142 Select monitor mode.
 143 .El
 144 .It Fl mediaopt Ar opts
 145 Disable the specified media options on the driver and return it to the
 146 default mode of operation (BSS).
 147 .It Cm ssid Ar id
 148 Set the network ID.
 149 The
 150 .Ar id
 151 can either be any text string up to 32 characters in length,
 152 or a series of hexadecimal digits up to 64 digits.
 153 An empty
 154 .Ar id
 155 string allows the interface to connect to any available access points.
 156 By default the
 157 .Nm
 158 driver uses an empty string.
 159 Note that network ID is synonymous with Extended Service Set ID (ESSID).
 160 .It Cm nwkey Ar key
 161 Enable WEP encryption using the specified
 162 .Ar key .
 163 The
 164 .Ar key
 165 can either be a string, a series of hexadecimal digits (preceded by
 166 .Sq 0x ) ,
 167 or a set of keys of the form
 168 .Dq n:k1,k2,k3,k4 ,
 169 where
 170 .Sq n
 171 specifies which of the keys will be used for transmitted packets,
 172 and the four keys,
 173 .Dq k1
 174 through
 175 .Dq k4 ,
 176 are configured as WEP keys.
 177 If a set of keys is specified, a comma
 178 .Pq Sq \&,
 179 within the key must be escaped with a backslash.
 180 Note that if multiple keys are used, their order must be the same within
 181 the network.
 182 .Nm
 183 is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
 184 or 104-bit (13 characters or 26 hexadecimal digits) keys.
 185 .It Fl nwkey
 186 Disable WEP encryption.
 187 This is the default mode of operation.
 188 .It Cm nwkey persist
 189 Enable WEP encryption with the persistent key stored in the network card.
 190 .El
 191 .Sh HARDWARE
 192 The following adapters should work:
 193 .Pp
 194 .Bl -column -compact ".Li Ovislink AirLive WL-1120PCM" "CardBus"
 195 .It Em Card Ta Em Bus
 196 .\".It Li "Acer Aspire 1357 LMi" Ta Mini PCI
 197 .\".It Li "Belkin F5D6001 V3" Ta PCI
 198 .It Li "Belkin F5D6020 V3" Ta CardBus
 199 .It Li "Buffalo WLI-CB-B11" Ta CardBus
 200 .It Li "Corega CG-WLCB11V3" Ta CardBus
 201 .\".It Li "D-Link DWL-510" Ta PCI
 202 .\".It Li "D-Link DWL-520 rev D" Ta PCI
 203 .It Li "D-Link DWL-610" Ta CardBus
 204 .\".It Li "Encore ENLWI-PCI1-NT" Ta PCI
 205 .\".It Li "Gigabyte GN-WLMR101" Ta PCI
 206 .It Li "Level-One WPC-0101" Ta CardBus
 207 .It Li "Linksys WPC11 v4" Ta CardBus
 208 .It Li "Netgear MA521" Ta CardBus
 209 .It Li "Ovislink AirLive WL-1120PCM" Ta CardBus
 210 .It Li "Planet WL-3553" Ta CardBus
 211 .It Li "TrendNET TEW-266PC" Ta CardBus
 212 .\".It Li "TrendNET TEW-288PI" Ta PCI
 213 .It Li "VCTnet PC-11B1" Ta CardBus
 214 .El
 215 .Sh EXAMPLES
 216 Refer to the
 217 .Sx EXAMPLES
 218 section of
 219 .Xr wlan 4 .
 220 .Sh SEE ALSO
 221 .Xr arp 4 ,
 222 .Xr cardbus 4 ,
 223 .Xr ifmedia 4 ,
 224 .Xr intro 4 ,
 225 .Xr netintro 4 ,
 226 .Xr pci 4 ,
 227 .Xr wlan 4 ,
 228 .Xr wlan_ratectl 4 ,
 229 .Xr hostapd 8 ,
 230 .Xr ifconfig 8
 231 .Rs
 232 .%T Realtek
 233 .%O http://www.realtek.com.tw
 234 .Re
 235 .Sh HISTORY
 236 The
 237 .Nm
 238 device driver first appeared in
 239 .Nx 3.0
 240 and then in
 241 .Ox 3.7 .
 242 It was imported into
 243 .Dx 1.7 .
 244 .Sh AUTHORS
 245 .An -nosplit
 246 The
 247 .Nm
 248 driver was written by
 249 .An David Young Aq Mt dyoung@NetBSD.org
 250 and ported to
 251 .Ox
 252 by
 253 .An Jonathan Gray Aq Mt jsg@openbsd.org ,
 254 who wrote this man page.
 255 The
 256 .Dx
 257 port was done by
 258 .An Sepherosa Ziehau Aq Mt sepherosa@gmail.com .
 259 .Sh BUGS
 260 Only the Philips SA2400A and Maxim MAX2820 RF transceivers are known to work.
 261 Devices incorporating a GCT RF transceiver are not supported due to a lack of
 262 documentation from GCT.
 263 .Pp
 264 While PCI devices will attach most of them are not able to transmit.