src/include/pci.h

   1 #ifndef PCI_H
   2 #define PCI_H
   3
   4 /*
   5 ** Support for NE2000 PCI clones added David Monro June 1997
   6 ** Generalised for other PCI NICs by Ken Yap July 1997
   7 **
   8 ** Most of this is taken from:
   9 **
  10 ** /usr/src/linux/drivers/pci/pci.c
  11 ** /usr/src/linux/include/linux/pci.h
  12 ** /usr/src/linux/arch/i386/bios32.c
  13 ** /usr/src/linux/include/linux/bios32.h
  14 ** /usr/src/linux/drivers/net/ne.c
  15 */
  16
  17 /*
  18  * This program is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU General Public License as
  20  * published by the Free Software Foundation; either version 2, or (at
  21  * your option) any later version.
  22  */
  23
  24 #include "stdint.h"
  25 #include "nic.h"
  26 #include "pci_ids.h"
  27
  28 #define PCI_BUS_TYPE    1
  29
  30 /*
  31  * PCI constants
  32  *
  33  */
  34
  35 #define PCI_COMMAND_IO                  0x1     /* Enable response in I/O space */
  36 #define PCI_COMMAND_MEM                 0x2     /* Enable response in mem space */
  37 #define PCI_COMMAND_MASTER              0x4     /* Enable bus mastering */
  38 #define PCI_LATENCY_TIMER               0x0d    /* 8 bits */
  39 #define PCI_COMMAND_SPECIAL             0x8     /* Enable response to special cycles */
  40 #define PCI_COMMAND_INVALIDATE          0x10    /* Use memory write and invalidate */
  41 #define  PCI_COMMAND_VGA_PALETTE 0x20   /* Enable palette snooping */
  42 #define  PCI_COMMAND_PARITY     0x40    /* Enable parity checking */
  43 #define  PCI_COMMAND_WAIT       0x80    /* Enable address/data stepping */
  44 #define  PCI_COMMAND_SERR       0x100   /* Enable SERR */
  45 #define  PCI_COMMAND_FAST_BACK  0x200   /* Enable back-to-back writes */
  46
  47
  48 #define PCI_VENDOR_ID           0x00    /* 16 bits */
  49 #define PCI_DEVICE_ID           0x02    /* 16 bits */
  50 #define PCI_COMMAND             0x04    /* 16 bits */
  51
  52 #define PCI_STATUS              0x06    /* 16 bits */
  53 #define  PCI_STATUS_CAP_LIST    0x10    /* Support Capability List */
  54 #define  PCI_STATUS_66MHZ       0x20    /* Support 66 Mhz PCI 2.1 bus */
  55 #define  PCI_STATUS_UDF         0x40    /* Support User Definable Features [obsolete] */
  56 #define  PCI_STATUS_FAST_BACK   0x80    /* Accept fast-back to back */
  57 #define  PCI_STATUS_PARITY      0x100   /* Detected parity error */
  58 #define  PCI_STATUS_DEVSEL_MASK 0x600   /* DEVSEL timing */
  59 #define  PCI_STATUS_DEVSEL_FAST 0x000
  60 #define  PCI_STATUS_DEVSEL_MEDIUM 0x200
  61 #define  PCI_STATUS_DEVSEL_SLOW 0x400
  62 #define  PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
  63 #define  PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
  64 #define  PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
  65 #define  PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
  66 #define  PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
  67
  68 #define PCI_REVISION            0x08    /* 8 bits  */
  69 #define PCI_REVISION_ID         0x08    /* 8 bits  */
  70 #define PCI_CLASS_REVISION      0x08    /* 32 bits  */
  71 #define PCI_CLASS_CODE          0x0b    /* 8 bits */
  72 #define PCI_SUBCLASS_CODE       0x0a    /* 8 bits */
  73 #define PCI_HEADER_TYPE         0x0e    /* 8 bits */
  74 #define  PCI_HEADER_TYPE_NORMAL 0
  75 #define  PCI_HEADER_TYPE_BRIDGE 1
  76 #define  PCI_HEADER_TYPE_CARDBUS 2
  77
  78
  79 /* Header type 0 (normal devices) */
  80 #define PCI_CARDBUS_CIS         0x28
  81 #define PCI_SUBSYSTEM_VENDOR_ID 0x2c
  82 #define PCI_SUBSYSTEM_ID        0x2e
  83
  84 #define PCI_BASE_ADDRESS_0      0x10    /* 32 bits */
  85 #define PCI_BASE_ADDRESS_1      0x14    /* 32 bits */
  86 #define PCI_BASE_ADDRESS_2      0x18    /* 32 bits */
  87 #define PCI_BASE_ADDRESS_3      0x1c    /* 32 bits */
  88 #define PCI_BASE_ADDRESS_4      0x20    /* 32 bits */
  89 #define PCI_BASE_ADDRESS_5      0x24    /* 32 bits */
  90
  91 #define PCI_BASE_ADDRESS_MEM_TYPE_MASK 0x06
  92 #define PCI_BASE_ADDRESS_MEM_TYPE_32    0x00    /* 32 bit address */
  93 #define PCI_BASE_ADDRESS_MEM_TYPE_1M    0x02    /* Below 1M [obsolete] */
  94 #define PCI_BASE_ADDRESS_MEM_TYPE_64    0x04    /* 64 bit address */
  95
  96 #ifndef PCI_BASE_ADDRESS_IO_MASK
  97 #define PCI_BASE_ADDRESS_IO_MASK       (~0x03)
  98 #endif
  99 #ifndef PCI_BASE_ADDRESS_MEM_MASK
 100 #define PCI_BASE_ADDRESS_MEM_MASK       (~0x0f)
 101 #endif
 102 #define PCI_BASE_ADDRESS_SPACE_IO       0x01
 103 #define PCI_ROM_ADDRESS         0x30    /* 32 bits */
 104 #define PCI_ROM_ADDRESS_ENABLE  0x01    /* Write 1 to enable ROM,
 105                                            bits 31..11 are address,
 106                                            10..2 are reserved */
 107
 108 #define PCI_CAPABILITY_LIST     0x34    /* Offset of first capability list entry */
 109
 110 #define PCI_INTERRUPT_LINE      0x3c    /* IRQ number (0-15) */
 111 #define PCI_INTERRUPT_PIN       0x3d    /* IRQ pin on PCI bus (A-D) */
 112
 113 /* Header type 1 (PCI-to-PCI bridges) */
 114 #define PCI_PRIMARY_BUS         0x18    /* Primary bus number */
 115 #define PCI_SECONDARY_BUS       0x19    /* Secondary bus number */
 116 #define PCI_SUBORDINATE_BUS     0x1a    /* Highest bus number behind the bridge */
 117 #define PCI_SEC_LATENCY_TIMER   0x1b    /* Latency timer for secondary interface */
 118 #define PCI_IO_BASE             0x1c    /* I/O range behind the bridge */
 119 #define PCI_IO_LIMIT            0x1d
 120 #define  PCI_IO_RANGE_TYPE_MASK 0x0f    /* I/O bridging type */
 121 #define  PCI_IO_RANGE_TYPE_16   0x00
 122 #define  PCI_IO_RANGE_TYPE_32   0x01
 123 #define  PCI_IO_RANGE_MASK      ~0x0f
 124 #define PCI_SEC_STATUS          0x1e    /* Secondary status register, only bit 14 used */
 125 #define PCI_MEMORY_BASE         0x20    /* Memory range behind */
 126 #define PCI_MEMORY_LIMIT        0x22
 127 #define  PCI_MEMORY_RANGE_TYPE_MASK 0x0f
 128 #define  PCI_MEMORY_RANGE_MASK  ~0x0f
 129 #define PCI_PREF_MEMORY_BASE    0x24    /* Prefetchable memory range behind */
 130 #define PCI_PREF_MEMORY_LIMIT   0x26
 131 #define  PCI_PREF_RANGE_TYPE_MASK 0x0f
 132 #define  PCI_PREF_RANGE_TYPE_32 0x00
 133 #define  PCI_PREF_RANGE_TYPE_64 0x01
 134 #define  PCI_PREF_RANGE_MASK    ~0x0f
 135 #define PCI_PREF_BASE_UPPER32   0x28    /* Upper half of prefetchable memory range */
 136 #define PCI_PREF_LIMIT_UPPER32  0x2c
 137 #define PCI_IO_BASE_UPPER16     0x30    /* Upper half of I/O addresses */
 138 #define PCI_IO_LIMIT_UPPER16    0x32
 139 /* 0x34 same as for htype 0 */
 140 /* 0x35-0x3b is reserved */
 141 #define PCI_ROM_ADDRESS1        0x38    /* Same as PCI_ROM_ADDRESS, but for htype 1 */
 142 /* 0x3c-0x3d are same as for htype 0 */
 143 #define PCI_BRIDGE_CONTROL      0x3e
 144 #define  PCI_BRIDGE_CTL_PARITY  0x01    /* Enable parity detection on secondary interface */
 145 #define  PCI_BRIDGE_CTL_SERR    0x02    /* The same for SERR forwarding */
 146 #define  PCI_BRIDGE_CTL_NO_ISA  0x04    /* Disable bridging of ISA ports */
 147 #define  PCI_BRIDGE_CTL_VGA     0x08    /* Forward VGA addresses */
 148 #define  PCI_BRIDGE_CTL_MASTER_ABORT 0x20  /* Report master aborts */
 149 #define  PCI_BRIDGE_CTL_BUS_RESET 0x40  /* Secondary bus reset */
 150 #define  PCI_BRIDGE_CTL_FAST_BACK 0x80  /* Fast Back2Back enabled on secondary interface */
 151
 152 #define PCI_CB_CAPABILITY_LIST  0x14
 153
 154 /* Capability lists */
 155
 156 #define PCI_CAP_LIST_ID         0       /* Capability ID */
 157 #define  PCI_CAP_ID_PM          0x01    /* Power Management */
 158 #define  PCI_CAP_ID_AGP         0x02    /* Accelerated Graphics Port */
 159 #define  PCI_CAP_ID_VPD         0x03    /* Vital Product Data */
 160 #define  PCI_CAP_ID_SLOTID      0x04    /* Slot Identification */
 161 #define  PCI_CAP_ID_MSI         0x05    /* Message Signalled Interrupts */
 162 #define  PCI_CAP_ID_CHSWP       0x06    /* CompactPCI HotSwap */
 163 #define PCI_CAP_LIST_NEXT       1       /* Next capability in the list */
 164 #define PCI_CAP_FLAGS           2       /* Capability defined flags (16 bits) */
 165 #define PCI_CAP_SIZEOF          4
 166
 167 /* Power Management Registers */
 168
 169 #define PCI_PM_PMC              2       /* PM Capabilities Register */
 170 #define  PCI_PM_CAP_VER_MASK    0x0007  /* Version */
 171 #define  PCI_PM_CAP_PME_CLOCK   0x0008  /* PME clock required */
 172 #define  PCI_PM_CAP_RESERVED    0x0010  /* Reserved field */
 173 #define  PCI_PM_CAP_DSI         0x0020  /* Device specific initialization */
 174 #define  PCI_PM_CAP_AUX_POWER   0x01C0  /* Auxilliary power support mask */
 175 #define  PCI_PM_CAP_D1          0x0200  /* D1 power state support */
 176 #define  PCI_PM_CAP_D2          0x0400  /* D2 power state support */
 177 #define  PCI_PM_CAP_PME         0x0800  /* PME pin supported */
 178 #define  PCI_PM_CAP_PME_MASK    0xF800  /* PME Mask of all supported states */
 179 #define  PCI_PM_CAP_PME_D0      0x0800  /* PME# from D0 */
 180 #define  PCI_PM_CAP_PME_D1      0x1000  /* PME# from D1 */
 181 #define  PCI_PM_CAP_PME_D2      0x2000  /* PME# from D2 */
 182 #define  PCI_PM_CAP_PME_D3      0x4000  /* PME# from D3 (hot) */
 183 #define  PCI_PM_CAP_PME_D3cold  0x8000  /* PME# from D3 (cold) */
 184 #define PCI_PM_CTRL             4       /* PM control and status register */
 185 #define  PCI_PM_CTRL_STATE_MASK 0x0003  /* Current power state (D0 to D3) */
 186 #define  PCI_PM_CTRL_PME_ENABLE 0x0100  /* PME pin enable */
 187 #define  PCI_PM_CTRL_DATA_SEL_MASK      0x1e00  /* Data select (??) */
 188 #define  PCI_PM_CTRL_DATA_SCALE_MASK    0x6000  /* Data scale (??) */
 189 #define  PCI_PM_CTRL_PME_STATUS 0x8000  /* PME pin status */
 190 #define PCI_PM_PPB_EXTENSIONS   6       /* PPB support extensions (??) */
 191 #define  PCI_PM_PPB_B2_B3       0x40    /* Stop clock when in D3hot (??) */
 192 #define  PCI_PM_BPCC_ENABLE     0x80    /* Bus power/clock control enable (??) */
 193 #define PCI_PM_DATA_REGISTER    7       /* (??) */
 194 #define PCI_PM_SIZEOF           8
 195
 196 /* AGP registers */
 197
 198 #define PCI_AGP_VERSION         2       /* BCD version number */
 199 #define PCI_AGP_RFU             3       /* Rest of capability flags */
 200 #define PCI_AGP_STATUS          4       /* Status register */
 201 #define  PCI_AGP_STATUS_RQ_MASK 0xff000000      /* Maximum number of requests - 1 */
 202 #define  PCI_AGP_STATUS_SBA     0x0200  /* Sideband addressing supported */
 203 #define  PCI_AGP_STATUS_64BIT   0x0020  /* 64-bit addressing supported */
 204 #define  PCI_AGP_STATUS_FW      0x0010  /* FW transfers supported */
 205 #define  PCI_AGP_STATUS_RATE4   0x0004  /* 4x transfer rate supported */
 206 #define  PCI_AGP_STATUS_RATE2   0x0002  /* 2x transfer rate supported */
 207 #define  PCI_AGP_STATUS_RATE1   0x0001  /* 1x transfer rate supported */
 208 #define PCI_AGP_COMMAND         8       /* Control register */
 209 #define  PCI_AGP_COMMAND_RQ_MASK 0xff000000  /* Master: Maximum number of requests */
 210 #define  PCI_AGP_COMMAND_SBA    0x0200  /* Sideband addressing enabled */
 211 #define  PCI_AGP_COMMAND_AGP    0x0100  /* Allow processing of AGP transactions */
 212 #define  PCI_AGP_COMMAND_64BIT  0x0020  /* Allow processing of 64-bit addresses */
 213 #define  PCI_AGP_COMMAND_FW     0x0010  /* Force FW transfers */
 214 #define  PCI_AGP_COMMAND_RATE4  0x0004  /* Use 4x rate */
 215 #define  PCI_AGP_COMMAND_RATE2  0x0002  /* Use 2x rate */
 216 #define  PCI_AGP_COMMAND_RATE1  0x0001  /* Use 1x rate */
 217 #define PCI_AGP_SIZEOF          12
 218
 219 /* Slot Identification */
 220
 221 #define PCI_SID_ESR             2       /* Expansion Slot Register */
 222 #define  PCI_SID_ESR_NSLOTS     0x1f    /* Number of expansion slots available */
 223 #define  PCI_SID_ESR_FIC        0x20    /* First In Chassis Flag */
 224 #define PCI_SID_CHASSIS_NR      3       /* Chassis Number */
 225
 226 /* Message Signalled Interrupts registers */
 227
 228 #define PCI_MSI_FLAGS           2       /* Various flags */
 229 #define  PCI_MSI_FLAGS_64BIT    0x80    /* 64-bit addresses allowed */
 230 #define  PCI_MSI_FLAGS_QSIZE    0x70    /* Message queue size configured */
 231 #define  PCI_MSI_FLAGS_QMASK    0x0e    /* Maximum queue size available */
 232 #define  PCI_MSI_FLAGS_ENABLE   0x01    /* MSI feature enabled */
 233 #define PCI_MSI_RFU             3       /* Rest of capability flags */
 234 #define PCI_MSI_ADDRESS_LO      4       /* Lower 32 bits */
 235 #define PCI_MSI_ADDRESS_HI      8       /* Upper 32 bits (if PCI_MSI_FLAGS_64BIT set) */
 236 #define PCI_MSI_DATA_32         8       /* 16 bits of data for 32-bit devices */
 237 #define PCI_MSI_DATA_64         12      /* 16 bits of data for 64-bit devices */
 238 /*
 239  * A location on a PCI bus
 240  *
 241  */
 242 struct pci_loc {
 243         uint16_t                busdevfn;
 244 };
 245
 246 /*
 247  * A physical PCI device
 248  *
 249  */
 250 struct pci_device {
 251         const char *    name;
 252         uint32_t        membase;        /* BAR 1 */
 253         uint32_t        ioaddr;         /* first IO BAR */
 254         uint16_t        vendor_id, device_id;
 255         uint16_t        class;
 256         uint16_t        busdevfn;
 257         uint8_t         revision;
 258         uint8_t         irq;
 259 } __attribute__ (( packed ));
 260
 261 /*
 262  * Useful busdevfn calculations
 263  *
 264  */
 265 #define PCI_BUS(busdevfn)       ( ( uint8_t ) ( ( (busdevfn) >> 8 ) & 0xff ) )
 266 #define PCI_DEV(busdevfn)       ( ( uint8_t ) ( ( (busdevfn) >> 3 ) & 0x1f ) )
 267 #define PCI_FUNC(busdevfn)      ( ( uint8_t ) ( (busdevfn) & 0x07 ) )
 268 #define PCI_FN0(busdevfn)       ( ( uint16_t ) ( (busdevfn) & 0xfff8 ) )
 269 #define PCI_MAX_BUSDEVFN        0xffff
 270
 271 /*
 272  * An individual PCI device identified by vendor and device IDs
 273  *
 274  */
 275 struct pci_id {
 276         unsigned short vendor_id, device_id;
 277         const char *name;
 278 };
 279
 280 /*
 281  * PCI_ROM is used to build up entries in a struct pci_id array.  It
 282  * is also parsed by parserom.pl to generate Makefile rules and files
 283  * for rom-o-matic.
 284  */
 285 #define PCI_ROM( _vendor_id, _device_id, _name, _description ) {        \
 286         .vendor_id = _vendor_id,                                        \
 287         .device_id = _device_id,                                        \
 288         .name = _name,                                                  \
 289 }
 290
 291 /*
 292  * A PCI driver information table, with a device ID (struct pci_id)
 293  * table and an optional class.
 294  *
 295  * Set the class to something other than PCI_NO_CLASS if the driver
 296  * can handle an entire class of devices.
 297  *
 298  */
 299 struct pci_driver {
 300         struct pci_id *ids;
 301         unsigned int id_count;
 302         uint16_t class;
 303 };
 304 #define PCI_NO_CLASS 0
 305
 306 /*
 307  * Define a PCI driver.
 308  *
 309  */
 310 #define PCI_DRIVER( _ids, _class ) {                                    \
 311                 .ids = _ids,                                            \
 312                 .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),       \
 313                 .class = _class,                                        \
 314         }
 315
 316 /*
 317  * These are the functions we expect pci_io.c to provide.
 318  *
 319  */
 320 extern int pci_read_config_byte ( struct pci_device *pci, unsigned int where,
 321                                   uint8_t *value );
 322 extern int pci_write_config_byte ( struct pci_device *pci, unsigned int where,
 323                                    uint8_t value );
 324 extern int pci_read_config_word ( struct pci_device *pci, unsigned int where,
 325                                   uint16_t *value );
 326 extern int pci_write_config_word ( struct pci_device *pci, unsigned int where,
 327                                    uint16_t value );
 328 extern int pci_read_config_dword ( struct pci_device *pci, unsigned int where,
 329                                    uint32_t *value );
 330 extern int pci_write_config_dword ( struct pci_device *pci, unsigned int where,
 331                                     uint32_t value );
 332 extern unsigned long pci_bus_base ( struct pci_device *pci );
 333
 334 /*
 335  * pci_io.c is allowed to overwrite pci_max_bus if it knows what the
 336  * highest bus in the system will be.
 337  *
 338  */
 339 extern unsigned int pci_max_bus;
 340
 341 /*
 342  * Functions in pci.c
 343  *
 344  */
 345 extern void adjust_pci_device ( struct pci_device *pci );
 346 extern unsigned long pci_bar_start ( struct pci_device *pci,
 347                                      unsigned int bar );
 348 extern unsigned long pci_bar_size ( struct pci_device *pci, unsigned int bar );
 349 extern int pci_find_capability ( struct pci_device *pci, int capability );
 350 extern void pci_fill_nic ( struct nic *nic, struct pci_device *pci );
 351
 352 /*
 353  * PCI bus global definition
 354  *
 355  */
 356 extern struct bus_driver pci_driver;
 357
 358 #endif  /* PCI_H */