From patchwork Thu Nov 30 13:32:54 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tomasz Duszynski X-Patchwork-Id: 31835 X-Patchwork-Delegate: pablo.de.lara.guarch@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5A6EE199AE; Thu, 30 Nov 2017 14:33:06 +0100 (CET) Received: from mail-lf0-f66.google.com (mail-lf0-f66.google.com [209.85.215.66]) by dpdk.org (Postfix) with ESMTP id 1724C7CE1 for ; Thu, 30 Nov 2017 14:33:02 +0100 (CET) Received: by mail-lf0-f66.google.com with SMTP id i2so7881574lfe.9 for ; Thu, 30 Nov 2017 05:33:02 -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=udm+OKxC9/daggx2QQaizxq88zKGWX/Brxq7WQ0Jes0=; b=b68mlna2gtEqZ2vK3v+b5x8q6blmR2R/4PgTzjdGYPBiXXp4YK8yZ41wfwEAd+NMAn drp9EuvrPIPQztWtcMo2PzvXAH/3yWrzop3Qmp4SCq8LUs+FE7JwjZVLVZ4KeyJSCCdV ORgLMF2pDhqeaE1btXPs7qeIOQEkKL1XYRul5AxY2Cag3q40VMQzUjKCxebNBAf+kelf ouhEX3clRhua/OFycioj8DKHngRiqlytuOK5QtNqCYWd6y4NkC5PoJBF7wwwGJjsvD+M JuRw7J/QYKz1n8WSlwZIRlYQnXVmXZDR3ghThSFAbnQtVtJc29vikLn+YsufhF67FbUA /Bbg== 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=udm+OKxC9/daggx2QQaizxq88zKGWX/Brxq7WQ0Jes0=; b=RqG8yB+mPYOniOrfw+bPZ0tukiq4EvIfVgd5p6WcWjWearaCX2FmZP6Oi9pSSY0IaY ehsyiu2TkMrDOcDymylP/Qd19ZQv45KVLtvrMxvTgVcHqgXNQGTSKLyikocRofuARcyC xvdOPxDqfqsR0pDYwgVDZ7nUcRTsuxbCVQNLSwxTEuLZBeItXg/eDpxKhRtwtnYVyM9p uJzGeuM2u1YGMTX+OGcyujTXWdT1v10YfKU2+6drStQQvMl9AQhfjwwavhDtWa+LtBAS bOz9dqfVZ0b+5B7UPJk0Ms/wQgVgzX4Sfxc/Z5R1Kj067ptQcK35/aGqNKKYz3DYl1Ng 1ASQ== X-Gm-Message-State: AJaThX7ai/Kw4CukJCKDCEt/0x+hs+CN5o1FgDiruM73dFS5nQUR3LJk Sp6fWZiq/u/BaZRI4LfhZtMCkROSBtI= X-Google-Smtp-Source: AGs4zMb+05LyZL6pjdOM6MmorepskPW4Rm8d4hr7I7xsfHb3ZMKybktRtFv6LllRTwy/rjTR22PO2g== X-Received: by 10.46.21.87 with SMTP id 23mr3073666ljv.107.1512048781519; Thu, 30 Nov 2017 05:33:01 -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 19sm852050ljx.58.2017.11.30.05.33.00 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 30 Nov 2017 05:33:00 -0800 (PST) From: Tomasz Duszynski To: dev@dpdk.org Cc: mw@semihalf.com, jck@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jianbo.liu@arm.com, Tomasz Duszynski Date: Thu, 30 Nov 2017 14:32:54 +0100 Message-Id: <1512048774-23838-3-git-send-email-tdu@semihalf.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1512048774-23838-1-git-send-email-tdu@semihalf.com> References: <1512048774-23838-1-git-send-email-tdu@semihalf.com> Subject: [dpdk-dev] [PATCH 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Update MRVL CRYPTO PMD documentation. Signed-off-by: Tomasz Duszynski --- 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..4024801 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 `__. +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. - -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 `__. +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 `__. - 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 ======================