[src/trunk]: src now that Jared fixed ena(4) to work, add manpage for it; ada...

[jdolecek <jdolecek%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/0b28619a5a1d
branches:  trunk
changeset: 446345:0b28619a5a1d
user:      jdolecek <jdolecek%NetBSD.org@localhost>
date:      Sat Dec 01 11:17:28 2018 +0000

description:
now that Jared fixed ena(4) to work, add manpage for it; adapted from FreeBSD

diffstat:

 distrib/sets/lists/man/mi |    5 +-
 share/man/man4/Makefile   |    4 +-
 share/man/man4/ena.4      |  104 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 110 insertions(+), 3 deletions(-)

diffs (159 lines):

diff -r f18c45e43805 -r 0b28619a5a1d distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Sat Dec 01 08:03:44 2018 +0000
+++ b/distrib/sets/lists/man/mi Sat Dec 01 11:17:28 2018 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1628 2018/11/24 18:37:50 bouyer Exp $
+# $NetBSD: mi,v 1.1629 2018/12/01 11:17:28 jdolecek Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -1058,6 +1058,7 @@
 ./usr/share/man/cat4/emips/intro.0             man-sys-catman          .cat
 ./usr/share/man/cat4/emuxki.0                  man-sys-catman          .cat
 ./usr/share/man/cat4/en.0                      man-obsolete            obsolete
+./usr/share/man/cat4/ena.0                     man-sys-catman          .cat
 ./usr/share/man/cat4/envsys.0                  man-sys-catman          .cat
 ./usr/share/man/cat4/ep.0                      man-sys-catman          .cat
 ./usr/share/man/cat4/epic.0                    man-sys-catman          .cat
@@ -4211,6 +4212,7 @@
 ./usr/share/man/html4/emips/intro.html         man-sys-htmlman         html
 ./usr/share/man/html4/emuxki.html              man-sys-htmlman         html
 ./usr/share/man/html4/en.html                  man-obsolete            obsolete
+./usr/share/man/html4/ena.html                 man-sys-htmlman         html
 ./usr/share/man/html4/envsys.html              man-sys-htmlman         html
 ./usr/share/man/html4/ep.html                  man-sys-htmlman         html
 ./usr/share/man/html4/epic.html                        man-sys-htmlman         html
@@ -7136,6 +7138,7 @@
 ./usr/share/man/man4/emips/intro.4             man-sys-man             .man
 ./usr/share/man/man4/emuxki.4                  man-sys-man             .man
 ./usr/share/man/man4/en.4                      man-obsolete            obsolete
+./usr/share/man/man4/ena.4                     man-sys-man             .man
 ./usr/share/man/man4/envsys.4                  man-sys-man             .man
 ./usr/share/man/man4/ep.4                      man-sys-man             .man
 ./usr/share/man/man4/epic.4                    man-sys-man             .man
diff -r f18c45e43805 -r 0b28619a5a1d share/man/man4/Makefile
--- a/share/man/man4/Makefile   Sat Dec 01 08:03:44 2018 +0000
+++ b/share/man/man4/Makefile   Sat Dec 01 11:17:28 2018 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.673 2018/11/24 18:37:50 bouyer Exp $
+#      $NetBSD: Makefile,v 1.674 2018/12/01 11:17:28 jdolecek Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -21,7 +21,7 @@
        com.4 coram.4 crypto.4 cs80bus.4 cuda.4 cypide.4 cxdtv.4 \
        ddb.4 ddc.4 de.4 dge.4 dk.4 dm.4 dmoverio.4 \
        dmphy.4 dpt.4 dpti.4 drm.4 drum.4 drvctl.4 dtv.4 dtviic.4 dwctwo.4 \
-       eap.4 ebus.4 edc.4 elmc.4 emuxki.4 envsys.4 ep.4 esh.4 \
+       eap.4 ebus.4 edc.4 elmc.4 emuxki.4 ena.4 envsys.4 ep.4 esh.4 \
        esa.4 esiop.4 esm.4 eso.4 et.4 etphy.4 exphy.4 \
        fd.4 filemon.4 finsio.4 flash.4 fpa.4 fms.4 fss.4 \
        fujbp.4 full.4 fxp.4 \
diff -r f18c45e43805 -r 0b28619a5a1d share/man/man4/ena.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/ena.4      Sat Dec 01 11:17:28 2018 +0000
@@ -0,0 +1,104 @@
+.\" Copyright (c) 2015-2017 Amazon.com, Inc. or its affiliates.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.\" $NetBSD: ena.4,v 1.1 2018/12/01 11:17:28 jdolecek Exp $
+.\"
+.Dd December 1, 2018
+.Dt ENA 4
+.Os
+.Sh NAME
+.Nm ena
+.Nd "NetBSD kernel driver for Elastic Network Adapter (ENA) family"
+.Sh SYNOPSIS
+.Cd "ena* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The ENA is a networking interface designed to make good use of modern CPU
+features and system architectures.
+.Pp
+The ENA device exposes a lightweight management interface with a
+minimal set of memory mapped registers and extendable command set
+through an Admin Queue.
+.Pp
+The driver supports a range of ENA devices, is link-speed independent
+(i.e., the same driver is used for 10GbE, 25GbE, 40GbE, etc.), and has
+a negotiated and extendable feature set.
+.Pp
+Some ENA devices support SR-IOV. This driver is used for both the
+SR-IOV Physical Function (PF) and Virtual Function (VF) devices.
+.Pp
+The ENA devices enable high speed and low overhead network traffic
+processing by providing multiple Tx/Rx queue pairs (the maximum number
+is advertised by the device via the Admin Queue), a dedicated MSI-X
+interrupt vector per Tx/Rx queue pair, and CPU cacheline optimized
+data placement.
+.Pp
+The
+.Nm
+driver supports industry standard TCP/IP offload features such
+as checksum offload and TCP transmit segmentation offload (TSO).
+Receive-side scaling (RSS) is supported for multi-core scaling.
+.Pp
+The
+.Nm
+driver and its corresponding devices implement health
+monitoring mechanisms such as watchdog, enabling the device and driver
+to recover in a manner transparent to the application, as well as
+debug logs.
+.Pp
+Some of the ENA devices support a working mode called Low-latency
+Queue (LLQ), which saves several more microseconds. This feature might
+be implemented for driver in future releases.
+.Sh HARDWARE
+Supported PCI vendor ID/device IDs:
+.Pp
+.Bl -bullet -compact
+.It
+1d0f:0ec2 - ENA PF
+.It
+1d0f:1ec2 - ENA PF with LLQ support
+.It
+1d0f:ec20 - ENA VF
+.It
+1d0f:ec21 - ENA VF with LLQ support
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr netintro 4 ,
+.Xr pci 4 ,
+.Xr ifconfig 8
+.Sh AUTHORS
+The
+.Nm
+driver was originally written by
+.An Semihalf
+for
+.Fx .
+The driver was ported to
+.Nx
+by
+.An Jared D. McNeill Aq Mt jmcneill%NetBSD.org@localhost .