reactos/drivers/bus/pci/pcidef.h

   1 /*
   2  *      $Id$
   3  *
   4  *      PCI defines and function prototypes
   5  *      Copyright 1994, Drew Eckhardt
   6  *      Copyright 1997--1999 Martin Mares <mj@suse.cz>
   7  *
   8  *      For more information, please consult the following manuals (look at
   9  *      http://www.pcisig.com/ for how to get them):
  10  *
  11  *      PCI BIOS Specification
  12  *      PCI Local Bus Specification
  13  *      PCI to PCI Bridge Specification
  14  *      PCI System Design Guide
  15  *
  16  *  Ported from linux pci.h to ReactOS by:
  17  *    Casper S. Hornstrup (chorns@users.sourceforge.net)
  18  */
  19
  20 #ifndef _PCIDEF_H
  21 #define _PCIDEF_H
  22
  23 /*
  24  * Under PCI, each device has 256 bytes of configuration address space,
  25  * of which the first 64 bytes are standardized as follows:
  26  */
  27 #define PCI_VENDOR_ID           0x00    /* 16 bits */
  28 #define PCI_DEVICE_ID           0x02    /* 16 bits */
  29 #define PCI_COMMAND             0x04    /* 16 bits */
  30 #define  PCI_COMMAND_IO         0x1     /* Enable response in I/O space */
  31 #define  PCI_COMMAND_MEMORY     0x2     /* Enable response in Memory space */
  32 #define  PCI_COMMAND_MASTER     0x4     /* Enable bus mastering */
  33 #define  PCI_COMMAND_SPECIAL    0x8     /* Enable response to special cycles */
  34 #define  PCI_COMMAND_INVALIDATE 0x10    /* Use memory write and invalidate */
  35 #define  PCI_COMMAND_VGA_PALETTE 0x20   /* Enable palette snooping */
  36 #define  PCI_COMMAND_PARITY     0x40    /* Enable parity checking */
  37 #define  PCI_COMMAND_WAIT       0x80    /* Enable address/data stepping */
  38 #define  PCI_COMMAND_SERR       0x100   /* Enable SERR */
  39 #define  PCI_COMMAND_FAST_BACK  0x200   /* Enable back-to-back writes */
  40
  41 #define PCI_STATUS              0x06    /* 16 bits */
  42 #define  PCI_STATUS_CAP_LIST    0x10    /* Support Capability List */
  43 #define  PCI_STATUS_66MHZ       0x20    /* Support 66 Mhz PCI 2.1 bus */
  44 #define  PCI_STATUS_UDF         0x40    /* Support User Definable Features [obsolete] */
  45 #define  PCI_STATUS_FAST_BACK   0x80    /* Accept fast-back to back */
  46 #define  PCI_STATUS_PARITY      0x100   /* Detected parity error */
  47 #define  PCI_STATUS_DEVSEL_MASK 0x600   /* DEVSEL timing */
  48 #define  PCI_STATUS_DEVSEL_FAST 0x000
  49 #define  PCI_STATUS_DEVSEL_MEDIUM 0x200
  50 #define  PCI_STATUS_DEVSEL_SLOW 0x400
  51 #define  PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
  52 #define  PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
  53 #define  PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
  54 #define  PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
  55 #define  PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
  56
  57 #define PCI_CLASS_REVISION      0x08    /* High 24 bits are class, low 8
  58                                            revision */
  59 #define PCI_REVISION_ID         0x08    /* Revision ID */
  60 #define PCI_CLASS_PROG          0x09    /* Reg. Level Programming Interface */
  61 #define PCI_CLASS_DEVICE        0x0a    /* Device class */
  62
  63 #define PCI_CACHE_LINE_SIZE     0x0c    /* 8 bits */
  64 #define PCI_LATENCY_TIMER       0x0d    /* 8 bits */
  65 #define PCI_HEADER_TYPE         0x0e    /* 8 bits */
  66 #define  PCI_HEADER_TYPE_NORMAL 0
  67 #define  PCI_HEADER_TYPE_BRIDGE 1
  68 #define  PCI_HEADER_TYPE_CARDBUS 2
  69
  70 #define PCI_BIST                0x0f    /* 8 bits */
  71 #define PCI_BIST_CODE_MASK      0x0f    /* Return result */
  72 #define PCI_BIST_START          0x40    /* 1 to start BIST, 2 secs or less */
  73 #define PCI_BIST_CAPABLE        0x80    /* 1 if BIST capable */
  74
  75 /*
  76  * Base addresses specify locations in memory or I/O space.
  77  * Decoded size can be determined by writing a value of
  78  * 0xffffffff to the register, and reading it back.  Only
  79  * 1 bits are decoded.
  80  */
  81 #define PCI_BASE_ADDRESS_0      0x10    /* 32 bits */
  82 #define PCI_BASE_ADDRESS_1      0x14    /* 32 bits [htype 0,1 only] */
  83 #define PCI_BASE_ADDRESS_2      0x18    /* 32 bits [htype 0 only] */
  84 #define PCI_BASE_ADDRESS_3      0x1c    /* 32 bits */
  85 #define PCI_BASE_ADDRESS_4      0x20    /* 32 bits */
  86 #define PCI_BASE_ADDRESS_5      0x24    /* 32 bits */
  87 #define  PCI_BASE_ADDRESS_SPACE 0x01    /* 0 = memory, 1 = I/O */
  88 #define  PCI_BASE_ADDRESS_SPACE_IO 0x01
  89 #define  PCI_BASE_ADDRESS_SPACE_MEMORY 0x00
  90 #define  PCI_BASE_ADDRESS_MEM_TYPE_MASK 0x06
  91 #define  PCI_BASE_ADDRESS_MEM_TYPE_32   0x00    /* 32 bit address */
  92 #define  PCI_BASE_ADDRESS_MEM_TYPE_1M   0x02    /* Below 1M [obsolete] */
  93 #define  PCI_BASE_ADDRESS_MEM_TYPE_64   0x04    /* 64 bit address */
  94 #define  PCI_BASE_ADDRESS_MEM_PREFETCH  0x08    /* prefetchable? */
  95 #define  PCI_BASE_ADDRESS_MEM_MASK      (~0x0fUL)
  96 #define  PCI_BASE_ADDRESS_IO_MASK       (~0x03UL)
  97 /* bit 1 is reserved if address_space = 1 */
  98
  99 /* Header type 0 (normal devices) */
 100 #define PCI_CARDBUS_CIS         0x28
 101 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c
 102 #define PCI_SUBSYSTEM_ID        0x2e
 103 #define PCI_ROM_ADDRESS         0x30    /* Bits 31..11 are address, 10..1 reserved */
 104 #define  PCI_ROM_ADDRESS_ENABLE 0x01
 105 #define PCI_ROM_ADDRESS_MASK    (~0x7ffUL)
 106
 107 #define PCI_CAPABILITY_LIST     0x34    /* Offset of first capability list entry */
 108
 109 /* 0x35-0x3b are reserved */
 110 #define PCI_INTERRUPT_LINE      0x3c    /* 8 bits */
 111 #define PCI_INTERRUPT_PIN       0x3d    /* 8 bits */
 112 #define PCI_MIN_GNT             0x3e    /* 8 bits */
 113 #define PCI_MAX_LAT             0x3f    /* 8 bits */
 114
 115 /* Header type 1 (PCI-to-PCI bridges) */
 116 #define PCI_PRIMARY_BUS         0x18    /* Primary bus number */
 117 #define PCI_SECONDARY_BUS       0x19    /* Secondary bus number */
 118 #define PCI_SUBORDINATE_BUS     0x1a    /* Highest bus number behind the bridge */
 119 #define PCI_SEC_LATENCY_TIMER   0x1b    /* Latency timer for secondary interface */
 120 #define PCI_IO_BASE             0x1c    /* I/O range behind the bridge */
 121 #define PCI_IO_LIMIT            0x1d
 122 #define  PCI_IO_RANGE_TYPE_MASK 0x0f    /* I/O bridging type */
 123 #define  PCI_IO_RANGE_TYPE_16   0x00
 124 #define  PCI_IO_RANGE_TYPE_32   0x01
 125 #define  PCI_IO_RANGE_MASK      ~0x0f
 126 #define PCI_SEC_STATUS          0x1e    /* Secondary status register, only bit 14 used */
 127 #define PCI_MEMORY_BASE         0x20    /* Memory range behind */
 128 #define PCI_MEMORY_LIMIT        0x22
 129 #define  PCI_MEMORY_RANGE_TYPE_MASK 0x0f
 130 #define  PCI_MEMORY_RANGE_MASK  ~0x0f
 131 #define PCI_PREF_MEMORY_BASE    0x24    /* Prefetchable memory range behind */
 132 #define PCI_PREF_MEMORY_LIMIT   0x26
 133 #define  PCI_PREF_RANGE_TYPE_MASK 0x0f
 134 #define  PCI_PREF_RANGE_TYPE_32 0x00
 135 #define  PCI_PREF_RANGE_TYPE_64 0x01
 136 #define  PCI_PREF_RANGE_MASK    ~0x0f
 137 #define PCI_PREF_BASE_UPPER32   0x28    /* Upper half of prefetchable memory range */
 138 #define PCI_PREF_LIMIT_UPPER32  0x2c
 139 #define PCI_IO_BASE_UPPER16     0x30    /* Upper half of I/O addresses */
 140 #define PCI_IO_LIMIT_UPPER16    0x32
 141 /* 0x34 same as for htype 0 */
 142 /* 0x35-0x3b is reserved */
 143 #define PCI_ROM_ADDRESS1        0x38    /* Same as PCI_ROM_ADDRESS, but for htype 1 */
 144 /* 0x3c-0x3d are same as for htype 0 */
 145 #define PCI_BRIDGE_CONTROL      0x3e
 146 #define  PCI_BRIDGE_CTL_PARITY  0x01    /* Enable parity detection on secondary interface */
 147 #define  PCI_BRIDGE_CTL_SERR    0x02    /* The same for SERR forwarding */
 148 #define  PCI_BRIDGE_CTL_NO_ISA  0x04    /* Disable bridging of ISA ports */
 149 #define  PCI_BRIDGE_CTL_VGA     0x08    /* Forward VGA addresses */
 150 #define  PCI_BRIDGE_CTL_MASTER_ABORT 0x20  /* Report master aborts */
 151 #define  PCI_BRIDGE_CTL_BUS_RESET 0x40  /* Secondary bus reset */
 152 #define  PCI_BRIDGE_CTL_FAST_BACK 0x80  /* Fast Back2Back enabled on secondary interface */
 153
 154 /* Header type 2 (CardBus bridges) */
 155 #define PCI_CB_CAPABILITY_LIST  0x14
 156 /* 0x15 reserved */
 157 #define PCI_CB_SEC_STATUS       0x16    /* Secondary status */
 158 #define PCI_CB_PRIMARY_BUS      0x18    /* PCI bus number */
 159 #define PCI_CB_CARD_BUS         0x19    /* CardBus bus number */
 160 #define PCI_CB_SUBORDINATE_BUS  0x1a    /* Subordinate bus number */
 161 #define PCI_CB_LATENCY_TIMER    0x1b    /* CardBus latency timer */
 162 #define PCI_CB_MEMORY_BASE_0    0x1c
 163 #define PCI_CB_MEMORY_LIMIT_0   0x20
 164 #define PCI_CB_MEMORY_BASE_1    0x24
 165 #define PCI_CB_MEMORY_LIMIT_1   0x28
 166 #define PCI_CB_IO_BASE_0        0x2c
 167 #define PCI_CB_IO_BASE_0_HI     0x2e
 168 #define PCI_CB_IO_LIMIT_0       0x30
 169 #define PCI_CB_IO_LIMIT_0_HI    0x32
 170 #define PCI_CB_IO_BASE_1        0x34
 171 #define PCI_CB_IO_BASE_1_HI     0x36
 172 #define PCI_CB_IO_LIMIT_1       0x38
 173 #define PCI_CB_IO_LIMIT_1_HI    0x3a
 174 #define  PCI_CB_IO_RANGE_MASK   ~0x03
 175 /* 0x3c-0x3d are same as for htype 0 */
 176 #define PCI_CB_BRIDGE_CONTROL   0x3e
 177 #define  PCI_CB_BRIDGE_CTL_PARITY       0x01    /* Similar to standard bridge control register */
 178 #define  PCI_CB_BRIDGE_CTL_SERR         0x02
 179 #define  PCI_CB_BRIDGE_CTL_ISA          0x04
 180 #define  PCI_CB_BRIDGE_CTL_VGA          0x08
 181 #define  PCI_CB_BRIDGE_CTL_MASTER_ABORT 0x20
 182 #define  PCI_CB_BRIDGE_CTL_CB_RESET     0x40    /* CardBus reset */
 183 #define  PCI_CB_BRIDGE_CTL_16BIT_INT    0x80    /* Enable interrupt for 16-bit cards */
 184 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM0 0x100  /* Prefetch enable for both memory regions */
 185 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM1 0x200
 186 #define  PCI_CB_BRIDGE_CTL_POST_WRITES  0x400
 187 #define PCI_CB_SUBSYSTEM_VENDOR_ID 0x40
 188 #define PCI_CB_SUBSYSTEM_ID     0x42
 189 #define PCI_CB_LEGACY_MODE_BASE 0x44    /* 16-bit PC Card legacy mode base address (ExCa) */
 190 /* 0x48-0x7f reserved */
 191
 192 /* Capability lists */
 193
 194 #define PCI_CAP_LIST_ID         0       /* Capability ID */
 195 #define  PCI_CAP_ID_PM          0x01    /* Power Management */
 196 #define  PCI_CAP_ID_AGP         0x02    /* Accelerated Graphics Port */
 197 #define  PCI_CAP_ID_VPD         0x03    /* Vital Product Data */
 198 #define  PCI_CAP_ID_SLOTID      0x04    /* Slot Identification */
 199 #define  PCI_CAP_ID_MSI         0x05    /* Message Signalled Interrupts */
 200 #define  PCI_CAP_ID_CHSWP       0x06    /* CompactPCI HotSwap */
 201 #define PCI_CAP_LIST_NEXT       1       /* Next capability in the list */
 202 #define PCI_CAP_FLAGS           2       /* Capability defined flags (16 bits) */
 203 #define PCI_CAP_SIZEOF          4
 204
 205 /* Power Management Registers */
 206
 207 #define PCI_PM_PMC              2       /* PM Capabilities Register */
 208 #define  PCI_PM_CAP_VER_MASK    0x0007  /* Version */
 209 #define  PCI_PM_CAP_PME_CLOCK   0x0008  /* PME clock required */
 210 #define  PCI_PM_CAP_RESERVED    0x0010  /* Reserved field */
 211 #define  PCI_PM_CAP_DSI         0x0020  /* Device specific initialization */
 212 #define  PCI_PM_CAP_AUX_POWER   0x01C0  /* Auxilliary power support mask */
 213 #define  PCI_PM_CAP_D1          0x0200  /* D1 power state support */
 214 #define  PCI_PM_CAP_D2          0x0400  /* D2 power state support */
 215 #define  PCI_PM_CAP_PME         0x0800  /* PME pin supported */
 216 #define  PCI_PM_CAP_PME_MASK    0xF800  /* PME Mask of all supported states */
 217 #define  PCI_PM_CAP_PME_D0      0x0800  /* PME# from D0 */
 218 #define  PCI_PM_CAP_PME_D1      0x1000  /* PME# from D1 */
 219 #define  PCI_PM_CAP_PME_D2      0x2000  /* PME# from D2 */
 220 #define  PCI_PM_CAP_PME_D3      0x4000  /* PME# from D3 (hot) */
 221 #define  PCI_PM_CAP_PME_D3cold  0x8000  /* PME# from D3 (cold) */
 222 #define PCI_PM_CTRL             4       /* PM control and status register */
 223 #define  PCI_PM_CTRL_STATE_MASK 0x0003  /* Current power state (D0 to D3) */
 224 #define  PCI_PM_CTRL_PME_ENABLE 0x0100  /* PME pin enable */
 225 #define  PCI_PM_CTRL_DATA_SEL_MASK      0x1e00  /* Data select (??) */
 226 #define  PCI_PM_CTRL_DATA_SCALE_MASK    0x6000  /* Data scale (??) */
 227 #define  PCI_PM_CTRL_PME_STATUS 0x8000  /* PME pin status */
 228 #define PCI_PM_PPB_EXTENSIONS   6       /* PPB support extensions (??) */
 229 #define  PCI_PM_PPB_B2_B3       0x40    /* Stop clock when in D3hot (??) */
 230 #define  PCI_PM_BPCC_ENABLE     0x80    /* Bus power/clock control enable (??) */
 231 #define PCI_PM_DATA_REGISTER    7       /* (??) */
 232 #define PCI_PM_SIZEOF           8
 233
 234 /* AGP registers */
 235
 236 #define PCI_AGP_VERSION         2       /* BCD version number */
 237 #define PCI_AGP_RFU             3       /* Rest of capability flags */
 238 #define PCI_AGP_STATUS          4       /* Status register */
 239 #define  PCI_AGP_STATUS_RQ_MASK 0xff000000      /* Maximum number of requests - 1 */
 240 #define  PCI_AGP_STATUS_SBA     0x0200  /* Sideband addressing supported */
 241 #define  PCI_AGP_STATUS_64BIT   0x0020  /* 64-bit addressing supported */
 242 #define  PCI_AGP_STATUS_FW      0x0010  /* FW transfers supported */
 243 #define  PCI_AGP_STATUS_RATE4   0x0004  /* 4x transfer rate supported */
 244 #define  PCI_AGP_STATUS_RATE2   0x0002  /* 2x transfer rate supported */
 245 #define  PCI_AGP_STATUS_RATE1   0x0001  /* 1x transfer rate supported */
 246 #define PCI_AGP_COMMAND         8       /* Control register */
 247 #define  PCI_AGP_COMMAND_RQ_MASK 0xff000000  /* Master: Maximum number of requests */
 248 #define  PCI_AGP_COMMAND_SBA    0x0200  /* Sideband addressing enabled */
 249 #define  PCI_AGP_COMMAND_AGP    0x0100  /* Allow processing of AGP transactions */
 250 #define  PCI_AGP_COMMAND_64BIT  0x0020  /* Allow processing of 64-bit addresses */
 251 #define  PCI_AGP_COMMAND_FW     0x0010  /* Force FW transfers */
 252 #define  PCI_AGP_COMMAND_RATE4  0x0004  /* Use 4x rate */
 253 #define  PCI_AGP_COMMAND_RATE2  0x0002  /* Use 4x rate */
 254 #define  PCI_AGP_COMMAND_RATE1  0x0001  /* Use 4x rate */
 255 #define PCI_AGP_SIZEOF          12
 256
 257 /* Slot Identification */
 258
 259 #define PCI_SID_ESR             2       /* Expansion Slot Register */
 260 #define  PCI_SID_ESR_NSLOTS     0x1f    /* Number of expansion slots available */
 261 #define  PCI_SID_ESR_FIC        0x20    /* First In Chassis Flag */
 262 #define PCI_SID_CHASSIS_NR      3       /* Chassis Number */
 263
 264 /* Message Signalled Interrupts registers */
 265
 266 #define PCI_MSI_FLAGS           2       /* Various flags */
 267 #define  PCI_MSI_FLAGS_64BIT    0x80    /* 64-bit addresses allowed */
 268 #define  PCI_MSI_FLAGS_QSIZE    0x70    /* Message queue size configured */
 269 #define  PCI_MSI_FLAGS_QMASK    0x0e    /* Maximum queue size available */
 270 #define  PCI_MSI_FLAGS_ENABLE   0x01    /* MSI feature enabled */
 271 #define PCI_MSI_RFU             3       /* Rest of capability flags */
 272 #define PCI_MSI_ADDRESS_LO      4       /* Lower 32 bits */
 273 #define PCI_MSI_ADDRESS_HI      8       /* Upper 32 bits (if PCI_MSI_FLAGS_64BIT set) */
 274 #define PCI_MSI_DATA_32         8       /* 16 bits of data for 32-bit devices */
 275 #define PCI_MSI_DATA_64         12      /* 16 bits of data for 64-bit devices */
 276
 277 /*
 278  * The PCI interface treats multi-function devices as independent
 279  * devices.  The slot/function address of each device is encoded
 280  * in a single byte as follows:
 281  *
 282  *      7:3 = slot
 283  *      2:0 = function
 284  */
 285 #define PCI_DEVFN(slot,func)    ((((slot) & 0x1f) << 3) | ((func) & 0x07))
 286 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
 287 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
 288
 289
 290 /*
 291  *  For PCI devices, the region numbers are assigned this way:
 292  *
 293  *      0-5     standard PCI regions
 294  *      6       expansion ROM
 295  *      7-10    bridges: address space assigned to buses behind the bridge
 296  */
 297
 298 #define PCI_ROM_RESOURCE 6
 299 #define PCI_BRIDGE_RESOURCES 7
 300 #define PCI_NUM_RESOURCES 11
 301
 302 #define PCI_REGION_FLAG_MASK 0x0f       /* These bits of resource flags tell us the PCI region flags */
 303
 304 #endif /* _PCIDEF_H */