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_device device; /**< Inherit core device */
153 struct rte_pci_addr addr; /**< PCI location. */
154 struct rte_pci_id id; /**< PCI ID. */
155 struct rte_mem_resource mem_resource[PCI_MAX_RESOURCE];
156 /**< PCI Memory Resource */
157 struct rte_intr_handle intr_handle; /**< Interrupt handle */
158 struct rte_pci_driver *driver; /**< Associated driver */
159 uint16_t max_vfs; /**< sriov enable if not zero */
160 enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
165 * Helper macro for drivers that need to convert to struct rte_pci_device.
167 #define RTE_DEV_TO_PCI(ptr) container_of(ptr, struct rte_pci_device, device)
169 /** Any PCI device identifier (vendor, device, ...) */
170 #define PCI_ANY_ID (0xffff)
171 #define RTE_CLASS_ANY_ID (0xffffff)
174 /** C++ macro used to help building up tables of device IDs */
175 #define RTE_PCI_DEVICE(vend, dev) \
182 /** Macro used to help building up tables of device IDs */
183 #define RTE_PCI_DEVICE(vend, dev) \
184 .class_id = RTE_CLASS_ANY_ID, \
185 .vendor_id = (vend), \
186 .device_id = (dev), \
187 .subsystem_vendor_id = PCI_ANY_ID, \
188 .subsystem_device_id = PCI_ANY_ID
191 struct rte_pci_driver;
194 * Initialisation function for the driver called during PCI probing.
196 typedef int (pci_probe_t)(struct rte_pci_driver *, struct rte_pci_device *);
199 * Uninitialisation function for the driver called during hotplugging.
201 typedef int (pci_remove_t)(struct rte_pci_device *);
204 * A structure describing a PCI driver.
206 struct rte_pci_driver {
207 TAILQ_ENTRY(rte_pci_driver) next; /**< Next in list. */
208 struct rte_driver driver; /**< Inherit core driver. */
209 pci_probe_t *probe; /**< Device Probe function. */
210 pci_remove_t *remove; /**< Device Remove function. */
211 const struct rte_pci_id *id_table; /**< ID table, NULL terminated. */
212 uint32_t drv_flags; /**< Flags contolling handling of device. */
215 /** Device needs PCI BAR mapping (done with either IGB_UIO or VFIO) */
216 #define RTE_PCI_DRV_NEED_MAPPING 0x0001
217 /** Device driver supports link state interrupt */
218 #define RTE_PCI_DRV_INTR_LSC 0x0008
221 * A structure describing a PCI mapping.
232 * A structure describing a mapped PCI resource.
233 * For multi-process we need to reproduce all PCI mappings in secondary
234 * processes, so save them in a tailq.
236 struct mapped_pci_resource {
237 TAILQ_ENTRY(mapped_pci_resource) next;
239 struct rte_pci_addr pci_addr;
242 struct pci_map maps[PCI_MAX_RESOURCE];
245 /** mapped pci device list */
246 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
248 /**< Internal use only - Macro used by pci addr parsing functions **/
249 #define GET_PCIADDR_FIELD(in, fd, lim, dlm) \
254 val = strtoul((in), &end, 16); \
255 if (errno != 0 || end[0] != (dlm) || val > (lim)) \
257 (fd) = (typeof (fd))val; \
262 * Utility function to produce a PCI Bus-Device-Function value
263 * given a string representation. Assumes that the BDF is provided without
264 * a domain prefix (i.e. domain returned is always 0)
267 * The input string to be parsed. Should have the format XX:XX.X
269 * The PCI Bus-Device-Function address to be returned. Domain will always be
272 * 0 on success, negative on error.
275 eal_parse_pci_BDF(const char *input, struct rte_pci_addr *dev_addr)
277 dev_addr->domain = 0;
278 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
279 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
280 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
285 * Utility function to produce a PCI Bus-Device-Function value
286 * given a string representation. Assumes that the BDF is provided including
290 * The input string to be parsed. Should have the format XXXX:XX:XX.X
292 * The PCI Bus-Device-Function address to be returned
294 * 0 on success, negative on error.
297 eal_parse_pci_DomBDF(const char *input, struct rte_pci_addr *dev_addr)
299 GET_PCIADDR_FIELD(input, dev_addr->domain, UINT16_MAX, ':');
300 GET_PCIADDR_FIELD(input, dev_addr->bus, UINT8_MAX, ':');
301 GET_PCIADDR_FIELD(input, dev_addr->devid, UINT8_MAX, '.');
302 GET_PCIADDR_FIELD(input, dev_addr->function, UINT8_MAX, 0);
305 #undef GET_PCIADDR_FIELD
308 * Utility function to write a pci device name, this device name can later be
309 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
313 * The PCI Bus-Device-Function address
315 * The output buffer string
317 * The output buffer size
320 rte_eal_pci_device_name(const struct rte_pci_addr *addr,
321 char *output, size_t size)
323 RTE_VERIFY(size >= PCI_PRI_STR_SIZE);
324 RTE_VERIFY(snprintf(output, size, PCI_PRI_FMT,
325 addr->domain, addr->bus,
326 addr->devid, addr->function) >= 0);
329 /* Compare two PCI device addresses. */
331 * Utility function to compare two PCI device addresses.
334 * The PCI Bus-Device-Function address to compare
336 * The PCI Bus-Device-Function address to compare
338 * 0 on equal PCI address.
339 * Positive on addr is greater than addr2.
340 * Negative on addr is less than addr2, or error.
343 rte_eal_compare_pci_addr(const struct rte_pci_addr *addr,
344 const struct rte_pci_addr *addr2)
346 uint64_t dev_addr, dev_addr2;
348 if ((addr == NULL) || (addr2 == NULL))
351 dev_addr = (addr->domain << 24) | (addr->bus << 16) |
352 (addr->devid << 8) | addr->function;
353 dev_addr2 = (addr2->domain << 24) | (addr2->bus << 16) |
354 (addr2->devid << 8) | addr2->function;
356 if (dev_addr > dev_addr2)
358 else if (dev_addr < dev_addr2)
365 * Scan the content of the PCI bus, and the devices in the devices
369 * 0 on success, negative on error
371 int rte_eal_pci_scan(void);
374 * Probe the PCI bus for registered drivers.
376 * Scan the content of the PCI bus, and call the probe() function for
377 * all registered drivers that have a matching entry in its id_table
378 * for discovered devices.
382 * - Negative on error.
384 int rte_eal_pci_probe(void);
387 * Map the PCI device resources in user space virtual memory address
389 * Note that driver should not call this function when flag
390 * RTE_PCI_DRV_NEED_MAPPING is set, as EAL will do that for
394 * A pointer to a rte_pci_device structure describing the device
398 * 0 on success, negative on error and positive if no driver
399 * is found for the device.
401 int rte_eal_pci_map_device(struct rte_pci_device *dev);
407 * A pointer to a rte_pci_device structure describing the device
410 void rte_eal_pci_unmap_device(struct rte_pci_device *dev);
414 * Map a particular resource from a file.
416 * @param requested_addr
417 * The starting address for the new mapping range.
419 * The file descriptor.
421 * The offset for the mapping range.
423 * The size for the mapping range.
424 * @param additional_flags
425 * The additional flags for the mapping range.
427 * - On success, the function returns a pointer to the mapped area.
428 * - On error, the value MAP_FAILED is returned.
430 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
431 size_t size, int additional_flags);
435 * Unmap a particular resource.
437 * @param requested_addr
438 * The address for the unmapping range.
440 * The size for the unmapping range.
442 void pci_unmap_resource(void *requested_addr, size_t size);
445 * Probe the single PCI device.
447 * Scan the content of the PCI bus, and find the pci device specified by pci
448 * address, then call the probe() function for registered driver that has a
449 * matching entry in its id_table for discovered device.
452 * The PCI Bus-Device-Function address to probe.
455 * - Negative on error.
457 int rte_eal_pci_probe_one(const struct rte_pci_addr *addr);
460 * Close the single PCI device.
462 * Scan the content of the PCI bus, and find the pci device specified by pci
463 * address, then call the remove() function for registered driver that has a
464 * matching entry in its id_table for discovered device.
467 * The PCI Bus-Device-Function address to close.
470 * - Negative on error.
472 int rte_eal_pci_detach(const struct rte_pci_addr *addr);
475 * Dump the content of the PCI bus.
478 * A pointer to a file for output
480 void rte_eal_pci_dump(FILE *f);
483 * Register a PCI driver.
486 * A pointer to a rte_pci_driver structure describing the driver
489 void rte_eal_pci_register(struct rte_pci_driver *driver);
491 /** Helper for PCI device registration from driver (eth, crypto) instance */
492 #define RTE_PMD_REGISTER_PCI(nm, pci_drv) \
493 RTE_INIT(pciinitfn_ ##nm); \
494 static void pciinitfn_ ##nm(void) \
496 (pci_drv).driver.name = RTE_STR(nm);\
497 rte_eal_pci_register(&pci_drv); \
499 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
502 * Unregister a PCI driver.
505 * A pointer to a rte_pci_driver structure describing the driver
506 * to be unregistered.
508 void rte_eal_pci_unregister(struct rte_pci_driver *driver);
511 * Read PCI config space.
514 * A pointer to a rte_pci_device structure describing the device
517 * A data buffer where the bytes should be read into
519 * The length of the data buffer.
521 * The offset into PCI config space
523 int rte_eal_pci_read_config(const struct rte_pci_device *device,
524 void *buf, size_t len, off_t offset);
527 * Write PCI config space.
530 * A pointer to a rte_pci_device structure describing the device
533 * A data buffer containing the bytes should be written
535 * The length of the data buffer.
537 * The offset into PCI config space
539 int rte_eal_pci_write_config(const struct rte_pci_device *device,
540 const void *buf, size_t len, off_t offset);
543 * A structure used to access io resources for a pci device.
544 * rte_pci_ioport is arch, os, driver specific, and should not be used outside
547 struct rte_pci_ioport {
548 struct rte_pci_device *dev;
550 uint64_t len; /* only filled for memory mapped ports */
554 * Initialize a rte_pci_ioport object for a pci device io resource.
556 * This object is then used to gain access to those io resources (see below).
559 * A pointer to a rte_pci_device structure describing the device
562 * Index of the io pci resource we want to access.
564 * The rte_pci_ioport object to be initialized.
566 * 0 on success, negative on error.
568 int rte_eal_pci_ioport_map(struct rte_pci_device *dev, int bar,
569 struct rte_pci_ioport *p);
572 * Release any resources used in a rte_pci_ioport object.
575 * The rte_pci_ioport object to be uninitialized.
577 * 0 on success, negative on error.
579 int rte_eal_pci_ioport_unmap(struct rte_pci_ioport *p);
582 * Read from a io pci resource.
585 * The rte_pci_ioport object from which we want to read.
587 * A data buffer where the bytes should be read into
589 * The length of the data buffer.
591 * The offset into the pci io resource.
593 void rte_eal_pci_ioport_read(struct rte_pci_ioport *p,
594 void *data, size_t len, off_t offset);
597 * Write to a io pci resource.
600 * The rte_pci_ioport object to which we want to write.
602 * A data buffer where the bytes should be read into
604 * The length of the data buffer.
606 * The offset into the pci io resource.
608 void rte_eal_pci_ioport_write(struct rte_pci_ioport *p,
609 const void *data, size_t len, off_t offset);
615 #endif /* _RTE_PCI_H_ */