intel · Feb 21, 2023 · Feb 21, 2023 · Jun 23, 2023 · Jun 23, 2023 · Jun 23, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -79,3 +79,59 @@ For prior version, please refer to the tag commit message. Sorry guys.
 
 ## [0.9.4] - 2023-1-17
 - I225 Fix packet routing for AF_PACKET TBS
+
+## [0.9.5] - 2023-2-21
+- Remove 5 second interval in napi switch on/off to avoid
+  extra latency.
+
+## [0.9.6] - 2023-6-23
+- ADL-N support on SKU5 that only has 2 cores for i225
+- Update deprecated pthread function in TXRX-AFXDP test script
+- Update deprecated bpf_xdp function in TXRX-AFXDP test script
+- Refactor xdp cleanup routine
+
+## [0.9.7] - 2023-7-17
+- Refactor AF_XDP execution flow to support on kernel 6.* and above
+- Fix syntax error in build.sh for Ubuntu
+- Introduce new package installer
+- Update README.md
+- Add an exception handler for binary file checking
+
+## [0.9.8] - 2023-8-10
+- Add EHL support for TI-PHY
+- txrx-tsn: Add extra flush packets in TX thread
+- txrx-tsn: Tuning NAPI Deferral to improve performance
+
+## [0.9.9] - 2023-9-5
+- Update i225 OPCUA-PKT1 mapping
+- Add eth flowtype proto rx filter to json
+
+## [0.9.10] - 2023-10-9
+- Code enhancement to ease code viewing and understanding
+
+## [0.9.11] - 2023-11-8
+- Update libbpf symbolic link in packages installer
+
+## [0.9.12] - 2023-12-15
+- Update script to run in bash to avoid unexpected output on Ubuntu
+- Add preliminary ASL support
+
+## [0.9.13] - 2024-02-07
+- Automate core configuration settings for i225 and stmmac
+- Automate core configuration settings for ASL platform
+- Add Intel security policy and guideline
+- Mount temp_file_dir directory to tmpfs
+
+## [0.9.14] - 2024-08-26
+- Change vlan socket priority value to be limited to 4 for both stmmac and i226
+- Added support for proxy server input via command line option
+- Fixed description of board information in OPCUA json script runner
+- Add iperf3 and linuxptp debian packages as dependencies on package_installer.sh
+- Added ethtool, iproute2 and ubuntu RT dependencies with links to required patches in README.md
+- Added note clarifying the usage of <PLAT> command line argument in README_json.md
+
+## [0.9.15] - 2025-01-10
+- Enable feature that disable EEE before test execution
+- Change command from lscpu to nproc to get CPU count
+- Make plot persist after tsq1a exits
+- Update liveplot to use replot
diff --git a/README.md b/README.md
@@ -65,13 +65,76 @@ Method 2:
 
 ### General
 
+#### *For system clock:*
+```
+# Please ensure the system clock is set to current date before using the installer script to install the required dependencies.
+# Otherwise the installation will failed.
+# Set the system clock to current date using command below:
+	date -s YY/MM/DD
+```
+
 #### *For system shell:*
 ```
 # Bash are required as system shell in order to compile and run TSN Reference Software.
 # Install bash using command below:
 	sudo apt-get install bash
 ```
 
+#### *Packages Installer:*
+```
+# All the TSN Ref Sw App required dependencies can be install by using the packages installer below:
+
+IMPORTANCE: Please read and follow the instruction below before using the packages installer!
+
+# In order to ease the installation of generic packages and IOTG customized helper libraries (libbpf-iotg and sopen62541-iotg) needed,
+# we have provide a installation script.
+# The script will check out a specific version of the libraries from upstream git and apply our patches on top of it.
+
+# Suggestion is to use the installer script (after having kept the original libbpf and libopen62541 in a safe place).
+# This will ensure the tsn ref sw will be able to find/use correct libraries.
+
+NOTE: If your kernel support for Intel XDP+TBS, please ensure the '__u64 txtime' descriptor is available in struct xdp_desc() in /usr/include/linux/if_xdp.h as example below:
+
+/* Rx/Tx descriptor */
+struct xdp_desc {
+        __u64 addr;
+        __u32 len;
+        __u32 options;
+        __u64 txtime;
+};
+
+WARNING: You are able to install libbpf & open62541 without the 'txtime' descriptor but you might facing error/failure during the tests.
+
+# The packages installer branch : https://github.com/intel/iotg_tsn_ref_sw
+# Branch name : **master**
+# Use the commands below to install the packages:
+
+	cd dependencies
+	./packages_installer.sh --proxy=<your.proxy.if.necessary.com> --git-proxy=<your.git.proxy.if.necessary.com>
+
+# NOTE: The proxy and git-proxy are optional arguments, provide if necessary.
+# NOTE: The packages installer only support the overwrite installation.
+# NOTE: Refer to the below
+
+# NOTE: If you are installing the libbpf and libopen62541-iotg manually, there is a chance the related open62541-iotg.pc file is not there.
+# Hence, you might have to comment out this line in **configure.ac**.
+
+**AM_CONDITIONAL([WITH_OPCUA], [test "x$no_open62541_iotg_fork" = "x0"] && test "x${HAVE_XDP}" = "xyes")**
+
+# Disclaimer
+	* The packages installers only serves to install dependencies for TSN Ref Sw App.
+	* This project is not for intended for production use.
+	* This project is intended to be used with specific platforms and bsp, other HW/SW combinations YMMV
+	* Users are responsible for their own products' functionality and performance.
+
+# FAQ
+
+	If git clone fail, try the solution below:
+	* Please configure the proxy according to your proxy setting before git clone
+	* Please configure the system date up-to-date before git clone
+	* Please reboot your system before git clone
+```
+
 ### Yocto
 
 #### *For compilation:*
