X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Focteontx.rst;h=8e2a2b75b09a87f4381785c07a3889c980a9f0b7;hb=aed545af1b5ed6b7baa2eb41bad63486d6c95226;hp=a6631cd0e30adb05dfc1fa9051f4e40fc8e4ce1b;hpb=f820b589663116403d8f530d777ed28ae7ec7dd6;p=dpdk.git diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst index a6631cd0e3..8e2a2b75b0 100644 --- a/doc/guides/nics/octeontx.rst +++ b/doc/guides/nics/octeontx.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright (C) Cavium, Inc. 2017. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Cavium, Inc nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2017 Cavium, Inc OCTEONTX Poll Mode driver ========================= @@ -71,34 +44,7 @@ The features supported by the device and not yet supported by this PMD include: Prerequisites ------------- -There are three main pre-perquisites for executing OCTEONTX PMD on a OCTEONTX -compatible board: - -1. **OCTEONTX Linux kernel PF driver for Network acceleration HW blocks** - - The OCTEONTX Linux kernel drivers (including the required PF driver for the - all network acceleration blocks) are available on GitHub at - `octeontx-kmod `_ - along with build, install and dpdk usage instructions. - -2. **ARM64 Tool Chain** - - For example, the *aarch64* Linaro Toolchain, which can be obtained from - `here `_. - -3. **Rootfile system** - - Any *aarch64* supporting filesystem can be used. For example, - Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained - from ``_. - - As an alternative method, OCTEONTX PMD 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. - - SDK and related information can be obtained from: `Cavium support site `_. - -Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. +See :doc:`../platform/octeontx` for setup information. Pre-Installation Configuration ------------------------------ @@ -113,27 +59,6 @@ Please note that enabling debugging options may affect system performance. Toggle compilation of the ``librte_pmd_octeontx`` driver. -- ``CONFIG_RTE_LIBRTE_OCTEONTX_DEBUG_DRIVER`` (default ``n``) - - Toggle display of generic debugging messages - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_DEBUG_INIT`` (default ``n``) - - Toggle display of initialization related messages. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_DEBUG_RX`` (default ``n``) - - Toggle display of receive path message - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_DEBUG_TX`` (default ``n``) - - Toggle display of transmit path message - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_DEBUG_MBOX`` (default ``n``) - - Toggle display of mbox related message - - Driver compilation and testing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -163,8 +88,8 @@ following ``make`` command: --mbuf-pool-ops-name="octeontx_fpavf" \ --vdev='event_octeontx' \ --vdev='eth_octeontx,nr_port=2' \ - -- --rxq=1 --txq=1 --nb-core=2 --total-num-mbufs=16384 \ - --disable-hw-vlan-filter -i + -- --rxq=1 --txq=1 --nb-core=2 \ + --total-num-mbufs=16384 -i ..... EAL: Detected 24 lcore(s) EAL: Probing VFIO support... @@ -222,7 +147,7 @@ Example: .. code-block:: console - ./your_dpdk_application --mbuf-pool-ops="octeontx_fpavf" \ + ./your_dpdk_application --mbuf-pool-ops-name="octeontx_fpavf" \ --vdev='event_octeontx' \ --vdev="eth_octeontx,nr_port=2"