Updated ch 8. Using Enea NFV Access SDKs

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

1 files changed, 47 insertions, 48 deletions

diff --git a/doc/book-enea-nfv-access-guide/doc/using_nfv_access_sdks.xml b/doc/book-enea-nfv-access-guide/doc/using_nfv_access_sdks.xml
index 4b10d2a..13ae3b7 100644
--- a/doc/book-enea-nfv-access-guide/doc/using_nfv_access_sdks.xml
+++ b/doc/book-enea-nfv-access-guide/doc/using_nfv_access_sdks.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <chapter id="workflow">
@@ -32,17 +32,16 @@
 
   <itemizedlist>
     <listitem>
-      <para>x86_64/install/install-sdk.sh</para>
+      <para>aarch/install/install-sdk.sh</para>
     </listitem>
   </itemizedlist>
 
   <para>After installing the SDK, a developer will be able to compile and
   generate executables for the preferred target machine. Cross-gdb
-  (<filename>x86_64-enea-linux-gdb</filename>) is created by the
-  Cross-Development toolchain. It can be used to debug applications on the
-  target platform from the development workstation. For kernel debugging,
-  <command>ftrace</command> and <command>kgdb</command> are enabled on the
-  host sdk image.</para>
+  (<filename>enea-linux-gdb</filename>) is created by the Cross-Development
+  toolchain. It can be used to debug applications on the target platform from
+  the development workstation. For kernel debugging, <command>ftrace</command>
+  and <command>kgdb</command> are enabled on the host sdk image.</para>
 
   <para>Various user-space tools helpful in the development process, are also
   provided. The tools include <emphasis role="bold">LatencyTop</emphasis>,
@@ -79,7 +78,7 @@
 
       <listitem>
         <para>Setup the toolchain environment for your target by sourcing the
-        environment-setup script. Example: <programlisting>$ source sdkdir/environment-setup-corei7-64-enea-linux</programlisting></para>
+        environment-setup script. Example: <programlisting>$ source sdkdir/environment-setup-aarch64-enea-linux</programlisting></para>
       </listitem>
     </orderedlist>
   </section>
@@ -100,7 +99,7 @@
         $(CC) -o helloworld helloworld.o
 clean:
         rm -f *.o helloworld
