diff options
| author |   Ting Xu <ting.xu@intel.com> | 2022-12-15 02:10:59 +0000 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2023-08-17 01:37:44 +0000 |
| commit | 737edea328d701e33cde6ad9601e546ded6dd08f (patch) | |
| tree | 5764c71d4209b90654c9e4395eedb1fb23cc3fa5 /src/plugins/idpf/README.rst | |
| parent | cc22d38100ee7d2c03289457095baa85583c762a (diff) | |
idpf: add native idpf driver plugin
Add a new native idpf driver. This patch enables the device
initialization. Add some necessary functions and definations
for input and output. A new version of virtchnl is introduced.
Type: feature
Signed-off-by: Ting Xu <ting.xu@intel.com>
Change-Id: Ibbd9cd645e64469f1c4c8b33346c1301be3f6927
Diffstat (limited to 'src/plugins/idpf/README.rst')
| -rw-r--r-- | src/plugins/idpf/README.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/src/plugins/idpf/README.rst b/src/plugins/idpf/README.rst new file mode 100644 index 00000000000..7d4a6b93f3a --- /dev/null +++ b/src/plugins/idpf/README.rst @@ -0,0 +1,59 @@ +Intel IDPF device driver +======================== + +Overview +-------- + +This plugins provides native device support for Intel Infrastructure +Data Path Function (IDPF). The current IDPF is a driver specification +for future Intel Physical Function devices. IDPF defines communication +channel between Data Plane (DP) and Control Plane (CP). + +Prerequisites +------------- + +- Driver requires MSI-X interrupt support, which is not supported by + uio_pci_generic driver, so vfio-pci needs to be used. On systems + without IOMMU vfio driver can still be used with recent kernels which + support no-iommu mode. + +Known issues +------------ + +- This driver is still in experimental phase, and the corresponding device +is not released yet. + +- Current version only supports device initialization. Basic I/O function +will be supported in the next release. + +Usage +----- + +Interface Creation +~~~~~~~~~~~~~~~~~~ + +Interfaces can be dynamically created by using following CLI: + +:: + + create interface idpf 0000:4b:00.0 vport-num 1 rx-single 1 tx-single 1 + set int state idpf-0/4b/0/0 up + +vport-num: number of vport to be created. Each vport is related to one netdev. +rx-single: configure Rx queue mode, split queue mode by default. +tx-single: configure Tx queue mode, split queue mode by default. + +Interface Deletion +~~~~~~~~~~~~~~~~~~ + +Interface can be deleted with following CLI: + +:: + + delete interface idpf <interface name> + +Interface Statistics +~~~~~~~~~~~~~~~~~~~~ + +Interface statistics can be displayed with +``sh hardware-interface <if-name>`` command. |