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.
26 * $FreeBSD: src/sys/dev/pci/pcivar.h,v 1.80.2.1.4.1 2009/04/15 03:14:26 kensmith Exp $
34 #include <sys/queue.h>
37 /* some PCI bus constants */
39 #define PCI_DOMAINMAX 65535 /* highest supported domain number */
40 #define PCI_BUSMAX 255 /* highest supported bus number */
41 #define PCI_SLOTMAX 31 /* highest supported slot number */
42 #define PCI_FUNCMAX 7 /* highest supported function number */
43 #define PCI_REGMAX 255 /* highest supported config register addr. */
45 #define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */
46 #define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */
47 #define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */
49 typedef uint64_t pci_addr_t;
51 /* Interesting values for PCI power management */
53 uint16_t pp_cap; /* PCI power management capabilities */
54 uint8_t pp_status; /* config space address of PCI power status reg */
55 uint8_t pp_pmcsr; /* config space address of PMCSR reg */
56 uint8_t pp_data; /* config space address of PCI power data reg */
72 uint8_t vpd_reg; /* base register, + 2 for addr, + 4 data */
74 char *vpd_ident; /* string identifier */
76 struct vpd_readonly *vpd_ros;
78 struct vpd_write *vpd_w;
81 /* Interesting values for PCI MSI */
83 uint16_t msi_ctrl; /* Message Control */
84 uint8_t msi_location; /* Offset of MSI capability registers. */
85 uint8_t msi_msgnum; /* Number of messages */
86 int msi_alloc; /* Number of allocated messages. */
87 uint64_t msi_addr; /* Contents of address register. */
88 uint16_t msi_data; /* Contents of data register. */
92 /* Interesting values for PCI MSI-X */
94 uint64_t mv_address; /* Contents of address register. */
95 uint32_t mv_data; /* Contents of data register. */
99 struct msix_table_entry {
100 u_int mte_vector; /* 1-based index into msix_vectors array. */
105 uint16_t msix_ctrl; /* Message Control */
106 uint16_t msix_msgnum; /* Number of messages */
107 uint8_t msix_location; /* Offset of MSI-X capability registers. */
108 uint8_t msix_table_bar; /* BAR containing vector table. */
109 uint8_t msix_pba_bar; /* BAR containing PBA. */
110 uint32_t msix_table_offset;
111 uint32_t msix_pba_offset;
112 int msix_alloc; /* Number of allocated vectors. */
113 int msix_table_len; /* Length of virtual table. */
114 struct msix_table_entry *msix_table; /* Virtual table. */
115 struct msix_vector *msix_vectors; /* Array of allocated vectors. */
116 struct resource *msix_table_res; /* Resource containing vector table. */
117 struct resource *msix_pba_res; /* Resource containing PBA. */
120 /* Interesting values for HyperTransport */
122 uint8_t ht_slave; /* Non-zero if device is an HT slave. */
123 uint8_t ht_msimap; /* Offset of MSI mapping cap registers. */
124 uint16_t ht_msictrl; /* MSI mapping control */
125 uint64_t ht_msiaddr; /* MSI mapping base address */
128 /* Interesting values for PCI Express capability */
130 uint8_t expr_ptr; /* capability ptr */
131 uint16_t expr_cap; /* capabilities */
132 uint32_t expr_slotcap; /* slot capabilities */
135 /* Interesting values for PCI-X */
140 /* config header information common to all header types */
141 typedef struct pcicfg {
142 struct device *dev; /* device which owns this */
144 uint32_t bar[PCI_MAXMAPS_0]; /* BARs */
145 uint32_t bios; /* BIOS mapping */
147 uint16_t subvendor; /* card vendor ID */
148 uint16_t subdevice; /* card device ID, assigned by card vendor */
149 uint16_t vendor; /* chip vendor ID */
150 uint16_t device; /* chip device ID, assigned by chip vendor */
152 uint16_t cmdreg; /* disable/enable chip and PCI options */
153 uint16_t statreg; /* supported PCI features and error state */
155 uint8_t baseclass; /* chip PCI class */
156 uint8_t subclass; /* chip PCI subclass */
157 uint8_t progif; /* chip PCI programming interface */
158 uint8_t revid; /* chip revision ID */
160 uint8_t hdrtype; /* chip config header type */
161 uint8_t cachelnsz; /* cache line size in 4byte units */
162 uint8_t intpin; /* PCI interrupt pin */
163 uint8_t intline; /* interrupt line (IRQ for PC arch) */
165 uint8_t mingnt; /* min. useful bus grant time in 250ns units */
166 uint8_t maxlat; /* max. tolerated bus grant latency in 250ns */
167 uint8_t lattimer; /* latency timer in units of 30ns bus cycles */
169 uint8_t mfdev; /* multi-function device (from hdrtype reg) */
170 uint8_t nummaps; /* actual number of PCI maps used */
172 uint32_t domain; /* PCI domain */
173 uint8_t bus; /* config space bus address */
174 uint8_t slot; /* config space slot address */
175 uint8_t func; /* config space function number */
178 uint8_t secondarybus; /* bus on secondary side of bridge, if any */
183 struct pcicfg_pp pp; /* pci power management */
184 struct pcicfg_vpd vpd; /* pci vital product data */
185 struct pcicfg_msi msi; /* pci msi */
186 struct pcicfg_msix msix; /* pci msi-x */
187 struct pcicfg_ht ht; /* HyperTransport */
188 struct pcicfg_expr expr; /* PCI Express */
189 struct pcicfg_pcix pcix; /* PCI-X */
192 /* additional type 1 device config header information (PCI to PCI bridge) */
194 #define PCI_PPBMEMBASE(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff)
195 #define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff)
196 #define PCI_PPBIOBASE(h,l) ((((h)<<16) + ((l)<<8)) & ~0xfff)
197 #define PCI_PPBIOLIMIT(h,l) ((((h)<<16) + ((l)<<8)) | 0xfff)
200 pci_addr_t pmembase; /* base address of prefetchable memory */
201 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */
202 uint32_t membase; /* base address of memory window */
203 uint32_t memlimit; /* topmost address of memory window */
204 uint32_t iobase; /* base address of port window */
205 uint32_t iolimit; /* topmost address of port window */
206 uint16_t secstat; /* secondary bus status register */
207 uint16_t bridgectl; /* bridge control register */
208 uint8_t seclat; /* CardBus latency timer */
211 /* additional type 2 device config header information (CardBus bridge) */
214 uint32_t membase0; /* base address of memory window */
215 uint32_t memlimit0; /* topmost address of memory window */
216 uint32_t membase1; /* base address of memory window */
217 uint32_t memlimit1; /* topmost address of memory window */
218 uint32_t iobase0; /* base address of port window */
219 uint32_t iolimit0; /* topmost address of port window */
220 uint32_t iobase1; /* base address of port window */
221 uint32_t iolimit1; /* topmost address of port window */
222 uint32_t pccardif; /* PC Card 16bit IF legacy more base addr. */
223 uint16_t secstat; /* secondary bus status register */
224 uint16_t bridgectl; /* bridge control register */
225 uint8_t seclat; /* CardBus latency timer */
228 extern uint32_t pci_numdevs;
230 /* Only if the prerequisites are present */
231 #if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_)
233 STAILQ_ENTRY(pci_devinfo) pci_links;
234 struct resource_list resources;
236 struct pci_conf conf;
245 * Define pci-specific resource flags for accessing memory via dense
246 * or bwx memory spaces. These flags are ignored on i386.
248 #define PCI_RF_DENSE 0x10000
249 #define PCI_RF_BWX 0x20000
251 enum pci_device_ivars {
273 PCI_IVAR_PCIXCAP_PTR,
274 PCI_IVAR_PCIECAP_PTR,
279 * Simplified accessors for pci devices
281 #define PCI_ACCESSOR(var, ivar, type) \
282 __BUS_ACCESSOR(pci, var, PCI, ivar, type)
284 PCI_ACCESSOR(subvendor, SUBVENDOR, uint16_t)
285 PCI_ACCESSOR(subdevice, SUBDEVICE, uint16_t)
286 PCI_ACCESSOR(vendor, VENDOR, uint16_t)
287 PCI_ACCESSOR(device, DEVICE, uint16_t)
288 PCI_ACCESSOR(devid, DEVID, uint32_t)
289 PCI_ACCESSOR(class, CLASS, uint8_t)
290 PCI_ACCESSOR(subclass, SUBCLASS, uint8_t)
291 PCI_ACCESSOR(progif, PROGIF, uint8_t)
292 PCI_ACCESSOR(revid, REVID, uint8_t)
293 PCI_ACCESSOR(intpin, INTPIN, uint8_t)
294 PCI_ACCESSOR(irq, IRQ, uint8_t)
295 PCI_ACCESSOR(domain, DOMAIN, uint32_t)
296 PCI_ACCESSOR(bus, BUS, uint8_t)
297 PCI_ACCESSOR(slot, SLOT, uint8_t)
298 PCI_ACCESSOR(function, FUNCTION, uint8_t)
299 PCI_ACCESSOR(ether, ETHADDR, uint8_t *)
300 PCI_ACCESSOR(cmdreg, CMDREG, uint8_t)
301 PCI_ACCESSOR(cachelnsz, CACHELNSZ, uint8_t)
302 PCI_ACCESSOR(mingnt, MINGNT, uint8_t)
303 PCI_ACCESSOR(maxlat, MAXLAT, uint8_t)
304 PCI_ACCESSOR(lattimer, LATTIMER, uint8_t)
305 PCI_ACCESSOR(pcixcap_ptr, PCIXCAP_PTR, uint8_t)
306 PCI_ACCESSOR(pciecap_ptr, PCIECAP_PTR, uint8_t)
307 PCI_ACCESSOR(vpdcap_ptr, VPDCAP_PTR, uint8_t)
312 * Operations on configuration space.
314 static __inline uint32_t
315 pci_read_config(device_t dev, int reg, int width)
317 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width);
321 pci_write_config(device_t dev, int reg, uint32_t val, int width)
323 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width);
327 * Ivars for pci bridges.
330 /*typedef enum pci_device_ivars pcib_device_ivars;*/
331 enum pcib_device_ivars {
336 #define PCIB_ACCESSOR(var, ivar, type) \
337 __BUS_ACCESSOR(pcib, var, PCIB, ivar, type)
339 PCIB_ACCESSOR(domain, DOMAIN, uint32_t)
340 PCIB_ACCESSOR(bus, BUS, uint32_t)
345 * PCI interrupt validation. Invalid interrupt values such as 0 or 128
346 * on i386 or other platforms should be mapped out in the MD pcireadconf
347 * code and not here, since the only MI invalid IRQ is 255.
349 #define PCI_INVALID_IRQ 255
350 #define PCI_INTERRUPT_VALID(x) ((x) != PCI_INVALID_IRQ)
353 * Convenience functions.
355 * These should be used in preference to manually manipulating
356 * configuration space.
359 pci_enable_busmaster(device_t dev)
361 return(PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev));
365 pci_disable_busmaster(device_t dev)
367 return(PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev));
371 pci_enable_io(device_t dev, int space)
373 return(PCI_ENABLE_IO(device_get_parent(dev), dev, space));
377 pci_disable_io(device_t dev, int space)
379 return(PCI_DISABLE_IO(device_get_parent(dev), dev, space));
383 pci_get_vpd_ident(device_t dev, const char **identptr)
385 return(PCI_GET_VPD_IDENT(device_get_parent(dev), dev, identptr));
389 pci_get_vpd_readonly(device_t dev, const char *kw, const char **identptr)
391 return(PCI_GET_VPD_READONLY(device_get_parent(dev), dev, kw, identptr));
395 * Check if the address range falls within the VGA defined address range(s)
398 pci_is_vga_ioport_range(u_long start, u_long end)
401 return (((start >= 0x3b0 && end <= 0x3bb) ||
402 (start >= 0x3c0 && end <= 0x3df)) ? 1 : 0);
406 pci_is_vga_memory_range(u_long start, u_long end)
409 return ((start >= 0xa0000 && end <= 0xbffff) ? 1 : 0);
412 int pcie_slot_implemented(device_t);
413 void pcie_set_max_readrq(device_t, uint16_t);
414 uint16_t pcie_get_max_readrq(device_t);
417 * PCI power states are as defined by ACPI:
419 * D0 State in which device is on and running. It is receiving full
420 * power from the system and delivering full functionality to the user.
421 * D1 Class-specific low-power state in which device context may or may not
422 * be lost. Buses in D1 cannot do anything to the bus that would force
423 * devices on that bus to lose context.
424 * D2 Class-specific low-power state in which device context may or may
425 * not be lost. Attains greater power savings than D1. Buses in D2
426 * can cause devices on that bus to lose some context. Devices in D2
427 * must be prepared for the bus to be in D2 or higher.
428 * D3 State in which the device is off and not running. Device context is
429 * lost. Power can be removed from the device.
431 #define PCI_POWERSTATE_D0 0
432 #define PCI_POWERSTATE_D1 1
433 #define PCI_POWERSTATE_D2 2
434 #define PCI_POWERSTATE_D3 3
435 #define PCI_POWERSTATE_UNKNOWN -1
438 pci_set_powerstate(device_t dev, int state)
440 return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state);
444 pci_get_powerstate(device_t dev)
446 return PCI_GET_POWERSTATE(device_get_parent(dev), dev);
450 pci_find_extcap(device_t dev, int capability, int *capreg)
452 return PCI_FIND_EXTCAP(device_get_parent(dev), dev, capability, capreg);
456 pci_is_pcie(device_t dev)
458 return (pci_get_pciecap_ptr(dev) != 0);
462 pci_is_pcix(device_t dev)
464 return (pci_get_pcixcap_ptr(dev) != 0);
468 pci_alloc_msi(device_t dev, int *rid, int count, int cpuid)
470 return (PCI_ALLOC_MSI(device_get_parent(dev), dev, rid, count, cpuid));
474 pci_alloc_msix(device_t dev, int *count)
476 return (PCI_ALLOC_MSIX(device_get_parent(dev), dev, count));
480 pci_remap_msix(device_t dev, int count, const u_int *vectors)
482 return (PCI_REMAP_MSIX(device_get_parent(dev), dev, count, vectors));
486 pci_release_msi(device_t dev)
488 return (PCI_RELEASE_MSI(device_get_parent(dev), dev));
492 pci_msi_count(device_t dev)
494 return (PCI_MSI_COUNT(device_get_parent(dev), dev));
498 pci_msix_count(device_t dev)
500 return (PCI_MSIX_COUNT(device_get_parent(dev), dev));
503 device_t pci_find_bsf(uint8_t, uint8_t, uint8_t);
504 device_t pci_find_dbsf(uint32_t, uint8_t, uint8_t, uint8_t);
505 device_t pci_find_device(uint16_t, uint16_t);
508 * Can be used by MD code to request the PCI bus to re-map an MSI or
511 int pci_remap_msi_irq(device_t dev, u_int irq);
513 /* Can be used by drivers to manage the MSI-X table. */
514 int pci_pending_msix(device_t dev, u_int index);
516 int pci_msi_device_blacklisted(device_t dev);
518 void pci_ht_map_msi(device_t dev, uint64_t addr);
520 /* Returns PCI_INTR_TYPE_ */
521 int pci_alloc_1intr(device_t dev, int msi_enable, int *rid, u_int *flags);
523 #define PCI_INTR_TYPE_LEGACY 0
524 #define PCI_INTR_TYPE_MSI 1
525 #define PCI_INTR_TYPE_MSIX 2 /* not yet */
527 #endif /* _SYS_BUS_H_ */
530 * cdev switch for control device, initialised in generic PCI code
532 extern struct cdevsw pcicdev;
535 * List of all PCI devices, generation count for the list.
537 STAILQ_HEAD(devlist, pci_devinfo);
539 extern struct devlist pci_devq;
540 extern uint32_t pci_generation;
542 /* for compatibility to FreeBSD-2.2 and 3.x versions of PCI code */
544 #if defined(_KERNEL) && !defined(KLD_MODULE)
545 #include "opt_compat_oldpci.h"
549 /* all this is going some day */
551 typedef pcicfgregs *pcici_t;
552 typedef unsigned pcidi_t;
553 typedef void pci_inthand_t(void *arg);
555 #define pci_max_burst_len (3)
557 /* just copied from old PCI code for now ... */
561 const char* (*pd_probe ) (pcici_t tag, pcidi_t type);
562 void (*pd_attach) (pcici_t tag, int unit);
564 int (*pd_shutdown) (int, int);
568 typedef u_short pci_port_t;
570 typedef u_int pci_port_t;
573 u_long pci_conf_read (pcici_t tag, u_long reg);
574 void pci_conf_write (pcici_t tag, u_long reg, u_long data);
575 int pci_map_port (pcici_t tag, u_long reg, pci_port_t* pa);
576 int pci_map_mem (pcici_t tag, u_long reg, vm_offset_t* va, vm_offset_t* pa);
577 int pci_map_int (pcici_t tag, pci_inthand_t *handler, void *arg);
578 int pci_map_int_right(pcici_t cfg, pci_inthand_t *handler, void *arg,
580 int pci_unmap_int (pcici_t tag);
582 void pci_cfgwrite (pcicfgregs *cfg, int reg, int data, int bytes);
584 pcici_t pci_get_parent_from_tag(pcici_t tag);
585 int pci_get_bus_from_tag(pcici_t tag);
587 pcicfgregs *pci_devlist_get_parent(pcicfgregs *cfg);
590 int compat_pci_handler (struct module *, int, void *);
591 #define COMPAT_PCI_DRIVER(name, pcidata) \
592 static moduledata_t name##_mod = { \
594 compat_pci_handler, \
597 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_ANY)
599 #endif /* COMPAT_OLDPCI */
601 #endif /* _PCIVAR_H_ */