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