pcivar.h revision 178588
1/*- 2 * Copyright (c) 1997, Stefan Esser <se@freebsd.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 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. 14 * 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. 25 * 26 * $FreeBSD: head/sys/dev/pci/pcivar.h 178588 2008-04-26 14:13:48Z marius $ 27 * 28 */ 29 30#ifndef _PCIVAR_H_ 31#define _PCIVAR_H_ 32 33#include <sys/queue.h> 34 35/* some PCI bus constants */ 36 37#define PCI_DOMAINMAX 65535 /* highest supported domain number */ 38#define PCI_BUSMAX 255 /* highest supported bus number */ 39#define PCI_SLOTMAX 31 /* highest supported slot number */ 40#define PCI_FUNCMAX 7 /* highest supported function number */ 41#define PCI_REGMAX 255 /* highest supported config register addr. */ 42 43#define PCI_MAXMAPS_0 6 /* max. no. of memory/port maps */ 44#define PCI_MAXMAPS_1 2 /* max. no. of maps for PCI to PCI bridge */ 45#define PCI_MAXMAPS_2 1 /* max. no. of maps for CardBus bridge */ 46 47typedef uint64_t pci_addr_t; 48 49/* Interesting values for PCI power management */ 50struct pcicfg_pp { 51 uint16_t pp_cap; /* PCI power management capabilities */ 52 uint8_t pp_status; /* config space address of PCI power status reg */ 53 uint8_t pp_pmcsr; /* config space address of PMCSR reg */ 54 uint8_t pp_data; /* config space address of PCI power data reg */ 55}; 56 57struct vpd_readonly { 58 char keyword[2]; 59 char *value; 60}; 61 62struct vpd_write { 63 char keyword[2]; 64 char *value; 65 int start; 66 int len; 67}; 68 69struct pcicfg_vpd { 70 uint8_t vpd_reg; /* base register, + 2 for addr, + 4 data */ 71 char vpd_cached; 72 char *vpd_ident; /* string identifier */ 73 int vpd_rocnt; 74 struct vpd_readonly *vpd_ros; 75 int vpd_wcnt; 76 struct vpd_write *vpd_w; 77}; 78 79/* Interesting values for PCI MSI */ 80struct pcicfg_msi { 81 uint16_t msi_ctrl; /* Message Control */ 82 uint8_t msi_location; /* Offset of MSI capability registers. */ 83 uint8_t msi_msgnum; /* Number of messages */ 84 int msi_alloc; /* Number of allocated messages. */ 85 uint64_t msi_addr; /* Contents of address register. */ 86 uint16_t msi_data; /* Contents of data register. */ 87 u_int msi_handlers; 88}; 89 90/* Interesting values for PCI MSI-X */ 91struct msix_vector { 92 uint64_t mv_address; /* Contents of address register. */ 93 uint32_t mv_data; /* Contents of data register. */ 94 int mv_irq; 95}; 96 97struct msix_table_entry { 98 u_int mte_vector; /* 1-based index into msix_vectors array. */ 99 u_int mte_handlers; 100}; 101 102struct pcicfg_msix { 103 uint16_t msix_ctrl; /* Message Control */ 104 uint16_t msix_msgnum; /* Number of messages */ 105 uint8_t msix_location; /* Offset of MSI-X capability registers. */ 106 uint8_t msix_table_bar; /* BAR containing vector table. */ 107 uint8_t msix_pba_bar; /* BAR containing PBA. */ 108 uint32_t msix_table_offset; 109 uint32_t msix_pba_offset; 110 int msix_alloc; /* Number of allocated vectors. */ 111 int msix_table_len; /* Length of virtual table. */ 112 struct msix_table_entry *msix_table; /* Virtual table. */ 113 struct msix_vector *msix_vectors; /* Array of allocated vectors. */ 114 struct resource *msix_table_res; /* Resource containing vector table. */ 115 struct resource *msix_pba_res; /* Resource containing PBA. */ 116}; 117 118/* config header information common to all header types */ 119typedef struct pcicfg { 120 struct device *dev; /* device which owns this */ 121 122 uint32_t bar[PCI_MAXMAPS_0]; /* BARs */ 123 uint32_t bios; /* BIOS mapping */ 124 125 uint16_t subvendor; /* card vendor ID */ 126 uint16_t subdevice; /* card device ID, assigned by card vendor */ 127 uint16_t vendor; /* chip vendor ID */ 128 uint16_t device; /* chip device ID, assigned by chip vendor */ 129 130 uint16_t cmdreg; /* disable/enable chip and PCI options */ 131 uint16_t statreg; /* supported PCI features and error state */ 132 133 uint8_t baseclass; /* chip PCI class */ 134 uint8_t subclass; /* chip PCI subclass */ 135 uint8_t progif; /* chip PCI programming interface */ 136 uint8_t revid; /* chip revision ID */ 137 138 uint8_t hdrtype; /* chip config header type */ 139 uint8_t cachelnsz; /* cache line size in 4byte units */ 140 uint8_t intpin; /* PCI interrupt pin */ 141 uint8_t intline; /* interrupt line (IRQ for PC arch) */ 142 143 uint8_t mingnt; /* min. useful bus grant time in 250ns units */ 144 uint8_t maxlat; /* max. tolerated bus grant latency in 250ns */ 145 uint8_t lattimer; /* latency timer in units of 30ns bus cycles */ 146 147 uint8_t mfdev; /* multi-function device (from hdrtype reg) */ 148 uint8_t nummaps; /* actual number of PCI maps used */ 149 150 uint32_t domain; /* PCI domain */ 151 uint8_t bus; /* config space bus address */ 152 uint8_t slot; /* config space slot address */ 153 uint8_t func; /* config space function number */ 154 155 struct pcicfg_pp pp; /* pci power management */ 156 struct pcicfg_vpd vpd; /* pci vital product data */ 157 struct pcicfg_msi msi; /* pci msi */ 158 struct pcicfg_msix msix; /* pci msi-x */ 159} pcicfgregs; 160 161/* additional type 1 device config header information (PCI to PCI bridge) */ 162 163#define PCI_PPBMEMBASE(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) & ~0xfffff) 164#define PCI_PPBMEMLIMIT(h,l) ((((pci_addr_t)(h) << 32) + ((l)<<16)) | 0xfffff) 165#define PCI_PPBIOBASE(h,l) ((((h)<<16) + ((l)<<8)) & ~0xfff) 166#define PCI_PPBIOLIMIT(h,l) ((((h)<<16) + ((l)<<8)) | 0xfff) 167 168typedef struct { 169 pci_addr_t pmembase; /* base address of prefetchable memory */ 170 pci_addr_t pmemlimit; /* topmost address of prefetchable memory */ 171 uint32_t membase; /* base address of memory window */ 172 uint32_t memlimit; /* topmost address of memory window */ 173 uint32_t iobase; /* base address of port window */ 174 uint32_t iolimit; /* topmost address of port window */ 175 uint16_t secstat; /* secondary bus status register */ 176 uint16_t bridgectl; /* bridge control register */ 177 uint8_t seclat; /* CardBus latency timer */ 178} pcih1cfgregs; 179 180/* additional type 2 device config header information (CardBus bridge) */ 181 182typedef struct { 183 uint32_t membase0; /* base address of memory window */ 184 uint32_t memlimit0; /* topmost address of memory window */ 185 uint32_t membase1; /* base address of memory window */ 186 uint32_t memlimit1; /* topmost address of memory window */ 187 uint32_t iobase0; /* base address of port window */ 188 uint32_t iolimit0; /* topmost address of port window */ 189 uint32_t iobase1; /* base address of port window */ 190 uint32_t iolimit1; /* topmost address of port window */ 191 uint32_t pccardif; /* PC Card 16bit IF legacy more base addr. */ 192 uint16_t secstat; /* secondary bus status register */ 193 uint16_t bridgectl; /* bridge control register */ 194 uint8_t seclat; /* CardBus latency timer */ 195} pcih2cfgregs; 196 197extern uint32_t pci_numdevs; 198 199/* Only if the prerequisites are present */ 200#if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_) 201struct pci_devinfo { 202 STAILQ_ENTRY(pci_devinfo) pci_links; 203 struct resource_list resources; 204 pcicfgregs cfg; 205 struct pci_conf conf; 206}; 207#endif 208 209#ifdef _SYS_BUS_H_ 210 211#include "pci_if.h" 212 213enum pci_device_ivars { 214 PCI_IVAR_SUBVENDOR, 215 PCI_IVAR_SUBDEVICE, 216 PCI_IVAR_VENDOR, 217 PCI_IVAR_DEVICE, 218 PCI_IVAR_DEVID, 219 PCI_IVAR_CLASS, 220 PCI_IVAR_SUBCLASS, 221 PCI_IVAR_PROGIF, 222 PCI_IVAR_REVID, 223 PCI_IVAR_INTPIN, 224 PCI_IVAR_IRQ, 225 PCI_IVAR_DOMAIN, 226 PCI_IVAR_BUS, 227 PCI_IVAR_SLOT, 228 PCI_IVAR_FUNCTION, 229 PCI_IVAR_ETHADDR, 230 PCI_IVAR_CMDREG, 231 PCI_IVAR_CACHELNSZ, 232 PCI_IVAR_MINGNT, 233 PCI_IVAR_MAXLAT, 234 PCI_IVAR_LATTIMER 235}; 236 237/* 238 * Simplified accessors for pci devices 239 */ 240#define PCI_ACCESSOR(var, ivar, type) \ 241 __BUS_ACCESSOR(pci, var, PCI, ivar, type) 242 243PCI_ACCESSOR(subvendor, SUBVENDOR, uint16_t) 244PCI_ACCESSOR(subdevice, SUBDEVICE, uint16_t) 245PCI_ACCESSOR(vendor, VENDOR, uint16_t) 246PCI_ACCESSOR(device, DEVICE, uint16_t) 247PCI_ACCESSOR(devid, DEVID, uint32_t) 248PCI_ACCESSOR(class, CLASS, uint8_t) 249PCI_ACCESSOR(subclass, SUBCLASS, uint8_t) 250PCI_ACCESSOR(progif, PROGIF, uint8_t) 251PCI_ACCESSOR(revid, REVID, uint8_t) 252PCI_ACCESSOR(intpin, INTPIN, uint8_t) 253PCI_ACCESSOR(irq, IRQ, uint8_t) 254PCI_ACCESSOR(domain, DOMAIN, uint32_t) 255PCI_ACCESSOR(bus, BUS, uint8_t) 256PCI_ACCESSOR(slot, SLOT, uint8_t) 257PCI_ACCESSOR(function, FUNCTION, uint8_t) 258PCI_ACCESSOR(ether, ETHADDR, uint8_t *) 259PCI_ACCESSOR(cmdreg, CMDREG, uint8_t) 260PCI_ACCESSOR(cachelnsz, CACHELNSZ, uint8_t) 261PCI_ACCESSOR(mingnt, MINGNT, uint8_t) 262PCI_ACCESSOR(maxlat, MAXLAT, uint8_t) 263PCI_ACCESSOR(lattimer, LATTIMER, uint8_t) 264 265#undef PCI_ACCESSOR 266 267/* 268 * Operations on configuration space. 269 */ 270static __inline uint32_t 271pci_read_config(device_t dev, int reg, int width) 272{ 273 return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width); 274} 275 276static __inline void 277pci_write_config(device_t dev, int reg, uint32_t val, int width) 278{ 279 PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width); 280} 281 282/* 283 * Ivars for pci bridges. 284 */ 285 286/*typedef enum pci_device_ivars pcib_device_ivars;*/ 287enum pcib_device_ivars { 288 PCIB_IVAR_DOMAIN, 289 PCIB_IVAR_BUS 290}; 291 292#define PCIB_ACCESSOR(var, ivar, type) \ 293 __BUS_ACCESSOR(pcib, var, PCIB, ivar, type) 294 295PCIB_ACCESSOR(domain, DOMAIN, uint32_t) 296PCIB_ACCESSOR(bus, BUS, uint32_t) 297 298#undef PCIB_ACCESSOR 299 300/* 301 * PCI interrupt validation. Invalid interrupt values such as 0 or 128 302 * on i386 or other platforms should be mapped out in the MD pcireadconf 303 * code and not here, since the only MI invalid IRQ is 255. 304 */ 305#define PCI_INVALID_IRQ 255 306#define PCI_INTERRUPT_VALID(x) ((x) != PCI_INVALID_IRQ) 307 308/* 309 * Convenience functions. 310 * 311 * These should be used in preference to manually manipulating 312 * configuration space. 313 */ 314static __inline int 315pci_enable_busmaster(device_t dev) 316{ 317 return(PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev)); 318} 319 320static __inline int 321pci_disable_busmaster(device_t dev) 322{ 323 return(PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev)); 324} 325 326static __inline int 327pci_enable_io(device_t dev, int space) 328{ 329 return(PCI_ENABLE_IO(device_get_parent(dev), dev, space)); 330} 331 332static __inline int 333pci_disable_io(device_t dev, int space) 334{ 335 return(PCI_DISABLE_IO(device_get_parent(dev), dev, space)); 336} 337 338static __inline int 339pci_get_vpd_ident(device_t dev, const char **identptr) 340{ 341 return(PCI_GET_VPD_IDENT(device_get_parent(dev), dev, identptr)); 342} 343 344static __inline int 345pci_get_vpd_readonly(device_t dev, const char *kw, const char **identptr) 346{ 347 return(PCI_GET_VPD_READONLY(device_get_parent(dev), dev, kw, identptr)); 348} 349 350/* 351 * Check if the address range falls within the VGA defined address range(s) 352 */ 353static __inline int 354pci_is_vga_ioport_range(u_long start, u_long end) 355{ 356 357 return (((start >= 0x3b0 && end <= 0x3bb) || 358 (start >= 0x3c0 && end <= 0x3df)) ? 1 : 0); 359} 360 361static __inline int 362pci_is_vga_memory_range(u_long start, u_long end) 363{ 364 365 return ((start >= 0xa0000 && end <= 0xbffff) ? 1 : 0); 366} 367 368/* 369 * PCI power states are as defined by ACPI: 370 * 371 * D0 State in which device is on and running. It is receiving full 372 * power from the system and delivering full functionality to the user. 373 * D1 Class-specific low-power state in which device context may or may not 374 * be lost. Buses in D1 cannot do anything to the bus that would force 375 * devices on that bus to lose context. 376 * D2 Class-specific low-power state in which device context may or may 377 * not be lost. Attains greater power savings than D1. Buses in D2 378 * can cause devices on that bus to lose some context. Devices in D2 379 * must be prepared for the bus to be in D2 or higher. 380 * D3 State in which the device is off and not running. Device context is 381 * lost. Power can be removed from the device. 382 */ 383#define PCI_POWERSTATE_D0 0 384#define PCI_POWERSTATE_D1 1 385#define PCI_POWERSTATE_D2 2 386#define PCI_POWERSTATE_D3 3 387#define PCI_POWERSTATE_UNKNOWN -1 388 389static __inline int 390pci_set_powerstate(device_t dev, int state) 391{ 392 return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state); 393} 394 395static __inline int 396pci_get_powerstate(device_t dev) 397{ 398 return PCI_GET_POWERSTATE(device_get_parent(dev), dev); 399} 400 401static __inline int 402pci_find_extcap(device_t dev, int capability, int *capreg) 403{ 404 return PCI_FIND_EXTCAP(device_get_parent(dev), dev, capability, capreg); 405} 406 407static __inline int 408pci_alloc_msi(device_t dev, int *count) 409{ 410 return (PCI_ALLOC_MSI(device_get_parent(dev), dev, count)); 411} 412 413static __inline int 414pci_alloc_msix(device_t dev, int *count) 415{ 416 return (PCI_ALLOC_MSIX(device_get_parent(dev), dev, count)); 417} 418 419static __inline int 420pci_remap_msix(device_t dev, int count, const u_int *vectors) 421{ 422 return (PCI_REMAP_MSIX(device_get_parent(dev), dev, count, vectors)); 423} 424 425static __inline int 426pci_release_msi(device_t dev) 427{ 428 return (PCI_RELEASE_MSI(device_get_parent(dev), dev)); 429} 430 431static __inline int 432pci_msi_count(device_t dev) 433{ 434 return (PCI_MSI_COUNT(device_get_parent(dev), dev)); 435} 436 437static __inline int 438pci_msix_count(device_t dev) 439{ 440 return (PCI_MSIX_COUNT(device_get_parent(dev), dev)); 441} 442 443device_t pci_find_bsf(uint8_t, uint8_t, uint8_t); 444device_t pci_find_dbsf(uint32_t, uint8_t, uint8_t, uint8_t); 445device_t pci_find_device(uint16_t, uint16_t); 446 447/* 448 * Can be used by MD code to request the PCI bus to re-map an MSI or 449 * MSI-X message. 450 */ 451int pci_remap_msi_irq(device_t dev, u_int irq); 452 453/* Can be used by drivers to manage the MSI-X table. */ 454int pci_pending_msix(device_t dev, u_int index); 455 456int pci_msi_device_blacklisted(device_t dev); 457 458#endif /* _SYS_BUS_H_ */ 459 460/* 461 * cdev switch for control device, initialised in generic PCI code 462 */ 463extern struct cdevsw pcicdev; 464 465/* 466 * List of all PCI devices, generation count for the list. 467 */ 468STAILQ_HEAD(devlist, pci_devinfo); 469 470extern struct devlist pci_devq; 471extern uint32_t pci_generation; 472 473#endif /* _PCIVAR_H_ */ 474