From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id A8BCC1B19E for ; Tue, 19 Sep 2017 15:52:45 +0200 (CEST) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga105.fm.intel.com with ESMTP; 19 Sep 2017 06:52:44 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.42,418,1500966000"; d="scan'208";a="1016161489" Received: from irsmsx101.ger.corp.intel.com ([163.33.3.153]) by orsmga003.jf.intel.com with ESMTP; 19 Sep 2017 06:52:42 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.49]) by IRSMSX101.ger.corp.intel.com ([169.254.1.22]) with mapi id 14.03.0319.002; Tue, 19 Sep 2017 14:52:42 +0100 From: "Mcnamara, John" To: Santosh Shukla , "dev@dpdk.org" , "olivier.matz@6wind.com" CC: "jerin.jacob@caviumnetworks.com" , "thomas@monjalon.net" , "hemant.agrawal@nxp.com" Thread-Topic: [PATCH v2 10/10] doc: add mempool and octeontx mempool device Thread-Index: AQHTIiPamKZki9Bad0OImvYfOM9JK6K8V1fA Date: Tue, 19 Sep 2017 13:52:41 +0000 Message-ID: References: <20170824132903.32057-1-santosh.shukla@caviumnetworks.com> <20170831063719.19273-1-santosh.shukla@caviumnetworks.com> <20170831063719.19273-11-santosh.shukla@caviumnetworks.com> In-Reply-To: <20170831063719.19273-11-santosh.shukla@caviumnetworks.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNDBiM2I5YTUtNDEyYy00NDEwLWFlNGEtMzg5ZmFmNzExNGEzIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6ImFKTHZpcW9HVGxDNlwveTRFcXNXelwvYkx6UGQ3bytHQTFpTXFhYXl1TXJhRT0ifQ== dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v2 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Sep 2017 13:52:46 -0000 > -----Original Message----- > From: Santosh Shukla [mailto:santosh.shukla@caviumnetworks.com] > Sent: Thursday, August 31, 2017 7:37 AM > To: dev@dpdk.org; olivier.matz@6wind.com > Cc: jerin.jacob@caviumnetworks.com; Mcnamara, John > ; thomas@monjalon.net; hemant.agrawal@nxp.com; > Santosh Shukla > Subject: [PATCH v2 10/10] doc: add mempool and octeontx mempool device >=20 > This commit adds a section to the docs listing the mempool device PMDs > available. >=20 > It then adds the octeontx fpavf mempool PMD to the listed mempool devices= . >=20 > Cc: John McNamara >=20 > Signed-off-by: Santosh Shukla > Signed-off-by: Jerin Jacob Minor comments below. > + > +OCTEONTX FPAVF Mempool Driver > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D Underscores should match the length of the title. > + > +Features OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is mempool > +driver for offload mempool device found in **Cavium OCTEONTX** SoC > +family. I'd suggest something like: 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 > +`_. > + > +Feature > +-------- > + > +Features of the OCTEONTX FPAVF PMD are: > +- 32 SR-IOV Virtual functions > +- 32 Pools > +- HW mempool manager A bullet list requires a blank line between the previous paragraph to rende= r properly: Features of the OCTEONTX FPAVF PMD are: - 32 SR-IOV Virtual functions - 32 Pools - HW mempool manager > + > +Supported OCTEONTX SoCs > +----------------------- > +- CN83xx Add a blank line after the title. > + SDK and related information can be obtained from: `Cavium support sit= e > `_. > + > +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to > setup the basic DPDK environment. Remove the "-" bullet at the start of this line. > +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=3D0x100000000000 --mbuf-pool= - > ops=3D"octeontx_fpavf" Wrap the long commandline for the pdf docs: .. code-block:: console ./build/app/test -c 0xf --base-virtaddr=3D0x100000000000 \ --mbuf-pool-ops=3D"octeontx_fpavf" Reviewed-by: John McNamara