diff mbox series

[v3,6/6] net/macb: add necessary docs and update related files

Message ID 1733814614-412254-1-git-send-email-liwencheng@phytium.com.cn (mailing list archive)
State Changes Requested
Delegated to: Stephen Hemminger
Headers
Series [v3,1/6] net/macb: add new driver |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS

Commit Message

Wencheng Li Dec. 10, 2024, 7:10 a.m. UTC 
Added missing documentation in doc/guides/nics,
mailmap entry, and updated MAINTAINERS file.

Signed-off-by: Wencheng Li <liwencheng@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_24_11.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 mbox series

Patch

diff --git a/.mailmap b/.mailmap
index 8187982..2674a82 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1654,6 +1654,7 @@  Wen Chiu <wchiu@brocade.com>
 Wen-Chi Yang <wolkayang@gmail.com>
 Wenfeng Liu <liuwf@arraynetworks.com.cn>
 Wenjie Li <wenjiex.a.li@intel.com>
+Wencheng Li <liwencheng@phytium.com.cn>
 Wenjie Sun <findtheonlyway@gmail.com>
 Wenjing Qiao <wenjing.qiao@intel.com>
 Wenjun Wu <wenjun1.wu@intel.com>
diff --git a/MAINTAINERS b/MAINTAINERS
index 60bdcce..8fdcc66 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -921,6 +921,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@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@microsoft.com>
 M: Wei Hu <weh@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 50688d9..6e0c87b 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_24_11.rst b/doc/guides/rel_notes/release_24_11.rst
index 8486cd9..962291a 100644
--- a/doc/guides/rel_notes/release_24_11.rst
+++ b/doc/guides/rel_notes/release_24_11.rst
@@ -167,6 +167,11 @@  New Features
   Added a new network PMD which supports Realtek 2.5 and 5 Gigabit
   Ethernet NICs.
 
+* **Added Phytium macb net driver.**
+
+  Added a new network PMD which supports Phytium 1 and 10 Gigabit
+  Ethernet NICs.
+
 * **Added ZTE zxdh net driver [EXPERIMENTAL].**
 
   Added ethdev driver support for the zxdh NX Series Ethernet Controller.