> -----Original Message----- > From: dev [mailto:dev-boun...@dpdk.org] On Behalf Of Hemant Agrawal > Sent: Sunday, December 4, 2016 6:17 PM > To: dev@dpdk.org > Cc: thomas.monja...@6wind.com; Richardson, Bruce > <bruce.richard...@intel.com>; shreyansh.j...@nxp.com; Hemant Agrawal > <hemant.agra...@nxp.com> > Subject: [dpdk-dev] [PATCH 01/32] doc: add dpaa2 nic details > > Add the dpaa2 architecture and pmd details > > Signed-off-by: Hemant Agrawal <hemant.agra...@nxp.com>
Thanks for the detailed doc. There is a whitespace warning on merge. Also, some comments below. > + > +DPAA2 Poll Mode Driver > +=============================== > + The underline should match the length of the title. Also, there should be 1 newline after each section header. This is in this example but there are several without it. > + > +NXP DPAA2 (Data Path Acceleration Architecture Gen2) > +---------------------------------------------------- > + > +This section provides an overview of the NXP DPAA2 architecture and how > +it is integrated into the DPDK. The text says "This section" which implies that the following sections are subsections. In that case the underline for the sub sections should probably be: ~~~~~~~~~~~~~~~~ http://dpdk.org/doc/guides/contributing/documentation.html#section-headers This applies to some other section introductions below as well. > + > +Contents summary > +- DPAA2 overview > +- Overview of DPAA2 objects > +- DPAA2 driver architecture overview This needs a newline after "Contents summary" to generate a list. > + > +DPAA2 Overview > +-------------- > +Refer: `FSL MC BUS in Linux Kernel > <https://www.kernel.org/doc/readme/drivers-staging-fsl-mc-README.txt>`_. s/Refer/Reference/ Note, I was very impressed with this doc until I saw that the text was all in the other README file. :-) > +DPAA2 is a hardware architecture designed for high-speeed network s/speeed/speed/ > + Toggle display of generic debugging messages > + > +- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``y``) > + > + Toggle to use physical address vs virtual address for hardware > acceleraters. s/acceleraters/accelerators/ > + > +Driver Compilation > +~~~~~~~~~~~~~~~~~~ > + > +To compile the DPAA2 PMD for Linux arm64 gcc target, run the following > +“make†command: Non-ascii/non-Unicode characters here. Use ``make`` instead. > + > +# configure the resource container > + > + configure resources in MC and create the DPRC container > + export the DPRC container > + e.g. export DPRCT=dprc.2 Should be #. and have a console block or directive like the example below. > + > +#. Start ``testpmd`` with basic parameters: > + > + .. code-block:: console > + > + ./arm64-dpaa2-linuxapp-gcc/testpmd -c 0xff -n 1 \ > + -- -i --portmask=0x1 --nb-cores=1 --no-flush-rx > + > +