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>`.
23 Recommended Matching List
24 -------------------------
26 It is highly recommended to upgrade the ice kernel driver and firmware and
27 DDP packages to avoid the compatibility issues with ice PMD. Here is the
28 suggested matching list.
30 +----------------------+-----------------------+------------------+----------------+-------------------+
31 | DPDK version | Kernel driver version | Firmware version | DDP OS Package | DDP COMMS Package |
32 +======================+=======================+==================+================+===================+
33 | 19.11 | 0.12.25 | 1.1.16.39 | 1.3.4 | 1.3.10 |
34 +----------------------+-----------------------+------------------+----------------+-------------------+
35 | 19.08 (experimental) | 0.10.1 | 1.1.12.7 | 1.2.0 | N/A |
36 +----------------------+-----------------------+------------------+----------------+-------------------+
37 | 19.05 (experimental) | 0.9.4 | 1.1.10.16 | 1.1.0 | N/A |
38 +----------------------+-----------------------+------------------+----------------+-------------------+
40 Pre-Installation Configuration
41 ------------------------------
46 The following options can be modified in the ``config`` file.
47 Please note that enabling debugging options may affect system performance.
49 - ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
51 Toggle compilation of the ``librte_pmd_ice`` driver.
53 - ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
55 Toggle display of generic debugging messages.
57 - ``CONFIG_RTE_LIBRTE_ICE_RX_ALLOW_BULK_ALLOC`` (default ``y``)
59 Toggle bulk allocation for RX.
61 - ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
63 Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
65 Runtime Config Options
66 ~~~~~~~~~~~~~~~~~~~~~~
68 - ``Safe Mode Support`` (default ``0``)
70 If driver failed to load OS package, by default driver's initialization failed.
71 But if user intend to use the device without OS package, user can take ``devargs``
72 parameter ``safe-mode-support``, for example::
74 -w 80:00.0,safe-mode-support=1
76 Then the driver will be initialized successfully and the device will enter Safe Mode.
77 NOTE: In Safe mode, only very limited features are available, features like RSS,
78 checksum, fdir, tunneling ... are all disabled.
80 - ``Generic Flow Pipeline Mode Support`` (default ``0``)
82 In pipeline mode, a flow can be set at one specific stage by setting parameter
83 ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
84 priority 0 located at the first pipeline stage which typically be used as a firewall
85 to drop the packet on a blacklist(we called it permission stage). At this stage,
86 flow rules are created for the device's exact match engine: switch. Flows with priority
87 !0 located at the second stage, typically packets are classified here and be steered to
88 specific queue or queue group (we called it distribution stage), At this stage, flow
89 rules are created for device's flow director engine.
90 For none-pipeline mode, ``priority`` is ignored, a flow rule can be created as a flow director
91 rule or a switch rule depends on its pattern/action and the resource allocation situation,
92 all flows are virtually at the same pipeline stage.
93 By default, generic flow API is enabled in none-pipeline mode, user can choose to
94 use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
97 -w 80:00.0,pipeline-mode-support=1
99 - ``Flow Mark Support`` (default ``0``)
101 This is a hint to the driver to select the data path that supports flow mark extraction
103 NOTE: This is an experimental devarg, it will be removed when any of below conditions
105 1) all data paths support flow mark (currently vPMD does not)
106 2) a new offload like RTE_DEV_RX_OFFLOAD_FLOW_MARK be introduced as a standard way to hint.
109 -w 80:00.0,flow-mark-support=1
111 - ``Protocol extraction for per queue``
113 Configure the RX queues to do protocol extraction into mbuf for protocol
114 handling acceleration, like checking the TCP SYN packets quickly.
116 The argument format is::
118 -w 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
119 -w 18:00.0,proto_xtr=<protocol>
121 Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
122 is used as a range separator and ``,`` is used as a single number separator.
123 The grouping ``()`` can be omitted for single element group. If no queues are
124 specified, PMD will use this protocol extraction type for all queues.
126 Protocol is : ``vlan, ipv4, ipv6, ipv6_flow, tcp``.
128 .. code-block:: console
130 testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
132 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
133 VLAN extraction, other queues run with no protocol extraction.
135 .. code-block:: console
137 testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
139 This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
140 IPv6 extraction, other queues use the default VLAN extraction.
142 The extraction metadata is copied into the registered dynamic mbuf field, and
143 the related dynamic mbuf flags is set.
145 .. table:: Protocol extraction : ``vlan``
147 +----------------------------+----------------------------+
149 +======+===+=================+======+===+=================+
150 | PCP | D | VID | PCP | D | VID |
151 +------+---+-----------------+------+---+-----------------+
153 VLAN1 - single or EVLAN (first for QinQ).
155 VLAN2 - C-VLAN (second for QinQ).
157 .. table:: Protocol extraction : ``ipv4``
159 +----------------------------+----------------------------+
161 +======+=======+=============+==============+=============+
162 | Ver |Hdr Len| ToS | TTL | Protocol |
163 +------+-------+-------------+--------------+-------------+
165 IPHDR1 - IPv4 header word 4, "TTL" and "Protocol" fields.
167 IPHDR2 - IPv4 header word 0, "Ver", "Hdr Len" and "Type of Service" fields.
169 .. table:: Protocol extraction : ``ipv6``
171 +----------------------------+----------------------------+
173 +=====+=============+========+=============+==============+
174 | Ver |Traffic class| Flow | Next Header | Hop Limit |
175 +-----+-------------+--------+-------------+--------------+
177 IPHDR1 - IPv6 header word 3, "Next Header" and "Hop Limit" fields.
179 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
182 .. table:: Protocol extraction : ``ipv6_flow``
184 +----------------------------+----------------------------+
186 +=====+=============+========+============================+
187 | Ver |Traffic class| Flow Label |
188 +-----+-------------+-------------------------------------+
190 IPHDR1 - IPv6 header word 1, 16 low bits of the "Flow Label" field.
192 IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
195 .. table:: Protocol extraction : ``tcp``
197 +----------------------------+----------------------------+
198 | TCPHDR2 | TCPHDR1 |
199 +============================+======+======+==============+
200 | Reserved |Offset| RSV | Flags |
201 +----------------------------+------+------+--------------+
203 TCPHDR1 - TCP header word 6, "Data Offset" and "Flags" fields.
207 Use ``rte_net_ice_dynf_proto_xtr_metadata_get`` to access the protocol
208 extraction metadata, and use ``RTE_PKT_RX_DYNF_PROTO_XTR_*`` to get the
209 metadata type of ``struct rte_mbuf::ol_flags``.
211 The ``rte_net_ice_dump_proto_xtr_metadata`` routine shows how to
212 access the protocol extraction result in ``struct rte_mbuf``.
214 Driver compilation and testing
215 ------------------------------
217 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
226 Vector PMD for RX and TX path are selected automatically. The paths
227 are chosen based on 2 conditions.
230 On the X86 platform, the driver checks if the CPU supports AVX2.
231 If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
233 - ``Offload features``
234 The supported HW offload features are described in the document ice_vec.ini.
235 If any not supported features are used, ICE vector PMD is disabled and the
236 normal paths are chosen.
238 Malicious driver detection (MDD)
239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241 It's not appropriate to send a packet, if this packet's destination MAC address
242 is just this port's MAC address. If SW tries to send such packets, HW will
243 report a MDD event and drop the packets.
245 The APPs based on DPDK should avoid providing such packets.
247 Sample Application Notes
248 ------------------------
253 Vlan filter only works when Promiscuous mode is off.
255 To start ``testpmd``, and add vlan 10 to port 0:
257 .. code-block:: console
259 ./app/testpmd -l 0-15 -n 4 -- -i
262 testpmd> rx_vlan add 10 0
264 Limitations or Known issues
265 ---------------------------
267 The Intel E810 requires a programmable pipeline package be downloaded
268 by the driver to support normal operations. The E810 has a limited
269 functionality built in to allow PXE boot and other use cases, but the
270 driver must download a package file during the driver initialization
273 The default DDP package file name is ice.pkg. For a specific NIC, the
274 DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg,
275 where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For
276 example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68,
277 the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg
278 (in hex and all low case). During initialization, the driver searches
279 in the following paths in order: /lib/firmware/updates/intel/ice/ddp
280 and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP
281 package will be downloaded first if the file exists. If not, then the
282 driver tries to load the default package. The type of loaded package
283 is stored in ``ice_adapter->active_pkg_type``.
285 A symbolic link to the DDP package file is also ok. The same package
286 file is used by both the kernel driver and the DPDK PMD.
291 Ice code released in 19.02 is for evaluation only.