4 * Copyright (c) 1997--2007 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
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 */
45 char *id_file_name; /* Name of ID list file */
46 int free_id_name; /* Set if id_file_name is malloced */
47 int numeric_ids; /* Enforce PCI_LOOKUP_NUMERIC (>1 => PCI_LOOKUP_MIXED) */
48 int network_ids; /* Try DNS lookups on unknown ID's */
49 char *id_domain; /* DNS domain used for the lookups */ /* FIXME: set function? */
50 int debugging; /* Turn on debugging messages */
52 /* Functions you can override: */
53 void (*error)(char *msg, ...); /* Write error message and quit */
54 void (*warning)(char *msg, ...); /* Write a warning message */
55 void (*debug)(char *msg, ...); /* Write a debugging message */
57 struct pci_dev *devices; /* Devices found on this bus */
59 /* Fields used internally: */
60 struct pci_methods *methods;
61 struct id_entry **id_hash; /* names.c */
62 struct id_bucket *current_id_bucket;
64 int fd; /* proc: fd */
65 int fd_rw; /* proc: fd opened read-write */
66 struct pci_dev *cached_dev; /* proc: device the fd is for */
67 int fd_pos; /* proc: current position */
70 /* Initialize PCI access */
71 struct pci_access *pci_alloc(void);
72 void pci_init(struct pci_access *);
73 void pci_cleanup(struct pci_access *);
75 /* Scanning of devices */
76 void pci_scan_bus(struct pci_access *acc);
77 struct pci_dev *pci_get_dev(struct pci_access *acc, int domain, int bus, int dev, int func); /* Raw access to specified device */
78 void pci_free_dev(struct pci_dev *);
85 struct pci_dev *next; /* Next device in the chain */
86 u16 domain; /* PCI domain (host bridge) */
87 u8 bus, dev, func; /* Bus inside domain, device and function */
89 /* These fields are set by pci_fill_info() */
90 int known_fields; /* Set of info fields already known */
91 u16 vendor_id, device_id; /* Identity of the device */
92 u16 device_class; /* PCI device class */
93 int irq; /* IRQ number */
94 pciaddr_t base_addr[6]; /* Base addresses */
95 pciaddr_t size[6]; /* Region sizes */
96 pciaddr_t rom_base_addr; /* Expansion ROM base address */
97 pciaddr_t rom_size; /* Expansion ROM size */
99 /* Fields used internally: */
100 struct pci_access *access;
101 struct pci_methods *methods;
102 u8 *cache; /* Cached config registers */
104 int hdrtype; /* Cached low 7 bits of header type, -1 if unknown */
105 void *aux; /* Auxillary data */
108 #define PCI_ADDR_IO_MASK (~(pciaddr_t) 0x3)
109 #define PCI_ADDR_MEM_MASK (~(pciaddr_t) 0xf)
111 u8 pci_read_byte(struct pci_dev *, int pos); /* Access to configuration space */
112 u16 pci_read_word(struct pci_dev *, int pos);
113 u32 pci_read_long(struct pci_dev *, int pos);
114 int pci_read_block(struct pci_dev *, int pos, u8 *buf, int len);
115 int pci_write_byte(struct pci_dev *, int pos, u8 data);
116 int pci_write_word(struct pci_dev *, int pos, u16 data);
117 int pci_write_long(struct pci_dev *, int pos, u32 data);
118 int pci_write_block(struct pci_dev *, int pos, u8 *buf, int len);
120 int pci_fill_info(struct pci_dev *, int flags); /* Fill in device information */
122 #define PCI_FILL_IDENT 1
123 #define PCI_FILL_IRQ 2
124 #define PCI_FILL_BASES 4
125 #define PCI_FILL_ROM_BASE 8
126 #define PCI_FILL_SIZES 16
127 #define PCI_FILL_CLASS 32
128 #define PCI_FILL_RESCAN 0x10000
130 void pci_setup_cache(struct pci_dev *, u8 *cache, int len);
137 int domain, bus, slot, func; /* -1 = ANY */
141 void pci_filter_init(struct pci_access *, struct pci_filter *);
142 char *pci_filter_parse_slot(struct pci_filter *, char *);
143 char *pci_filter_parse_id(struct pci_filter *, char *);
144 int pci_filter_match(struct pci_filter *, struct pci_dev *);
147 * Conversion of PCI ID's to names (according to the pci.ids file)
149 * Call pci_lookup_name() to identify different types of ID's:
151 * VENDOR (vendorID) -> vendor
152 * DEVICE (vendorID, deviceID) -> device
153 * VENDOR | DEVICE (vendorID, deviceID) -> combined vendor and device
154 * SUBSYSTEM | VENDOR (subvendorID) -> subsystem vendor
155 * SUBSYSTEM | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> subsystem device
156 * SUBSYSTEM | VENDOR | DEVICE (vendorID, deviceID, subvendorID, subdevID) -> combined subsystem v+d
157 * SUBSYSTEM | ... (-1, -1, subvendorID, subdevID) -> generic subsystem
158 * CLASS (classID) -> class
159 * PROGIF (classID, progif) -> programming interface
162 char *pci_lookup_name(struct pci_access *a, char *buf, int size, int flags, ...);
164 int pci_load_name_list(struct pci_access *a); /* Called automatically by pci_lookup_*() when needed; returns success */
165 void pci_free_name_list(struct pci_access *a); /* Called automatically by pci_cleanup() */
166 void pci_set_name_list_path(struct pci_access *a, char *name, int to_be_freed);
168 enum pci_lookup_mode {
169 PCI_LOOKUP_VENDOR = 1, /* Vendor name (args: vendorID) */
170 PCI_LOOKUP_DEVICE = 2, /* Device name (args: vendorID, deviceID) */
171 PCI_LOOKUP_CLASS = 4, /* Device class (args: classID) */
172 PCI_LOOKUP_SUBSYSTEM = 8,
173 PCI_LOOKUP_PROGIF = 16, /* Programming interface (args: classID, prog_if) */
174 PCI_LOOKUP_NUMERIC = 0x10000, /* Want only formatted numbers; default if access->numeric_ids is set */
175 PCI_LOOKUP_NO_NUMBERS = 0x20000, /* Return NULL if not found in the database; default is to print numerically */
176 PCI_LOOKUP_MIXED = 0x40000, /* Include both numbers and names */