From 877e16841b5b9c7a4e5e6549cacd7cc347f41ec0 Mon Sep 17 00:00:00 2001 From: Sepherosa Ziehau Date: Thu, 26 Nov 2015 09:38:29 +0800 Subject: [PATCH] ix.4: ixX -> ixY and dev.ix.X -> dev.ix.Y --- share/man/man4/ix.4 | 54 +++++++++++++++++++-------------------------- 1 file changed, 23 insertions(+), 31 deletions(-) diff --git a/share/man/man4/ix.4 b/share/man/man4/ix.4 index bd8234baa9..581778aa37 100644 --- a/share/man/man4/ix.4 +++ b/share/man/man4/ix.4 @@ -31,7 +31,7 @@ .\" .\" $FreeBSD: src/share/man/man4/ixgbe.4,v 1.2 2008/06/17 21:14:02 brueffer Exp $ .\" -.Dd November 28, 2014 +.Dd November 26, 2015 .Dt IX 4 .Os .Sh NAME @@ -172,36 +172,36 @@ Tunables can be set at the .Xr loader 8 prompt before booting the kernel or stored in .Xr loader.conf 5 . -.Em X +.Em Y is the device unit number. -.Bl -tag -width ".Va hw.ixX.unsupported_sfp" -.It Va hw.ix.rxd Va hw.ixX.rxd +.Bl -tag -width ".Va hw.ixY.unsupported_sfp" +.It Va hw.ix.rxd Va hw.ixY.rxd Number of receive descriptors allocated by the driver. The default value is 2048. The minimum is 64, and the maximum is 4096. -.It Va hw.ix.txd Va hw.ixX.txd +.It Va hw.ix.txd Va hw.ixY.txd Number of transmit descriptors allocated by the driver. The default value is 2048. The minimum is 64, and the maximum is 4096. -.It Va hw.ix.rxr Va hw.ixX.rxr +.It Va hw.ix.rxr Va hw.ixY.rxr This tunable specifies the number of reception queues could be enabled. Maximum allowed value for these tunables is device specific and it must be power of 2 aligned. Setting these tunables to 0 allows the driver to make as many reception queues ready-for-use as allowed by the number of CPUs. -.It Va hw.ix.txr Va hw.ixX.txr +.It Va hw.ix.txr Va hw.ixY.txr This tunable specifies the number of transmission queues could be enabled. Maximum allowed value for these tunables is device specific and it must be power of 2 aligned. Setting these tunables to 0 allows the driver to make as many transmission queues ready-for-use as allowed by the number of CPUs. -.It Va hw.ix.msix.enable Va hw.ixX.msix.enable +.It Va hw.ix.msix.enable Va hw.ixY.msix.enable By default, the driver will use MSI-X if it is supported. This behaviour can be turned off by setting this tunable to 0. -.It Va hw.ix.msix.agg_rxtx Va hw.ixX.msix.agg_rxtx +.It Va hw.ix.msix.agg_rxtx Va hw.ixY.msix.agg_rxtx If MSI-X is used, the driver aggregates transmission queue and reception queue processing by default. @@ -211,7 +211,7 @@ put transmission queue processing and reception queue processing onto independent MSI-X vector, then transmission queue and reception queue processing are always aggregated. -.It Va hw.ixX.msix.off +.It Va hw.ixY.msix.off If MSI-X is used, and transmission queue and reception queue processing are aggregated, this tunable specifies the leading target CPU for @@ -220,13 +220,13 @@ The value specificed must be aligned to the maximum of the number of reception queues and the number of transmission queues enabled, and must be less than the power of 2 number of CPUs. -.It Va hw.ixX.msix.rxoff +.It Va hw.ixY.msix.rxoff If MSI-X is used, and transmission queue and reception queue processing are not aggregated, this tunable specifies the leading target CPU for reception queues processing. The value specificed must be aligned to the number of reception queues enabled and must be less than the power of 2 number of CPUs. -.It Va hw.ixX.msix.txoff +.It Va hw.ixY.msix.txoff If MSI-X is used, and transmission queue and reception queue processing are not aggregated, this tunable specifies the leading target CPU @@ -234,21 +234,21 @@ for transmission queues processing. The value specificed must be aligned to the number of transmission queues enabled and must be less than the power of 2 number of CPUs. -.It Va hw.ix.msi.enable Va hw.ixX.msi.enable +.It Va hw.ix.msi.enable Va hw.ixY.msi.enable If MSI-X is disabled and MSI is supported, the driver will use MSI. This behavior can be turned off by setting this tunable to 0. -.It Va hw.ixX.msi.cpu +.It Va hw.ixY.msi.cpu If MSI is used, it specifies the MSI's target CPU. -.It Va hw.ixX.npoll.txoff +.It Va hw.ixY.npoll.txoff This tunable specifies the leading target CPU for transmission queue .Xr polling 4 processing. The value specificed must be aligned to the number of transmission queues enabled and must be less than the power of 2 number of CPUs. -.It Va hw.ixX.npoll.rxoff +.It Va hw.ixY.npoll.rxoff This tunable specifies the leading target CPU for reception queue .Xr polling 4 @@ -262,7 +262,7 @@ This behavior can be changed by setting this tunable to 1. .El .Sh MIB Variables A number of per-interface variables are implemented in the -.Va dev.ix. Ns Em X +.Va dev.ix. Ns Em Y branch of the .Xr sysctl 3 MIB. @@ -272,7 +272,7 @@ Number of reception queues could be enabled (read-only). Use the tunable .Va hw.ix.rxr or -.Va hw.ixX.rxr +.Va hw.ixY.rxr to configure it. .It Va rxr_inuse Number of reception queues being used (read-only). @@ -281,7 +281,7 @@ Number of transmission queues could be enabled (read-only). Use the tunable .Va hw.ix.txr or -.Va hw.ixX.txr +.Va hw.ixY.txr to configure it. .It Va txr_inuse Number of transmission queues being used (read-only). @@ -290,14 +290,14 @@ Number of descriptors per reception queue (read-only). Use the tunable .Va hw.ix.rxd or -.Va hw.ixX.rxd +.Va hw.ixY.rxd to configure it. .It Va txd Number of descriptors per transmission queue (read-only). Use the tunable .Va hw.ix.txd or -.Va hw.ixX.txd +.Va hw.ixY.txd to configure it. .It Va rxtx_intr_rate If MSI or legacy interrupt is used, @@ -348,24 +348,16 @@ due to the frequent hardware register writing. The default value is 32. .It Va npoll_rxoff See the tunable -.Va hw.ixX.npoll.rxoff . +.Va hw.ixY.npoll.rxoff . The set value will take effect the next time .Xr polling 4 is enabled on the device. .It Va npoll_txoff See the tunable -.Va hw.ixX.npoll.txoff . +.Va hw.ixY.npoll.txoff . The set value will take effect the next time .Xr polling 4 is enabled on the device. -.It Va flowctrl -Flow control setting. -Set it to 0 to turn off flow control. -Set it to 1 to enable only the reception of pause frames. -Set it to 2 to enable only the generation of pause frames. -Set it to 3 to enable both the reception of pause frames -and generation of pause frames, -i.e. full flow control. .El .Sh SEE ALSO .Xr altq 4 , -- 2.41.0