4 * Copyright(c) 2010-2015 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 2013-2014 6WIND S.A.
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.
81 #include <sys/queue.h>
85 #include <rte_debug.h>
86 #include <rte_interrupts.h>
89 TAILQ_HEAD(pci_device_list, rte_pci_device); /**< PCI devices in D-linked Q. */
90 TAILQ_HEAD(pci_driver_list, rte_pci_driver); /**< PCI drivers in D-linked Q. */
92 extern struct pci_driver_list pci_driver_list; /**< Global list of PCI drivers. */
93 extern struct pci_device_list pci_device_list; /**< Global list of PCI devices. */
95 /** Pathname of PCI devices directory. */
96 const char *pci_get_sysfs_path(void);
98 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
99 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
100 #define PCI_PRI_STR_SIZE sizeof("XXXX:XX:XX.X")
102 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
103 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
105 /** Nb. of values in PCI device identifier format string. */
106 #define PCI_FMT_NVAL 4
108 /** Nb. of values in PCI resource format. */
109 #define PCI_RESOURCE_FMT_NVAL 3
112 * A structure describing a PCI resource.
114 struct rte_pci_resource {
115 uint64_t phys_addr; /**< Physical address, 0 if no resource. */
116 uint64_t len; /**< Length of the resource. */
117 void *addr; /**< Virtual address, NULL when not mapped. */
120 /** Maximum number of PCI resources. */
121 #define PCI_MAX_RESOURCE 6
124 * A structure describing an ID for a PCI driver. Each driver provides a
125 * table of these IDs for each device that it supports.
128 uint32_t class_id; /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
129 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
130 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
131 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
132 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
136 * A structure describing the location of a PCI device.
138 struct rte_pci_addr {
139 uint16_t domain; /**< Device domain */
140 uint8_t bus; /**< Device bus */
141 uint8_t devid; /**< Device ID */
142 uint8_t function; /**< Device function. */
147 enum rte_kernel_driver {
148 RTE_KDRV_UNKNOWN = 0,
151 RTE_KDRV_UIO_GENERIC,
157 * A structure describing a PCI device.
159 struct rte_pci_device {
160 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
161 struct rte_pci_addr addr; /**< PCI location. */
162 struct rte_pci_id id; /**< PCI ID. */
163 struct rte_pci_resource mem_resource[PCI_MAX_RESOURCE]; /**< PCI Memory Resource */
164 struct rte_intr_handle intr_handle; /**< Interrupt handle */
165 struct rte_pci_driver *driver; /**< Associated driver */
166 uint16_t max_vfs; /**< sriov enable if not zero */
167 int numa_node; /**< NUMA node connection */
168 struct rte_devargs *devargs; /**< Device user arguments */
169 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
172 /** Any PCI device identifier (vendor, device, ...) */
173 #define PCI_ANY_ID (0xffff)
174 #define RTE_CLASS_ANY_ID (0xffffff)
177 /** C++ macro used to help building up tables of device IDs */
178 #define RTE_PCI_DEVICE(vend, dev) \
185 /** Macro used to help building up tables of device IDs */
186 #define RTE_PCI_DEVICE(vend, dev) \
187 .class_id = RTE_CLASS_ANY_ID, \
188 .vendor_id = (vend), \
189 .device_id = (dev), \
190 .subsystem_vendor_id = PCI_ANY_ID, \
191 .subsystem_device_id = PCI_ANY_ID
194 struct rte_pci_driver;
197 * Initialisation function for the driver called during PCI probing.
199 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
202 * Uninitialisation function for the driver called during hotplugging.
204 typedef int (pci_remove_t)(struct rte_pci_device *);
207 * A structure describing a PCI driver.
209 struct rte_pci_driver {
210 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
211 const char *name; /**< Driver name. */
212 pci_probe_t *probe; /**< Device Probe function. */
213 pci_remove_t *remove; /**< Device Remove function. */
214 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
215 uint32_t drv_flags; /**< Flags contolling handling of device. */
218 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
219 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
220 /** Device needs to be unbound even if no module is provided */
221 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
222 /** Device driver supports link state interrupt */
223 #define RTE_PCI_DRV_INTR_LSC 0x0008
224 /** Device driver supports detaching capability */
225 #define RTE_PCI_DRV_DETACHABLE 0x0010
228 * A structure describing a PCI mapping.
239 * A structure describing a mapped PCI resource.
240 * For multi-process we need to reproduce all PCI mappings in secondary
241 * processes, so save them in a tailq.
243 struct mapped_pci_resource {
244 TAILQ_ENTRY(mapped_pci_resource) next;
246 struct rte_pci_addr pci_addr;
249 struct pci_map maps[PCI_MAX_RESOURCE];
252 /** mapped pci device list */
253 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
255 /**< Internal use only - Macro used by pci addr parsing functions **/
256 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
261 val = strtoul((in), &end, 16); \
262 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
264 (fd) = (typeof (fd))val; \
269 * Utility function to produce a PCI Bus-Device-Function value
270 * given a string representation. Assumes that the BDF is provided without
271 * a domain prefix (i.e. domain returned is always 0)
274 * The input string to be parsed. Should have the format XX:XX.X
276 * The PCI Bus-Device-Function address to be returned. Domain will always be
279 * 0 on success, negative on error.
282 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
284 dev_addr->domain = 0;
285 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
286 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
287 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
292 * Utility function to produce a PCI Bus-Device-Function value
293 * given a string representation. Assumes that the BDF is provided including
297 * The input string to be parsed. Should have the format XXXX:XX:XX.X
299 * The PCI Bus-Device-Function address to be returned
301 * 0 on success, negative on error.
304 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
306 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
307 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
308 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
309 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
312 #undef GET_PCIADDR_FIELD
315 * Utility function to write a pci device name, this device name can later be
316 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
320 * The PCI Bus-Device-Function address
322 * The output buffer string
324 * The output buffer size
327 rte_eal_pci_device_name(const struct rte_pci_addr *addr,
328 char *output, size_t size)
330 RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
331 RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
332 addr->domain, addr->bus,
333 addr->devid, addr->function) >= 0);
336 /* Compare two PCI device addresses. */
338 * Utility function to compare two PCI device addresses.
341 * The PCI Bus-Device-Function address to compare
343 * The PCI Bus-Device-Function address to compare
345 * 0 on equal PCI address.
346 * Positive on addr is greater than addr2.
347 * Negative on addr is less than addr2, or error.
350 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
351 const struct rte_pci_addr *addr2)
353 uint64_t dev_addr, dev_addr2;
355 if ((addr == NULL) || (addr2 == NULL))
358 dev_addr = (addr->domain << 24) | (addr->bus << 16) |
359 (addr->devid << 8) | addr->function;
360 dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
361 (addr2->devid << 8) | addr2->function;
363 if (dev_addr > dev_addr2)
365 else if (dev_addr < dev_addr2)
372 * Scan the content of the PCI bus, and the devices in the devices
376 * 0 on success, negative on error
378 int rte_eal_pci_scan(void);
381 * Probe the PCI bus for registered drivers.
383 * Scan the content of the PCI bus, and call the probe() function for
384 * all registered drivers that have a matching entry in its id_table
385 * for discovered devices.
389 * - Negative on error.
391 int rte_eal_pci_probe(void);
394 * Map the PCI device resources in user space virtual memory address
396 * Note that driver should not call this function when flag
397 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
401 * A pointer to a rte_pci_device structure describing the device
405 * 0 on success, negative on error and positive if no driver
406 * is found for the device.
408 int rte_eal_pci_map_device(struct rte_pci_device *dev);
414 * A pointer to a rte_pci_device structure describing the device
417 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
421 * Map a particular resource from a file.
423 * @param requested_addr
424 * The starting address for the new mapping range.
426 * The file descriptor.
428 * The offset for the mapping range.
430 * The size for the mapping range.
431 * @param additional_flags
432 * The additional flags for the mapping range.
434 * - On success, the function returns a pointer to the mapped area.
435 * - On error, the value MAP_FAILED is returned.
437 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
438 size_t size, int additional_flags);
442 * Unmap a particular resource.
444 * @param requested_addr
445 * The address for the unmapping range.
447 * The size for the unmapping range.
449 void pci_unmap_resource(void *requested_addr, size_t size);
452 * Probe the single PCI device.
454 * Scan the content of the PCI bus, and find the pci device specified by pci
455 * address, then call the probe() function for registered driver that has a
456 * matching entry in its id_table for discovered device.
459 * The PCI Bus-Device-Function address to probe.
462 * - Negative on error.
464 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
467 * Close the single PCI device.
469 * Scan the content of the PCI bus, and find the pci device specified by pci
470 * address, then call the remove() function for registered driver that has a
471 * matching entry in its id_table for discovered device.
474 * The PCI Bus-Device-Function address to close.
477 * - Negative on error.
479 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
482 * Dump the content of the PCI bus.
485 * A pointer to a file for output
487 void rte_eal_pci_dump(FILE *f);
490 * Register a PCI driver.
493 * A pointer to a rte_pci_driver structure describing the driver
496 void rte_eal_pci_register(struct rte_pci_driver *driver);
498 /** Helper for PCI device registration from driver (eth, crypto) instance */
499 #define DRIVER_REGISTER_PCI(nm, pci_drv) \
500 RTE_INIT(pciinitfn_ ##nm); \
501 static void pciinitfn_ ##nm(void) \
503 (pci_drv).name = RTE_STR(nm);\
504 rte_eal_pci_register(&pci_drv); \
506 DRIVER_EXPORT_NAME(nm, __COUNTER__)
509 * Unregister a PCI driver.
512 * A pointer to a rte_pci_driver structure describing the driver
513 * to be unregistered.
515 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
518 * Read PCI config space.
521 * A pointer to a rte_pci_device structure describing the device
524 * A data buffer where the bytes should be read into
526 * The length of the data buffer.
528 * The offset into PCI config space
530 int rte_eal_pci_read_config(const struct rte_pci_device *device,
531 void *buf, size_t len, off_t offset);
534 * Write PCI config space.
537 * A pointer to a rte_pci_device structure describing the device
540 * A data buffer containing the bytes should be written
542 * The length of the data buffer.
544 * The offset into PCI config space
546 int rte_eal_pci_write_config(const struct rte_pci_device *device,
547 const void *buf, size_t len, off_t offset);
550 * A structure used to access io resources for a pci device.
551 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
554 struct rte_pci_ioport {
555 struct rte_pci_device *dev;
557 uint64_t len; /* only filled for memory mapped ports */
561 * Initialize a rte_pci_ioport object for a pci device io resource.
563 * This object is then used to gain access to those io resources (see below).
566 * A pointer to a rte_pci_device structure describing the device
569 * Index of the io pci resource we want to access.
571 * The rte_pci_ioport object to be initialized.
573 * 0 on success, negative on error.
575 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
576 struct rte_pci_ioport *p);
579 * Release any resources used in a rte_pci_ioport object.
582 * The rte_pci_ioport object to be uninitialized.
584 * 0 on success, negative on error.
586 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
589 * Read from a io pci resource.
592 * The rte_pci_ioport object from which we want to read.
594 * A data buffer where the bytes should be read into
596 * The length of the data buffer.
598 * The offset into the pci io resource.
600 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
601 void *data, size_t len, off_t offset);
604 * Write to a io pci resource.
607 * The rte_pci_ioport object to which we want to write.
609 * A data buffer where the bytes should be read into
611 * The length of the data buffer.
613 * The offset into the pci io resource.
615 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
616 const void *data, size_t len, off_t offset);
622 #endif /* _RTE_PCI_H_ */