include/pci.h

   1 /*
   2  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   3  * Andreas Heppel <aheppel@sysgo.de>
   4  *
   5  * (C) Copyright 2002
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #ifndef _PCI_H
  12 #define _PCI_H
  13
  14 /*
  15  * Under PCI, each device has 256 bytes of configuration address space,
  16  * of which the first 64 bytes are standardized as follows:
  17  */
  18 #define PCI_VENDOR_ID           0x00    /* 16 bits */
  19 #define PCI_DEVICE_ID           0x02    /* 16 bits */
  20 #define PCI_COMMAND             0x04    /* 16 bits */
  21 #define  PCI_COMMAND_IO         0x1     /* Enable response in I/O space */
  22 #define  PCI_COMMAND_MEMORY     0x2     /* Enable response in Memory space */
  23 #define  PCI_COMMAND_MASTER     0x4     /* Enable bus mastering */
  24 #define  PCI_COMMAND_SPECIAL    0x8     /* Enable response to special cycles */
  25 #define  PCI_COMMAND_INVALIDATE 0x10    /* Use memory write and invalidate */
  26 #define  PCI_COMMAND_VGA_PALETTE 0x20   /* Enable palette snooping */
  27 #define  PCI_COMMAND_PARITY     0x40    /* Enable parity checking */
  28 #define  PCI_COMMAND_WAIT       0x80    /* Enable address/data stepping */
  29 #define  PCI_COMMAND_SERR       0x100   /* Enable SERR */
  30 #define  PCI_COMMAND_FAST_BACK  0x200   /* Enable back-to-back writes */
  31
  32 #define PCI_STATUS              0x06    /* 16 bits */
  33 #define  PCI_STATUS_CAP_LIST    0x10    /* Support Capability List */
  34 #define  PCI_STATUS_66MHZ       0x20    /* Support 66 Mhz PCI 2.1 bus */
  35 #define  PCI_STATUS_UDF         0x40    /* Support User Definable Features [obsolete] */
  36 #define  PCI_STATUS_FAST_BACK   0x80    /* Accept fast-back to back */
  37 #define  PCI_STATUS_PARITY      0x100   /* Detected parity error */
  38 #define  PCI_STATUS_DEVSEL_MASK 0x600   /* DEVSEL timing */
  39 #define  PCI_STATUS_DEVSEL_FAST 0x000
  40 #define  PCI_STATUS_DEVSEL_MEDIUM 0x200
  41 #define  PCI_STATUS_DEVSEL_SLOW 0x400
  42 #define  PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
  43 #define  PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
  44 #define  PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
  45 #define  PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
  46 #define  PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
  47
  48 #define PCI_CLASS_REVISION      0x08    /* High 24 bits are class, low 8
  49                                            revision */
  50 #define PCI_REVISION_ID         0x08    /* Revision ID */
  51 #define PCI_CLASS_PROG          0x09    /* Reg. Level Programming Interface */
  52 #define PCI_CLASS_DEVICE        0x0a    /* Device class */
  53 #define PCI_CLASS_CODE          0x0b    /* Device class code */
  54 #define  PCI_CLASS_CODE_TOO_OLD 0x00
  55 #define  PCI_CLASS_CODE_STORAGE 0x01
  56 #define  PCI_CLASS_CODE_NETWORK 0x02
  57 #define  PCI_CLASS_CODE_DISPLAY 0x03
  58 #define  PCI_CLASS_CODE_MULTIMEDIA 0x04
  59 #define  PCI_CLASS_CODE_MEMORY  0x05
  60 #define  PCI_CLASS_CODE_BRIDGE  0x06
  61 #define  PCI_CLASS_CODE_COMM    0x07
  62 #define  PCI_CLASS_CODE_PERIPHERAL 0x08
  63 #define  PCI_CLASS_CODE_INPUT   0x09
  64 #define  PCI_CLASS_CODE_DOCKING 0x0A
  65 #define  PCI_CLASS_CODE_PROCESSOR 0x0B
  66 #define  PCI_CLASS_CODE_SERIAL  0x0C
  67 #define  PCI_CLASS_CODE_WIRELESS 0x0D
  68 #define  PCI_CLASS_CODE_I2O     0x0E
  69 #define  PCI_CLASS_CODE_SATELLITE 0x0F
  70 #define  PCI_CLASS_CODE_CRYPTO  0x10
  71 #define  PCI_CLASS_CODE_DATA    0x11
  72 /* Base Class 0x12 - 0xFE is reserved */
  73 #define  PCI_CLASS_CODE_OTHER   0xFF
  74
  75 #define PCI_CLASS_SUB_CODE      0x0a    /* Device sub-class code */
  76 #define  PCI_CLASS_SUB_CODE_TOO_OLD_NOTVGA      0x00
  77 #define  PCI_CLASS_SUB_CODE_TOO_OLD_VGA         0x01
  78 #define  PCI_CLASS_SUB_CODE_STORAGE_SCSI        0x00
  79 #define  PCI_CLASS_SUB_CODE_STORAGE_IDE         0x01
  80 #define  PCI_CLASS_SUB_CODE_STORAGE_FLOPPY      0x02
  81 #define  PCI_CLASS_SUB_CODE_STORAGE_IPIBUS      0x03
  82 #define  PCI_CLASS_SUB_CODE_STORAGE_RAID        0x04
  83 #define  PCI_CLASS_SUB_CODE_STORAGE_ATA         0x05
  84 #define  PCI_CLASS_SUB_CODE_STORAGE_SATA        0x06
  85 #define  PCI_CLASS_SUB_CODE_STORAGE_SAS         0x07
  86 #define  PCI_CLASS_SUB_CODE_STORAGE_OTHER       0x80
  87 #define  PCI_CLASS_SUB_CODE_NETWORK_ETHERNET    0x00
  88 #define  PCI_CLASS_SUB_CODE_NETWORK_TOKENRING   0x01
  89 #define  PCI_CLASS_SUB_CODE_NETWORK_FDDI        0x02
  90 #define  PCI_CLASS_SUB_CODE_NETWORK_ATM         0x03
  91 #define  PCI_CLASS_SUB_CODE_NETWORK_ISDN        0x04
  92 #define  PCI_CLASS_SUB_CODE_NETWORK_WORLDFIP    0x05
  93 #define  PCI_CLASS_SUB_CODE_NETWORK_PICMG       0x06
  94 #define  PCI_CLASS_SUB_CODE_NETWORK_OTHER       0x80
  95 #define  PCI_CLASS_SUB_CODE_DISPLAY_VGA         0x00
  96 #define  PCI_CLASS_SUB_CODE_DISPLAY_XGA         0x01
  97 #define  PCI_CLASS_SUB_CODE_DISPLAY_3D          0x02
  98 #define  PCI_CLASS_SUB_CODE_DISPLAY_OTHER       0x80
  99 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_VIDEO    0x00
 100 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_AUDIO    0x01
 101 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_PHONE    0x02
 102 #define  PCI_CLASS_SUB_CODE_MULTIMEDIA_OTHER    0x80
 103 #define  PCI_CLASS_SUB_CODE_MEMORY_RAM          0x00
 104 #define  PCI_CLASS_SUB_CODE_MEMORY_FLASH        0x01
 105 #define  PCI_CLASS_SUB_CODE_MEMORY_OTHER        0x80
 106 #define  PCI_CLASS_SUB_CODE_BRIDGE_HOST         0x00
 107 #define  PCI_CLASS_SUB_CODE_BRIDGE_ISA          0x01
 108 #define  PCI_CLASS_SUB_CODE_BRIDGE_EISA         0x02
 109 #define  PCI_CLASS_SUB_CODE_BRIDGE_MCA          0x03
 110 #define  PCI_CLASS_SUB_CODE_BRIDGE_PCI          0x04
 111 #define  PCI_CLASS_SUB_CODE_BRIDGE_PCMCIA       0x05
 112 #define  PCI_CLASS_SUB_CODE_BRIDGE_NUBUS        0x06
 113 #define  PCI_CLASS_SUB_CODE_BRIDGE_CARDBUS      0x07
 114 #define  PCI_CLASS_SUB_CODE_BRIDGE_RACEWAY      0x08
 115 #define  PCI_CLASS_SUB_CODE_BRIDGE_SEMI_PCI     0x09
 116 #define  PCI_CLASS_SUB_CODE_BRIDGE_INFINIBAND   0x0A
 117 #define  PCI_CLASS_SUB_CODE_BRIDGE_OTHER        0x80
 118 #define  PCI_CLASS_SUB_CODE_COMM_SERIAL         0x00
 119 #define  PCI_CLASS_SUB_CODE_COMM_PARALLEL       0x01
 120 #define  PCI_CLASS_SUB_CODE_COMM_MULTIPORT      0x02
 121 #define  PCI_CLASS_SUB_CODE_COMM_MODEM          0x03
 122 #define  PCI_CLASS_SUB_CODE_COMM_GPIB           0x04
 123 #define  PCI_CLASS_SUB_CODE_COMM_SMARTCARD      0x05
 124 #define  PCI_CLASS_SUB_CODE_COMM_OTHER          0x80
 125 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_PIC      0x00
 126 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_DMA      0x01
 127 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_TIMER    0x02
 128 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_RTC      0x03
 129 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_HOTPLUG  0x04
 130 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_SD       0x05
 131 #define  PCI_CLASS_SUB_CODE_PERIPHERAL_OTHER    0x80
 132 #define  PCI_CLASS_SUB_CODE_INPUT_KEYBOARD      0x00
 133 #define  PCI_CLASS_SUB_CODE_INPUT_DIGITIZER     0x01
 134 #define  PCI_CLASS_SUB_CODE_INPUT_MOUSE         0x02
 135 #define  PCI_CLASS_SUB_CODE_INPUT_SCANNER       0x03
 136 #define  PCI_CLASS_SUB_CODE_INPUT_GAMEPORT      0x04
 137 #define  PCI_CLASS_SUB_CODE_INPUT_OTHER         0x80
 138 #define  PCI_CLASS_SUB_CODE_DOCKING_GENERIC     0x00
 139 #define  PCI_CLASS_SUB_CODE_DOCKING_OTHER       0x80
 140 #define  PCI_CLASS_SUB_CODE_PROCESSOR_386       0x00
 141 #define  PCI_CLASS_SUB_CODE_PROCESSOR_486       0x01
 142 #define  PCI_CLASS_SUB_CODE_PROCESSOR_PENTIUM   0x02
 143 #define  PCI_CLASS_SUB_CODE_PROCESSOR_ALPHA     0x10
 144 #define  PCI_CLASS_SUB_CODE_PROCESSOR_POWERPC   0x20
 145 #define  PCI_CLASS_SUB_CODE_PROCESSOR_MIPS      0x30
 146 #define  PCI_CLASS_SUB_CODE_PROCESSOR_COPROC    0x40
 147 #define  PCI_CLASS_SUB_CODE_SERIAL_1394         0x00
 148 #define  PCI_CLASS_SUB_CODE_SERIAL_ACCESSBUS    0x01
 149 #define  PCI_CLASS_SUB_CODE_SERIAL_SSA          0x02
 150 #define  PCI_CLASS_SUB_CODE_SERIAL_USB          0x03
 151 #define  PCI_CLASS_SUB_CODE_SERIAL_FIBRECHAN    0x04
 152 #define  PCI_CLASS_SUB_CODE_SERIAL_SMBUS        0x05
 153 #define  PCI_CLASS_SUB_CODE_SERIAL_INFINIBAND   0x06
 154 #define  PCI_CLASS_SUB_CODE_SERIAL_IPMI         0x07
 155 #define  PCI_CLASS_SUB_CODE_SERIAL_SERCOS       0x08
 156 #define  PCI_CLASS_SUB_CODE_SERIAL_CANBUS       0x09
 157 #define  PCI_CLASS_SUB_CODE_WIRELESS_IRDA       0x00
 158 #define  PCI_CLASS_SUB_CODE_WIRELESS_IR         0x01
 159 #define  PCI_CLASS_SUB_CODE_WIRELESS_RF         0x10
 160 #define  PCI_CLASS_SUB_CODE_WIRELESS_BLUETOOTH  0x11
 161 #define  PCI_CLASS_SUB_CODE_WIRELESS_BROADBAND  0x12
 162 #define  PCI_CLASS_SUB_CODE_WIRELESS_80211A     0x20
 163 #define  PCI_CLASS_SUB_CODE_WIRELESS_80211B     0x21
 164 #define  PCI_CLASS_SUB_CODE_WIRELESS_OTHER      0x80
 165 #define  PCI_CLASS_SUB_CODE_I2O_V1_0            0x00
 166 #define  PCI_CLASS_SUB_CODE_SATELLITE_TV        0x01
 167 #define  PCI_CLASS_SUB_CODE_SATELLITE_AUDIO     0x02
 168 #define  PCI_CLASS_SUB_CODE_SATELLITE_VOICE     0x03
 169 #define  PCI_CLASS_SUB_CODE_SATELLITE_DATA      0x04
 170 #define  PCI_CLASS_SUB_CODE_CRYPTO_NETWORK      0x00
 171 #define  PCI_CLASS_SUB_CODE_CRYPTO_ENTERTAINMENT 0x10
 172 #define  PCI_CLASS_SUB_CODE_CRYPTO_OTHER        0x80
 173 #define  PCI_CLASS_SUB_CODE_DATA_DPIO           0x00
 174 #define  PCI_CLASS_SUB_CODE_DATA_PERFCNTR       0x01
 175 #define  PCI_CLASS_SUB_CODE_DATA_COMMSYNC       0x10
 176 #define  PCI_CLASS_SUB_CODE_DATA_MGMT           0x20
 177 #define  PCI_CLASS_SUB_CODE_DATA_OTHER          0x80
 178
 179 #define PCI_CACHE_LINE_SIZE     0x0c    /* 8 bits */
 180 #define PCI_LATENCY_TIMER       0x0d    /* 8 bits */
 181 #define PCI_HEADER_TYPE         0x0e    /* 8 bits */
 182 #define  PCI_HEADER_TYPE_NORMAL 0
 183 #define  PCI_HEADER_TYPE_BRIDGE 1
 184 #define  PCI_HEADER_TYPE_CARDBUS 2
 185
 186 #define PCI_BIST                0x0f    /* 8 bits */
 187 #define PCI_BIST_CODE_MASK      0x0f    /* Return result */
 188 #define PCI_BIST_START          0x40    /* 1 to start BIST, 2 secs or less */
 189 #define PCI_BIST_CAPABLE        0x80    /* 1 if BIST capable */
 190
 191 /*
 192  * Base addresses specify locations in memory or I/O space.
 193  * Decoded size can be determined by writing a value of
 194  * 0xffffffff to the register, and reading it back.  Only
 195  * 1 bits are decoded.
 196  */
 197 #define PCI_BASE_ADDRESS_0      0x10    /* 32 bits */
 198 #define PCI_BASE_ADDRESS_1      0x14    /* 32 bits [htype 0,1 only] */
 199 #define PCI_BASE_ADDRESS_2      0x18    /* 32 bits [htype 0 only] */
 200 #define PCI_BASE_ADDRESS_3      0x1c    /* 32 bits */
 201 #define PCI_BASE_ADDRESS_4      0x20    /* 32 bits */
 202 #define PCI_BASE_ADDRESS_5      0x24    /* 32 bits */
 203 #define  PCI_BASE_ADDRESS_SPACE 0x01    /* 0 = memory, 1 = I/O */
 204 #define  PCI_BASE_ADDRESS_SPACE_IO 0x01
 205 #define  PCI_BASE_ADDRESS_SPACE_MEMORY 0x00
 206 #define  PCI_BASE_ADDRESS_MEM_TYPE_MASK 0x06
 207 #define  PCI_BASE_ADDRESS_MEM_TYPE_32   0x00    /* 32 bit address */
 208 #define  PCI_BASE_ADDRESS_MEM_TYPE_1M   0x02    /* Below 1M [obsolete] */
 209 #define  PCI_BASE_ADDRESS_MEM_TYPE_64   0x04    /* 64 bit address */
 210 #define  PCI_BASE_ADDRESS_MEM_PREFETCH  0x08    /* prefetchable? */
 211 #define  PCI_BASE_ADDRESS_MEM_MASK      (~0x0fULL)
 212 #define  PCI_BASE_ADDRESS_IO_MASK       (~0x03ULL)
 213 /* bit 1 is reserved if address_space = 1 */
 214
 215 /* Header type 0 (normal devices) */
 216 #define PCI_CARDBUS_CIS         0x28
 217 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c
 218 #define PCI_SUBSYSTEM_ID        0x2e
 219 #define PCI_ROM_ADDRESS         0x30    /* Bits 31..11 are address, 10..1 reserved */
 220 #define  PCI_ROM_ADDRESS_ENABLE 0x01
 221 #define PCI_ROM_ADDRESS_MASK    (~0x7ffULL)
 222
 223 #define PCI_CAPABILITY_LIST     0x34    /* Offset of first capability list entry */
 224
 225 /* 0x35-0x3b are reserved */
 226 #define PCI_INTERRUPT_LINE      0x3c    /* 8 bits */
 227 #define PCI_INTERRUPT_PIN       0x3d    /* 8 bits */
 228 #define PCI_MIN_GNT             0x3e    /* 8 bits */
 229 #define PCI_MAX_LAT             0x3f    /* 8 bits */
 230
 231 /* Header type 1 (PCI-to-PCI bridges) */
 232 #define PCI_PRIMARY_BUS         0x18    /* Primary bus number */
 233 #define PCI_SECONDARY_BUS       0x19    /* Secondary bus number */
 234 #define PCI_SUBORDINATE_BUS     0x1a    /* Highest bus number behind the bridge */
 235 #define PCI_SEC_LATENCY_TIMER   0x1b    /* Latency timer for secondary interface */
 236 #define PCI_IO_BASE             0x1c    /* I/O range behind the bridge */
 237 #define PCI_IO_LIMIT            0x1d
 238 #define  PCI_IO_RANGE_TYPE_MASK 0x0f    /* I/O bridging type */
 239 #define  PCI_IO_RANGE_TYPE_16   0x00
 240 #define  PCI_IO_RANGE_TYPE_32   0x01
 241 #define  PCI_IO_RANGE_MASK      ~0x0f
 242 #define PCI_SEC_STATUS          0x1e    /* Secondary status register, only bit 14 used */
 243 #define PCI_MEMORY_BASE         0x20    /* Memory range behind */
 244 #define PCI_MEMORY_LIMIT        0x22
 245 #define  PCI_MEMORY_RANGE_TYPE_MASK 0x0f
 246 #define  PCI_MEMORY_RANGE_MASK  ~0x0f
 247 #define PCI_PREF_MEMORY_BASE    0x24    /* Prefetchable memory range behind */
 248 #define PCI_PREF_MEMORY_LIMIT   0x26
 249 #define  PCI_PREF_RANGE_TYPE_MASK 0x0f
 250 #define  PCI_PREF_RANGE_TYPE_32 0x00
 251 #define  PCI_PREF_RANGE_TYPE_64 0x01
 252 #define  PCI_PREF_RANGE_MASK    ~0x0f
 253 #define PCI_PREF_BASE_UPPER32   0x28    /* Upper half of prefetchable memory range */
 254 #define PCI_PREF_LIMIT_UPPER32  0x2c
 255 #define PCI_IO_BASE_UPPER16     0x30    /* Upper half of I/O addresses */
 256 #define PCI_IO_LIMIT_UPPER16    0x32
 257 /* 0x34 same as for htype 0 */
 258 /* 0x35-0x3b is reserved */
 259 #define PCI_ROM_ADDRESS1        0x38    /* Same as PCI_ROM_ADDRESS, but for htype 1 */
 260 /* 0x3c-0x3d are same as for htype 0 */
 261 #define PCI_BRIDGE_CONTROL      0x3e
 262 #define  PCI_BRIDGE_CTL_PARITY  0x01    /* Enable parity detection on secondary interface */
 263 #define  PCI_BRIDGE_CTL_SERR    0x02    /* The same for SERR forwarding */
 264 #define  PCI_BRIDGE_CTL_NO_ISA  0x04    /* Disable bridging of ISA ports */
 265 #define  PCI_BRIDGE_CTL_VGA     0x08    /* Forward VGA addresses */
 266 #define  PCI_BRIDGE_CTL_MASTER_ABORT 0x20  /* Report master aborts */
 267 #define  PCI_BRIDGE_CTL_BUS_RESET 0x40  /* Secondary bus reset */
 268 #define  PCI_BRIDGE_CTL_FAST_BACK 0x80  /* Fast Back2Back enabled on secondary interface */
 269
 270 /* From 440ep */
 271 #define PCI_ERREN       0x48     /* Error Enable */
 272 #define PCI_ERRSTS      0x49     /* Error Status */
 273 #define PCI_BRDGOPT1    0x4A     /* PCI Bridge Options 1 */
 274 #define PCI_PLBSESR0    0x4C     /* PCI PLB Slave Error Syndrome 0 */
 275 #define PCI_PLBSESR1    0x50     /* PCI PLB Slave Error Syndrome 1 */
 276 #define PCI_PLBSEAR     0x54     /* PCI PLB Slave Error Address */
 277 #define PCI_CAPID       0x58     /* Capability Identifier */
 278 #define PCI_NEXTITEMPTR 0x59     /* Next Item Pointer */
 279 #define PCI_PMC         0x5A     /* Power Management Capabilities */
 280 #define PCI_PMCSR       0x5C     /* Power Management Control Status */
 281 #define PCI_PMCSRBSE    0x5E     /* PMCSR PCI to PCI Bridge Support Extensions */
 282 #define PCI_BRDGOPT2    0x60     /* PCI Bridge Options 2 */
 283 #define PCI_PMSCRR      0x64     /* Power Management State Change Request Re. */
 284
 285 /* Header type 2 (CardBus bridges) */
 286 #define PCI_CB_CAPABILITY_LIST  0x14
 287 /* 0x15 reserved */
 288 #define PCI_CB_SEC_STATUS       0x16    /* Secondary status */
 289 #define PCI_CB_PRIMARY_BUS      0x18    /* PCI bus number */
 290 #define PCI_CB_CARD_BUS         0x19    /* CardBus bus number */
 291 #define PCI_CB_SUBORDINATE_BUS  0x1a    /* Subordinate bus number */
 292 #define PCI_CB_LATENCY_TIMER    0x1b    /* CardBus latency timer */
 293 #define PCI_CB_MEMORY_BASE_0    0x1c
 294 #define PCI_CB_MEMORY_LIMIT_0   0x20
 295 #define PCI_CB_MEMORY_BASE_1    0x24
 296 #define PCI_CB_MEMORY_LIMIT_1   0x28
 297 #define PCI_CB_IO_BASE_0        0x2c
 298 #define PCI_CB_IO_BASE_0_HI     0x2e
 299 #define PCI_CB_IO_LIMIT_0       0x30
 300 #define PCI_CB_IO_LIMIT_0_HI    0x32
 301 #define PCI_CB_IO_BASE_1        0x34
 302 #define PCI_CB_IO_BASE_1_HI     0x36
 303 #define PCI_CB_IO_LIMIT_1       0x38
 304 #define PCI_CB_IO_LIMIT_1_HI    0x3a
 305 #define  PCI_CB_IO_RANGE_MASK   ~0x03
 306 /* 0x3c-0x3d are same as for htype 0 */
 307 #define PCI_CB_BRIDGE_CONTROL   0x3e
 308 #define  PCI_CB_BRIDGE_CTL_PARITY       0x01    /* Similar to standard bridge control register */
 309 #define  PCI_CB_BRIDGE_CTL_SERR         0x02
 310 #define  PCI_CB_BRIDGE_CTL_ISA          0x04
 311 #define  PCI_CB_BRIDGE_CTL_VGA          0x08
 312 #define  PCI_CB_BRIDGE_CTL_MASTER_ABORT 0x20
 313 #define  PCI_CB_BRIDGE_CTL_CB_RESET     0x40    /* CardBus reset */
 314 #define  PCI_CB_BRIDGE_CTL_16BIT_INT    0x80    /* Enable interrupt for 16-bit cards */
 315 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM0 0x100  /* Prefetch enable for both memory regions */
 316 #define  PCI_CB_BRIDGE_CTL_PREFETCH_MEM1 0x200
 317 #define  PCI_CB_BRIDGE_CTL_POST_WRITES  0x400
 318 #define PCI_CB_SUBSYSTEM_VENDOR_ID 0x40
 319 #define PCI_CB_SUBSYSTEM_ID     0x42
 320 #define PCI_CB_LEGACY_MODE_BASE 0x44    /* 16-bit PC Card legacy mode base address (ExCa) */
 321 /* 0x48-0x7f reserved */
 322
 323 /* Capability lists */
 324
 325 #define PCI_CAP_LIST_ID         0       /* Capability ID */
 326 #define  PCI_CAP_ID_PM          0x01    /* Power Management */
 327 #define  PCI_CAP_ID_AGP         0x02    /* Accelerated Graphics Port */
 328 #define  PCI_CAP_ID_VPD         0x03    /* Vital Product Data */
 329 #define  PCI_CAP_ID_SLOTID      0x04    /* Slot Identification */
 330 #define  PCI_CAP_ID_MSI         0x05    /* Message Signalled Interrupts */
 331 #define  PCI_CAP_ID_CHSWP       0x06    /* CompactPCI HotSwap */
 332 #define  PCI_CAP_ID_EXP         0x10    /* PCI Express */
 333 #define PCI_CAP_LIST_NEXT       1       /* Next capability in the list */
 334 #define PCI_CAP_FLAGS           2       /* Capability defined flags (16 bits) */
 335 #define PCI_CAP_SIZEOF          4
 336
 337 /* Power Management Registers */
 338
 339 #define  PCI_PM_CAP_VER_MASK    0x0007  /* Version */
 340 #define  PCI_PM_CAP_PME_CLOCK   0x0008  /* PME clock required */
 341 #define  PCI_PM_CAP_AUX_POWER   0x0010  /* Auxilliary power support */
 342 #define  PCI_PM_CAP_DSI         0x0020  /* Device specific initialization */
 343 #define  PCI_PM_CAP_D1          0x0200  /* D1 power state support */
 344 #define  PCI_PM_CAP_D2          0x0400  /* D2 power state support */
 345 #define  PCI_PM_CAP_PME         0x0800  /* PME pin supported */
 346 #define PCI_PM_CTRL             4       /* PM control and status register */
 347 #define  PCI_PM_CTRL_STATE_MASK 0x0003  /* Current power state (D0 to D3) */
 348 #define  PCI_PM_CTRL_PME_ENABLE 0x0100  /* PME pin enable */
 349 #define  PCI_PM_CTRL_DATA_SEL_MASK      0x1e00  /* Data select (??) */
 350 #define  PCI_PM_CTRL_DATA_SCALE_MASK    0x6000  /* Data scale (??) */
 351 #define  PCI_PM_CTRL_PME_STATUS 0x8000  /* PME pin status */
 352 #define PCI_PM_PPB_EXTENSIONS   6       /* PPB support extensions (??) */
 353 #define  PCI_PM_PPB_B2_B3       0x40    /* Stop clock when in D3hot (??) */
 354 #define  PCI_PM_BPCC_ENABLE     0x80    /* Bus power/clock control enable (??) */
 355 #define PCI_PM_DATA_REGISTER    7       /* (??) */
 356 #define PCI_PM_SIZEOF           8
 357
 358 /* AGP registers */
 359
 360 #define PCI_AGP_VERSION         2       /* BCD version number */
 361 #define PCI_AGP_RFU             3       /* Rest of capability flags */
 362 #define PCI_AGP_STATUS          4       /* Status register */
 363 #define  PCI_AGP_STATUS_RQ_MASK 0xff000000      /* Maximum number of requests - 1 */
 364 #define  PCI_AGP_STATUS_SBA     0x0200  /* Sideband addressing supported */
 365 #define  PCI_AGP_STATUS_64BIT   0x0020  /* 64-bit addressing supported */
 366 #define  PCI_AGP_STATUS_FW      0x0010  /* FW transfers supported */
 367 #define  PCI_AGP_STATUS_RATE4   0x0004  /* 4x transfer rate supported */
 368 #define  PCI_AGP_STATUS_RATE2   0x0002  /* 2x transfer rate supported */
 369 #define  PCI_AGP_STATUS_RATE1   0x0001  /* 1x transfer rate supported */
 370 #define PCI_AGP_COMMAND         8       /* Control register */
 371 #define  PCI_AGP_COMMAND_RQ_MASK 0xff000000  /* Master: Maximum number of requests */
 372 #define  PCI_AGP_COMMAND_SBA    0x0200  /* Sideband addressing enabled */
 373 #define  PCI_AGP_COMMAND_AGP    0x0100  /* Allow processing of AGP transactions */
 374 #define  PCI_AGP_COMMAND_64BIT  0x0020  /* Allow processing of 64-bit addresses */
 375 #define  PCI_AGP_COMMAND_FW     0x0010  /* Force FW transfers */
 376 #define  PCI_AGP_COMMAND_RATE4  0x0004  /* Use 4x rate */
 377 #define  PCI_AGP_COMMAND_RATE2  0x0002  /* Use 4x rate */
 378 #define  PCI_AGP_COMMAND_RATE1  0x0001  /* Use 4x rate */
 379 #define PCI_AGP_SIZEOF          12
 380
 381 /* PCI-X registers */
 382
 383 #define  PCI_X_CMD_DPERR_E      0x0001  /* Data Parity Error Recovery Enable */
 384 #define  PCI_X_CMD_ERO          0x0002  /* Enable Relaxed Ordering */
 385 #define  PCI_X_CMD_MAX_READ     0x0000  /* Max Memory Read Byte Count */
 386 #define  PCI_X_CMD_MAX_SPLIT    0x0030  /* Max Outstanding Split Transactions */
 387 #define  PCI_X_CMD_VERSION(x)   (((x) >> 12) & 3) /* Version */
 388
 389
 390 /* Slot Identification */
 391
 392 #define PCI_SID_ESR             2       /* Expansion Slot Register */
 393 #define  PCI_SID_ESR_NSLOTS     0x1f    /* Number of expansion slots available */
 394 #define  PCI_SID_ESR_FIC        0x20    /* First In Chassis Flag */
 395 #define PCI_SID_CHASSIS_NR      3       /* Chassis Number */
 396
 397 /* Message Signalled Interrupts registers */
 398
 399 #define PCI_MSI_FLAGS           2       /* Various flags */
 400 #define  PCI_MSI_FLAGS_64BIT    0x80    /* 64-bit addresses allowed */
 401 #define  PCI_MSI_FLAGS_QSIZE    0x70    /* Message queue size configured */
 402 #define  PCI_MSI_FLAGS_QMASK    0x0e    /* Maximum queue size available */
 403 #define  PCI_MSI_FLAGS_ENABLE   0x01    /* MSI feature enabled */
 404 #define PCI_MSI_RFU             3       /* Rest of capability flags */
 405 #define PCI_MSI_ADDRESS_LO      4       /* Lower 32 bits */
 406 #define PCI_MSI_ADDRESS_HI      8       /* Upper 32 bits (if PCI_MSI_FLAGS_64BIT set) */
 407 #define PCI_MSI_DATA_32         8       /* 16 bits of data for 32-bit devices */
 408 #define PCI_MSI_DATA_64         12      /* 16 bits of data for 64-bit devices */
 409
 410 #define PCI_MAX_PCI_DEVICES     32
 411 #define PCI_MAX_PCI_FUNCTIONS   8
 412
 413 #define PCI_FIND_CAP_TTL 0x48
 414 #define CAP_START_POS 0x40
 415
 416 /* Include the ID list */
 417
 418 #include <pci_ids.h>
 419
 420 #ifndef __ASSEMBLY__
 421
 422 #ifdef CONFIG_SYS_PCI_64BIT
 423 typedef u64 pci_addr_t;
 424 typedef u64 pci_size_t;
 425 #else
 426 typedef u32 pci_addr_t;
 427 typedef u32 pci_size_t;
 428 #endif
 429
 430 struct pci_region {
 431         pci_addr_t bus_start;   /* Start on the bus */
 432         phys_addr_t phys_start; /* Start in physical address space */
 433         pci_size_t size;        /* Size */
 434         unsigned long flags;    /* Resource flags */
 435
 436         pci_addr_t bus_lower;
 437 };
 438
 439 #define PCI_REGION_MEM          0x00000000      /* PCI memory space */
 440 #define PCI_REGION_IO           0x00000001      /* PCI IO space */
 441 #define PCI_REGION_TYPE         0x00000001
 442 #define PCI_REGION_PREFETCH     0x00000008      /* prefetchable PCI memory */
 443
 444 #define PCI_REGION_SYS_MEMORY   0x00000100      /* System memory */
 445 #define PCI_REGION_RO           0x00000200      /* Read-only memory */
 446
 447 static inline void pci_set_region(struct pci_region *reg,
 448                                       pci_addr_t bus_start,
 449                                       phys_addr_t phys_start,
 450                                       pci_size_t size,
 451                                       unsigned long flags) {
 452         reg->bus_start  = bus_start;
 453         reg->phys_start = phys_start;
 454         reg->size       = size;
 455         reg->flags      = flags;
 456 }
 457
 458 typedef int pci_dev_t;
 459
 460 #define PCI_BUS(d)              (((d) >> 16) & 0xff)
 461 #define PCI_DEV(d)              (((d) >> 11) & 0x1f)
 462 #define PCI_FUNC(d)             (((d) >> 8) & 0x7)
 463 #define PCI_DEVFN(d, f)         ((d) << 11 | (f) << 8)
 464 #define PCI_MASK_BUS(bdf)       ((bdf) & 0xffff)
 465 #define PCI_ADD_BUS(bus, devfn) (((bus) << 16) | (devfn))
 466 #define PCI_BDF(b, d, f)        ((b) << 16 | PCI_DEVFN(d, f))
 467 #define PCI_VENDEV(v, d)        (((v) << 16) | (d))
 468 #define PCI_ANY_ID              (~0)
 469
 470 struct pci_device_id {
 471         unsigned int vendor, device;    /* Vendor and device ID or PCI_ANY_ID */
 472         unsigned int subvendor, subdevice; /* Subsystem ID's or PCI_ANY_ID */
 473         unsigned int class, class_mask; /* (class,subclass,prog-if) triplet */
 474         unsigned long driver_data;      /* Data private to the driver */
 475 };
 476
 477 struct pci_controller;
 478
 479 struct pci_config_table {
 480         unsigned int vendor, device;            /* Vendor and device ID or PCI_ANY_ID */
 481         unsigned int class;                     /* Class ID, or  PCI_ANY_ID */
 482         unsigned int bus;                       /* Bus number, or PCI_ANY_ID */
 483         unsigned int dev;                       /* Device number, or PCI_ANY_ID */
 484         unsigned int func;                      /* Function number, or PCI_ANY_ID */
 485
 486         void (*config_device)(struct pci_controller* hose, pci_dev_t dev,
 487                               struct pci_config_table *);
 488         unsigned long priv[3];
 489 };
 490
 491 extern void pci_cfgfunc_do_nothing(struct pci_controller* hose, pci_dev_t dev,
 492                                    struct pci_config_table *);
 493 extern void pci_cfgfunc_config_device(struct pci_controller* hose, pci_dev_t dev,
 494                                       struct pci_config_table *);
 495
 496 #define MAX_PCI_REGIONS         7
 497
 498 #define INDIRECT_TYPE_NO_PCIE_LINK      1
 499
 500 /*
 501  * Structure of a PCI controller (host bridge)
 502  */
 503 struct pci_controller {
 504 #ifdef CONFIG_DM_PCI
 505         struct udevice *bus;
 506         struct udevice *ctlr;
 507 #else
 508         struct pci_controller *next;
 509 #endif
 510
 511         int first_busno;
 512         int last_busno;
 513
 514         volatile unsigned int *cfg_addr;
 515         volatile unsigned char *cfg_data;
 516
 517         int indirect_type;
 518
 519         /*
 520          * TODO(sjg@chromium.org): With driver model we use struct
 521          * pci_controller for both the controller and any bridge devices
 522          * attached to it. But there is only one region list and it is in the
 523          * top-level controller.
 524          *
 525          * This could be changed so that struct pci_controller is only used
 526          * for PCI controllers and a separate UCLASS (or perhaps
 527          * UCLASS_PCI_GENERIC) is used for bridges.
 528          */
 529         struct pci_region regions[MAX_PCI_REGIONS];
 530         int region_count;
 531
 532         struct pci_config_table *config_table;
 533
 534         void (*fixup_irq)(struct pci_controller *, pci_dev_t);
 535 #ifndef CONFIG_DM_PCI
 536         /* Low-level architecture-dependent routines */
 537         int (*read_byte)(struct pci_controller*, pci_dev_t, int where, u8 *);
 538         int (*read_word)(struct pci_controller*, pci_dev_t, int where, u16 *);
 539         int (*read_dword)(struct pci_controller*, pci_dev_t, int where, u32 *);
 540         int (*write_byte)(struct pci_controller*, pci_dev_t, int where, u8);
 541         int (*write_word)(struct pci_controller*, pci_dev_t, int where, u16);
 542         int (*write_dword)(struct pci_controller*, pci_dev_t, int where, u32);
 543 #endif
 544
 545         /* Used by auto config */
 546         struct pci_region *pci_mem, *pci_io, *pci_prefetch;
 547
 548         /* Used by ppc405 autoconfig*/
 549         struct pci_region *pci_fb;
 550 #ifndef CONFIG_DM_PCI
 551         int current_busno;
 552
 553         void *priv_data;
 554 #endif
 555 };
 556
 557 #ifndef CONFIG_DM_PCI
 558 static inline void pci_set_ops(struct pci_controller *hose,
 559                                    int (*read_byte)(struct pci_controller*,
 560                                                     pci_dev_t, int where, u8 *),
 561                                    int (*read_word)(struct pci_controller*,
 562                                                     pci_dev_t, int where, u16 *),
 563                                    int (*read_dword)(struct pci_controller*,
 564                                                      pci_dev_t, int where, u32 *),
 565                                    int (*write_byte)(struct pci_controller*,
 566                                                      pci_dev_t, int where, u8),
 567                                    int (*write_word)(struct pci_controller*,
 568                                                      pci_dev_t, int where, u16),
 569                                    int (*write_dword)(struct pci_controller*,
 570                                                       pci_dev_t, int where, u32)) {
 571         hose->read_byte   = read_byte;
 572         hose->read_word   = read_word;
 573         hose->read_dword  = read_dword;
 574         hose->write_byte  = write_byte;
 575         hose->write_word  = write_word;
 576         hose->write_dword = write_dword;
 577 }
 578 #endif
 579
 580 #ifdef CONFIG_PCI_INDIRECT_BRIDGE
 581 extern void pci_setup_indirect(struct pci_controller* hose, u32 cfg_addr, u32 cfg_data);
 582 #endif
 583
 584 extern phys_addr_t pci_hose_bus_to_phys(struct pci_controller* hose,
 585                                         pci_addr_t addr, unsigned long flags);
 586 extern pci_addr_t pci_hose_phys_to_bus(struct pci_controller* hose,
 587                                         phys_addr_t addr, unsigned long flags);
 588
 589 #define pci_phys_to_bus(dev, addr, flags) \
 590         pci_hose_phys_to_bus(pci_bus_to_hose(PCI_BUS(dev)), (addr), (flags))
 591 #define pci_bus_to_phys(dev, addr, flags) \
 592         pci_hose_bus_to_phys(pci_bus_to_hose(PCI_BUS(dev)), (addr), (flags))
 593
 594 #define pci_virt_to_bus(dev, addr, flags) \
 595         pci_hose_phys_to_bus(pci_bus_to_hose(PCI_BUS(dev)), \
 596                              (virt_to_phys(addr)), (flags))
 597 #define pci_bus_to_virt(dev, addr, flags, len, map_flags) \
 598         map_physmem(pci_hose_bus_to_phys(pci_bus_to_hose(PCI_BUS(dev)), \
 599                                          (addr), (flags)), \
 600                     (len), (map_flags))
 601
 602 #define pci_phys_to_mem(dev, addr) \
 603         pci_phys_to_bus((dev), (addr), PCI_REGION_MEM)
 604 #define pci_mem_to_phys(dev, addr) \
 605         pci_bus_to_phys((dev), (addr), PCI_REGION_MEM)
 606 #define pci_phys_to_io(dev, addr)  pci_phys_to_bus((dev), (addr), PCI_REGION_IO)
 607 #define pci_io_to_phys(dev, addr)  pci_bus_to_phys((dev), (addr), PCI_REGION_IO)
 608
 609 #define pci_virt_to_mem(dev, addr) \
 610         pci_virt_to_bus((dev), (addr), PCI_REGION_MEM)
 611 #define pci_mem_to_virt(dev, addr, len, map_flags) \
 612         pci_bus_to_virt((dev), (addr), PCI_REGION_MEM, (len), (map_flags))
 613 #define pci_virt_to_io(dev, addr) \
 614         pci_virt_to_bus((dev), (addr), PCI_REGION_IO)
 615 #define pci_io_to_virt(dev, addr, len, map_flags) \
 616         pci_bus_to_virt((dev), (addr), PCI_REGION_IO, (len), (map_flags))
 617
 618 extern int pci_hose_read_config_byte(struct pci_controller *hose,
 619                                      pci_dev_t dev, int where, u8 *val);
 620 extern int pci_hose_read_config_word(struct pci_controller *hose,
 621                                      pci_dev_t dev, int where, u16 *val);
 622 extern int pci_hose_read_config_dword(struct pci_controller *hose,
 623                                       pci_dev_t dev, int where, u32 *val);
 624 extern int pci_hose_write_config_byte(struct pci_controller *hose,
 625                                       pci_dev_t dev, int where, u8 val);
 626 extern int pci_hose_write_config_word(struct pci_controller *hose,
 627                                       pci_dev_t dev, int where, u16 val);
 628 extern int pci_hose_write_config_dword(struct pci_controller *hose,
 629                                        pci_dev_t dev, int where, u32 val);
 630
 631 #ifndef CONFIG_DM_PCI
 632 extern int pci_read_config_byte(pci_dev_t dev, int where, u8 *val);
 633 extern int pci_read_config_word(pci_dev_t dev, int where, u16 *val);
 634 extern int pci_read_config_dword(pci_dev_t dev, int where, u32 *val);
 635 extern int pci_write_config_byte(pci_dev_t dev, int where, u8 val);
 636 extern int pci_write_config_word(pci_dev_t dev, int where, u16 val);
 637 extern int pci_write_config_dword(pci_dev_t dev, int where, u32 val);
 638 #endif
 639
 640 extern int pci_hose_read_config_byte_via_dword(struct pci_controller *hose,
 641                                                pci_dev_t dev, int where, u8 *val);
 642 extern int pci_hose_read_config_word_via_dword(struct pci_controller *hose,
 643                                                pci_dev_t dev, int where, u16 *val);
 644 extern int pci_hose_write_config_byte_via_dword(struct pci_controller *hose,
 645                                                 pci_dev_t dev, int where, u8 val);
 646 extern int pci_hose_write_config_word_via_dword(struct pci_controller *hose,
 647                                                 pci_dev_t dev, int where, u16 val);
 648
 649 extern void *pci_map_bar(pci_dev_t pdev, int bar, int flags);
 650 extern void pci_register_hose(struct pci_controller* hose);
 651 extern struct pci_controller* pci_bus_to_hose(int bus);
 652 extern struct pci_controller *find_hose_by_cfg_addr(void *cfg_addr);
 653
 654 extern int pci_skip_dev(struct pci_controller *hose, pci_dev_t dev);
 655 extern int pci_hose_scan(struct pci_controller *hose);
 656 extern int pci_hose_scan_bus(struct pci_controller *hose, int bus);
 657
 658 extern void pciauto_region_init(struct pci_region* res);
 659 extern void pciauto_region_align(struct pci_region *res, pci_size_t size);
 660 extern int pciauto_region_allocate(struct pci_region* res, pci_size_t size, pci_addr_t *bar);
 661 extern void pciauto_setup_device(struct pci_controller *hose,
 662                                  pci_dev_t dev, int bars_num,
 663                                  struct pci_region *mem,
 664                                  struct pci_region *prefetch,
 665                                  struct pci_region *io);
 666 extern void pciauto_prescan_setup_bridge(struct pci_controller *hose,
 667                                  pci_dev_t dev, int sub_bus);
 668 extern void pciauto_postscan_setup_bridge(struct pci_controller *hose,
 669                                  pci_dev_t dev, int sub_bus);
 670 extern void pciauto_config_init(struct pci_controller *hose);
 671 extern int pciauto_config_device(struct pci_controller *hose, pci_dev_t dev);
 672
 673 extern pci_dev_t pci_find_device (unsigned int vendor, unsigned int device, int index);
 674 extern pci_dev_t pci_find_devices (struct pci_device_id *ids, int index);
 675 pci_dev_t pci_find_class(unsigned int find_class, int index);
 676
 677 extern int pci_hose_config_device(struct pci_controller *hose,
 678                                   pci_dev_t dev,
 679                                   unsigned long io,
 680                                   pci_addr_t mem,
 681                                   unsigned long command);
 682
 683 extern int pci_hose_find_capability(struct pci_controller *hose, pci_dev_t dev,
 684                                     int cap);
 685 extern int pci_hose_find_cap_start(struct pci_controller *hose, pci_dev_t dev,
 686                                    u8 hdr_type);
 687 extern int pci_find_cap(struct pci_controller *hose, pci_dev_t dev, int pos,
 688                         int cap);
 689
 690 #ifdef CONFIG_PCI_FIXUP_DEV
 691 extern void board_pci_fixup_dev(struct pci_controller *hose, pci_dev_t dev,
 692                                 unsigned short vendor,
 693                                 unsigned short device,
 694                                 unsigned short class);
 695 #endif
 696
 697 const char * pci_class_str(u8 class);
 698 int pci_last_busno(void);
 699
 700 #ifdef CONFIG_MPC85xx
 701 extern void pci_mpc85xx_init (struct pci_controller *hose);
 702 #endif
 703
 704 /**
 705  * pci_write_bar32() - Write the address of a BAR including control bits
 706  *
 707  * This writes a raw address (with control bits) to a bar
 708  *
 709  * @hose:       PCI hose to use
 710  * @dev:        PCI device to update
 711  * @barnum:     BAR number (0-5)
 712  * @addr:       BAR address with control bits
 713  */
 714 void pci_write_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum,
 715                      u32 addr_and_ctrl);
 716
 717 /**
 718  * pci_read_bar32() - read the address of a bar
 719  *
 720  * @hose:       PCI hose to use
 721  * @dev:        PCI device to inspect
 722  * @barnum:     BAR number (0-5)
 723  * @return address of the bar, masking out any control bits
 724  * */
 725 u32 pci_read_bar32(struct pci_controller *hose, pci_dev_t dev, int barnum);
 726
 727 /**
 728  * pci_hose_find_devices() - Find devices by vendor/device ID
 729  *
 730  * @hose:       PCI hose to search
 731  * @busnum:     Bus number to search
 732  * @ids:        PCI vendor/device IDs to look for, terminated by 0, 0 record
 733  * @indexp:     Pointer to device index to find. To find the first matching
 734  *              device, pass 0; to find the second, pass 1, etc. This
 735  *              parameter is decremented for each non-matching device so
 736  *              can be called repeatedly.
 737  */
 738 pci_dev_t pci_hose_find_devices(struct pci_controller *hose, int busnum,
 739                                 struct pci_device_id *ids, int *indexp);
 740
 741 /* Access sizes for PCI reads and writes */
 742 enum pci_size_t {
 743         PCI_SIZE_8,
 744         PCI_SIZE_16,
 745         PCI_SIZE_32,
 746 };
 747
 748 struct udevice;
 749
 750 #ifdef CONFIG_DM_PCI
 751 /**
 752  * struct pci_child_platdata - information stored about each PCI device
 753  *
 754  * Every device on a PCI bus has this per-child data.
 755  *
 756  * It can be accessed using dev_get_parentdata(dev) if dev->parent is a
 757  * PCI bus (i.e. UCLASS_PCI)
 758  *
 759  * @devfn:      Encoded device and function index - see PCI_DEVFN()
 760  * @vendor:     PCI vendor ID (see pci_ids.h)
 761  * @device:     PCI device ID (see pci_ids.h)
 762  * @class:      PCI class, 3 bytes: (base, sub, prog-if)
 763  */
 764 struct pci_child_platdata {
 765         int devfn;
 766         unsigned short vendor;
 767         unsigned short device;
 768         unsigned int class;
 769 };
 770
 771 /* PCI bus operations */
 772 struct dm_pci_ops {
 773         /**
 774          * read_config() - Read a PCI configuration value
 775          *
 776          * PCI buses must support reading and writing configuration values
 777          * so that the bus can be scanned and its devices configured.
 778          *
 779          * Normally PCI_BUS(@bdf) is the same as @bus->seq, but not always.
 780          * If bridges exist it is possible to use the top-level bus to
 781          * access a sub-bus. In that case @bus will be the top-level bus
 782          * and PCI_BUS(bdf) will be a different (higher) value
 783          *
 784          * @bus:        Bus to read from
 785          * @bdf:        Bus, device and function to read
 786          * @offset:     Byte offset within the device's configuration space
 787          * @valuep:     Place to put the returned value
 788          * @size:       Access size
 789          * @return 0 if OK, -ve on error
 790          */
 791         int (*read_config)(struct udevice *bus, pci_dev_t bdf, uint offset,
 792                            ulong *valuep, enum pci_size_t size);
 793         /**
 794          * write_config() - Write a PCI configuration value
 795          *
 796          * @bus:        Bus to write to
 797          * @bdf:        Bus, device and function to write
 798          * @offset:     Byte offset within the device's configuration space
 799          * @value:      Value to write
 800          * @size:       Access size
 801          * @return 0 if OK, -ve on error
 802          */
 803         int (*write_config)(struct udevice *bus, pci_dev_t bdf, uint offset,
 804                             ulong value, enum pci_size_t size);
 805 };
 806
 807 /* Get access to a PCI bus' operations */
 808 #define pci_get_ops(dev)        ((struct dm_pci_ops *)(dev)->driver->ops)
 809
 810 /**
 811  * pci_get_bdf() - Get the BDF value for a device
 812  *
 813  * @dev:        Device to check
 814  * @return bus/device/function value (see PCI_BDF())
 815  */
 816 pci_dev_t pci_get_bdf(struct udevice *dev);
 817
 818 /**
 819  * pci_bind_bus_devices() - scan a PCI bus and bind devices
 820  *
 821  * Scan a PCI bus looking for devices. Bind each one that is found. If
 822  * devices are already bound that match the scanned devices, just update the
 823  * child data so that the device can be used correctly (this happens when
 824  * the device tree describes devices we expect to see on the bus).
 825  *
 826  * Devices that are bound in this way will use a generic PCI driver which
 827  * does nothing. The device can still be accessed but will not provide any
 828  * driver interface.
 829  *
 830  * @bus:        Bus containing devices to bind
 831  * @return 0 if OK, -ve on error
 832  */
 833 int pci_bind_bus_devices(struct udevice *bus);
 834
 835 /**
 836  * pci_auto_config_devices() - configure bus devices ready for use
 837  *
 838  * This works through all devices on a bus by scanning the driver model
 839  * data structures (normally these have been set up by pci_bind_bus_devices()
 840  * earlier).
 841  *
 842  * Space is allocated for each PCI base address register (BAR) so that the
 843  * devices are mapped into memory and I/O space ready for use.
 844  *
 845  * @bus:        Bus containing devices to bind
 846  * @return 0 if OK, -ve on error
 847  */
 848 int pci_auto_config_devices(struct udevice *bus);
 849
 850 /**
 851  * pci_bus_find_bdf() - Find a device given its PCI bus address
 852  *
 853  * @bdf:        PCI device address: bus, device and function -see PCI_BDF()
 854  * @devp:       Returns the device for this address, if found
 855  * @return 0 if OK, -ENODEV if not found
 856  */
 857 int pci_bus_find_bdf(pci_dev_t bdf, struct udevice **devp);
 858
 859 /**
 860  * pci_bus_find_devfn() - Find a device on a bus
 861  *
 862  * @find_devfn:         PCI device address (device and function only)
 863  * @devp:       Returns the device for this address, if found
 864  * @return 0 if OK, -ENODEV if not found
 865  */
 866 int pci_bus_find_devfn(struct udevice *bus, pci_dev_t find_devfn,
 867                        struct udevice **devp);
 868
 869 /**
 870  * pci_get_ff() - Returns a mask for the given access size
 871  *
 872  * @size:       Access size
 873  * @return 0xff for PCI_SIZE_8, 0xffff for PCI_SIZE_16, 0xffffffff for
 874  * PCI_SIZE_32
 875  */
 876 int pci_get_ff(enum pci_size_t size);
 877
 878 /**
 879  * pci_bus_find_devices () - Find devices on a bus
 880  *
 881  * @bus:        Bus to search
 882  * @ids:        PCI vendor/device IDs to look for, terminated by 0, 0 record
 883  * @indexp:     Pointer to device index to find. To find the first matching
 884  *              device, pass 0; to find the second, pass 1, etc. This
 885  *              parameter is decremented for each non-matching device so
 886  *              can be called repeatedly.
 887  * @devp:       Returns matching device if found
 888  * @return 0 if found, -ENODEV if not
 889  */
 890 int pci_bus_find_devices(struct udevice *bus, struct pci_device_id *ids,
 891                          int *indexp, struct udevice **devp);
 892
 893 /**
 894  * pci_find_device_id() - Find a device on any bus
 895  *
 896  * @ids:        PCI vendor/device IDs to look for, terminated by 0, 0 record
 897  * @index:      Index number of device to find, 0 for the first match, 1 for
 898  *              the second, etc.
 899  * @devp:       Returns matching device if found
 900  * @return 0 if found, -ENODEV if not
 901  */
 902 int pci_find_device_id(struct pci_device_id *ids, int index,
 903                        struct udevice **devp);
 904
 905 /**
 906  * dm_pci_hose_probe_bus() - probe a subordinate bus, scanning it for devices
 907  *
 908  * This probes the given bus which causes it to be scanned for devices. The
 909  * devices will be bound but not probed.
 910  *
 911  * @hose specifies the PCI hose that will be used for the scan. This is
 912  * always a top-level bus with uclass UCLASS_PCI. The bus to scan is
 913  * in @bdf, and is a subordinate bus reachable from @hose.
 914  *
 915  * @hose:       PCI hose to scan
 916  * @bdf:        PCI bus address to scan (PCI_BUS(bdf) is the bus number)
 917  * @return 0 if OK, -ve on error
 918  */
 919 int dm_pci_hose_probe_bus(struct pci_controller *hose, pci_dev_t bdf);
 920
 921 /**
 922  * pci_bus_read_config() - Read a configuration value from a device
 923  *
 924  * TODO(sjg@chromium.org): We should be able to pass just a device and have
 925  * it do the right thing. It would be good to have that function also.
 926  *
 927  * @bus:        Bus to read from
 928  * @bdf:        PCI device address: bus, device and function -see PCI_BDF()
 929  * @valuep:     Place to put the returned value
 930  * @size:       Access size
 931  * @return 0 if OK, -ve on error
 932  */
 933 int pci_bus_read_config(struct udevice *bus, pci_dev_t bdf, int offset,
 934                         unsigned long *valuep, enum pci_size_t size);
 935
 936 /**
 937  * pci_bus_write_config() - Write a configuration value to a device
 938  *
 939  * @bus:        Bus to write from
 940  * @bdf:        PCI device address: bus, device and function -see PCI_BDF()
 941  * @value:      Value to write
 942  * @size:       Access size
 943  * @return 0 if OK, -ve on error
 944  */
 945 int pci_bus_write_config(struct udevice *bus, pci_dev_t bdf, int offset,
 946                          unsigned long value, enum pci_size_t size);
 947
 948 /*
 949  * The following functions provide access to the above without needing the
 950  * size parameter. We are trying to encourage the use of the 8/16/32-style
 951  * functions, rather than byte/word/dword. But both are supported.
 952  */
 953 int pci_write_config32(pci_dev_t pcidev, int offset, u32 value);
 954
 955 /* Compatibility with old naming */
 956 static inline int pci_write_config_dword(pci_dev_t pcidev, int offset,
 957                                          u32 value)
 958 {
 959         return pci_write_config32(pcidev, offset, value);
 960 }
 961
 962 int pci_write_config16(pci_dev_t pcidev, int offset, u16 value);
 963
 964 /* Compatibility with old naming */
 965 static inline int pci_write_config_word(pci_dev_t pcidev, int offset,
 966                                         u16 value)
 967 {
 968         return pci_write_config16(pcidev, offset, value);
 969 }
 970
 971 int pci_write_config8(pci_dev_t pcidev, int offset, u8 value);
 972
 973 /* Compatibility with old naming */
 974 static inline int pci_write_config_byte(pci_dev_t pcidev, int offset,
 975                                         u8 value)
 976 {
 977         return pci_write_config8(pcidev, offset, value);
 978 }
 979
 980 int pci_read_config32(pci_dev_t pcidev, int offset, u32 *valuep);
 981
 982 /* Compatibility with old naming */
 983 static inline int pci_read_config_dword(pci_dev_t pcidev, int offset,
 984                                         u32 *valuep)
 985 {
 986         return pci_read_config32(pcidev, offset, valuep);
 987 }
 988
 989 int pci_read_config16(pci_dev_t pcidev, int offset, u16 *valuep);
 990
 991 /* Compatibility with old naming */
 992 static inline int pci_read_config_word(pci_dev_t pcidev, int offset,
 993                                        u16 *valuep)
 994 {
 995         return pci_read_config16(pcidev, offset, valuep);
 996 }
 997
 998 int pci_read_config8(pci_dev_t pcidev, int offset, u8 *valuep);
 999
