Re: [PATCH v3 3/4] doc: add mrvl net pmd documentation

[Tomasz Duszynski <tdu@semihalf.com>]

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   = 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          = Y
> > +MTU update           = Y
> > +Jumbo frame          = Y
> > +Promiscuous mode     = Y
> > +Allmulticast mode    = Y
> > +Unicast MAC filter   = Y
> > +Multicast MAC filter = Y
> > +RSS hash             = Y
> > +VLAN filter          = Y
> > +CRC offload          = Y
> > +L3 checksum offload  = Y
> > +L4 checksum offload  = Y
> > +Packet type parsing  = Y
> > +Basic stats          = Y
> > +Stats per queue      = Y
> > +ARMv8                = Y
>
> Is other architecture not supported or not tested?
Currently that NIC comes integrated into Armada 7k/8k SoCs and they are based
on ARMv8.
>
> > +Usage doc            = Y
>
> <...>
>
> > +Prerequisites
> > +-------------
> > +
> > +- MUSDK (Marvell User-Space SDK) sources available
> > +  `here <https://github.com/MarvellEmbeddedProcessors/musdk-marvell/tree/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 Marvell's
> > +    PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library can 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 build
> > +process is described in library's documentation under ``doc`` directory.
> > +
> > +Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` 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ński