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