doc/guides/platform/octeontx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Cavium, Inc
   3
   4 OCTEONTX Board Support Package
   5 ==============================
   6
   7 This doc has information about steps to setup octeontx platform
   8 and information about common offload hw block drivers of
   9 **Cavium OCTEONTX** SoC family.
  10
  11
  12 More information about SoC can be found at `Cavium, Inc Official Website
  13 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
  14
  15 Common Offload HW Block Drivers
  16 -------------------------------
  17
  18 1. **Eventdev Driver**
  19    See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver
  20    information.
  21
  22 2. **Mempool Driver**
  23    See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver
  24    information.
  25
  26 Steps To Setup Platform
  27 -----------------------
  28
  29 There are three main pre-prerequisites for setting up Platform drivers on
  30 OCTEONTX compatible board:
  31
  32 1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**
  33
  34    The OCTEONTX Linux kernel drivers (includes the required PF driver for the
  35    Platform drivers) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_
  36    along with build, install and dpdk usage instructions.
  37
  38 2. **ARM64 Tool Chain**
  39
  40    For example, the *aarch64* Linaro Toolchain, which can be obtained from
  41    `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
  42
  43 3. **Rootfile system**
  44
  45    Any *aarch64* supporting filesystem can be used. For example,
  46    Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
  47    from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
  48
  49    As an alternative method, Platform drivers can also be executed using images provided
  50    as part of SDK from Cavium. The SDK includes all the above prerequisites necessary
  51    to bring up a OCTEONTX board.
  52
  53    SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
  54
  55 - Follow the DPDK :doc: `../linux_gsg/index.rst` to setup the basic DPDK environment.