[v4,1/6] net/ngbe: add build and doc infrastructure
Checks
Commit Message
Adding bare minimum PMD library and doc build infrastructure
and claim the maintainership for ngbe PMD.
Signed-off-by: Jiawen Wu <jiawenwu@trustnetic.com>
---
MAINTAINERS | 6 ++++++
doc/guides/nics/features/ngbe.ini | 10 +++++++++
doc/guides/nics/index.rst | 1 +
doc/guides/nics/ngbe.rst | 28 ++++++++++++++++++++++++++
doc/guides/rel_notes/release_21_05.rst | 6 ++++++
drivers/net/meson.build | 1 +
drivers/net/ngbe/meson.build | 12 +++++++++++
drivers/net/ngbe/ngbe_ethdev.c | 4 ++++
drivers/net/ngbe/ngbe_ethdev.h | 4 ++++
drivers/net/ngbe/version.map | 3 +++
10 files changed, 75 insertions(+)
create mode 100644 doc/guides/nics/features/ngbe.ini
create mode 100644 doc/guides/nics/ngbe.rst
create mode 100644 drivers/net/ngbe/meson.build
create mode 100644 drivers/net/ngbe/ngbe_ethdev.c
create mode 100644 drivers/net/ngbe/ngbe_ethdev.h
create mode 100644 drivers/net/ngbe/version.map
Comments
On 4/6/2021 10:30 AM, Jiawen Wu wrote:
> Adding bare minimum PMD library and doc build infrastructure
> and claim the maintainership for ngbe PMD.
>
> Signed-off-by: Jiawen Wu <jiawenwu@trustnetic.com>
<...>
> diff --git a/doc/guides/nics/ngbe.rst b/doc/guides/nics/ngbe.rst
> new file mode 100644
> index 000000000..007d8e80e
> --- /dev/null
> +++ b/doc/guides/nics/ngbe.rst
> @@ -0,0 +1,28 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(c) 2018-2020.
You may want to add who is the copyright owner, like "Intel Corporation" part in
Copyright(c) 2017-2019 Intel Corporation
I recognized same is missing in txgbe too, can you fix that too please?
> +
> +NGBE Poll Mode Driver
> +======================
> +
> +The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support
> +for Wangxun 1 Gigabit Ethernet NICs.
> +
> +Prerequisites
> +-------------
> +
> +- Learning about Wangxun 10 Gigabit Ethernet NICs using
"10 Gigabit" or "1 Gigabit"?
> + `<https://www.net-swift.com/a/386.html>`_.
> +
What is the relation between netswift/WebEx/Wangxun ?
On April 9, 2021 10:37 PM, Ferruh Yigit wrote:
> On 4/6/2021 10:30 AM, Jiawen Wu wrote:
> > Adding bare minimum PMD library and doc build infrastructure and claim
> > the maintainership for ngbe PMD.
> >
> > Signed-off-by: Jiawen Wu <jiawenwu@trustnetic.com>
>
> <...>
>
> > diff --git a/doc/guides/nics/ngbe.rst b/doc/guides/nics/ngbe.rst new
> > file mode 100644 index 000000000..007d8e80e
> > --- /dev/null
> > +++ b/doc/guides/nics/ngbe.rst
> > @@ -0,0 +1,28 @@
> > +.. SPDX-License-Identifier: BSD-3-Clause
> > + Copyright(c) 2018-2020.
>
> You may want to add who is the copyright owner, like "Intel Corporation" part
> in
> Copyright(c) 2017-2019 Intel Corporation
>
> I recognized same is missing in txgbe too, can you fix that too please?
>
I'm thinking about it...
> > +
> > +NGBE Poll Mode Driver
> > +======================
> > +
> > +The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support for
> > +Wangxun 1 Gigabit Ethernet NICs.
> > +
> > +Prerequisites
> > +-------------
> > +
> > +- Learning about Wangxun 10 Gigabit Ethernet NICs using
>
> "10 Gigabit" or "1 Gigabit"?
>
It's a clerical error.
> > + `<https://www.net-swift.com/a/386.html>`_.
> > +
>
> What is the relation between netswift/WebEx/Wangxun ?
Wangxun is Chinese spell of our company name, trustnetic and net-swift are domain names.
WebEx, as far as I know, its Chinese translation is the same as Wangxun, but it has nothing relation between us.
@@ -887,6 +887,12 @@ F: drivers/net/txgbe/
F: doc/guides/nics/txgbe.rst
F: doc/guides/nics/features/txgbe.ini
+Wangxun ngbe
+M: Jiawen Wu <jiawenwu@trustnetic.com>
+F: drivers/net/ngbe/
+F: doc/guides/nics/ngbe.rst
+F: doc/guides/nics/features/ngbe.ini
+
VMware vmxnet3
M: Yong Wang <yongwang@vmware.com>
F: drivers/net/vmxnet3/
new file mode 100644
@@ -0,0 +1,10 @@
+;
+; Supported features of the 'ngbe' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Linux = Y
+ARMv8 = Y
+x86-32 = Y
+x86-64 = Y
@@ -47,6 +47,7 @@ Network Interface Controller Drivers
netvsc
nfb
nfp
+ ngbe
null
octeontx
octeontx2
new file mode 100644
@@ -0,0 +1,28 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2018-2020.
+
+NGBE Poll Mode Driver
+======================
+
+The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support
+for Wangxun 1 Gigabit Ethernet NICs.
+
+Prerequisites
+-------------
+
+- Learning about Wangxun 10 Gigabit Ethernet NICs using
+ `<https://www.net-swift.com/a/386.html>`_.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+
+Driver compilation and testing
+------------------------------
+
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.
+
+Limitations or Known issues
+---------------------------
+
+Build with ICC is not supported yet.
+Power8, ARMv7 and BSD are not supported yet.
@@ -113,6 +113,12 @@ New Features
* Added support for txgbevf PMD.
* Support device arguments to handle AN training for backplane NICs.
+* **Added Wangxun ngbe PMD.**
+
+ Added a new PMD driver for Wangxun 1 Gigabit Ethernet NICs.
+
+ See the :doc:`../nics/ngbe` for more details.
+
* **Enabled vmxnet3 PMD on Windows.**
* **Updated the AF_XDP driver.**
@@ -36,6 +36,7 @@ drivers = ['af_packet',
'netvsc',
'nfb',
'nfp',
+ 'ngbe',
'null',
'octeontx',
'octeontx2',
new file mode 100644
@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2018-2020
+
+if is_windows
+ build = false
+ reason = 'not supported on Windows'
+ subdir_done()
+endif
+
+sources = files(
+ 'ngbe_ethdev.c',
+)
new file mode 100644
@@ -0,0 +1,4 @@
+ /* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2018-2020
+ */
+
new file mode 100644
@@ -0,0 +1,4 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2018-2020
+ */
+
new file mode 100644
@@ -0,0 +1,3 @@
+DPDK_21 {
+ local: *;
+};