diff mbox series

[v2,01/11] net/octeontx_ep: add build and doc infrastructure

Message ID 20210118093602.5449-1-pnalla@marvell.com (mailing list archive)
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers show
Series [v2,01/11] net/octeontx_ep: add build and doc infrastructure | expand

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Nalla Pradeep Jan. 18, 2021, 9:35 a.m. UTC
Adding bare minimum PMD library and doc build infrastructure
and claim the maintainership for octeontx end point PMD.

Signed-off-by: Nalla Pradeep <pnalla@marvell.com>
---
 MAINTAINERS                              |  9 +++++++
 doc/guides/nics/features/octeontx_ep.ini |  8 ++++++
 doc/guides/nics/index.rst                |  1 +
 doc/guides/nics/octeontx_ep.rst          | 32 ++++++++++++++++++++++++
 drivers/net/meson.build                  |  1 +
 drivers/net/octeontx_ep/meson.build      |  8 ++++++
 drivers/net/octeontx_ep/otx_ep_ethdev.c  |  3 +++
 drivers/net/octeontx_ep/version.map      |  4 +++
 8 files changed, 66 insertions(+)
 create mode 100644 doc/guides/nics/features/octeontx_ep.ini
 create mode 100644 doc/guides/nics/octeontx_ep.rst
 create mode 100644 drivers/net/octeontx_ep/meson.build
 create mode 100644 drivers/net/octeontx_ep/otx_ep_ethdev.c
 create mode 100644 drivers/net/octeontx_ep/version.map

Comments

Jerin Jacob Jan. 19, 2021, 11:50 a.m. UTC | #1
On Mon, Jan 18, 2021 at 3:08 PM Nalla Pradeep <pnalla@marvell.com> wrote:
>
> Adding bare minimum PMD library and doc build infrastructure
> and claim the maintainership for octeontx end point PMD.
>
> Signed-off-by: Nalla Pradeep <pnalla@marvell.com>
> ---
>  MAINTAINERS                              |  9 +++++++
>  doc/guides/nics/features/octeontx_ep.ini |  8 ++++++
>  doc/guides/nics/index.rst                |  1 +
>  doc/guides/nics/octeontx_ep.rst          | 32 ++++++++++++++++++++++++
>  drivers/net/meson.build                  |  1 +
>  drivers/net/octeontx_ep/meson.build      |  8 ++++++
>  drivers/net/octeontx_ep/otx_ep_ethdev.c  |  3 +++
>  drivers/net/octeontx_ep/version.map      |  4 +++
>  8 files changed, 66 insertions(+)

> +
> +The following options may be modified in the ``config`` file.
> +
> +- ``CONFIG_RTE_LIBRTE_OCTEONTX_EP_PMD`` (default ``y``)

Stale stuff. Not valid for meson.

