From: David Marchand Date: Tue, 4 Aug 2020 08:47:32 +0000 (+0200) Subject: doc: announce PCI resources map API removal X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=2c8d1021615eb41329a1d6f2259430d7ad5fd7c4;p=dpdk.git doc: announce PCI resources map API removal The PCI resources map API (pci_map_resource/pci_unmap_resource) was imposing use of Unix mmap flags while it does not make sense on Windows. This API was only used to internally setup PCI devices in the PCI bus driver and has no known external users. Announce its removal in 20.11 with its associated structures. The workaround implemented in the commit 9d2b24593724 ("pci: keep API compatibility with mmap values") will be removed at the same time. Signed-off-by: David Marchand Acked-by: Jerin Jacob Acked-by: Gaetan Rivet Acked-by: Thomas Monjalon --- diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 806938b5ac..52c9b9a25f 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -74,6 +74,17 @@ Deprecation Notices us extending existing enum/define. One solution can be using a fixed size array instead of ``.*MAX.*`` value. +* pci: The PCI resources map API (``pci_map_resource`` and + ``pci_unmap_resource``) was not abstracting the Unix mmap flags (see the + workaround for Windows support implemented in the commit + 9d2b24593724 ("pci: keep API compatibility with mmap values")). + This API will be removed from the public API in 20.11 and moved to the PCI + bus driver along with the PCI resources lists and associated structures + (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and + ``mapped_pci_res_list``). + With this removal, there won't be a need for the mentioned workaround which + will be reverted. + * pci: The ``rte_kernel_driver`` enum defined in rte_dev.h will be made private to the PCI subsystem as it is used only by the PCI bus driver and PCI drivers.