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