[dpdk-dev,2/2] crypto/mrvl: update MRVL CRYPTO PMD documentation
Checks
Commit Message
Update MRVL CRYPTO PMD documentation.
Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
---
doc/guides/cryptodevs/mrvl.rst | 28 ++++------------------------
doc/guides/nics/mrvl.rst | 2 ++
2 files changed, 6 insertions(+), 24 deletions(-)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Tomasz Duszynski
> Sent: Thursday, November 30, 2017 1:33 PM
> To: dev@dpdk.org
> Cc: mw@semihalf.com; jck@semihalf.com; dima@marvell.com;
> nsamsono@marvell.com; jianbo.liu@arm.com; Tomasz Duszynski
> <tdu@semihalf.com>
> Subject: [dpdk-dev] [PATCH 2/2] crypto/mrvl: update MRVL CRYPTO PMD
> documentation
>
> Update MRVL CRYPTO PMD documentation.
>
> Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
This is depending on the network driver update, right?
You should say it in the cover letter. I will wait until it is applied then.
...
> -
> Installation
> ------------
>
> @@ -92,20 +85,11 @@ Currently there are two driver specific compilation
> options in
>
> Toggle display of debugging messages.
>
> -During compilation external MUSDK library, which provides direct access -
> to Marvell's EIP197 cryptographic engine, is necessary. Library sources are -
> available `here <https://github.com/MarvellEmbeddedProcessors/musdk-
> marvell/tree/musdk-armada-17.08>`__.
> +For a list of prerequisites please refer to `Prerequisites` section in
> +:ref:`MRVL Poll Mode Driver <mrvl_poll_mode_driver>` guide.
Maybe say that it is the network PMD?
Thanks,
Pablo
On Mon, Dec 11, 2017 at 12:44:43PM +0000, De Lara Guarch, Pablo wrote:
>
>
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Tomasz Duszynski
> > Sent: Thursday, November 30, 2017 1:33 PM
> > To: dev@dpdk.org
> > Cc: mw@semihalf.com; jck@semihalf.com; dima@marvell.com;
> > nsamsono@marvell.com; jianbo.liu@arm.com; Tomasz Duszynski
> > <tdu@semihalf.com>
> > Subject: [dpdk-dev] [PATCH 2/2] crypto/mrvl: update MRVL CRYPTO PMD
> > documentation
> >
> > Update MRVL CRYPTO PMD documentation.
> >
> > Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
>
>
> This is depending on the network driver update, right?
> You should say it in the cover letter. I will wait until it is applied then.
Right, I've missed that. Anyway, from what I see network driver
patches have been already applied.
>
> ...
>
> > -
> > Installation
> > ------------
> >
> > @@ -92,20 +85,11 @@ Currently there are two driver specific compilation
> > options in
> >
> > Toggle display of debugging messages.
> >
> > -During compilation external MUSDK library, which provides direct access -
> > to Marvell's EIP197 cryptographic engine, is necessary. Library sources are -
> > available `here <https://github.com/MarvellEmbeddedProcessors/musdk-
> > marvell/tree/musdk-armada-17.08>`__.
> > +For a list of prerequisites please refer to `Prerequisites` section in
> > +:ref:`MRVL Poll Mode Driver <mrvl_poll_mode_driver>` guide.
>
> Maybe say that it is the network PMD?
OK. I'll send v2 then.
>
> Thanks,
> Pablo
>
--
- Tomasz Duszyński
@@ -70,13 +70,6 @@ Limitations
* Hardware only supports scenarios where ICV (digest buffer) is placed just
after the authenticated data. Other placement will result in error.
-* Before running crypto test suite it is advised to increase limit of
- opened files:
-
- .. code-block:: console
-
- ulimit -n 20000
-
Installation
------------
@@ -92,20 +85,11 @@ Currently there are two driver specific compilation options in
Toggle display of debugging messages.
-During compilation external MUSDK library, which provides direct access
-to Marvell's EIP197 cryptographic engine, is necessary. Library sources are
-available `here <https://github.com/MarvellEmbeddedProcessors/musdk-marvell/tree/musdk-armada-17.08>`__.
+For a list of prerequisites please refer to `Prerequisites` section in
+:ref:`MRVL Poll Mode Driver <mrvl_poll_mode_driver>` guide.
-Alternatively, prebuilt library can be downloaded from
-`Marvell Extranet <https://extranet.marvell.com>`_. Once approval has been
-granted, library can be found by typing ``musdk`` in the search box.
-
-For MUSDK library build instructions please refer to ``doc/musdk_get_started.txt``
-in library sources directory.
-
-MUSDK requires out of tree kernel modules to work. Kernel tree needed to build
-them is available
-`here <https://github.com/MarvellEmbeddedProcessors/linux-marvell/tree/linux-4.4.52-armada-17.08>`__.
+For `crypto_safexcel.ko` module build instructions please refer
+to `doc/musdk_get_started.txt`.
Initialization
--------------
@@ -121,10 +105,6 @@ loaded:
insmod mv_sam_uio.ko
insmod crypto_safexcel.ko
-- `musdk_uio.ko`, `mv_pp2_uio.ko` and `mv_sam_uio.ko` are distributed together with MUSDK library.
-- `crypto_safexcel.ko` is an in-kernel module.
-- `mvpp2x_sysfs.ko` can be build from sources available `here <https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell/tree/mvpp2x-armada-17.08>`__.
-
The following parameters (all optional) are exported by the driver:
* max_nb_queue_pairs: maximum number of queue pairs in the device (8 by default).
@@ -29,6 +29,8 @@
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.. _mrvl_poll_mode_driver:
+
MRVL Poll Mode Driver
======================