From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tomasz Duszynski Subject: [PATCH v3 2/2] crypto/mrvl: update MRVL CRYPTO PMD documentation Date: Tue, 9 Jan 2018 10:08:48 +0100 Message-ID: <1515488928-30495-2-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> Cc: mw@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jianbo.liu@arm.com, Tomasz Duszynski To: dev@dpdk.org 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) In-Reply-To: <1515488928-30495-1-git-send-email-tdu@semihalf.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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