Rewrite qede(7D) in mdoc

2 files changed, 108 insertions, 157 deletions

diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile
index 368319657a..baf6e5d23a 100644
--- a/usr/src/man/man7d/Makefile
+++ b/usr/src/man/man7d/Makefile
@@ -103,6 +103,7 @@ _MANFILES=	aac.7d		\
 		ptm.7d		\
 		pts.7d		\
 		pty.7d		\
+		qede.7d		\
 		qlc.7d		\
 		ramdisk.7d	\
 		random.7d	\
diff --git a/usr/src/man/man7d/qede.7d b/usr/src/man/man7d/qede.7d
index 32ae6df02f..235d1c7543 100644
--- a/usr/src/man/man7d/qede.7d
+++ b/usr/src/man/man7d/qede.7d
@@ -1,119 +1,108 @@
-<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
-<!--ArborText, Inc., 1988-1997, v.4001-->
-<!ENTITY % commonents SYSTEM "smancommon.ent">
-%commonents;
-<!ENTITY % booktitles SYSTEM "booktitles.ent">
-%booktitles;
-]>
-
-<refentry id="qede-7d">
-
-<refmeta>
-<refentrytitle>qede</refentrytitle>
-<manvolnum>7D</manvolnum>
-<refmiscinfo class="date">03 January 2012</refmiscinfo>
-<refmiscinfo class="sectdesc">&man7d;</refmiscinfo>
-<refmiscinfo class="software">&release;</refmiscinfo>
-<refmiscinfo class="arch">generic</refmiscinfo>
-<refmiscinfo class="copyright">Copyright (C) 2014 QLogic Corporation. All Rights Reserved</refmiscinfo>
-</refmeta>
-
-<refnamediv>
-<refname>qede</refname>
-<refpurpose>QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet Driver</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
-<title>&synp-tt;</title>
-<synopsis><literal>/dev/qede*</literal></synopsis>
-</refsynopsisdiv>
-
-<refsect1>
-
-<title>&desc-tt;</title>
-
-<indexterm significance="normal" id="qede-7d-indx-1">
-<primary sortas="qede">qede &mdash; qede Ethernet device driver</primary>
-</indexterm>
-<indexterm significance="normal" id="qede-7d-indx-2">
-<primary sortas="sunw,qede device driver">qede Ethernet device driver &mdash; qede</primary>
-</indexterm>
-
-<para>
-The <literal>qede</literal> Ethernet driver is a multi-threaded, loadable,
-clonable, GLDv3-based driver supporting the Data Link Provider Interface,
-<olink targetdocent="REFMAN7" localinfo="dlpi-7p"><citerefentry><refentrytitle>dlpi</refentrytitle><manvolnum>7P</manvolnum></citerefentry></olink>,
-over QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet controllers.  Multiple QLogic 
-FastLinQ controllers installed within the system are supported by the driver.
-</para>
-
-<para>
-The <literal>qede</literal> driver provides support for the QLogic QL45xxx
-line of devices. Functions include chip initialization, frame
-transmit and receive, multicast and promiscuous support, error recovery and
-reporting. These devices provide 10000/25000/40000/50000/100000 Mbps networking
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source.  A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright (c) 2014 QLogic Corporation. All Rights Reserved
+.\"
+.Dd August 28, 2017
+.Dt QEDE 7D
+.Os
+.Sh NAME
+.Nm qede
+.Nd QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet Driver
+.Sh SYNOPSIS
+.Pa /dev/net/qede*
+.Sh DESCRIPTION
+The
+.Nm
+Ethernet driver is a multi-threaded, loadable, clonable, GLDv3-based
+driver supporting the Data Link Provider Interface,
+.Xr dlpi 7P ,
+over QLogic FastLinQ QL45xxx 10/25/40/50/100 Gigabit Ethernet
+controllers.
+Multiple QLogic FastLinQ controllers installed within the system are
+supported by the driver.
+.Pp
+The
+.Nm
+driver provides support for the QLogic QL45xxx line of devices.
+Functions include chip initialization, frame transmit and receive,
+multicast and promiscuous support, error recovery and reporting.
+These devices provide 10000/25000/40000/50000/100000 Mbps networking
 interfaces.
