[1/2] remove references to private PCI probe function
Checks
Commit Message
rte_pci_probe() is private to the PCI bus.
Clean the remaining references in the documentation and comments.
Fixes: c752998b5e2e ("pci: introduce library and driver")
Cc: stable@dpdk.org
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
doc/guides/sample_app_ug/l2_forward_event.rst | 8 --------
doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 9 ---------
doc/guides/sample_app_ug/link_status_intr.rst | 7 -------
doc/guides/sample_app_ug/multi_process.rst | 2 +-
drivers/bus/pci/pci_common.c | 6 +++---
drivers/bus/pci/private.h | 10 ----------
drivers/net/virtio/virtio_user_ethdev.c | 2 +-
7 files changed, 5 insertions(+), 39 deletions(-)
Comments
Hello David,
On 06/05/20 14:43 +0200, David Marchand wrote:
> rte_pci_probe() is private to the PCI bus.
> Clean the remaining references in the documentation and comments.
>
> Fixes: c752998b5e2e ("pci: introduce library and driver")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> doc/guides/sample_app_ug/l2_forward_event.rst | 8 --------
> doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 9 ---------
> doc/guides/sample_app_ug/link_status_intr.rst | 7 -------
> doc/guides/sample_app_ug/multi_process.rst | 2 +-
> drivers/bus/pci/pci_common.c | 6 +++---
> drivers/bus/pci/private.h | 10 ----------
> drivers/net/virtio/virtio_user_ethdev.c | 2 +-
> 7 files changed, 5 insertions(+), 39 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/l2_forward_event.rst b/doc/guides/sample_app_ug/l2_forward_event.rst
> index 8bdf352c4e..d536eee819 100644
> --- a/doc/guides/sample_app_ug/l2_forward_event.rst
> +++ b/doc/guides/sample_app_ug/l2_forward_event.rst
> @@ -204,9 +204,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
>
> .. code-block:: c
>
> - if (rte_pci_probe() < 0)
> - rte_panic("Cannot probe PCI\n");
> -
> /* reset l2fwd_dst_ports */
>
> for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
> @@ -236,11 +233,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
> rte_eth_dev_info_get((uint8_t) portid, &dev_info);
> }
>
> -Observe that:
> -
> -* rte_pci_probe() parses the devices on the PCI bus and initializes recognized
> - devices.
> -
Reading the docs overall, what needed to be covered by referencing
rte_pci_probe() here should be covered by the reference to
rte_eal_init() earlier.
So simply removing rte_pci_probe() line in these docs seems ok.
LGTM,
Reviewed-by: Gaetan Rivet <grive@u256.net>
On Wed, May 6, 2020 at 2:43 PM David Marchand <david.marchand@redhat.com> wrote:
>
> rte_pci_probe() is private to the PCI bus.
> Clean the remaining references in the documentation and comments.
>
> Fixes: c752998b5e2e ("pci: introduce library and driver")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
Reviewed-by: Gaetan Rivet <grive@u256.net>
Applied.
@@ -204,9 +204,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
.. code-block:: c
- if (rte_pci_probe() < 0)
- rte_panic("Cannot probe PCI\n");
-
/* reset l2fwd_dst_ports */
for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
@@ -236,11 +233,6 @@ chapters that related to the Poll Mode and Event mode Driver in the
rte_eth_dev_info_get((uint8_t) portid, &dev_info);
}
-Observe that:
-
-* rte_pci_probe() parses the devices on the PCI bus and initializes recognized
- devices.
-
The next step is to configure the RX and TX queues. For each port, there is only
one RX queue (only one lcore is able to poll a given port). The number of TX
queues depends on the number of available lcores. The rte_eth_dev_configure()
@@ -194,9 +194,6 @@ in the *DPDK Programmer's Guide* - Rel 1.4 EAR and the *DPDK API Reference*.
.. code-block:: c
- if (rte_pci_probe() < 0)
- rte_exit(EXIT_FAILURE, "Cannot probe PCI\n");
-
/* reset l2fwd_dst_ports */
for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
@@ -226,12 +223,6 @@ in the *DPDK Programmer's Guide* - Rel 1.4 EAR and the *DPDK API Reference*.
rte_eth_dev_info_get((uint8_t) portid, &dev_info);
}
-Observe that:
-
-* rte_igb_pmd_init_all() simultaneously registers the driver as a PCI driver and as an Ethernet* Poll Mode Driver.
-
-* rte_pci_probe() parses the devices on the PCI bus and initializes recognized devices.
-
The next step is to configure the RX and TX queues.
For each port, there is only one RX queue (only one lcore is able to poll a given port).
The number of TX queues depends on the number of available lcores.
@@ -88,9 +88,6 @@ To fully understand this code, it is recommended to study the chapters that rela
.. code-block:: c
- if (rte_pci_probe() < 0)
- rte_exit(EXIT_FAILURE, "Cannot probe PCI\n");
-
/*
* Each logical core is assigned a dedicated TX queue on each port.
*/
@@ -115,10 +112,6 @@ To fully understand this code, it is recommended to study the chapters that rela
rte_eth_dev_info_get((uint8_t) portid, &dev_info);
}
-Observe that:
-
-* rte_pci_probe() parses the devices on the PCI bus and initializes recognized devices.
-
The next step is to configure the RX and TX queues.
For each port, there is only one RX queue (only one lcore is able to poll a given port).
The number of TX queues depends on the number of available lcores.
@@ -209,7 +209,7 @@ How the Application Works
^^^^^^^^^^^^^^^^^^^^^^^^^
The initialization calls in both the primary and secondary instances are the same for the most part,
-calling the rte_eal_init(), 1 G and 10 G driver initialization and then rte_pci_probe() functions.
+calling the rte_eal_init(), 1 G and 10 G driver initialization and then probing devices.
Thereafter, the initialization done depends on whether the process is configured as a primary or secondary instance.
In the primary instance, a memory pool is created for the packet mbufs and the network ports to be used are initialized -
@@ -288,8 +288,8 @@ pci_probe_all_drivers(struct rte_pci_device *dev)
* all registered drivers that have a matching entry in its id_table
* for discovered devices.
*/
-int
-rte_pci_probe(void)
+static int
+pci_probe(void)
{
struct rte_pci_device *dev = NULL;
size_t probed = 0, failed = 0;
@@ -675,7 +675,7 @@ rte_pci_get_iommu_class(void)
struct rte_pci_bus rte_pci_bus = {
.bus = {
.scan = rte_pci_scan,
- .probe = rte_pci_probe,
+ .probe = pci_probe,
.find_device = pci_find_device,
.plug = pci_plug,
.unplug = pci_unplug,
@@ -17,16 +17,6 @@ struct rte_pci_device;
extern struct rte_pci_bus rte_pci_bus;
-/**
- * Probe the PCI bus
- *
- * @return
- * - 0 on success.
- * - !0 on error.
- */
-int
-rte_pci_probe(void);
-
/**
* Scan the content of the PCI bus, and the devices in the devices
* list
@@ -720,7 +720,7 @@ virtio_user_pmd_probe(struct rte_vdev_device *dev)
goto end;
}
- /* previously called by rte_pci_probe() for physical dev */
+ /* previously called by pci probing for physical dev */
if (eth_virtio_dev_init(eth_dev) < 0) {
PMD_INIT_LOG(ERR, "eth_virtio_dev_init fails");
virtio_user_eth_dev_free(eth_dev);