xref: /openbsd-src/share/man/man4/rtwn.4 (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1.\" $OpenBSD: rtwn.4,v 1.8 2019/03/29 17:16:35 jmc Exp $
2.\"
3.\" Copyright (c) 2010 Damien Bergamini <damien.bergamini@free.fr>
4.\" Copyright (c) 2015 Stefan Sperling <stsp@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 $Mdocdate: March 29 2019 $
19.Dt RTWN 4
20.Os
21.Sh NAME
22.Nm rtwn
23.Nd Realtek RTL8188CE/RTL8188EE/RTL8192CE/RTL8723AE PCIe IEEE 802.11b/g/n
24wireless network device
25.Sh SYNOPSIS
26.Cd "rtwn* at pci? port ?"
27.Sh DESCRIPTION
28The
29.Nm
30driver supports PCIe wireless network devices based on the Realtek
31RTL8188CE, RTL8188EE, RTL8192CE and RTL8723AE chipsets.
32.Pp
33The RTL8188CE, RTL8188EE and RTL8723AE are highly integrated 802.11n adapters
34that combine a MAC, a 1T1R capable baseband and an RF in a single chip.
35The RTL8723AE also includes a Bluetooth 2.1/3.0/4.0 controller.
36.Pp
37The RTL8192CE is a highly integrated multiple-in, multiple-out (MIMO)
38802.11n adapter that combines a MAC, a 2T2R capable baseband and an
39RF in a single chip.
40.Pp
41These devices operate in the 2GHz spectrum only.
42.Pp
43These are the modes the
44.Nm
45driver can operate in:
46.Bl -tag -width "IBSS-masterXX"
47.It BSS mode
48Also known as
49.Em infrastructure
50mode, this is used when associating with an access point, through
51which all traffic passes.
52This mode is the default.
53.It monitor mode
54In this mode the driver is able to receive packets without
55associating with an access point.
56This disables the internal receive filter and enables the card to
57capture packets from networks which it wouldn't normally have access to,
58or to scan for access points.
59.El
60.Pp
61The
62.Nm
63driver can be configured to use
64Wired Equivalent Privacy (WEP) or
65Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
66WPA is the current encryption standard for wireless networks.
67It is strongly recommended that WEP
68not be used as the sole mechanism
69to secure wireless communication,
70due to serious weaknesses in it.
71.Pp
72The
73.Nm
74driver can be configured at runtime with
75.Xr ifconfig 8
76or on boot with
77.Xr hostname.if 5 .
78.Sh FILES
79The driver needs at least version 1.0 of the following firmware files,
80which are loaded when an interface is brought up:
81.Pp
82.Bl -tag -width Ds -offset indent -compact
83.It Pa /etc/firmware/rtwn-rtl8188efw
84.It Pa /etc/firmware/rtwn-rtl8192cfwU
85.It Pa /etc/firmware/rtwn-rtl8192cfwU_B
86.It Pa /etc/firmware/rtwn-rtl8723fw
87.It Pa /etc/firmware/rtwn-rtl8723fw_B
88.El
89.Pp
90A prepackaged version of the firmware can be installed using
91.Xr fw_update 1 .
92.Sh EXAMPLES
93The following example scans for available networks:
94.Pp
95.Dl # ifconfig rtwn0 scan
96.Pp
97The following
98.Xr hostname.if 5
99example configures rtwn0 to join network
100.Dq mynwid ,
101using WPA key
102.Dq mywpakey ,
103obtaining an IP address using DHCP:
104.Bd -literal -offset indent
105nwid mynwid wpakey mywpakey
106dhcp
107.Ed
108.Sh DIAGNOSTICS
109.Bl -diag
110.It "rtwn0: could not read firmware ..."
111For some reason, the driver was unable to read the microcode file from the
112filesystem.
113The file might be missing or corrupted.
114.It "rtwn0: device timeout"
115A frame dispatched to the hardware for transmission did not complete in time.
116The driver will reset the hardware.
117This should not happen.
118.El
119.Sh SEE ALSO
120.Xr arp 4 ,
121.Xr ifmedia 4 ,
122.Xr intro 4 ,
123.Xr netintro 4 ,
124.Xr pci 4 ,
125.Xr hostname.if 5 ,
126.Xr ifconfig 8
127.Sh HISTORY
128The
129.Nm
130driver first appeared in
131.Ox 5.8 .
132.Sh AUTHORS
133The
134.Nm
135driver was written by
136.An -nosplit
137.An Stefan Sperling Aq Mt stsp@openbsd.org .
138It was based on the
139.Xr urtwn 4
140driver written by
141.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
142.Sh CAVEATS
143The
144.Nm
145driver does not support any of the 802.11n capabilities offered by the
146adapters.
147Additional work is required in
148.Xr ieee80211 9
149before those features can be supported.
150.Pp
151This driver does not support powersave mode.
152