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