avf: fix adminq enqueue errors

[vpp.git] / src / plugins / avf / README.md

diff --git a/src/plugins/avf/README.md b/src/plugins/avf/README.md
index 6a464a4..7aa2661 100644 (file)
--- a/src/plugins/avf/README.md
+++ b/src/plugins/avf/README.md
@@ -4,7 +4,7 @@
 This plugins provides native device support for intel Adaptive Virtual
 Function (AVF). AVF is driver specification for current and future
 Intel Virtual Function devices. AVF defines communication channel between
 This plugins provides native device support for intel Adaptive Virtual
 Function (AVF). AVF is driver specification for current and future
 Intel Virtual Function devices. AVF defines communication channel between

-Physical Funciton (PF) and VF.
+Physical Functions (PF) and VF.

 In essence, today this driver can be used only with 
 Intel XL710 / X710 / XXV710 adapters.
 
 In essence, today this driver can be used only with 
 Intel XL710 / X710 / XXV710 adapters.
 


@@ -19,11 +19,7 @@ vfio driver can still be used with recent kernels which support no-iommu mode.
 
 ##Known issues
 This driver is still in experimental phase, however it shows very good 
 
 ##Known issues
 This driver is still in experimental phase, however it shows very good 

-performance numbers. Following items are not implemented (yet).
-
-* Jumbo MTU support
-* Interrupt and adaptive mode
-* NUMA support
+performance numbers.

 
 ## Usage
 ### System setup
 
 ## Usage
 ### System setup


@@ -75,11 +71,28 @@ setup 0000:3b:00.0 00:11:22:33:44:00
 setup 0000:3b:00.1 00:11:22:33:44:01
 ```
 
 setup 0000:3b:00.1 00:11:22:33:44:01
 ```
 

-### Interface Cration
+### Promisc mode
+In cases when interface is used in the L2 mode or promisc mode is needed for some other reason,
+trust needs to be set to "on" using the linux "ip link" utility.
+```
+ip link set dev <PF inteface name> vf <VF id> trust on
+```
+
+### L2 spoofing check
+By default Virtual Function is not allowed to send ethernet frames which
+have source MAC address different than address assigned to the VF.
+In some cases it is expected that VPP will send such frames (e.g. L2 bridging,
+bonding, l2 cross-connect) and in such cases spoof chack needs to be turned
+off by issuing following command:
+```
+ip link set dev <PF inteface name> vf <VF id> spoofchk off
+```
+
+### Interface Creation

 Interfaces can be dynamically created by using following CLI:
 ```
 create interface avf 0000:3b:02.0
 Interfaces can be dynamically created by using following CLI:
 ```
 create interface avf 0000:3b:02.0

-set int state AVF0/3b/2/0 up
+set int state avf-0/3b/2/0 up

 ```
 
 ### Interface Deletion
 ```
 
 ### Interface Deletion