4 * Copyright (c) 1997--2024 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL v2+
8 * SPDX-License-Identifier: GPL-2.0-or-later
21 #define PCI_LIB_VERSION 0x030d00
28 * PCI Access Structure
33 enum pci_access_type {
34 /* Known access methods, remember to update init.c as well */
35 PCI_ACCESS_AUTO, /* Autodetection */
36 PCI_ACCESS_SYS_BUS_PCI, /* Linux /sys/bus/pci */
37 PCI_ACCESS_PROC_BUS_PCI, /* Linux /proc/bus/pci */
38 PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 */
39 PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 */
40 PCI_ACCESS_FBSD_DEVICE, /* FreeBSD /dev/pci */
41 PCI_ACCESS_AIX_DEVICE, /* /dev/pci0, /dev/bus0, etc. */
42 PCI_ACCESS_NBSD_LIBPCI, /* NetBSD libpci */
43 PCI_ACCESS_OBSD_DEVICE, /* OpenBSD /dev/pci */
44 PCI_ACCESS_DUMP, /* Dump file */
45 PCI_ACCESS_DARWIN, /* Darwin */
46 PCI_ACCESS_SYLIXOS_DEVICE, /* SylixOS pci */
47 PCI_ACCESS_HURD, /* GNU/Hurd */
48 PCI_ACCESS_WIN32_CFGMGR32, /* Win32 cfgmgr32.dll */
49 PCI_ACCESS_WIN32_KLDBG, /* Win32 kldbgdrv.sys */
50 PCI_ACCESS_WIN32_SYSDBG, /* Win32 NT SysDbg */
51 PCI_ACCESS_MMIO_TYPE1, /* MMIO ports, type 1 */
52 PCI_ACCESS_MMIO_TYPE1_EXT, /* MMIO ports, type 1 extended */
53 PCI_ACCESS_ECAM, /* PCIe ECAM via /dev/mem */
54 PCI_ACCESS_AOS_EXPANSION, /* AmigaOS Expansion library */
59 /* Options you can change: */
60 unsigned int method; /* Access method */
61 int writeable; /* Open in read/write mode */
62 int buscentric; /* Bus-centric view of the world */
64 char *id_file_name; /* Name of ID list file (use pci_set_name_list_path()) */
65 int free_id_name; /* Set if id_file_name is malloced */
66 int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
68 unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */
69 /* Default: PCI_LOOKUP_CACHE */
71 int debugging; /* Turn on debugging messages */
73 /* Functions you can override: */
74 void (*error)(char *msg, ...) PCI_PRINTF(1,2) PCI_NONRET; /* Write error message and quit */
75 void (*warning)(char *msg, ...) PCI_PRINTF(1,2); /* Write a warning message */
76 void (*debug)(char *msg, ...) PCI_PRINTF(1,2); /* Write a debugging message */
78 struct pci_dev *devices; /* Devices found on this bus */
80 /* Fields used internally: */
81 struct pci_methods *methods;
82 struct pci_param *params;
83 struct id_entry **id_hash; /* names.c */
84 struct id_bucket *current_id_bucket;
85 int id_load_attempted;
86 int id_cache_status; /* 0=not read, 1=read, 2=dirty */
88 struct udev *id_udev; /* names-hwdb.c */
89 struct udev_hwdb *id_udev_hwdb;
90 int fd; /* proc/sys: fd for config space */
91 int fd_rw; /* proc/sys: fd opened read-write */
92 int fd_vpd; /* sys: fd for VPD */
93 struct pci_dev *cached_dev; /* proc/sys: device the fds are for */
94 void *backend_data; /* Private data of the back end */
97 /* Initialize PCI access */
98 struct pci_access *pci_alloc(void) PCI_ABI;
99 void pci_init(struct pci_access *) PCI_ABI;
100 void pci_cleanup(struct pci_access *) PCI_ABI;
102 /* Scanning of devices */
103 void pci_scan_bus(struct pci_access *acc) PCI_ABI;
104 struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func) PCI_ABI; /* Raw access to specified device */
105 void pci_free_dev(struct pci_dev *) PCI_ABI;
107 /* Names of access methods */
108 int pci_lookup_method(char *name) PCI_ABI; /* Returns -1 if not found */
109 char *pci_get_method_name(int index) PCI_ABI; /* Returns "" if unavailable, NULL if index out of range */
116 struct pci_param *next; /* Please use pci_walk_params() for traversing the list */
117 char *param; /* Name of the parameter */
118 char *value; /* Value of the parameter */
119 int value_malloced; /* used internally */
120 char *help; /* Explanation of the parameter */
123 char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI;
124 int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI; /* 0 on success, -1 if no such parameter */
125 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
126 struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI;
133 struct pci_dev *next; /* Next device in the chain */
134 u16 domain_16; /* 16-bit version of the PCI domain for backward compatibility */
135 /* 0xffff if the real domain doesn't fit in 16 bits */
136 u8 bus, dev, func; /* Bus inside domain, device and function */
138 /* These fields are set by pci_fill_info() */
139 unsigned int known_fields; /* Set of info fields already known (see pci_fill_info()) */
140 u16 vendor_id, device_id; /* Identity of the device */
141 u16 device_class; /* PCI device class */
142 int irq; /* IRQ number */
143 pciaddr_t base_addr[6]; /* Base addresses including flags in lower bits */
144 pciaddr_t size[6]; /* Region sizes */
145 pciaddr_t rom_base_addr; /* Expansion ROM base address */
146 pciaddr_t rom_size; /* Expansion ROM size */
147 struct pci_cap *first_cap; /* List of capabilities */
148 char *phy_slot; /* Physical slot */
149 char *module_alias; /* Linux kernel module alias */
150 char *label; /* Device name as exported by BIOS */
151 int numa_node; /* NUMA node */
152 pciaddr_t flags[6]; /* PCI_IORESOURCE_* flags for regions */
153 pciaddr_t rom_flags; /* PCI_IORESOURCE_* flags for expansion ROM */
154 int domain; /* PCI domain (host bridge) */
155 pciaddr_t bridge_base_addr[4]; /* Bridge base addresses (without flags) */
156 pciaddr_t bridge_size[4]; /* Bridge sizes */
157 pciaddr_t bridge_flags[4]; /* PCI_IORESOURCE_* flags for bridge addresses */
158 u8 prog_if, rev_id; /* Programming interface for device_class and revision id */
159 u16 subsys_vendor_id, subsys_id; /* Subsystem vendor id and subsystem id */
160 struct pci_dev *parent; /* Parent device, does not have to be always accessible */
161 int no_config_access; /* No access to config space for this device */
162 u32 rcd_link_cap; /* Link Capabilities register for Restricted CXL Devices */
163 u16 rcd_link_status; /* Link Status register for RCD */
164 u16 rcd_link_ctrl; /* Link Control register for RCD */
166 /* Fields used internally */
167 struct pci_access *access;
168 struct pci_methods *methods;
169 u8 *cache; /* Cached config registers */
171 int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
172 void *backend_data; /* Private data for of the back end */
173 struct pci_property *properties; /* A linked list of extra properties */
174 struct pci_cap *last_cap; /* Last capability in the list */
177 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
178 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
179 #define PCI_ADDR_FLAG_MASK 0xf
181 /* Access to configuration space */
182 u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI;
183 u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
184 u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
185 int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI;
186 int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
187 int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
188 int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
190 /* Configuration space as a sequence of bytes (little-endian) */
191 int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
192 int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
195 * Most device properties take some effort to obtain, so libpci does not
196 * initialize them during default bus scan. Instead, you have to call
197 * pci_fill_info() with the proper PCI_FILL_xxx constants OR'ed together.
199 * Some properties are stored directly in the pci_dev structure.
200 * The remaining ones can be accessed through pci_get_string_property().
202 * pci_fill_info() returns the current value of pci_dev->known_fields.
203 * This is a bit mask of all fields, which were already obtained during
204 * the lifetime of the device. This includes fields which are not supported
205 * by the particular device -- in that case, the field is left at its default
206 * value, which is 0 for integer fields and NULL for pointers. On the other
207 * hand, we never consider known fields unsupported by the current back-end;
208 * such fields always contain the default value.
210 * XXX: flags and the result should be unsigned, but we do not want to break the ABI.
213 int pci_fill_info(struct pci_dev *, int flags) PCI_ABI;
214 char *pci_get_string_property(struct pci_dev *d, u32 prop) PCI_ABI;
216 #define PCI_FILL_IDENT 0x0001 /* vendor and device ID */
217 #define PCI_FILL_IRQ 0x0002
218 #define PCI_FILL_BASES 0x0004
219 #define PCI_FILL_ROM_BASE 0x0008
220 #define PCI_FILL_SIZES 0x0010
221 #define PCI_FILL_CLASS 0x0020
222 #define PCI_FILL_CAPS 0x0040 /* capabilities */
223 #define PCI_FILL_EXT_CAPS 0x0080 /* extended capabilities */
224 #define PCI_FILL_PHYS_SLOT 0x0100 /* physical slot (string property) */
225 #define PCI_FILL_MODULE_ALIAS 0x0200 /* Linux kernel module alias (string property) */
226 #define PCI_FILL_LABEL 0x0400 /* (string property) */
227 #define PCI_FILL_NUMA_NODE 0x0800
228 #define PCI_FILL_IO_FLAGS 0x1000
229 #define PCI_FILL_DT_NODE 0x2000 /* Device tree node (string property) */
230 #define PCI_FILL_IOMMU_GROUP 0x4000 /* (string property) */
231 #define PCI_FILL_BRIDGE_BASES 0x8000
232 #define PCI_FILL_RESCAN 0x00010000 /* force re-scan of cached properties */
233 #define PCI_FILL_CLASS_EXT 0x00020000 /* prog_if and rev_id */
234 #define PCI_FILL_SUBSYS 0x00040000 /* subsys_vendor_id and subsys_id */
235 #define PCI_FILL_PARENT 0x00080000
236 #define PCI_FILL_DRIVER 0x00100000 /* OS driver currently in use (string property) */
237 #define PCI_FILL_RCD_LNK 0x00200000 /* CXL RCD Link status properties (rcd_*) */
239 void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI;
246 struct pci_cap *next;
247 u16 id; /* PCI_CAP_ID_xxx */
248 u16 type; /* PCI_CAP_xxx */
249 unsigned int addr; /* Position in the config space */
252 #define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */
253 #define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */
255 struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI;
256 struct pci_cap *pci_find_cap_nr(struct pci_dev *, unsigned int id, unsigned int type,
257 unsigned int *cap_number) PCI_ABI;
264 int domain, bus, slot, func; /* -1 = ANY */
267 unsigned int device_class_mask; /* Which bits of the device_class are compared, default=all */
272 void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI;
273 char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI;
274 char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI;
275 int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI;
278 * Conversion of PCI ID's to names (according to the pci.ids file)
280 * Call pci_lookup_name() to identify different types of ID's:
282 * VENDOR (vendorID) -> vendor
283 * DEVICE (vendorID, deviceID) -> device
284 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
285 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
286 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
287 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
288 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
289 * CLASS (classID) -> class
290 * PROGIF (classID, progif) -> programming interface
293 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI;
295 int pci_load_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_lookup_*() when needed; returns success */
296 void pci_free_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_cleanup() */
297 void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI;
298 void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
300 enum pci_lookup_mode {
301 PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
302 PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
303 PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
304 PCI_LOOKUP_SUBSYSTEM = 8,
305 PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
306 PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
307 PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
308 PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */
309 PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */
310 PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */
311 PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */
312 PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */
313 PCI_LOOKUP_NO_HWDB = 0x800000, /* Do not ask udev's hwdb */