2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice unmodified, this list of conditions, and the following
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/queue.h>
36 #include <sys/eventhandler.h>
38 /* some PCI bus constants */
39 #define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */
40 #define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */
41 #define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */
43 typedef uint64_t pci_addr_t;
45 /* Config registers for PCI-PCI and PCI-Cardbus bridges. */
46 struct pcicfg_bridge {
54 /* Interesting values for PCI power management */
56 uint16_t pp_cap; /* PCI power management capabilities */
57 uint8_t pp_status; /* conf. space addr. of PM control/status reg */
58 uint8_t pp_bse; /* conf. space addr. of PM BSE reg */
59 uint8_t pp_data; /* conf. space addr. of PM data reg */
63 pci_addr_t pm_value; /* Raw BAR value */
66 STAILQ_ENTRY(pci_map) pm_link;
83 uint8_t vpd_reg; /* base register, + 2 for addr, + 4 data */
85 char *vpd_ident; /* string identifier */
87 struct vpd_readonly *vpd_ros;
89 struct vpd_write *vpd_w;
92 /* Interesting values for PCI MSI */
94 uint16_t msi_ctrl; /* Message Control */
95 uint8_t msi_location; /* Offset of MSI capability registers. */
96 uint8_t msi_msgnum; /* Number of messages */
97 int msi_alloc; /* Number of allocated messages. */
98 uint64_t msi_addr; /* Contents of address register. */
99 uint16_t msi_data; /* Contents of data register. */
103 /* Interesting values for PCI MSI-X */
105 uint64_t mv_address; /* Contents of address register. */
106 uint32_t mv_data; /* Contents of data register. */
110 struct msix_table_entry {
111 u_int mte_vector; /* 1-based index into msix_vectors array. */
116 uint16_t msix_ctrl; /* Message Control */
117 uint16_t msix_msgnum; /* Number of messages */
118 uint8_t msix_location; /* Offset of MSI-X capability registers. */
119 uint8_t msix_table_bar; /* BAR containing vector table. */
120 uint8_t msix_pba_bar; /* BAR containing PBA. */
121 uint32_t msix_table_offset;
122 uint32_t msix_pba_offset;
123 int msix_alloc; /* Number of allocated vectors. */
124 int msix_table_len; /* Length of virtual table. */
125 struct msix_table_entry *msix_table; /* Virtual table. */
126 struct msix_vector *msix_vectors; /* Array of allocated vectors. */
127 struct resource *msix_table_res; /* Resource containing vector table. */
128 struct resource *msix_pba_res; /* Resource containing PBA. */
131 /* Interesting values for HyperTransport */
133 uint8_t ht_slave; /* Non-zero if device is an HT slave. */
134 uint8_t ht_msimap; /* Offset of MSI mapping cap registers. */
135 uint16_t ht_msictrl; /* MSI mapping control */
136 uint64_t ht_msiaddr; /* MSI mapping base address */
139 /* Interesting values for PCI-express */
141 uint8_t pcie_location; /* Offset of PCI-e capability registers. */
142 uint8_t pcie_type; /* Device type. */
143 uint16_t pcie_flags; /* Device capabilities register. */
144 uint16_t pcie_device_ctl; /* Device control register. */
145 uint16_t pcie_link_ctl; /* Link control register. */
146 uint16_t pcie_slot_ctl; /* Slot control register. */
147 uint16_t pcie_root_ctl; /* Root control register. */
148 uint16_t pcie_device_ctl2; /* Second device control register. */
149 uint16_t pcie_link_ctl2; /* Second link control register. */
150 uint16_t pcie_slot_ctl2; /* Second slot control register. */
154 uint16_t pcix_command;
155 uint8_t pcix_location; /* Offset of PCI-X capability registers. */
162 struct pci_ea_entry {
166 uint64_t eae_max_offset;
167 uint32_t eae_cfg_offset;
168 STAILQ_ENTRY(pci_ea_entry) eae_link;
172 int ea_location; /* Structure offset in Configuration Header */
173 STAILQ_HEAD(, pci_ea_entry) ea_entries; /* EA entries */
176 #define PCICFG_VF 0x0001 /* Device is an SR-IOV Virtual Function */
178 /* config header information common to all header types */
179 typedef struct pcicfg {
180 device_t dev; /* device which owns this */
182 STAILQ_HEAD(, pci_map) maps; /* BARs */
184 uint16_t subvendor; /* card vendor ID */
185 uint16_t subdevice; /* card device ID, assigned by card vendor */
186 uint16_t vendor; /* chip vendor ID */
187 uint16_t device; /* chip device ID, assigned by chip vendor */
189 uint16_t cmdreg; /* disable/enable chip and PCI options */
190 uint16_t statreg; /* supported PCI features and error state */
192 uint8_t baseclass; /* chip PCI class */
193 uint8_t subclass; /* chip PCI subclass */
194 uint8_t progif; /* chip PCI programming interface */
195 uint8_t revid; /* chip revision ID */
197 uint8_t hdrtype; /* chip config header type */
198 uint8_t cachelnsz; /* cache line size in 4byte units */
199 uint8_t intpin; /* PCI interrupt pin */
200 uint8_t intline; /* interrupt line (IRQ for PC arch) */
202 uint8_t mingnt; /* min. useful bus grant time in 250ns units */
203 uint8_t maxlat; /* max. tolerated bus grant latency in 250ns */
204 uint8_t lattimer; /* latency timer in units of 30ns bus cycles */
206 uint8_t mfdev; /* multi-function device (from hdrtype reg) */
207 uint8_t nummaps; /* actual number of PCI maps used */
209 uint32_t domain; /* PCI domain */
210 uint8_t bus; /* config space bus address */
211 uint8_t slot; /* config space slot address */
212 uint8_t func; /* config space function number */
214 uint32_t flags; /* flags defined above */
216 struct pcicfg_bridge bridge; /* Bridges */
217 struct pcicfg_pp pp; /* Power management */
218 struct pcicfg_vpd vpd; /* Vital product data */
219 struct pcicfg_msi msi; /* PCI MSI */
220 struct pcicfg_msix msix; /* PCI MSI-X */
221 struct pcicfg_ht ht; /* HyperTransport */
222 struct pcicfg_pcie pcie; /* PCI Express */
223 struct pcicfg_pcix pcix; /* PCI-X */
224 struct pcicfg_iov *iov; /* SR-IOV */
225 struct pcicfg_vf vf; /* SR-IOV Virtual Function */
226 struct pcicfg_ea ea; /* Enhanced Allocation */
229 /* additional type 1 device config header information (PCI to PCI bridge) */
232 pci_addr_t pmembase; /* base address of prefetchable memory */
233 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */
234 uint32_t membase; /* base address of memory window */
235 uint32_t memlimit; /* topmost address of memory window */
236 uint32_t iobase; /* base address of port window */
237 uint32_t iolimit; /* topmost address of port window */
238 uint16_t secstat; /* secondary bus status register */
239 uint16_t bridgectl; /* bridge control register */
240 uint8_t seclat; /* CardBus latency timer */
243 /* additional type 2 device config header information (CardBus bridge) */
246 uint32_t membase0; /* base address of memory window */
247 uint32_t memlimit0; /* topmost address of memory window */
248 uint32_t membase1; /* base address of memory window */
249 uint32_t memlimit1; /* topmost address of memory window */
250 uint32_t iobase0; /* base address of port window */
251 uint32_t iolimit0; /* topmost address of port window */
252 uint32_t iobase1; /* base address of port window */
253 uint32_t iolimit1; /* topmost address of port window */
254 uint32_t pccardif; /* PC Card 16bit IF legacy more base addr. */
255 uint16_t secstat; /* secondary bus status register */
256 uint16_t bridgectl; /* bridge control register */
257 uint8_t seclat; /* CardBus latency timer */
260 extern uint32_t pci_numdevs;
262 struct pci_device_table {
263 #if BYTE_ORDER == LITTLE_ENDIAN
267 match_flag_subvendor:1,
268 match_flag_subdevice:1,
270 match_flag_subclass:1,
277 match_flag_subclass:1,
279 match_flag_subdevice:1,
280 match_flag_subvendor:1,
292 uintptr_t driver_data;
296 #define PCI_DEV(v, d) \
297 .match_flag_vendor = 1, .vendor = (v), \
298 .match_flag_device = 1, .device = (d)
299 #define PCI_SUBDEV(sv, sd) \
300 .match_flag_subvendor = 1, .subvendor = (sv), \
301 .match_flag_subdevice = 1, .subdevice = (sd)
302 #define PCI_CLASS(x) \
303 .match_flag_class = 1, .class_id = (x)
304 #define PCI_SUBCLASS(x) \
305 .match_flag_subclass = 1, .subclass = (x)
306 #define PCI_REVID(x) \
307 .match_flag_revid = 1, .revid = (x)
308 #define PCI_DESCR(x) \
310 #define PCI_PNP_STR \
311 "M16:mask;U16:vendor;U16:device;U16:subvendor;U16:subdevice;" \
312 "U16:class;U16:subclass;U16:revid;"
313 #define PCI_PNP_INFO(table) \
314 MODULE_PNP_INFO(PCI_PNP_STR, pci, table, table, sizeof(table[0]), \
315 sizeof(table) / sizeof(table[0]))
317 const struct pci_device_table *pci_match_device(device_t child,
318 const struct pci_device_table *id, size_t nelt);
319 #define PCI_MATCH(child, table) \
320 pci_match_device(child, (table), nitems(table));
322 /* Only if the prerequisites are present */
323 #if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_)
325 STAILQ_ENTRY(pci_devinfo) pci_links;
326 struct resource_list resources;
328 struct pci_conf conf;
336 enum pci_device_ivars {
361 * Simplified accessors for pci devices
363 #define PCI_ACCESSOR(var, ivar, type) \
364 __BUS_ACCESSOR(pci, var, PCI, ivar, type)
366 PCI_ACCESSOR(subvendor, SUBVENDOR, uint16_t)
367 PCI_ACCESSOR(subdevice, SUBDEVICE, uint16_t)
368 PCI_ACCESSOR(vendor, VENDOR, uint16_t)
369 PCI_ACCESSOR(device, DEVICE, uint16_t)
370 PCI_ACCESSOR(devid, DEVID, uint32_t)
371 PCI_ACCESSOR(class, CLASS, uint8_t)
372 PCI_ACCESSOR(subclass, SUBCLASS, uint8_t)
373 PCI_ACCESSOR(progif, PROGIF, uint8_t)
374 PCI_ACCESSOR(revid, REVID, uint8_t)
375 PCI_ACCESSOR(intpin, INTPIN, uint8_t)
376 PCI_ACCESSOR(irq, IRQ, uint8_t)
377 PCI_ACCESSOR(domain, DOMAIN, uint32_t)
378 PCI_ACCESSOR(bus, BUS, uint8_t)
379 PCI_ACCESSOR(slot, SLOT, uint8_t)
380 PCI_ACCESSOR(function, FUNCTION, uint8_t)
381 PCI_ACCESSOR(ether, ETHADDR, uint8_t *)
382 PCI_ACCESSOR(cmdreg, CMDREG, uint8_t)
383 PCI_ACCESSOR(cachelnsz, CACHELNSZ, uint8_t)
384 PCI_ACCESSOR(mingnt, MINGNT, uint8_t)
385 PCI_ACCESSOR(maxlat, MAXLAT, uint8_t)
386 PCI_ACCESSOR(lattimer, LATTIMER, uint8_t)
391 * Operations on configuration space.
393 static __inline uint32_t
394 pci_read_config(device_t dev, int reg, int width)
396 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width);
400 pci_write_config(device_t dev, int reg, uint32_t val, int width)
402 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width);
406 * Ivars for pci bridges.
409 /*typedef enum pci_device_ivars pcib_device_ivars;*/
410 enum pcib_device_ivars {
415 #define PCIB_ACCESSOR(var, ivar, type) \
416 __BUS_ACCESSOR(pcib, var, PCIB, ivar, type)
418 PCIB_ACCESSOR(domain, DOMAIN, uint32_t)
419 PCIB_ACCESSOR(bus, BUS, uint32_t)
424 * PCI interrupt validation. Invalid interrupt values such as 0 or 128
425 * on i386 or other platforms should be mapped out in the MD pcireadconf
426 * code and not here, since the only MI invalid IRQ is 255.
428 #define PCI_INVALID_IRQ 255
429 #define PCI_INTERRUPT_VALID(x) ((x) != PCI_INVALID_IRQ)
432 * Convenience functions.
434 * These should be used in preference to manually manipulating
435 * configuration space.
438 pci_enable_busmaster(device_t dev)
440 return(PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev));
444 pci_disable_busmaster(device_t dev)
446 return(PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev));
450 pci_enable_io(device_t dev, int space)
452 return(PCI_ENABLE_IO(device_get_parent(dev), dev, space));
456 pci_disable_io(device_t dev, int space)
458 return(PCI_DISABLE_IO(device_get_parent(dev), dev, space));
462 pci_get_vpd_ident(device_t dev, const char **identptr)
464 return(PCI_GET_VPD_IDENT(device_get_parent(dev), dev, identptr));
468 pci_get_vpd_readonly(device_t dev, const char *kw, const char **vptr)
470 return(PCI_GET_VPD_READONLY(device_get_parent(dev), dev, kw, vptr));
474 * Check if the address range falls within the VGA defined address range(s)
477 pci_is_vga_ioport_range(rman_res_t start, rman_res_t end)
480 return (((start >= 0x3b0 && end <= 0x3bb) ||
481 (start >= 0x3c0 && end <= 0x3df)) ? 1 : 0);
485 pci_is_vga_memory_range(rman_res_t start, rman_res_t end)
488 return ((start >= 0xa0000 && end <= 0xbffff) ? 1 : 0);
492 * PCI power states are as defined by ACPI:
494 * D0 State in which device is on and running. It is receiving full
495 * power from the system and delivering full functionality to the user.
496 * D1 Class-specific low-power state in which device context may or may not
497 * be lost. Buses in D1 cannot do anything to the bus that would force
498 * devices on that bus to lose context.
499 * D2 Class-specific low-power state in which device context may or may
500 * not be lost. Attains greater power savings than D1. Buses in D2
501 * can cause devices on that bus to lose some context. Devices in D2
502 * must be prepared for the bus to be in D2 or higher.
503 * D3 State in which the device is off and not running. Device context is
504 * lost. Power can be removed from the device.
506 #define PCI_POWERSTATE_D0 0
507 #define PCI_POWERSTATE_D1 1
508 #define PCI_POWERSTATE_D2 2
509 #define PCI_POWERSTATE_D3 3
510 #define PCI_POWERSTATE_UNKNOWN -1
513 pci_set_powerstate(device_t dev, int state)
515 return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state);
519 pci_get_powerstate(device_t dev)
521 return PCI_GET_POWERSTATE(device_get_parent(dev), dev);
525 pci_find_cap(device_t dev, int capability, int *capreg)
527 return (PCI_FIND_CAP(device_get_parent(dev), dev, capability, capreg));
531 pci_find_next_cap(device_t dev, int capability, int start, int *capreg)
533 return (PCI_FIND_NEXT_CAP(device_get_parent(dev), dev, capability, start,
538 pci_find_extcap(device_t dev, int capability, int *capreg)
540 return (PCI_FIND_EXTCAP(device_get_parent(dev), dev, capability, capreg));
544 pci_find_next_extcap(device_t dev, int capability, int start, int *capreg)
546 return (PCI_FIND_NEXT_EXTCAP(device_get_parent(dev), dev, capability,
551 pci_find_htcap(device_t dev, int capability, int *capreg)
553 return (PCI_FIND_HTCAP(device_get_parent(dev), dev, capability, capreg));
557 pci_find_next_htcap(device_t dev, int capability, int start, int *capreg)
559 return (PCI_FIND_NEXT_HTCAP(device_get_parent(dev), dev, capability,
564 pci_alloc_msi(device_t dev, int *count)
566 return (PCI_ALLOC_MSI(device_get_parent(dev), dev, count));
570 pci_alloc_msix(device_t dev, int *count)
572 return (PCI_ALLOC_MSIX(device_get_parent(dev), dev, count));
576 pci_enable_msi(device_t dev, uint64_t address, uint16_t data)
578 PCI_ENABLE_MSI(device_get_parent(dev), dev, address, data);
582 pci_enable_msix(device_t dev, u_int index, uint64_t address, uint32_t data)
584 PCI_ENABLE_MSIX(device_get_parent(dev), dev, index, address, data);
588 pci_disable_msi(device_t dev)
590 PCI_DISABLE_MSI(device_get_parent(dev), dev);
594 pci_remap_msix(device_t dev, int count, const u_int *vectors)
596 return (PCI_REMAP_MSIX(device_get_parent(dev), dev, count, vectors));
600 pci_release_msi(device_t dev)
602 return (PCI_RELEASE_MSI(device_get_parent(dev), dev));
606 pci_msi_count(device_t dev)
608 return (PCI_MSI_COUNT(device_get_parent(dev), dev));
612 pci_msix_count(device_t dev)
614 return (PCI_MSIX_COUNT(device_get_parent(dev), dev));
618 pci_msix_pba_bar(device_t dev)
620 return (PCI_MSIX_PBA_BAR(device_get_parent(dev), dev));
624 pci_msix_table_bar(device_t dev)
626 return (PCI_MSIX_TABLE_BAR(device_get_parent(dev), dev));
630 pci_get_id(device_t dev, enum pci_id_type type, uintptr_t *id)
632 return (PCI_GET_ID(device_get_parent(dev), dev, type, id));
636 * This is the deprecated interface, there is no way to tell the difference
637 * between a failure and a valid value that happens to be the same as the
640 static __inline uint16_t
641 pci_get_rid(device_t dev)
645 if (pci_get_id(dev, PCI_ID_RID, &rid) != 0)
652 pci_child_added(device_t dev)
655 return (PCI_CHILD_ADDED(device_get_parent(dev), dev));
658 device_t pci_find_bsf(uint8_t, uint8_t, uint8_t);
659 device_t pci_find_dbsf(uint32_t, uint8_t, uint8_t, uint8_t);
660 device_t pci_find_device(uint16_t, uint16_t);
661 device_t pci_find_class(uint8_t class, uint8_t subclass);
663 /* Can be used by drivers to manage the MSI-X table. */
664 int pci_pending_msix(device_t dev, u_int index);
666 int pci_msi_device_blacklisted(device_t dev);
667 int pci_msix_device_blacklisted(device_t dev);
669 void pci_ht_map_msi(device_t dev, uint64_t addr);
671 device_t pci_find_pcie_root_port(device_t dev);
672 int pci_get_max_payload(device_t dev);
673 int pci_get_max_read_req(device_t dev);
674 void pci_restore_state(device_t dev);
675 void pci_save_state(device_t dev);
676 int pci_set_max_read_req(device_t dev, int size);
677 uint32_t pcie_read_config(device_t dev, int reg, int width);
678 void pcie_write_config(device_t dev, int reg, uint32_t value, int width);
679 uint32_t pcie_adjust_config(device_t dev, int reg, uint32_t mask,
680 uint32_t value, int width);
681 bool pcie_flr(device_t dev, u_int max_delay, bool force);
682 int pcie_get_max_completion_timeout(device_t dev);
683 bool pcie_wait_for_pending_transactions(device_t dev, u_int max_delay);
685 #ifdef BUS_SPACE_MAXADDR
686 #if (BUS_SPACE_MAXADDR > 0xFFFFFFFF)
687 #define PCI_DMA_BOUNDARY 0x100000000
689 #define PCI_DMA_BOUNDARY 0
693 #endif /* _SYS_BUS_H_ */
696 * cdev switch for control device, initialised in generic PCI code
698 extern struct cdevsw pcicdev;
701 * List of all PCI devices, generation count for the list.
703 STAILQ_HEAD(devlist, pci_devinfo);
705 extern struct devlist pci_devq;
706 extern uint32_t pci_generation;
708 struct pci_map *pci_find_bar(device_t dev, int reg);
709 int pci_bar_enabled(device_t dev, struct pci_map *pm);
710 struct pcicfg_vpd *pci_fetch_vpd_list(device_t dev);
712 #define VGA_PCI_BIOS_SHADOW_ADDR 0xC0000
713 #define VGA_PCI_BIOS_SHADOW_SIZE 131072
715 int vga_pci_is_boot_display(device_t dev);
716 void * vga_pci_map_bios(device_t dev, size_t *size);
717 void vga_pci_unmap_bios(device_t dev, void *bios);
718 int vga_pci_repost(device_t dev);
721 * Global eventhandlers invoked when PCI devices are added or removed
724 typedef void (*pci_event_fn)(void *arg, device_t dev);
725 EVENTHANDLER_DECLARE(pci_add_device, pci_event_fn);
726 EVENTHANDLER_DECLARE(pci_delete_device, pci_event_fn);
728 #endif /* _PCIVAR_H_ */