From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <tdu@semihalf.com>
Received: from mail-lf0-f68.google.com (mail-lf0-f68.google.com
[209.85.215.68]) by dpdk.org (Postfix) with ESMTP id 66262199C8
for <dev@dpdk.org>; Mon, 11 Dec 2017 15:07:19 +0100 (CET)
Received: by mail-lf0-f68.google.com with SMTP id f18so19296445lfg.8
for <dev@dpdk.org>; Mon, 11 Dec 2017 06:07:19 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=semihalf-com.20150623.gappssmtp.com; s=20150623;
h=from:to:cc:subject:date:message-id:in-reply-to:references;
bh=DZ2TZNAYt6c3W8ZoesOWwHMYtQNiUl27VUouRJjZ9HY=;
b=ecAJ7a4Z/mPaWKKY2ltCA3drEB05WqScgLqJO+lpw/yEC6UfhRH6Im3ahHZ/6Asayh
TNxvivHtdqovWP3dGviCOMxrCeS3iFTzh/DZiwj9giPJju2hN85xt59f30FJEqM7E/IY
9EjrfYmG3RgTu9u2rerN7w9JedNdzmO6XOIFmSTtYLf3pw/mROEXWwCq6clM8n7w6FIf
fY8uttTnF8QfeEQg2//SOtrxfP35OH5zt/vrDrGQ1d12gWRa9MjCzQQMduse9q1rz28t
XrlQFnd7FnhJ82Ei4N/sAF83o3JKWgAWlQ0+Pr1WiKCmbpJ1DRr5V3Nwqzvt0v3Tpnk/
sJMw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20161025;
h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
:references;
bh=DZ2TZNAYt6c3W8ZoesOWwHMYtQNiUl27VUouRJjZ9HY=;
b=d9d90hxvcCBcloe63jVrmoBzeSKM+XPNQ8giw2hhyMtSXSV4NnLRuS27agLqhyX5u4
16UUfEy2rlS30OkTDJdw9s1YmuLMkqg7qWGAz282fL8i8kNecN6l56k/jNDVunadA9JA
dUS218cHHIgYCa0jGlHfDlo5s4R8xvH57Lxob/lSAzdVeJRb82UqDfiUDw8fJRrI7CKJ
SfXejsYwSZkiMoHgP0mymjNVMf2xNVu2catlarkqZe8oPFAjX8MoE0KGNfFoqupbtQ3W
ckDzlxeGEfH1aC5gpOGO4hE/e7MncUXE8Gchr2NRTPXBu4EUIq7m0CrjGvMPmHzrs+xT
BU+Q==
X-Gm-Message-State: AKGB3mLBR9hcrebnzRYu6/YKql5OmFKK8aDpvBBcA2g2xlrWD/gWJ2bF
j3muAbL4rM23sSPyLf81fyHv35fuqDA=
X-Google-Smtp-Source: ACJfBouHwYQfYPSikLNOwNxIOfT1v6Bex3AS4/izJzC1dzcimxpkVTS3J+1nM+Yo00dN3yoLqCtW9A==
X-Received: by 10.46.91.79 with SMTP id p76mr305115ljb.22.1513001238806;
Mon, 11 Dec 2017 06:07:18 -0800 (PST)
Received: from tdu.semihalf.local (31-172-191-173.noc.fibertech.net.pl.
[31.172.191.173])
by smtp.gmail.com with ESMTPSA id f9sm2740562lfh.92.2017.12.11.06.07.17
(version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);
Mon, 11 Dec 2017 06:07:18 -0800 (PST)
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>
Date: Mon, 11 Dec 2017 15:07:03 +0100
Message-Id: <1513001223-9881-3-git-send-email-tdu@semihalf.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1513001223-9881-1-git-send-email-tdu@semihalf.com>
References: <1512048774-23838-1-git-send-email-tdu@semihalf.com>
<1513001223-9881-1-git-send-email-tdu@semihalf.com>
Subject: [dpdk-dev] [PATCH v2 2/2] crypto/mrvl: update MRVL CRYPTO PMD
documentation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 11 Dec 2017 14:07:19 -0000
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