]>
Commit | Line | Data |
---|---|---|
727ce158 | 1 | /* |
727ce158 MM |
2 | * The PCI Library |
3 | * | |
c02d903c | 4 | * Copyright (c) 1997--2018 Martin Mares <mj@ucw.cz> |
727ce158 MM |
5 | * |
6 | * Can be freely distributed and used under the terms of the GNU GPL. | |
7 | */ | |
8 | ||
9 | #ifndef _PCI_LIB_H | |
10 | #define _PCI_LIB_H | |
11 | ||
59a0211a | 12 | #ifndef PCI_CONFIG_H |
727ce158 | 13 | #include "config.h" |
59a0211a MM |
14 | #endif |
15 | ||
727ce158 | 16 | #include "header.h" |
489233b4 | 17 | #include "types.h" |
f3395cc5 | 18 | |
4092c885 | 19 | #define PCI_LIB_VERSION 0x030506 |
043ebdee | 20 | |
2f421184 MM |
21 | #ifndef PCI_ABI |
22 | #define PCI_ABI | |
23 | #endif | |
24 | ||
727ce158 MM |
25 | /* |
26 | * PCI Access Structure | |
27 | */ | |
28 | ||
29 | struct pci_methods; | |
727ce158 | 30 | |
d772ef15 | 31 | enum pci_access_type { |
59cfe93d | 32 | /* Known access methods, remember to update init.c as well */ |
cb6ee324 MM |
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 */ | |
d772ef15 MM |
39 | PCI_ACCESS_AIX_DEVICE, /* /dev/pci0, /dev/bus0, etc. */ |
40 | PCI_ACCESS_NBSD_LIBPCI, /* NetBSD libpci */ | |
b6359063 | 41 | PCI_ACCESS_OBSD_DEVICE, /* OpenBSD /dev/pci */ |
5bdd27f6 | 42 | PCI_ACCESS_DUMP, /* Dump file */ |
7cb1afbe | 43 | PCI_ACCESS_DARWIN, /* Darwin */ |
83fd885b | 44 | PCI_ACCESS_SYLIXOS_DEVICE, /* SylixOS pci */ |
d772ef15 MM |
45 | PCI_ACCESS_MAX |
46 | }; | |
727ce158 MM |
47 | |
48 | struct pci_access { | |
49 | /* Options you can change: */ | |
50 | unsigned int method; /* Access method */ | |
727ce158 MM |
51 | int writeable; /* Open in read/write mode */ |
52 | int buscentric; /* Bus-centric view of the world */ | |
103f074c MM |
53 | |
54 | char *id_file_name; /* Name of ID list file (use pci_set_name_list_path()) */ | |
cc062b4a | 55 | int free_id_name; /* Set if id_file_name is malloced */ |
bc2eed2d | 56 | int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */ |
103f074c MM |
57 | |
58 | unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */ | |
98ccf6d6 | 59 | /* Default: PCI_LOOKUP_CACHE */ |
103f074c | 60 | |
727ce158 MM |
61 | int debugging; /* Turn on debugging messages */ |
62 | ||
63 | /* Functions you can override: */ | |
4f6b38ca MM |
64 | void (*error)(char *msg, ...) PCI_PRINTF(1,2); /* Write error message and quit */ |
65 | void (*warning)(char *msg, ...) PCI_PRINTF(1,2); /* Write a warning message */ | |
66 | void (*debug)(char *msg, ...) PCI_PRINTF(1,2); /* Write a debugging message */ | |
727ce158 MM |
67 | |
68 | struct pci_dev *devices; /* Devices found on this bus */ | |
69 | ||
70 | /* Fields used internally: */ | |
71 | struct pci_methods *methods; | |
fa182368 | 72 | struct pci_param *params; |
aeaca5d3 MM |
73 | struct id_entry **id_hash; /* names.c */ |
74 | struct id_bucket *current_id_bucket; | |
103f074c MM |
75 | int id_load_failed; |
76 | int id_cache_status; /* 0=not read, 1=read, 2=dirty */ | |
ac357d3b MM |
77 | struct udev *id_udev; /* names-hwdb.c */ |
78 | struct udev_hwdb *id_udev_hwdb; | |
9bd5b1cf BH |
79 | int fd; /* proc/sys: fd for config space */ |
80 | int fd_rw; /* proc/sys: fd opened read-write */ | |
81 | int fd_pos; /* proc/sys: current position */ | |
82 | int fd_vpd; /* sys: fd for VPD */ | |
83 | struct pci_dev *cached_dev; /* proc/sys: device the fds are for */ | |
727ce158 MM |
84 | }; |
85 | ||
86 | /* Initialize PCI access */ | |
2f421184 MM |
87 | struct pci_access *pci_alloc(void) PCI_ABI; |
88 | void pci_init(struct pci_access *) PCI_ABI; | |
89 | void pci_cleanup(struct pci_access *) PCI_ABI; | |
727ce158 MM |
90 | |
91 | /* Scanning of devices */ | |
2f421184 MM |
92 | void pci_scan_bus(struct pci_access *acc) PCI_ABI; |
93 | 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 */ | |
94 | void pci_free_dev(struct pci_dev *) PCI_ABI; | |
727ce158 | 95 | |
9ff67879 | 96 | /* Names of access methods */ |
2f421184 MM |
97 | int pci_lookup_method(char *name) PCI_ABI; /* Returns -1 if not found */ |
98 | char *pci_get_method_name(int index) PCI_ABI; /* Returns "" if unavailable, NULL if index out of range */ | |
9ff67879 | 99 | |
fa182368 MM |
100 | /* |
101 | * Named parameters | |
102 | */ | |
103 | ||
104 | struct pci_param { | |
105 | struct pci_param *next; /* Please use pci_walk_params() for traversing the list */ | |
106 | char *param; /* Name of the parameter */ | |
107 | char *value; /* Value of the parameter */ | |
108 | int value_malloced; /* used internally */ | |
0f24ef6f | 109 | char *help; /* Explanation of the parameter */ |
fa182368 MM |
110 | }; |
111 | ||
2f421184 MM |
112 | char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI; |
113 | int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI; /* 0 on success, -1 if no such parameter */ | |
fa182368 | 114 | /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */ |
2f421184 | 115 | struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI; |
fa182368 | 116 | |
727ce158 MM |
117 | /* |
118 | * Devices | |
119 | */ | |
120 | ||
121 | struct pci_dev { | |
122 | struct pci_dev *next; /* Next device in the chain */ | |
4186391b MM |
123 | u16 domain_16; /* 16-bit version of the PCI domain for backward compatibility */ |
124 | /* 0xffff if the real domain doesn't fit in 16 bits */ | |
f31412d1 | 125 | u8 bus, dev, func; /* Bus inside domain, device and function */ |
727ce158 MM |
126 | |
127 | /* These fields are set by pci_fill_info() */ | |
e95c8373 | 128 | int known_fields; /* Set of info fields already known */ |
f31412d1 | 129 | u16 vendor_id, device_id; /* Identity of the device */ |
c2b144ef | 130 | u16 device_class; /* PCI device class */ |
727ce158 | 131 | int irq; /* IRQ number */ |
f3d91991 | 132 | pciaddr_t base_addr[6]; /* Base addresses including flags in lower bits */ |
e95c8373 | 133 | pciaddr_t size[6]; /* Region sizes */ |
f3395cc5 | 134 | pciaddr_t rom_base_addr; /* Expansion ROM base address */ |
e95c8373 | 135 | pciaddr_t rom_size; /* Expansion ROM size */ |
89c51b98 | 136 | struct pci_cap *first_cap; /* List of capabilities */ |
2849a165 | 137 | char *phy_slot; /* Physical slot */ |
b1861a8d | 138 | char *module_alias; /* Linux kernel module alias */ |
aecf5b35 | 139 | char *label; /* Device name as exported by BIOS */ |
7ef7f3ec | 140 | int numa_node; /* NUMA node */ |
3d0a6d88 MM |
141 | pciaddr_t flags[6]; /* PCI_IORESOURCE_* flags for regions */ |
142 | pciaddr_t rom_flags; /* PCI_IORESOURCE_* flags for expansion ROM */ | |
4186391b | 143 | int domain; /* PCI domain (host bridge) */ |
727ce158 | 144 | |
c02d903c | 145 | /* Fields used internally */ |
727ce158 MM |
146 | struct pci_access *access; |
147 | struct pci_methods *methods; | |
f31412d1 | 148 | u8 *cache; /* Cached config registers */ |
3430bafe | 149 | int cache_len; |
6aa54f1b | 150 | int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */ |
d9b1b8e3 | 151 | void *aux; /* Auxiliary data */ |
c02d903c | 152 | struct pci_property *properties; /* A linked list of extra properties */ |
727ce158 MM |
153 | }; |
154 | ||
f3395cc5 MM |
155 | #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3) |
156 | #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf) | |
6d143c32 | 157 | #define PCI_ADDR_FLAG_MASK 0xf |
f3395cc5 | 158 | |
2f421184 MM |
159 | u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; /* Access to configuration space */ |
160 | u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI; | |
161 | u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI; | |
162 | int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI; | |
52c81519 | 163 | int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI; |
2f421184 MM |
164 | int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI; |
165 | int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI; | |
166 | int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI; | |
167 | int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI; | |
727ce158 | 168 | |
c02d903c MM |
169 | /* |
170 | * Most device properties take some effort to obtain, so libpci does not | |
171 | * initialize them during default bus scan. Instead, you have to call | |
172 | * pci_fill_info() with the proper PCI_FILL_xxx constants OR'ed together. | |
173 | * | |
174 | * Some properties are stored directly in the pci_dev structure. | |
175 | * The remaining ones can be accessed through pci_get_string_property(). | |
176 | */ | |
177 | ||
178 | int pci_fill_info(struct pci_dev *, int flags) PCI_ABI; | |
179 | char *pci_get_string_property(struct pci_dev *d, u32 prop) PCI_ABI; | |
727ce158 | 180 | |
7ef7f3ec MM |
181 | #define PCI_FILL_IDENT 0x0001 |
182 | #define PCI_FILL_IRQ 0x0002 | |
183 | #define PCI_FILL_BASES 0x0004 | |
184 | #define PCI_FILL_ROM_BASE 0x0008 | |
185 | #define PCI_FILL_SIZES 0x0010 | |
186 | #define PCI_FILL_CLASS 0x0020 | |
187 | #define PCI_FILL_CAPS 0x0040 | |
188 | #define PCI_FILL_EXT_CAPS 0x0080 | |
189 | #define PCI_FILL_PHYS_SLOT 0x0100 | |
190 | #define PCI_FILL_MODULE_ALIAS 0x0200 | |
191 | #define PCI_FILL_LABEL 0x0400 | |
192 | #define PCI_FILL_NUMA_NODE 0x0800 | |
558f736b | 193 | #define PCI_FILL_IO_FLAGS 0x1000 |
c02d903c | 194 | #define PCI_FILL_DT_NODE 0x2000 /* Device tree node */ |
7ef7f3ec | 195 | #define PCI_FILL_RESCAN 0x00010000 |
727ce158 | 196 | |
2f421184 | 197 | void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI; |
727ce158 | 198 | |
6d5e39ac MM |
199 | /* |
200 | * Capabilities | |
201 | */ | |
202 | ||
203 | struct pci_cap { | |
204 | struct pci_cap *next; | |
205 | u16 id; /* PCI_CAP_ID_xxx */ | |
206 | u16 type; /* PCI_CAP_xxx */ | |
207 | unsigned int addr; /* Position in the config space */ | |
208 | }; | |
209 | ||
7831d7f9 MM |
210 | #define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */ |
211 | #define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */ | |
6d5e39ac MM |
212 | |
213 | struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI; | |
214 | ||
727ce158 MM |
215 | /* |
216 | * Filters | |
217 | */ | |
218 | ||
219 | struct pci_filter { | |
84c8d1bb | 220 | int domain, bus, slot, func; /* -1 = ANY */ |
52aecc75 MM |
221 | int vendor, device, device_class; |
222 | int rfu[3]; | |
727ce158 MM |
223 | }; |
224 | ||
2f421184 MM |
225 | void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI; |
226 | char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI; | |
227 | char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI; | |
228 | int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI; | |
727ce158 MM |
229 | |
230 | /* | |
aeaca5d3 MM |
231 | * Conversion of PCI ID's to names (according to the pci.ids file) |
232 | * | |
233 | * Call pci_lookup_name() to identify different types of ID's: | |
234 | * | |
235 | * VENDOR (vendorID) -> vendor | |
236 | * DEVICE (vendorID, deviceID) -> device | |
237 | * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device | |
238 | * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor | |
239 | * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device | |
240 | * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d | |
241 | * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem | |
242 | * CLASS (classID) -> class | |
243 | * PROGIF (classID, progif) -> programming interface | |
727ce158 MM |
244 | */ |
245 | ||
2f421184 | 246 | char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI; |
727ce158 | 247 | |
2f421184 MM |
248 | int pci_load_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_lookup_*() when needed; returns success */ |
249 | void pci_free_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_cleanup() */ | |
250 | void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI; | |
251 | void pci_id_cache_flush(struct pci_access *a) PCI_ABI; | |
aeaca5d3 MM |
252 | |
253 | enum pci_lookup_mode { | |
254 | PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */ | |
255 | PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */ | |
256 | PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */ | |
257 | PCI_LOOKUP_SUBSYSTEM = 8, | |
258 | PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */ | |
259 | PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */ | |
bc2eed2d MM |
260 | PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */ |
261 | PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */ | |
103f074c MM |
262 | PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */ |
263 | PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */ | |
264 | PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */ | |
265 | PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */ | |
ac357d3b | 266 | PCI_LOOKUP_NO_HWDB = 0x800000, /* Do not ask udev's hwdb */ |
aeaca5d3 | 267 | }; |
727ce158 MM |
268 | |
269 | #endif |