4 * Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 * Copyright 2013-2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 #include <sys/queue.h>
56 #include <rte_debug.h>
57 #include <rte_interrupts.h>
61 /** Pathname of PCI devices directory. */
62 const char *pci_get_sysfs_path(void);
64 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
65 #define PCI_PRI_FMT "%.4" PRIx16 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
66 #define PCI_PRI_STR_SIZE sizeof("XXXXXXXX:XX:XX.X")
68 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
69 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
71 /** Nb. of values in PCI device identifier format string. */
72 #define PCI_FMT_NVAL 4
74 /** Nb. of values in PCI resource format. */
75 #define PCI_RESOURCE_FMT_NVAL 3
77 /** Maximum number of PCI resources. */
78 #define PCI_MAX_RESOURCE 6
80 /* Forward declarations */
81 struct rte_pci_device;
82 struct rte_pci_driver;
84 /** List of PCI devices */
85 TAILQ_HEAD(rte_pci_device_list, rte_pci_device);
86 /** List of PCI drivers */
87 TAILQ_HEAD(rte_pci_driver_list, rte_pci_driver);
89 /* PCI Bus iterators */
90 #define FOREACH_DEVICE_ON_PCIBUS(p) \
91 TAILQ_FOREACH(p, &(rte_pci_bus.device_list), next)
93 #define FOREACH_DRIVER_ON_PCIBUS(p) \
94 TAILQ_FOREACH(p, &(rte_pci_bus.driver_list), next)
97 * A structure describing an ID for a PCI driver. Each driver provides a
98 * table of these IDs for each device that it supports.
101 uint32_t class_id; /**< Class ID (class, subclass, pi) or RTE_CLASS_ANY_ID. */
102 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
103 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
104 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
105 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
109 * A structure describing the location of a PCI device.
111 struct rte_pci_addr {
112 uint32_t domain; /**< Device domain */
113 uint8_t bus; /**< Device bus */
114 uint8_t devid; /**< Device ID */
115 uint8_t function; /**< Device function. */
120 enum rte_kernel_driver {
121 RTE_KDRV_UNKNOWN = 0,
124 RTE_KDRV_UIO_GENERIC,
130 * A structure describing a PCI device.
132 struct rte_pci_device {
133 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
134 struct rte_device device; /**< Inherit core device */
135 struct rte_pci_addr addr; /**< PCI location. */
136 struct rte_pci_id id; /**< PCI ID. */
137 struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
138 /**< PCI Memory Resource */
139 struct rte_intr_handle intr_handle; /**< Interrupt handle */
140 struct rte_pci_driver *driver; /**< Associated driver */
141 uint16_t max_vfs; /**< sriov enable if not zero */
142 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
143 char name[PCI_PRI_STR_SIZE+1]; /**< PCI location (ASCII) */
148 * Helper macro for drivers that need to convert to struct rte_pci_device.
150 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
152 /** Any PCI device identifier (vendor, device, ...) */
153 #define PCI_ANY_ID (0xffff)
154 #define RTE_CLASS_ANY_ID (0xffffff)
157 /** C++ macro used to help building up tables of device IDs */
158 #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 .class_id = RTE_CLASS_ANY_ID, \
168 .vendor_id = (vend), \
169 .device_id = (dev), \
170 .subsystem_vendor_id = PCI_ANY_ID, \
171 .subsystem_device_id = PCI_ANY_ID
175 * Initialisation function for the driver called during PCI probing.
177 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
180 * Uninitialisation function for the driver called during hotplugging.
182 typedef int (pci_remove_t)(struct rte_pci_device *);
185 * A structure describing a PCI driver.
187 struct rte_pci_driver {
188 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
189 struct rte_driver driver; /**< Inherit core driver. */
190 struct rte_pci_bus *bus; /**< PCI bus reference. */
191 pci_probe_t *probe; /**< Device Probe function. */
192 pci_remove_t *remove; /**< Device Remove function. */
193 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
194 uint32_t drv_flags; /**< Flags contolling handling of device. */
198 * Structure describing the PCI bus
201 struct rte_bus bus; /**< Inherit the generic class */
202 struct rte_pci_device_list device_list; /**< List of PCI devices */
203 struct rte_pci_driver_list driver_list; /**< List of PCI drivers */
206 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
207 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
208 /** Device driver supports link state interrupt */
209 #define RTE_PCI_DRV_INTR_LSC 0x0008
210 /** Device driver supports device removal interrupt */
211 #define RTE_PCI_DRV_INTR_RMV 0x0010
212 /** Device driver needs to keep mapped resources if unsupported dev detected */
213 #define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
216 * A structure describing a PCI mapping.
227 * A structure describing a mapped PCI resource.
228 * For multi-process we need to reproduce all PCI mappings in secondary
229 * processes, so save them in a tailq.
231 struct mapped_pci_resource {
232 TAILQ_ENTRY(mapped_pci_resource) next;
234 struct rte_pci_addr pci_addr;
237 struct pci_map maps[PCI_MAX_RESOURCE];
240 /** mapped pci device list */
241 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
243 /**< Internal use only - Macro used by pci addr parsing functions **/
244 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
249 val = strtoul((in), &end, 16); \
250 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
252 (fd) = (typeof (fd))val; \
257 * Utility function to produce a PCI Bus-Device-Function value
258 * given a string representation. Assumes that the BDF is provided without
259 * a domain prefix (i.e. domain returned is always 0)
262 * The input string to be parsed. Should have the format XX:XX.X
264 * The PCI Bus-Device-Function address to be returned. Domain will always be
267 * 0 on success, negative on error.
270 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
272 dev_addr->domain = 0;
273 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
274 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
275 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
280 * Utility function to produce a PCI Bus-Device-Function value
281 * given a string representation. Assumes that the BDF is provided including
285 * The input string to be parsed. Should have the format XXXX:XX:XX.X
287 * The PCI Bus-Device-Function address to be returned
289 * 0 on success, negative on error.
292 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
294 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
295 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
296 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
297 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
300 #undef GET_PCIADDR_FIELD
303 * Utility function to write a pci device name, this device name can later be
304 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
308 * The PCI Bus-Device-Function address
310 * The output buffer string
312 * The output buffer size
315 rte_pci_device_name(const struct rte_pci_addr *addr,
316 char *output, size_t size)
318 RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
319 RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
320 addr->domain, addr->bus,
321 addr->devid, addr->function) >= 0);
324 /* Compare two PCI device addresses. */
326 * Utility function to compare two PCI device addresses.
329 * The PCI Bus-Device-Function address to compare
331 * The PCI Bus-Device-Function address to compare
333 * 0 on equal PCI address.
334 * Positive on addr is greater than addr2.
335 * Negative on addr is less than addr2, or error.
338 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
339 const struct rte_pci_addr *addr2)
341 uint64_t dev_addr, dev_addr2;
343 if ((addr == NULL) || (addr2 == NULL))
346 dev_addr = ((uint64_t)addr->domain << 24) |
347 (addr->bus << 16) | (addr->devid << 8) | addr->function;
348 dev_addr2 = ((uint64_t)addr2->domain << 24) |
349 (addr2->bus << 16) | (addr2->devid << 8) | addr2->function;
351 if (dev_addr > dev_addr2)
353 else if (dev_addr < dev_addr2)
360 * Scan the content of the PCI bus, and the devices in the devices
364 * 0 on success, negative on error
366 int rte_pci_scan(void);
379 * Map the PCI device resources in user space virtual memory address
381 * Note that driver should not call this function when flag
382 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
386 * A pointer to a rte_pci_device structure describing the device
390 * 0 on success, negative on error and positive if no driver
391 * is found for the device.
393 int rte_pci_map_device(struct rte_pci_device *dev);
399 * A pointer to a rte_pci_device structure describing the device
402 void rte_pci_unmap_device(struct rte_pci_device *dev);
406 * Map a particular resource from a file.
408 * @param requested_addr
409 * The starting address for the new mapping range.
411 * The file descriptor.
413 * The offset for the mapping range.
415 * The size for the mapping range.
416 * @param additional_flags
417 * The additional flags for the mapping range.
419 * - On success, the function returns a pointer to the mapped area.
420 * - On error, the value MAP_FAILED is returned.
422 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
423 size_t size, int additional_flags);
427 * Unmap a particular resource.
429 * @param requested_addr
430 * The address for the unmapping range.
432 * The size for the unmapping range.
434 void pci_unmap_resource(void *requested_addr, size_t size);
437 * Probe the single PCI device.
439 * Scan the content of the PCI bus, and find the pci device specified by pci
440 * address, then call the probe() function for registered driver that has a
441 * matching entry in its id_table for discovered device.
444 * The PCI Bus-Device-Function address to probe.
447 * - Negative on error.
449 int rte_pci_probe_one(const struct rte_pci_addr *addr);
452 * Close 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 remove() 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 close.
462 * - Negative on error.
464 int rte_pci_detach(const struct rte_pci_addr *addr);
467 * Dump the content of the PCI bus.
470 * A pointer to a file for output
472 void rte_pci_dump(FILE *f);
475 * Register a PCI driver.
478 * A pointer to a rte_pci_driver structure describing the driver
481 void rte_pci_register(struct rte_pci_driver *driver);
483 /** Helper for PCI device registration from driver (eth, crypto) instance */
484 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
485 RTE_INIT(pciinitfn_ ##nm); \
486 static void pciinitfn_ ##nm(void) \
488 (pci_drv).driver.name = RTE_STR(nm);\
489 rte_pci_register(&pci_drv); \
491 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
494 * Unregister a PCI driver.
497 * A pointer to a rte_pci_driver structure describing the driver
498 * to be unregistered.
500 void rte_pci_unregister(struct rte_pci_driver *driver);
503 * Read PCI config space.
506 * A pointer to a rte_pci_device structure describing the device
509 * A data buffer where the bytes should be read into
511 * The length of the data buffer.
513 * The offset into PCI config space
515 int rte_pci_read_config(const struct rte_pci_device *device,
516 void *buf, size_t len, off_t offset);
519 * Write PCI config space.
522 * A pointer to a rte_pci_device structure describing the device
525 * A data buffer containing the bytes should be written
527 * The length of the data buffer.
529 * The offset into PCI config space
531 int rte_pci_write_config(const struct rte_pci_device *device,
532 const void *buf, size_t len, off_t offset);
535 * A structure used to access io resources for a pci device.
536 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
539 struct rte_pci_ioport {
540 struct rte_pci_device *dev;
542 uint64_t len; /* only filled for memory mapped ports */
546 * Initialize a rte_pci_ioport object for a pci device io resource.
548 * This object is then used to gain access to those io resources (see below).
551 * A pointer to a rte_pci_device structure describing the device
554 * Index of the io pci resource we want to access.
556 * The rte_pci_ioport object to be initialized.
558 * 0 on success, negative on error.
560 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
561 struct rte_pci_ioport *p);
564 * Release any resources used in a rte_pci_ioport object.
567 * The rte_pci_ioport object to be uninitialized.
569 * 0 on success, negative on error.
571 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
574 * Read from a io pci resource.
577 * The rte_pci_ioport object from which we want to read.
579 * A data buffer where the bytes should be read into
581 * The length of the data buffer.
583 * The offset into the pci io resource.
585 void rte_pci_ioport_read(struct rte_pci_ioport *p,
586 void *data, size_t len, off_t offset);
589 * Write to a io pci resource.
592 * The rte_pci_ioport object to which we want to write.
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_pci_ioport_write(struct rte_pci_ioport *p,
601 const void *data, size_t len, off_t offset);
607 #endif /* _RTE_PCI_H_ */