-</para>
-
-</refsect1>
-
-<refsect1>
-
-<title>DRIVER CONFIGURATION</title>
-
-<para>
+.Sh DRIVER CONFIGURATION
 The primary methods of configuration are via modification of the
-<literal>/kernel/drv/qede.conf</literal> file or execution of the
-<olink targetdocent="REFMAN1" localinfo="dladm-1m"><citerefentry><refentrytitle>dladm</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>
-utility. There are many configuration items available and all are thoroughly
-documented in the <literal>/kernel/drv/qede.conf</literal> file. Note that for
-changes to this file to take affect the driver must be reloaded or the system
-rebooted. In order to reload the driver with new configuration changes all
-<literal>qede</literal> interfaces must be first unplumbed and then the
-<olink targetdocent="REFMAN1" localinfo="update_drv-1m"><citerefentry><refentrytitle>update_drv</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>
-tool must be executed. For the configuration items that do not require a
-driver reload the
-<olink targetdocent="REFMAN1" localinfo="dladm-1m"><citerefentry><refentrytitle>dladm</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>
+.Pa /kernel/drv/qede.conf
+file or execution of the
+.Xr dladm 1M
+utility.
+There are many configuration items available and all are thoroughly
+documented in the
+.Pa /kernel/drv/qede.conf
+file.
+Note that for changes to this file to take affect the driver must be
+reloaded or the system rebooted.
+In order to reload the driver with new configuration changes all
+.Nm qede
+interfaces must be first unplumbed and then the
+.Xr update_drv 1M
+tool must be executed.
+For the configuration items that do not require a driver reload the
+.Xr dladm 1M
 tool can be used to dynamically change the option.
-</para>
-
-</refsect1>
-
-<refsect1>
-
-<title>DEBUGGING</title>
-
-<refsect2>
-<title>kstat</title>
-<para>
-There are many statistics exposed via <literal>kstat</literal> by
-<literal>qede</literal>.  The main groups are:
-<literal>'intr'</literal> for interrupts stats,
-<literal>'l2chip'</literal> for layer 2 chip stats,
-<literal>'l2driver'</literal> for layer 2 driver stats,
-<literal>'l2stats'</literal> for general layer 2 stats,
-<literal>'link'</literal> for detailed link status,
-<literal>'mac'</literal> for GLDv3 MAC layer stats,
-<literal>'rxq#'</literal> for Rx ring stats,
-<literal>'txq#'</literal> for Tx ring stats, and
-<literal>'stats'</literal> for general driver stats and version info.
-</para>
-<para>
+Use of
+.Xr dladm 1M
+is the preferred method.
+.Sh DEBUGGING
+.Ss kstat
+There are many statistics exposed via
+.Xr kstat 1M
+by the
+.Nm
+driver.
+The main groups are:
+.Bl -tag -width Em
+.It Em intr
+for interrupts stats
+.It Em l2chip
+for layer 2 chip stats
+.It Em l2driver
+for layer 2 driver stats
+.It Em l2stats
+for general layer 2 stats
+.It Em link
+for detailed link status
+.It Em mac
+for GLDv3 MAC layer stats
+.It Em rxq#
+for Rx ring stats
+.It Em txq#
+for Tx ring stats
+.It Em stats
+for general driver stats and version info.
+.El
+.Pp
 To get a list of all the individual statistics in these goups run:
