X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fplatform%2Focteontx.rst;h=42ddb1762efa775c3eea8f94844b9a5bd0080d6b;hb=19f3af2371a7fdc549cbc270c298be156b3bd545;hp=dc1aa4fe16dc2e2d29f72bde31acefbb29a367ca;hpb=a9263e3c5ad0b71adb95d686c1c3153865b0e1d2;p=dpdk.git diff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst index dc1aa4fe16..42ddb1762e 100644 --- a/doc/guides/platform/octeontx.rst +++ b/doc/guides/platform/octeontx.rst @@ -1,12 +1,12 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Cavium, Inc -OCTEONTX Board Support Package -============================== +OCTEON TX Board Support Package +=============================== -This doc has information about steps to setup octeontx platform +This doc has information about steps to setup OCTEON TX platform and information about common offload hw block drivers of -**Cavium OCTEONTX** SoC family. +**Cavium OCTEON TX** SoC family. More information about SoC can be found at `Cavium, Inc Official Website @@ -15,26 +15,36 @@ More information about SoC can be found at `Cavium, Inc Official Website Common Offload HW Block Drivers ------------------------------- -1. **Eventdev Driver** - See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver +1. **Crypto Driver** + See :doc:`../cryptodevs/octeontx` for octeontx crypto driver information. -2. **Mempool Driver** - See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver +2. **Eventdev Driver** + See :doc:`../eventdevs/octeontx` for octeontx ssovf eventdev driver + information. + +3. **Mempool Driver** + See :doc:`../mempool/octeontx` for octeontx fpavf mempool driver information. Steps To Setup Platform ----------------------- There are three main pre-prerequisites for setting up Platform drivers on -OCTEONTX compatible board: +OCTEON TX compatible board: -1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks** +1. **OCTEON TX Linux kernel PF driver for Network acceleration HW blocks** - The OCTEONTX Linux kernel drivers (includes the required PF driver for the + The OCTEON TX Linux kernel drivers (includes the required PF driver for the Platform drivers) are available on Github at `octeontx-kmod `_ along with build, install and dpdk usage instructions. +.. note:: + + The PF driver and the required microcode for the crypto offload block will be + available with OCTEON TX SDK only. So for using crypto offload, follow the steps + mentioned in :ref:`setup_platform_using_OCTEON_TX_SDK`. + 2. **ARM64 Tool Chain** For example, the *aarch64* Linaro Toolchain, which can be obtained from @@ -48,8 +58,91 @@ OCTEONTX compatible board: As an alternative method, Platform drivers can also be executed using images provided as part of SDK from Cavium. The SDK includes all the above prerequisites necessary - to bring up a OCTEONTX board. + to bring up a OCTEON TX board. Please refer :ref:`setup_platform_using_OCTEON_TX_SDK`. + +- Follow the DPDK :doc:`../linux_gsg/index` to setup the basic DPDK environment. + +.. _setup_platform_using_OCTEON_TX_SDK: + +Setup Platform Using OCTEON TX SDK +---------------------------------- + +The OCTEON TX platform drivers can be compiled either natively on +**OCTEON TX** :sup:`®` board or cross-compiled on an x86 based platform. + +The **OCTEON TX** :sup:`®` board must be running the linux kernel based on +OCTEON TX SDK 6.2.0 patch 3. In this, the PF drivers for all hardware +offload blocks are already built in. + +Native Compilation +~~~~~~~~~~~~~~~~~~ + +If the kernel and modules are cross-compiled and copied to the target board, +some intermediate binaries required for native build would be missing on the +target board. To make sure all the required binaries are available in the +native architecture, the linux sources need to be compiled once natively. + +.. code-block:: console + + cd /lib/modules/$(uname -r)/source + make menuconfig + make + +The above steps would rebuild the modules and the required intermediate binaries. +Once the target is ready for native compilation, the OCTEON TX platform +drivers can be compiled with the following steps, + +.. code-block:: console + + meson build -Dexamples= + ninja -C build + +The example applications can be compiled using the following: + +.. code-block:: console + + meson build -Dexamples= + ninja -C build + +Cross Compilation +~~~~~~~~~~~~~~~~~ + +The DPDK applications can be cross-compiled on any x86 based platform. The +OCTEON TX SDK need to be installed on the build system. The SDK package will +provide the required toolchain etc. + +Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details. + +The following steps can be used to perform cross-compilation with OCTEON TX +SDK 6.2.0 patch 3: + +.. code-block:: console + + cd + source env-setup + +The above steps will prepare build system with required toolchain. +Now this build system can be used to build applications for **OCTEON TX** :sup:`®` platforms. + +.. code-block:: console + + cd + meson build --cross-file config/arm/arm64_thunderx_linux_gcc + ninja -C build + +The example applications can be compiled using the following: + +.. code-block:: console + + cd + meson build --cross-file config/arm/arm64_thunderx_linux_gcc -Dexamples= + ninja -C build + +.. note:: - SDK and related information can be obtained from: `Cavium support site `_. + By default, meson cross compilation uses ``aarch64-linux-gnu-gcc`` toolchain, + if OCTEON TX SDK 6.2.0 patch 3 is available then it can be used by + overriding the c, cpp, ar, strip ``binaries`` attributes to respective thunderx + toolchain binaries in ``config/arm/arm64_thunderx_linux_gcc`` file. -- Follow the DPDK :doc: `../linux_gsg/index.rst` to setup the basic DPDK environment. +SDK and related information can be obtained from: `Cavium support site `_.