From 75881c8882f3713bbca57b2d18c1154138ed133b Mon Sep 17 00:00:00 2001 From: stsp Date: Thu, 4 Jun 2015 22:29:31 +0000 Subject: [PATCH] man page for rtwn(4) --- share/man/man4/Makefile | 4 +- share/man/man4/rtwn.4 | 140 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 142 insertions(+), 2 deletions(-) create mode 100644 share/man/man4/rtwn.4 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 4c6a83d82e4..ff630506f83 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.593 2015/04/16 08:56:53 mpi Exp $ +# $OpenBSD: Makefile,v 1.594 2015/06/04 22:29:31 stsp Exp $ MAN= aac.4 ac97.4 acphy.4 \ acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \ @@ -47,7 +47,7 @@ MAN= aac.4 ac97.4 acphy.4 \ qla.4 qle.4 qlw.4 qsphy.4 radio.4 \ ral.4 random.4 rdomain.4 rd.4 rdac.4 re.4 rdcphy.4 rgephy.4 ricohrtc.4 \ rl.4 rlphy.4 route.4 rsu.4 rt.4 rtsx.4 rum.4 run.4 \ - rtfps.4 rtii.4 rtw.4 safe.4 safte.4 sbus.4 schsio.4 \ + rtfps.4 rtii.4 rtw.4 rtwn.4 safe.4 safte.4 sbus.4 schsio.4 \ scsi.4 sd.4 \ sdmmc.4 sdhc.4 se.4 ses.4 \ sf.4 sf2r.4 sfr.4 sili.4 siop.4 sis.4 sk.4 sli.4 \ diff --git a/share/man/man4/rtwn.4 b/share/man/man4/rtwn.4 new file mode 100644 index 00000000000..17efe6c5927 --- /dev/null +++ b/share/man/man4/rtwn.4 @@ -0,0 +1,140 @@ +.\" $OpenBSD: rtwn.4,v 1.1 2015/06/04 22:29:31 stsp Exp $ +.\" +.\" Copyright (c) 2010 Damien Bergamini +.\" Copyright (c) 2015 Stefan Sperling +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: June 4 2015 $ +.Dt RTWN 4 +.Os +.Sh NAME +.Nm rtwn +.Nd Realtek RTL8188CE PCIe IEEE 802.11b/g/n wireless network device +.Sh SYNOPSIS +.Cd "rtwn* at pci? port ?" +.Sh DESCRIPTION +The +.Nm +driver supports PCIe wireless network devices based on the Realtek +RTL8188CE chipset. +.Pp +The RTL8188CE is a highly integrated 802.11n adapter that combines a MAC, +a 1T1R capable baseband and an RF in a single chip. +It operates in the 2GHz spectrum only. +.Pp +These are the modes the +.Nm +driver can operate in: +.Bl -tag -width "IBSS-masterXX" +.It BSS mode +Also known as +.Em infrastructure +mode, this is used when associating with an access point, through +which all traffic passes. +This mode is the default. +.It monitor mode +In this mode the driver is able to receive packets without +associating with an access point. +This disables the internal receive filter and enables the card to +capture packets from networks which it wouldn't normally have access to, +or to scan for access points. +.El +.Pp +The +.Nm +driver can be configured to use +Wired Equivalent Privacy (WEP) or +Wi-Fi Protected Access (WPA-PSK and WPA2-PSK). +WPA is the current encryption standard for wireless networks. +It is strongly recommended that WEP +not be used as the sole mechanism +to secure wireless communication, +due to serious weaknesses in it. +.Pp +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 +or on boot with +.Xr hostname.if 5 . +.Sh FILES +The driver needs at least version 1.0 of the following firmware files, +which are loaded when an interface is attached: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It /etc/firmware/rtwn-rtl8192cfwU +.It /etc/firmware/rtwn-rtl8192cfwU_B +.El +.Pp +A prepackaged version of the firmware can be installed using +.Xr fw_update 1 . +.Sh EXAMPLES +The following example scans for available networks: +.Pp +.Dl # ifconfig rtwn0 scan +.Pp +The following +.Xr hostname.if 5 +example configures rtwn0 to join network +.Dq mynwid , +using WPA key +.Dq mywpakey , +obtaining an IP address using DHCP: +.Bd -literal -offset indent +nwid mynwid +wpakey mywpakey +dhcp +.Ed +.Sh DIAGNOSTICS +.Bl -diag +.It "rtwn0: could not read firmware ..." +For some reason, the driver was unable to read the microcode file from the +filesystem. +The file might be missing or corrupted. +.It "rtwn0: device timeout" +A frame dispatched to the hardware for transmission did not complete in time. +The driver will reset the hardware. +This should not happen. +.El +.Sh SEE ALSO +.Xr arp 4 , +.Xr ifmedia 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr pci 4 , +.Xr hostname.if 5 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 5.8 . +.Sh AUTHORS +The +.Nm +driver was written by +.An -nosplit +.An Stefan Sperling Aq Mt stsp@openbsd.org . +It was based on the +.Xr urtwn 4 +driver written by +.An Damien Bergamini Aq Mt damien.bergamini@free.fr . +.Sh CAVEATS +The +.Nm +driver does not support any of the 802.11n capabilities offered by the +adapters. +Additional work is required in +.Xr ieee80211 9 +before those features can be supported. -- 2.20.1