From patchwork Fri Sep 7 07:25:21 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 146181 Delivered-To: patch@linaro.org Received: by 2002:a2e:1648:0:0:0:0:0 with SMTP id 8-v6csp838545ljw; Fri, 7 Sep 2018 00:27:34 -0700 (PDT) X-Google-Smtp-Source: ANB0VdajOSkfwASTMO4s5mtSpdbUGxUWti1w88FRGF2nMN26odoSqJZuNiLsiSsz9i0Takfs/RhI X-Received: by 2002:adf:9503:: with SMTP id 3-v6mr4882497wrs.251.1536305253911; Fri, 07 Sep 2018 00:27:33 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1536305253; cv=none; d=google.com; s=arc-20160816; b=eZ1x8Ot+ap+RMDYkohPNeQMccCdywAuxtH1i+XmUGLIoedQzynTgjfUGMboZRRwCxc q+xxM9xa3sAb7A9pI8RvJyswZiyoV02BxQ4gDCT1Td2bxavY572pigB0ukekjxS8wHyd Gtrs150lA83SPlLyji1gkNtVCnyGg43cJ4tRjJqR3ksmmRTYXkSg6jfXal0PTH3+YCEI Wbwcun8eaFwizdPaQtXRxMrICVL9RCoVcr60Ki5Eww7lSp6stsjMiSLxa4seklnB9HSV acN6IbwWEfVJmZOvjTCmNq6cJhYIxY5JuTuorLml1jXPScXyuBJZ0yBdqe+0IIxfVFUU Pltg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:cc:to:from; bh=T66fV0fdY9kQ7Z0IotwFjokDZXjxUxFbpA1ExoOjAmw=; b=XpN88uZMW4YtcBnnQ0HQL8X4rsAUtEes5o43RiTpnJHNeH2pN7Ig6Zvx2l24lQUc48 bH0qzJJSumLVWZMe9R1Loz8KIwX4HcnLyaqLtPB8Fy6e/LheX8mesfJJ6cjmBRWBwojs uCgmCRsTIr3A1uuiJoPZQFqfsg8ysjZuxbBHuvW9CBkvfmBFr90jK4VOegm9tFZ0HjUN 9L1uOXwn9HEXe4rcJx37+zPbwiCRMzSU6XgAoKTCBLkis9CSDVyZrdZkadPHiDl9tWGn 7sFmVe/oiw1oEhX8JA6z/btysdOZ8HKvCFeNjIYZeDXOk4GD4+rRwnanBdt4Iyxi7dd/ 34oA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=nxp.com Return-Path: Received: from dpdk.org (dpdk.org. [92.243.14.124]) by mx.google.com with ESMTP id v6-v6si7377305wra.377.2018.09.07.00.27.33; Fri, 07 Sep 2018 00:27:33 -0700 (PDT) Received-SPF: pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) client-ip=92.243.14.124; Authentication-Results: mx.google.com; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=nxp.com Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 97D8B4CBD; Fri, 7 Sep 2018 09:27:21 +0200 (CEST) Received: from inva021.nxp.com (inva021.nxp.com [92.121.34.21]) by dpdk.org (Postfix) with ESMTP id 32DFF3256 for ; Fri, 7 Sep 2018 09:27:17 +0200 (CEST) Received: from inva021.nxp.com (localhost [127.0.0.1]) by inva021.eu-rdc02.nxp.com (Postfix) with ESMTP id 1101F200011; Fri, 7 Sep 2018 09:27:17 +0200 (CEST) Received: from invc005.ap-rdc01.nxp.com (invc005.ap-rdc01.nxp.com [165.114.16.14]) by inva021.eu-rdc02.nxp.com (Postfix) with ESMTP id 6698520009E; Fri, 7 Sep 2018 09:27:15 +0200 (CEST) Received: from bf-netperf1.ap.freescale.net (bf-netperf1.ap.freescale.net [10.232.134.28]) by invc005.ap-rdc01.nxp.com (Postfix) with ESMTP id 37B194030E; Fri, 7 Sep 2018 15:27:13 +0800 (SGT) From: Hemant Agrawal To: dev@dpdk.org Cc: john.mcnamara@intel.com Date: Fri, 7 Sep 2018 12:55:21 +0530 Message-Id: <1536305122-23322-3-git-send-email-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1536305122-23322-1-git-send-email-hemant.agrawal@nxp.com> References: <1535614772-20886-1-git-send-email-hemant.agrawal@nxp.com> <1536305122-23322-1-git-send-email-hemant.agrawal@nxp.com> MIME-Version: 1.0 X-Virus-Scanned: ClamAV using ClamSMTP Subject: [dpdk-dev] [PATCH v2 3/4] doc: create a platorm specific page for NXP DPAA2 platform X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Hemant Agrawal --- doc/guides/platform/dpaa2.rst | 98 +++++++++++++++++++++++++++++++++++++++++++ doc/guides/platform/index.rst | 1 + 2 files changed, 99 insertions(+) create mode 100644 doc/guides/platform/dpaa2.rst -- 2.7.4 diff --git a/doc/guides/platform/dpaa2.rst b/doc/guides/platform/dpaa2.rst new file mode 100644 index 0000000..e9f4399 --- /dev/null +++ b/doc/guides/platform/dpaa2.rst @@ -0,0 +1,98 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + +NXP QorIQ DPAA2 Board Support Package +===================================== + +This doc has information about steps to setup NXP QoriQ DPAA2 platform +and information about common offload hw block drivers of +**NXP QorIQ DPAA2** SoC family. + +Supported DPAA2 SoCs +-------------------- + +- LX2160A +- LS2084A/LS2044A +- LS2088A/LS2048A +- LS1088A/LS1048A + +More information about SoC can be found at `NXP Official Website +`_. + + +Common Offload HW Block Drivers +------------------------------- + +1. **Nics Driver** + See :doc:`../nics/dpaa2` for NXP dpaa2 nic driver information. + +2. **Cryptodev Driver** + See :doc:`../cryptodevs/dpaa2_sec` for NXP dpaa2 cryptodev driver information. + +3. **Eventdev Driver** + See :doc:`../eventdevs/dpaa2` for NXP dpaa2 eventdev driver information. + + +Steps To Setup Platform +----------------------- + +There are four main pre-requisities for executing DPAA2 PMD on a DPAA2 +compatible board: + +1. **ARM 64 Tool Chain** + + For example, the `*aarch64* Linaro Toolchain `_. + +2. **Linux Kernel** + + It can be obtained from `NXP's Github hosting `_. + +3. **Rootfile system** + + Any *aarch64* supporting filesystem can be used. For example, + Ubuntu 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained + from `here + `_. + +4. **Resource Scripts** + + DPAA2 based resources can be configured easily with the help of ready scripts + as provided in the DPDK Extra repository. + +As an alternative method, DPAA2 PMD can also be executed using images provided +as part of SDK from NXP. The SDK includes all the above prerequisites necessary +to bring up a DPAA2 board. + +The following dependencies are not part of DPDK and must be installed +separately: + +- **NXP Linux SDK** + + NXP Linux software development kit (SDK) includes support for family + of QorIQ® ARM-Architecture-based system on chip (SoC) processors + and corresponding boards. + + It includes the Linux board support packages (BSPs) for NXP SoCs, + a fully operational tool chain, kernel and board specific modules. + + SDK and related information can be obtained from: `NXP QorIQ SDK `_. + + +.. _extra_scripts: + +- **DPDK Extra Scripts** + + DPAA2 based resources can be configured easily with the help of ready scripts + as provided in the DPDK Extra repository. + + `DPDK Extras Scripts `_. + +Currently supported by DPDK: + +- NXP SDK **2.0+** (preferred: LSDK 18.09). +- MC Firmware version **10.10.0** and higher. +- Supported architectures: **arm64 LE**. + +- Follow the DPDK :ref:`Getting Started Guide for Linux ` + to setup the basic DPDK environment. diff --git a/doc/guides/platform/index.rst b/doc/guides/platform/index.rst index fc7c6d4..98c6638 100644 --- a/doc/guides/platform/index.rst +++ b/doc/guides/platform/index.rst @@ -11,4 +11,5 @@ The following are platform specific guides and setup information. :numbered: dpaa + dpaa2 octeontx