From mboxrd@z Thu Jan  1 00:00:00 1970
From: Tomasz Duszynski <tdu@semihalf.com>
Subject: Re: [PATCH v3 3/4] doc: add mrvl net pmd documentation
Date: Wed, 4 Oct 2017 09:53:32 +0200
Message-ID: <20171004075332.GA5668@tdu>
References: <1506594158-15721-2-git-send-email-tdu@semihalf.com>
 <1507031500-11473-1-git-send-email-tdu@semihalf.com>
 <1507031500-11473-4-git-send-email-tdu@semihalf.com>
 <fe780213-d122-3c13-ac5e-8dd21a5747b7@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Cc: Tomasz Duszynski <tdu@semihalf.com>, dev@dpdk.org, mw@semihalf.com,
 dima@marvell.com, nsamsono@marvell.com, Jianbo.liu@linaro.org,
 Jacek Siuda <jck@semihalf.com>, sgridish@marvell.com
To: Ferruh Yigit <ferruh.yigit@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-lf0-f53.google.com (mail-lf0-f53.google.com
 [209.85.215.53]) by dpdk.org (Postfix) with ESMTP id B5E951B5FA
 for <dev@dpdk.org>; Wed,  4 Oct 2017 09:53:34 +0200 (CEST)
Received: by mail-lf0-f53.google.com with SMTP id m199so12409274lfe.3
 for <dev@dpdk.org>; Wed, 04 Oct 2017 00:53:34 -0700 (PDT)
Content-Disposition: inline
In-Reply-To: <fe780213-d122-3c13-ac5e-8dd21a5747b7@intel.com>
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>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On Wed, Oct 04, 2017 at 01:29:01AM +0100, Ferruh Yigit wrote:

+cc Shlomi.
> On 10/3/2017 12:51 PM, Tomasz Duszynski wrote:
> > Add documentation for the MRVL NET PMD driver.
> >
> > Signed-off-by: Jacek Siuda <jck@semihalf.com>
> > Signed-off-by: Tomasz Duszynski <jck@semihalf.com>
>
> <...>
>
> > +;
> > +[Features]
> > +Speed capabilities   =3D Y
>
> This doesn't seems correct please check doc/guides/nics/features.rst
Right, speed capabilities are not returned via rte_eth_dev_info. Thanks
for pointing this out. Will fix that in v4.
>
> > +Link status          =3D Y
> > +MTU update           =3D Y
> > +Jumbo frame          =3D Y
> > +Promiscuous mode     =3D Y
> > +Allmulticast mode    =3D Y
> > +Unicast MAC filter   =3D Y
> > +Multicast MAC filter =3D Y
> > +RSS hash             =3D Y
> > +VLAN filter          =3D Y
> > +CRC offload          =3D Y
> > +L3 checksum offload  =3D Y
> > +L4 checksum offload  =3D Y
> > +Packet type parsing  =3D Y
> > +Basic stats          =3D Y
> > +Stats per queue      =3D Y
> > +ARMv8                =3D Y
>
> Is other architecture not supported or not tested?
Currently that NIC comes integrated into Armada 7k/8k SoCs and they are bas=
ed
on ARMv8.
>
> > +Usage doc            =3D Y
>
> <...>
>
> > +Prerequisites
> > +-------------
> > +
> > +- MUSDK (Marvell User-Space SDK) sources available
> > +  `here <https://github.com/MarvellEmbeddedProcessors/musdk-marvell/tr=
ee/musdk-armada-17.08>`_.
>
> Is this 17.08 by change related to DPDK version, I mean is there any
> relation between DPDK version and musdk library version?
No relation except similar versioning convention that is used. Musdk
library version needed by DPDK driver is mentioned explicitly in
documentation.
>
> > +
> > +    MUSDK is a light-weight library that provides direct access to Mar=
vell's
> > +    PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library c=
an be
> > +    requested from `Marvell Extranet <https://extranet.marvell.com>`_.=
 Once
> > +    approval has been granted, library can be found by typing ``musdk`=
` in
> > +    search box.
>
> What is the condition of having an approval?
I think Marvell team would be more helpful here.
>
> > +
> > +- DPDK environment
> > +
> > +    Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>`=
 to setup
> > +    DPDK environment.
> > +
> > +
>
> <...>
>
> > +Building DPDK
> > +-------------
> > +
> > +Driver needs precompiled MUSDK library during compilation. Detailed bu=
ild
> > +process is described in library's documentation under ``doc`` director=
y.
> > +
> > +Before the DPDK build process the environmental variable ``LIBMUSDK_PA=
TH`` with
> > +the path to the MUSDK installation directory needs to be exported.
> > +
> > +Usage Example
> > +-------------
> > +
> > +MRVL PMD requires extra kernel modules to function properly:
> > +
> > +.. code-block:: console
> > +
> > +   insmod musdk_uio.ko
> > +   insmod mv_pp_uio.ko
> > +   insmod mvpp2x_sysfs.ko
>
> Why these kernel modules are required and how one can obtain them?
Kernel modules are used to map device memory regions to userspace.
musdk_uio and mv_pp_uio both come with MUSDK library. As for mvpp2x_sysfs
I think Marvell team could be more helpful here.
> These are out of tree kernel modules right?
Right. You have to either build them yourself or get precompiled from
Marvell-extranet.
>
> <...>
>

--
- Tomasz Duszy=C5=84ski