From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0E87345B5A; Thu, 17 Oct 2024 08:34:46 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 023E0402F1; Thu, 17 Oct 2024 08:34:46 +0200 (CEST) Received: from rtits2.realtek.com.tw (rtits2.realtek.com [211.75.126.72]) by mails.dpdk.org (Postfix) with ESMTP id BA92F402EB for ; Thu, 17 Oct 2024 08:34:44 +0200 (CEST) X-SpamFilter-By: ArmorX SpamTrap 5.78 with qID 49H6Yg2K24189436, This message is accepted by code: ctloc85258 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=realsil.com.cn; s=dkim; t=1729146883; bh=/+bLQfbTAUL42Ls8F8ROsTvJ9GNqn+F4LzlQILovp24=; h=From:To:CC:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Transfer-Encoding:Content-Type; b=Rk/3G4TwQrfDEO3KsCQ755rGtFyM+iQVRGe8/nSLm9+7hmIzk7zmc1py78TKwLzRU DnbAUT9EqRPkg/Sw9Zr0Pnwy+7GvbZjuygAgmWd+s/25a+AlqvwHOBX2H5VSrmgugE kVVAKzsolbs99XPYavsbXe2VtXsagYfqmj8Vdokby9/qBoZc+5VtivXzj9JVNv+LfP VZPKjfEOHZyObc+0svWQfjA1UdkYc7Jaz227u54+GEhmS7E4lK5Qo7AZnQIaEB2BSh t+ruPQKjyjC48fYKCxdSioHHqmFHulyNoplLW3J9i1IH9bA6Ad45Wm8aBKUS7zRsGC uuOvXH+wDKl1A== Received: from RSEXH36502.realsil.com.cn (ms1.realsil.com.cn[172.29.17.3]) by rtits2.realtek.com.tw (8.15.2/3.06/5.92) with ESMTPS id 49H6Yg2K24189436 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=FAIL) for ; Thu, 17 Oct 2024 14:34:43 +0800 Received: from RSEXDAG02.realsil.com.cn (172.29.17.196) by RSEXH36502.realsil.com.cn (172.29.17.3) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Thu, 17 Oct 2024 14:34:42 +0800 Received: from RSEXH36502.realsil.com.cn (172.29.17.3) by RSEXDAG02.realsil.com.cn (172.29.17.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Thu, 17 Oct 2024 14:34:42 +0800 Received: from 172.29.32.27 (172.29.32.27) by RSEXH36502.realsil.com.cn (172.29.17.3) with Microsoft SMTP Server id 15.1.2507.35 via Frontend Transport; Thu, 17 Oct 2024 14:34:42 +0800 From: Howard Wang To: CC: , Howard Wang Subject: [PATCH v2 18/18] doc/guides/nics: add documents for r8169 pmd Date: Thu, 17 Oct 2024 14:32:00 +0800 Message-ID: <20241017063200.26101-19-howard_wang@realsil.com.cn> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241017063200.26101-1-howard_wang@realsil.com.cn> References: <20241017063200.26101-1-howard_wang@realsil.com.cn> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Signed-off-by: Howard Wang --- 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 M: Xing Wang M: Realtek NIC SW 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