1a9263e3cSJerin Jacob.. SPDX-License-Identifier: BSD-3-Clause 2a9263e3cSJerin Jacob Copyright(c) 2017 Cavium, Inc 326cb0a72SSantosh Shukla 426cb0a72SSantosh ShuklaOCTEON TX Board Support Package 5*95a6b04fSAnoob Joseph=============================== 626cb0a72SSantosh Shukla 7*95a6b04fSAnoob JosephThis doc has information about steps to setup OCTEON TX platform 826cb0a72SSantosh Shuklaand information about common offload hw block drivers of 926cb0a72SSantosh Shukla**Cavium OCTEON TX** SoC family. 1026cb0a72SSantosh Shukla 1126cb0a72SSantosh Shukla 1226cb0a72SSantosh ShuklaMore information about SoC can be found at `Cavium, Inc Official Website 1326cb0a72SSantosh Shukla<http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_. 1426cb0a72SSantosh Shukla 1526cb0a72SSantosh ShuklaCommon Offload HW Block Drivers 1626cb0a72SSantosh Shukla------------------------------- 1726cb0a72SSantosh Shukla 1826cb0a72SSantosh Shukla1. **Eventdev Driver** 1949781e37SPavan Nikhilesh See :doc:`../eventdevs/octeontx` for octeontx ssovf eventdev driver 2026cb0a72SSantosh Shukla information. 2126cb0a72SSantosh Shukla 2248191ddeSSantosh Shukla2. **Mempool Driver** 2349781e37SPavan Nikhilesh See :doc:`../mempool/octeontx` for octeontx fpavf mempool driver 2448191ddeSSantosh Shukla information. 2548191ddeSSantosh Shukla 2626cb0a72SSantosh ShuklaSteps To Setup Platform 2726cb0a72SSantosh Shukla----------------------- 2826cb0a72SSantosh Shukla 2926cb0a72SSantosh ShuklaThere are three main pre-prerequisites for setting up Platform drivers on 3026cb0a72SSantosh ShuklaOCTEON TX compatible board: 3126cb0a72SSantosh Shukla 3226cb0a72SSantosh Shukla1. **OCTEON TX Linux kernel PF driver for Network acceleration HW blocks** 3326cb0a72SSantosh Shukla 3426cb0a72SSantosh Shukla The OCTEON TX Linux kernel drivers (includes the required PF driver for the 3526cb0a72SSantosh Shukla Platform drivers) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_ 3626cb0a72SSantosh Shukla along with build, install and dpdk usage instructions. 3726cb0a72SSantosh Shukla 3826cb0a72SSantosh Shukla2. **ARM64 Tool Chain** 3926cb0a72SSantosh Shukla 4026cb0a72SSantosh Shukla For example, the *aarch64* Linaro Toolchain, which can be obtained from 4126cb0a72SSantosh Shukla `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_. 4226cb0a72SSantosh Shukla 4326cb0a72SSantosh Shukla3. **Rootfile system** 4426cb0a72SSantosh Shukla 4526cb0a72SSantosh Shukla Any *aarch64* supporting filesystem can be used. For example, 4626cb0a72SSantosh Shukla Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained 4726cb0a72SSantosh Shukla from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_. 4826cb0a72SSantosh Shukla 4926cb0a72SSantosh Shukla As an alternative method, Platform drivers can also be executed using images provided 5026cb0a72SSantosh Shukla as part of SDK from Cavium. The SDK includes all the above prerequisites necessary 5126cb0a72SSantosh Shukla to bring up a OCTEON TX board. 5226cb0a72SSantosh Shukla 5326cb0a72SSantosh Shukla SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_. 5426cb0a72SSantosh Shukla 5549781e37SPavan Nikhilesh- Follow the DPDK :doc:`../linux_gsg/index` to setup the basic DPDK environment. 56