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. */
121 * A structure describing a PCI device.
123 struct rte_pci_device {
124 TAILQ_ENTRY(rte_pci_device) next; /**< Next probed PCI device. */
125 struct rte_device device; /**< Inherit core device */
126 struct rte_pci_addr addr; /**< PCI location. */
127 struct rte_pci_id id; /**< PCI ID. */
128 struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
129 /**< PCI Memory Resource */
130 struct rte_intr_handle intr_handle; /**< Interrupt handle */
131 struct rte_pci_driver *driver; /**< Associated driver */
132 uint16_t max_vfs; /**< sriov enable if not zero */
133 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
134 char name[PCI_PRI_STR_SIZE+1]; /**< PCI location (ASCII) */
139 * Helper macro for drivers that need to convert to struct rte_pci_device.
141 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
143 /** Any PCI device identifier (vendor, device, ...) */
144 #define PCI_ANY_ID (0xffff)
145 #define RTE_CLASS_ANY_ID (0xffffff)
148 /** C++ macro used to help building up tables of device IDs */
149 #define RTE_PCI_DEVICE(vend, dev) \
156 /** Macro used to help building up tables of device IDs */
157 #define RTE_PCI_DEVICE(vend, dev) \
158 .class_id = RTE_CLASS_ANY_ID, \
159 .vendor_id = (vend), \
160 .device_id = (dev), \
161 .subsystem_vendor_id = PCI_ANY_ID, \
162 .subsystem_device_id = PCI_ANY_ID
166 * Initialisation function for the driver called during PCI probing.
168 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
171 * Uninitialisation function for the driver called during hotplugging.
173 typedef int (pci_remove_t)(struct rte_pci_device *);
176 * A structure describing a PCI driver.
178 struct rte_pci_driver {
179 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
180 struct rte_driver driver; /**< Inherit core driver. */
181 struct rte_pci_bus *bus; /**< PCI bus reference. */
182 pci_probe_t *probe; /**< Device Probe function. */
183 pci_remove_t *remove; /**< Device Remove function. */
184 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
185 uint32_t drv_flags; /**< Flags contolling handling of device. */
189 * Structure describing the PCI bus
192 struct rte_bus bus; /**< Inherit the generic class */
193 struct rte_pci_device_list device_list; /**< List of PCI devices */
194 struct rte_pci_driver_list driver_list; /**< List of PCI drivers */
197 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
198 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
199 /** Device driver supports link state interrupt */
200 #define RTE_PCI_DRV_INTR_LSC 0x0008
201 /** Device driver supports device removal interrupt */
202 #define RTE_PCI_DRV_INTR_RMV 0x0010
203 /** Device driver needs to keep mapped resources if unsupported dev detected */
204 #define RTE_PCI_DRV_KEEP_MAPPED_RES 0x0020
205 /** Device driver supports IOVA as VA */
206 #define RTE_PCI_DRV_IOVA_AS_VA 0X0040
209 * A structure describing a PCI mapping.
219 struct pci_msix_table {
226 * A structure describing a mapped PCI resource.
227 * For multi-process we need to reproduce all PCI mappings in secondary
228 * processes, so save them in a tailq.
230 struct mapped_pci_resource {
231 TAILQ_ENTRY(mapped_pci_resource) next;
233 struct rte_pci_addr pci_addr;
236 struct pci_map maps[PCI_MAX_RESOURCE];
237 struct pci_msix_table msix_table;
240 /** mapped pci device list */
241 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
244 * Utility function to produce a PCI Bus-Device-Function value
245 * given a string representation. Assumes that the BDF is provided without
246 * a domain prefix (i.e. domain returned is always 0)
249 * The input string to be parsed. Should have the format XX:XX.X
251 * The PCI Bus-Device-Function address to be returned. Domain will always be
254 * 0 on success, negative on error.
256 int rte_pci_bdf_parse(const char *input, struct rte_pci_addr *dev_addr);
260 * Utility function to produce a PCI Bus-Device-Function value
261 * given a string representation. Assumes that the BDF is provided without
262 * a domain prefix (i.e. domain returned is always 0)
265 * The input string to be parsed. Should have the format XX:XX.X
267 * The PCI Bus-Device-Function address to be returned. Domain will always be
270 * 0 on success, negative on error.
272 int eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr);
275 * Utility function to produce a PCI Bus-Device-Function value
276 * given a string representation. Assumes that the BDF is provided including
280 * The input string to be parsed. Should have the format XXXX:XX:XX.X
282 * The PCI Bus-Device-Function address to be returned
284 * 0 on success, negative on error.
286 int rte_pci_dbdf_parse(const char *input, struct rte_pci_addr *dev_addr);
290 * Utility function to produce a PCI Bus-Device-Function value
291 * given a string representation. Assumes that the BDF is provided including
295 * The input string to be parsed. Should have the format XXXX:XX:XX.X
297 * The PCI Bus-Device-Function address to be returned
299 * 0 on success, negative on error.
301 int eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr);
304 * Utility function to write a pci device name, this device name can later be
305 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
309 * The PCI Bus-Device-Function address
311 * The output buffer string
313 * The output buffer size
315 void rte_pci_device_name(const struct rte_pci_addr *addr, char *output,
319 * Utility function to compare two PCI device addresses.
322 * The PCI Bus-Device-Function address to compare
324 * The PCI Bus-Device-Function address to compare
326 * 0 on equal PCI address.
327 * Positive on addr is greater than addr2.
328 * Negative on addr is less than addr2, or error.
330 int rte_pci_addr_cmp(const struct rte_pci_addr *addr,
331 const struct rte_pci_addr *addr2);
335 * Utility function to compare two PCI device addresses.
338 * The PCI Bus-Device-Function address to compare
340 * The PCI Bus-Device-Function address to compare
342 * 0 on equal PCI address.
343 * Positive on addr is greater than addr2.
344 * Negative on addr is less than addr2, or error.
346 int rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
347 const struct rte_pci_addr *addr2);
350 * Utility function to parse a string into a PCI location.
353 * The string to parse
355 * The reference to the structure where the location
361 int rte_pci_addr_parse(const char *str, struct rte_pci_addr *addr);
364 * Scan the content of the PCI bus, and the devices in the devices
368 * 0 on success, negative on error
370 int rte_pci_scan(void);
383 * Match the PCI Driver and Device using the ID Table
386 * PCI driver from which ID table would be extracted
388 * PCI device to match against the driver
390 * 1 for successful match
391 * 0 for unsuccessful match
394 rte_pci_match(const struct rte_pci_driver *pci_drv,
395 const struct rte_pci_device *pci_dev);
399 * Get iommu class of PCI devices on the bus.
400 * And return their preferred iova mapping mode.
403 * - enum rte_iova_mode.
406 rte_pci_get_iommu_class(void);
409 * Map the PCI device resources in user space virtual memory address
411 * Note that driver should not call this function when flag
412 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
416 * A pointer to a rte_pci_device structure describing the device
420 * 0 on success, negative on error and positive if no driver
421 * is found for the device.
423 int rte_pci_map_device(struct rte_pci_device *dev);
429 * A pointer to a rte_pci_device structure describing the device
432 void rte_pci_unmap_device(struct rte_pci_device *dev);
436 * Map a particular resource from a file.
438 * @param requested_addr
439 * The starting address for the new mapping range.
441 * The file descriptor.
443 * The offset for the mapping range.
445 * The size for the mapping range.
446 * @param additional_flags
447 * The additional flags for the mapping range.
449 * - On success, the function returns a pointer to the mapped area.
450 * - On error, the value MAP_FAILED is returned.
452 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
453 size_t size, int additional_flags);
457 * Unmap a particular resource.
459 * @param requested_addr
460 * The address for the unmapping range.
462 * The size for the unmapping range.
464 void pci_unmap_resource(void *requested_addr, size_t size);
467 * Probe 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 probe() 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 probe.
477 * - Negative on error.
479 int rte_pci_probe_one(const struct rte_pci_addr *addr);
482 * Close the single PCI device.
484 * Scan the content of the PCI bus, and find the pci device specified by pci
485 * address, then call the remove() function for registered driver that has a
486 * matching entry in its id_table for discovered device.
489 * The PCI Bus-Device-Function address to close.
492 * - Negative on error.
494 int rte_pci_detach(const struct rte_pci_addr *addr);
497 * Dump the content of the PCI bus.
500 * A pointer to a file for output
502 void rte_pci_dump(FILE *f);
505 * Register a PCI driver.
508 * A pointer to a rte_pci_driver structure describing the driver
511 void rte_pci_register(struct rte_pci_driver *driver);
513 /** Helper for PCI device registration from driver (eth, crypto) instance */
514 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
515 RTE_INIT(pciinitfn_ ##nm); \
516 static void pciinitfn_ ##nm(void) \
518 (pci_drv).driver.name = RTE_STR(nm);\
519 rte_pci_register(&pci_drv); \
521 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
524 * Unregister a PCI driver.
527 * A pointer to a rte_pci_driver structure describing the driver
528 * to be unregistered.
530 void rte_pci_unregister(struct rte_pci_driver *driver);
533 * Read PCI config space.
536 * A pointer to a rte_pci_device structure describing the device
539 * A data buffer where the bytes should be read into
541 * The length of the data buffer.
543 * The offset into PCI config space
545 int rte_pci_read_config(const struct rte_pci_device *device,
546 void *buf, size_t len, off_t offset);
549 * Write PCI config space.
552 * A pointer to a rte_pci_device structure describing the device
555 * A data buffer containing the bytes should be written
557 * The length of the data buffer.
559 * The offset into PCI config space
561 int rte_pci_write_config(const struct rte_pci_device *device,
562 const void *buf, size_t len, off_t offset);
565 * A structure used to access io resources for a pci device.
566 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
569 struct rte_pci_ioport {
570 struct rte_pci_device *dev;
572 uint64_t len; /* only filled for memory mapped ports */
576 * Initialize a rte_pci_ioport object for a pci device io resource.
578 * This object is then used to gain access to those io resources (see below).
581 * A pointer to a rte_pci_device structure describing the device
584 * Index of the io pci resource we want to access.
586 * The rte_pci_ioport object to be initialized.
588 * 0 on success, negative on error.
590 int rte_pci_ioport_map(struct rte_pci_device *dev, int bar,
591 struct rte_pci_ioport *p);
594 * Release any resources used in a rte_pci_ioport object.
597 * The rte_pci_ioport object to be uninitialized.
599 * 0 on success, negative on error.
601 int rte_pci_ioport_unmap(struct rte_pci_ioport *p);
604 * Read from a io pci resource.
607 * The rte_pci_ioport object from which we want to read.
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_pci_ioport_read(struct rte_pci_ioport *p,
616 void *data, size_t len, off_t offset);
619 * Write to a io pci resource.
622 * The rte_pci_ioport object to which we want to write.
624 * A data buffer where the bytes should be read into
626 * The length of the data buffer.
628 * The offset into the pci io resource.
630 void rte_pci_ioport_write(struct rte_pci_ioport *p,
631 const void *data, size_t len, off_t offset);
637 #endif /* _RTE_PCI_H_ */