1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 6WIND S.A.
5 #ifndef _PCI_PRIVATE_H_
6 #define _PCI_PRIVATE_H_
11 #include <rte_bus_pci.h>
13 struct rte_pci_driver;
14 struct rte_pci_device;
27 * Scan the content of the PCI bus, and the devices in the devices
31 * 0 on success, negative on error
33 int rte_pci_scan(void);
36 * Find the name of a PCI device.
39 pci_name_set(struct rte_pci_device *dev);
42 * Add a PCI device to the PCI Bus (append to PCI Device list). This function
43 * also updates the bus references of the PCI Device (and the generic device
44 * object embedded within.
50 void rte_pci_add_device(struct rte_pci_device *pci_dev);
53 * Insert a PCI device in the PCI Bus at a particular location in the device
54 * list. It also updates the PCI Bus reference of the new devices to be
57 * @param exist_pci_dev
58 * Existing PCI device in PCI Bus
60 * PCI device to be added before exist_pci_dev
63 void rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
64 struct rte_pci_device *new_pci_dev);
67 * Update a pci device object by asking the kernel for the latest information.
69 * This function is private to EAL.
72 * The PCI Bus-Device-Function address to look for
75 * - negative on error.
77 int pci_update_device(const struct rte_pci_addr *addr);
80 * Map the PCI resource of a PCI device in virtual memory
82 * This function is private to EAL.
85 * 0 on success, negative on error
87 int pci_uio_map_resource(struct rte_pci_device *dev);
90 * Unmap the PCI resource of a PCI device
92 * This function is private to EAL.
94 void pci_uio_unmap_resource(struct rte_pci_device *dev);
97 * Allocate uio resource for PCI device
99 * This function is private to EAL.
102 * PCI device to allocate uio resource
104 * Pointer to uio resource.
105 * If the function returns 0, the pointer will be filled.
107 * 0 on success, negative on error
109 int pci_uio_alloc_resource(struct rte_pci_device *dev,
110 struct mapped_pci_resource **uio_res);
113 * Free uio resource for PCI device
115 * This function is private to EAL.
118 * PCI device to free uio resource
120 * Pointer to uio resource.
122 void pci_uio_free_resource(struct rte_pci_device *dev,
123 struct mapped_pci_resource *uio_res);
126 * Map device memory to uio resource
128 * This function is private to EAL.
131 * PCI device that has memory information.
133 * Memory resource index of the PCI device.
135 * uio resource that will keep mapping information.
137 * Mapping information index of the uio resource.
139 * 0 on success, negative on error
141 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
142 struct mapped_pci_resource *uio_res, int map_idx);
145 * Match the PCI Driver and Device using the ID Table
148 * PCI driver from which ID table would be extracted
150 * PCI device to match against the driver
152 * 1 for successful match
153 * 0 for unsuccessful match
156 rte_pci_match(const struct rte_pci_driver *pci_drv,
157 const struct rte_pci_device *pci_dev);
160 * Get iommu class of PCI devices on the bus.
161 * And return their preferred iova mapping mode.
164 * - enum rte_iova_mode.
167 rte_pci_get_iommu_class(void);
169 #endif /* _PCI_PRIVATE_H_ */