The original hisilicon DMA driver correspond to the internal DMA unit of Kunpeng SoC PCIe subsystem. This commit renames it to hisi_pciep (PCIe internal endpoint) to reflect hardware IP.
Signed-off-by: Chengwen Feng <[email protected]> --- MAINTAINERS | 6 +++--- .../dmadevs/{hisilicon.rst => hisi_pciep.rst} | 14 +++++++------- doc/guides/dmadevs/index.rst | 2 +- doc/guides/rel_notes/release_25_11.rst | 4 ++++ .../hisi_pciep_dmadev.c} | 8 ++++---- .../hisi_pciep_dmadev.h} | 0 drivers/dma/{hisilicon => hisi_pciep}/meson.build | 2 +- drivers/dma/meson.build | 2 +- 8 files changed, 21 insertions(+), 17 deletions(-) rename doc/guides/dmadevs/{hisilicon.rst => hisi_pciep.rst} (72%) rename drivers/dma/{hisilicon/hisi_dmadev.c => hisi_pciep/hisi_pciep_dmadev.c} (99%) rename drivers/dma/{hisilicon/hisi_dmadev.h => hisi_pciep/hisi_pciep_dmadev.h} (100%) rename drivers/dma/{hisilicon => hisi_pciep}/meson.build (93%) diff --git a/MAINTAINERS b/MAINTAINERS index 1a2729be66..92be9a5d1b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1361,10 +1361,10 @@ M: Conor Walsh <[email protected]> F: drivers/dma/ioat/ F: doc/guides/dmadevs/ioat.rst -HiSilicon DMA +HiSilicon PCIEP DMA M: Chengwen Feng <[email protected]> -F: drivers/dma/hisilicon/ -F: doc/guides/dmadevs/hisilicon.rst +F: drivers/dma/hisi_pciep/ +F: doc/guides/dmadevs/hisi_pciep.rst Marvell CNXK DPI DMA M: Vamsi Attunuru <[email protected]> diff --git a/doc/guides/dmadevs/hisilicon.rst b/doc/guides/dmadevs/hisi_pciep.rst similarity index 72% rename from doc/guides/dmadevs/hisilicon.rst rename to doc/guides/dmadevs/hisi_pciep.rst index 974bc49376..9e9166648e 100644 --- a/doc/guides/dmadevs/hisilicon.rst +++ b/doc/guides/dmadevs/hisi_pciep.rst @@ -1,11 +1,11 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2021 HiSilicon Limited. -HISILICON Kunpeng DMA Driver -============================ +HISILICON PCIEP DMA Driver +========================== -Kunpeng SoC has an internal DMA unit which can be used by application -to accelerate data copies. +Kunpeng SoC PCIE subsystem has an internal DMA unit which can be used by +application to accelerate data copies. The DMA PF function supports multiple DMA channels. @@ -18,8 +18,8 @@ Supported Kunpeng SoCs Device Setup ------------- -Kunpeng DMA devices will need to be bound to a suitable DPDK-supported -user-space IO driver such as ``vfio-pci`` in order to be used by DPDK. +This device needs to be bound to a suitable DPDK-supported user-space IO +driver such as ``vfio-pci`` in order to be used by DPDK. Device Probing and Initialization ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -35,7 +35,7 @@ and the 2nd ``dmadev`` name is "0000:7b:00.0-ch1". Device Configuration ~~~~~~~~~~~~~~~~~~~~~ -Kunpeng DMA configuration requirements: +Configuration requirements: * ``ring_size`` must be a power of two, between 32 and 8192. * Only one ``vchan`` is supported per ``dmadev``. diff --git a/doc/guides/dmadevs/index.rst b/doc/guides/dmadevs/index.rst index 15ddaf5192..2ddcced09c 100644 --- a/doc/guides/dmadevs/index.rst +++ b/doc/guides/dmadevs/index.rst @@ -14,7 +14,7 @@ an application through DMA API. cnxk dpaa dpaa2 - hisilicon + hisi_pciep idxd ioat odm diff --git a/doc/guides/rel_notes/release_25_11.rst b/doc/guides/rel_notes/release_25_11.rst index 3c32b26e3b..eb5c048d5b 100644 --- a/doc/guides/rel_notes/release_25_11.rst +++ b/doc/guides/rel_notes/release_25_11.rst @@ -87,6 +87,10 @@ New Features * Added multi-process per port. * Optimized code. +* **Rename hisilicon DMA driver to hisi_pciep DMA driver.** + + * Rename to hisi_pciep (PCIe internal endpoint) to reflect hardware IP. + * **Allow overriding the automatic usage/help generation in argparse library.** The argparse library now supports overriding the automatic help text generation, diff --git a/drivers/dma/hisilicon/hisi_dmadev.c b/drivers/dma/hisi_pciep/hisi_pciep_dmadev.c similarity index 99% rename from drivers/dma/hisilicon/hisi_dmadev.c rename to drivers/dma/hisi_pciep/hisi_pciep_dmadev.c index 7575fb12d9..13c14833be 100644 --- a/drivers/dma/hisilicon/hisi_dmadev.c +++ b/drivers/dma/hisi_pciep/hisi_pciep_dmadev.c @@ -15,7 +15,7 @@ #include <rte_pci.h> #include <rte_dmadev_pmd.h> -#include "hisi_dmadev.h" +#include "hisi_pciep_dmadev.h" RTE_LOG_REGISTER_DEFAULT(hisi_dma_logtype, INFO); #define RTE_LOGTYPE_HISI_DMA hisi_dma_logtype @@ -992,6 +992,6 @@ static struct rte_pci_driver hisi_dma_pmd_drv = { .remove = hisi_dma_remove, }; -RTE_PMD_REGISTER_PCI(dma_hisilicon, hisi_dma_pmd_drv); -RTE_PMD_REGISTER_PCI_TABLE(dma_hisilicon, pci_id_hisi_dma_map); -RTE_PMD_REGISTER_KMOD_DEP(dma_hisilicon, "vfio-pci"); +RTE_PMD_REGISTER_PCI(dma_hisi_pciep, hisi_dma_pmd_drv); +RTE_PMD_REGISTER_PCI_TABLE(dma_hisi_pciep, pci_id_hisi_dma_map); +RTE_PMD_REGISTER_KMOD_DEP(dma_hisi_pciep, "vfio-pci"); diff --git a/drivers/dma/hisilicon/hisi_dmadev.h b/drivers/dma/hisi_pciep/hisi_pciep_dmadev.h similarity index 100% rename from drivers/dma/hisilicon/hisi_dmadev.h rename to drivers/dma/hisi_pciep/hisi_pciep_dmadev.h diff --git a/drivers/dma/hisilicon/meson.build b/drivers/dma/hisi_pciep/meson.build similarity index 93% rename from drivers/dma/hisilicon/meson.build rename to drivers/dma/hisi_pciep/meson.build index 1098539e20..35944464c6 100644 --- a/drivers/dma/hisilicon/meson.build +++ b/drivers/dma/hisi_pciep/meson.build @@ -15,7 +15,7 @@ endif deps += ['bus_pci', 'dmadev'] sources = files( - 'hisi_dmadev.c', + 'hisi_pciep_dmadev.c', ) require_iova_in_mbuf = false diff --git a/drivers/dma/meson.build b/drivers/dma/meson.build index 358132759a..4f82a306bf 100644 --- a/drivers/dma/meson.build +++ b/drivers/dma/meson.build @@ -5,7 +5,7 @@ drivers = [ 'cnxk', 'dpaa', 'dpaa2', - 'hisilicon', + 'hisi_pciep', 'idxd', 'ioat', 'odm', -- 2.17.1
