doc: add feature support matrix link for i40e

Message ID 20200225111440.98742-1-xiaolong.ye@intel.com (mailing list archive)
State Accepted, archived
Headers
Series doc: add feature support matrix link for i40e |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Xiaolong Ye Feb. 25, 2020, 11:14 a.m. UTC
  There is an increase in number of issues related to supported cables and
modules, this link and note can help users identify or narrow down the
issues.

Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
---
 doc/guides/nics/i40e.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

Comments

Ferruh Yigit Feb. 25, 2020, 3:37 p.m. UTC | #1
On 2/25/2020 11:14 AM, Xiaolong Ye wrote:
> There is an increase in number of issues related to supported cables and
> modules, this link and note can help users identify or narrow down the
> issues.
> 
> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Feb. 25, 2020, 3:44 p.m. UTC | #2
25/02/2020 16:37, Ferruh Yigit:
> On 2/25/2020 11:14 AM, Xiaolong Ye wrote:
> > There is an increase in number of issues related to supported cables and
> > modules, this link and note can help users identify or narrow down the
> > issues.
> > 
> > Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index cc8724a19..d6e578eda 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -59,6 +59,21 @@  Prerequisites
 - Upgrade the NVM/FW version following the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
   <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ and `Intel® Ethernet NVM Update Tool: Quick Usage Guide for EFI <https://www.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-efi-usage-guide.html>`_ if needed.
 
+- For information about supported media, please refer to this document: `Intel® Ethernet Controller X710/XXV710/XL710 Feature Support Matrix
+  <http://www.intel.com/content/dam/www/public/us/en/documents/release-notes/xl710-ethernet-controller-feature-matrix.pdf>`_.
+
+   .. Note::
+
+      * Some adapters based on the Intel(R) Ethernet Controller 700 Series only
+        support Intel Ethernet Optics modules. On these adapters, other modules are not
+        supported and will not function.
+
+      * For connections based on Intel(R) Ethernet Controller 700 Series,
+        support is dependent on your system board. Please see your vendor for details.
+
+      * In all cases Intel recommends using Intel Ethernet Optics; other modules
+        may function but are not validated by Intel. Contact Intel for supported media types.
+
 Recommended Matching List
 -------------------------