-<literallayout>
-% kstat -m qede -i 0 -l
-</literallayout>
-</refsect2>
-
-<refsect2>
-<title>kmdb</title>
-<para>
-There is an MDB module for qede that offers a much deeper level of debugging
-information in comparison to kstat.  Depending on how
-<olink targetdocent="REFMAN1" localinfo="kmdb-1"><citerefentry><refentrytitle>kmdb</refentrytitle><manvolnum>1</manvolnum></citerefentry></olink>
-is initiated the qede module might or might not be automatically loaded.  If
-not then is must be loaded manually.
-<literallayout>
+.Bd -literal -offset indent
+# kstat -m qede -i 0 -l
+.Ed
+.Ss mdb
+There is an MDB module for
+.Nm
+that offers a much deeper level of debugging information in comparison
+to kstat.
+Depending on how
+.Xr mdb 1
+is initiated the qede module might or might not be automatically loaded.
+If not then is must be loaded manually.
+.Bd -literal -offset indent
 > ::load /kernel/kmdb/amd64/qede
 > ::help qede
 
@@ -131,48 +120,9 @@ DESCRIPTION
   -r      interrupt status
   -l      mutex locks status
   -c #    status for chain # (-1 for all chains)
-</literallayout>
-</para>
-</refsect2>
-
-</refsect1>
-
-<refsect1>
-
-<title>&file-tt;</title>
-
-<variablelist termlength="medium">
-<varlistentry><term><filename>/dev/qede[instance]</filename></term><listitem><para><literal>qede</literal> Character special device</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/drv/qede.conf</filename></term><listitem><para>Driver configuration file.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/drv/qede</filename></term><listitem><para>32-bit i386 driver binary.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/drv/amd64/qede</filename></term><listitem><para>64-bit i386 driver binary.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/drv/sparcv9/qede</filename></term><listitem><para>SPARC driver binary.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/kmdb/qede</filename></term><listitem><para>32-bit i386 debugger module.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/kmdb/amd64/qede</filename></term><listitem><para>64-bit i386 debugger module.</para></listitem></varlistentry>
-<varlistentry><term><filename>/kernel/kmdb/sparcv9/qede</filename></term><listitem><para>SPARC debugger module.</para></listitem></varlistentry>
-<varlistentry><term><filename>release.txt</filename></term><listitem><para>Revision history of the driver.</para></listitem></varlistentry>
-<varlistentry><term><filename>readme.txt</filename></term><listitem><para>README guide for the driver.</para></listitem></varlistentry>
-</variablelist>
-
-</refsect1>
-
-<refsect1>
-
-<title>&also-tt;</title>
-
-<para>
-<olink targetdocent="REFMAN1M" localinfo="dladm-1m"><citerefentry><refentrytitle>dladm</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>,
-<olink targetdocent="REFMAN1M" localinfo="netstat-1m"><citerefentry><refentrytitle>netstat</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>,
-<olink targetdocent="REFMAN1M" localinfo="ifconfig-1m"><citerefentry><refentrytitle>ifconfig</refentrytitle><manvolnum>1M</manvolnum></citerefentry></olink>,
-<olink targetdocent="REFMAN4" localinfo="driver.conf-4"><citerefentry><refentrytitle>driver.conf</refentrytitle><manvolnum>4</manvolnum></citerefentry></olink>,
-<olink targetdocent="REFMAN7" localinfo="gld-7p"><citerefentry><refentrytitle>gld</refentrytitle><manvolnum>7P</manvolnum></citerefentry></olink>,
-<olink targetdocent="REFMAN7" localinfo="brcmdcbxinfo-7d"><citerefentry><refentrytitle>brcmdcbxinfo</refentrytitle><manvolnum>7D</manvolnum></citerefentry></olink>
-</para>
-<para><citetitle>QLogic QL45xxx 10/25/40/50/100 Gigabit Adapter Driver Installation Notes</citetitle></para>
-<para><citetitle>Writing Device Drivers</citetitle></para>
-<para><citetitle>STREAMS Programming Guide</citetitle></para>
-<para><citetitle>Network Interfaces Guide</citetitle></para>
-</refsect1>
-
-</refentry>
-
+.Ed
+.Sh SEE ALSO
+.Xr dladm 1M ,
+.Xr ifconfig 1M ,
+.Xr driver.conf 4 ,
+.Xr dlpi 7P