af_th: add Enable/Disable DPDK chapter

- Add Enable / Disable DPDK section
- Add configuring interface in standard and sriov mode
- Replace PCI address with interface name, e.g. '0000:03:00.2' with 'enp4s0f1
- Update doc version to 2.2.2

Change-Id: I93e1cedafb9580a781f1f1cac6beac6e0f5f41f3
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>

2 files changed, 128 insertions, 58 deletions

diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index da661db..e1bab54 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -10,7 +10,7 @@
     directory.</para>
 
     <para>The <literal>/device</literal> folder contains Python scripts for
-    adding a uCPE device, receiving uCPE events' reports, removing a uCPE
+    adding uCPE device(s), receiving uCPE events' reports, removing a uCPE
     device, and waiting for a uCPE device to connect to the uCPE
     Manager.</para>
 
@@ -362,7 +362,7 @@ test 004: Bind wan NIC to DPDK (__main__.UnittestSuite) ...
 2019-03-07 18:03:30,086 - DEBUG: Login successful on host 'localhost'
 2019-03-07 18:03:30,087 - DEBUG: Session token is: 8cd95f32-40f2-11e9-a81f525400d08e1d
 2019-03-07 18:03:30,095 - DEBUG: Found device with name 'intelc3850-2'
-2019-03-07 18:03:30,096 - DEBUG: Bind NIC '0000:03:00.2'
+2019-03-07 18:03:30,096 - DEBUG: Bind NIC 'enp4s0f1'
 2019-03-07 18:03:30,729 - INFO: Done
 2019-03-07 18:03:30,767 - DEBUG: Logging out and exiting...
 ok
@@ -811,11 +811,71 @@ Events on device: intelc3850-2 and severity: 1000
       </section>
     </section>
 
+    <section id="enable_disable_dpdk">
+      <title>Enabling or Disabling the DPDK</title>
+
+      <para>Steps and details on how to enable or disable the DPDK are explained below.</para>
+
+      <section id="script_dpdk">
+        <title>Script Options</title>
+
+        <programlisting>$ python configDPDK.py -h
+Usage: configDPDK.py [options]
+
+Configure DPDK
+
+Options:
+--version                          show program's version number and exit
+-h, --help                         show this help message and exit
+-u USERNAME, --username=USERNAME   Enea uCPE Manager login username
+-p PASSWORD, --password=PASSWORD   Enea uCPE Manager login password
+-H HOST, --host=HOST               Enea uCPE Manager host name or IP address
+-s STATE, --state=STATE            Enable/Disable
+-n DEVICENAME, --device-name=DEVICENAME    Name of the device
+
+Mandatory options:
+-H/--host, -s/--state</programlisting>
+      </section>
+
+      <section id="run_pydpdk">
+        <title>Running the Python Module</title>
+
+        <para>The <literal>configDPDK</literal> Python module can be executed
+        individually by running the following command lines:</para>
+
+        <para>To Enable DPDK:</para>
+
+        <programlisting>$ python configDPDK.py -s enable -n intelc3850-2
+
+2020-01-06 08:35:16,820 - DEBUG: Started logging
+2020-01-06 08:35:16,821 - INFO: Configure DPDK
+2020-01-06 08:35:16,870 - DEBUG: Login successful on host '172.24.3.90'
+2020-01-06 08:35:16,871 - DEBUG: Session token is: 601149e0-3089-11ea-b0c7-525400b7889f
+2020-01-06 08:35:16,894 - DEBUG: Found device with name 'inteld1521-1'
+2020-01-06 08:35:16,895 - DEBUG: Set DPDK state to enable
+2020-01-06 08:35:16,936 - INFO: Done
+2020-01-06 08:35:16,961 - DEBUG: Logging out and exiting...</programlisting>
+
+        <para>To Disable DPDK:</para>
+
+        <programlisting>$ python configDPDK.py -s disable -n intelc3850-2
+
+2020-01-06 08:33:57,157 - DEBUG: Started logging
+2020-01-06 08:33:57,158 - INFO: Configure DPDK
+2020-01-06 08:33:57,215 - DEBUG: Login successful on host '172.24.3.90'
+2020-01-06 08:33:57,216 - DEBUG: Session token is: 3096e670-3089-11ea-b0c7-525400b7889f
+2020-01-06 08:33:57,239 - DEBUG: Found device with name 'inteld1521-1'
+2020-01-06 08:33:57,241 - DEBUG: Set DPDK state to disable
+2020-01-06 08:33:57,284 - INFO: Done
+2020-01-06 08:33:57,310 - DEBUG: Logging out and exiting...</programlisting>
+      </section>
+    </section>
+
     <section id="bind_ucpe_device">
       <title>Binding a Network Interface</title>
 
-      <para>How to Bind a physical network interface to a DPDK or SR-IOV is
-      detailed below.</para>
+      <para>How to Bind a physical network interface to a DPDK, Standard or
+      SR-IOV is detailed below.</para>
 
       <section id="script_opts_bind">
         <title>Script Options</title>
