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 DPDK `Getting Started Guide for Windows <https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic DPDK environment.
33 - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
35 - To access any Intel® Ethernet hardware, load the NetUIO driver in place of existing built-in (inbox) driver.
37 - To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
38 <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
40 - Loading of private Dynamic Device Personalization (DDP) package is not supported on Windows.
43 Recommended Matching List
44 -------------------------
46 It is highly recommended to upgrade the ice kernel driver, firmware and DDP package
47 to avoid the compatibility issues with ice PMD.
48 Here is the suggested matching list which has been tested and verified.
49 The detailed information can refer to chapter Tested Platforms/Tested NICs in release notes.
51 +-----------+---------------+-----------------+-----------+--------------+-----------+
52 | DPDK | Kernel Driver | OS Default DDP | COMMS DDP | Wireless DDP | Firmware |
53 +===========+===============+=================+===========+==============+===========+
54 | 20.11 | 1.3.2 | 1.3.20 | 1.3.24 | N/A | 2.3 |
55 +-----------+---------------+-----------------+-----------+--------------+-----------+
56 | 21.02 | 1.4.11 | 1.3.24 | 1.3.28 | 1.3.4 | 2.4 |
57 +-----------+---------------+-----------------+-----------+--------------+-----------+
59 Pre-Installation Configuration
60 ------------------------------
63 Runtime Config Options
64 ~~~~~~~~~~~~~~~~~~~~~~
66 - ``Safe Mode Support`` (default ``0``)
68 If driver failed to load OS package, by default driver's initialization failed.
69 But if user intend to use the device without OS package, user can take ``devargs``
70 parameter ``safe-mode-support``, for example::
72 -a 80:00.0,safe-mode-support=1
74 Then the driver will be initialized successfully and the device will enter Safe Mode.
75 NOTE: In Safe mode, only very limited features are available, features like RSS,
76 checksum, fdir, tunneling ... are all disabled.
78 - ``Generic Flow Pipeline Mode Support`` (default ``0``)
80 In pipeline mode, a flow can be set at one specific stage by setting parameter
81 ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
82 priority 0 located at the first pipeline stage which typically be used as a firewall
83 to drop the packet on a blocklist(we called it permission stage). At this stage,
84 flow rules are created for the device's exact match engine: switch. Flows with priority
85 !0 located at the second stage, typically packets are classified here and be steered to
86 specific queue or queue group (we called it distribution stage), At this stage, flow
87 rules are created for device's flow director engine.
88 For none-pipeline mode, ``priority`` is ignored, a flow rule can be created as a flow director
89 rule or a switch rule depends on its pattern/action and the resource allocation situation,
90 all flows are virtually at the same pipeline stage.
91 By default, generic flow API is enabled in none-pipeline mode, user can choose to
92 use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
95 -a 80:00.0,pipeline-mode-support=1
97 - ``Protocol extraction for per queue``
99 Configure the RX queues to do protocol extraction into mbuf for protocol
100 handling acceleration, like checking the TCP SYN packets quickly.
102 The argument format is::
104 -a 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
105 -a 18:00.0,proto_xtr=<protocol>
107 Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
108 is used as a range separator and ``,`` is used as a single number separator.
109 The grouping ``()`` can be omitted for single element group. If no queues are
110 specified, PMD will use this protocol extraction type for all queues.
112 Protocol is : ``vlan, ipv4, ipv6, ipv6_flow, tcp, ip_offset``.
114 .. code-block:: console
116 dpdk-testpmd -a 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
118 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
119 VLAN extraction, other queues run with no protocol extraction.
121 .. code-block:: console
123 dpdk-testpmd -a 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
125 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
126 IPv6 extraction, other queues use the default VLAN extraction.
128 The extraction metadata is copied into the registered dynamic mbuf field, and
129 the related dynamic mbuf flags is set.
131 .. table:: Protocol extraction : ``vlan``
133 +----------------------------+----------------------------+
135 +======+===+=================+======+===+=================+
136 | PCP | D | VID | PCP | D | VID |
137 +------+---+-----------------+------+---+-----------------+
139 VLAN1 - single or EVLAN (first for QinQ).
141 VLAN2 - C-VLAN (second for QinQ).
143 .. table:: Protocol extraction : ``ipv4``
145 +----------------------------+----------------------------+
147 +======+=======+=============+==============+=============+
148 | Ver |Hdr Len| ToS | TTL | Protocol |
149 +------+-------+-------------+--------------+-------------+
151 IPHDR1 - IPv4 header word 4, "TTL" and "Protocol" fields.
153 IPHDR2 - IPv4 header word 0, "Ver", "Hdr Len" and "Type of Service" fields.
155 .. table:: Protocol extraction : ``ipv6``
157 +----------------------------+----------------------------+
159 +=====+=============+========+=============+==============+
160 | Ver |Traffic class| Flow | Next Header | Hop Limit |
161 +-----+-------------+--------+-------------+--------------+
163 IPHDR1 - IPv6 header word 3, "Next Header" and "Hop Limit" fields.
165 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
168 .. table:: Protocol extraction : ``ipv6_flow``
170 +----------------------------+----------------------------+
172 +=====+=============+========+============================+
173 | Ver |Traffic class| Flow Label |
174 +-----+-------------+-------------------------------------+
176 IPHDR1 - IPv6 header word 1, 16 low bits of the "Flow Label" field.
178 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
181 .. table:: Protocol extraction : ``tcp``
183 +----------------------------+----------------------------+
184 | TCPHDR2 | TCPHDR1 |
185 +============================+======+======+==============+
186 | Reserved |Offset| RSV | Flags |
187 +----------------------------+------+------+--------------+
189 TCPHDR1 - TCP header word 6, "Data Offset" and "Flags" fields.
193 .. table:: Protocol extraction : ``ip_offset``
195 +----------------------------+----------------------------+
197 +============================+============================+
198 | IPv6 HDR Offset | IPv4 HDR Offset |
199 +----------------------------+----------------------------+
201 IPHDR1 - Outer/Single IPv4 Header offset.
203 IPHDR2 - Outer/Single IPv6 Header offset.
205 Use ``rte_net_ice_dynf_proto_xtr_metadata_get`` to access the protocol
206 extraction metadata, and use ``RTE_PKT_RX_DYNF_PROTO_XTR_*`` to get the
207 metadata type of ``struct rte_mbuf::ol_flags``.
209 The ``rte_net_ice_dump_proto_xtr_metadata`` routine shows how to
210 access the protocol extraction result in ``struct rte_mbuf``.
212 Driver compilation and testing
213 ------------------------------
215 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
224 Vector PMD for RX and TX path are selected automatically. The paths
225 are chosen based on 2 conditions.
228 On the X86 platform, the driver checks if the CPU supports AVX2.
229 If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
230 If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
231 is set to 512, AVX512 paths will be chosen.
233 - ``Offload features``
234 The supported HW offload features are described in the document ice.ini,
235 A value "P" means the offload feature is not supported by vector path.
236 If any not supported features are used, ICE vector PMD is disabled and the
237 normal paths are chosen.
239 Malicious driver detection (MDD)
240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242 It's not appropriate to send a packet, if this packet's destination MAC address
243 is just this port's MAC address. If SW tries to send such packets, HW will
244 report a MDD event and drop the packets.
246 The APPs based on DPDK should avoid providing such packets.
248 Device Config Function (DCF)
249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 This section demonstrates ICE DCF PMD, which shares the core module with ICE
254 A DCF (Device Config Function) PMD bounds to the device's trusted VF with ID 0,
255 it can act as a sole controlling entity to exercise advance functionality (such
256 as switch, ACL) for the rest VFs.
258 The DCF PMD needs to advertise and acquire DCF capability which allows DCF to
259 send AdminQ commands that it would like to execute over to the PF and receive
260 responses for the same from PF.
264 .. figure:: img/ice_dcf.*
266 DCF Communication flow.
270 echo 4 > /sys/bus/pci/devices/0000\:18\:00.0/sriov_numvfs
272 #. Enable the VF0 trust on::
274 ip link set dev enp24s0f0 vf 0 trust on
276 #. Bind the VF0, and run testpmd with 'cap=dcf' devarg::
278 dpdk-testpmd -l 22-25 -n 4 -a 18:01.0,cap=dcf -- -i
280 #. Monitor the VF2 interface network traffic::
282 tcpdump -e -nn -i enp24s1f2
284 #. Create one flow to redirect the traffic to VF2 by DCF::
286 flow create 0 priority 0 ingress pattern eth / ipv4 src is 192.168.0.2 \
287 dst is 192.168.0.3 / end actions vf id 2 / end
289 #. Send the packet, and it should be displayed on tcpdump::
291 sendp(Ether(src='3c:fd:fe:aa:bb:78', dst='00:00:00:01:02:03')/IP(src=' \
292 192.168.0.2', dst="192.168.0.3")/TCP(flags='S')/Raw(load='XXXXXXXXXX'), \
293 iface="enp24s0f0", count=10)
295 Sample Application Notes
296 ------------------------
301 Vlan filter only works when Promiscuous mode is off.
303 To start ``testpmd``, and add vlan 10 to port 0:
305 .. code-block:: console
307 ./app/dpdk-testpmd -l 0-15 -n 4 -- -i
310 testpmd> rx_vlan add 10 0
312 Limitations or Known issues
313 ---------------------------
315 The Intel E810 requires a programmable pipeline package be downloaded
316 by the driver to support normal operations. The E810 has a limited
317 functionality built in to allow PXE boot and other use cases, but the
318 driver must download a package file during the driver initialization
321 The default DDP package file name is ice.pkg. For a specific NIC, the
322 DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg,
323 where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For
324 example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68,
325 the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg
326 (in hex and all low case). During initialization, the driver searches
327 in the following paths in order: /lib/firmware/updates/intel/ice/ddp
328 and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP
329 package will be downloaded first if the file exists. If not, then the
330 driver tries to load the default package. The type of loaded package
331 is stored in ``ice_adapter->active_pkg_type``.
333 A symbolic link to the DDP package file is also ok. The same package
334 file is used by both the kernel driver and the DPDK PMD.
338 Windows support: The DDP package is not supported on Windows so,
339 loading of the package is disabled on Windows.