-#include stdio.h;
+#include &lt;stdio.h&gt;
 int main(void) {
         printf("Hello World\n");
         return 0;
@@ -117,7 +116,7 @@ int main(void) {
       <listitem>
         <para>Deploy the helloworld program to your target and run it:</para>
 
-        <programlisting># ./helloworld
+        <programlisting>root@cn8304:~# ./helloworld
 hello world</programlisting>
       </listitem>
     </orderedlist>
@@ -151,9 +150,9 @@ scripts:
     $(MAKE) -C $(KERNEL_SRC) scripts
 clean:
     $(MAKE) -C $(KERNEL_SRC) M=$(PWD) LDFLAGS="" clean
-#include linux/module.h     /* Needed by all modules */
-#include linux/kernel.h     /* Needed for KERN_INFO */
-#include linux/init.h       /* Needed for the macros */
+#include &lt;linux/module.h&gt;     /* Needed by all modules */
+#include &lt;linux/kernel.h&gt;     /* Needed for KERN_INFO */
+#include &lt;linux/init.h&gt;       /* Needed for the macros */
 
 static int __init hello_start(void)
 {
@@ -184,9 +183,9 @@ MODULE_LICENSE("GPL");</programlisting>
         <para>Deploy the kernel module <literal>hello.ko</literal> to your
         target and install/remove it:</para>
 
-        <programlisting># insmod hello.ko
-# rmmod hello.ko
-# dmesg
+        <programlisting>root@cn8304:~# insmod hello.ko
+root@cn8304:~# rmmod hello.ko
+root@cn8304:~# dmesg
 [...] Loading hello module...
 [...] Hello, world
 [...] Goodbye, world</programlisting>
@@ -204,7 +203,7 @@ MODULE_LICENSE("GPL");</programlisting>
       host target. For this you will need a network connection to the target,
       to use <literal>scp</literal> to copy to the desired location.</para>
 
-      <para><programlisting># scp helloworld root@&lt;target_ip_address&gt;:/tmp</programlisting></para>
+      <para><programlisting>$ scp helloworld root@&lt;target_ip_address&gt;:/tmp</programlisting></para>
     </section>
 
     <section id="deploy_onguest">
@@ -228,7 +227,7 @@ MODULE_LICENSE("GPL");</programlisting>
           <para>On the host, run the <literal>qemu-ifup</literal> script
           located in <literal>/etc</literal> directory:</para>
 
-          <para><programlisting># /etc/qemu-ifup &ndash;t tap0 &ndash;a 192.168.122.10 &ndash;p 1050 &ndash;g 22</programlisting></para>
+          <para><programlisting>root@cn8304:~# /etc/qemu-ifup –t tap0 –a 192.168.122.10 –p 1050 –g 22</programlisting></para>
 
           <itemizedlist>
             <listitem>
@@ -269,15 +268,15 @@ MODULE_LICENSE("GPL");</programlisting>
           device and set the default gateway as the <literal>virbr0</literal>
           ip address:</para>
 
-          <para><programlisting>ip addr add 192.168.122.10/24 dev enp0s2
-ip link set enp0s2 up
-ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
+          <para><programlisting>root@qemuarm64:~# ip addr add 192.168.122.10/24 dev enp0s2
+root@qemuarm64:~# ip link set enp0s2 up
+root@qemuarm64:~# ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
         </listitem>
 
         <listitem>
           <para>Now you can use <literal>scp</literal> from your development
           machine to deploy your artifacts on the guest, by giving the host
-          port for forwarding as a command parameter: <programlisting>scp -P 1050 helloworld root@target_ip_address:/tmp</programlisting></para>
+          port for forwarding as a command parameter: <programlisting>$ scp -P 1050 helloworld root@target_ip_address:/tmp</programlisting></para>
         </listitem>
 
         <listitem>
@@ -285,9 +284,9 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
           stopping the virtual machine, you can use the
           <literal>qemu-ifdown</literal> script to clean up the configuration
           on host. The following command will remove the tap interface and all
-          the iptables rules for the specific ip address: <programlisting># /etc/qemu-ifdown &ndash;t tap0 &ndash;a 192.168.122.10</programlisting>If
+          the iptables rules for the specific ip address: <programlisting>root@qemuarm64:~# /etc/qemu-ifdown –t tap0 –a 192.168.122.10</programlisting>If
           we need to remove only a particular port forwarding rule from
-          iptables, this should be run: <programlisting># /etc/qemu-ifdown &ndash;t tap0 &ndash;a 192.168.122.10 &ndash;p 1050 &ndash;g 22</programlisting></para>
+          iptables, this should be run: <programlisting>root@qemuarm64:~# /etc/qemu-ifdown –t tap0 –a 192.168.122.10 –p 1050 –g 22</programlisting></para>
         </listitem>
       </orderedlist>
     </section>
@@ -296,19 +295,19 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
   <section id="crossdebugging">
     <title>Cross-Debugging on Enea NFV Access</title>
 
-    <para>The cross-debugger (<literal>x86_64-enea-linux-gdb</literal>) is
-    created when installing the SDK on the development machine. It is helpful
-    for debugging both the kernel and user-applications. In order to perform
-    this task, we need the following tools to be available on the target
+    <para>The cross-debugger (<literal>enea-linux-gdb</literal>) is created
+    when installing the SDK on the development machine. It is helpful for
+    debugging both the kernel and user-applications. In order to perform this
+    task, we need the following tools to be available on the target
     machine:</para>
 
     <itemizedlist>
       <listitem>
-        <para>Kgdb &ndash; for kernel cross-debugging</para>
+        <para>Kgdb – for kernel cross-debugging</para>
       </listitem>
 
       <listitem>
-        <para>GDBServer &ndash; for application cross-debugging</para>
+        <para>GDBServer – for application cross-debugging</para>
       </listitem>
     </itemizedlist>
 
@@ -326,10 +325,10 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
       GDBServer and cross-gdb.</para>
 
       <para>On target, launch the GDBServer, specifying how to communicate
-      with GDB and the name of your program:<programlisting># gdbserver :&lt;port_no&gt; /tmp/helloworld</programlisting>The
+      with GDB and the name of your program:<programlisting>root@cn8304:~# gdbserver :&lt;port_no&gt; /tmp/helloworld</programlisting>The
       target will now be listening on the port given as a parameter to the
       gdbserver. On the development machine, from the
-      <literal>&lt;sdkdir&gt;</literal>, start the cross-gdb:<programlisting># x86_64-enea-linux-gdb &lt;path_to_the_program&gt;/helloworld</programlisting>Connect
+      <literal>&lt;sdkdir&gt;</literal>, start the cross-gdb:<programlisting>$ enea-linux-gdb &lt;path_to_the_program&gt;/helloworld</programlisting>Connect
       the GDB to the target: <programlisting>(gdb) target remote &lt;target_ip_address&gt;:&lt;port_no&gt;</programlisting>Now
       remote debugging is started and the GDB commands are available to debug
       your program from the target machine.</para>
@@ -351,7 +350,7 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
       <orderedlist>
         <listitem>
           <para>On the host, run the script <literal>qemu-ifup</literal>
-          located in <literal>/etc</literal> directory: <programlisting># /etc/qemu-ifup &ndash;t tap0 &ndash;a 192.168.122.10 &ndash;p 1051 &ndash;g 1025</programlisting></para>
+          located in <literal>/etc</literal> directory: <programlisting>root@cn8304:~# /etc/qemu-ifup –t tap0 –a 192.168.122.10 –p 1051 –g 1025</programlisting></para>
 
           <itemizedlist>
             <listitem>
@@ -367,14 +366,14 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">1051</emphasis> &ndash; the host
-              port which is set to forward traffic from the host to the guest
-              and is used by gdb target remote command.</para>
+              <para><emphasis role="bold">1051</emphasis> – the host port
+              which is set to forward traffic from the host to the guest and
+              is used by gdb target remote command.</para>
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">1025</emphasis>&ndash; the port used
-              by GDBServer on guest for listening.</para>
+              <para><emphasis role="bold">1025</emphasis>– the port used by
+              GDBServer on guest for listening.</para>
             </listitem>
           </itemizedlist>
         </listitem>
@@ -388,23 +387,23 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
         <listitem>
           <para>On the guest, after logging, configure the virtual network
           device and set the default gateway to virbr0 ip
-          address:<programlisting>ip addr add 192.168.122.10/24 dev enp0s2
-ip link set enp0s2 up
-ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
+          address:<programlisting>root@qemuarm64:~# ip addr add 192.168.122.10/24 dev enp0s2
+root@qemuarm64:~# ip link set enp0s2 up
+root@qemuarm64:~# ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
         </listitem>
 
         <listitem>
           <para>GDBserver is the program which runs on the guest VM and allows
           you to run GDB on your workstation. On the guest, launch GBDserver
           specifying how to communicate with GDB and the name of your program:
-          <programlisting># gdbserver :1025 /tmp/helloworld</programlisting>The
+          <programlisting>root@qemuarm64:~# gdbserver :1025 /tmp/helloworld</programlisting>The
           guest is now listening on port 1025, given as a parameter to the
           gdbserver.</para>
         </listitem>
 
         <listitem>
           <para>On the development machine, from the<filename>
-          &lt;sdkdir&gt;</filename>, start the cross-gdb:<programlisting># x86_64-enea-linux-gdb &lt;path_to_the_program&gt;/helloworld</programlisting></para>
+          &lt;sdkdir&gt;</filename>, start the cross-gdb:<programlisting>$ enea-linux-gdb &lt;path_to_the_program&gt;/helloworld</programlisting></para>
         </listitem>
 
         <listitem>
@@ -417,7 +416,7 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
           <para>On the host, after finishing the cross-debugging session and
           stopping the virtual machine, you can use the
           <filename>qemu-ifdown</filename> script to clean up the
-          configuration on host:<programlisting># /etc/qemu-ifdown -t tap0 -a 192.168.122.10</programlisting></para>
+          configuration on host:<programlisting>root@cn8304:~# /etc/qemu-ifdown -t tap0 -a 192.168.122.10</programlisting></para>
         </listitem>
       </orderedlist>
     </section>
@@ -436,12 +435,12 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
       <itemizedlist>
         <listitem>
           <para>On target, once serial communication is established, configure
-          <literal>kgdboc</literal> after the kernel boots:<programlisting># echo ttyS0,115200 &gt; /sys/module/kgdboc/parameters/kgdboc</programlisting></para>
+          <literal>kgdboc</literal> after the kernel boots:<programlisting>root@cn8304:~# echo ttyS0,115200 &gt; /sys/module/kgdboc/parameters/kgdboc</programlisting></para>
         </listitem>
 
         <listitem>
           <para>In order to connect to gdb via kgdboc, the kernel must first
-          be stopped:<programlisting># echo g &gt; /proc/sysrq-trigger</programlisting></para>
+          be stopped:<programlisting>root@cn8304:~# echo g &gt; /proc/sysrq-trigger</programlisting></para>
         </listitem>
 
         <listitem>
@@ -454,8 +453,8 @@ ip route add default via 192.168.122.1 dev enp0s2</programlisting></para>
           kernel image as a parameter. The image is located in
           <filename>&lt;sdkdir&gt;/sysroots/corei7-64-enea-linux/boot/</filename>
           and should be the same as the image found in the
-          <literal>/boot</literal> directory from the target.<programlisting># x86_64-enea-linux-gdb /
-./sysroots/corei7-64-enea-linux/boot/vmlinux-4.9.30-intel-pk-standard</programlisting></para>
+          <literal>/boot</literal> directory from the target.<programlisting>$ enea-linux-gdb /
+./sysroots/aarch64-enea-linux/boot/vmlinux-4.9.0-octeontx.sdk.6.1.0.p3.build.22-cavium-tiny</programlisting></para>
         </listitem>
 
         <listitem>