1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2015 Intel Corporation.
3 * Copyright 2013-2014 6WIND S.A.
21 #include <sys/queue.h>
23 #include <sys/types.h>
25 /** Formatting string for PCI device identifier: Ex: 0000:00:01.0 */
26 #define PCI_PRI_FMT "%.4" PRIx32 ":%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
27 #define PCI_PRI_STR_SIZE sizeof("XXXXXXXX:XX:XX.X")
29 /** Short formatting string, without domain, for PCI device: Ex: 00:01.0 */
30 #define PCI_SHORT_PRI_FMT "%.2" PRIx8 ":%.2" PRIx8 ".%" PRIx8
32 /** Nb. of values in PCI device identifier format string. */
33 #define PCI_FMT_NVAL 4
35 /** Nb. of values in PCI resource format. */
36 #define PCI_RESOURCE_FMT_NVAL 3
38 /** Maximum number of PCI resources. */
39 #define PCI_MAX_RESOURCE 6
42 * A structure describing an ID for a PCI driver. Each driver provides a
43 * table of these IDs for each device that it supports.
46 uint32_t class_id; /**< Class ID or RTE_CLASS_ANY_ID. */
47 uint16_t vendor_id; /**< Vendor ID or PCI_ANY_ID. */
48 uint16_t device_id; /**< Device ID or PCI_ANY_ID. */
49 uint16_t subsystem_vendor_id; /**< Subsystem vendor ID or PCI_ANY_ID. */
50 uint16_t subsystem_device_id; /**< Subsystem device ID or PCI_ANY_ID. */
54 * A structure describing the location of a PCI device.
57 uint32_t domain; /**< Device domain */
58 uint8_t bus; /**< Device bus */
59 uint8_t devid; /**< Device ID */
60 uint8_t function; /**< Device function. */
63 /** Any PCI device identifier (vendor, device, ...) */
64 #define PCI_ANY_ID (0xffff)
65 #define RTE_CLASS_ANY_ID (0xffffff)
68 * A structure describing a PCI mapping.
78 struct pci_msix_table {
85 * A structure describing a mapped PCI resource.
86 * For multi-process we need to reproduce all PCI mappings in secondary
87 * processes, so save them in a tailq.
89 struct mapped_pci_resource {
90 TAILQ_ENTRY(mapped_pci_resource) next;
92 struct rte_pci_addr pci_addr;
95 struct pci_map maps[PCI_MAX_RESOURCE];
96 struct pci_msix_table msix_table;
100 /** mapped pci device list */
101 TAILQ_HEAD(mapped_pci_res_list, mapped_pci_resource);
104 * Utility function to write a pci device name, this device name can later be
105 * used to retrieve the corresponding rte_pci_addr using eal_parse_pci_*
109 * The PCI Bus-Device-Function address
111 * The output buffer string
113 * The output buffer size
115 void rte_pci_device_name(const struct rte_pci_addr *addr,
116 char *output, size_t size);
119 * Utility function to compare two PCI device addresses.
122 * The PCI Bus-Device-Function address to compare
124 * The PCI Bus-Device-Function address to compare
126 * 0 on equal PCI address.
127 * Positive on addr is greater than addr2.
128 * Negative on addr is less than addr2, or error.
130 int rte_pci_addr_cmp(const struct rte_pci_addr *addr,
131 const struct rte_pci_addr *addr2);
135 * Utility function to parse a string into a PCI location.
138 * The string to parse
140 * The reference to the structure where the location
146 int rte_pci_addr_parse(const char *str, struct rte_pci_addr *addr);
149 * Map a particular resource from a file.
151 * @param requested_addr
152 * The starting address for the new mapping range.
154 * The file descriptor.
156 * The offset for the mapping range.
158 * The size for the mapping range.
159 * @param additional_flags
160 * The additional flags for the mapping range.
162 * - On success, the function returns a pointer to the mapped area.
163 * - On error, MAP_FAILED is returned.
165 void *pci_map_resource(void *requested_addr, int fd, off_t offset,
166 size_t size, int additional_flags);
169 * Unmap a particular resource.
171 * @param requested_addr
172 * The address for the unmapping range.
174 * The size for the unmapping range.
176 void pci_unmap_resource(void *requested_addr, size_t size);
182 #endif /* _RTE_PCI_H_ */