doc/guides/nics/ice.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 Intel Corporation.
   3
   4 ICE Poll Mode Driver
   5 ======================
   6
   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.
  10
  11
  12 Prerequisites
  13 -------------
  14
  15 - Identifying your adapter using `Intel Support
  16   <http://www.intel.com/support>`_ and get the latest NVM/FW images.
  17
  18 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  19
  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>`.
  22
  23
  24 Pre-Installation Configuration
  25 ------------------------------
  26
  27 Config File Options
  28 ~~~~~~~~~~~~~~~~~~~
  29
  30 The following options can be modified in the ``config`` file.
  31 Please note that enabling debugging options may affect system performance.
  32
  33 - ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
  34
  35   Toggle compilation of the ``librte_pmd_ice`` driver.
  36
  37 - ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
  38
  39   Toggle display of generic debugging messages.
  40
  41 - ``CONFIG_RTE_LIBRTE_ICE_RX_ALLOW_BULK_ALLOC`` (default ``y``)
  42
  43   Toggle bulk allocation for RX.
  44
  45 - ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
  46
  47   Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
  48
  49 Runtime Config Options
  50 ~~~~~~~~~~~~~~~~~~~~~~
  51
  52 - ``Safe Mode Support`` (default ``0``)
  53
  54   If driver failed to load OS package, by default driver's initialization failed.
  55   But if user intend to use the device without OS package, user can take ``devargs``
  56   parameter ``safe-mode-support``, for example::
  57
  58     -w 80:00.0,safe-mode-support=1
  59
  60   Then the driver will be initialized successfully and the device will enter Safe Mode.
  61   NOTE: In Safe mode, only very limited features are available, features like RSS,
  62   checksum, fdir, tunneling ... are all disabled.
  63
  64 - ``Protocol extraction for per queue``
  65
  66   Configure the RX queues to do protocol extraction into ``rte_mbuf::udata64``
  67   for protocol handling acceleration, like checking the TCP SYN packets quickly.
  68
  69   The argument format is::
  70
  71       -w 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
  72       -w 18:00.0,proto_xtr=<protocol>
  73
  74   Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
  75   is used as a range separator and ``,`` is used as a single number separator.
  76   The grouping ``()`` can be omitted for single element group. If no queues are
  77   specified, PMD will use this protocol extraction type for all queues.
  78
  79   Protocol is : ``vlan, ipv4, ipv6, ipv6_flow, tcp``.
  80
  81   .. code-block:: console
  82
  83     testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
  84
  85   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
  86   VLAN extraction, other queues run with no protocol extraction.
  87
  88   .. code-block:: console
  89
  90     testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
  91
  92   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
  93   IPv6 extraction, other queues use the default VLAN extraction.
  94
  95   The extraction will be copied into the lower 32 bit of ``rte_mbuf::udata64``.
  96
  97   .. table:: Protocol extraction : ``vlan``
  98
  99    +----------------------------+----------------------------+
 100    |           VLAN2            |           VLAN1            |
 101    +======+===+=================+======+===+=================+
 102    |  PCP | D |       VID       |  PCP | D |       VID       |
 103    +------+---+-----------------+------+---+-----------------+
 104
 105   VLAN1 - single or EVLAN (first for QinQ).
 106
 107   VLAN2 - C-VLAN (second for QinQ).
 108
 109   .. table:: Protocol extraction : ``ipv4``
 110
 111    +----------------------------+----------------------------+
 112    |           IPHDR2           |           IPHDR1           |
 113    +======+=======+=============+==============+=============+
 114    |  Ver |Hdr Len|    ToS      |      TTL     |  Protocol   |
 115    +------+-------+-------------+--------------+-------------+
 116
 117   IPHDR1 - IPv4 header word 4, "TTL" and "Protocol" fields.
 118
 119   IPHDR2 - IPv4 header word 0, "Ver", "Hdr Len" and "Type of Service" fields.
 120
 121   .. table:: Protocol extraction : ``ipv6``
 122
 123    +----------------------------+----------------------------+
 124    |           IPHDR2           |           IPHDR1           |
 125    +=====+=============+========+=============+==============+
 126    | Ver |Traffic class|  Flow  | Next Header |   Hop Limit  |
 127    +-----+-------------+--------+-------------+--------------+
 128
 129   IPHDR1 - IPv6 header word 3, "Next Header" and "Hop Limit" fields.
 130
 131   IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
 132   "Flow Label" fields.
 133
 134   .. table:: Protocol extraction : ``ipv6_flow``
 135
 136    +----------------------------+----------------------------+
 137    |           IPHDR2           |           IPHDR1           |
 138    +=====+=============+========+============================+
 139    | Ver |Traffic class|            Flow Label               |
 140    +-----+-------------+-------------------------------------+
 141
 142   IPHDR1 - IPv6 header word 1, 16 low bits of the "Flow Label" field.
 143
 144   IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
 145   "Flow Label" fields.
 146
 147   .. table:: Protocol extraction : ``tcp``
 148
 149    +----------------------------+----------------------------+
 150    |           TCPHDR2          |           TCPHDR1          |
 151    +============================+======+======+==============+
 152    |          Reserved          |Offset|  RSV |     Flags    |
 153    +----------------------------+------+------+--------------+
 154
 155   TCPHDR1 - TCP header word 6, "Data Offset" and "Flags" fields.
 156
 157   TCPHDR2 - Reserved
 158
 159   Use ``get_proto_xtr_flds(struct rte_mbuf *mb)`` to access the protocol
 160   extraction, do not use ``rte_mbuf::udata64`` directly.
 161
 162   The ``dump_proto_xtr_flds(struct rte_mbuf *mb)`` routine shows how to
 163   access the protocol extraction result in ``struct rte_mbuf``.
 164
 165 Driver compilation and testing
 166 ------------------------------
 167
 168 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 169 for details.
 170
 171 Features
 172 --------
 173
 174 Vector PMD
 175 ~~~~~~~~~~
 176
 177 Vector PMD for RX and TX path are selected automatically. The paths
 178 are chosen based on 2 conditions.
 179
 180 - ``CPU``
 181   On the X86 platform, the driver checks if the CPU supports AVX2.
 182   If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
 183
 184 - ``Offload features``
 185   The supported HW offload features are described in the document ice_vec.ini.
 186   If any not supported features are used, ICE vector PMD is disabled and the
 187   normal paths are chosen.
 188
 189 Malicious driver detection (MDD)
 190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 191
 192 It's not appropriate to send a packet, if this packet's destination MAC address
 193 is just this port's MAC address. If SW tries to send such packets, HW will
 194 report a MDD event and drop the packets.
 195
 196 The APPs based on DPDK should avoid providing such packets.
 197
 198 Sample Application Notes
 199 ------------------------
 200
 201 Vlan filter
 202 ~~~~~~~~~~~
 203
 204 Vlan filter only works when Promiscuous mode is off.
 205
 206 To start ``testpmd``, and add vlan 10 to port 0:
 207
 208 .. code-block:: console
 209
 210     ./app/testpmd -l 0-15 -n 4 -- -i
 211     ...
 212
 213     testpmd> rx_vlan add 10 0
 214
 215 Limitations or Known issues
 216 ---------------------------
 217
 218 The Intel E810 requires a programmable pipeline package be downloaded
 219 by the driver to support normal operations. The E810 has a limited
 220 functionality built in to allow PXE boot and other use cases, but the
 221 driver must download a package file during the driver initialization
 222 stage.
 223
 224 The default DDP package file name is ice.pkg. For a specific NIC, the
 225 DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg,
 226 where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For
 227 example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68,
 228 the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg
 229 (in hex and all low case). During initialization, the driver searches
 230 in the following paths in order: /lib/firmware/updates/intel/ice/ddp
 231 and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP
 232 package will be downloaded first if the file exists. If not, then the
 233 driver tries to load the default package. The type of loaded package
 234 is stored in ``ice_adapter->active_pkg_type``.
 235
 236 A symbolic link to the DDP package file is also ok. The same package
 237 file is used by both the kernel driver and the DPDK PMD.
 238
 239 19.02 limitation
 240 ~~~~~~~~~~~~~~~~
 241
 242 Ice code released in 19.02 is for evaluation only.