1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2018 Intel Corporation.
7 The ice PMD (librte_pmd_ice) provides poll mode driver support for
8 10/25 Gbps IntelĀ® Ethernet 810 Series Network Adapters based on
9 the Intel Ethernet Controller E810.
15 - Identifying your adapter using `Intel Support
16 <http://www.intel.com/support>`_ and get the latest NVM/FW images.
18 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
20 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
21 section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
24 Pre-Installation Configuration
25 ------------------------------
30 The following options can be modified in the ``config`` file.
31 Please note that enabling debugging options may affect system performance.
33 - ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
35 Toggle compilation of the ``librte_pmd_ice`` driver.
37 - ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
39 Toggle display of generic debugging messages.
41 - ``CONFIG_RTE_LIBRTE_ICE_RX_ALLOW_BULK_ALLOC`` (default ``y``)
43 Toggle bulk allocation for RX.
45 - ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
47 Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
49 Runtime Config Options
50 ~~~~~~~~~~~~~~~~~~~~~~
53 Driver compilation and testing
54 ------------------------------
56 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
65 Vector PMD for RX and TX path are selected automatically. The paths
66 are chosen based on 2 conditions.
69 On the X86 platform, the driver checks if the CPU supports AVX2.
70 If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
72 - ``Offload features``
73 The supported HW offload features are described in the document ice_vec.ini.
74 If any not supported features are used, ICE vector PMD is disabled and the
75 normal paths are chosen.
77 Malicious driver detection (MDD)
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
80 It's not appropriate to send a packet, if this packet's destination MAC address
81 is just this port's MAC address. If SW tries to send such packets, HW will
82 report a MDD event and drop the packets.
84 The APPs based on DPDK should avoid providing such packets.
86 Sample Application Notes
87 ------------------------
92 Vlan filter only works when Promiscuous mode is off.
94 To start ``testpmd``, and add vlan 10 to port 0:
96 .. code-block:: console
98 ./app/testpmd -l 0-15 -n 4 -- -i
101 testpmd> rx_vlan add 10 0
103 Limitations or Known issues
104 ---------------------------
106 The Intel E810 requires a programmable pipeline package be downloaded
107 by the driver to support normal operations. The E810 has a limited
108 functionality built in to allow PXE boot and other use cases, but the
109 driver must download a package file during the driver initialization
110 stage. The file must be in the /lib/firmware/intel/ice/ddp directory
111 and it must be named ice.pkg. A symbolic link to this file is also ok.
112 The same package file is used by both the kernel driver and the DPDK PMD.
118 Ice code released in 19.02 is for evaluation only.