RE: [PATCH v5 1/9] drivers/raw: introduce cnxk rvu lf device driver

[Jerin Jacob <jerinj@marvell.com>]

> -----Original Message-----
> From: Akhil Goyal <gakhil@marvell.com>
> Sent: Thursday, October 24, 2024 6:48 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; david.marchand@redhat.com;
> hemant.agrawal@nxp.com; Jerin Jacob <jerinj@marvell.com>; Harman Kalra
> <hkalra@marvell.com>; stephen@networkplumber.org;
> sachin.saxena@oss.nxp.com; ferruh.yigit@amd.com; Akhil Goyal
> <gakhil@marvell.com>
> Subject: [PATCH v5 1/9] drivers/raw: introduce cnxk rvu lf device driver
> 
> CNXK product families can have a use case to allow PF and VF applications to
> communicate using mailboxes and also get notified of any interrupt that may
> occur on the device.
> Hence, a new raw device driver is added for such RVU LF devices.
> These devices can map to a PF or a VF which can send mailboxes to each other.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
_> +
>  NTB
>  M: Jingjing Wu <jingjing.wu@intel.com>
>  F: drivers/raw/ntb/
> diff --git a/doc/guides/rawdevs/cnxk_rvu_lf.rst
> b/doc/guides/rawdevs/cnxk_rvu_lf.rst
> new file mode 100644
> index 0000000000..8a0bc22dd5
> --- /dev/null
> +++ b/doc/guides/rawdevs/cnxk_rvu_lf.rst
> @@ -0,0 +1,40 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2024 Marvell.
> +
> +Marvell CNXK RVU LF Driver
> +==========================
> +
> +CNXK product families can have a use case to allow PF and VF

PF and VF -> RVU PF and RVU VF

> +applications to communicate using mailboxes and also get notified of

Applications-> driver

> +any interrupt that may occur on the device.
> +Hence, a new raw device driver is added for such RVU LF devices.
> +These devices can map to a PF or a VF which can send mailboxes to each
> +other.
> +
> +Features
> +--------
> +
> +The RVU LF device implements following features in the rawdev API:
> +
> +- Register mailbox callbacks for the other side to process mailboxes.
> +- Register interrupt handler callbacks.
> +- Process mailbox.
> +- Set range of message IDs allowed for communication.

Please update each lines in the respective patch.

Also,  please wire this file to doc/guides/platform/cnxk.rst like other cnxk drivers

> +
> +Limitations
> +-----------
> +
> +In multiprocess mode user-space application must ensure no resources
> +sharing takes place.
> +Otherwise, user-space application should ensure synchronization.
> +
> +Device Setup
> +------------
> +
> +The RVU LF devices will need to be bound to a user-space IO driver for use.
> +The script ``dpdk-devbind.py`` included with DPDK can be used to view
> +the state of the devices and to bind them to a suitable DPDK-supported
> +kernel driver. When querying the status of the devices, they will
> +appear under the category of "Misc (rawdev) devices", i.e. the command
> +``dpdk-devbind.py --status-dev misc`` can be used to see the state of
> +those devices alone.