The Q2 release version will be v22.06.
The unnecessary links to document files are removed.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I337c4941095f861fe7d2fe9c7556dfbae229f19e

'set -x' prints shell commands and their arguments as they are executed
which makes the output of setup.sh too verbose to follow, so disable the
verbose output for end users to capture critical messages more easily.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ie5c012e88603d4989fa46e4788d32265630e55a0

The git-repo has to be installed manually because repo installed via
apt-get has issues on Ubuntu.
Updated the utilities required if running solution on a fresh installed
environment.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I9591181a77cea5239091835da61295fb4269fef3

The solution use cases are validated on Ampere Altra and Ubuntu 20.04
platform, so limit the supported platforms to Ampere Altra only.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Ib88ce3a773911617d7c8e85dbef84c1e35dcd5ab

Briefly decribe what VPP IPv4 L3fwd is and how it works in user guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I63928fe07db4b773b5249764bb034c95c8ebf576

Tianyu Li authored Jun 06, 2022 and Lijian Zhang committed Jun 09, 2022

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I18dc47f95add24a9102083171000d1ba8ab679b9

Tianyu Li authored Jun 01, 2022 and Lijian Zhang committed Jun 09, 2022

Add ARP entry to resolve MAC address for next hop,
no longer depends on traffic generator's ARP reply.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I77860bce9677a33d010a2748005fde6f49409269

Tianyu Li authored May 17, 2022 and Lijian Zhang committed Jun 09, 2022

- Remove unused section
- Add steps on setup and build
- Validate ip route entry
- Add extra port guide
- Add links to support other types of NIC
- Add advanced instructions

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ieb4ae759aa6dcaf1d6b6b2ee9a27862a3719bacb

Nathan Brown authored May 11, 2022 and Lijian Zhang committed Jun 09, 2022

Add following sections to the common user guide section:
- Download code
- Configure DUT
- Build
- Reboot.

Add the following sections to the DPDK user guide:
- Examples for commands to run other than quickstart provided command
- Validating with traffic flow
- Instructions on RSS
- Instructions on modifying default forwarding rules for FIB/EM/LPM
- Add Resources section
- Include multiple drop-down sections for further details
- Apply more consistent formatting
- Remove pronoun usage

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Ia46ddc88f4b1050f48ce35a84be44ed1a6ea3c9d

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

Make the description of the DPDK devbind script in stop section of the
l3fwd application consistent with bind section.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I622ec304a19c26f3fc8a096ea338ac7e889ac43e

Tianyu Li authored May 30, 2022 and Lijian Zhang committed Jun 09, 2022

VPP version 22.02 has a known issue and doesn't support invoke with
relative path without './'.
Add './' to invoke VPP with relative path in the quickstart guide.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: Ibcc96bd0e7df7ced96367e10067bd40abb2b5db5

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

When VPP boots up, it displays warnings about unsupported PCI devices
and errors about plugins which are not loaded by default. There might
be other errors which can be ignored safely for the use cases
in quick start guide.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: Idd3d302641bcae14a5b81268706c45a38b9e6414

Honnappa Nagarahalli authored May 26, 2022 and Lijian Zhang committed Jun 09, 2022

Prefix sudo to commands that need root privileges. This is more accurate
and improves user experience.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I1c480ab1ccb9cdb0a1f7ab04016908bb4968e7dc

Add information on expected end users and their skills.
Improve DUT hardware and software requirements.
Add reference to changelog.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: Iafe47541833bd12adedbbcfc2381fa64f311d900

Nathan Brown authored May 20, 2022 and Lijian Zhang committed Jun 09, 2022

This commit cleans up multiple things in the quickstart
guide. Notably, it:
    - applies consistent formatting
    - applies consistent naming
    - rearranges some headings and their levels
    - improves phrasing of certain sections for clarity and brevity
    - keeps setup.sh echos consistent with quickstart guide
    - has setup.sh install lshw package in case user does not have it
      installed

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I951e94fae5d580d9b816321b6b809dc36e451ee9

Nathan Brown authored May 13, 2022 and Lijian Zhang committed Jun 09, 2022

Adds explanation of dpdk-devbind.py to quickstart guide.
Also fixes minor formatting issue in quickstart guide.

Signed-off-by: Nathan Brown <nathan.brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I1a8b96f791367ccbdfb0c0146e242b06aa9f8516

