From: Tomasz Duszynski <tdu@semihalf.com>
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 v2 2/2] crypto/mrvl: update MRVL CRYPTO PMD documentation
Date: Mon, 11 Dec 2017 15:07:03 +0100 [thread overview]
Message-ID: <1513001223-9881-3-git-send-email-tdu@semihalf.com> (raw)
In-Reply-To: <1513001223-9881-1-git-send-email-tdu@semihalf.com>
Update MRVL CRYPTO PMD documentation.
Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
Acked-by: Jianbo Liu <jianbo.liu@arm.com>
---
doc/guides/cryptodevs/mrvl.rst | 28 ++++------------------------
doc/guides/nics/mrvl.rst | 2 ++
2 files changed, 6 insertions(+), 24 deletions(-)
diff --git a/doc/guides/cryptodevs/mrvl.rst b/doc/guides/cryptodevs/mrvl.rst
index 4e992fb..22a48e4 100644
--- a/doc/guides/cryptodevs/mrvl.rst
+++ b/doc/guides/cryptodevs/mrvl.rst
@@ -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 NET 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).
diff --git a/doc/guides/nics/mrvl.rst b/doc/guides/nics/mrvl.rst
index 67b254c..892097d 100644
--- a/doc/guides/nics/mrvl.rst
+++ b/doc/guides/nics/mrvl.rst
@@ -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
======================
--
2.7.4
prev parent reply other threads:[~2017-12-11 14:07 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-30 13:32 [dpdk-dev] [PATCH 0/2] Sync compilation with MUSDK-17.10 Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 1/2] crypto/mrvl: sync compilation with musdk-17.10 Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 2/2] crypto/mrvl: update MRVL CRYPTO PMD documentation Tomasz Duszynski
2017-12-11 12:44 ` De Lara Guarch, Pablo
2017-12-11 13:42 ` Tomasz Duszynski
2017-12-04 2:27 ` [dpdk-dev] [PATCH 0/2] Sync compilation with MUSDK-17.10 Jianbo Liu
2017-12-11 14:07 ` [dpdk-dev] [PATCH v2 " Tomasz Duszynski
2017-12-11 14:07 ` [dpdk-dev] [PATCH v2 1/2] crypto/mrvl: sync compilation with musdk-17.10 Tomasz Duszynski
2018-01-08 14:27 ` Tomasz Duszynski
2018-01-08 14:41 ` De Lara Guarch, Pablo
2018-01-08 14:45 ` Tomasz Duszynski
2018-01-09 9:08 ` [dpdk-dev] [PATCH v3 " Tomasz Duszynski
2018-01-09 9:08 ` [dpdk-dev] [PATCH v3 2/2] crypto/mrvl: update MRVL CRYPTO PMD documentation Tomasz Duszynski
2018-01-09 11:47 ` De Lara Guarch, Pablo
2018-01-09 11:47 ` [dpdk-dev] [PATCH v3 1/2] crypto/mrvl: sync compilation with musdk-17.10 De Lara Guarch, Pablo
2018-01-16 17:54 ` Ferruh Yigit
2017-12-11 14:07 ` Tomasz Duszynski [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1513001223-9881-3-git-send-email-tdu@semihalf.com \
--to=tdu@semihalf.com \
--cc=dev@dpdk.org \
--cc=dima@marvell.com \
--cc=jck@semihalf.com \
--cc=jianbo.liu@arm.com \
--cc=mw@semihalf.com \
--cc=nsamsono@marvell.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).