@@ -823,7 +883,7 @@ Events on device: intelc3850-2 and severity: 1000
         <programlisting>$ python bindNetworkInterface.py -h
 Usage: bindNetworkInterface.py [options]
 
-Binds a physical network interface to a DPDK or SR-IOV.
+Binds a physical network interface to a DPDK, standard or SR-IOV.
 
 Options:
  --version show program's version number and exit
@@ -858,21 +918,40 @@ format
  "args": "-f ../../lab_config/intelc3850-2/lan_nic.json"
  },
  {
- "name": "Bind wan NIC to DPDK ",
+ "name": "Bind wan NIC to DPDK",
  "args": "-f ../../lab_config/intelc3850-2/wan_nic.json"
+ },
+ {
+ "name": "Bind wan/lan NIC to SR-IOV",
+ "args": "-f ../../lab_config/intelc3850-2/sriov_nic.json"
+ },
+ {
+ "name": "Bind wan/lan NIC to Standard",
+ "args": "-f ../../lab_config/intelc3850-2/std_nic.json"
  }
 ]</programlisting><emphasis role="bold">Sample
         <filename>lan_nic.json</filename> configuration
         file:</emphasis><programlisting>{
- "name": "0000:01:00.1",
+ "name": "enp4s0f0",
  "type": "dpdk",
- "subType": "igb_uio"
+ "subType": "vfio-pci"
 }</programlisting><emphasis role="bold">Sample
         <filename>wan_nic.json</filename> configuration
         file:</emphasis><programlisting>{
- "name": "0000:03:00.2",
+ "name": "enp4s0f1",
  "type": "dpdk",
- "subType": "igb_uio"
+ "subType": "vfio-pci"
+}</programlisting><emphasis role="bold">Sample
+        <filename>sriov_nic.json</filename> configuration
+        file:</emphasis><programlisting>{
+ "name": "eno1",
+ "type": "srIov",
+ "subType": "passthrough | adapter-pool"
+}</programlisting><emphasis role="bold">Sample
+        <filename>std_nic.json</filename> configuration
+        file:</emphasis><programlisting>{
+ "name": "eno2",
+ "type": "standard"
 }</programlisting></para>
       </section>
 
@@ -952,7 +1031,7 @@ Unbinds a physical interface to the DPDK or SR-IOV
         configuration file:</emphasis></para>
 
         <programlisting>{
- "name": "0000:01:00.1",
+ "name": "enp4s0f0",
  "type": "dpdk"
 }</programlisting>
 
@@ -960,7 +1039,7 @@ Unbinds a physical interface to the DPDK or SR-IOV
         configuration file:</emphasis></para>
 
         <programlisting>{
- "name": "0000:03:00.2",
+ "name": "enp4s0f1",
  "type": "dpdk",
 }
 </programlisting>
@@ -1020,49 +1099,40 @@ Options:
         executed individually by running the following command:</para>
 
         <programlisting>$ python getNetworkInterfaces.py -H localhost -n intelc3850-2
-2019-07-04 16:03:47,580 - DEBUG: Started logging
-2019-07-04 16:03:47,580 - INFO: Dump NICs
-2019-07-04 16:03:47,609 - DEBUG: Login successful on host 'localhost'
-2019-07-04 16:03:47,610 - DEBUG: Session token is: 8ae9b103-9e64-11e9-a715-5254007632e2
-2019-07-04 16:03:47,626 - DEBUG: Found device with name 'intelc3850-2'
-2019-07-04 16:03:47,627 - DEBUG:
+2020-01-07 05:58:03,630 - DEBUG: Started logging
+2020-01-07 05:58:03,630 - INFO: Dump NICs
+2020-01-07 05:58:03,687 - DEBUG: Login successful on host '172.24.3.90'
+2020-01-07 05:58:03,688 - DEBUG: Session token is: 93dd3cd0-313c-11ea-b0c7-525400b7889f
+2020-01-07 05:58:03,715 - DEBUG: Found device with name 'intelc3850-2'
+2020-01-07 05:58:03,717 - DEBUG:
 ----------------- External Network Interfaces for intelc3850-2-----------------
