[Midnightbsd-cvs] src [9514] trunk/share/man/man4: update man pages for nic driver update

[laffer1 at midnightbsd.org]

Revision: 9514
          http://svnweb.midnightbsd.org/src/?rev=9514
Author:   laffer1
Date:     2017-08-16 09:39:37 -0400 (Wed, 16 Aug 2017)
Log Message:
-----------
update man pages for nic driver update

Modified Paths:
--------------
    trunk/share/man/man4/em.4
    trunk/share/man/man4/igb.4

Modified: trunk/share/man/man4/em.4
===================================================================
--- trunk/share/man/man4/em.4	2017-08-16 02:02:05 UTC (rev 9513)
+++ trunk/share/man/man4/em.4	2017-08-16 13:39:37 UTC (rev 9514)
@@ -29,9 +29,9 @@
 .\"
 .\" * Other names and brands may be claimed as the property of others.
 .\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/em.4 294958 2016-01-27 22:31:08Z marius $
 .\"
-.Dd May 14, 2010
+.Dd August 16, 2015
 .Dt EM 4
 .Os
 .Sh NAME
@@ -45,6 +45,14 @@
 .Cd "device em"
 .Ed
 .Pp
+Optional multiqueue support is available via the following kernel
+compile options:
+.Bd -ragged -offset indent
+.Cd "options EM_MULTIQUEUE"
+.Ed
+.Pp
+Note:  Activating EM_MULTIQUEUE support is not supported by Intel.
+.Pp
 Alternatively, to load the driver as a
 module at boot time, place the following line in
 .Xr loader.conf 5 :
@@ -197,14 +205,33 @@
 prompt before booting the kernel or stored in
 .Xr loader.conf 5 .
 .Bl -tag -width indent
+.It Va hw.em.disable_crc_stripping
+Disable or enable hardware stripping of CRC field.
+This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC
+causes remote access over IPMI to fail.
+Default 0 (enabled).
+.It Va hw.em.eee_setting
+Disable or enable Energy Efficient Ethernet.
+Default 1 (disabled).
+.It Va hw.em.msix
+Enable or disable MSI-X style interrupts.
+Default 1 (enabled).
+.It Va hw.em.smart_pwr_down
+Enable or disable smart power down features on newer adapters.
+Default 0 (disabled).
+.It Va hw.em.sbp
+Show bad packets when in promiscuous mode.
+Default 0 (off).
 .It Va hw.em.rxd
 Number of receive descriptors allocated by the driver.
-The default value is 256.
+The default value is 1024 for adapters newer than 82547,
+and 256 for older ones.
 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 while others can have up to 4096.
 .It Va hw.em.txd
 Number of transmit descriptors allocated by the driver.
-The default value is 256.
+The default value is 1024 for adapters newer than 82547,
+and 256 for older ones.
 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 while others can have up to 4096.
 .It Va hw.em.rx_int_delay
@@ -226,6 +253,11 @@
 .Va hw.em.tx_int_delay
 is non-zero, this tunable limits the maximum delay in which a transmit
 interrupt is generated.
+.It Va hw.em.num_queues
+Number of hardware queues that will be configured on this adapter (maximum of 2)
+Defaults to 1.
+Only valid with kernel configuration
+.Cd "options EM_MULTIQUEUE".
 .El
 .Sh FILES
 .Bl -tag -width /dev/led/em*
@@ -240,7 +272,6 @@
 Turn the identification LED of em0 off again:
 .Pp
 .Dl "echo 0 > /dev/led/em0"
-.Pp
 .Sh DIAGNOSTICS
 .Bl -diag
 .It "em%d: Unable to allocate bus resource: memory"
@@ -259,7 +290,7 @@
 If an issue is identified with the released source code on the supported kernel
 with a supported adapter, email the specific information related to the
 issue to
-.Aq freebsdnic at mailbox.intel.com .
+.Aq freebsd at intel.com .
 .Sh SEE ALSO
 .Xr altq 4 ,
 .Xr arp 4 ,
@@ -279,10 +310,7 @@
 The
 .Nm
 driver was written by
-.An Intel Corporation Aq freebsdnic at mailbox.intel.com .
+.An Intel Corporation Aq freebsd at intel.com .
 .Sh BUGS
-Hardware-assisted VLAN processing is disabled by default.
-You can enable it on an
-.Nm
-interface using
-.Xr ifconfig 8 .
+.Pp
+Activating EM_MULTIQUEUE support requires MSI-X features.

Modified: trunk/share/man/man4/igb.4
===================================================================
--- trunk/share/man/man4/igb.4	2017-08-16 02:02:05 UTC (rev 9513)
+++ trunk/share/man/man4/igb.4	2017-08-16 13:39:37 UTC (rev 9514)
@@ -29,7 +29,7 @@
 .\"
 .\" * Other names and brands may be claimed as the property of others.
 .\"
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/share/man/man4/igb.4 250371 2013-05-08 16:29:12Z sbruno $
 .\"
 .Dd March 25, 2013
 .Dt IGB 4
@@ -151,11 +151,11 @@
 .Bl -tag -width indent
 .It Va hw.igb.rxd
 Number of receive descriptors allocated by the driver.
-The default value is 256.
+The default value is 1024.
 The minimum is 80, and the maximum is 4096.
 .It Va hw.igb.txd
 Number of transmit descriptors allocated by the driver.
-The default value is 256.
+The default value is 1024.
 The minimum is 80, and the maximum is 4096.
 .It Va hw.igb.enable_aim
 If set to 1, enable Adaptive Interrupt Moderation.
@@ -187,7 +187,6 @@
 Turn the identification LED of igb0 off again:
 .Pp
 .Dl "echo 0 > /dev/led/igb0"
-.Pp
 .Sh DIAGNOSTICS
 .Bl -diag
 .It "igb%d: Unable to allocate bus resource: memory"
@@ -206,7 +205,7 @@
 If an issue is identified with the released source code on the supported kernel
 with a supported adapter, email the specific information related to the
 issue to
-.Aq freebsdnic at mailbox.intel.com .
+.Aq freebsd at intel.com .
 .Sh SEE ALSO
 .Xr altq 4 ,
 .Xr arp 4 ,
@@ -226,4 +225,4 @@
 The
 .Nm
 driver was written by
-.An Intel Corporation Aq freebsdnic at mailbox.intel.com .
+.An Intel Corporation Aq freebsd at intel.com .