]> git.ipfire.org Git - thirdparty/pciutils.git/blame - lib/pci.h
Backward ABI compatibility for new filters and pci_fill_info
[thirdparty/pciutils.git] / lib / pci.h
CommitLineData
727ce158 1/*
727ce158
MM
2 * The PCI Library
3 *
ac357d3b 4 * Copyright (c) 1997--2014 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
dbe1e0a6 19#define PCI_LIB_VERSION 0x030200
043ebdee 20
2f421184
MM
21#ifndef PCI_ABI
22#define PCI_ABI
23#endif
24
727ce158
MM
25/*
26 * PCI Access Structure
27 */
28
29struct pci_methods;
727ce158 30
d772ef15
MM
31enum pci_access_type {
32 /* Known access methods, remember to update access.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 */
7cb1afbe
RY
42 PCI_ACCESS_DUMP, /* Dump file */
43 PCI_ACCESS_DARWIN, /* Darwin */
d772ef15
MM
44 PCI_ACCESS_MAX
45};
727ce158
MM
46
47struct pci_access {
48 /* Options you can change: */
49 unsigned int method; /* Access method */
727ce158
MM
50 int writeable; /* Open in read/write mode */
51 int buscentric; /* Bus-centric view of the world */
103f074c
MM
52
53 char *id_file_name; /* Name of ID list file (use pci_set_name_list_path()) */
cc062b4a 54 int free_id_name; /* Set if id_file_name is malloced */
bc2eed2d 55 int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
103f074c
MM
56
57 unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */
98ccf6d6 58 /* Default: PCI_LOOKUP_CACHE */
103f074c 59
727ce158
MM
60 int debugging; /* Turn on debugging messages */
61
62 /* Functions you can override: */
4f6b38ca
MM
63 void (*error)(char *msg, ...) PCI_PRINTF(1,2); /* Write error message and quit */
64 void (*warning)(char *msg, ...) PCI_PRINTF(1,2); /* Write a warning message */
65 void (*debug)(char *msg, ...) PCI_PRINTF(1,2); /* Write a debugging message */
727ce158
MM
66
67 struct pci_dev *devices; /* Devices found on this bus */
68
69 /* Fields used internally: */
70 struct pci_methods *methods;
fa182368 71 struct pci_param *params;
aeaca5d3
MM
72 struct id_entry **id_hash; /* names.c */
73 struct id_bucket *current_id_bucket;
103f074c
MM
74 int id_load_failed;
75 int id_cache_status; /* 0=not read, 1=read, 2=dirty */
ac357d3b
MM
76 struct udev *id_udev; /* names-hwdb.c */
77 struct udev_hwdb *id_udev_hwdb;
9bd5b1cf
BH
78 int fd; /* proc/sys: fd for config space */
79 int fd_rw; /* proc/sys: fd opened read-write */
80 int fd_pos; /* proc/sys: current position */
81 int fd_vpd; /* sys: fd for VPD */
82 struct pci_dev *cached_dev; /* proc/sys: device the fds are for */
727ce158
MM
83};
84
85/* Initialize PCI access */
2f421184
MM
86struct pci_access *pci_alloc(void) PCI_ABI;
87void pci_init(struct pci_access *) PCI_ABI;
88void pci_cleanup(struct pci_access *) PCI_ABI;
727ce158
MM
89
90/* Scanning of devices */
2f421184
MM
91void pci_scan_bus(struct pci_access *acc) PCI_ABI;
92struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func) PCI_ABI; /* Raw access to specified device */
93void pci_free_dev(struct pci_dev *) PCI_ABI;
727ce158 94
9ff67879 95/* Names of access methods */
2f421184
MM
96int pci_lookup_method(char *name) PCI_ABI; /* Returns -1 if not found */
97char *pci_get_method_name(int index) PCI_ABI; /* Returns "" if unavailable, NULL if index out of range */
9ff67879 98
fa182368
MM
99/*
100 * Named parameters
101 */
102
103struct pci_param {
104 struct pci_param *next; /* Please use pci_walk_params() for traversing the list */
105 char *param; /* Name of the parameter */
106 char *value; /* Value of the parameter */
107 int value_malloced; /* used internally */
0f24ef6f 108 char *help; /* Explanation of the parameter */
fa182368
MM
109};
110
2f421184
MM
111char *pci_get_param(struct pci_access *acc, char *param) PCI_ABI;
112int pci_set_param(struct pci_access *acc, char *param, char *value) PCI_ABI; /* 0 on success, -1 if no such parameter */
fa182368 113/* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
2f421184 114struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev) PCI_ABI;
fa182368 115
727ce158
MM
116/*
117 * Devices
118 */
119
120struct pci_dev {
121 struct pci_dev *next; /* Next device in the chain */
84c8d1bb 122 u16 domain; /* PCI domain (host bridge) */
f31412d1 123 u8 bus, dev, func; /* Bus inside domain, device and function */
727ce158
MM
124
125 /* These fields are set by pci_fill_info() */
e95c8373 126 int known_fields; /* Set of info fields already known */
f31412d1 127 u16 vendor_id, device_id; /* Identity of the device */
c2b144ef 128 u16 device_class; /* PCI device class */
727ce158 129 int irq; /* IRQ number */
f3d91991 130 pciaddr_t base_addr[6]; /* Base addresses including flags in lower bits */
e95c8373 131 pciaddr_t size[6]; /* Region sizes */
f3395cc5 132 pciaddr_t rom_base_addr; /* Expansion ROM base address */
e95c8373 133 pciaddr_t rom_size; /* Expansion ROM size */
89c51b98 134 struct pci_cap *first_cap; /* List of capabilities */
2849a165 135 char *phy_slot; /* Physical slot */
b1861a8d 136 char *module_alias; /* Linux kernel module alias */
aecf5b35 137 char *label; /* Device name as exported by BIOS */
727ce158
MM
138
139 /* Fields used internally: */
140 struct pci_access *access;
141 struct pci_methods *methods;
f31412d1 142 u8 *cache; /* Cached config registers */
3430bafe 143 int cache_len;
6aa54f1b 144 int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
727ce158
MM
145 void *aux; /* Auxillary data */
146};
147
f3395cc5
MM
148#define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
149#define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
6d143c32 150#define PCI_ADDR_FLAG_MASK 0xf
f3395cc5 151
2f421184
MM
152u8 pci_read_byte(struct pci_dev *, int pos) PCI_ABI; /* Access to configuration space */
153u16 pci_read_word(struct pci_dev *, int pos) PCI_ABI;
154u32 pci_read_long(struct pci_dev *, int pos) PCI_ABI;
155int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
52c81519 156int pci_read_vpd(struct pci_dev *d, int pos, u8 *buf, int len) PCI_ABI;
2f421184
MM
157int pci_write_byte(struct pci_dev *, int pos, u8 data) PCI_ABI;
158int pci_write_word(struct pci_dev *, int pos, u16 data) PCI_ABI;
159int pci_write_long(struct pci_dev *, int pos, u32 data) PCI_ABI;
160int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len) PCI_ABI;
727ce158 161
2f421184 162int pci_fill_info(struct pci_dev *, int flags) PCI_ABI; /* Fill in device information */
727ce158
MM
163
164#define PCI_FILL_IDENT 1
165#define PCI_FILL_IRQ 2
166#define PCI_FILL_BASES 4
167#define PCI_FILL_ROM_BASE 8
e95c8373 168#define PCI_FILL_SIZES 16
c2b144ef 169#define PCI_FILL_CLASS 32
6d5e39ac
MM
170#define PCI_FILL_CAPS 64
171#define PCI_FILL_EXT_CAPS 128
2849a165 172#define PCI_FILL_PHYS_SLOT 256
b1861a8d 173#define PCI_FILL_MODULE_ALIAS 512
e84876c6 174#define PCI_FILL_LABEL 1024
727ce158
MM
175#define PCI_FILL_RESCAN 0x10000
176
2f421184 177void pci_setup_cache(struct pci_dev *, u8 *cache, int len) PCI_ABI;
727ce158 178
6d5e39ac
MM
179/*
180 * Capabilities
181 */
182
183struct pci_cap {
184 struct pci_cap *next;
185 u16 id; /* PCI_CAP_ID_xxx */
186 u16 type; /* PCI_CAP_xxx */
187 unsigned int addr; /* Position in the config space */
188};
189
7831d7f9
MM
190#define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */
191#define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */
6d5e39ac
MM
192
193struct pci_cap *pci_find_cap(struct pci_dev *, unsigned int id, unsigned int type) PCI_ABI;
194
727ce158
MM
195/*
196 * Filters
197 */
198
199struct pci_filter {
84c8d1bb 200 int domain, bus, slot, func; /* -1 = ANY */
52aecc75
MM
201 int vendor, device, device_class;
202 int rfu[3];
727ce158
MM
203};
204
2f421184
MM
205void pci_filter_init(struct pci_access *, struct pci_filter *) PCI_ABI;
206char *pci_filter_parse_slot(struct pci_filter *, char *) PCI_ABI;
207char *pci_filter_parse_id(struct pci_filter *, char *) PCI_ABI;
208int pci_filter_match(struct pci_filter *, struct pci_dev *) PCI_ABI;
727ce158
MM
209
210/*
aeaca5d3
MM
211 * Conversion of PCI ID's to names (according to the pci.ids file)
212 *
213 * Call pci_lookup_name() to identify different types of ID's:
214 *
215 * VENDOR (vendorID) -> vendor
216 * DEVICE (vendorID, deviceID) -> device
217 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
218 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
219 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
220 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
221 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
222 * CLASS (classID) -> class
223 * PROGIF (classID, progif) -> programming interface
727ce158
MM
224 */
225
2f421184 226char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...) PCI_ABI;
727ce158 227
2f421184
MM
228int pci_load_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_lookup_*() when needed; returns success */
229void pci_free_name_list(struct pci_access *a) PCI_ABI; /* Called automatically by pci_cleanup() */
230void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed) PCI_ABI;
231void pci_id_cache_flush(struct pci_access *a) PCI_ABI;
aeaca5d3
MM
232
233enum pci_lookup_mode {
234 PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
235 PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
236 PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
237 PCI_LOOKUP_SUBSYSTEM = 8,
238 PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
239 PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
bc2eed2d
MM
240 PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
241 PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */
103f074c
MM
242 PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */
243 PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */
244 PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */
245 PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */
ac357d3b 246 PCI_LOOKUP_NO_HWDB = 0x800000, /* Do not ask udev's hwdb */
aeaca5d3 247};
727ce158
MM
248
249#endif