[dpdk-dev] [PATCH] doc: announce PCI resources map API removal

[Jerin Jacob]

On Tue, Aug 4, 2020 at 2:18 PM David Marchand <david.marchand at redhat.com> wrote:
>
> 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 <david.marchand at redhat.com>

Acked-by: Jerin Jacob <jerinj at marvell.com>


> ---
>  doc/guides/rel_notes/deprecation.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ea4cfa7a48..24808c002c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -67,6 +67,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.
> +
>  * ethdev: Split the ``struct eth_dev_ops`` struct to hide it as much as possible
>    will be done in 20.11.
>    Currently the ``struct eth_dev_ops`` struct is accessible by the application
> --
> 2.23.0
>