From: Howard Wang <howard_wang@realsil.com.cn>
To: <dev@dpdk.org>
Cc: <pro_nic_dpdk@realtek.com>, Howard Wang <howard_wang@realsil.com.cn>
Subject: [PATCH v2 18/18] doc/guides/nics: add documents for r8169 pmd
Date: Thu, 17 Oct 2024 14:32:00 +0800 [thread overview]
Message-ID: <20241017063200.26101-19-howard_wang@realsil.com.cn> (raw)
In-Reply-To: <20241017063200.26101-1-howard_wang@realsil.com.cn>
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 --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
--
2.34.1
next prev parent reply other threads:[~2024-10-17 6:34 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-17 6:31 [PATCH v2 00/18] net/r8169: add r8169 pmd to dpdk Howard Wang
2024-10-17 6:31 ` [PATCH v2 01/18] net/r8169: add PMD driver skeleton Howard Wang
2024-10-17 16:30 ` Stephen Hemminger
2024-10-17 6:31 ` [PATCH v2 02/18] net/r8169: add logging structure Howard Wang
2024-10-17 16:32 ` Stephen Hemminger
2024-10-17 6:31 ` [PATCH v2 03/18] net/r8169: add hardware registers access routines Howard Wang
2024-10-17 16:34 ` Stephen Hemminger
2024-10-18 3:41 ` 答复: " 王颢
2024-10-17 6:31 ` [PATCH v2 04/18] net/r8169: implement core logic for Tx/Rx Howard Wang
2024-10-17 6:31 ` [PATCH v2 05/18] net/r8169: add support for hw config Howard Wang
2024-10-17 16:35 ` Stephen Hemminger
2024-10-18 5:45 ` 答复: " 王颢
2024-10-17 6:31 ` [PATCH v2 06/18] net/r8169: add phy registers access routines Howard Wang
2024-10-17 6:31 ` [PATCH v2 07/18] net/r8169: add support for hardware operations Howard Wang
2024-10-17 6:31 ` [PATCH v2 08/18] net/r8169: add support for phy configuration Howard Wang
2024-10-17 6:31 ` [PATCH v2 09/18] net/r8169: add support for hw initialization Howard Wang
2024-10-17 6:31 ` [PATCH v2 10/18] net/r8169: add link status and interrupt management Howard Wang
2024-10-17 6:31 ` [PATCH v2 11/18] net/r8169: implement Rx path Howard Wang
2024-10-17 16:11 ` Stephen Hemminger
2024-10-18 2:02 ` 答复: " 王颢
2024-10-17 6:31 ` [PATCH v2 12/18] net/r8169: implement Tx path Howard Wang
2024-10-17 8:13 ` [PATCH " Howard Wang
2024-10-17 6:31 ` [PATCH v2 13/18] net/r8169: implement device statistics Howard Wang
2024-10-17 6:31 ` [PATCH v2 14/18] net/r8169: implement promisc and allmulti modes Howard Wang
2024-10-17 6:31 ` [PATCH v2 15/18] net/r8169: impelment MTU configuration Howard Wang
2024-10-17 6:31 ` [PATCH v2 16/18] net/r8169: add support for getting fw version Howard Wang
2024-10-17 6:31 ` [PATCH v2 17/18] net/r8169: add driver_start and driver_stop Howard Wang
2024-10-17 6:32 ` Howard Wang [this message]
2024-10-17 16:43 ` [PATCH v2 18/18] doc/guides/nics: add documents for r8169 pmd Stephen Hemminger
2024-10-17 16:41 ` [PATCH v2 00/18] net/r8169: add r8169 pmd to dpdk Stephen Hemminger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241017063200.26101-19-howard_wang@realsil.com.cn \
--to=howard_wang@realsil.com.cn \
--cc=dev@dpdk.org \
--cc=pro_nic_dpdk@realtek.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).