From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <Santosh.Shukla@cavium.com>
Received: from NAM03-CO1-obe.outbound.protection.outlook.com
(mail-co1nam03on0046.outbound.protection.outlook.com [104.47.40.46])
by dpdk.org (Postfix) with ESMTP id 091851B1F7
for <dev@dpdk.org>; Sun, 8 Oct 2017 14:41:28 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version;
bh=pKgJLfradW0cKeZr0l7MA3egm0DoPDE5Xxle09trvl4=;
b=NwLM8OKSPWnXePbdKZ0KEedg+iVvOjCCj0vE+hRg6QaxjwqlfpA3RkKftKZUl7xwLmypUYtXz9OmE10hpttvT9NJvHyzAv3b/4WsezKxDhMFhBMavzcFxv5BnNeclWUipg1QWQIavq00E+Wvj2uyrwPentYbcWGOEChu1/cB+04=
Authentication-Results: spf=none (sender IP is )
smtp.mailfrom=Santosh.Shukla@cavium.com;
Received: from localhost.localdomain (14.140.2.178) by
MWHPR07MB3103.namprd07.prod.outlook.com (10.172.95.9) with Microsoft SMTP
Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id
15.20.77.7; Sun, 8 Oct 2017 12:41:23 +0000
From: Santosh Shukla <santosh.shukla@caviumnetworks.com>
To: olivier.matz@6wind.com,
dev@dpdk.org
Cc: thomas@monjalon.net, jerin.jacob@caviumnetworks.com,
hemant.agrawal@nxp.com, Santosh Shukla <santosh.shukla@caviumnetworks.com>,
John McNamara <john.mcnamara@intel.com>
Date: Sun, 8 Oct 2017 18:10:11 +0530
Message-Id: <20171008124011.1577-11-santosh.shukla@caviumnetworks.com>
X-Mailer: git-send-email 2.14.1
In-Reply-To: <20171008124011.1577-1-santosh.shukla@caviumnetworks.com>
References: <20170831063719.19273-1-santosh.shukla@caviumnetworks.com>
<20171008124011.1577-1-santosh.shukla@caviumnetworks.com>
MIME-Version: 1.0
Content-Type: text/plain
X-Originating-IP: [14.140.2.178]
X-ClientProxiedBy: BMXPR01CA0045.INDPRD01.PROD.OUTLOOK.COM (10.174.214.31) To
MWHPR07MB3103.namprd07.prod.outlook.com (10.172.95.9)
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-Correlation-Id: ed7afd46-eef7-4a4f-7456-08d50e49e3f6
X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0;
RULEID:(22001)(2017030254152)(2017052603199)(201703131423075)(201703031133081)(201702281549075);
SRVR:MWHPR07MB3103;
X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3103;
3:VuWOuJ9p8cWpLCdDvmhUebhgFaTQ8eP0cn6wBAyhXU/tBYAmUyVOyypEdURzap1tx9+CvXLCkUIHl2+sKe7C+VW9YjkRRsbM0e0zXdsS8msB0Z7xVSUHdhqatiw/kY6ZduBmEJX1ExudfMBdDkiSrY38WVZSguxbeZ+i0SDSmwFxlyErXpCZC4pluX8iSav9kW1H1MRYjsWINxjDDlQN+zXbodJQCMU7XeV2n7lHOUi0SHlp5TbdazDka4Z9NbTi;
25:snh/Ir7goVosLcoyzS6vYaomxfrR3C2OclCisEf3cJam1Cy767fBBXQEaJa7cQEr0xjiQdvlNiQRcnMOwKrWKjgbSEAZkSSmGeeG+DZ9+7Hy5HoFQGUkkl2rMXlVpWk3COJpZtZC6Kpv/2oVae7TuepY6FrPyp+L6XquWUbw8ZK8t8FJlhjNET6kSBQymP1QNq4tS6VHfDy6r0IhznmC/dabH6VgDjFr6LDT/JvvStejZ/lo9hQQDkyOQyXevcsYiqVo9TD/bb32bNAyXDt5MX6dTMtrwCbz7BiKirvsyuTXsxso/1Y9aHcUQtw9l1XptfdOtcpg6uKmjW8RwY0kuA==;
31:bOsbsMogMydTmpe4SN7UvzS2d4B7oRk5rOpSTT5CdN/pVPBycnU/jJ4sM9XGDUGMJKrprZ02S4bYDEmCqa8peaAgO1/tdT5LrwfBjRfCd2Bcf+ZMlQT8Hk3gfRuum/4gdmrPETkCoJZ4Tjy9gN35WE8uak5NmeByEPQTlRi0HQYkNEcj1/gaxjoPS2BPANCN6LSRddl8kuTKaLFEdVvvWdoGgnGNUaTHjLYDy3KHm3o=
X-MS-TrafficTypeDiagnostic: MWHPR07MB3103:
X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3103;
20:alZkn+YMISPrswXZ7d7sYqsT8Ymfu3DhS/akw/3na5cHXih105E5/hWIgqaMmyd7HPnfa4BKsQlTpMxF1/iTI1xmlFtiJO+JnEk0L8NFiGp1F3BFdwifdAuXDkNc50hIIPqkCpgOIcxaJksnw/3uH9TH+drMjl6YLEUvFa9pbT4piTUuamXlEeCGY+CRHIY+Wku5Xd5a8JvEWVuWNw29CMQaF5TlfrAxf7JVOATW8XmfS7iIo252FB3eba1x8I851NRMSCd4oplLrxZYZLBZynNadTaQCfY0gz3FZaVi/tYbvjGfNbI0iTEYMAYco5aFMIZM4IzKTbEJ7jdrYoBjmc57/GaHw2Cy2BXy6fkeqtjGU4/+FGeG49AMa2YdyGDNslY40GSBtnxKknzwt1XLah4gcSrxrCxQTC9IvNCysZbSHwZ0h6OC5TXv/viGnPC6CCZkaCpCeKfkyJ9YQs8EvdXVSETj3REcuFo9SehKMksJXiCy8TicE/5/jFzDFejmAghwKcg1FY57qvCB9sQF9FTEWqRA1UFI09ORfbuROWgMsiXjU8+6cb+5jXg3tlRLXvRz6mEPjp9/kLl76y9k9pVZYEQKHIOesmbecO2ZFh0=
X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(228905959029699);
X-Microsoft-Antispam-PRVS: <MWHPR07MB31030520FF15BD162DDCC76CEA770@MWHPR07MB3103.namprd07.prod.outlook.com>
X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0;
RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(5005006)(8121501046)(3002001)(100000703101)(100105400095)(93006095)(10201501046)(6041248)(20161123562025)(20161123560025)(20161123555025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123558100)(20161123564025)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095);
SRVR:MWHPR07MB3103; BCL:0; PCL:0;
RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095);
SRVR:MWHPR07MB3103;
X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3103;
4:Xg48Anv8RFX/USEp1l5X9X9/SjBClMJ1BMOTM2ZXJMQsi48VRVyocBD8/gEvkDqrS1KASCdotM+ZlsW7JNlBiO8rB9nRpz4j+1F6Jle218cu7dtMVKBGK2K7YwuMLexBLKGXWEyaNzT6YSxW4gTxhadjQkQOJEvsS+RSNNSc1rro+MFn9ZRVhbxZfOfaE3xPqe+LUcYjfkuCesgc+G2Rg5709oY6wfcFLljVzRE9kPI3ST/mq48YBtOFl7b+53Xpq0mHyjBEDQ/ZkNTrUu0wCd2qdESFgM92E6OCPXrD9NqDY4l8RAlJSlpAhx/IwWFp3LwDMcQiTzwXmnH83fi56w==
X-Forefront-PRVS: 0454444834
X-Forefront-Antispam-Report: SFV:NSPM;
SFS:(10009020)(6009001)(6069001)(376002)(346002)(189002)(199003)(3846002)(16526018)(54906003)(1076002)(6512007)(6306002)(2950100002)(33646002)(478600001)(97736004)(50466002)(25786009)(106356001)(8936002)(48376002)(36756003)(4326008)(5660300001)(50226002)(105586002)(305945005)(5009440100003)(16586007)(6666003)(189998001)(72206003)(66066001)(76176999)(81156014)(6486002)(5003940100001)(8656003)(68736007)(47776003)(316002)(53936002)(7736002)(81166006)(50986999)(2906002)(42882006)(575784001)(6116002)(8676002)(101416001)(6506006)(110426004);
DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR07MB3103; H:localhost.localdomain; FPR:;
SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en;
Received-SPF: None (protection.outlook.com: cavium.com does not designate
permitted sender hosts)
X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; MWHPR07MB3103;
23:7BMoq9fndwiw1B8rK+LlaMJFuwDCZiWlrYo5S7LES?=
=?us-ascii?Q?n8rnK4GIfzO5qUqrHjkkES04GaGtd6xUR6DvE/V1hBLQbHY3/50ng0avslgV?=
=?us-ascii?Q?fzuabivNZ8rIXNr6s9DVDRCc8HcWkzZNm6dhUGvH2AFhFU/GA0/rFLQeR94j?=
=?us-ascii?Q?fDhXzujEwH8UmCPBvoOOBkIqg0o0/s3rzmTJcHm17IlmvwS/ovnkueU6z1jp?=
=?us-ascii?Q?/YuZE4/FqLCIulR9m8Ky/kM+qnmO11mobAich+SYgjAt3pgsJtzMFedwRhEZ?=
=?us-ascii?Q?pbjUwEC5/eKyu7/DTOlMBgTdRbRQrfXglyA2Rg5krg625aiIWDPgTHPSFR51?=
=?us-ascii?Q?sQR9CLefG6iyaVCT15SAxLkBonzLUCDssqrLASTqeatM1Ak/ZGneGtwb0T5h?=
=?us-ascii?Q?r5Iv1aCJzWqDRyC1MqdaQvbbU2G5vM3N0xH+D3uiX7nvBksoohsMcxM9n5jZ?=
=?us-ascii?Q?D6Wq2C8kLMWjOEGVGq5URVB/UOgIB4DPEQ+lS26bm2FT9d2Stmo7MHxV7eYY?=
=?us-ascii?Q?ISw3llGJaeymxRonmCWVlWsB6Bvd6IvUUGHPAoKJxe0vMDDK3NoIp/gXsKR6?=
=?us-ascii?Q?CRB6ghpK3cerhub6c8k00bV9A3Q7o8ZC63zzpP2cSmxmQlXOKScMLEv4TQQv?=
=?us-ascii?Q?GBSeYLgIPveNJvscYkxSqkcJkIrfvRwl32PFEWlMEkGRosuVDdlHgQcHcFF/?=
=?us-ascii?Q?3a2bKLjq9Fkfyrz3ZDNLdDvsn/NmUlHRo/QS4MbmJC3Gv6KkimUa3amuuXsv?=
=?us-ascii?Q?G52P+/CmXPejZZ/g4KuEzljHeMki+Vz/jXXcBqiPjMxsQME1KLHIKg9itwwg?=
=?us-ascii?Q?irq+sZwW9BgpnlAtUxRgMLAHOXSxxsQFWQ1uXk3t8ga28jchmTBhLNLWzvzn?=
=?us-ascii?Q?wlAfDUUJiInGlgDasgqYt9zpjUJCI33j1x1YNruNvhcZjWTSCsjrS5vGj37l?=
=?us-ascii?Q?31QuSjgzQRHw6vKgQ5n1hbNFec7a47v+7QMDl5i7JiIoQisokz94RfqEUVhf?=
=?us-ascii?Q?I5CpsAHqjZbsvpR9DSVrwH5st7GBufwPuNMq4hATzrLUNfMN4VqF2LvUI2JQ?=
=?us-ascii?Q?5ALP/4WFLsZxF/E6rs8CDACEBaLFraBOs3OEVA80RPkyljd2BPpiV/wBBLEy?=
=?us-ascii?Q?KrrAHPOLdP+IBIoFPP2VDi135up0qKDbfZlDuz0+Yvd/DIl8S/1gb89p74/D?=
=?us-ascii?Q?9nViQmDknCfSDsSdXLdZTVd/3UOl3T6TzoHg+OuO2A/hJy1a+lpdDjBaX5O/?=
=?us-ascii?Q?YXXNs8AFqXzk/7624w=3D?=
X-Microsoft-Exchange-Diagnostics: 1; MWHPR07MB3103;
6:psiYiSsc8pStZ5lVY1ASbQpN/D+ovsf9I9/YMPtl6h6uqBBb7ydI3Y1KmbL1MBD2Qwtnsw0pTwW9fZjMROybwcNc9uAWgN2W2Vp2rMJkJRy3/0Q1ySreoRPNbmTfeyfQEcIxoeEgrz0C72W40e4DI9vArFVP6MBv1xpeTAMcDAbqrw+7fKAxtCMug6+HRp/sTfnSCpo46EZXLQXzQe5CsHZlLv3C0Nwnjf2kA0VJW6kWjzSD6IHd2U06zfR9va/2OBrn0OpkuyRMsIcrHbVKnMSB/JCBdhGUdh0G3KwLtzTCZMLXM4wK1zyBy6o7zsPRMMOVJhbqV8Nst9SXJRPd+Q==;
5:afNvBL4fGBbXO9W/gFh1go+Ajl44Ppi2POBUSZEE8Z12ChkIA+A1dNh00e0jOQ2pCpX7INi9e4wqWe5wipdX8WibjhYZdTQqMBRTjWCOBXzNUOdY3y1Yg1IZ5nvbAXet1nRFTqWhZmPObq9tNwyvhA==;
24:MCVOaUAfgL7/r/LCoGk0qtN3p+WJTkb94QSWP8scLIOn2BdhTewq6Y/Yh5TdwM71hIwsgbOJ0rN2kcDrCtnn/giCw8QnVya9YBx6mFzWlsw=;
7:SDhBbK/MsbYGln/BGAZCiOAaNhBSL50gwJITvzD/HU0nymvT2LSUdXhiZhc7t6xXdI5XYXzK7uVTkb1MbRmVL23RGHtgiw7d9f1Inu4U/35i5FK4x4ZNH9tYdA7cVz71pJXPXb8+5uyFl+mQoY1Pa0ErHujuC/C9rbpvvq/WRsS9ygvdfCVTBxs78nuEB6/c7PdlOanZbtgbu5NRUh1zKKiS2lPEBS953e89znJY5o0=
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-OriginatorOrg: caviumnetworks.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Oct 2017 12:41:23.4649 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR07MB3103
Subject: [dpdk-dev] [PATCH v3 10/10] doc: add mempool and octeontx mempool
device
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sun, 08 Oct 2017 12:41:28 -0000
This commit adds a section to the docs listing the mempool
device PMDs available.
It then adds the octeontx fpavf mempool PMD to the listed mempool
devices.
Cc: John McNamara <john.mcnamara@intel.com>
Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Reviewed-by: John McNamara <john.mcnamara@intel.com>
---
v2 --> v3:
- Incorporated doc review comment (Suggested by John)
MAINTAINERS | 7 +++
doc/guides/index.rst | 1 +
doc/guides/mempool/index.rst | 40 +++++++++++++
doc/guides/mempool/octeontx.rst | 130 ++++++++++++++++++++++++++++++++++++++++
4 files changed, 178 insertions(+)
create mode 100644 doc/guides/mempool/index.rst
create mode 100644 doc/guides/mempool/octeontx.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index cd0d6bcac..59e782809 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -340,6 +340,13 @@ F: drivers/net/liquidio/
F: doc/guides/nics/liquidio.rst
F: doc/guides/nics/features/liquidio.ini
+Cavium Octeontx Mempool
+M: Santosh Shukla <santosh.shukla@caviumnetworks.com>
+M: Jerin Jacob <jerin.jacob@caviumnetworks.com>
+F: drivers/mempool/octeontx
+F: doc/guides/mempool/index.rst
+F: doc/guides/mempool/octeontx.rst
+
Chelsio cxgbe
M: Rahul Lakkireddy <rahul.lakkireddy@chelsio.com>
F: drivers/net/cxgbe/
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 63716b095..98f4b7aab 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -44,6 +44,7 @@ DPDK documentation
nics/index
cryptodevs/index
eventdevs/index
+ mempool/index
xen/index
contributing/index
rel_notes/index
diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst
new file mode 100644
index 000000000..440fb175a
--- /dev/null
+++ b/doc/guides/mempool/index.rst
@@ -0,0 +1,40 @@
+.. BSD LICENSE
+ Copyright(c) 2017 Cavium Inc. 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 Intel Corporation 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.
+
+Mempool Device Driver
+=====================
+
+The following are a list of mempool PMDs, which can be used from an
+application through the mempool API.
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ octeontx
diff --git a/doc/guides/mempool/octeontx.rst b/doc/guides/mempool/octeontx.rst
new file mode 100644
index 000000000..02a9b0212
--- /dev/null
+++ b/doc/guides/mempool/octeontx.rst
@@ -0,0 +1,130 @@
+.. 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.
+
+OCTEONTX FPAVF Mempool Driver
+=============================
+
+The OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is a mempool
+driver for offload mempool device found in **Cavium OCTEONTX** SoC
+family.
+
+More information can be found at `Cavium, Inc Official Website
+<http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
+
+Feature
+-------
+
+Features of the OCTEONTX FPAVF PMD are:
+
+- 32 SR-IOV Virtual functions
+- 32 Pools
+- HW mempool manager
+
+Supported OCTEONTX SoCs
+-----------------------
+
+- CN83xx
+
+Prerequisites
+-------------
+
+There are three main pre-perquisites for executing FPAVF 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
+ FPAVF) are available on Github at `octeontx-kmod <https://github.com/caviumnetworks/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 <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
+
+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 `<http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
+
+ As an alternative method, FPAVF 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 <https://support.cavium.com/>`_.
+
+Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+
+Pre-Installation Configuration
+------------------------------
+
+Config File Options
+~~~~~~~~~~~~~~~~~~~
+
+The following options can be modified in the ``config`` file.
+Please note that enabling debugging options may affect system performance.
+
+- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
+
+ Set default mempool ops to octeontx_fpavf.
+
+- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``)
+
+ Toggle compilation of the ``librte_mempool_octeontx`` driver.
+
+- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL_DEBUG`` (default ``n``)
+
+ Toggle display of generic debugging messages
+
+Driver Compilation
+~~~~~~~~~~~~~~~~~~
+
+To compile the OCTEONTX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+
+.. code-block:: console
+
+ cd <DPDK-source-directory>
+ make config T=arm64-thunderx-linuxapp-gcc test-build
+
+
+Initialization
+--------------
+
+The octeontx fpavf mempool initialization similar to other mempool
+drivers like ring. However user need to pass --base-virtaddr as
+command line input to application example test_mempool.c application.
+
+Example:
+
+.. code-block:: console
+
+ ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
+ --mbuf-pool-ops-name="octeontx_fpavf"
--
2.14.1