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
111 /** Maximum number of PCI resources. */
112 #define PCI_MAX_RESOURCE 6
115 * A structure describing an ID for a PCI driver. Each driver provides a
116 * table of these IDs for each device that it supports.
119 uint32_t class_id; /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
120 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
121 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
122 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
123 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
127 * A structure describing the location of a PCI device.
129 struct rte_pci_addr {
130 uint16_t domain; /**< Device domain */
131 uint8_t bus; /**< Device bus */
132 uint8_t devid; /**< Device ID */
133 uint8_t function; /**< Device function. */
138 enum rte_kernel_driver {
139 RTE_KDRV_UNKNOWN = 0,
142 RTE_KDRV_UIO_GENERIC,
148 * A structure describing a PCI device.
150 struct rte_pci_device {
151 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
152 struct rte_pci_addr addr; /**< PCI location. */
153 struct rte_pci_id id; /**< PCI ID. */
154 struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
155 /**< PCI Memory Resource */
156 struct rte_intr_handle intr_handle; /**< Interrupt handle */
157 struct rte_pci_driver *driver; /**< Associated driver */
158 uint16_t max_vfs; /**< sriov enable if not zero */
159 int numa_node; /**< NUMA node connection */
160 struct rte_devargs *devargs; /**< Device user arguments */
161 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
164 /** Any PCI device identifier (vendor, device, ...) */
165 #define PCI_ANY_ID (0xffff)
166 #define RTE_CLASS_ANY_ID (0xffffff)
169 /** C++ macro used to help building up tables of device IDs */
170 #define RTE_PCI_DEVICE(vend, dev) \
177 /** Macro used to help building up tables of device IDs */
178 #define RTE_PCI_DEVICE(vend, dev) \
179 .class_id = RTE_CLASS_ANY_ID, \
180 .vendor_id = (vend), \
181 .device_id = (dev), \
182 .subsystem_vendor_id = PCI_ANY_ID, \
183 .subsystem_device_id = PCI_ANY_ID
186 struct rte_pci_driver;
189 * Initialisation function for the driver called during PCI probing.
191 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
194 * Uninitialisation function for the driver called during hotplugging.
196 typedef int (pci_remove_t)(struct rte_pci_device *);
199 * A structure describing a PCI driver.
201 struct rte_pci_driver {
202 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
203 struct rte_driver driver; /**< Inherit core driver. */
204 pci_probe_t *probe; /**< Device Probe function. */
205 pci_remove_t *remove; /**< Device Remove function. */
206 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
207 uint32_t drv_flags; /**< Flags contolling handling of device. */
210 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
211 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
212 /** Device needs to be unbound even if no module is provided */
213 #define RTE_PCI_DRV_FORCE_UNBIND 0x0004
214 /** Device driver supports link state interrupt */
215 #define RTE_PCI_DRV_INTR_LSC 0x0008
216 /** Device driver supports detaching capability */
217 #define RTE_PCI_DRV_DETACHABLE 0x0010
220 * A structure describing a PCI mapping.
231 * A structure describing a mapped PCI resource.
232 * For multi-process we need to reproduce all PCI mappings in secondary
233 * processes, so save them in a tailq.
235 struct mapped_pci_resource {
236 TAILQ_ENTRY(mapped_pci_resource) next;
238 struct rte_pci_addr pci_addr;
241 struct pci_map maps[PCI_MAX_RESOURCE];
244 /** mapped pci device list */
245 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
247 /**< Internal use only - Macro used by pci addr parsing functions **/
248 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
253 val = strtoul((in), &end, 16); \
254 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
256 (fd) = (typeof (fd))val; \
261 * Utility function to produce a PCI Bus-Device-Function value
262 * given a string representation. Assumes that the BDF is provided without
263 * a domain prefix (i.e. domain returned is always 0)
266 * The input string to be parsed. Should have the format XX:XX.X
268 * The PCI Bus-Device-Function address to be returned. Domain will always be
271 * 0 on success, negative on error.
274 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
276 dev_addr->domain = 0;
277 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
278 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
279 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
284 * Utility function to produce a PCI Bus-Device-Function value
285 * given a string representation. Assumes that the BDF is provided including
289 * The input string to be parsed. Should have the format XXXX:XX:XX.X
291 * The PCI Bus-Device-Function address to be returned
293 * 0 on success, negative on error.
296 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
298 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
299 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
300 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
301 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
304 #undef GET_PCIADDR_FIELD
307 * Utility function to write a pci device name, this device name can later be
308 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
312 * The PCI Bus-Device-Function address
314 * The output buffer string
316 * The output buffer size
319 rte_eal_pci_device_name(const struct rte_pci_addr *addr,
320 char *output, size_t size)
322 RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
323 RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
324 addr->domain, addr->bus,
325 addr->devid, addr->function) >= 0);
328 /* Compare two PCI device addresses. */
330 * Utility function to compare two PCI device addresses.
333 * The PCI Bus-Device-Function address to compare
335 * The PCI Bus-Device-Function address to compare
337 * 0 on equal PCI address.
338 * Positive on addr is greater than addr2.
339 * Negative on addr is less than addr2, or error.
342 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
343 const struct rte_pci_addr *addr2)
345 uint64_t dev_addr, dev_addr2;
347 if ((addr == NULL) || (addr2 == NULL))
350 dev_addr = (addr->domain << 24) | (addr->bus << 16) |
351 (addr->devid << 8) | addr->function;
352 dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
353 (addr2->devid << 8) | addr2->function;
355 if (dev_addr > dev_addr2)
357 else if (dev_addr < dev_addr2)
364 * Scan the content of the PCI bus, and the devices in the devices
368 * 0 on success, negative on error
370 int rte_eal_pci_scan(void);
373 * Probe the PCI bus for registered drivers.
375 * Scan the content of the PCI bus, and call the probe() function for
376 * all registered drivers that have a matching entry in its id_table
377 * for discovered devices.
381 * - Negative on error.
383 int rte_eal_pci_probe(void);
386 * Map the PCI device resources in user space virtual memory address
388 * Note that driver should not call this function when flag
389 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
393 * A pointer to a rte_pci_device structure describing the device
397 * 0 on success, negative on error and positive if no driver
398 * is found for the device.
400 int rte_eal_pci_map_device(struct rte_pci_device *dev);
406 * A pointer to a rte_pci_device structure describing the device
409 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
413 * Map a particular resource from a file.
415 * @param requested_addr
416 * The starting address for the new mapping range.
418 * The file descriptor.
420 * The offset for the mapping range.
422 * The size for the mapping range.
423 * @param additional_flags
424 * The additional flags for the mapping range.
426 * - On success, the function returns a pointer to the mapped area.
427 * - On error, the value MAP_FAILED is returned.
429 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
430 size_t size, int additional_flags);
434 * Unmap a particular resource.
436 * @param requested_addr
437 * The address for the unmapping range.
439 * The size for the unmapping range.
441 void pci_unmap_resource(void *requested_addr, size_t size);
444 * Probe the single PCI device.
446 * Scan the content of the PCI bus, and find the pci device specified by pci
447 * address, then call the probe() function for registered driver that has a
448 * matching entry in its id_table for discovered device.
451 * The PCI Bus-Device-Function address to probe.
454 * - Negative on error.
456 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
459 * Close the single PCI device.
461 * Scan the content of the PCI bus, and find the pci device specified by pci
462 * address, then call the remove() function for registered driver that has a
463 * matching entry in its id_table for discovered device.
466 * The PCI Bus-Device-Function address to close.
469 * - Negative on error.
471 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
474 * Dump the content of the PCI bus.
477 * A pointer to a file for output
479 void rte_eal_pci_dump(FILE *f);
482 * Register a PCI driver.
485 * A pointer to a rte_pci_driver structure describing the driver
488 void rte_eal_pci_register(struct rte_pci_driver *driver);
490 /** Helper for PCI device registration from driver (eth, crypto) instance */
491 #define DRIVER_REGISTER_PCI(nm, pci_drv) \
492 RTE_INIT(pciinitfn_ ##nm); \
493 static void pciinitfn_ ##nm(void) \
495 (pci_drv).driver.name = RTE_STR(nm);\
496 rte_eal_pci_register(&pci_drv); \
498 DRIVER_EXPORT_NAME(nm, __COUNTER__)
501 * Unregister a PCI driver.
504 * A pointer to a rte_pci_driver structure describing the driver
505 * to be unregistered.
507 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
510 * Read PCI config space.
513 * A pointer to a rte_pci_device structure describing the device
516 * A data buffer where the bytes should be read into
518 * The length of the data buffer.
520 * The offset into PCI config space
522 int rte_eal_pci_read_config(const struct rte_pci_device *device,
523 void *buf, size_t len, off_t offset);
526 * Write PCI config space.
529 * A pointer to a rte_pci_device structure describing the device
532 * A data buffer containing the bytes should be written
534 * The length of the data buffer.
536 * The offset into PCI config space
538 int rte_eal_pci_write_config(const struct rte_pci_device *device,
539 const void *buf, size_t len, off_t offset);
542 * A structure used to access io resources for a pci device.
543 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
546 struct rte_pci_ioport {
547 struct rte_pci_device *dev;
549 uint64_t len; /* only filled for memory mapped ports */
553 * Initialize a rte_pci_ioport object for a pci device io resource.
555 * This object is then used to gain access to those io resources (see below).
558 * A pointer to a rte_pci_device structure describing the device
561 * Index of the io pci resource we want to access.
563 * The rte_pci_ioport object to be initialized.
565 * 0 on success, negative on error.
567 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
568 struct rte_pci_ioport *p);
571 * Release any resources used in a rte_pci_ioport object.
574 * The rte_pci_ioport object to be uninitialized.
576 * 0 on success, negative on error.
578 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
581 * Read from a io pci resource.
584 * The rte_pci_ioport object from which we want to read.
586 * A data buffer where the bytes should be read into
588 * The length of the data buffer.
590 * The offset into the pci io resource.
592 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
593 void *data, size_t len, off_t offset);
596 * Write to a io pci resource.
599 * The rte_pci_ioport object to which we want to write.
601 * A data buffer where the bytes should be read into
603 * The length of the data buffer.
605 * The offset into the pci io resource.
607 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
608 const void *data, size_t len, off_t offset);
614 #endif /* _RTE_PCI_H_ */