From: Jie Liu <[email protected]> Add a new guide for SXE2 PMD in the nics directory. The guide contains driver capabilities, prerequisites, and compilation/usage instructions.
Update the release notes to announce the addition of the sxe2 network driver. Signed-off-by: Jie Liu <[email protected]> --- doc/guides/nics/features/sxe2.ini | 30 +++++++++++++++++++++++ doc/guides/nics/index.rst | 1 + doc/guides/nics/sxe2.rst | 34 ++++++++++++++++++++++++++ doc/guides/rel_notes/release_26_07.rst | 4 +++ 4 files changed, 69 insertions(+) create mode 100644 doc/guides/nics/features/sxe2.ini create mode 100644 doc/guides/nics/sxe2.rst diff --git a/doc/guides/nics/features/sxe2.ini b/doc/guides/nics/features/sxe2.ini new file mode 100644 index 0000000000..2718a702d4 --- /dev/null +++ b/doc/guides/nics/features/sxe2.ini @@ -0,0 +1,30 @@ +; +; Supported features of the 'sxe2' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +; A feature with "P" indicates only be supported when non-vector path +; is selected. +; +[Features] +Fast mbuf free = P +Free Tx mbuf on demand = Y +Burst mode info = Y +Queue start/stop = Y +MTU update = Y +Buffer split on Rx = P +Scattered Rx = Y +CRC offload = Y +VLAN offload = Y +QinQ offload = P +L3 checksum offload = Y +L4 checksum offload = Y +Timestamp offload = P +Inner L3 checksum = P +Inner L4 checksum = P +Rx descriptor status = Y +Tx descriptor status = Y +FreeBSD = Y +Linux = Y +x86-32 = Y +x86-64 = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index cb818284fe..e20be478f8 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -68,6 +68,7 @@ Network Interface Controller Drivers rnp sfc_efx softnic + sxe2 tap thunderx txgbe diff --git a/doc/guides/nics/sxe2.rst b/doc/guides/nics/sxe2.rst new file mode 100644 index 0000000000..7fcf9c085b --- /dev/null +++ b/doc/guides/nics/sxe2.rst @@ -0,0 +1,34 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright (C), 2025, Wuxi Stars Micro System Technologies Co., Ltd. + +SXE2 Poll Mode Driver +====================== + +The sxe2 PMD (**librte_net_sxe2**) provides poll mode driver support for +10/25/50/100 Gbps Network Adapters. +The embedded switch, Physical Functions (PF), +and SR-IOV Virtual Functions (VF) are supported. + +Implementation details +---------------------- + +The sxe2 PMD is designed to operate alongside the sxe2 kernel network driver. +For management and control operations, the PMD communicates with the kernel +driver via ioctl interfaces. These commands are processed by the kernel +driver and subsequently dispatched to the hardware firmware for execution. + +For security and robustness, the driver's data path is optimized to operate +using virtual addresses (IOVA as VA mode). However, to ensure full +compatibility in system environments where an IOMMU is absent or disabled, +the driver also provides an explicit path to support physical addressing +(IOVA as PA mode). + +The hardware is capable of handling the corresponding IOVA addresses (either +VA or PA) directly, as provided by the DPDK memory subsystem. This ensures +that DPDK applications can only access memory segments explicitly allocated +to the current process, preventing unauthorized access to random physical +memory. + +This capability allows the PMD to coexist with kernel network interfaces +which remain functional, although they stop receiving unicast packets as +long as they share the same MAC address. diff --git a/doc/guides/rel_notes/release_26_07.rst b/doc/guides/rel_notes/release_26_07.rst index f012d47a4b..fa0f0f5cca 100644 --- a/doc/guides/rel_notes/release_26_07.rst +++ b/doc/guides/rel_notes/release_26_07.rst @@ -64,6 +64,10 @@ New Features * ``--auto-probing`` enables the initial bus probing, which is the current default behavior. +* **Added Linkdata sxe2 ethernet driver.** + + Added network driver for the Linkdata Network Adapters. + Removed Items ------------- -- 2.47.3