> +
> +  Toggle compilation of the ``librte_pmd_octeontx_ep`` driver.
> diff --git a/drivers/net/meson.build b/drivers/net/meson.build
> index 4948500aef..007f6d889b 100644
> --- a/drivers/net/meson.build
> +++ b/drivers/net/meson.build
> @@ -39,6 +39,7 @@ drivers = ['af_packet',
>         'null',
>         'octeontx',
>         'octeontx2',
> +       'octeontx_ep',
>         'pcap',
>         'pfe',
>         'qede',
> diff --git a/drivers/net/octeontx_ep/meson.build b/drivers/net/octeontx_ep/meson.build
> new file mode 100644
> index 0000000000..83ffbad7b6
> --- /dev/null
> +++ b/drivers/net/octeontx_ep/meson.build
> @@ -0,0 +1,8 @@
> +# SPDX-License-Identifier: BSD-3-Clause
> +# Copyright(C) 2020 Marvell.

Change the copyright to 2021


> +#
> +
> +sources = files(
> +               'otx_ep_ethdev.c',
> +               )
> +
> diff --git a/drivers/net/octeontx_ep/otx_ep_ethdev.c b/drivers/net/octeontx_ep/otx_ep_ethdev.c
> new file mode 100644
> index 0000000000..2b2d684a0b
> --- /dev/null
> +++ b/drivers/net/octeontx_ep/otx_ep_ethdev.c
> @@ -0,0 +1,3 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(C) 2020 Marvell.
> + */
> diff --git a/drivers/net/octeontx_ep/version.map b/drivers/net/octeontx_ep/version.map
> new file mode 100644
> index 0000000000..f4db678dd5
> --- /dev/null
> +++ b/drivers/net/octeontx_ep/version.map
> @@ -0,0 +1,4 @@
> +DPDK_20.0 {

21


> +
> +        local: *;
> +};
> --
> 2.17.1
>
Ferruh Yigit Jan. 26, 2021, 3:09 p.m. UTC | #2
On 1/18/2021 9:35 AM, Nalla Pradeep wrote:
> Adding bare minimum PMD library and doc build infrastructure
> and claim the maintainership for octeontx end point PMD.
> 
> Signed-off-by: Nalla Pradeep <pnalla@marvell.com>

<...>

> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'octeontx_ep' network poll mode driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +Linux VFIO           = Y

This feature name has been updated, can you please rebase on top of latest 
next-net for it.

Also can you please set the supported architectures.

<...>

> @@ -0,0 +1,32 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(C) 2020 Marvell.
> +
> +OCTEON TX EP Poll Mode driver
> +===========================
> +
> +The OCTEON TX EP ETHDEV PMD (**librte_pmd_octeontx_ep**) provides poll mode
> +ethdev driver support for the virtual functions (VF) of **Marvell OCTEON TX2**
> +and **Cavium OCTEON TX** families of adapters in SR-IOV context.
> +
> +More information can be found at `Marvell Official Website
> +<https://www.marvell.com/embedded-processors/infrastructure-processors>`_.

This link leads to a very generic product page, is there a way to provide the 
link for the product this driver is for?

> +
> +Features
> +--------
> +
> +Features of the OCTEON TX EP Ethdev PMD are:
> +

Above 'Features' block can be added when a featre is added.

> +
> +Prerequisites
> +-------------
> +
> +See :doc:`../platform/octeontx2` and `../platform/octeontx` for setup information.
> +

Since this is a VF driver, there must be a dependency to the PF driver, can you 
please provide more details on the PF driver.
As far as I understand both octeontx & octeontx2 are supported but please give 
more details about dependency. I assume there must be some host drivers for the 
endpoint PF, etc..

> +Compile time Config Options
> +---------------------------
> +
> +The following options may be modified in the ``config`` file.
> +
> +- ``CONFIG_RTE_LIBRTE_OCTEONTX_EP_PMD`` (default ``y``)
> +
> +  Toggle compilation of the ``librte_pmd_octeontx_ep`` driver.

I think the config option is not more exists, please drop it.

<...>

> +++ b/drivers/net/octeontx_ep/version.map
> @@ -0,0 +1,4 @@
> +DPDK_20.0 {

It should be 'DPDK_21'

> +
> +        local: *;
> +};
>
Ferruh Yigit Jan. 26, 2021, 3:41 p.m. UTC | #3
On 1/18/2021 9:35 AM, Nalla Pradeep wrote:
> Adding bare minimum PMD library and doc build infrastructure
> and claim the maintainership for octeontx end point PMD.
> 
> Signed-off-by: Nalla Pradeep <pnalla@marvell.com>

For the series,

First of all sorry for the late review, I put some comments on some patches.

Overall the set looks clean, there seems no major issue, I hope changes can be 
done on time for -rc2.

If there is a timing concern for updates, I am OK to postpone some parts to -rc3 
as long as they are committed to be completed for -rc3, let say like for adding 
dynamic logging support etc...

Please be aware of the 32bit build error, details in the relative patch.

Thanks,
ferruh
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 76ed473e44..5a095df77d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -762,6 +762,15 @@  T: git://dpdk.org/next/dpdk-next-crypto
 F: drivers/common/octeontx2/otx2_sec*
 F: drivers/net/octeontx2/otx2_ethdev_sec*
 
+Marvell OCTEON TX EP - endpoint
+M: Nalla Pradeep <pnalla@marvell.com>
+M: Radha Mohan Chintakuntla <radhac@marvell.com>
+M: Veerasenareddy Burru <vburru@marvell.com>
+T: git://dpdk.org/next/dpdk-next-net-mrvl
+F: drivers/net/octeontx_ep/
+F: doc/guides/nics/features/octeontx_ep.ini
+F: doc/guides/nics/octeontx_ep.rst
+
 Mellanox mlx4
 M: Matan Azrad <matan@nvidia.com>
 M: Shahaf Shuler <shahafs@nvidia.com>
diff --git a/doc/guides/nics/features/octeontx_ep.ini b/doc/guides/nics/features/octeontx_ep.ini
new file mode 100644
index 0000000000..95d6585222
--- /dev/null
+++ b/doc/guides/nics/features/octeontx_ep.ini
@@ -0,0 +1,8 @@ 
+;
+; Supported features of the 'octeontx_ep' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Linux VFIO           = Y
+Usage doc            = Y
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 3443617755..799697caf0 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -50,6 +50,7 @@  Network Interface Controller Drivers
     null
     octeontx
     octeontx2
+    octeontx_ep
     pfe
     qede
     sfc_efx
diff --git a/doc/guides/nics/octeontx_ep.rst b/doc/guides/nics/octeontx_ep.rst
new file mode 100644
index 0000000000..d194896093
--- /dev/null
+++ b/doc/guides/nics/octeontx_ep.rst
@@ -0,0 +1,32 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(C) 2020 Marvell.
+
+OCTEON TX EP Poll Mode driver
+===========================
+
+The OCTEON TX EP ETHDEV PMD (**librte_pmd_octeontx_ep**) provides poll mode
+ethdev driver support for the virtual functions (VF) of **Marvell OCTEON TX2**
+and **Cavium OCTEON TX** families of adapters in SR-IOV context.
+
+More information can be found at `Marvell Official Website
+<https://www.marvell.com/embedded-processors/infrastructure-processors>`_.
+
+Features
+--------
+
+Features of the OCTEON TX EP Ethdev PMD are:
+
+
+Prerequisites
+-------------
+
+See :doc:`../platform/octeontx2` and `../platform/octeontx` for setup information.
+
+Compile time Config Options
+---------------------------
+
+The following options may be modified in the ``config`` file.
+
+- ``CONFIG_RTE_LIBRTE_OCTEONTX_EP_PMD`` (default ``y``)
+
+  Toggle compilation of the ``librte_pmd_octeontx_ep`` driver.
diff --git a/drivers/net/meson.build b/drivers/net/meson.build
index 4948500aef..007f6d889b 100644
--- a/drivers/net/meson.build
+++ b/drivers/net/meson.build
@@ -39,6 +39,7 @@  drivers = ['af_packet',
 	'null',
 	'octeontx',
 	'octeontx2',
+	'octeontx_ep',
 	'pcap',
 	'pfe',
 	'qede',
diff --git a/drivers/net/octeontx_ep/meson.build b/drivers/net/octeontx_ep/meson.build
new file mode 100644
index 0000000000..83ffbad7b6
--- /dev/null
+++ b/drivers/net/octeontx_ep/meson.build
@@ -0,0 +1,8 @@ 
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(C) 2020 Marvell.
+#
+
+sources = files(
+               'otx_ep_ethdev.c',
+               )
+
diff --git a/drivers/net/octeontx_ep/otx_ep_ethdev.c b/drivers/net/octeontx_ep/otx_ep_ethdev.c
new file mode 100644
index 0000000000..2b2d684a0b
--- /dev/null
+++ b/drivers/net/octeontx_ep/otx_ep_ethdev.c
@@ -0,0 +1,3 @@ 
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2020 Marvell.
+ */
diff --git a/drivers/net/octeontx_ep/version.map b/drivers/net/octeontx_ep/version.map
new file mode 100644
index 0000000000..f4db678dd5
--- /dev/null
+++ b/drivers/net/octeontx_ep/version.map
@@ -0,0 +1,4 @@ 
+DPDK_20.0 {
+
+        local: *;
+};