2 Copyright (C) Cavium, Inc. 2017. All rights reserved.
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions
8 * Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 * Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in
12 the documentation and/or other materials provided with the
14 * Neither the name of Cavium, Inc nor the names of its
15 contributors may be used to endorse or promote products derived
16 from this software without specific prior written permission.
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 OCTEONTX Board Support Package
31 ==============================
33 This doc has information about steps to setup octeontx platform
34 and information about common offload hw block drivers of
35 **Cavium OCTEONTX** SoC family.
38 More information about SoC can be found at `Cavium, Inc Official Website
39 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
41 Common Offload HW Block Drivers
42 -------------------------------
44 1. **Eventdev Driver**
45 See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver
48 Steps To Setup Platform
49 -----------------------
51 There are three main pre-prerequisites for setting up Platform drivers on
52 OCTEONTX compatible board:
54 1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks**
56 The OCTEONTX Linux kernel drivers (includes the required PF driver for the
57 Platform drivers) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/octeontx-kmod>`_
58 along with build, install and dpdk usage instructions.
60 2. **ARM64 Tool Chain**
62 For example, the *aarch64* Linaro Toolchain, which can be obtained from
63 `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
65 3. **Rootfile system**
67 Any *aarch64* supporting filesystem can be used. For example,
68 Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
69 from `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
71 As an alternative method, Platform drivers can also be executed using images provided
72 as part of SDK from Cavium. The SDK includes all the above prerequisites necessary
73 to bring up a OCTEONTX board.
75 SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
77 - Follow the DPDK :doc: `../linux_gsg/index.rst` to setup the basic DPDK environment.