doc/guides/rawdevs/ioat_rawdev.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2019 Intel Corporation.
   3
   4 .. include:: <isonum.txt>
   5
   6 IOAT Rawdev Driver for Intel\ |reg| QuickData Technology
   7 ======================================================================
   8
   9 The ``ioat`` rawdev driver provides a poll-mode driver (PMD) for Intel\ |reg|
  10 QuickData Technology, part of Intel\ |reg| I/O Acceleration Technology
  11 `(Intel I/OAT)
  12 <https://www.intel.com/content/www/us/en/wireless-network/accel-technology.html>`_.
  13 This PMD, when used on supported hardware, allows data copies, for example,
  14 cloning packet data, to be accelerated by that hardware rather than having to
  15 be done by software, freeing up CPU cycles for other tasks.
  16
  17 Hardware Requirements
  18 ----------------------
  19
  20 On Linux, the presence of an Intel\ |reg| QuickData Technology hardware can
  21 be detected by checking the output of the ``lspci`` command, where the
  22 hardware will be often listed as "Crystal Beach DMA" or "CBDMA". For
  23 example, on a system with Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @2.20GHz,
  24 lspci shows:
  25
  26 .. code-block:: console
  27
  28   # lspci | grep DMA
  29   00:04.0 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 0 (rev 01)
  30   00:04.1 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 1 (rev 01)
  31   00:04.2 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 2 (rev 01)
  32   00:04.3 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 3 (rev 01)
  33   00:04.4 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 4 (rev 01)
  34   00:04.5 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 5 (rev 01)
  35   00:04.6 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 6 (rev 01)
  36   00:04.7 System peripheral: Intel Corporation Xeon E7 v4/Xeon E5 v4/Xeon E3 v4/Xeon D Crystal Beach DMA Channel 7 (rev 01)
  37
  38 On a system with Intel\ |reg| Xeon\ |reg| Gold 6154 CPU @ 3.00GHz, lspci
  39 shows:
  40
  41 .. code-block:: console
  42
  43   # lspci | grep DMA
  44   00:04.0 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  45   00:04.1 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  46   00:04.2 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  47   00:04.3 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  48   00:04.4 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  49   00:04.5 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  50   00:04.6 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  51   00:04.7 System peripheral: Intel Corporation Sky Lake-E CBDMA Registers (rev 04)
  52
  53
  54 Compilation
  55 ------------
  56
  57 For builds done with ``make``, the driver compilation is enabled by the
  58 ``CONFIG_RTE_LIBRTE_PMD_IOAT_RAWDEV`` build configuration option. This is
  59 enabled by default in builds for x86 platforms, and disabled in other
  60 configurations.
  61
  62 For builds using ``meson`` and ``ninja``, the driver will be built when the
  63 target platform is x86-based.
  64
  65 Device Setup
  66 -------------
  67
  68 The Intel\ |reg| QuickData Technology HW devices will need to be bound to a
  69 user-space IO driver for use. The script ``dpdk-devbind.py`` script
  70 included with DPDK can be used to view the state of the devices and to bind
  71 them to a suitable DPDK-supported kernel driver. When querying the status
  72 of the devices, they will appear under the category of "Misc (rawdev)
  73 devices", i.e. the command ``dpdk-devbind.py --status-dev misc`` can be
  74 used to see the state of those devices alone.
  75
  76 Device Probing and Initialization
  77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  78
  79 Once bound to a suitable kernel device driver, the HW devices will be found
  80 as part of the PCI scan done at application initialization time. No vdev
  81 parameters need to be passed to create or initialize the device.
  82
  83 Once probed successfully, the device will appear as a ``rawdev``, that is a
  84 "raw device type" inside DPDK, and can be accessed using APIs from the
  85 ``rte_rawdev`` library.
  86
  87 Using IOAT Rawdev Devices
  88 --------------------------
  89
  90 To use the devices from an application, the rawdev API can be used, along
  91 with definitions taken from the device-specific header file
  92 ``rte_ioat_rawdev.h``. This header is needed to get the definition of
  93 structure parameters used by some of the rawdev APIs for IOAT rawdev
  94 devices, as well as providing key functions for using the device for memory
  95 copies.
  96
  97 Getting Device Information
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99
 100 Basic information about each rawdev device can be queried using the
 101 ``rte_rawdev_info_get()`` API. For most applications, this API will be
 102 needed to verify that the rawdev in question is of the expected type. For
 103 example, the following code snippet can be used to identify an IOAT
 104 rawdev device for use by an application:
 105
 106 .. code-block:: C
 107
 108         for (i = 0; i < count && !found; i++) {
 109                 struct rte_rawdev_info info = { .dev_private = NULL };
 110                 found = (rte_rawdev_info_get(i, &info) == 0 &&
 111                                 strcmp(info.driver_name,
 112                                                 IOAT_PMD_RAWDEV_NAME_STR) == 0);
 113         }
 114
 115 When calling the ``rte_rawdev_info_get()`` API for an IOAT rawdev device,
 116 the ``dev_private`` field in the ``rte_rawdev_info`` struct should either
 117 be NULL, or else be set to point to a structure of type
 118 ``rte_ioat_rawdev_config``, in which case the size of the configured device
 119 input ring will be returned in that structure.
 120
 121 Device Configuration
 122 ~~~~~~~~~~~~~~~~~~~~~
 123
 124 Configuring an IOAT rawdev device is done using the
 125 ``rte_rawdev_configure()`` API, which takes the same structure parameters
 126 as the, previously referenced, ``rte_rawdev_info_get()`` API. The main
 127 difference is that, because the parameter is used as input rather than
 128 output, the ``dev_private`` structure element cannot be NULL, and must
 129 point to a valid ``rte_ioat_rawdev_config`` structure, containing the ring
 130 size to be used by the device. The ring size must be a power of two,
 131 between 64 and 4096.
 132
 133 The following code shows how the device is configured in
 134 ``test_ioat_rawdev.c``:
 135
 136 .. code-block:: C
 137
 138    #define IOAT_TEST_RINGSIZE 512
 139         struct rte_ioat_rawdev_config p = { .ring_size = -1 };
 140         struct rte_rawdev_info info = { .dev_private = &p };
 141
 142         /* ... */
 143
 144         p.ring_size = IOAT_TEST_RINGSIZE;
 145         if (rte_rawdev_configure(dev_id, &info) != 0) {
 146                 printf("Error with rte_rawdev_configure()\n");
 147                 return -1;
 148         }
 149
 150 Once configured, the device can then be made ready for use by calling the
 151 ``rte_rawdev_start()`` API.