> -----Original Message----- > From: Akhil Goyal [mailto:akhil.go...@nxp.com] > Sent: Friday, March 3, 2017 7:50 PM > To: dev@dpdk.org > Cc: thomas.monja...@6wind.com; Doherty, Declan <declan.dohe...@intel.com>; > De Lara Guarch, Pablo <pablo.de.lara.gua...@intel.com>; Mcnamara, John > <john.mcnam...@intel.com>; nhor...@tuxdriver.com; hemant.agra...@nxp.com; > Akhil Goyal <akhil.go...@nxp.com> > Subject: [PATCH v5 09/12] doc: add NXP dpaa2 sec in cryptodev
Hi, thanks for the doc. Some minor comments below. > + > +NXP(R) DPAA2 CAAM Accelerator Based (DPAA2_SEC) Crypto Poll Mode Driver > +======================================================================= This title is quite long and the "Crypto Poll Mode Driver" part is probably unnecessary in the context of the doc. Maybe something like: NXP DPAA2 CAAM Accelerator ========================== > + > +The DPAA2_SEC PMD provides poll mode crypto driver support for NXP > +DPAA2 CAAM hardware accelerator. > + > +Architecture > +------------ > + > +SEC is the SOC's security engine, which serves as NXP's latest > +cryptographic acceleration and offloading hardware. It combines > +functions previously implemented in separate modules to create a > +modular and scalable acceleration and assurance engine. It also > +implements block encryption algorithms, stream cipher algorithms, > +hashing algorithms, public key algorithms, run-time integrity checking, > +and a hardware random number generator. SEC performs higher-level > +cryptographic operations than previous NXP cryptographic accelerators. > This provides significant improvement to system level performance. > + > +DPAA2_SEC is one of the hardware resource in DPAA2 Architecture. More > +information on DPAA2 Architecture is described in > +docs/guides/nics/dpaa2.rst This needs to be a RST link to the dpaa2.rst doc which means to it will also require a target in dpaa2.rst. See the following section of the contributors guide: http://dpdk.org/doc/guides/contributing/documentation.html#hyperlinks > + > +DPAA2_SEC PMD is one of DPAA2 drivers which interacts with Management > +Complex (MC) portal to access the hardware object - DPSECI. The MC > +provides access to create, discover, connect, configure and destroy > dpseci object in DPAA2_SEC PMD. s/object/objects/ > + > +DPAA2_SEC PMD also uses some of the other hardware resources like > +buffer pools, queues, queue portals to store and to enqueue/dequeue data > to the hardware SEC. > + > +DPSECI objects are detected by PMD using a resource container called > +DPRC(like in docs/guides/nics/dpaa2.rst). Requires a space before the bracket and a real link, like above > + > +For example: > + > +.. code-block:: console > + > + DPRC.1 (bus) > + | > + +--+--------+-------+-------+-------+---------+ > + | | | | | | > + DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 DPSECI.1 > + DPMCP.2 DPIO.2 DPNI.2 DPMAC.2 DPSECI.2 > + DPMCP.3 There are tabs in this figure that break the alignment. Also in the other figure. > +Supported DPAA2 SoCs > +-------------------- > + > +- LS2080A/LS2040A > +- LS2084A/LS2044A > +- LS2088A/LS2048A > +- LS1088A/LS1048A Use * for bullet list, for consistency with the doc guidelines and the rest of the doc. Here and elsewhere. > + > +Limitations > +----------- > + > +* Chained mbufs are not supported. > +* Hash followed by Cipher mode is not supported > +* Only supports the session-oriented API implementation (session-less > APIs are not supported). > + > +Prerequisites > +------------- > + > +DPAA2_SEC driver has similar pre-requisites as listed in dpaa2 > pmd(docs/guides/nics/dpaa2.rst). Same space and link comment as above. > +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 s/family/the 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 > <http://www.nxp.com/products/software-and-tools/run-time-software/linux- > sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_. > + > +- **DPDK Helper Scripts** > + > + DPAA2 based resources can be configured easily with the help of ready > + scripts as provided in the DPDK helper repository. > + > + `DPDK Helper Scripts <https://github.com/qoriq-open-source/dpdk- > helper>`_. > + > +Currently supported by DPDK: > + > +- NXP SDK **2.0+**. > +- MC Firmware version **10.0.0** and higher. > +- Supported architectures: **arm64 LE**. > + > +- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to > setup the basic DPDK environment. > + > +Pre-Installation Configuration > +------------------------------ > + > +Config File Options > +~~~~~~~~~~~~~~~~~~~ > + > +Basic DPAA2 config file options are described in > doc/guides/nics/dpaa2.rst. > +In Additiont to those following options can be modified in the Better as: In addition to those, the following ... Regards, John
