Add a manual page for iwm(4).

2 files changed, 146 insertions, 3 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 66169494b80..e0027797574 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.590 2015/02/05 09:40:33 phessler Exp $
+#	$OpenBSD: Makefile,v 1.591 2015/02/06 20:19:26 stsp Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -29,8 +29,8 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	ichiic.4 ichwdt.4 icmp.4 icmp6.4 icsphy.4 ifmedia.4 \
 	iha.4 iic.4 inet.4 inet6.4 inphy.4 iophy.4 \
 	ip.4 ip6.4 ipcomp.4 ipgphy.4 ipmi.4 ips.4 ipsec.4 ipw.4 \
-	isa.4 isagpio.4 isapnp.4 isp.4 it.4 itherm.4 iwi.4 iwn.4 ix.4 ixgb.4 \
-	jmb.4 jme.4 jmphy.4 \
+	isa.4 isagpio.4 isapnp.4 isp.4 it.4 itherm.4 iwi.4 iwn.4 iwm.4 \
+	ix.4 ixgb.4 jmb.4 jme.4 jmphy.4 \
 	kate.4 km.4 ksyms.4 kue.4 lc.4 lge.4 lii.4 lisa.4 lm.4 \
 	lmc.4 lmenv.4 lmn.4 lmtemp.4 lo.4 lpt.4 lxtphy.4 luphy.4 \
 	maestro.4 mainbus.4 malo.4 maxds.4 maxtmp.4 mbg.4 midi.4 mii.4 mfi.4 \
diff --git a/share/man/man4/iwm.4 b/share/man/man4/iwm.4
new file mode 100644
index 00000000000..a8abce439de
--- /dev/null
+++ b/share/man/man4/iwm.4
@@ -0,0 +1,143 @@
+.\" $OpenBSD: iwm.4,v 1.1 2015/02/06 20:19:26 stsp Exp $
+.\"
+.\" Copyright (c) 2007,2008
+.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
+.\"
+.\" 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: February 6 2015 $
+.Dt IWM 4
+.Os
+.Sh NAME
+.Nm iwm
+.Nd Intel 7200 IEEE 802.11a/ac/g/n wireless network devices
+.Sh SYNOPSIS
+.Cd "iwn* at pci?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for
+.Tn Intel
+Wireless 7260 PCIe Mini Card network adapters.
+.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 5.6 of the following firmware files,
+which are loaded when an interface is brought up:
+.Pp
+.Bl -tag -width Ds -offset indent -compact
+.\".It Pa /etc/firmware/iwm-3160-9   
+.It Pa /etc/firmware/iwm-7260-9
+.\".It Pa /etc/firmware/iwm-7265-9
+.El
+.Pp
+These firmware files are not free because Intel refuses to grant
+distribution rights without contractual obligations.
+As a result, even though
+.Ox
+includes the driver, the firmware files cannot be included and
+users have to download these files on their own.
+.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 iwm0 scan
+.Pp
+The following
+.Xr hostname.if 5
+example configures iwm0 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 "iwm0: 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.
+.\" .It "iwm0: fatal firmware error"
+.\" For some reason, the firmware crashed.
+.\" The driver will reset the hardware.
+.\" This should not happen.
+.\" .It "iwm0: radio is disabled by hardware switch"
+.\" The radio transmitter is off and thus no packet can go out.
+.\" The driver will reset the hardware.
+.\" Make sure the laptop radio switch is on.
+.It "iwm0: could not read firmware ..."
+For some reason, the driver was unable to read the firmware image from the
+filesystem.
+The file might be missing or corrupted.
+.\" .It "iwm0: firmware file too short: N bytes"
+.\" The firmware image is corrupted and can't be loaded into the adapter.
+.\" .It "iwm0: could not load firmware"
+.\" An attempt to load the firmware into the adapter failed.
+.\" The driver will reset the hardware.
+.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 CAVEATS
+The
+.Nm
+driver does not support any of the 802.11n and 802.11ac capabilities offered by
+the adapters.
+Additional work is required in
+.Xr ieee80211 9
+before those features can be supported.