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 (params: none) */
27 PCI_ACCESS_SYS_BUS_PCI, /* Linux /sys/bus/pci (params: path) */
28 PCI_ACCESS_PROC_BUS_PCI, /* Linux /proc/bus/pci (params: path) */
29 PCI_ACCESS_I386_TYPE1, /* i386 ports, type 1 (params: none) */
30 PCI_ACCESS_I386_TYPE2, /* i386 ports, type 2 (params: none) */
31 PCI_ACCESS_FBSD_DEVICE, /* FreeBSD /dev/pci (params: path) */
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 (params: filename) */
40 /* Options you can change: */
41 unsigned int method; /* Access method */
42 char *method_params[PCI_ACCESS_MAX]; /* Parameters for the methods */
43 int writeable; /* Open in read/write mode */
44 int buscentric; /* Bus-centric view of the world */
46 char *id_file_name; /* Name of ID list file (use pci_set_name_list_path()) */
47 int free_id_name; /* Set if id_file_name is malloced */
48 int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
50 unsigned int id_lookup_mode; /* pci_lookup_mode flags which are set automatically */
51 /* Default: PCI_LOOKUP_CACHE */
53 int debugging; /* Turn on debugging messages */
55 /* Functions you can override: */
56 void (*error)(char *msg, ...); /* Write error message and quit */
57 void (*warning)(char *msg, ...); /* Write a warning message */
58 void (*debug)(char *msg, ...); /* Write a debugging message */
60 struct pci_dev *devices; /* Devices found on this bus */
62 /* Fields used internally: */
63 struct pci_methods *methods;
64 struct pci_param *params;
65 struct id_entry **id_hash; /* names.c */
66 struct id_bucket *current_id_bucket;
68 int id_cache_status; /* 0=not read, 1=read, 2=dirty */
69 int fd; /* proc: fd */
70 int fd_rw; /* proc: fd opened read-write */
71 struct pci_dev *cached_dev; /* proc: device the fd is for */
72 int fd_pos; /* proc: current position */
75 /* Initialize PCI access */
76 struct pci_access *pci_alloc(void);
77 void pci_init(struct pci_access *);
78 void pci_cleanup(struct pci_access *);
80 /* Scanning of devices */
81 void pci_scan_bus(struct pci_access *acc);
82 struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func); /* Raw access to specified device */
83 void pci_free_dev(struct pci_dev *);
90 struct pci_param *next; /* Please use pci_walk_params() for traversing the list */
91 char *param; /* Name of the parameter */
92 char *value; /* Value of the parameter */
93 int value_malloced; /* used internally */
96 char *pci_get_param(struct pci_access *acc, char *param);
97 int pci_set_param(struct pci_access *acc, char *param, char *value); /* 0 on success, -1 if no such parameter */
98 /* To traverse the list, call pci_walk_params repeatedly, first with prev=NULL, and do not modify the parameters during traversal. */
99 struct pci_param *pci_walk_params(struct pci_access *acc, struct pci_param *prev);
106 struct pci_dev *next; /* Next device in the chain */
107 u16 domain; /* PCI domain (host bridge) */
108 u8 bus, dev, func; /* Bus inside domain, device and function */
110 /* These fields are set by pci_fill_info() */
111 int known_fields; /* Set of info fields already known */
112 u16 vendor_id, device_id; /* Identity of the device */
113 u16 device_class; /* PCI device class */
114 int irq; /* IRQ number */
115 pciaddr_t base_addr[6]; /* Base addresses */
116 pciaddr_t size[6]; /* Region sizes */
117 pciaddr_t rom_base_addr; /* Expansion ROM base address */
118 pciaddr_t rom_size; /* Expansion ROM size */
120 /* Fields used internally: */
121 struct pci_access *access;
122 struct pci_methods *methods;
123 u8 *cache; /* Cached config registers */
125 int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
126 void *aux; /* Auxillary data */
129 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
130 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
132 u8 pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */
133 u16 pci_read_word(struct pci_dev *, int pos);
134 u32 pci_read_long(struct pci_dev *, int pos);
135 int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len);
136 int pci_write_byte(struct pci_dev *, int pos, u8 data);
137 int pci_write_word(struct pci_dev *, int pos, u16 data);
138 int pci_write_long(struct pci_dev *, int pos, u32 data);
139 int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len);
141 int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
143 #define PCI_FILL_IDENT 1
144 #define PCI_FILL_IRQ 2
145 #define PCI_FILL_BASES 4
146 #define PCI_FILL_ROM_BASE 8
147 #define PCI_FILL_SIZES 16
148 #define PCI_FILL_CLASS 32
149 #define PCI_FILL_RESCAN 0x10000
151 void pci_setup_cache(struct pci_dev *, u8 *cache, int len);
158 int domain, bus, slot, func; /* -1 = ANY */
162 void pci_filter_init(struct pci_access *, struct pci_filter *);
163 char *pci_filter_parse_slot(struct pci_filter *, char *);
164 char *pci_filter_parse_id(struct pci_filter *, char *);
165 int pci_filter_match(struct pci_filter *, struct pci_dev *);
168 * Conversion of PCI ID's to names (according to the pci.ids file)
170 * Call pci_lookup_name() to identify different types of ID's:
172 * VENDOR (vendorID) -> vendor
173 * DEVICE (vendorID, deviceID) -> device
174 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
175 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
176 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
177 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
178 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
179 * CLASS (classID) -> class
180 * PROGIF (classID, progif) -> programming interface
183 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...);
185 int pci_load_name_list(struct pci_access *a); /* Called automatically by pci_lookup_*() when needed; returns success */
186 void pci_free_name_list(struct pci_access *a); /* Called automatically by pci_cleanup() */
187 void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed);
188 void pci_id_cache_flush(struct pci_access *a);
190 enum pci_lookup_mode {
191 PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
192 PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
193 PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
194 PCI_LOOKUP_SUBSYSTEM = 8,
195 PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
196 PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
197 PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
198 PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */
199 PCI_LOOKUP_NETWORK = 0x80000, /* Try to resolve unknown ID's by DNS */
200 PCI_LOOKUP_SKIP_LOCAL = 0x100000, /* Do not consult local database */
201 PCI_LOOKUP_CACHE = 0x200000, /* Consult the local cache before using DNS */
202 PCI_LOOKUP_REFRESH_CACHE = 0x400000, /* Forget all previously cached entries, but still allow updating the cache */