]>
git.ipfire.org Git - thirdparty/pciutils.git/blob - lib/pci.h
4 * Copyright (c) 1997--2008 Martin Mares <mj@ucw.cz>
6 * Can be freely distributed and used under the terms of the GNU GPL.
16 #define PCI_LIB_VERSION 0x020204 /* FIXME: Update */
19 * PCI Access Structure
24 enum pci_access_type
{
25 /* Known access methods, remember to update access.c as well */
26 PCI_ACCESS_AUTO
, /* Autodetection */
27 PCI_ACCESS_SYS_BUS_PCI
, /* Linux /sys/bus/pci */
28 PCI_ACCESS_PROC_BUS_PCI
, /* Linux /proc/bus/pci */
29 PCI_ACCESS_I386_TYPE1
, /* i386 ports, type 1 */
30 PCI_ACCESS_I386_TYPE2
, /* i386 ports, type 2 */
31 PCI_ACCESS_FBSD_DEVICE
, /* FreeBSD /dev/pci */
32 PCI_ACCESS_AIX_DEVICE
, /* /dev/pci0, /dev/bus0, etc. */
33 PCI_ACCESS_NBSD_LIBPCI
, /* NetBSD libpci */
34 PCI_ACCESS_OBSD_DEVICE
, /* OpenBSD /dev/pci */
35 PCI_ACCESS_DUMP
, /* Dump file */
40 /* Options you can change: */
41 unsigned int method
; /* Access method */
42 int writeable
; /* Open in read/write mode */
43 int buscentric
; /* Bus-centric view of the world */
45 char *id_file_name
; /* Name of ID list file (use pci_set_name_list_path()) */
46 int free_id_name
; /* Set if id_file_name is malloced */
47 int numeric_ids
; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
49 unsigned int id_lookup_mode
; /* pci_lookup_mode flags which are set automatically */
50 /* Default: PCI_LOOKUP_CACHE */
52 int debugging
; /* Turn on debugging messages */
54 /* Functions you can override: */
55 void (*error
)(char *msg
, ...); /* Write error message and quit */
56 void (*warning
)(char *msg
, ...); /* Write a warning message */
57 void (*debug
)(char *msg
, ...); /* Write a debugging message */
59 struct pci_dev
*devices
; /* Devices found on this bus */
61 /* Fields used internally: */
62 struct pci_methods
*methods
;
63 struct pci_param
*params
;
64 struct id_entry
**id_hash
; /* names.c */
65 struct id_bucket
*current_id_bucket
;
67 int id_cache_status
; /* 0=not read, 1=read, 2=dirty */
68 int fd
; /* proc: fd */
69 int fd_rw
; /* proc: fd opened read-write */
70 struct pci_dev
*cached_dev
; /* proc: device the fd is for */
71 int fd_pos
; /* proc: current position */
74 /* Initialize PCI access */
75 struct pci_access
*pci_alloc(void);
76 void pci_init(struct pci_access
*);
77 void pci_cleanup(struct pci_access
*);
79 /* Scanning of devices */
80 void pci_scan_bus(struct pci_access
*acc
);
81 struct pci_dev
*pci_get_dev(struct pci_access
*acc
, int domain
, int bus
, int dev
, int func
); /* Raw access to specified device */
82 void pci_free_dev(struct pci_dev
*);
84 /* Names of access methods */
85 int pci_lookup_method(char *name
); /* Returns -1 if not found */
86 char *pci_get_method_name(int index
); /* Returns "" if unavailable, NULL if index out of range */
93 struct pci_param
*next
; /* Please use pci_walk_params() for traversing the list */
94 char *param
; /* Name of the parameter */
95 char *value
; /* Value of the parameter */
96 int value_malloced
; /* used internally */
97 char *help
; /* Explanation of the parameter */
100 char *pci_get_param(struct pci_access
*acc
, char *param
);
101 int pci_set_param(struct pci_access
*acc
, char *param
, char *value
); /* 0 on success, -1 if no such parameter */
102 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
103 struct pci_param
*pci_walk_params(struct pci_access
*acc
, struct pci_param
*prev
);
110 struct pci_dev
*next
; /* Next device in the chain */
111 u16 domain
; /* PCI domain (host bridge) */
112 u8 bus
, dev
, func
; /* Bus inside domain, device and function */
114 /* These fields are set by pci_fill_info() */
115 int known_fields
; /* Set of info fields already known */
116 u16 vendor_id
, device_id
; /* Identity of the device */
117 u16 device_class
; /* PCI device class */
118 int irq
; /* IRQ number */
119 pciaddr_t base_addr
[6]; /* Base addresses */
120 pciaddr_t size
[6]; /* Region sizes */
121 pciaddr_t rom_base_addr
; /* Expansion ROM base address */
122 pciaddr_t rom_size
; /* Expansion ROM size */
124 /* Fields used internally: */
125 struct pci_access
*access
;
126 struct pci_methods
*methods
;
127 u8
*cache
; /* Cached config registers */
129 int hdrtype
; /* Cached low 7 bits of header type, -1 if unknown */
130 void *aux
; /* Auxillary data */
133 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
134 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
136 u8
pci_read_byte(struct pci_dev
*, int pos
); /* Access to configuration space */
137 u16
pci_read_word(struct pci_dev
*, int pos
);
138 u32
pci_read_long(struct pci_dev
*, int pos
);
139 int pci_read_block(struct pci_dev
*, int pos
, u8
*buf
, int len
);
140 int pci_write_byte(struct pci_dev
*, int pos
, u8 data
);
141 int pci_write_word(struct pci_dev
*, int pos
, u16 data
);
142 int pci_write_long(struct pci_dev
*, int pos
, u32 data
);
143 int pci_write_block(struct pci_dev
*, int pos
, u8
*buf
, int len
);
145 int pci_fill_info(struct pci_dev
*, int flags
); /* Fill in device information */
147 #define PCI_FILL_IDENT 1
148 #define PCI_FILL_IRQ 2
149 #define PCI_FILL_BASES 4
150 #define PCI_FILL_ROM_BASE 8
151 #define PCI_FILL_SIZES 16
152 #define PCI_FILL_CLASS 32
153 #define PCI_FILL_RESCAN 0x10000
155 void pci_setup_cache(struct pci_dev
*, u8
*cache
, int len
);
162 int domain
, bus
, slot
, func
; /* -1 = ANY */
166 void pci_filter_init(struct pci_access
*, struct pci_filter
*);
167 char *pci_filter_parse_slot(struct pci_filter
*, char *);
168 char *pci_filter_parse_id(struct pci_filter
*, char *);
169 int pci_filter_match(struct pci_filter
*, struct pci_dev
*);
172 * Conversion of PCI ID's to names (according to the pci.ids file)
174 * Call pci_lookup_name() to identify different types of ID's:
176 * VENDOR (vendorID) -> vendor
177 * DEVICE (vendorID, deviceID) -> device
178 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
179 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
180 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
181 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
182 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
183 * CLASS (classID) -> class
184 * PROGIF (classID, progif) -> programming interface
187 char *pci_lookup_name(struct pci_access
*a
, char *buf
, int size
, int flags
, ...);
189 int pci_load_name_list(struct pci_access
*a
); /* Called automatically by pci_lookup_*() when needed; returns success */
190 void pci_free_name_list(struct pci_access
*a
); /* Called automatically by pci_cleanup() */
191 void pci_set_name_list_path(struct pci_access
*a
, char *name
, int to_be_freed
);
192 void pci_id_cache_flush(struct pci_access
*a
);
194 enum pci_lookup_mode
{
195 PCI_LOOKUP_VENDOR
= 1, /* Vendor name (args: vendorID) */
196 PCI_LOOKUP_DEVICE
= 2, /* Device name (args: vendorID, deviceID) */
197 PCI_LOOKUP_CLASS
= 4, /* Device class (args: classID) */
198 PCI_LOOKUP_SUBSYSTEM
= 8,
199 PCI_LOOKUP_PROGIF
= 16, /* Programming interface (args: classID, prog_if) */
200 PCI_LOOKUP_NUMERIC
= 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
201 PCI_LOOKUP_NO_NUMBERS
= 0x20000, /* Return NULL if not found in the database; default is to print numerically */
202 PCI_LOOKUP_MIXED
= 0x40000, /* Include both numbers and names */
203 PCI_LOOKUP_NETWORK
= 0x80000, /* Try to resolve unknown ID's by DNS */
204 PCI_LOOKUP_SKIP_LOCAL
= 0x100000, /* Do not consult local database */
205 PCI_LOOKUP_CACHE
= 0x200000, /* Consult the local cache before using DNS */
206 PCI_LOOKUP_REFRESH_CACHE
= 0x400000, /* Forget all previously cached entries, but still allow updating the cache */