1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2018 Intel Corporation.
7 The ice PMD (**librte_net_ice**) provides poll mode driver support for
8 10/25/50/100 Gbps Intel® Ethernet 800 Series Network Adapters based on
9 the Intel Ethernet Controller E810 and Intel Ethernet Connection E822/E823.
14 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
16 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
17 section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
19 - Please follow the matching list to download specific kernel driver, firmware and DDP package from
20 `https://www.intel.com/content/www/us/en/search.html?ws=text#q=e810&t=Downloads&layout=table`.
22 - To understand what is DDP package and how it works, please review `Intel® Ethernet Controller E810 Dynamic
23 Device Personalization (DDP) for Telecommunications Technology Guide <https://cdrdv2.intel.com/v1/dl/getContent/617015>`_.
25 - To understand DDP for COMMs usage with DPDK, please review `Intel® Ethernet 800 Series Telecommunication (Comms)
26 Dynamic Device Personalization (DDP) Package <https://cdrdv2.intel.com/v1/dl/getContent/618651>`_.
31 - Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
32 to setup the basic DPDK environment.
34 - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
36 - To access any Intel® Ethernet hardware, load the NetUIO driver in place of existing built-in (inbox) driver.
38 - To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
39 <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
41 - Loading of private Dynamic Device Personalization (DDP) package is not supported on Windows.
44 Recommended Matching List
45 -------------------------
47 It is highly recommended to upgrade the ice kernel driver, firmware and DDP package
48 to avoid the compatibility issues with ice PMD.
49 Here is the suggested matching list which has been tested and verified.
50 The detailed information can refer to chapter Tested Platforms/Tested NICs in release notes.
52 +-----------+---------------+-----------------+-----------+--------------+-----------+
53 | DPDK | Kernel Driver | OS Default DDP | COMMS DDP | Wireless DDP | Firmware |
54 +===========+===============+=================+===========+==============+===========+
55 | 20.11 | 1.3.2 | 1.3.20 | 1.3.24 | N/A | 2.3 |
56 +-----------+---------------+-----------------+-----------+--------------+-----------+
57 | 21.02 | 1.4.11 | 1.3.24 | 1.3.28 | 1.3.4 | 2.4 |
58 +-----------+---------------+-----------------+-----------+--------------+-----------+
59 | 21.05 | 1.6.5 | 1.3.26 | 1.3.30 | 1.3.6 | 3.0 |
60 +-----------+---------------+-----------------+-----------+--------------+-----------+
61 | 21.08 | 1.7.16 | 1.3.27 | 1.3.31 | 1.3.7 | 3.1 |
62 +-----------+---------------+-----------------+-----------+--------------+-----------+
63 | 21.11 | 1.7.16 | 1.3.27 | 1.3.31 | 1.3.7 | 3.1 |
64 +-----------+---------------+-----------------+-----------+--------------+-----------+
66 Pre-Installation Configuration
67 ------------------------------
70 Runtime Config Options
71 ~~~~~~~~~~~~~~~~~~~~~~
73 - ``Safe Mode Support`` (default ``0``)
75 If driver failed to load OS package, by default driver's initialization failed.
76 But if user intend to use the device without OS package, user can take ``devargs``
77 parameter ``safe-mode-support``, for example::
79 -a 80:00.0,safe-mode-support=1
81 Then the driver will be initialized successfully and the device will enter Safe Mode.
82 NOTE: In Safe mode, only very limited features are available, features like RSS,
83 checksum, fdir, tunneling ... are all disabled.
85 - ``Generic Flow Pipeline Mode Support`` (default ``0``)
87 In pipeline mode, a flow can be set at one specific stage by setting parameter
88 ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
89 priority 0 located at the first pipeline stage which typically be used as a firewall
90 to drop the packet on a blocklist(we called it permission stage). At this stage,
91 flow rules are created for the device's exact match engine: switch. Flows with priority
92 !0 located at the second stage, typically packets are classified here and be steered to
93 specific queue or queue group (we called it distribution stage), At this stage, flow
94 rules are created for device's flow director engine.
95 For none-pipeline mode, ``priority`` is ignored, a flow rule can be created as a flow director
96 rule or a switch rule depends on its pattern/action and the resource allocation situation,
97 all flows are virtually at the same pipeline stage.
98 By default, generic flow API is enabled in none-pipeline mode, user can choose to
99 use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
102 -a 80:00.0,pipeline-mode-support=1
104 - ``Protocol extraction for per queue``
106 Configure the RX queues to do protocol extraction into mbuf for protocol
107 handling acceleration, like checking the TCP SYN packets quickly.
109 The argument format is::
111 -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
112 -a 18:00.0,proto_xtr=<protocol>
114 Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
115 is used as a range separator and ``,`` is used as a single number separator.
116 The grouping ``()`` can be omitted for single element group. If no queues are
117 specified, PMD will use this protocol extraction type for all queues.
119 Protocol is : ``vlan, ipv4, ipv6, ipv6_flow, tcp, ip_offset``.
121 .. code-block:: console
123 dpdk-testpmd -a 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
125 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
126 VLAN extraction, other queues run with no protocol extraction.
128 .. code-block:: console
130 dpdk-testpmd -a 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
132 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
133 IPv6 extraction, other queues use the default VLAN extraction.
135 The extraction metadata is copied into the registered dynamic mbuf field, and
136 the related dynamic mbuf flags is set.
138 .. table:: Protocol extraction : ``vlan``
140 +----------------------------+----------------------------+
142 +======+===+=================+======+===+=================+
143 | PCP | D | VID | PCP | D | VID |
144 +------+---+-----------------+------+---+-----------------+
146 VLAN1 - single or EVLAN (first for QinQ).
148 VLAN2 - C-VLAN (second for QinQ).
150 .. table:: Protocol extraction : ``ipv4``
152 +----------------------------+----------------------------+
154 +======+=======+=============+==============+=============+
155 | Ver |Hdr Len| ToS | TTL | Protocol |
156 +------+-------+-------------+--------------+-------------+
158 IPHDR1 - IPv4 header word 4, "TTL" and "Protocol" fields.
160 IPHDR2 - IPv4 header word 0, "Ver", "Hdr Len" and "Type of Service" fields.
162 .. table:: Protocol extraction : ``ipv6``
164 +----------------------------+----------------------------+
166 +=====+=============+========+=============+==============+
167 | Ver |Traffic class| Flow | Next Header | Hop Limit |
168 +-----+-------------+--------+-------------+--------------+
170 IPHDR1 - IPv6 header word 3, "Next Header" and "Hop Limit" fields.
172 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
175 .. table:: Protocol extraction : ``ipv6_flow``
177 +----------------------------+----------------------------+
179 +=====+=============+========+============================+
180 | Ver |Traffic class| Flow Label |
181 +-----+-------------+-------------------------------------+
183 IPHDR1 - IPv6 header word 1, 16 low bits of the "Flow Label" field.
185 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
188 .. table:: Protocol extraction : ``tcp``
190 +----------------------------+----------------------------+
191 | TCPHDR2 | TCPHDR1 |
192 +============================+======+======+==============+
193 | Reserved |Offset| RSV | Flags |
194 +----------------------------+------+------+--------------+
196 TCPHDR1 - TCP header word 6, "Data Offset" and "Flags" fields.
200 .. table:: Protocol extraction : ``ip_offset``
202 +----------------------------+----------------------------+
204 +============================+============================+
205 | IPv6 HDR Offset | IPv4 HDR Offset |
206 +----------------------------+----------------------------+
208 IPHDR1 - Outer/Single IPv4 Header offset.
210 IPHDR2 - Outer/Single IPv6 Header offset.
212 Use ``rte_net_ice_dynf_proto_xtr_metadata_get`` to access the protocol
213 extraction metadata, and use ``RTE_PKT_RX_DYNF_PROTO_XTR_*`` to get the
214 metadata type of ``struct rte_mbuf::ol_flags``.
216 The ``rte_net_ice_dump_proto_xtr_metadata`` routine shows how to
217 access the protocol extraction result in ``struct rte_mbuf``.
219 - ``Hardware debug mask log support`` (default ``0``)
221 User can enable the related hardware debug mask such as ICE_DBG_NVM::
223 -a 0000:88:00.0,hw_debug_mask=0x80 --log-level=pmd.net.ice.driver:8
225 These ICE_DBG_XXX are defined in ``drivers/net/ice/base/ice_type.h``.
227 - ``1PPS out support``
229 The E810 supports four single-ended GPIO signals (SDP[20:23]). The 1PPS
230 signal outputs via SDP[20:23]. User can select GPIO pin index flexibly.
231 Pin index 0 means SDP20, 1 means SDP21 and so on. For example::
233 -a af:00.0,pps_out='[pin:0]'
235 - ``Low Rx latency`` (default ``0``)
237 vRAN workloads require low latency DPDK interface for the front haul
238 interface connection to Radio. By specifying ``1`` for parameter
239 ``rx_low_latency``, each completed Rx descriptor can be written immediately
240 to host memory and the Rx interrupt latency can be reduced to 2us::
242 -a 0000:88:00.0,rx_low_latency=1
244 As a trade-off, this configuration may cause the packet processing performance
245 degradation due to the PCI bandwidth limitation.
247 Driver compilation and testing
248 ------------------------------
250 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
259 Vector PMD for RX and TX path are selected automatically. The paths
260 are chosen based on 2 conditions.
263 On the X86 platform, the driver checks if the CPU supports AVX2.
264 If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
265 If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
266 is set to 512, AVX512 paths will be chosen.
268 - ``Offload features``
269 The supported HW offload features are described in the document ice.ini,
270 A value "P" means the offload feature is not supported by vector path.
271 If any not supported features are used, ICE vector PMD is disabled and the
272 normal paths are chosen.
274 Malicious driver detection (MDD)
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277 It's not appropriate to send a packet, if this packet's destination MAC address
278 is just this port's MAC address. If SW tries to send such packets, HW will
279 report a MDD event and drop the packets.
281 The APPs based on DPDK should avoid providing such packets.
283 Device Config Function (DCF)
284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
286 This section demonstrates ICE DCF PMD, which shares the core module with ICE
289 A DCF (Device Config Function) PMD bounds to the device's trusted VF with ID 0,
290 it can act as a sole controlling entity to exercise advance functionality (such
291 as switch, ACL) for the rest VFs.
293 The DCF PMD needs to advertise and acquire DCF capability which allows DCF to
294 send AdminQ commands that it would like to execute over to the PF and receive
295 responses for the same from PF.
299 .. figure:: img/ice_dcf.*
301 DCF Communication flow.
305 echo 4 > /sys/bus/pci/devices/0000\:18\:00.0/sriov_numvfs
307 #. Enable the VF0 trust on::
309 ip link set dev enp24s0f0 vf 0 trust on
311 #. Bind the VF0, and run testpmd with 'cap=dcf' devarg::
313 dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf -- -i
315 #. Monitor the VF2 interface network traffic::
317 tcpdump -e -nn -i enp24s1f2
319 #. Create one flow to redirect the traffic to VF2 by DCF::
321 flow create 0 priority 0 ingress pattern eth / ipv4 src is 192.168.0.2 \
322 dst is 192.168.0.3 / end actions vf id 2 / end
324 #. Send the packet, and it should be displayed on tcpdump::
326 sendp(Ether(src='3c:fd:fe:aa:bb:78', dst='00:00:00:01:02:03')/IP(src=' \
327 192.168.0.2', dst="192.168.0.3")/TCP(flags='S')/Raw(load='XXXXXXXXXX'), \
328 iface="enp24s0f0", count=10)
330 Sample Application Notes
331 ------------------------
336 Vlan filter only works when Promiscuous mode is off.
338 To start ``testpmd``, and add vlan 10 to port 0:
340 .. code-block:: console
342 ./app/dpdk-testpmd -l 0-15 -n 4 -- -i
345 testpmd> rx_vlan add 10 0
347 Limitations or Known issues
348 ---------------------------
350 The Intel E810 requires a programmable pipeline package be downloaded
351 by the driver to support normal operations. The E810 has a limited
352 functionality built in to allow PXE boot and other use cases, but the
353 driver must download a package file during the driver initialization
356 The default DDP package file name is ice.pkg. For a specific NIC, the
357 DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg,
358 where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For
359 example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68,
360 the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg
361 (in hex and all low case). During initialization, the driver searches
362 in the following paths in order: /lib/firmware/updates/intel/ice/ddp
363 and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP
364 package will be downloaded first if the file exists. If not, then the
365 driver tries to load the default package. The type of loaded package
366 is stored in ``ice_adapter->active_pkg_type``.
368 A symbolic link to the DDP package file is also ok. The same package
369 file is used by both the kernel driver and the DPDK PMD.
373 Windows support: The DDP package is not supported on Windows so,
374 loading of the package is disabled on Windows.