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