-2019-07-04 16:03:47,945 - DEBUG: 0000:01:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
-        MacAddress: ac:1f:6b:2d:ee:58sriov(63)
-2019-07-04 16:03:47,945 - DEBUG:
-2019-07-04 16:03:47,969 - DEBUG:
------------------ Configured External Network Interfaces for intelc3850-2-------------
-2019-07-04 16:03:47,969 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
-        41d31385-fafd-48fe-b702-ce72fea85478
-2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
-        b0a4b919-95cd-48c2-83ad-28ec233546b2
-2019-07-04 16:03:47,969 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
-        380ac405-9e51-11e9-a715-5254007632e2
-2019-07-04 16:03:47,970 - DEBUG: 0000:03:00.1 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
-        MacAddress: 0c:c4:7a:fb:85:ddsriov(7)
-2019-07-04 16:03:47,970 - DEBUG:
-2019-07-04 16:03:47,991 - DEBUG:
------------------ Configured External Network Interfaces for intelc3850-2-------------
-2019-07-04 16:03:47,991 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
-        41d31385-fafd-48fe-b702-ce72fea85478
-2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
-        b0a4b919-95cd-48c2-83ad-28ec233546b2
-2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
-        380ac405-9e51-11e9-a715-5254007632e2
-2019-07-04 16:03:47,992 - DEBUG: 0000:03:00.0 DpdkTypes: [u'igb_uio', u'vfio-pci'] \
-        MacAddress: 0c:c4:7a:fb:85:dcsriov(7)
-2019-07-04 16:03:47,992 - DEBUG:
-2019-07-04 16:03:48,012 - DEBUG:
------------------ Configured External Network Interfaces for intelc3850-2-------------
-2019-07-04 16:03:48,012 - DEBUG: 0000:01:00.1 DpdkType: igb_uio ID: \
-        41d31385-fafd-48fe-b702-ce72fea85478
-2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.2 DpdkType: igb_uio ID: \
-        b0a4b919-95cd-48c2-83ad-28ec233546b2
-2019-07-04 16:03:48,012 - DEBUG: 0000:03:00.3 DpdkType: igb_uio ID: \
-        380ac405-9e51-11e9-a715-5254007632e2
-2019-07-04 16:03:48,013 - DEBUG:
-2019-07-04 16:03:48,013 - INFO: Done
-2019-07-04 16:03:48,029 - DEBUG: Logging out and exiting...</programlisting>
+2020-01-07 05:58:07,622 - DEBUG: eno4 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:dfsriov(7)
+2020-01-07 05:58:07,624 - DEBUG:
+2020-01-07 05:58:07,656 - DEBUG:
+----------------- Configured External Network Interfaces for intelc3850-2-----------------
+2020-01-07 05:58:07,657 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7
+2020-01-07 05:58:07,658 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1
+2020-01-07 05:58:07,659 - DEBUG: enp1s0f0 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: ac:1f:6b:2d:ee:58sriov(63)
+2020-01-07 05:58:07,660 - DEBUG:
+2020-01-07 05:58:07,690 - DEBUG:
+----------------- Configured External Network Interfaces for intelc3850-2-----------------
+2020-01-07 05:58:07,691 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7
+2020-01-07 05:58:07,692 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1
+2020-01-07 05:58:07,693 - DEBUG: eno2 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:ddsriov(7)
+2020-01-07 05:58:07,695 - DEBUG:
+2020-01-07 05:58:07,724 - DEBUG:
+----------------- Configured External Network Interfaces for intelc3850-2-----------------
+2020-01-07 05:58:07,725 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7
+2020-01-07 05:58:07,726 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1
+2020-01-07 05:58:07,727 - DEBUG: eno1 DpdkTypes: [u'igb_uio', u'vfio-pci'] MacAddress: 0c:c4:7a:fb:85:dcsriov(7)
+2020-01-07 05:58:07,728 - DEBUG:
+2020-01-07 05:58:07,760 - DEBUG:
+----------------- Configured External Network Interfaces for intelc3850-2-----------------
+2020-01-07 05:58:07,761 - DEBUG: eno3 DpdkType: vfio-pci ID: 47556b22-b5c2-4acb-b3cb-09b1f024b3a7
+2020-01-07 05:58:07,761 - DEBUG: enp1s0f1 DpdkType: vfio-pci ID: 2c06b4f7-6814-4432-8765-a9d0cd5303c1
+2020-01-07 05:58:07,762 - DEBUG:
+2020-01-07 05:58:07,763 - INFO: Done
+2020-01-07 05:58:07,787 - DEBUG: Logging out and exiting...</programlisting>
       </section>
     </section>
 
@@ -1124,7 +1194,7 @@ Options:
 
         <programlisting>{
  "name": "lan_br",
- "interfaces": ["0000:01:00.1"]
+ "interfaces": ["enp4s0f0"]
 }</programlisting>
 
         <para><emphasis role="bold">Sample <filename>wan_br.json</filename>
@@ -1132,7 +1202,7 @@ Options:
 
         <programlisting>{
  "name": "wan_br",
- "interfaces": ["0000:03:00.2"]
+ "interfaces": ["enp4s0f1"]
 }</programlisting>
       </section>
 
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml
index feabc9f..be0be23 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml
@@ -42,7 +42,7 @@ export PATH=~/bin:$PATH</programlisting></para>
     correct also compared to the "previous" REL VER in pardoc-distro.xml
     "prev_baseline".</bridgehead>
 
-    <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para>
+    <para id="EneaLinux_REL_VER"><phrase>2.2.2</phrase></para>
 
     <para id="Yocto_VER"><phrase>2.4</phrase></para>
 
@@ -283,4 +283,4 @@ repo sync</programlisting></para>
       </tgroup>
     </table>
   </section>
-</section>
\ No newline at end of file
+</section>