doc: announce marking device and driver objects as internal

rte_driver and rte_device are unnecessarily exposed in the public API/ABI.
Announce that they will be made opaque in the public API and mark
associated API as internal.
This impacts all bus, as their driver registration mechanism will be
made internal.

Note: the PCI bus had a similar deprecation notice that we can remove as
the new one is more generic.

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Chenbo Xia <chenbo.xia@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Jerin Jacob <jerinj@marvell.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Kevin Laatz <kevin.laatz@intel.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
This commit is contained in:
David Marchand 2022-07-10 08:17:36 +02:00 committed by Thomas Monjalon
parent c02e52019f
commit cf905d31df

View File

@ -49,10 +49,12 @@ Deprecation Notices
external users may still register their bus using a new driver header
(see ``enable_driver_sdk`` meson option).
* pci: To reduce unnecessary ABIs exposed by DPDK bus driver, "rte_bus_pci.h"
will be made internal in 21.11 and macros/data structures/functions defined
in the header will not be considered as ABI anymore. This change is inspired
by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176.
* drivers: As a follow-up of the work on the ``rte_bus`` object,
the ``rte_driver`` and ``rte_device`` objects (and as a domino effect,
their bus-specific counterparts) will be made opaque in DPDK 22.11.
Registering a driver on a bus will be marked as an internal API:
external users may still register their drivers using the bus-specific
driver header (see ``enable_driver_sdk`` meson option).
* bus: The ``dev->device.numa_node`` field is set by each bus driver for
every device it manages to indicate on which NUMA node this device lies.