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