Honnappa Nagarahalli authored May 23, 2022 and Lijian Zhang committed Jun 09, 2022

Add makefile targets to build DPDK, VPP, and to build all the components.
With this the build.sh is not required. This will make building the
code and the documents look similar.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>

Change-Id: I2d9ced7cc7a6a275463a0ad1546f14a4ed8202e1

Remove all placeholder directories, including build, scripts and src.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>

Change-Id: I5a7ccfe9540251473387ed17d376af0c34aff5ed

Honnappa Nagarahalli authored May 20, 2022 and Lijian Zhang committed Jun 09, 2022

The tools targets in the makefile at the base directory are moved
to another makefile under the tools directory. This provides a cleaner
separation for tools targets.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I03704a8b5e029110f6936d3e878f1e09dd31914e

Tianyu Li authored May 11, 2022 and Lijian Zhang committed Jun 09, 2022

Change to use virtual-env to install pip requirement

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I26588acf117839090d98236d472ac933277573d0

Tianyu Li authored Apr 21, 2022 and Lijian Zhang committed Jun 09, 2022

1. Add VPP in build.sh
2. Add VPP IPv4 forward use case to quickstart guide and user guide

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I88a48c818ed6f7fe70bc94776ef87cbe739466a9

The commit log check tool is ported from DPDK project. As DPDK project
is BSD-3-Clause License, so keep the license exceptions in LICENSE.rst
file.
Add commit log check target in Makefile.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Id103f616d621ec0c6f3f0bb6b28614ab13d7634d

Print the files with license text issues without any additional user
input.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: I3dbdd4b9b045f5735e4938059cdeacc4b26853ab

Dharmik Thakkar authored Apr 27, 2022 and Lijian Zhang committed Jun 09, 2022

- Update build script:
  * Remove 'git clone' as repos are managed through manifest file
  * Update directory structure to match the one in manifest file
- Replace quickstart.md with doc/quickstart.rst
- Update DPDK L3 Fwd application in user guide
- Update README.md
  * Remove reference to specific solutions releases
  * To point to quickstart and user guides

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>

Change-Id: Iee9d3b1c9fe8ae1d49aeed8d36173d74bdbf3266

Tianyu Li authored May 07, 2022 and Lijian Zhang committed Jun 09, 2022

The components directory contains code from upstream projects.
There is no need to run license-check and license-fix in those
directories.

Signed-off-by: Tianyu Li <tianyu.li@arm.com>
Reviewed-by: Lijian Zhang <lijian.zhang@arm.com>

Change-Id: I95a0758feef8293a1dd08be0dd2d2f4e029d0e87

Add scripts to identify and fix issues with license text in various files.
Update files with license text issues using these scripts.
Use 'make license-check' to identify license issues and 'make license-fix'
to fix the issues.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I33b88f00830aba4471c8065256815a1421cab76f

Add Sphinx based documentation and the infrastructure to build documentation.
Along with this add overview and place holders for user guide.

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Tianyu Li <Tianyu.Li@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: I14c705af4c148b3fbbc0b779af2c1e1e0f108d7f

Honnappa Nagarahalli authored May 02, 2022 and Lijian Zhang committed Jun 09, 2022

Fix the DPDK l3fwd command and add the requirement of root privileges.
Add the setup step, run and test section headings. Fix few typos.

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: Iebae259cee36b0b8f2f4b45a7270143ab4f5e744

Honnappa Nagarahalli authored May 02, 2022 and Lijian Zhang committed Jun 09, 2022

Build script checks out v21.11 release of DPDK.

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Malvika Gupta <malvika.gupta@arm.com>
Reviewed-by: Nathan Brown <Nathan.Brown@arm.com>

Change-Id: Ibddc5d5116a438d5c5061246b20da7e3cd2f0956

Dharmik Thakkar authored Mar 09, 2022 and Lijian Zhang committed Jun 09, 2022

Add the following files:
setup.sh - installs dependencies for all the components of the
           solution. Currently, dependencies for DPDK are added.
build.sh - builds all the components of the solution. Currently,
           builds DPDK.
quickstart.md - provides instructions on how to get started
CHANGELOG.md - contains the changes made in each release.
README.md - provides a brief introduction to the dataplane stack solution

Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Nathan Brown <nathan.brown@arm.com>

Change-Id: I8347ee52a3ba0562db61a24ae646f147a7a463c1

Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>

Change-Id: I69f449c504b2e263ede324de0a7de7523264c265