X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Fice.rst;h=f95fef8cf0a0310114209603e439d98c0b818fc5;hb=34fd4373ce76efd0236e59397c495762c2ec9e64;hp=c5a76a2a21a9e3ba98da744c85b87acdc96dcb83;hpb=1509e07f58369cb629b018d6272d714d6b6d236e;p=dpdk.git diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index c5a76a2a21..f95fef8cf0 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -5,18 +5,60 @@ ICE Poll Mode Driver ====================== The ice PMD (**librte_net_ice**) provides poll mode driver support for -10/25/50/100 Gbps Intel® Ethernet 810 Series Network Adapters based on -the Intel Ethernet Controller E810. +10/25/50/100 Gbps Intel® Ethernet 800 Series Network Adapters based on +the Intel Ethernet Controller E810 and Intel Ethernet Connection E822/E823. - -Prerequisites -------------- +Linux Prerequisites +------------------- - Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms" section of the :ref:`Getting Started Guide for Linux `. +- Please follow the matching list to download specific kernel driver, firmware and DDP package from + `https://www.intel.com/content/www/us/en/search.html?ws=text#q=e810&t=Downloads&layout=table`. + +- To understand what is DDP package and how it works, please review `Intel® Ethernet Controller E810 Dynamic + Device Personalization (DDP) for Telecommunications Technology Guide `_. + +- To understand DDP for COMMs usage with DPDK, please review `Intel® Ethernet 800 Series Telecommunication (Comms) + Dynamic Device Personalization (DDP) Package `_. + +Windows Prerequisites +--------------------- + +- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>` + to setup the basic DPDK environment. + +- Identify the Intel® Ethernet adapter and get the latest NVM/FW version. + +- To access any Intel® Ethernet hardware, load the NetUIO driver in place of existing built-in (inbox) driver. + +- To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository + `_. + +- Loading of private Dynamic Device Personalization (DDP) package is not supported on Windows. + + +Recommended Matching List +------------------------- + +It is highly recommended to upgrade the ice kernel driver, firmware and DDP package +to avoid the compatibility issues with ice PMD. +Here is the suggested matching list which has been tested and verified. +The detailed information can refer to chapter Tested Platforms/Tested NICs in release notes. + + +-----------+---------------+-----------------+-----------+--------------+-----------+ + | DPDK | Kernel Driver | OS Default DDP | COMMS DDP | Wireless DDP | Firmware | + +===========+===============+=================+===========+==============+===========+ + | 20.11 | 1.3.2 | 1.3.20 | 1.3.24 | N/A | 2.3 | + +-----------+---------------+-----------------+-----------+--------------+-----------+ + | 21.02 | 1.4.11 | 1.3.24 | 1.3.28 | 1.3.4 | 2.4 | + +-----------+---------------+-----------------+-----------+--------------+-----------+ + | 21.05 | 1.6.5 | 1.3.26 | 1.3.30 | 1.3.6 | 3.0 | + +-----------+---------------+-----------------+-----------+--------------+-----------+ + Pre-Installation Configuration ------------------------------ @@ -170,6 +212,34 @@ Runtime Config Options The ``rte_net_ice_dump_proto_xtr_metadata`` routine shows how to access the protocol extraction result in ``struct rte_mbuf``. +- ``Hardware debug mask log support`` (default ``0``) + + User can enable the related hardware debug mask such as ICE_DBG_NVM:: + + -a 0000:88:00.0,hw_debug_mask=0x80 --log-level=pmd.net.ice.driver:8 + + These ICE_DBG_XXX are defined in ``drivers/net/ice/base/ice_type.h``. + +- ``1PPS out support`` + + The E810 supports four single-ended GPIO signals (SDP[20:23]). The 1PPS + signal outputs via SDP[20:23]. User can select GPIO pin index flexibly. + Pin index 0 means SDP20, 1 means SDP21 and so on. For example:: + + -a af:00.0,pps_out='[pin:0]' + +- ``Low Rx latency`` (default ``0``) + + vRAN workloads require low latency DPDK interface for the front haul + interface connection to Radio. By specifying ``1`` for parameter + ``rx_low_latency``, each completed Rx descriptor can be written immediately + to host memory and the Rx interrupt latency can be reduced to 2us:: + + -a 0000:88:00.0,rx_low_latency=1 + + As a trade-off, this configuration may cause the packet processing performance + degradation due to the PCI bandwidth limitation. + Driver compilation and testing ------------------------------ @@ -188,9 +258,12 @@ are chosen based on 2 conditions. - ``CPU`` On the X86 platform, the driver checks if the CPU supports AVX2. If it's supported, AVX2 paths will be chosen. If not, SSE is chosen. + If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth`` + is set to 512, AVX512 paths will be chosen. - ``Offload features`` - The supported HW offload features are described in the document ice_vec.ini. + The supported HW offload features are described in the document ice.ini, + A value "P" means the offload feature is not supported by vector path. If any not supported features are used, ICE vector PMD is disabled and the normal paths are chosen. @@ -290,3 +363,8 @@ is stored in ``ice_adapter->active_pkg_type``. A symbolic link to the DDP package file is also ok. The same package file is used by both the kernel driver and the DPDK PMD. + + .. Note:: + + Windows support: The DDP package is not supported on Windows so, + loading of the package is disabled on Windows.