src/plugins/idpf/README.rst

   1 Intel IDPF device driver
   2 ========================
   3
   4 Overview
   5 --------
   6
   7 This plugins provides native device support for Intel Infrastructure
   8 Data Path Function (IDPF). The current IDPF is a driver specification
   9 for future Intel Physical Function devices. IDPF defines communication
  10 channel between Data Plane (DP) and Control Plane (CP).
  11
  12 Prerequisites
  13 -------------
  14
  15 -  Driver requires MSI-X interrupt support, which is not supported by
  16    uio_pci_generic driver, so vfio-pci needs to be used. On systems
  17    without IOMMU vfio driver can still be used with recent kernels which
  18    support no-iommu mode.
  19
  20 Known issues
  21 ------------
  22
  23 -  This driver is still in experimental phase, and the corresponding device
  24 is not released yet.
  25
  26 -  Current version only supports device initialization. Basic I/O function
  27 will be supported in the next release.
  28
  29 Usage
  30 -----
  31
  32 Interface Creation
  33 ~~~~~~~~~~~~~~~~~~
  34
  35 Interfaces can be dynamically created by using following CLI:
  36
  37 ::
  38
  39    create interface idpf 0000:4b:00.0 vport-num 1 rx-single 1 tx-single 1
  40    set int state idpf-0/4b/0/0 up
  41
  42 vport-num: number of vport to be created. Each vport is related to one netdev.
  43 rx-single: configure Rx queue mode, split queue mode by default.
  44 tx-single: configure Tx queue mode, split queue mode by default.
  45
  46 Interface Deletion
  47 ~~~~~~~~~~~~~~~~~~
  48
  49 Interface can be deleted with following CLI:
  50
  51 ::
  52
  53    delete interface idpf <interface name>
  54
  55 Interface Statistics
  56 ~~~~~~~~~~~~~~~~~~~~
  57
  58 Interface statistics can be displayed with
  59 ``sh hardware-interface <if-name>`` command.