]>
git.ipfire.org Git - thirdparty/pciutils.git/blob - lib/pci.h
4 * Copyright (c) 1997--2017 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL.
19 #define PCI_LIB_VERSION 0x030504
26 * PCI Access Structure
31 enum pci_access_type
{
32 /* Known access methods, remember to update access.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 */
48 /* Options you can change: */
49 unsigned int method
; /* Access method */
50 int writeable
; /* Open in read/write mode */
51 int buscentric
; /* Bus-centric view of the world */
53 char *id_file_name
; /* Name of ID list file (use pci_set_name_list_path()) */
54 int free_id_name
; /* Set if id_file_name is malloced */
55 int numeric_ids
; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
57 unsigned int id_lookup_mode
; /* pci_lookup_mode flags which are set automatically */
58 /* Default: PCI_LOOKUP_CACHE */
60 int debugging
; /* Turn on debugging messages */
62 /* Functions you can override: */
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 */
67 struct pci_dev
*devices
; /* Devices found on this bus */
69 /* Fields used internally: */
70 struct pci_methods
*methods
;
71 struct pci_param
*params
;
72 struct id_entry
**id_hash
; /* names.c */
73 struct id_bucket
*current_id_bucket
;
75 int id_cache_status
; /* 0=not read, 1=read, 2=dirty */
76 struct udev
*id_udev
; /* names-hwdb.c */
77 struct udev_hwdb
*id_udev_hwdb
;
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 */
85 /* Initialize PCI access */
86 struct pci_access
*pci_alloc(void) PCI_ABI
;
87 void pci_init(struct pci_access
*) PCI_ABI
;
88 void pci_cleanup(struct pci_access
*) PCI_ABI
;
90 /* Scanning of devices */
91 void pci_scan_bus(struct pci_access
*acc
) PCI_ABI
;
92 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 */
93 void pci_free_dev(struct pci_dev
*) PCI_ABI
;
95 /* Names of access methods */
96 int pci_lookup_method(char *name
) PCI_ABI
; /* Returns -1 if not found */
97 char *pci_get_method_name(int index
) PCI_ABI
; /* Returns "" if unavailable, NULL if index out of range */
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 */
108 char *help
; /* Explanation of the parameter */
111 char *pci_get_param(struct pci_access
*acc
, char *param
) PCI_ABI
;
112 int pci_set_param(struct pci_access
*acc
, char *param
, char *value
) PCI_ABI
; /* 0 on success, -1 if no such parameter */
113 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
114 struct pci_param
*pci_walk_params(struct pci_access
*acc
, struct pci_param
*prev
) PCI_ABI
;
121 struct pci_dev
*next
; /* Next device in the chain */
122 u16 domain_16
; /* 16-bit version of the PCI domain for backward compatibility */
123 /* 0xffff if the real domain doesn't fit in 16 bits */
124 u8 bus
, dev
, func
; /* Bus inside domain, device and function */
126 /* These fields are set by pci_fill_info() */
127 int known_fields
; /* Set of info fields already known */
128 u16 vendor_id
, device_id
; /* Identity of the device */
129 u16 device_class
; /* PCI device class */
130 int irq
; /* IRQ number */
131 pciaddr_t base_addr
[6]; /* Base addresses including flags in lower bits */
132 pciaddr_t size
[6]; /* Region sizes */
133 pciaddr_t rom_base_addr
; /* Expansion ROM base address */
134 pciaddr_t rom_size
; /* Expansion ROM size */
135 struct pci_cap
*first_cap
; /* List of capabilities */
136 char *phy_slot
; /* Physical slot */
137 char *module_alias
; /* Linux kernel module alias */
138 char *label
; /* Device name as exported by BIOS */
139 int numa_node
; /* NUMA node */
140 pciaddr_t flags
[6]; /* PCI_IORESOURCE_* flags for regions */
141 pciaddr_t rom_flags
; /* PCI_IORESOURCE_* flags for expansion ROM */
142 int domain
; /* PCI domain (host bridge) */
144 /* Fields used internally: */
145 struct pci_access
*access
;
146 struct pci_methods
*methods
;
147 u8
*cache
; /* Cached config registers */
149 int hdrtype
; /* Cached low 7 bits of header type, -1 if unknown */
150 void *aux
; /* Auxillary data */
153 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
154 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
155 #define PCI_ADDR_FLAG_MASK 0xf
157 u8
pci_read_byte(struct pci_dev
*, int pos
) PCI_ABI
; /* Access to configuration space */
158 u16
pci_read_word(struct pci_dev
*, int pos
) PCI_ABI
;
159 u32
pci_read_long(struct pci_dev
*, int pos
) PCI_ABI
;
160 int pci_read_block(struct pci_dev
*, int pos
, u8
*buf
, int len
) PCI_ABI
;
161 int pci_read_vpd(struct pci_dev
*d
, int pos
, u8
*buf
, int len
) PCI_ABI
;
162 int pci_write_byte(struct pci_dev
*, int pos
, u8 data
) PCI_ABI
;
163 int pci_write_word(struct pci_dev
*, int pos
, u16 data
) PCI_ABI
;
164 int pci_write_long(struct pci_dev
*, int pos
, u32 data
) PCI_ABI
;
165 int pci_write_block(struct pci_dev
*, int pos
, u8
*buf
, int len
) PCI_ABI
;
167 int pci_fill_info(struct pci_dev
*, int flags
) PCI_ABI
; /* Fill in device information */
169 #define PCI_FILL_IDENT 0x0001
170 #define PCI_FILL_IRQ 0x0002
171 #define PCI_FILL_BASES 0x0004
172 #define PCI_FILL_ROM_BASE 0x0008
173 #define PCI_FILL_SIZES 0x0010
174 #define PCI_FILL_CLASS 0x0020
175 #define PCI_FILL_CAPS 0x0040
176 #define PCI_FILL_EXT_CAPS 0x0080
177 #define PCI_FILL_PHYS_SLOT 0x0100
178 #define PCI_FILL_MODULE_ALIAS 0x0200
179 #define PCI_FILL_LABEL 0x0400
180 #define PCI_FILL_NUMA_NODE 0x0800
181 #define PCI_FILL_IO_FLAGS 0x1000
182 #define PCI_FILL_RESCAN 0x00010000
184 void pci_setup_cache(struct pci_dev
*, u8
*cache
, int len
) PCI_ABI
;
191 struct pci_cap
*next
;
192 u16 id
; /* PCI_CAP_ID_xxx */
193 u16 type
; /* PCI_CAP_xxx */
194 unsigned int addr
; /* Position in the config space */
197 #define PCI_CAP_NORMAL 1 /* Traditional PCI capabilities */
198 #define PCI_CAP_EXTENDED 2 /* PCIe extended capabilities */
200 struct pci_cap
*pci_find_cap(struct pci_dev
*, unsigned int id
, unsigned int type
) PCI_ABI
;
207 int domain
, bus
, slot
, func
; /* -1 = ANY */
208 int vendor
, device
, device_class
;
212 void pci_filter_init(struct pci_access
*, struct pci_filter
*) PCI_ABI
;
213 char *pci_filter_parse_slot(struct pci_filter
*, char *) PCI_ABI
;
214 char *pci_filter_parse_id(struct pci_filter
*, char *) PCI_ABI
;
215 int pci_filter_match(struct pci_filter
*, struct pci_dev
*) PCI_ABI
;
218 * Conversion of PCI ID's to names (according to the pci.ids file)
220 * Call pci_lookup_name() to identify different types of ID's:
222 * VENDOR (vendorID) -> vendor
223 * DEVICE (vendorID, deviceID) -> device
224 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
225 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
226 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
227 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
228 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
229 * CLASS (classID) -> class
230 * PROGIF (classID, progif) -> programming interface
233 char *pci_lookup_name(struct pci_access
*a
, char *buf
, int size
, int flags
, ...) PCI_ABI
;
235 int pci_load_name_list(struct pci_access
*a
) PCI_ABI
; /* Called automatically by pci_lookup_*() when needed; returns success */
236 void pci_free_name_list(struct pci_access
*a
) PCI_ABI
; /* Called automatically by pci_cleanup() */
237 void pci_set_name_list_path(struct pci_access
*a
, char *name
, int to_be_freed
) PCI_ABI
;
238 void pci_id_cache_flush(struct pci_access
*a
) PCI_ABI
;
240 enum pci_lookup_mode
{
241 PCI_LOOKUP_VENDOR
= 1, /* Vendor name (args: vendorID) */
242 PCI_LOOKUP_DEVICE
= 2, /* Device name (args: vendorID, deviceID) */
243 PCI_LOOKUP_CLASS
= 4, /* Device class (args: classID) */
244 PCI_LOOKUP_SUBSYSTEM
= 8,
245 PCI_LOOKUP_PROGIF
= 16, /* Programming interface (args: classID, prog_if) */
246 PCI_LOOKUP_NUMERIC
= 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
247 PCI_LOOKUP_NO_NUMBERS
= 0x20000, /* Return NULL if not found in the database; default is to print numerically */
248 PCI_LOOKUP_MIXED
= 0x40000, /* Include both numbers and names */
249 PCI_LOOKUP_NETWORK
= 0x80000, /* Try to resolve unknown ID's by DNS */
250 PCI_LOOKUP_SKIP_LOCAL
= 0x100000, /* Do not consult local database */
251 PCI_LOOKUP_CACHE
= 0x200000, /* Consult the local cache before using DNS */
252 PCI_LOOKUP_REFRESH_CACHE
= 0x400000, /* Forget all previously cached entries, but still allow updating the cache */
253 PCI_LOOKUP_NO_HWDB
= 0x800000, /* Do not ask udev's hwdb */