* [PATCH v4 4/4] net/macb: add necessary docs and update related files [not found] <1733814614-412254-1-git-send-email-liwencheng@phytium.com.cn> @ 2025-04-02 7:11 ` liwencheng 2025-04-07 6:40 ` [PATCH v5 " liwencheng 0 siblings, 1 reply; 10+ messages in thread From: liwencheng @ 2025-04-02 7:11 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. Signed-off-by: liwencheng <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_25_03.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 --git a/.mailmap b/.mailmap index d8439b7..001d7b2 100644 --- a/.mailmap +++ b/.mailmap @@ -1675,6 +1675,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 4b01103..379645d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -920,6 +920,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 10a2eca..8ae1950 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_25_03.rst b/doc/guides/rel_notes/release_25_03.rst index 652562a..f53ccc9 100644 --- a/doc/guides/rel_notes/release_25_03.rst +++ b/doc/guides/rel_notes/release_25_03.rst @@ -127,6 +127,11 @@ New Features See the :doc:`../compressdevs/zsda` guide for more details on the new driver. +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. + * **Added atomic tests to the eventdev test application.** Added two atomic tests: ``atomic_queue`` and ``atomic_atq``. -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v5 4/4] net/macb: add necessary docs and update related files 2025-04-02 7:11 ` [PATCH v4 4/4] net/macb: add necessary docs and update related files liwencheng @ 2025-04-07 6:40 ` liwencheng 2025-04-07 18:23 ` Stephen Hemminger 2025-04-08 6:22 ` [PATCH v6 3/3] " liwencheng 0 siblings, 2 replies; 10+ messages in thread From: liwencheng @ 2025-04-07 6:40 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. v5: * Add driver based on 25.07. Signed-off-by: liwencheng <liwencheng@phytium.com.cn> --- 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_25_07.rst | 4 ++++ 5 files changed, 64 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 4b01103..379645d 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -920,6 +920,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 10a2eca..8ae1950 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_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index cd1025a..9298dc1 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -55,6 +55,10 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items ------------- -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH v5 4/4] net/macb: add necessary docs and update related files 2025-04-07 6:40 ` [PATCH v5 " liwencheng @ 2025-04-07 18:23 ` Stephen Hemminger 2025-04-08 6:22 ` [PATCH v6 3/3] " liwencheng 1 sibling, 0 replies; 10+ messages in thread From: Stephen Hemminger @ 2025-04-07 18:23 UTC (permalink / raw) To: liwencheng; +Cc: dev On Mon, 7 Apr 2025 06:40:35 +0000 liwencheng <liwencheng@phytium.com.cn> wrote: > Added missing documentation in doc/guides/nics, > mailmap entry, and updated MAINTAINERS file. > > v5: > * Add driver based on 25.07. > > Signed-off-by: liwencheng <liwencheng@phytium.com.cn> There are multiple build failures reported in the CI system ^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v6 3/3] net/macb: add necessary docs and update related files 2025-04-07 6:40 ` [PATCH v5 " liwencheng 2025-04-07 18:23 ` Stephen Hemminger @ 2025-04-08 6:22 ` liwencheng 2025-04-18 3:27 ` [PATCH v7 " Wencheng Li 1 sibling, 1 reply; 10+ messages in thread From: liwencheng @ 2025-04-08 6:22 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. Signed-off-by: liwencheng <liwencheng@phytium.com.cn> --- 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_25_07.rst | 4 ++++ 5 files changed, 64 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 167cc74..8b725ce 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -916,6 +916,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 10a2eca..8ae1950 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_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index 093b85d..5530bfc 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -55,6 +55,10 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items ------------- -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v7 3/3] net/macb: add necessary docs and update related files 2025-04-08 6:22 ` [PATCH v6 3/3] " liwencheng @ 2025-04-18 3:27 ` Wencheng Li 2025-06-04 7:01 ` [PATCH v8 " Wencheng Li 0 siblings, 1 reply; 10+ messages in thread From: Wencheng Li @ 2025-04-18 3:27 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. v7: * Describe the devargs used by the driver in the documentation. * Update macb.ini. Signed-off-by: Wencheng Li <liwencheng@phytium.com.cn> --- MAINTAINERS | 6 ++ doc/guides/nics/features/macb.ini | 19 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/macb.rst | 180 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 4 + 5 files changed, 210 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 167cc74..8b725ce 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -916,6 +916,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..5e291e3 --- /dev/null +++ b/doc/guides/nics/features/macb.ini @@ -0,0 +1,19 @@ +; +; 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 +Link status event = Y +MTU update = Y +Promiscuous mode = Y +Allmulticast mode = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Scattered Rx = Y +Basic stats = Y +Linux = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 10a2eca..8ae1950 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..9dbdbec --- /dev/null +++ b/doc/guides/nics/macb.rst @@ -0,0 +1,180 @@ +.. 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 +- Set link down or up +- MTU update +- Multiple queues for TX and RX +- CRC offload +- Scatter and gather for Tx and Rx +- Jumbo frames supported +- Promiscuous mode +- Allmulticast mode +- Basic stats + + +Runtime Configuration +--------------------- + +The following ``devargs`` options can be enabled at runtime. They can +be passed as part of EAL arguments. For example, + +Run the command in non-vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 + +- ``device`` (mandatory, with no default value) + + The name of port (owned by Phytium) that should be enabled in DPDK. + This options can be repeated resulting in a list of ports to be + enabled. For instance below will enable ``eth0`` and ``eth1`` ports. + +- ``--vdev=net_macb0, device=3200c000.ethernet, usephydrv=0`` (no default value) + + --vdev specifies the MACB driver, and device specifies the virtual device to be used. The options + --vdev=net_macb0,device=3200c000.ethernet and --vdev=net_macb1,device=3200e000.ethernet + can also be written as: --vdev=net_macb,device=3200c000.ethernet,device=3200e000.ethernet. + +- ``usephydrv`` (Default value: true) + The specified macb device does not have an external phy chip. + If there is indeed a device with phy, this parameter is not added. + +- ``--rxq`` (Default value: 1) + Specify the number of dpdk-testpmd receiving queues. + +- ``--txq`` (Default value: 1) + Specify the number of dpdk-testpmd sending queues. + +- ``--rxd`` (Default value: 512) + Receive the queue descriptor. + +- ``--txd`` (Default value: 512) + Send the queue descriptor. + +Run the command in vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 --rxfreet=32 --txrst=32 + +- ``--rxfreet`` (Default value: 16) + Enable the optimization of sending vector instructions. + +- ``--txrst`` (Default value: 16) + Enable the optimization of receiving vector instructions. + + +Usage Example +------------- + +MACB PMD requires extra out of tree kernel modules to function properly. +`macb_uio` sources are part of the MACB. + +.. code-block:: console + + insmod macb_uio.ko + +In order to run testpmd example application following command can be used: + +.. code-block:: console + + ./app/dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet \ + --vdev=net_macb1,device=3200e000.ethernet --iova-mode=pa -- -i -a + +Example output: + +.. code-block:: console + + [...] + EAL: Detected CPU lcores: 4 + EAL: Detected NUMA nodes: 1 + EAL: Detected static linkage of DPDK + EAL: Multi-process socket /var/run/dpdk/rte/mp_socket + EAL: Selected IOVA mode 'PA' + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + Interactive-mode selected + Auto-start selected + testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0 + testpmd: preferred mempool ops selected: ring_mp_mc + Configuring Port 0 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[0] + MACB: Port[0] doesn't meet Vector Rx preconditions + Port 0: 24:DC:0F:54:E5:D0 + Configuring Port 1 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[1] + MACB: Port[1] doesn't meet Vector Rx preconditions + Port 1: 24:DC:0F:54:E5:D1 + Checking link statuses... + MACB: Port 0: Link up at 10 Gbps FDX Autoneg + + Port 0: link state change event + MACB: Port 1: Link up at 10 Gbps FDX Autoneg + + Port 1: link state change event + Done + Start automatic packet forwarding + io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support enabled, MP allocation mode: native + Logical Core 3 (socket 0) forwards packets on 2 streams: + RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 + RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 + + io packet forwarding packets/burst=32 + nb forwarding cores=1 - nb forwarding ports=2 + port 0: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + port 1: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + testpmd> + + +Limitations +----------- + +The driver is only available on the ARM64 architecture. diff --git a/doc/guides/rel_notes/release_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index 093b85d..5530bfc 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -55,6 +55,10 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items ------------- -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v8 3/3] net/macb: add necessary docs and update related files 2025-04-18 3:27 ` [PATCH v7 " Wencheng Li @ 2025-06-04 7:01 ` Wencheng Li 2025-06-06 9:07 ` [PATCH v9 " Wencheng Li 0 siblings, 1 reply; 10+ messages in thread From: Wencheng Li @ 2025-06-04 7:01 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. v8: * Update document macb.rst. * Add usage instructions for the macb_uio module. * Update the explanation of testpmd parameters. Signed-off-by: Wencheng Li <liwencheng@phytium.com.cn> --- MAINTAINERS | 6 ++ doc/guides/nics/features/macb.ini | 19 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/macb.rst | 181 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 4 + 5 files changed, 211 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 57d378e..35dec12 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -916,6 +916,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..5e291e3 --- /dev/null +++ b/doc/guides/nics/features/macb.ini @@ -0,0 +1,19 @@ +; +; 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 +Link status event = Y +MTU update = Y +Promiscuous mode = Y +Allmulticast mode = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Scattered Rx = Y +Basic stats = Y +Linux = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 618c52d..837f948 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..6eca2af --- /dev/null +++ b/doc/guides/nics/macb.rst @@ -0,0 +1,181 @@ +.. 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 +- Set link down or up +- MTU update +- Multiple queues for TX and RX +- CRC offload +- Scatter and gather for Tx and Rx +- Jumbo frames supported +- Promiscuous mode +- Allmulticast mode +- Basic stats + + +Runtime Configuration +--------------------- + +The following ``devargs`` options can be enabled at runtime. They can +be passed as part of EAL arguments. For example, + +Run the command in non-vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 + +- ``device`` (mandatory, with no default value) + + The name of port (owned by Phytium) that should be enabled in DPDK. + This options can be repeated resulting in a list of ports to be + enabled. For instance below will enable ``eth0`` and ``eth1`` ports. + Use the network interface 3200c000.ethernet as eth0, + and the network interface 3200e000.ethernet as eth1. + +- ``--vdev=net_macb0, device=3200c000.ethernet, usephydrv=0`` (no default value) + + --vdev specifies the MACB driver, and device specifies the virtual device to be used. The options + --vdev=net_macb0,device=3200c000.ethernet and --vdev=net_macb1,device=3200e000.ethernet + can also be written as: --vdev=net_macb,device=3200c000.ethernet,device=3200e000.ethernet. + +- ``usephydrv`` (Default value: true) + The specified macb device does not have an external phy chip. + If there is indeed a device with phy, this parameter is not added. + +Run the command in vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 --rxfreet=32 --txrst=32 + +- ``--rxfreet`` (Default value: 16) + Enable the optimization of sending vector instructions. + +- ``--txrst`` (Default value: 16) + Enable the optimization of receiving vector instructions. + + +Usage Example +------------- + +MACB PMD requires extra out of tree kernel modules to function properly. The macb_uio +module can be found in the repository `<https://github.com/dpdk-kmods/macb_uio>`. +It can be loaded as shown below: + +.. code-block:: console + + git clone https://github.com/dpdk-kmods/macb_uio.git + cd macb_uio && make + modprobe uio + insmod macb_uio.ko + +Bind the network interface to the macb_uio driver: + +.. code-block:: console + + ./dpdk-pdevbind.sh --bind macb_uio 3200c000.ethernet + ./dpdk-pdevbind.sh --bind macb_uio 3200e000.ethernet + +In order to run testpmd example application following command can be used: + +.. code-block:: console + + ./app/dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet \ + --vdev=net_macb1,device=3200e000.ethernet --iova-mode=pa -- -i -a + +Example output: + +.. code-block:: console + + [...] + EAL: Detected CPU lcores: 4 + EAL: Detected NUMA nodes: 1 + EAL: Detected static linkage of DPDK + EAL: Multi-process socket /var/run/dpdk/rte/mp_socket + EAL: Selected IOVA mode 'PA' + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + Interactive-mode selected + Auto-start selected + testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0 + testpmd: preferred mempool ops selected: ring_mp_mc + Configuring Port 0 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[0] + MACB: Port[0] doesn't meet Vector Rx preconditions + Port 0: 24:DC:0F:54:E5:D0 + Configuring Port 1 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[1] + MACB: Port[1] doesn't meet Vector Rx preconditions + Port 1: 24:DC:0F:54:E5:D1 + Checking link statuses... + MACB: Port 0: Link up at 10 Gbps FDX Autoneg + + Port 0: link state change event + MACB: Port 1: Link up at 10 Gbps FDX Autoneg + + Port 1: link state change event + Done + Start automatic packet forwarding + io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support enabled, MP allocation mode: native + Logical Core 3 (socket 0) forwards packets on 2 streams: + RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 + RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 + + io packet forwarding packets/burst=32 + nb forwarding cores=1 - nb forwarding ports=2 + port 0: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + port 1: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + testpmd> + + +Limitations +----------- + +The driver is only available on the ARM64 architecture. diff --git a/doc/guides/rel_notes/release_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index 11bb6d3..0d7d88a 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -83,6 +83,10 @@ New Features See the :doc:`../cryptodevs/zsda` guide for more details on the new driver. +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items ------------- -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v9 3/3] net/macb: add necessary docs and update related files 2025-06-04 7:01 ` [PATCH v8 " Wencheng Li @ 2025-06-06 9:07 ` Wencheng Li 2025-08-20 4:35 ` [PATCH v10 " Wencheng Li 0 siblings, 1 reply; 10+ messages in thread From: Wencheng Li @ 2025-06-06 9:07 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. Signed-off-by: Wencheng Li <liwencheng@phytium.com.cn> --- MAINTAINERS | 6 ++ doc/guides/nics/features/macb.ini | 19 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/macb.rst | 181 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 4 + 5 files changed, 211 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 57d378e..35dec12 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -916,6 +916,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..5e291e3 --- /dev/null +++ b/doc/guides/nics/features/macb.ini @@ -0,0 +1,19 @@ +; +; 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 +Link status event = Y +MTU update = Y +Promiscuous mode = Y +Allmulticast mode = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Scattered Rx = Y +Basic stats = Y +Linux = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 618c52d..837f948 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..6eca2af --- /dev/null +++ b/doc/guides/nics/macb.rst @@ -0,0 +1,181 @@ +.. 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 +- Set link down or up +- MTU update +- Multiple queues for TX and RX +- CRC offload +- Scatter and gather for Tx and Rx +- Jumbo frames supported +- Promiscuous mode +- Allmulticast mode +- Basic stats + + +Runtime Configuration +--------------------- + +The following ``devargs`` options can be enabled at runtime. They can +be passed as part of EAL arguments. For example, + +Run the command in non-vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 + +- ``device`` (mandatory, with no default value) + + The name of port (owned by Phytium) that should be enabled in DPDK. + This options can be repeated resulting in a list of ports to be + enabled. For instance below will enable ``eth0`` and ``eth1`` ports. + Use the network interface 3200c000.ethernet as eth0, + and the network interface 3200e000.ethernet as eth1. + +- ``--vdev=net_macb0, device=3200c000.ethernet, usephydrv=0`` (no default value) + + --vdev specifies the MACB driver, and device specifies the virtual device to be used. The options + --vdev=net_macb0,device=3200c000.ethernet and --vdev=net_macb1,device=3200e000.ethernet + can also be written as: --vdev=net_macb,device=3200c000.ethernet,device=3200e000.ethernet. + +- ``usephydrv`` (Default value: true) + The specified macb device does not have an external phy chip. + If there is indeed a device with phy, this parameter is not added. + +Run the command in vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 --rxfreet=32 --txrst=32 + +- ``--rxfreet`` (Default value: 16) + Enable the optimization of sending vector instructions. + +- ``--txrst`` (Default value: 16) + Enable the optimization of receiving vector instructions. + + +Usage Example +------------- + +MACB PMD requires extra out of tree kernel modules to function properly. The macb_uio +module can be found in the repository `<https://github.com/dpdk-kmods/macb_uio>`. +It can be loaded as shown below: + +.. code-block:: console + + git clone https://github.com/dpdk-kmods/macb_uio.git + cd macb_uio && make + modprobe uio + insmod macb_uio.ko + +Bind the network interface to the macb_uio driver: + +.. code-block:: console + + ./dpdk-pdevbind.sh --bind macb_uio 3200c000.ethernet + ./dpdk-pdevbind.sh --bind macb_uio 3200e000.ethernet + +In order to run testpmd example application following command can be used: + +.. code-block:: console + + ./app/dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet \ + --vdev=net_macb1,device=3200e000.ethernet --iova-mode=pa -- -i -a + +Example output: + +.. code-block:: console + + [...] + EAL: Detected CPU lcores: 4 + EAL: Detected NUMA nodes: 1 + EAL: Detected static linkage of DPDK + EAL: Multi-process socket /var/run/dpdk/rte/mp_socket + EAL: Selected IOVA mode 'PA' + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + Interactive-mode selected + Auto-start selected + testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0 + testpmd: preferred mempool ops selected: ring_mp_mc + Configuring Port 0 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[0] + MACB: Port[0] doesn't meet Vector Rx preconditions + Port 0: 24:DC:0F:54:E5:D0 + Configuring Port 1 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[1] + MACB: Port[1] doesn't meet Vector Rx preconditions + Port 1: 24:DC:0F:54:E5:D1 + Checking link statuses... + MACB: Port 0: Link up at 10 Gbps FDX Autoneg + + Port 0: link state change event + MACB: Port 1: Link up at 10 Gbps FDX Autoneg + + Port 1: link state change event + Done + Start automatic packet forwarding + io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support enabled, MP allocation mode: native + Logical Core 3 (socket 0) forwards packets on 2 streams: + RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 + RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 + + io packet forwarding packets/burst=32 + nb forwarding cores=1 - nb forwarding ports=2 + port 0: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + port 1: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + testpmd> + + +Limitations +----------- + +The driver is only available on the ARM64 architecture. diff --git a/doc/guides/rel_notes/release_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index a4962e4..346e7fd 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -87,6 +87,10 @@ New Features See the :doc:`../cryptodevs/zsda` guide for more details on the new driver. +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items ------------- -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v10 3/3] net/macb: add necessary docs and update related files 2025-06-06 9:07 ` [PATCH v9 " Wencheng Li @ 2025-08-20 4:35 ` Wencheng Li 2025-08-20 15:12 ` Stephen Hemminger 2025-10-28 8:33 ` [PATCH v11 " Wencheng Li 0 siblings, 2 replies; 10+ messages in thread From: Wencheng Li @ 2025-08-20 4:35 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. Signed-off-by: Wencheng Li <liwencheng@phytium.com.cn> --- MAINTAINERS | 6 ++ doc/guides/nics/features/macb.ini | 19 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/macb.rst | 181 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_25_11.rst | 32 +----- 5 files changed, 210 insertions(+), 29 deletions(-) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 7aca98c..bd0453f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -920,6 +920,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..5e291e3 --- /dev/null +++ b/doc/guides/nics/features/macb.ini @@ -0,0 +1,19 @@ +; +; 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 +Link status event = Y +MTU update = Y +Promiscuous mode = Y +Allmulticast mode = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Scattered Rx = Y +Basic stats = Y +Linux = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 57d161c..9984a9f 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..6eca2af --- /dev/null +++ b/doc/guides/nics/macb.rst @@ -0,0 +1,181 @@ +.. 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 +- Set link down or up +- MTU update +- Multiple queues for TX and RX +- CRC offload +- Scatter and gather for Tx and Rx +- Jumbo frames supported +- Promiscuous mode +- Allmulticast mode +- Basic stats + + +Runtime Configuration +--------------------- + +The following ``devargs`` options can be enabled at runtime. They can +be passed as part of EAL arguments. For example, + +Run the command in non-vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 + +- ``device`` (mandatory, with no default value) + + The name of port (owned by Phytium) that should be enabled in DPDK. + This options can be repeated resulting in a list of ports to be + enabled. For instance below will enable ``eth0`` and ``eth1`` ports. + Use the network interface 3200c000.ethernet as eth0, + and the network interface 3200e000.ethernet as eth1. + +- ``--vdev=net_macb0, device=3200c000.ethernet, usephydrv=0`` (no default value) + + --vdev specifies the MACB driver, and device specifies the virtual device to be used. The options + --vdev=net_macb0,device=3200c000.ethernet and --vdev=net_macb1,device=3200e000.ethernet + can also be written as: --vdev=net_macb,device=3200c000.ethernet,device=3200e000.ethernet. + +- ``usephydrv`` (Default value: true) + The specified macb device does not have an external phy chip. + If there is indeed a device with phy, this parameter is not added. + +Run the command in vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 --rxfreet=32 --txrst=32 + +- ``--rxfreet`` (Default value: 16) + Enable the optimization of sending vector instructions. + +- ``--txrst`` (Default value: 16) + Enable the optimization of receiving vector instructions. + + +Usage Example +------------- + +MACB PMD requires extra out of tree kernel modules to function properly. The macb_uio +module can be found in the repository `<https://github.com/dpdk-kmods/macb_uio>`. +It can be loaded as shown below: + +.. code-block:: console + + git clone https://github.com/dpdk-kmods/macb_uio.git + cd macb_uio && make + modprobe uio + insmod macb_uio.ko + +Bind the network interface to the macb_uio driver: + +.. code-block:: console + + ./dpdk-pdevbind.sh --bind macb_uio 3200c000.ethernet + ./dpdk-pdevbind.sh --bind macb_uio 3200e000.ethernet + +In order to run testpmd example application following command can be used: + +.. code-block:: console + + ./app/dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet \ + --vdev=net_macb1,device=3200e000.ethernet --iova-mode=pa -- -i -a + +Example output: + +.. code-block:: console + + [...] + EAL: Detected CPU lcores: 4 + EAL: Detected NUMA nodes: 1 + EAL: Detected static linkage of DPDK + EAL: Multi-process socket /var/run/dpdk/rte/mp_socket + EAL: Selected IOVA mode 'PA' + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + Interactive-mode selected + Auto-start selected + testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0 + testpmd: preferred mempool ops selected: ring_mp_mc + Configuring Port 0 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[0] + MACB: Port[0] doesn't meet Vector Rx preconditions + Port 0: 24:DC:0F:54:E5:D0 + Configuring Port 1 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[1] + MACB: Port[1] doesn't meet Vector Rx preconditions + Port 1: 24:DC:0F:54:E5:D1 + Checking link statuses... + MACB: Port 0: Link up at 10 Gbps FDX Autoneg + + Port 0: link state change event + MACB: Port 1: Link up at 10 Gbps FDX Autoneg + + Port 1: link state change event + Done + Start automatic packet forwarding + io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support enabled, MP allocation mode: native + Logical Core 3 (socket 0) forwards packets on 2 streams: + RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 + RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 + + io packet forwarding packets/burst=32 + nb forwarding cores=1 - nb forwarding ports=2 + port 0: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + port 1: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + testpmd> + + +Limitations +----------- + +The driver is only available on the ARM64 architecture. diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst index ccad6d8..8a66081 100644 --- a/doc/guides/rel_notes/release_25_11.rst +++ b/doc/guides/rel_notes/release_25_11.rst @@ -24,36 +24,10 @@ DPDK Release 25.11 New Features ------------ -.. This section should contain new features added in this release. - Sample format: +* **Added Phytium macb net driver.** - * **Add a title in the past tense with a full stop.** - - Add a short 1-2 sentence description in the past tense. - The description should be enough to allow someone scanning - the release notes to understand the new feature. - - If the feature adds a lot of sub-features you can use a bullet list - like this: - - * Added feature foo to do something. - * Enhanced feature bar to do something else. - - Refer to the previous release notes for examples. - - Suggested order in release notes items: - * Core libs (EAL, mempool, ring, mbuf, buses) - * Device abstraction libs and PMDs (ordered alphabetically by vendor name) - - ethdev (lib, PMDs) - - cryptodev (lib, PMDs) - - eventdev (lib, PMDs) - - etc - * Other libs - * Apps, Examples, Tools (if significant) - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ======================================================= + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. Removed Items -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH v10 3/3] net/macb: add necessary docs and update related files 2025-08-20 4:35 ` [PATCH v10 " Wencheng Li @ 2025-08-20 15:12 ` Stephen Hemminger 2025-10-28 8:33 ` [PATCH v11 " Wencheng Li 1 sibling, 0 replies; 10+ messages in thread From: Stephen Hemminger @ 2025-08-20 15:12 UTC (permalink / raw) To: Wencheng Li; +Cc: dev On Wed, 20 Aug 2025 04:35:00 +0000 Wencheng Li <liwencheng@phytium.com.cn> wrote: > diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst > index ccad6d8..8a66081 100644 > --- a/doc/guides/rel_notes/release_25_11.rst > +++ b/doc/guides/rel_notes/release_25_11.rst > @@ -24,36 +24,10 @@ DPDK Release 25.11 > New Features > ------------ > > -.. This section should contain new features added in this release. > - Sample format: > +* **Added Phytium macb net driver.** > > - * **Add a title in the past tense with a full stop.** > - > - Add a short 1-2 sentence description in the past tense. > - The description should be enough to allow someone scanning > - the release notes to understand the new feature. > - > - If the feature adds a lot of sub-features you can use a bullet list > - like this: > - > - * Added feature foo to do something. > - * Enhanced feature bar to do something else. > - > - Refer to the previous release notes for examples. > - > - Suggested order in release notes items: > - * Core libs (EAL, mempool, ring, mbuf, buses) > - * Device abstraction libs and PMDs (ordered alphabetically by vendor name) > - - ethdev (lib, PMDs) > - - cryptodev (lib, PMDs) > - - eventdev (lib, PMDs) > - - etc > - * Other libs > - * Apps, Examples, Tools (if significant) > - > - This section is a comment. Do not overwrite or remove it. > - Also, make sure to start the actual text at the margin. > - ======================================================= > + Added a new network PMD which supports Phytium 1 and 10 Gigabit > + Ethernet NICs. > Please leave the template text there, it is only removed just before release. Just add your entry after the template. ^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v11 3/3] net/macb: add necessary docs and update related files 2025-08-20 4:35 ` [PATCH v10 " Wencheng Li 2025-08-20 15:12 ` Stephen Hemminger @ 2025-10-28 8:33 ` Wencheng Li 1 sibling, 0 replies; 10+ messages in thread From: Wencheng Li @ 2025-10-28 8:33 UTC (permalink / raw) To: dev Added missing documentation in doc/guides/nics, mailmap entry, and updated MAINTAINERS file. Signed-off-by: Wencheng Li <liwencheng@phytium.com.cn> --- MAINTAINERS | 6 ++ doc/guides/nics/features/macb.ini | 19 ++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/macb.rst | 181 +++++++++++++++++++++++++++++++++ doc/guides/rel_notes/release_25_11.rst | 5 + 5 files changed, 212 insertions(+) create mode 100644 doc/guides/nics/features/macb.ini create mode 100644 doc/guides/nics/macb.rst diff --git a/MAINTAINERS b/MAINTAINERS index 5f198bf..df4c2d2 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -930,6 +930,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..5e291e3 --- /dev/null +++ b/doc/guides/nics/features/macb.ini @@ -0,0 +1,19 @@ +; +; 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 +Link status event = Y +MTU update = Y +Promiscuous mode = Y +Allmulticast mode = Y +CRC offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Scattered Rx = Y +Basic stats = Y +Linux = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index b00ed99..d6ce39b 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -45,6 +45,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..6eca2af --- /dev/null +++ b/doc/guides/nics/macb.rst @@ -0,0 +1,181 @@ +.. 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 +- Set link down or up +- MTU update +- Multiple queues for TX and RX +- CRC offload +- Scatter and gather for Tx and Rx +- Jumbo frames supported +- Promiscuous mode +- Allmulticast mode +- Basic stats + + +Runtime Configuration +--------------------- + +The following ``devargs`` options can be enabled at runtime. They can +be passed as part of EAL arguments. For example, + +Run the command in non-vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 + +- ``device`` (mandatory, with no default value) + + The name of port (owned by Phytium) that should be enabled in DPDK. + This options can be repeated resulting in a list of ports to be + enabled. For instance below will enable ``eth0`` and ``eth1`` ports. + Use the network interface 3200c000.ethernet as eth0, + and the network interface 3200e000.ethernet as eth1. + +- ``--vdev=net_macb0, device=3200c000.ethernet, usephydrv=0`` (no default value) + + --vdev specifies the MACB driver, and device specifies the virtual device to be used. The options + --vdev=net_macb0,device=3200c000.ethernet and --vdev=net_macb1,device=3200e000.ethernet + can also be written as: --vdev=net_macb,device=3200c000.ethernet,device=3200e000.ethernet. + +- ``usephydrv`` (Default value: true) + The specified macb device does not have an external phy chip. + If there is indeed a device with phy, this parameter is not added. + +Run the command in vector mode: + +.. code-block:: console + + ./dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet,usephydrv=0 \ + --vdev=net_macb1,device=3200e000.ethernet,usephydrv=0 --iova-mode=pa -- -i \ + -a --rxq=1 --txq=1 --rxd=128 --txd=128 --rxfreet=32 --txrst=32 + +- ``--rxfreet`` (Default value: 16) + Enable the optimization of sending vector instructions. + +- ``--txrst`` (Default value: 16) + Enable the optimization of receiving vector instructions. + + +Usage Example +------------- + +MACB PMD requires extra out of tree kernel modules to function properly. The macb_uio +module can be found in the repository `<https://github.com/dpdk-kmods/macb_uio>`. +It can be loaded as shown below: + +.. code-block:: console + + git clone https://github.com/dpdk-kmods/macb_uio.git + cd macb_uio && make + modprobe uio + insmod macb_uio.ko + +Bind the network interface to the macb_uio driver: + +.. code-block:: console + + ./dpdk-pdevbind.sh --bind macb_uio 3200c000.ethernet + ./dpdk-pdevbind.sh --bind macb_uio 3200e000.ethernet + +In order to run testpmd example application following command can be used: + +.. code-block:: console + + ./app/dpdk-testpmd -l 0,3 --vdev=net_macb0,device=3200c000.ethernet \ + --vdev=net_macb1,device=3200e000.ethernet --iova-mode=pa -- -i -a + +Example output: + +.. code-block:: console + + [...] + EAL: Detected CPU lcores: 4 + EAL: Detected NUMA nodes: 1 + EAL: Detected static linkage of DPDK + EAL: Multi-process socket /var/run/dpdk/rte/mp_socket + EAL: Selected IOVA mode 'PA' + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + MACB: Phytium mac driver v5.8 + MACB: macb_get_fixed_link_speed_info(): speed info is unknown. + Interactive-mode selected + Auto-start selected + testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0 + testpmd: preferred mempool ops selected: ring_mp_mc + Configuring Port 0 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[0] + MACB: Port[0] doesn't meet Vector Rx preconditions + Port 0: 24:DC:0F:54:E5:D0 + Configuring Port 1 (socket 0) + MACB: Rx Burst Bulk Alloc Preconditions: rxq->rx_free_thresh=16, MACB_MAX_RX_BURST=32 + MACB: queue[0] doesn't meet Rx Bulk Alloc preconditions - canceling the feature for port[1] + MACB: Port[1] doesn't meet Vector Rx preconditions + Port 1: 24:DC:0F:54:E5:D1 + Checking link statuses... + MACB: Port 0: Link up at 10 Gbps FDX Autoneg + + Port 0: link state change event + MACB: Port 1: Link up at 10 Gbps FDX Autoneg + + Port 1: link state change event + Done + Start automatic packet forwarding + io packet forwarding - ports=2 - cores=1 - streams=2 - NUMA support enabled, MP allocation mode: native + Logical Core 3 (socket 0) forwards packets on 2 streams: + RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01 + RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00 + + io packet forwarding packets/burst=32 + nb forwarding cores=1 - nb forwarding ports=2 + port 0: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + port 1: RX queue number: 1 Tx queue number: 1 + Rx offloads=0xe Tx offloads=0x0 + RX queue: 0 + RX desc=512 - RX free threshold=16 + RX threshold registers: pthresh=0 hthresh=0 wthresh=0 + RX Offloads=0xe + TX queue: 0 + TX desc=512 - TX free threshold=32 + TX threshold registers: pthresh=0 hthresh=0 wthresh=0 + TX offloads=0x0 - TX RS bit threshold=0 + testpmd> + + +Limitations +----------- + +The driver is only available on the ARM64 architecture. diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst index c5ba335..5278932 100644 --- a/doc/guides/rel_notes/release_25_11.rst +++ b/doc/guides/rel_notes/release_25_11.rst @@ -55,6 +55,11 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added Phytium macb net driver.** + + Added a new network PMD which supports Phytium 1 and 10 Gigabit + Ethernet NICs. + * **Added automatic lcore-id remapping option.** Added the EAL option ``--remap-lcore-ids`` or ``-R`` -- 2.7.4 ^ permalink raw reply related [flat|nested] 10+ messages in thread
end of thread, other threads:[~2025-10-28 8:33 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <1733814614-412254-1-git-send-email-liwencheng@phytium.com.cn>
2025-04-02 7:11 ` [PATCH v4 4/4] net/macb: add necessary docs and update related files liwencheng
2025-04-07 6:40 ` [PATCH v5 " liwencheng
2025-04-07 18:23 ` Stephen Hemminger
2025-04-08 6:22 ` [PATCH v6 3/3] " liwencheng
2025-04-18 3:27 ` [PATCH v7 " Wencheng Li
2025-06-04 7:01 ` [PATCH v8 " Wencheng Li
2025-06-06 9:07 ` [PATCH v9 " Wencheng Li
2025-08-20 4:35 ` [PATCH v10 " Wencheng Li
2025-08-20 15:12 ` Stephen Hemminger
2025-10-28 8:33 ` [PATCH v11 " Wencheng Li
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox