[PATCH v4 4/4] net/macb: add necessary docs and update related files
liwencheng
liwencheng at phytium.com.cn
Wed Apr 2 09:11:11 CEST 2025
Added missing documentation in doc/guides/nics,
mailmap entry, and updated MAINTAINERS file.
Signed-off-by: liwencheng <liwencheng at phytium.com.cn>
---
.mailmap | 1 +
MAINTAINERS | 6 ++++++
doc/guides/nics/features/macb.ini | 27 +++++++++++++++++++++++++++
doc/guides/nics/index.rst | 1 +
doc/guides/nics/macb.rst | 26 ++++++++++++++++++++++++++
doc/guides/rel_notes/release_25_03.rst | 5 +++++
6 files changed, 66 insertions(+)
create mode 100644 doc/guides/nics/features/macb.ini
create mode 100644 doc/guides/nics/macb.rst
diff --git a/.mailmap b/.mailmap
index d8439b7..001d7b2 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1675,6 +1675,7 @@ Wen Chiu <wchiu at brocade.com>
Wen-Chi Yang <wolkayang at gmail.com>
Wenfeng Liu <liuwf at arraynetworks.com.cn>
Wenjie Li <wenjiex.a.li at intel.com>
+Wencheng Li <liwencheng at phytium.com.cn>
Wenjie Sun <findtheonlyway at gmail.com>
Wenjing Qiao <wenjing.qiao at intel.com>
Wenjun Wu <wenjun1.wu at intel.com>
diff --git a/MAINTAINERS b/MAINTAINERS
index 4b01103..379645d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -920,6 +920,12 @@ F: doc/guides/platform/bluefield.rst
F: doc/guides/nics/mlx5.rst
F: doc/guides/nics/features/mlx5.ini
+Phytium macb
+M: Wencheng Li <liwencheng at phytium.com.cn>
+F: drivers/net/macb
+F: doc/guides/nics/macb.rst
+F: doc/guides/nics/features/macb.ini
+
Microsoft mana
M: Long Li <longli at microsoft.com>
M: Wei Hu <weh at microsoft.com>
diff --git a/doc/guides/nics/features/macb.ini b/doc/guides/nics/features/macb.ini
new file mode 100644
index 0000000..cefc282
--- /dev/null
+++ b/doc/guides/nics/features/macb.ini
@@ -0,0 +1,27 @@
+;
+; Supported features of the 'macb' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+
+[Features]
+Speed capabilities = Y
+Link status = Y
+Queue start/stop = Y
+MTU update = Y
+Allmulticast mode = Y
+CRC offload = Y
+L3 checksum offload = Y
+L4 checksum offload = Y
+Scattered Rx = Y
+Rx descriptor status = Y
+Basic stats = Y
+Linux = Y
+
+[rte_flow items]
+eth = Y
+ipv4 = Y
+ipv6 = Y
+raw = Y
+tcp = Y
+udp = Y
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 10a2eca..8ae1950 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -43,6 +43,7 @@ Network Interface Controller Drivers
ionic
ipn3ke
ixgbe
+ macb
mana
memif
mlx4
diff --git a/doc/guides/nics/macb.rst b/doc/guides/nics/macb.rst
new file mode 100644
index 0000000..5614a63
--- /dev/null
+++ b/doc/guides/nics/macb.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2022~2023 Phytium Technology Co., Ltd.
+
+MACB Poll Mode Driver
+=====================
+
+The MACB PMD provides poll mode driver support
+for the Ethernet interface MAC 1/2.5/10 Gbps adapter.
+
+Supported Chipsets and NICs
+---------------------------
+
+Phytium Ethernet interface cdns,phytium-gem-1.0
+Phytium Ethernet interface cdns,phytium-gem-2.0
+
+Features
+--------
+
+Features of the MACB PMD are:
+
+* Speed capabilities
+* Link status
+* Tx Queue start/stop
+* Multiple queues for TX and RX
+* CRC offload
+* Jumbo frames supported
diff --git a/doc/guides/rel_notes/release_25_03.rst b/doc/guides/rel_notes/release_25_03.rst
index 652562a..f53ccc9 100644
--- a/doc/guides/rel_notes/release_25_03.rst
+++ b/doc/guides/rel_notes/release_25_03.rst
@@ -127,6 +127,11 @@ New Features
See the :doc:`../compressdevs/zsda` guide for more details on the new driver.
+* **Added Phytium macb net driver.**
+
+ Added a new network PMD which supports Phytium 1 and 10 Gigabit
+ Ethernet NICs.
+
* **Added atomic tests to the eventdev test application.**
Added two atomic tests: ``atomic_queue`` and ``atomic_atq``.
--
2.7.4
More information about the dev
mailing list