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 v8 01/17] net/r8169: add PMD driver skeleton
Date: Wed, 13 Nov 2024 17:28:38 +0800 [thread overview]
Message-ID: <20241113092854.91445-2-howard_wang@realsil.com.cn> (raw)
In-Reply-To: <20241113092854.91445-1-howard_wang@realsil.com.cn>
Meson build infrastructure, r8169_ethdev minimal skeleton,
header with Realtek NIC device and vendor IDs.
Signed-off-by: Howard Wang <howard_wang@realsil.com.cn>
---
.mailmap | 3 +
MAINTAINERS | 8 ++
doc/guides/nics/features/r8169.ini | 9 ++
doc/guides/nics/index.rst | 1 +
doc/guides/nics/r8169.rst | 19 ++++
doc/guides/rel_notes/release_24_11.rst | 5 +
drivers/net/meson.build | 1 +
drivers/net/r8169/meson.build | 6 +
drivers/net/r8169/r8169_compat.h | 17 +++
drivers/net/r8169/r8169_ethdev.c | 147 +++++++++++++++++++++++++
drivers/net/r8169/r8169_ethdev.h | 28 +++++
11 files changed, 244 insertions(+)
create mode 100644 doc/guides/nics/features/r8169.ini
create mode 100644 doc/guides/nics/r8169.rst
create mode 100644 drivers/net/r8169/meson.build
create mode 100644 drivers/net/r8169/r8169_compat.h
create mode 100644 drivers/net/r8169/r8169_ethdev.c
create mode 100644 drivers/net/r8169/r8169_ethdev.h
diff --git a/.mailmap b/.mailmap
index dc06d6023b..bc438b2fb6 100644
--- a/.mailmap
+++ b/.mailmap
@@ -262,6 +262,7 @@ Chris Wright <chrisw@redhat.com>
Chuanshe Zhang <zhangchuanshe@icloudshield.com>
Chuanyu Xue <chuanyu.xue@uconn.edu>
Chuhong Yao <ych@panath.cn>
+Chunhao Lin <hau@realtek.com>
Chunsong Feng <fengchunsong@huawei.com>
Churchill Khangar <churchill.khangar@intel.com>
Cian Ferriter <cian.ferriter@intel.com>
@@ -561,6 +562,7 @@ Hongjun Ni <hongjun.ni@intel.com>
Hongzhi Guo <guohongzhi1@huawei.com>
Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Horia Geanta Neag <horia.geanta@nxp.com>
+Howard Wang <howard_wang@realsil.com.cn>
H. Peter Anvin <hpa@linux.intel.com>
Hrvoje Habjanic <hrvoje.habjanic@zg.ht.hr>
Huaibin Wang <huaibin.wang@6wind.com>
@@ -1682,6 +1684,7 @@ Xieming Katty <katty.xieming@huawei.com>
Xinfeng Zhao <xinfengx.zhao@intel.com>
Xingguang He <xingguang.he@intel.com>
Xingyou Chen <niatlantice@gmail.com>
+Xing Wang <xing_wang@realsil.com.cn>
Xinying Yu <xinying.yu@corigine.com>
Xin Long <longxin.xl@alibaba-inc.com>
Xi Zhang <xix.zhang@intel.com>
diff --git a/MAINTAINERS b/MAINTAINERS
index 9a812b3632..4f5e2e8339 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -995,6 +995,14 @@ F: drivers/net/qede/
F: doc/guides/nics/qede.rst
F: doc/guides/nics/features/qede*.ini
+Realtek r8169
+M: Howard Wang <howard_wang@realsil.com.cn>
+M: Chunhao Lin <hau@realtek.com>
+M: Xing Wang <xing_wang@realsil.com.cn>
+F: drivers/net/r8169/
+F: doc/guides/nics/r8169.rst
+F: doc/guides/nics/features/r8169.ini
+
Solarflare sfc_efx
M: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
F: drivers/common/sfc_efx/
diff --git a/doc/guides/nics/features/r8169.ini b/doc/guides/nics/features/r8169.ini
new file mode 100644
index 0000000000..dd1ce4db5c
--- /dev/null
+++ b/doc/guides/nics/features/r8169.ini
@@ -0,0 +1,9 @@
+;
+; Supported features of the 'r8169' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Linux = Y
+x86-32 = Y
+x86-64 = Y
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 8e371ac4a5..50688d9f64 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..071aebcdbf
--- /dev/null
+++ b/doc/guides/nics/r8169.rst
@@ -0,0 +1,19 @@
+.. 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.
+
+More information about Realtek 2.5G Ethernet NIC can be found at `RTL8125
+<https://www.realtek.com/Product/Index?id=3962&cate_id=786&menu_id=1010>`_.
+More information about Realtek 5G Ethernet NIC can be found at `RTL8126
+<https://www.realtek.com/Product/ProductHitsDetail?id=4425&menu_id=643>`_.
+
+Supported Chipsets and NICs
+---------------------------
+
+- Realtek RTL8125 2.5 Gigabit Ethernet Controller
+- Realtek RTL8126 5 Gigabit Ethernet Controller
diff --git a/doc/guides/rel_notes/release_24_11.rst b/doc/guides/rel_notes/release_24_11.rst
index 66b970e036..42199f4582 100644
--- a/doc/guides/rel_notes/release_24_11.rst
+++ b/doc/guides/rel_notes/release_24_11.rst
@@ -170,6 +170,11 @@ New Features
* Added asynchronous flow support
* Added MTU update
+* **Added Realtek network PMD.**
+
+ Added a new network PMD which supports Realtek 2.5 and 5 Gigabit
+ Ethernet NICs.
+
* **Updated ZTE zxdh net driver [EXPERIMENTAL].**
* Added ethdev driver support for zxdh NX Series Ethernet Controller.
diff --git a/drivers/net/meson.build b/drivers/net/meson.build
index 0a12914534..dafd637ba4 100644
--- a/drivers/net/meson.build
+++ b/drivers/net/meson.build
@@ -52,6 +52,7 @@ drivers = [
'pcap',
'pfe',
'qede',
+ 'r8169',
'ring',
'sfc',
'softnic',
diff --git a/drivers/net/r8169/meson.build b/drivers/net/r8169/meson.build
new file mode 100644
index 0000000000..a49d350bf5
--- /dev/null
+++ b/drivers/net/r8169/meson.build
@@ -0,0 +1,6 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2024 Realtek Corporation. All rights reserved
+
+sources = files(
+ 'r8169_ethdev.c',
+)
diff --git a/drivers/net/r8169/r8169_compat.h b/drivers/net/r8169/r8169_compat.h
new file mode 100644
index 0000000000..e337ce3afa
--- /dev/null
+++ b/drivers/net/r8169/r8169_compat.h
@@ -0,0 +1,17 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2024 Realtek Corporation. All rights reserved
+ */
+
+#ifndef _R8169_COMPAT_H_
+#define _R8169_COMPAT_H_
+
+#include <stdint.h>
+
+typedef uint8_t u8;
+typedef uint16_t u16;
+typedef uint32_t u32;
+typedef uint64_t u64;
+
+#define PCI_VENDOR_ID_REALTEK 0x10EC
+
+#endif
diff --git a/drivers/net/r8169/r8169_ethdev.c b/drivers/net/r8169/r8169_ethdev.c
new file mode 100644
index 0000000000..740f7957be
--- /dev/null
+++ b/drivers/net/r8169/r8169_ethdev.c
@@ -0,0 +1,147 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2024 Realtek Corporation. All rights reserved
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+
+#include <rte_eal.h>
+
+#include <rte_common.h>
+#include <rte_pci.h>
+#include <bus_pci_driver.h>
+#include <rte_ether.h>
+#include <ethdev_driver.h>
+#include <ethdev_pci.h>
+#include <dev_driver.h>
+
+#include "r8169_ethdev.h"
+#include "r8169_compat.h"
+
+static int rtl_dev_configure(struct rte_eth_dev *dev);
+static int rtl_dev_start(struct rte_eth_dev *dev);
+static int rtl_dev_stop(struct rte_eth_dev *dev);
+static int rtl_dev_reset(struct rte_eth_dev *dev);
+static int rtl_dev_close(struct rte_eth_dev *dev);
+
+/*
+ * The set of PCI devices this driver supports
+ */
+static const struct rte_pci_id pci_id_r8169_map[] = {
+ { RTE_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8125) },
+ { RTE_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8162) },
+ { RTE_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8126) },
+ { RTE_PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x5000) },
+ {.vendor_id = 0, /* sentinel */ },
+};
+
+static const struct eth_dev_ops rtl_eth_dev_ops = {
+ .dev_configure = rtl_dev_configure,
+ .dev_start = rtl_dev_start,
+ .dev_stop = rtl_dev_stop,
+ .dev_close = rtl_dev_close,
+ .dev_reset = rtl_dev_reset,
+};
+
+static int
+rtl_dev_configure(struct rte_eth_dev *dev __rte_unused)
+{
+ return 0;
+}
+
+/*
+ * Configure device link speed and setup link.
+ * It returns 0 on success.
+ */
+static int
+rtl_dev_start(struct rte_eth_dev *dev __rte_unused)
+{
+ return 0;
+}
+
+/*
+ * Stop device: disable RX and TX functions to allow for reconfiguring.
+ */
+static int
+rtl_dev_stop(struct rte_eth_dev *dev __rte_unused)
+{
+ return 0;
+}
+
+/*
+ * Reset and stop device.
+ */
+static int
+rtl_dev_close(struct rte_eth_dev *dev)
+{
+ int ret_stp;
+
+ if (rte_eal_process_type() != RTE_PROC_PRIMARY)
+ return 0;
+
+ ret_stp = rtl_dev_stop(dev);
+
+ return ret_stp;
+}
+
+static int
+rtl_dev_init(struct rte_eth_dev *dev)
+{
+ dev->dev_ops = &rtl_eth_dev_ops;
+
+ /* For secondary processes, the primary process has done all the work */
+ if (rte_eal_process_type() != RTE_PROC_PRIMARY)
+ return 0;
+
+ return 0;
+}
+
+static int
+rtl_dev_uninit(struct rte_eth_dev *dev)
+{
+ if (rte_eal_process_type() != RTE_PROC_PRIMARY)
+ return -EPERM;
+
+ rtl_dev_close(dev);
+
+ return 0;
+}
+
+static int
+rtl_dev_reset(struct rte_eth_dev *dev)
+{
+ int ret;
+
+ ret = rtl_dev_uninit(dev);
+ if (ret)
+ return ret;
+
+ ret = rtl_dev_init(dev);
+
+ return ret;
+}
+
+static int
+rtl_pci_probe(struct rte_pci_driver *pci_drv __rte_unused,
+ struct rte_pci_device *pci_dev)
+{
+ return rte_eth_dev_pci_generic_probe(pci_dev, sizeof(struct rtl_adapter),
+ rtl_dev_init);
+}
+
+static int
+rtl_pci_remove(struct rte_pci_device *pci_dev)
+{
+ return rte_eth_dev_pci_generic_remove(pci_dev, rtl_dev_uninit);
+}
+
+static struct rte_pci_driver rte_r8169_pmd = {
+ .id_table = pci_id_r8169_map,
+ .drv_flags = RTE_PCI_DRV_NEED_MAPPING | RTE_PCI_DRV_INTR_LSC,
+ .probe = rtl_pci_probe,
+ .remove = rtl_pci_remove,
+};
+
+RTE_PMD_REGISTER_PCI(net_r8169, rte_r8169_pmd);
+RTE_PMD_REGISTER_PCI_TABLE(net_r8169, pci_id_r8169_map);
+RTE_PMD_REGISTER_KMOD_DEP(net_r8169, "* igb_uio | uio_pci_generic | vfio-pci");
diff --git a/drivers/net/r8169/r8169_ethdev.h b/drivers/net/r8169/r8169_ethdev.h
new file mode 100644
index 0000000000..93d8c48e99
--- /dev/null
+++ b/drivers/net/r8169/r8169_ethdev.h
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2024 Realtek Corporation. All rights reserved
+ */
+
+#ifndef _R8169_ETHDEV_H_
+#define _R8169_ETHDEV_H_
+
+#include <stdint.h>
+
+#include <rte_ethdev.h>
+#include <rte_ethdev_core.h>
+
+#include "r8169_compat.h"
+
+struct rtl_sw_stats {
+ u64 tx_packets;
+ u64 tx_bytes;
+ u64 tx_errors;
+ u64 rx_packets;
+ u64 rx_bytes;
+ u64 rx_errors;
+};
+
+struct rtl_adapter {
+ struct rtl_sw_stats sw_stats;
+};
+
+#endif
--
2.34.1
next prev parent reply other threads:[~2024-11-13 9:29 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-13 9:28 [PATCH v8 00/17] modify something as suggested Howard Wang
2024-11-13 9:28 ` Howard Wang [this message]
2024-11-13 9:28 ` [PATCH v8 02/17] net/r8169: add logging structure Howard Wang
2024-11-13 9:28 ` [PATCH v8 03/17] net/r8169: add hardware registers access routines Howard Wang
2024-11-13 9:28 ` [PATCH v8 04/17] net/r8169: implement core logic for Tx/Rx Howard Wang
2024-11-13 9:28 ` [PATCH v8 05/17] net/r8169: add support for HW config Howard Wang
2024-11-13 9:28 ` [PATCH v8 06/17] net/r8169: add PHY registers access routines Howard Wang
2024-11-13 9:28 ` [PATCH v8 07/17] net/r8169: add support for hardware operations Howard Wang
2024-11-13 9:28 ` [PATCH v8 08/17] net/r8169: add support for PHY configuration Howard Wang
2024-11-13 9:28 ` [PATCH v8 09/17] net/r8169: add support for HW initialization Howard Wang
2024-11-13 9:28 ` [PATCH v8 10/17] net/r8169: add link status and interrupt management Howard Wang
2024-11-13 9:28 ` [PATCH v8 11/17] net/r8169: implement Rx path Howard Wang
2024-11-13 9:28 ` [PATCH v8 12/17] net/r8169: implement Tx path Howard Wang
2024-11-13 9:28 ` [PATCH v8 13/17] net/r8169: implement device statistics Howard Wang
2024-11-13 9:28 ` [PATCH v8 14/17] net/r8169: implement promisc and allmulti modes Howard Wang
2024-11-13 9:28 ` [PATCH v8 15/17] net/r8169: implement MTU configuration Howard Wang
2024-11-13 9:28 ` [PATCH v8 16/17] net/r8169: add support for getting FW version Howard Wang
2024-11-13 9:28 ` [PATCH v8 17/17] net/r8169: add driver start and driver stop Howard Wang
2024-11-13 21:15 ` [PATCH v8 00/17] modify something as suggested Ferruh Yigit
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=20241113092854.91445-2-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).