diff mbox series

doc: describe ixgbe devargs fiber_sdp3_no_tx_disable

Message ID 20220427142040.24897-1-jeffd@silicom-usa.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers
Series doc: describe ixgbe devargs fiber_sdp3_no_tx_disable |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Jeff Daly April 27, 2022, 2:20 p.m. UTC 
  The devargs option for the IXGBE driver is introduced in order to
inform the driver to skip checking SDP3 as an indicator of laser
enable/disable for SFP modules.

Signed-off-by: Jeff Daly <jeffd@silicom-usa.com>
---
 doc/guides/nics/ixgbe.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Qi Zhang April 29, 2022, 2:59 a.m. UTC | #1 
> -----Original Message-----
> From: Jeff Daly <jeffd@silicom-usa.com>
> Sent: Wednesday, April 27, 2022 10:21 PM
> To: Wang, Haiyue <haiyue.wang@intel.com>
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: describe ixgbe devargs fiber_sdp3_no_tx_disable
> 
> The devargs option for the IXGBE driver is introduced in order to inform the
> driver to skip checking SDP3 as an indicator of laser enable/disable for SFP
> modules.
> 
> Signed-off-by: Jeff Daly <jeffd@silicom-usa.com>
> ---
>  doc/guides/nics/ixgbe.rst | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst index
> 82fa453fa28e..ad1a3da6101e 100644
> --- a/doc/guides/nics/ixgbe.rst
> +++ b/doc/guides/nics/ixgbe.rst
> @@ -101,6 +101,23 @@ To guarantee the constraint, capabilities in
> dev_conf.rxmode.offloads will be ch
> 
>  fdir_conf->mode will also be checked.
> 
> +Disable SDP3 TX_DISABLE for Fiber Links
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +The following ``devargs`` option can be enabled at runtime.  It must be
> +passed as part of EAL arguments. For example,
> +
> +.. code-block:: console
> +
> +   dpdk-testpmd -a fiber_sdp3_no_tx_disable=1 -- -i
> +
> +- ``fiber_sdp3_no_tx_disable`` (default **0**)
> +
> +  Not all IXGBE implementations with SFP cages use the SDP3 signal as
> + TX_DISABLE as a means to disable the laser on fiber SFP modules.
> +  This option informs the driver that in this case, SDP3 is not to be
> + used as a check for link up by testing for laser on/off.
> +
>  VF Runtime Options
>  ^^^^^^^^^^^^^^^^^^
> 
> --
> 2.25.1

Please squash the document update into the code path.
diff mbox series

Patch

diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index 82fa453fa28e..ad1a3da6101e 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -101,6 +101,23 @@  To guarantee the constraint, capabilities in dev_conf.rxmode.offloads will be ch
 
 fdir_conf->mode will also be checked.
 
+Disable SDP3 TX_DISABLE for Fiber Links
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following ``devargs`` option can be enabled at runtime.  It must
+be passed as part of EAL arguments. For example,
+
+.. code-block:: console
+
+   dpdk-testpmd -a fiber_sdp3_no_tx_disable=1 -- -i
+
+- ``fiber_sdp3_no_tx_disable`` (default **0**)
+
+  Not all IXGBE implementations with SFP cages use the SDP3 signal as
+  TX_DISABLE as a means to disable the laser on fiber SFP modules.
+  This option informs the driver that in this case, SDP3 is not to be
+  used as a check for link up by testing for laser on/off.
+
 VF Runtime Options
 ^^^^^^^^^^^^^^^^^^