From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-lf0-f68.google.com (mail-lf0-f68.google.com [209.85.215.68]) by dpdk.org (Postfix) with ESMTP id 191311B024 for ; Tue, 9 Jan 2018 10:09:08 +0100 (CET) Received: by mail-lf0-f68.google.com with SMTP id h137so15095266lfe.8 for ; Tue, 09 Jan 2018 01:09:08 -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=nf5EXoL5yVel8BWUatkHh/O2dYgZ36nA0BeZK8K6Zaw=; b=oh3uqofLvRojiM1uROK++l3qIHCrN0nUNgbKup/GhoftUXNT4trIMZWDoz/tQBGnB+ MqrMykS2Yc93AbXmDkHI0iv+h3tRmkMrktV6ziRYg0G9/6Vr/9tDZ/gLCNtFPhYQVf5B Mv0VjgUhwco0VV1sY+B0elXvJ/OKlLSlW9cKnVKuRu8ZwwihcDDyfbervRV1GQhSgJzJ WJgxIF8IbF9quPme3769shCKWGqIehQ6cW+mpXsqTrXYetrAeZXRBMZxFb6nOlQWFlpO OGFrh+CbrK8+HWrxwYVIV6e0qK7YppT/nEKQp2Me71YOa2335KXbcb7zljaeiTxVi1Pb wpmQ== 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=nf5EXoL5yVel8BWUatkHh/O2dYgZ36nA0BeZK8K6Zaw=; b=Q4J5EgqgDhvdh/gXB88vpB0fskWUpbL6oRMiLY2PtR7r+TzN5+m0locD5PVjwler1M nI9Si1tG5xzi3OchstQZhuOyqLzcChZsrMXlGO/UmA1QLLsgWNAxMkZoLlYy6cDpPmuX vSSNfNPh99Fmot1RqYJjeGRGNEscAJKgRs2oia35jnt66EPTtKIvtGdHHSBxg/DT0XpA 2aHvadiaC4EnZ///ldM4lL8b904D8DH5USsKc62+5mNduf5NJYzj/JTPLjz+IpV22Ffn yfXduMVjuWTrn38KPu0NWUCp5p/yd9WtA/K5N3Al0gCEXcFViAcHXj7KDfuBkZSD9J1F 7T8Q== X-Gm-Message-State: AKGB3mJm3DtpSiA7nfx+8dEZgZwydF1CKk7OOfRhGeOHNe2NAjl73WdY guVTXjwgI73/Tt37v9jmGdLpWls2NWc= X-Google-Smtp-Source: ACJfBovBv1yr8F8QgI6OlelIjmpWZWaIIrEOFO0V9xa4K2Ep1dA2/rwFySwr0AvxhiWCwsQcOAOEug== X-Received: by 10.46.65.132 with SMTP id d4mr8850200ljf.65.1515488947496; Tue, 09 Jan 2018 01:09:07 -0800 (PST) Received: from sh.semihalf.local (31-172-191-173.noc.fibertech.net.pl. [31.172.191.173]) by smtp.gmail.com with ESMTPSA id v63sm2766397lje.39.2018.01.09.01.09.06 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 09 Jan 2018 01:09:06 -0800 (PST) From: Tomasz Duszynski To: dev@dpdk.org Cc: mw@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jianbo.liu@arm.com, Tomasz Duszynski Date: Tue, 9 Jan 2018 10:08:48 +0100 Message-Id: <1515488928-30495-2-git-send-email-tdu@semihalf.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1515488928-30495-1-git-send-email-tdu@semihalf.com> References: <1513001223-9881-2-git-send-email-tdu@semihalf.com> <1515488928-30495-1-git-send-email-tdu@semihalf.com> Subject: [dpdk-dev] [PATCH v3 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 09 Jan 2018 09:09:08 -0000 Update MRVL CRYPTO PMD documentation. Signed-off-by: Tomasz Duszynski Acked-by: Jianbo Liu --- doc/guides/cryptodevs/mrvl.rst | 31 +++++++++---------------------- doc/guides/nics/mrvl.rst | 2 ++ 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/doc/guides/cryptodevs/mrvl.rst b/doc/guides/cryptodevs/mrvl.rst index 4e992fb..6a0b08c 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,18 @@ 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 `__. +For a list of prerequisites please refer to `Prerequisites` section in +:ref:`MRVL Poll Mode Driver ` guide. -Alternatively, prebuilt library can be downloaded from -`Marvell Extranet `_. Once approval has been -granted, library can be found by typing ``musdk`` in the search box. +MRVL CRYPTO PMD requires MUSDK built with EIP197 support thus following +extra option must be passed to the library configuration script: -For MUSDK library build instructions please refer to ``doc/musdk_get_started.txt`` -in library sources directory. +.. code-block:: console + + --enable-sam -MUSDK requires out of tree kernel modules to work. Kernel tree needed to build -them is available -`here `__. +For `crypto_safexcel.ko` module build instructions please refer +to `doc/musdk_get_started.txt`. Initialization -------------- @@ -121,10 +112,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 `__. - 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 4dc4710..468cebd 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