]>
Commit | Line | Data |
---|---|---|
727ce158 | 1 | /* |
727ce158 MM |
2 | * The PCI Library |
3 | * | |
08f8e666 | 4 | * Copyright (c) 1997--2024 Martin Mares <mj@ucw.cz> |
727ce158 | 5 | * |
61829219 MM |
6 | * Can be freely distributed and used under the terms of the GNU GPL v2+ |
7 | * | |
8 | * SPDX-License-Identifier: GPL-2.0-or-later | |
727ce158 MM |
9 | */ |
10 | ||
11 | #ifndef _PCI_LIB_H | |
12 | #define _PCI_LIB_H | |
13 | ||
59a0211a | 14 | #ifndef PCI_CONFIG_H |
727ce158 | 15 | #include "config.h" |
59a0211a MM |
16 | #endif |
17 | ||
727ce158 | 18 | #include "header.h" |
489233b4 | 19 | #include "types.h" |
f3395cc5 | 20 | |
7c5bf915 | 21 | #define PCI_LIB_VERSION 0x030d00 |
043ebdee | 22 | |
2f421184 MM |
23 | #ifndef PCI_ABI |
24 | #define PCI_ABI | |
25 | #endif | |
26 | ||
727ce158 MM |
27 | /* |
28 | * PCI Access Structure | |
29 | */ | |
30 | ||
31 | struct pci_methods; | |
727ce158 | 32 | |
d772ef15 | 33 | enum pci_access_type { |
59cfe93d | 34 | /* Known access methods, remember to update init.c as well */ |
cb6ee324 MM |
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 */ | |
d772ef15 MM |
41 | PCI_ACCESS_AIX_DEVICE, /* /dev/pci0, /dev/bus0, etc. */ |
42 | PCI_ACCESS_NBSD_LIBPCI, /* NetBSD libpci */ | |
b6359063 | 43 | PCI_ACCESS_OBSD_DEVICE, /* OpenBSD /dev/pci */ |
5bdd27f6 | 44 | PCI_ACCESS_DUMP, /* Dump file */ |
7cb1afbe | 45 | PCI_ACCESS_DARWIN, /* Darwin */ |
0a913370 JL |
46 | PCI_ACCESS_SYLIXOS_DEVICE, /* SylixOS pci */ |
47 | PCI_ACCESS_HURD, /* GNU/Hurd */ | |
26c8b543 | 48 | PCI_ACCESS_WIN32_CFGMGR32, /* Win32 cfgmgr32.dll */ |
aa5a16ef | 49 | PCI_ACCESS_WIN32_KLDBG, /* Win32 kldbgdrv.sys */ |
2d0af6fc | 50 | PCI_ACCESS_WIN32_SYSDBG, /* Win32 NT SysDbg */ |
0a7350fb | 51 | PCI_ACCESS_MMIO_TYPE1, /* MMIO ports, type 1 */ |
e2d9340b | 52 | PCI_ACCESS_MMIO_TYPE1_EXT, /* MMIO ports, type 1 extended */ |
2ba0f6f4 | 53 | PCI_ACCESS_ECAM, /* PCIe ECAM via /dev/mem */ |
5b52ae79 | 54 | PCI_ACCESS_AOS_EXPANSION, /* AmigaOS Expansion library */ |
d772ef15 MM |
55 | PCI_ACCESS_MAX |
56 | }; | |
727ce158 MM |
57 | |
58 | struct pci_access { | |
59 | /* Options you can change: */ | |
60 | unsigned int method; /* Access method */ | |
727ce158 MM |
61 | int writeable; /* Open in read/write mode */ |
62 | int buscentric; /* Bus-centric view of the world */ | |
103f074c MM |
63 | |
64 | char *id_file_name; /* Name of ID list file (use pci_set_name_list_path()) */ | |
cc062b4a | 65 | int free_id_name; /* Set if id_file_name is malloced */ |
bc2eed2d | 66 | int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */ |
103f074c MM |
67 | |
68 | unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */ | |
98ccf6d6 | 69 | /* Default: PCI_LOOKUP_CACHE */ |
103f074c | 70 | |
727ce158 MM |
71 | int debugging; /* Turn on debugging messages */ |
72 | ||
73 | /* Functions you can override: */ | |
eeef8fed | 74 | void (*error)(char *msg, ...) PCI_PRINTF(1,2) PCI_NONRET; /* Write error message and quit */ |
4f6b38ca MM |
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 */ | |
727ce158 MM |
77 | |
78 | struct pci_dev *devices; /* Devices found on this bus */ | |
79 | ||
80 | /* Fields used internally: */ | |
81 | struct pci_methods *methods; | |
fa182368 | 82 | struct pci_param *params; |
aeaca5d3 MM |
83 | struct id_entry **id_hash; /* names.c */ |
84 | struct id_bucket *current_id_bucket; | |
06f9ecf3 | 85 | int id_load_attempted; |
103f074c | 86 | int id_cache_status; /* 0=not read, 1=read, 2=dirty */ |
f022f467 | 87 | char *id_cache_name; |
ac357d3b MM |
88 | struct udev *id_udev; /* names-hwdb.c */ |
89 | struct udev_hwdb *id_udev_hwdb; | |
9bd5b1cf BH |
90 | int fd; /* proc/sys: fd for config space */ |
91 | int fd_rw; /* proc/sys: fd opened read-write */ | |
9bd5b1cf BH |
92 | int fd_vpd; /* sys: fd for VPD */ |
93 | struct pci_dev *cached_dev; /* proc/sys: device the fds are for */ | |
a997ef13 | 94 | void *backend_data; /* Private data of the back end */ |
727ce158 MM |
95 | }; |
96 | ||
97 | /* Initialize PCI access */ | |
2f421184 MM |
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; | |
727ce158 MM |
101 | |
102 | /* Scanning of devices */ | |
2f421184 MM |
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; | |
727ce158 | 106 | |
9ff67879 | 107 | /* Names of access methods */ |
2f421184 MM |
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 */ | |
9ff67879 | 110 | |
fa182368 MM |
111 | /* |
112 | * Named parameters | |
113 | */ | |
114 | ||
115 | struct pci_param { | |
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 */ | |
0f24ef6f | 120 | char *help; /* Explanation of the parameter */ |
fa182368 MM |
121 | }; |
122 | ||
2f421184 MM |
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 */ | |
fa182368 | 125 | /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */ |
2f421184 | 126 | struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI; |
fa182368 | 127 | |
727ce158 MM |
128 | /* |
129 | * Devices | |
130 | */ | |
131 | ||
132 | struct pci_dev { | |
133 | struct pci_dev *next; /* Next device in the chain */ | |
4186391b MM |
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 */ | |
f31412d1 | 136 | u8 bus, dev, func; /* Bus inside domain, device and function */ |
727ce158 MM |
137 | |
138 | /* These fields are set by pci_fill_info() */ | |
82c06b47 | 139 | unsigned int known_fields; /* Set of info fields already known (see pci_fill_info()) */ |
f31412d1 | 140 | u16 vendor_id, device_id; /* Identity of the device */ |
c2b144ef | 141 | u16 device_class; /* PCI device class */ |
727ce158 | 142 | int irq; /* IRQ number */ |
f3d91991 | 143 | pciaddr_t base_addr[6]; /* Base addresses including flags in lower bits */ |
e95c8373 | 144 | pciaddr_t size[6]; /* Region sizes */ |
f3395cc5 | 145 | pciaddr_t rom_base_addr; /* Expansion ROM base address */ |
e95c8373 | 146 | pciaddr_t rom_size; /* Expansion ROM size */ |
89c51b98 | 147 | struct pci_cap *first_cap; /* List of capabilities */ |
2849a165 | 148 | char *phy_slot; /* Physical slot */ |
b1861a8d | 149 | char *module_alias; /* Linux kernel module alias */ |
aecf5b35 | 150 | char *label; /* Device name as exported by BIOS */ |
7ef7f3ec | 151 | int numa_node; /* NUMA node */ |
3d0a6d88 MM |
152 | pciaddr_t flags[6]; /* PCI_IORESOURCE_* flags for regions */ |
153 | pciaddr_t rom_flags; /* PCI_IORESOURCE_* flags for expansion ROM */ | |
4186391b | 154 | int domain; /* PCI domain (host bridge) */ |
119c1376 PR |
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 */ | |
b84f2154 PR |
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 */ | |
5e9714ac | 160 | struct pci_dev *parent; /* Parent device, does not have to be always accessible */ |
08609192 | 161 | int no_config_access; /* No access to config space for this device */ |
a8a0f810 MM |
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 */ | |
727ce158 | 165 | |
c02d903c | 166 | /* Fields used internally */ |
727ce158 MM |
167 | struct pci_access *access; |
168 | struct pci_methods *methods; | |
f31412d1 | 169 | u8 *cache; /* Cached config registers */ |
3430bafe | 170 | int cache_len; |
6aa54f1b | 171 | int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */ |
a997ef13 | 172 | void *backend_data; /* Private data for of the back end */ |
c02d903c | 173 | struct pci_property *properties; /* A linked list of extra properties */ |
9c48ed23 | 174 | struct pci_cap *last_cap; /* Last capability in the list */ |
727ce158 MM |
175 | }; |
176 | ||
f3395cc5 MM |
177 | #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3) |
178 | #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf) | |
6d143c32 | 179 | #define PCI_ADDR_FLAG_MASK 0xf |
f3395cc5 | 180 | |
bca04128 MM |
181 | /* Access to configuration space */ |
182 | u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; | |
2f421184 MM |
183 | u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI; |
184 | u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI; | |
52c81519 | 185 | int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI; |
2f421184 MM |
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; | |
bca04128 MM |
189 | |
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; | |
2f421184 | 192 | int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI; |
727ce158 | 193 | |
c02d903c MM |
194 | /* |
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. | |
198 | * | |
199 | * Some properties are stored directly in the pci_dev structure. | |
200 | * The remaining ones can be accessed through pci_get_string_property(). | |
82c06b47 MM |
201 | * |
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. | |
209 | * | |
210 | * XXX: flags and the result should be unsigned, but we do not want to break the ABI. | |
c02d903c MM |
211 | */ |
212 | ||
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; | |
727ce158 | 215 | |
4c392dc3 | 216 | #define PCI_FILL_IDENT 0x0001 /* vendor and device ID */ |
7ef7f3ec MM |
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 | |
4c392dc3 MM |
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) */ | |
7ef7f3ec | 227 | #define PCI_FILL_NUMA_NODE 0x0800 |
558f736b | 228 | #define PCI_FILL_IO_FLAGS 0x1000 |
4c392dc3 MM |
229 | #define PCI_FILL_DT_NODE 0x2000 /* Device tree node (string property) */ |
230 | #define PCI_FILL_IOMMU_GROUP 0x4000 /* (string property) */ | |
119c1376 | 231 | #define PCI_FILL_BRIDGE_BASES 0x8000 |
4c392dc3 | 232 | #define PCI_FILL_RESCAN 0x00010000 /* force re-scan of cached properties */ |
b84f2154 PR |
233 | #define PCI_FILL_CLASS_EXT 0x00020000 /* prog_if and rev_id */ |
234 | #define PCI_FILL_SUBSYS 0x00040000 /* subsys_vendor_id and subsys_id */ | |
5e9714ac | 235 | #define PCI_FILL_PARENT 0x00080000 |
2b883e3f | 236 | #define PCI_FILL_DRIVER 0x00100000 /* OS driver currently in use (string property) */ |
a8a0f810 | 237 | #define PCI_FILL_RCD_LNK 0x00200000 /* CXL RCD Link status properties (rcd_*) */ |
727ce158 | 238 | |
2f421184 | 239 | void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI; |
727ce158 | 240 | |
6d5e39ac MM |
241 | /* |
242 | * Capabilities | |
243 | */ | |
244 | ||
245 | struct pci_cap { | |
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 */ | |
250 | }; | |
251 | ||
7831d7f9 MM |
252 | #define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */ |
253 | #define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */ | |
6d5e39ac MM |
254 | |
255 | struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI; | |
c22c314a | 256 | struct pci_cap *pci_find_cap_nr(struct pci_dev *, unsigned int id, unsigned int type, |
d7d9e305 | 257 | unsigned int *cap_number) PCI_ABI; |
6d5e39ac | 258 | |
727ce158 MM |
259 | /* |
260 | * Filters | |
261 | */ | |
262 | ||
263 | struct pci_filter { | |
84c8d1bb | 264 | int domain, bus, slot, func; /* -1 = ANY */ |
511122b8 MM |
265 | int vendor, device; |
266 | int device_class; | |
267 | unsigned int device_class_mask; /* Which bits of the device_class are compared, default=all */ | |
268 | int prog_if; | |
269 | int rfu[1]; | |
727ce158 MM |
270 | }; |
271 | ||
2f421184 MM |
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; | |
727ce158 MM |
276 | |
277 | /* | |
aeaca5d3 MM |
278 | * Conversion of PCI ID's to names (according to the pci.ids file) |
279 | * | |
280 | * Call pci_lookup_name() to identify different types of ID's: | |
281 | * | |
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 | |
727ce158 MM |
291 | */ |
292 | ||
2f421184 | 293 | char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI; |
727ce158 | 294 | |
2f421184 MM |
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; | |
aeaca5d3 MM |
299 | |
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 */ | |
bc2eed2d MM |
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 */ | |
103f074c MM |
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 */ | |
ac357d3b | 313 | PCI_LOOKUP_NO_HWDB = 0x800000, /* Do not ask udev's hwdb */ |
aeaca5d3 | 314 | }; |
727ce158 MM |
315 | |
316 | #endif |