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