@@ -125,65 +188,30 @@ Method 2:
 # In order to compile under Ubuntu, these packages need to be installed first (using sudo apt-get install ....) :
 	* autoconf
 	* build-essential
+	* cmake
 	* gawk
 	* gcc
 	* gnuplot
+	* pkg-config
+	* zlib1g
+	* zlib1g-dev
 	* libelf-dev
 	* libjson-c-dev
 	* xterm
+	* iperf3
+	* linuxptp
 
 NOTE: ensure your proxy settings are correct.
+NOTE: All the packages can be install by using the packages_installer.sh above.
 ```
 
-### IOTG Custom Libbpf & Open62541
-
-#### *Installation script:*
+#### *For run-time:*
 ```
-# In order to ease the installation of the customized helper libraries needed, we have provide a installation scripts to install libbpf and open62541.
-# The scripts will check out a specific version of the libraries from upstream git and apply our patches on top of it.
-
-# Suggestion is to use the overwriting installer script (after having kept the original libbpf and libopen62541 in a safe place).
-# This will ensure the tsn ref sw will be able to find/use correct libraries.
-
-NOTE: If your kernel support for Intel XDP+TBS, please ensure the '__u64 txtime' descriptor is available in struct xdp_desc() in /usr/include/linux/if_xdp.h as example below:
-
-/* Rx/Tx descriptor */
-struct xdp_desc {
-        __u64 addr;
-        __u32 len;
-        __u32 options;
-        __u64 txtime;
-};
-
-WARNING: You are able to install libbpf & open62541 without the 'txtime' descriptor but you might facing error/failure during the tests.
-
-# The dependencies installer branch : https://github.com/intel/iotg_tsn_ref_sw
-# Branch name : **master**
-# Use the commands below to install the dependencies:
-
-	cd dependencies
-	./libbpf_open62541_installer.sh --overwrite
-
-# Currently the dependencies installer only support the overwrite installation.
-# WIP to enhance the installer in a better way.
-# NOTE: If you are installing the libbpf and libopen62541-iotg manually, there is a chance the related open62541-iotg.pc file is not there.
-# Hence, you might have to comment out this line in **configure.ac**.
-
-**AM_CONDITIONAL([WITH_OPCUA], [test "x$no_open62541_iotg_fork" = "x0"] && test "x${HAVE_XDP}" = "xyes")**
-
-# Disclaimer
-	* The dependencies installers only serves to install dependencies for libbpf and open62541
-	* This project is not for intended for production use.
-	* This project is intended to be used with specific platforms and bsp, other
-  	  hardware/software combinations YMMV
-	* Users are responsible for their own products' functionality and performance.
-
-# FAQ
-
-	If git clone fail, try the solution below:
-	* Please configure the proxy according to your proxy setting before git clone
-	* Please configure the system date up-to-date before git clone
-	* Please reboot your system before git clone
+	* [Real-Time Ubuntu 22.04](https://ubuntu.com/real-time)
+	* iproute2 v5.15.0 [with real-time patches](https://github.com/intel/iotg-yocto-ese-main/tree/master/recipes-connectivity/iproute2/iproute2)
+	* [ethtool](https://salsa.debian.org/kernel-team/ethtool) [with real-time patches](https://github.com/intel/iotg-yocto-ese-main/tree/master/recipes-extended/ethtool/ethtool)
+	* linuxptp [v3.0 or later](https://github.com/richardcochran/linuxptp/releases/tag/v3.0)
+	* Python 3.8.2
 ```
 
 ## Build
@@ -252,8 +280,7 @@ For details information please refer to the documentation below:
 
 * This project is not for intended for production use.
 
-* This project is intended to be used with specific platforms and bsp, other
-  hardware/software combinations YMMV
+* This project is intended to be used with specific platforms and bsp, other HW/SW combinations YMMV
 
 * Users are responsible for their own products' functionality and performance.
 

diff --git a/README_json.md b/README_json.md
@@ -49,6 +49,11 @@ OPCUA-SERVER is a C-application that can transmit and receive ETH_UADP packets u
 AF_PACKET or AF_XDP sockets using libopen62541 (OPCUA-based library) APIs. It
 accepts only 1 .json.i file as input.
 
+
+**NOTE:** The `PLAT` command line argument refers to either the CPU platform 
+or the ethernet controller (e.g. the [i225](json/i225)), see in [json folder](json) 
+the available platforms.
+
 ### About: 1-port
 
 Very simple, just 1 pub/sub thread
@@ -76,7 +81,7 @@ each other via a single-ethernet connection.
     ./run.sh $PLAT $IFACE opcua-pkt1a setup
     ```
 
-2.  [Board A] Run the setup script to initialize IP and MAC address, then start
+2.  [Board B] Run the setup script to initialize IP and MAC address, then start
     clock synchronization and setup ingress qdisc.
 
     ```sh
@@ -91,7 +96,7 @@ each other via a single-ethernet connection.
     ./run.sh $PLAT $IFACE opcua-pkt1b run
     ```
 
-4.  [Board B] Immediately after step 3, start transmitting packets. The
+4.  [Board A] Immediately after step 3, start transmitting packets. The
     application will terminate itself after completion. Note that AF_PACKET or
     opcua-pkt* configurations will take longer as they use much higher packet
     intervals compared to AF_XDP or opuca-xdp* configurations.

diff --git a/README_shell.md b/README_shell.md
@@ -29,6 +29,10 @@ to each other via an Ethernet connection and user has a terminal open in the
 This example requires multiple pin header connections for (pulse-per-second)
 PPS and (auxiliary timestamping) AUXTS.
 
+**NOTE:** The `PLAT` command line argument refers to either the CPU platform 
+or the ethernet controller (e.g. the [i225](shell/i225)), see in [shell folder](shell) 
+the available platforms.
+
 0.  [Board A & B] Build the project.
 
     ```sh

diff --git a/Security.md b/Security.md
@@ -0,0 +1,5 @@
+# Security Policy
+Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation.
+
+## Reporting a Vulnerability
+Please report any security vulnerabilities in this project [utilizing the guidelines here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html).
diff --git a/build.sh b/build.sh
@@ -56,7 +56,7 @@ echo "OS Distro: $os_distro"
 
 # Check for default shell
 echo -e "\nBUILD.SH: Checking for Bash shell"
-if [ "$os_distro" == "\"Ubuntu"\" ]; then
+if [[ "$os_distro" == '"Ubuntu"' ]]; then
 	bash_shell=$(ls -la /usr/bin | grep -i 'bash' > /dev/null && echo 0 || echo 1)
 else
 	bash_shell=$(ls -la /bin/sh | grep -i 'bash' > /dev/null && echo 0 || echo 1)

diff --git a/common/irq_affinity_2c_4TxRx.map b/common/irq_affinity_2c_4TxRx.map
@@ -1,3 +1,4 @@
 TxRx-0,01,PTP (highest priority)
-TxRx-2,01,af_xdp/af_packet
-TxRx-3,02,iperf3 (least priority)
+TxRx-1,01,unused
+TxRx-2,02,af_xdp/af_packet
+TxRx-3,01,iperf3 (least priority)
diff --git a/common/liveplot.gnu b/common/liveplot.gnu
@@ -36,6 +36,10 @@ set ylabel "PHC difference (ns)"
 set xlabel "t(s)"
 
 plot filename using ($3) with lines title "nano-seconds"
-pause 1
-reread
+
+do for [i=0:100] {
+        pause 1
+        replot
+    }
+
 set autoscale
diff --git a/dependencies/helpers.sh → dependencies/deprecated/helpers.sh b/dependencies/helpers.sh → dependencies/deprecated/helpers.sh
diff --git a/dependencies/libbpf_open62541_installer.sh → .../deprecated/libbpf_open62541_installer.sh b/dependencies/libbpf_open62541_installer.sh → .../deprecated/libbpf_open62541_installer.sh