4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Copyright(c) 2013 6WIND.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name of 6WIND S.A. nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
80 #include <sys/queue.h>
83 #include <rte_interrupts.h>
85 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
86 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
88 extern struct pci_driver_list driver_list; /**< Global list of PCI drivers. */
89 extern struct pci_device_list device_list; /**< Global list of PCI devices. */
91 /** Pathname of PCI devices directory. */
92 #define SYSFS_PCI_DEVICES "/sys/bus/pci/devices"
94 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
95 #define PCI_PRI_FMT "%.4"PRIx16":%.2"PRIx8":%.2"PRIx8".%"PRIx8
97 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
98 #define PCI_SHORT_PRI_FMT "%.2"PRIx8":%.2"PRIx8".%"PRIx8
100 /** Nb. of values in PCI device identifier format string. */
101 #define PCI_FMT_NVAL 4
103 /** Nb. of values in PCI resource format. */
104 #define PCI_RESOURCE_FMT_NVAL 3
107 * A structure describing a PCI resource.
109 struct rte_pci_resource {
110 uint64_t phys_addr; /**< Physical address, 0 if no resource. */
111 uint64_t len; /**< Length of the resource. */
112 void *addr; /**< Virtual address, NULL when not mapped. */
115 /** Maximum number of PCI resources. */
116 #define PCI_MAX_RESOURCE 7
119 * A structure describing an ID for a PCI driver. Each driver provides a
120 * table of these IDs for each device that it supports.
123 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
124 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
125 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
126 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
130 * A structure describing the location of a PCI device.
132 struct rte_pci_addr {
133 uint16_t domain; /**< Device domain */
134 uint8_t bus; /**< Device bus */
135 uint8_t devid; /**< Device ID */
136 uint8_t function; /**< Device function. */
140 * A structure describing a PCI device.
142 struct rte_pci_device {
143 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
144 struct rte_pci_addr addr; /**< PCI location. */
145 struct rte_pci_id id; /**< PCI ID. */
146 struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE]; /**< PCI Memory Resource */
147 struct rte_intr_handle intr_handle; /**< Interrupt handle */
148 const struct rte_pci_driver *driver; /**< Associated driver */
149 uint16_t max_vfs; /**< sriov enable if not zero */
150 int numa_node; /**< NUMA node connection */
151 unsigned int blacklisted:1; /**< Device is blacklisted */
154 /** Any PCI device identifier (vendor, device, ...) */
155 #define PCI_ANY_ID (0xffff)
158 /** C++ macro used to help building up tables of device IDs */
159 #define RTE_PCI_DEVICE(vend, dev) \
165 /** Macro used to help building up tables of device IDs */
166 #define RTE_PCI_DEVICE(vend, dev) \
167 .vendor_id = (vend), \
168 .device_id = (dev), \
169 .subsystem_vendor_id = PCI_ANY_ID, \
170 .subsystem_device_id = PCI_ANY_ID
173 struct rte_pci_driver;
176 * Initialisation function for the driver called during PCI probing.
178 typedef int (pci_devinit_t)(struct rte_pci_driver *, struct rte_pci_device *);
181 * A structure describing a PCI driver.
183 struct rte_pci_driver {
184 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
185 const char *name; /**< Driver name. */
186 pci_devinit_t *devinit; /**< Device init. function. */
187 struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
188 uint32_t drv_flags; /**< Flags contolling handling of device. */
191 /** Device needs igb_uio kernel module */
192 #define RTE_PCI_DRV_NEED_IGB_UIO 0x0001
193 /** Device driver must be registered several times until failure */
194 #define RTE_PCI_DRV_MULTIPLE 0x0002
195 /** Device needs to be unbound even if no module is provided */
196 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
198 /**< Internal use only - Macro used by pci addr parsing functions **/
199 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
204 val = strtoul((in), &end, 16); \
205 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
207 (fd) = (typeof (fd))val; \
212 * Utility function to produce a PCI Bus-Device-Function value
213 * given a string representation. Assumes that the BDF is provided without
214 * a domain prefix (i.e. domain returned is always 0)
217 * The input string to be parsed. Should have the format XX:XX.X
219 * The PCI Bus-Device-Function address to be returned. Domain will always be
222 * 0 on success, negative on error.
225 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
227 dev_addr->domain = 0;
228 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
229 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
230 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
235 * Utility function to produce a PCI Bus-Device-Function value
236 * given a string representation. Assumes that the BDF is provided including
240 * The input string to be parsed. Should have the format XXXX:XX:XX.X
242 * The PCI Bus-Device-Function address to be returned
244 * 0 on success, negative on error.
247 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
249 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
250 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
251 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
252 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
255 #undef GET_PCIADDR_FIELD
258 * Probe the PCI bus for registered drivers.
260 * Scan the content of the PCI bus, and call the probe() function for
261 * all registered drivers that have a matching entry in its id_table
262 * for discovered devices.
266 * - Negative on error.
268 int rte_eal_pci_probe(void);
271 * Dump the content of the PCI bus.
273 void rte_eal_pci_dump(void);
276 * Register a PCI driver.
279 * A pointer to a rte_pci_driver structure describing the driver
282 void rte_eal_pci_register(struct rte_pci_driver *driver);
285 * Unregister a PCI driver.
288 * A pointer to a rte_pci_driver structure describing the driver
289 * to be unregistered.
291 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
294 * Register a list of PCI locations that will be blacklisted (not used by DPDK).
297 * List of PCI device addresses that will not be used by DPDK.
299 * Number of items in the list.
301 void rte_eal_pci_set_blacklist(struct rte_pci_addr *blacklist, unsigned size);
307 #endif /* _RTE_PCI_H_ */