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/50/100 Gbps Intel® Ethernet 810 Series Network Adapters based on
   9 the Intel Ethernet Controller E810.
  10
  11
  12 Prerequisites
  13 -------------
  14
  15 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  16
  17 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
  18   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
  19
  20 Pre-Installation Configuration
  21 ------------------------------
  22
  23 Config File Options
  24 ~~~~~~~~~~~~~~~~~~~
  25
  26 The following options can be modified in the ``config`` file.
  27 Please note that enabling debugging options may affect system performance.
  28
  29 - ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
  30
  31   Toggle compilation of the ``librte_pmd_ice`` driver.
  32
  33 - ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
  34
  35   Toggle display of generic debugging messages.
  36
  37 - ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
  38
  39   Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
  40
  41 Runtime Config Options
  42 ~~~~~~~~~~~~~~~~~~~~~~
  43
  44 - ``Safe Mode Support`` (default ``0``)
  45
  46   If driver failed to load OS package, by default driver's initialization failed.
  47   But if user intend to use the device without OS package, user can take ``devargs``
  48   parameter ``safe-mode-support``, for example::
  49
  50     -w 80:00.0,safe-mode-support=1
  51
  52   Then the driver will be initialized successfully and the device will enter Safe Mode.
  53   NOTE: In Safe mode, only very limited features are available, features like RSS,
  54   checksum, fdir, tunneling ... are all disabled.
  55
  56 - ``Generic Flow Pipeline Mode Support`` (default ``0``)
  57
  58   In pipeline mode, a flow can be set at one specific stage by setting parameter
  59   ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
  60   priority 0 located at the first pipeline stage which typically be used as a firewall
  61   to drop the packet on a blacklist(we called it permission stage). At this stage,
  62   flow rules are created for the device's exact match engine: switch. Flows with priority
  63   !0 located at the second stage, typically packets are classified here and be steered to
  64   specific queue or queue group (we called it distribution stage), At this stage, flow
  65   rules are created for device's flow director engine.
  66   For none-pipeline mode, ``priority`` is ignored, a flow rule can be created as a flow director
  67   rule or a switch rule depends on its pattern/action and the resource allocation situation,
  68   all flows are virtually at the same pipeline stage.
  69   By default, generic flow API is enabled in none-pipeline mode, user can choose to
  70   use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
  71   for example::
  72
  73     -w 80:00.0,pipeline-mode-support=1
  74
  75 - ``Protocol extraction for per queue``
  76
  77   Configure the RX queues to do protocol extraction into mbuf for protocol
  78   handling acceleration, like checking the TCP SYN packets quickly.
  79
  80   The argument format is::
  81
  82       -w 18:00.0,proto_xtr=<queues:protocol>[<queues:protocol>...]
  83       -w 18:00.0,proto_xtr=<protocol>
  84
  85   Queues are grouped by ``(`` and ``)`` within the group. The ``-`` character
  86   is used as a range separator and ``,`` is used as a single number separator.
  87   The grouping ``()`` can be omitted for single element group. If no queues are
  88   specified, PMD will use this protocol extraction type for all queues.
  89
  90   Protocol is : ``vlan, ipv4, ipv6, ipv6_flow, tcp, ip_offset``.
  91
  92   .. code-block:: console
  93
  94     testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
  95
  96   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
  97   VLAN extraction, other queues run with no protocol extraction.
  98
  99   .. code-block:: console
 100
 101     testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
 102
 103   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
 104   IPv6 extraction, other queues use the default VLAN extraction.
 105
 106   The extraction metadata is copied into the registered dynamic mbuf field, and
 107   the related dynamic mbuf flags is set.
 108
 109   .. table:: Protocol extraction : ``vlan``
 110
 111    +----------------------------+----------------------------+
 112    |           VLAN2            |           VLAN1            |
 113    +======+===+=================+======+===+=================+
 114    |  PCP | D |       VID       |  PCP | D |       VID       |
 115    +------+---+-----------------+------+---+-----------------+
 116
 117   VLAN1 - single or EVLAN (first for QinQ).
 118
 119   VLAN2 - C-VLAN (second for QinQ).
 120
 121   .. table:: Protocol extraction : ``ipv4``
 122
 123    +----------------------------+----------------------------+
 124    |           IPHDR2           |           IPHDR1           |
 125    +======+=======+=============+==============+=============+
 126    |  Ver |Hdr Len|    ToS      |      TTL     |  Protocol   |
 127    +------+-------+-------------+--------------+-------------+
 128
 129   IPHDR1 - IPv4 header word 4, "TTL" and "Protocol" fields.
 130
 131   IPHDR2 - IPv4 header word 0, "Ver", "Hdr Len" and "Type of Service" fields.
 132
 133   .. table:: Protocol extraction : ``ipv6``
 134
 135    +----------------------------+----------------------------+
 136    |           IPHDR2           |           IPHDR1           |
 137    +=====+=============+========+=============+==============+
 138    | Ver |Traffic class|  Flow  | Next Header |   Hop Limit  |
 139    +-----+-------------+--------+-------------+--------------+
 140
 141   IPHDR1 - IPv6 header word 3, "Next Header" and "Hop Limit" fields.
 142
 143   IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
 144   "Flow Label" fields.
 145
 146   .. table:: Protocol extraction : ``ipv6_flow``
 147
 148    +----------------------------+----------------------------+
 149    |           IPHDR2           |           IPHDR1           |
 150    +=====+=============+========+============================+
 151    | Ver |Traffic class|            Flow Label               |
 152    +-----+-------------+-------------------------------------+
 153
 154   IPHDR1 - IPv6 header word 1, 16 low bits of the "Flow Label" field.
 155
 156   IPHDR2 - IPv6 header word 0, "Ver", "Traffic class" and high 4 bits of
 157   "Flow Label" fields.
 158
 159   .. table:: Protocol extraction : ``tcp``
 160
 161    +----------------------------+----------------------------+
 162    |           TCPHDR2          |           TCPHDR1          |
 163    +============================+======+======+==============+
 164    |          Reserved          |Offset|  RSV |     Flags    |
 165    +----------------------------+------+------+--------------+
 166
 167   TCPHDR1 - TCP header word 6, "Data Offset" and "Flags" fields.
 168
 169   TCPHDR2 - Reserved
 170
 171   .. table:: Protocol extraction : ``ip_offset``
 172
 173    +----------------------------+----------------------------+
 174    |           IPHDR2           |           IPHDR1           |
 175    +============================+============================+
 176    |       IPv6 HDR Offset      |       IPv4 HDR Offset      |
 177    +----------------------------+----------------------------+
 178
 179   IPHDR1 - Outer/Single IPv4 Header offset.
 180
 181   IPHDR2 - Outer/Single IPv6 Header offset.
 182
 183   Use ``rte_net_ice_dynf_proto_xtr_metadata_get`` to access the protocol
 184   extraction metadata, and use ``RTE_PKT_RX_DYNF_PROTO_XTR_*`` to get the
 185   metadata type of ``struct rte_mbuf::ol_flags``.
 186
 187   The ``rte_net_ice_dump_proto_xtr_metadata`` routine shows how to
 188   access the protocol extraction result in ``struct rte_mbuf``.
 189
 190 Driver compilation and testing
 191 ------------------------------
 192
 193 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 194 for details.
 195
 196 Features
 197 --------
 198
 199 Vector PMD
 200 ~~~~~~~~~~
 201
 202 Vector PMD for RX and TX path are selected automatically. The paths
 203 are chosen based on 2 conditions.
 204
 205 - ``CPU``
 206   On the X86 platform, the driver checks if the CPU supports AVX2.
 207   If it's supported, AVX2 paths will be chosen. If not, SSE is chosen.
 208
 209 - ``Offload features``
 210   The supported HW offload features are described in the document ice_vec.ini.
 211   If any not supported features are used, ICE vector PMD is disabled and the
 212   normal paths are chosen.
 213
 214 Malicious driver detection (MDD)
 215 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 216
 217 It's not appropriate to send a packet, if this packet's destination MAC address
 218 is just this port's MAC address. If SW tries to send such packets, HW will
 219 report a MDD event and drop the packets.
 220
 221 The APPs based on DPDK should avoid providing such packets.
 222
 223 Device Config Function (DCF)
 224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 225
 226 This section demonstrates ICE DCF PMD, which shares the core module with ICE
 227 PMD and iAVF PMD.
 228
 229 A DCF (Device Config Function) PMD bounds to the device's trusted VF with ID 0,
 230 it can act as a sole controlling entity to exercise advance functionality (such
 231 as switch, ACL) for the rest VFs.
 232
 233 The DCF PMD needs to advertise and acquire DCF capability which allows DCF to
 234 send AdminQ commands that it would like to execute over to the PF and receive
 235 responses for the same from PF.
 236
 237 .. _figure_ice_dcf:
 238
 239 .. figure:: img/ice_dcf.*
 240
 241    DCF Communication flow.
 242
 243 #. Create the VFs::
 244
 245       echo 4 > /sys/bus/pci/devices/0000\:18\:00.0/sriov_numvfs
 246
 247 #. Enable the VF0 trust on::
 248
 249       ip link set dev enp24s0f0 vf 0 trust on
 250
 251 #. Bind the VF0,  and run testpmd with 'cap=dcf' devarg::
 252
 253       testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
 254
 255 #. Monitor the VF2 interface network traffic::
 256
 257       tcpdump -e -nn -i enp24s1f2
 258
 259 #. Create one flow to redirect the traffic to VF2 by DCF::
 260
 261       flow create 0 priority 0 ingress pattern eth / ipv4 src is 192.168.0.2 \
 262       dst is 192.168.0.3 / end actions vf id 2 / end
 263
 264 #. Send the packet, and it should be displayed on tcpdump::
 265
 266       sendp(Ether(src='3c:fd:fe:aa:bb:78', dst='00:00:00:01:02:03')/IP(src=' \
 267       192.168.0.2', dst="192.168.0.3")/TCP(flags='S')/Raw(load='XXXXXXXXXX'), \
 268       iface="enp24s0f0", count=10)
 269
 270 Sample Application Notes
 271 ------------------------
 272
 273 Vlan filter
 274 ~~~~~~~~~~~
 275
 276 Vlan filter only works when Promiscuous mode is off.
 277
 278 To start ``testpmd``, and add vlan 10 to port 0:
 279
 280 .. code-block:: console
 281
 282     ./app/testpmd -l 0-15 -n 4 -- -i
 283     ...
 284
 285     testpmd> rx_vlan add 10 0
 286
 287 Limitations or Known issues
 288 ---------------------------
 289
 290 The Intel E810 requires a programmable pipeline package be downloaded
 291 by the driver to support normal operations. The E810 has a limited
 292 functionality built in to allow PXE boot and other use cases, but the
 293 driver must download a package file during the driver initialization
 294 stage.
 295
 296 The default DDP package file name is ice.pkg. For a specific NIC, the
 297 DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg,
 298 where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For
 299 example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68,
 300 the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg
 301 (in hex and all low case). During initialization, the driver searches
 302 in the following paths in order: /lib/firmware/updates/intel/ice/ddp
 303 and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP
 304 package will be downloaded first if the file exists. If not, then the
 305 driver tries to load the default package. The type of loaded package
 306 is stored in ``ice_adapter->active_pkg_type``.
 307
 308 A symbolic link to the DDP package file is also ok. The same package
 309 file is used by both the kernel driver and the DPDK PMD.