diff mbox series

[v3,18/18] doc/guides/nics: add documents for r8169 pmd

Message ID 20241023033328.191827-19-howard_wang@realsil.com.cn (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series Modify some code as suggested by the maintainer. |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation fail Compilation issues
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing warning Testing issues
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Howard Wang Oct. 23, 2024, 3:33 a.m. UTC 
Signed-off-by: Howard Wang <howard_wang@realsil.com.cn>
---
 MAINTAINERS                        |  2 ++
 doc/guides/nics/features/r8169.ini | 32 ++++++++++++++++++++++++++++++
 doc/guides/nics/index.rst          |  1 +
 doc/guides/nics/r8169.rst          | 17 ++++++++++++++++
 4 files changed, 52 insertions(+)
 create mode 100644 doc/guides/nics/features/r8169.ini
 create mode 100644 doc/guides/nics/r8169.rst
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 5f9eccc43f..6f56c966fd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1082,6 +1082,8 @@  M: ChunHao Lin <hau@realtek.com>
 M: Xing Wang <xing_wang@realsil.com.cn>
 M: Realtek NIC SW <pro_nic_dpdk@realtek.com>
 F: drivers/net/r8169
+F: doc/guides/nics/r8169.rst
+F: doc/guides/nics/features/r8169.ini
 
 
 Crypto Drivers
diff --git a/doc/guides/nics/features/r8169.ini b/doc/guides/nics/features/r8169.ini
new file mode 100644
index 0000000000..8e4142f64e
--- /dev/null
+++ b/doc/guides/nics/features/r8169.ini
@@ -0,0 +1,32 @@ 
+;
+; Supported features of the 'r8169' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Speed capabilities   = Y
+Link speed configuration = Y
+Link status          = Y
+Link status event    = Y
+MTU update           = Y
+Scattered Rx         = Y
+TSO                  = Y
+Promiscuous mode     = Y
+Allmulticast mode    = Y
+Unicast MAC filter   = Y
+Multicast MAC filter = Y
+Flow control         = Y
+CRC offload          = Y
+L3 checksum offload  = Y
+L4 checksum offload  = Y
+Packet type parsing  = Y
+Rx descriptor status = Y
+Tx descriptor status = Y
+Basic stats          = Y
+Extended stats       = Y
+Stats per queue      = Y
+FW version           = Y
+Registers dump       = Y
+Linux                = Y
+x86-32               = Y
+x86-64               = Y
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index c14bc7988a..0861be59d3 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -60,6 +60,7 @@  Network Interface Controller Drivers
     pcap_ring
     pfe
     qede
+    r8169
     sfc_efx
     softnic
     tap
diff --git a/doc/guides/nics/r8169.rst b/doc/guides/nics/r8169.rst
new file mode 100644
index 0000000000..149276cc91
--- /dev/null
+++ b/doc/guides/nics/r8169.rst
@@ -0,0 +1,17 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2024 Realtek Corporation. All rights reserved
+
+R8169 Poll Mode Driver
+======================
+
+The R8169 PMD provides poll mode driver support for Realtek 2.5 and 5 Gigabit
+Ethernet NICs.
+
+Features
+--------
+
+Features of the R8169 PMD are:
+
+* Checksum offload
+* TCP segmentation offload
+* Jumbo frames supported