1000 /* Compatibility with old naming */
1001 static inline int pci_read_config_byte(pci_dev_t pcidev, int offset,
1002                                        u8 *valuep)
1003 {
1004         return pci_read_config8(pcidev, offset, valuep);
1005 }
1006
1007 /**
1008  * struct dm_pci_emul_ops - PCI device emulator operations
1009  */
1010 struct dm_pci_emul_ops {
1011         /**
1012          * get_devfn(): Check which device and function this emulators
1013          *
1014          * @dev:        device to check
1015          * @return the device and function this emulates, or -ve on error
1016          */
1017         int (*get_devfn)(struct udevice *dev);
1018         /**
1019          * read_config() - Read a PCI configuration value
1020          *
1021          * @dev:        Emulated device to read from
1022          * @offset:     Byte offset within the device's configuration space
1023          * @valuep:     Place to put the returned value
1024          * @size:       Access size
1025          * @return 0 if OK, -ve on error
1026          */
1027         int (*read_config)(struct udevice *dev, uint offset, ulong *valuep,
1028                            enum pci_size_t size);
1029         /**
1030          * write_config() - Write a PCI configuration value
1031          *
1032          * @dev:        Emulated device to write to
1033          * @offset:     Byte offset within the device's configuration space
1034          * @value:      Value to write
1035          * @size:       Access size
1036          * @return 0 if OK, -ve on error
1037          */
1038         int (*write_config)(struct udevice *dev, uint offset, ulong value,
1039                             enum pci_size_t size);
1040         /**
1041          * read_io() - Read a PCI I/O value
1042          *
1043          * @dev:        Emulated device to read from
1044          * @addr:       I/O address to read
1045          * @valuep:     Place to put the returned value
1046          * @size:       Access size
1047          * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1048          *              other -ve value on error
1049          */
1050         int (*read_io)(struct udevice *dev, unsigned int addr, ulong *valuep,
1051                        enum pci_size_t size);
1052         /**
1053          * write_io() - Write a PCI I/O value
1054          *
1055          * @dev:        Emulated device to write from
1056          * @addr:       I/O address to write
1057          * @value:      Value to write
1058          * @size:       Access size
1059          * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1060          *              other -ve value on error
1061          */
1062         int (*write_io)(struct udevice *dev, unsigned int addr,
1063                         ulong value, enum pci_size_t size);
1064         /**
1065          * map_physmem() - Map a device into sandbox memory
1066          *
1067          * @dev:        Emulated device to map
1068          * @addr:       Memory address, normally corresponding to a PCI BAR.
1069          *              The device should have been configured to have a BAR
1070          *              at this address.
1071          * @lenp:       On entry, the size of the area to map, On exit it is
1072          *              updated to the size actually mapped, which may be less
1073          *              if the device has less space
1074          * @ptrp:       Returns a pointer to the mapped address. The device's
1075          *              space can be accessed as @lenp bytes starting here
1076          * @return 0 if OK, -ENOENT if @addr is not mapped by this device,
1077          *              other -ve value on error
1078          */
1079         int (*map_physmem)(struct udevice *dev, phys_addr_t addr,
1080                            unsigned long *lenp, void **ptrp);
1081         /**
1082          * unmap_physmem() - undo a memory mapping
1083          *
1084          * This must be called after map_physmem() to undo the mapping.
1085          * Some devices can use this to check what has been written into
1086          * their mapped memory and perform an operations they require on it.
1087          * In this way, map/unmap can be used as a sort of handshake between
1088          * the emulated device and its users.
1089          *
1090          * @dev:        Emuated device to unmap
1091          * @vaddr:      Mapped memory address, as passed to map_physmem()
1092          * @len:        Size of area mapped, as returned by map_physmem()
1093          * @return 0 if OK, -ve on error
1094          */
1095         int (*unmap_physmem)(struct udevice *dev, const void *vaddr,
1096                              unsigned long len);
1097 };
1098
1099 /* Get access to a PCI device emulator's operations */
1100 #define pci_get_emul_ops(dev)   ((struct dm_pci_emul_ops *)(dev)->driver->ops)
1101
1102 /**
1103  * sandbox_pci_get_emul() - Get the emulation device for a PCI device
1104  *
1105  * Searches for a suitable emulator for the given PCI bus device
1106  *
1107  * @bus:        PCI bus to search
1108  * @find_devfn: PCI device and function address (PCI_DEVFN())
1109  * @emulp:      Returns emulated device if found
1110  * @return 0 if found, -ENODEV if not found
1111  */
1112 int sandbox_pci_get_emul(struct udevice *bus, pci_dev_t find_devfn,
1113                          struct udevice **emulp);
1114
1115 #endif /* CONFIG_DM_PCI */
1116
1117 /**
1118  * PCI_DEVICE - macro used to describe a specific pci device
1119  * @vend: the 16 bit PCI Vendor ID
1120  * @dev: the 16 bit PCI Device ID
1121  *
1122  * This macro is used to create a struct pci_device_id that matches a
1123  * specific device.  The subvendor and subdevice fields will be set to
1124  * PCI_ANY_ID.
1125  */
1126 #define PCI_DEVICE(vend, dev) \
1127         .vendor = (vend), .device = (dev), \
1128         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
1129
1130 /**
1131  * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
1132  * @vend: the 16 bit PCI Vendor ID
1133  * @dev: the 16 bit PCI Device ID
1134  * @subvend: the 16 bit PCI Subvendor ID
1135  * @subdev: the 16 bit PCI Subdevice ID
1136  *
1137  * This macro is used to create a struct pci_device_id that matches a
1138  * specific device with subsystem information.
1139  */
1140 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
1141         .vendor = (vend), .device = (dev), \
1142         .subvendor = (subvend), .subdevice = (subdev)
1143
1144 /**
1145  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
1146  * @dev_class: the class, subclass, prog-if triple for this device
1147  * @dev_class_mask: the class mask for this device
1148  *
1149  * This macro is used to create a struct pci_device_id that matches a
1150  * specific PCI class.  The vendor, device, subvendor, and subdevice
1151  * fields will be set to PCI_ANY_ID.
1152  */
1153 #define PCI_DEVICE_CLASS(dev_class, dev_class_mask) \
1154         .class = (dev_class), .class_mask = (dev_class_mask), \
1155         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
1156         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
1157
1158 /**
1159  * PCI_VDEVICE - macro used to describe a specific pci device in short form
1160  * @vend: the vendor name
1161  * @dev: the 16 bit PCI Device ID
1162  *
1163  * This macro is used to create a struct pci_device_id that matches a
1164  * specific PCI device.  The subvendor, and subdevice fields will be set
1165  * to PCI_ANY_ID. The macro allows the next field to follow as the device
1166  * private data.
1167  */
1168
1169 #define PCI_VDEVICE(vend, dev) \
1170         .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
1171         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
1172
1173 /**
1174  * struct pci_driver_entry - Matches a driver to its pci_device_id list
1175  * @driver: Driver to use
1176  * @match: List of match records for this driver, terminated by {}
1177  */
1178 struct pci_driver_entry {
1179         struct driver *driver;
1180         const struct pci_device_id *match;
1181 };
1182
1183 #define U_BOOT_PCI_DEVICE(__name, __match)                              \
1184         ll_entry_declare(struct pci_driver_entry, __name, pci_driver_entry) = {\
1185                 .driver = llsym(struct driver, __name, driver), \
1186                 .match = __match, \
1187                 }
1188
1189 #endif /* __ASSEMBLY__ */
1190 #endif /* _PCI_H */