2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice unmodified, this list of conditions, and the following
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/queue.h>
35 /* some PCI bus constants */
36 #define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */
37 #define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */
38 #define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */
40 typedef uint64_t pci_addr_t;
42 /* Config registers for PCI-PCI and PCI-Cardbus bridges. */
43 struct pcicfg_bridge {
51 /* Interesting values for PCI power management */
53 uint16_t pp_cap; /* PCI power management capabilities */
54 uint8_t pp_status; /* conf. space addr. of PM control/status reg */
55 uint8_t pp_bse; /* conf. space addr. of PM BSE reg */
56 uint8_t pp_data; /* conf. space addr. of PM data reg */
60 pci_addr_t pm_value; /* Raw BAR value */
63 STAILQ_ENTRY(pci_map) pm_link;
80 uint8_t vpd_reg; /* base register, + 2 for addr, + 4 data */
82 char *vpd_ident; /* string identifier */
84 struct vpd_readonly *vpd_ros;
86 struct vpd_write *vpd_w;
89 /* Interesting values for PCI MSI */
91 uint16_t msi_ctrl; /* Message Control */
92 uint8_t msi_location; /* Offset of MSI capability registers. */
93 uint8_t msi_msgnum; /* Number of messages */
94 int msi_alloc; /* Number of allocated messages. */
95 uint64_t msi_addr; /* Contents of address register. */
96 uint16_t msi_data; /* Contents of data register. */
100 /* Interesting values for PCI MSI-X */
102 uint64_t mv_address; /* Contents of address register. */
103 uint32_t mv_data; /* Contents of data register. */
107 struct msix_table_entry {
108 u_int mte_vector; /* 1-based index into msix_vectors array. */
113 uint16_t msix_ctrl; /* Message Control */
114 uint16_t msix_msgnum; /* Number of messages */
115 uint8_t msix_location; /* Offset of MSI-X capability registers. */
116 uint8_t msix_table_bar; /* BAR containing vector table. */
117 uint8_t msix_pba_bar; /* BAR containing PBA. */
118 uint32_t msix_table_offset;
119 uint32_t msix_pba_offset;
120 int msix_alloc; /* Number of allocated vectors. */
121 int msix_table_len; /* Length of virtual table. */
122 struct msix_table_entry *msix_table; /* Virtual table. */
123 struct msix_vector *msix_vectors; /* Array of allocated vectors. */
124 struct resource *msix_table_res; /* Resource containing vector table. */
125 struct resource *msix_pba_res; /* Resource containing PBA. */
128 /* Interesting values for HyperTransport */
130 uint8_t ht_slave; /* Non-zero if device is an HT slave. */
131 uint8_t ht_msimap; /* Offset of MSI mapping cap registers. */
132 uint16_t ht_msictrl; /* MSI mapping control */
133 uint64_t ht_msiaddr; /* MSI mapping base address */
136 /* Interesting values for PCI-express */
138 uint8_t pcie_location; /* Offset of PCI-e capability registers. */
139 uint8_t pcie_type; /* Device type. */
140 uint16_t pcie_flags; /* Device capabilities register. */
141 uint16_t pcie_device_ctl; /* Device control register. */
142 uint16_t pcie_link_ctl; /* Link control register. */
143 uint16_t pcie_slot_ctl; /* Slot control register. */
144 uint16_t pcie_root_ctl; /* Root control register. */
145 uint16_t pcie_device_ctl2; /* Second device control register. */
146 uint16_t pcie_link_ctl2; /* Second link control register. */
147 uint16_t pcie_slot_ctl2; /* Second slot control register. */
151 uint16_t pcix_command;
152 uint8_t pcix_location; /* Offset of PCI-X capability registers. */
159 #define PCICFG_VF 0x0001 /* Device is an SR-IOV Virtual Function */
161 /* config header information common to all header types */
162 typedef struct pcicfg {
163 struct device *dev; /* device which owns this */
165 STAILQ_HEAD(, pci_map) maps; /* BARs */
167 uint16_t subvendor; /* card vendor ID */
168 uint16_t subdevice; /* card device ID, assigned by card vendor */
169 uint16_t vendor; /* chip vendor ID */
170 uint16_t device; /* chip device ID, assigned by chip vendor */
172 uint16_t cmdreg; /* disable/enable chip and PCI options */
173 uint16_t statreg; /* supported PCI features and error state */
175 uint8_t baseclass; /* chip PCI class */
176 uint8_t subclass; /* chip PCI subclass */
177 uint8_t progif; /* chip PCI programming interface */
178 uint8_t revid; /* chip revision ID */
180 uint8_t hdrtype; /* chip config header type */
181 uint8_t cachelnsz; /* cache line size in 4byte units */
182 uint8_t intpin; /* PCI interrupt pin */
183 uint8_t intline; /* interrupt line (IRQ for PC arch) */
185 uint8_t mingnt; /* min. useful bus grant time in 250ns units */
186 uint8_t maxlat; /* max. tolerated bus grant latency in 250ns */
187 uint8_t lattimer; /* latency timer in units of 30ns bus cycles */
189 uint8_t mfdev; /* multi-function device (from hdrtype reg) */
190 uint8_t nummaps; /* actual number of PCI maps used */
192 uint32_t domain; /* PCI domain */
193 uint8_t bus; /* config space bus address */
194 uint8_t slot; /* config space slot address */
195 uint8_t func; /* config space function number */
197 uint32_t flags; /* flags defined above */
198 size_t devinfo_size; /* Size of devinfo for this bus type. */
200 struct pcicfg_bridge bridge; /* Bridges */
201 struct pcicfg_pp pp; /* Power management */
202 struct pcicfg_vpd vpd; /* Vital product data */
203 struct pcicfg_msi msi; /* PCI MSI */
204 struct pcicfg_msix msix; /* PCI MSI-X */
205 struct pcicfg_ht ht; /* HyperTransport */
206 struct pcicfg_pcie pcie; /* PCI Express */
207 struct pcicfg_pcix pcix; /* PCI-X */
208 struct pcicfg_iov *iov; /* SR-IOV */
209 struct pcicfg_vf vf; /* SR-IOV Virtual Function */
212 /* additional type 1 device config header information (PCI to PCI bridge) */
214 #define PCI_PPBMEMBASE(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff)
215 #define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff)
216 #define PCI_PPBIOBASE(h,l) ((((h)<<16) + ((l)<<8)) & ~0xfff)
217 #define PCI_PPBIOLIMIT(h,l) ((((h)<<16) + ((l)<<8)) | 0xfff)
220 pci_addr_t pmembase; /* base address of prefetchable memory */
221 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */
222 uint32_t membase; /* base address of memory window */
223 uint32_t memlimit; /* topmost address of memory window */
224 uint32_t iobase; /* base address of port window */
225 uint32_t iolimit; /* topmost address of port window */
226 uint16_t secstat; /* secondary bus status register */
227 uint16_t bridgectl; /* bridge control register */
228 uint8_t seclat; /* CardBus latency timer */
231 /* additional type 2 device config header information (CardBus bridge) */
234 uint32_t membase0; /* base address of memory window */
235 uint32_t memlimit0; /* topmost address of memory window */
236 uint32_t membase1; /* base address of memory window */
237 uint32_t memlimit1; /* topmost address of memory window */
238 uint32_t iobase0; /* base address of port window */
239 uint32_t iolimit0; /* topmost address of port window */
240 uint32_t iobase1; /* base address of port window */
241 uint32_t iolimit1; /* topmost address of port window */
242 uint32_t pccardif; /* PC Card 16bit IF legacy more base addr. */
243 uint16_t secstat; /* secondary bus status register */
244 uint16_t bridgectl; /* bridge control register */
245 uint8_t seclat; /* CardBus latency timer */
248 extern uint32_t pci_numdevs;
250 /* Only if the prerequisites are present */
251 #if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_)
253 STAILQ_ENTRY(pci_devinfo) pci_links;
254 struct resource_list resources;
256 struct pci_conf conf;
264 enum pci_device_ivars {
289 * Simplified accessors for pci devices
291 #define PCI_ACCESSOR(var, ivar, type) \
292 __BUS_ACCESSOR(pci, var, PCI, ivar, type)
294 PCI_ACCESSOR(subvendor, SUBVENDOR, uint16_t)
295 PCI_ACCESSOR(subdevice, SUBDEVICE, uint16_t)
296 PCI_ACCESSOR(vendor, VENDOR, uint16_t)
297 PCI_ACCESSOR(device, DEVICE, uint16_t)
298 PCI_ACCESSOR(devid, DEVID, uint32_t)
299 PCI_ACCESSOR(class, CLASS, uint8_t)
300 PCI_ACCESSOR(subclass, SUBCLASS, uint8_t)
301 PCI_ACCESSOR(progif, PROGIF, uint8_t)
302 PCI_ACCESSOR(revid, REVID, uint8_t)
303 PCI_ACCESSOR(intpin, INTPIN, uint8_t)
304 PCI_ACCESSOR(irq, IRQ, uint8_t)
305 PCI_ACCESSOR(domain, DOMAIN, uint32_t)
306 PCI_ACCESSOR(bus, BUS, uint8_t)
307 PCI_ACCESSOR(slot, SLOT, uint8_t)
308 PCI_ACCESSOR(function, FUNCTION, uint8_t)
309 PCI_ACCESSOR(ether, ETHADDR, uint8_t *)
310 PCI_ACCESSOR(cmdreg, CMDREG, uint8_t)
311 PCI_ACCESSOR(cachelnsz, CACHELNSZ, uint8_t)
312 PCI_ACCESSOR(mingnt, MINGNT, uint8_t)
313 PCI_ACCESSOR(maxlat, MAXLAT, uint8_t)
314 PCI_ACCESSOR(lattimer, LATTIMER, uint8_t)
319 * Operations on configuration space.
321 static __inline uint32_t
322 pci_read_config(device_t dev, int reg, int width)
324 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width);
328 pci_write_config(device_t dev, int reg, uint32_t val, int width)
330 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width);
334 * Ivars for pci bridges.
337 /*typedef enum pci_device_ivars pcib_device_ivars;*/
338 enum pcib_device_ivars {
343 #define PCIB_ACCESSOR(var, ivar, type) \
344 __BUS_ACCESSOR(pcib, var, PCIB, ivar, type)
346 PCIB_ACCESSOR(domain, DOMAIN, uint32_t)
347 PCIB_ACCESSOR(bus, BUS, uint32_t)
352 * PCI interrupt validation. Invalid interrupt values such as 0 or 128
353 * on i386 or other platforms should be mapped out in the MD pcireadconf
354 * code and not here, since the only MI invalid IRQ is 255.
356 #define PCI_INVALID_IRQ 255
357 #define PCI_INTERRUPT_VALID(x) ((x) != PCI_INVALID_IRQ)
360 * Convenience functions.
362 * These should be used in preference to manually manipulating
363 * configuration space.
366 pci_enable_busmaster(device_t dev)
368 return(PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev));
372 pci_disable_busmaster(device_t dev)
374 return(PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev));
378 pci_enable_io(device_t dev, int space)
380 return(PCI_ENABLE_IO(device_get_parent(dev), dev, space));
384 pci_disable_io(device_t dev, int space)
386 return(PCI_DISABLE_IO(device_get_parent(dev), dev, space));
390 pci_get_vpd_ident(device_t dev, const char **identptr)
392 return(PCI_GET_VPD_IDENT(device_get_parent(dev), dev, identptr));
396 pci_get_vpd_readonly(device_t dev, const char *kw, const char **vptr)
398 return(PCI_GET_VPD_READONLY(device_get_parent(dev), dev, kw, vptr));
402 * Check if the address range falls within the VGA defined address range(s)
405 pci_is_vga_ioport_range(u_long start, u_long end)
408 return (((start >= 0x3b0 && end <= 0x3bb) ||
409 (start >= 0x3c0 && end <= 0x3df)) ? 1 : 0);
413 pci_is_vga_memory_range(u_long start, u_long end)
416 return ((start >= 0xa0000 && end <= 0xbffff) ? 1 : 0);
420 * PCI power states are as defined by ACPI:
422 * D0 State in which device is on and running. It is receiving full
423 * power from the system and delivering full functionality to the user.
424 * D1 Class-specific low-power state in which device context may or may not
425 * be lost. Buses in D1 cannot do anything to the bus that would force
426 * devices on that bus to lose context.
427 * D2 Class-specific low-power state in which device context may or may
428 * not be lost. Attains greater power savings than D1. Buses in D2
429 * can cause devices on that bus to lose some context. Devices in D2
430 * must be prepared for the bus to be in D2 or higher.
431 * D3 State in which the device is off and not running. Device context is
432 * lost. Power can be removed from the device.
434 #define PCI_POWERSTATE_D0 0
435 #define PCI_POWERSTATE_D1 1
436 #define PCI_POWERSTATE_D2 2
437 #define PCI_POWERSTATE_D3 3
438 #define PCI_POWERSTATE_UNKNOWN -1
441 pci_set_powerstate(device_t dev, int state)
443 return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state);
447 pci_get_powerstate(device_t dev)
449 return PCI_GET_POWERSTATE(device_get_parent(dev), dev);
453 pci_find_cap(device_t dev, int capability, int *capreg)
455 return (PCI_FIND_CAP(device_get_parent(dev), dev, capability, capreg));
459 pci_find_extcap(device_t dev, int capability, int *capreg)
461 return (PCI_FIND_EXTCAP(device_get_parent(dev), dev, capability, capreg));
465 pci_find_htcap(device_t dev, int capability, int *capreg)
467 return (PCI_FIND_HTCAP(device_get_parent(dev), dev, capability, capreg));
471 pci_alloc_msi(device_t dev, int *count)
473 return (PCI_ALLOC_MSI(device_get_parent(dev), dev, count));
477 pci_alloc_msix(device_t dev, int *count)
479 return (PCI_ALLOC_MSIX(device_get_parent(dev), dev, count));
483 pci_enable_msi(device_t dev, uint64_t address, uint16_t data)
485 PCI_ENABLE_MSI(device_get_parent(dev), dev, address, data);
489 pci_enable_msix(device_t dev, u_int index, uint64_t address, uint32_t data)
491 PCI_ENABLE_MSIX(device_get_parent(dev), dev, index, address, data);
495 pci_disable_msi(device_t dev)
497 PCI_DISABLE_MSI(device_get_parent(dev), dev);
501 pci_remap_msix(device_t dev, int count, const u_int *vectors)
503 return (PCI_REMAP_MSIX(device_get_parent(dev), dev, count, vectors));
507 pci_release_msi(device_t dev)
509 return (PCI_RELEASE_MSI(device_get_parent(dev), dev));
513 pci_msi_count(device_t dev)
515 return (PCI_MSI_COUNT(device_get_parent(dev), dev));
519 pci_msix_count(device_t dev)
521 return (PCI_MSIX_COUNT(device_get_parent(dev), dev));
524 static __inline uint16_t
525 pci_get_rid(device_t dev)
527 return (PCI_GET_RID(device_get_parent(dev), dev));
531 pci_child_added(device_t dev)
534 return (PCI_CHILD_ADDED(device_get_parent(dev), dev));
537 device_t pci_find_bsf(uint8_t, uint8_t, uint8_t);
538 device_t pci_find_dbsf(uint32_t, uint8_t, uint8_t, uint8_t);
539 device_t pci_find_device(uint16_t, uint16_t);
540 device_t pci_find_class(uint8_t class, uint8_t subclass);
542 /* Can be used by drivers to manage the MSI-X table. */
543 int pci_pending_msix(device_t dev, u_int index);
545 int pci_msi_device_blacklisted(device_t dev);
546 int pci_msix_device_blacklisted(device_t dev);
548 void pci_ht_map_msi(device_t dev, uint64_t addr);
550 int pci_get_max_read_req(device_t dev);
551 void pci_restore_state(device_t dev);
552 void pci_save_state(device_t dev);
553 int pci_set_max_read_req(device_t dev, int size);
556 #ifdef BUS_SPACE_MAXADDR
557 #if (BUS_SPACE_MAXADDR > 0xFFFFFFFF)
558 #define PCI_DMA_BOUNDARY 0x100000000
560 #define PCI_DMA_BOUNDARY 0
564 #endif /* _SYS_BUS_H_ */
567 * cdev switch for control device, initialised in generic PCI code
569 extern struct cdevsw pcicdev;
572 * List of all PCI devices, generation count for the list.
574 STAILQ_HEAD(devlist, pci_devinfo);
576 extern struct devlist pci_devq;
577 extern uint32_t pci_generation;
579 struct pci_map *pci_find_bar(device_t dev, int reg);
580 int pci_bar_enabled(device_t dev, struct pci_map *pm);
581 struct pcicfg_vpd *pci_fetch_vpd_list(device_t dev);
583 #define VGA_PCI_BIOS_SHADOW_ADDR 0xC0000
584 #define VGA_PCI_BIOS_SHADOW_SIZE 131072
586 int vga_pci_is_boot_display(device_t dev);
587 void * vga_pci_map_bios(device_t dev, size_t *size);
588 void vga_pci_unmap_bios(device_t dev, void *bios);
589 int vga_pci_repost(device_t dev);
591 #endif /* _PCIVAR_H_ */