git.oblomov.eu Git - linux-2.6/blob - include/linux/pci.h

   1 /*
   2  *      pci.h
   3  *
   4  *      PCI defines and function prototypes
   5  *      Copyright 1994, Drew Eckhardt
   6  *      Copyright 1997--1999 Martin Mares <mj@ucw.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
  17 #ifndef LINUX_PCI_H
  18 #define LINUX_PCI_H
  19
  20 /* Include the pci register defines */
  21 #include <linux/pci_regs.h>
  22
  23 /*
  24  * The PCI interface treats multi-function devices as independent
  25  * devices.  The slot/function address of each device is encoded
  26  * in a single byte as follows:
  27  *
  28  *      7:3 = slot
  29  *      2:0 = function
  30  */
  31 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  32 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  33 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  34
  35 /* Ioctls for /proc/bus/pci/X/Y nodes. */
  36 #define PCIIOC_BASE             ('P' << 24 | 'C' << 16 | 'I' << 8)
  37 #define PCIIOC_CONTROLLER       (PCIIOC_BASE | 0x00)    /* Get controller for PCI device. */
  38 #define PCIIOC_MMAP_IS_IO       (PCIIOC_BASE | 0x01)    /* Set mmap state to I/O space. */
  39 #define PCIIOC_MMAP_IS_MEM      (PCIIOC_BASE | 0x02)    /* Set mmap state to MEM space. */
  40 #define PCIIOC_WRITE_COMBINE    (PCIIOC_BASE | 0x03)    /* Enable/disable write-combining. */
  41
  42 #ifdef __KERNEL__
  43
  44 #include <linux/mod_devicetable.h>
  45
  46 #include <linux/types.h>
  47 #include <linux/ioport.h>
  48 #include <linux/list.h>
  49 #include <linux/compiler.h>
  50 #include <linux/errno.h>
  51 #include <asm/atomic.h>
  52 #include <linux/device.h>
  53
  54 /* Include the ID list */
  55 #include <linux/pci_ids.h>
  56
  57 /* File state for mmap()s on /proc/bus/pci/X/Y */
  58 enum pci_mmap_state {
  59         pci_mmap_io,
  60         pci_mmap_mem
  61 };
  62
  63 /* This defines the direction arg to the DMA mapping routines. */
  64 #define PCI_DMA_BIDIRECTIONAL   0
  65 #define PCI_DMA_TODEVICE        1
  66 #define PCI_DMA_FROMDEVICE      2
  67 #define PCI_DMA_NONE            3
  68
  69 #define DEVICE_COUNT_RESOURCE   12
  70
  71 typedef int __bitwise pci_power_t;
  72
  73 #define PCI_D0          ((pci_power_t __force) 0)
  74 #define PCI_D1          ((pci_power_t __force) 1)
  75 #define PCI_D2          ((pci_power_t __force) 2)
  76 #define PCI_D3hot       ((pci_power_t __force) 3)
  77 #define PCI_D3cold      ((pci_power_t __force) 4)
  78 #define PCI_UNKNOWN     ((pci_power_t __force) 5)
  79 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
  80
  81 /** The pci_channel state describes connectivity between the CPU and
  82  *  the pci device.  If some PCI bus between here and the pci device
  83  *  has crashed or locked up, this info is reflected here.
  84  */
  85 typedef unsigned int __bitwise pci_channel_state_t;
  86
  87 enum pci_channel_state {
  88         /* I/O channel is in normal state */
  89         pci_channel_io_normal = (__force pci_channel_state_t) 1,
  90
  91         /* I/O to channel is blocked */
  92         pci_channel_io_frozen = (__force pci_channel_state_t) 2,
  93
  94         /* PCI card is dead */
  95         pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
  96 };
  97
  98 typedef unsigned int __bitwise pcie_reset_state_t;
  99
 100 enum pcie_reset_state {
 101         /* Reset is NOT asserted (Use to deassert reset) */
 102         pcie_deassert_reset = (__force pcie_reset_state_t) 1,
 103
 104         /* Use #PERST to reset PCI-E device */
 105         pcie_warm_reset = (__force pcie_reset_state_t) 2,
 106
 107         /* Use PCI-E Hot Reset to reset device */
 108         pcie_hot_reset = (__force pcie_reset_state_t) 3
 109 };
 110
 111 typedef unsigned short __bitwise pci_dev_flags_t;
 112 enum pci_dev_flags {
 113         /* INTX_DISABLE in PCI_COMMAND register disables MSI
 114          * generation too.
 115          */
 116         PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
 117 };
 118
 119 typedef unsigned short __bitwise pci_bus_flags_t;
 120 enum pci_bus_flags {
 121         PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
 122         PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
 123 };
 124
 125 struct pci_cap_saved_state {
 126         struct hlist_node next;
 127         char cap_nr;
 128         u32 data[0];
 129 };
 130
 131 struct pcie_link_state;
 132 struct pci_vpd;
 133
 134 /*
 135  * The pci_dev structure is used to describe PCI devices.
 136  */
 137 struct pci_dev {
 138         struct list_head bus_list;      /* node in per-bus list */
 139         struct pci_bus  *bus;           /* bus this device is on */
 140         struct pci_bus  *subordinate;   /* bus this device bridges to */
 141
 142         void            *sysdata;       /* hook for sys-specific extension */
 143         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
 144
 145         unsigned int    devfn;          /* encoded device & function index */
 146         unsigned short  vendor;
 147         unsigned short  device;
 148         unsigned short  subsystem_vendor;
 149         unsigned short  subsystem_device;
 150         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
 151         u8              revision;       /* PCI revision, low byte of class word */
 152         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
 153         u8              pcie_type;      /* PCI-E device/port type */
 154         u8              rom_base_reg;   /* which config register controls the ROM */
 155         u8              pin;            /* which interrupt pin this device uses */
 156
 157         struct pci_driver *driver;      /* which driver has allocated this device */
 158         u64             dma_mask;       /* Mask of the bits of bus address this
 159                                            device implements.  Normally this is
 160                                            0xffffffff.  You only need to change
 161                                            this if your device has broken DMA
 162                                            or supports 64-bit transfers.  */
 163
 164         struct device_dma_parameters dma_parms;
 165
 166         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
 167                                            this is D0-D3, D0 being fully functional,
 168                                            and D3 being off. */
 169
 170 #ifdef CONFIG_PCIEASPM
 171         struct pcie_link_state  *link_state;    /* ASPM link state. */
 172 #endif
 173
 174         pci_channel_state_t error_state;        /* current connectivity state */
 175         struct  device  dev;            /* Generic device interface */
 176
 177         int             cfg_size;       /* Size of configuration space */
 178
 179         /*
 180          * Instead of touching interrupt line and base address registers
 181          * directly, use the values stored here. They might be different!
 182          */
 183         unsigned int    irq;
 184         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
 185
 186         /* These fields are used by common fixups */
 187         unsigned int    transparent:1;  /* Transparent PCI bridge */
 188         unsigned int    multifunction:1;/* Part of multi-function device */
 189         /* keep track of device state */
 190         unsigned int    is_added:1;
 191         unsigned int    is_busmaster:1; /* device is busmaster */
 192         unsigned int    no_msi:1;       /* device may not use msi */
 193         unsigned int    no_d1d2:1;   /* only allow d0 or d3 */
 194         unsigned int    block_ucfg_access:1;    /* userspace config space access is blocked */
 195         unsigned int    broken_parity_status:1; /* Device generates false positive parity */
 196         unsigned int    msi_enabled:1;
 197         unsigned int    msix_enabled:1;
 198         unsigned int    is_managed:1;
 199         unsigned int    is_pcie:1;
 200         pci_dev_flags_t dev_flags;
 201         atomic_t        enable_cnt;     /* pci_enable_device has been called */
 202
 203         u32             saved_config_space[16]; /* config space saved at suspend time */
 204         struct hlist_head saved_cap_space;
 205         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
 206         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
 207         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
 208 #ifdef CONFIG_PCI_MSI
 209         struct list_head msi_list;
 210 #endif
 211         struct pci_vpd *vpd;
 212 };
 213
 214 extern struct pci_dev *alloc_pci_dev(void);
 215
 216 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
 217 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
 218 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
 219
 220 static inline int pci_channel_offline(struct pci_dev *pdev)
 221 {
 222         return (pdev->error_state != pci_channel_io_normal);
 223 }
 224
 225 static inline struct pci_cap_saved_state *pci_find_saved_cap(
 226         struct pci_dev *pci_dev, char cap)
 227 {
 228         struct pci_cap_saved_state *tmp;
 229         struct hlist_node *pos;
 230
 231         hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
 232                 if (tmp->cap_nr == cap)
 233                         return tmp;
 234         }
 235         return NULL;
 236 }
 237
 238 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
 239         struct pci_cap_saved_state *new_cap)
 240 {
 241         hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
 242 }
 243
 244 /*
 245  *  For PCI devices, the region numbers are assigned this way:
 246  *
 247  *      0-5     standard PCI regions
 248  *      6       expansion ROM
 249  *      7-10    bridges: address space assigned to buses behind the bridge
 250  */
 251
 252 #define PCI_ROM_RESOURCE        6
 253 #define PCI_BRIDGE_RESOURCES    7
 254 #define PCI_NUM_RESOURCES       11
 255
 256 #ifndef PCI_BUS_NUM_RESOURCES
 257 #define PCI_BUS_NUM_RESOURCES   16
 258 #endif
 259
 260 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
 261
 262 struct pci_bus {
 263         struct list_head node;          /* node in list of buses */
 264         struct pci_bus  *parent;        /* parent bus this bridge is on */
 265         struct list_head children;      /* list of child buses */
 266         struct list_head devices;       /* list of devices on this bus */
 267         struct pci_dev  *self;          /* bridge device as seen by parent */
 268         struct resource *resource[PCI_BUS_NUM_RESOURCES];
 269                                         /* address space routed to this bus */
 270
 271         struct pci_ops  *ops;           /* configuration access functions */
 272         void            *sysdata;       /* hook for sys-specific extension */
 273         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
 274
 275         unsigned char   number;         /* bus number */
 276         unsigned char   primary;        /* number of primary bridge */
 277         unsigned char   secondary;      /* number of secondary bridge */
 278         unsigned char   subordinate;    /* max number of subordinate buses */
 279
 280         char            name[48];
 281
 282         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
 283         pci_bus_flags_t bus_flags;      /* Inherited by child busses */
 284         struct device           *bridge;
 285         struct device           dev;
 286         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
 287         struct bin_attribute    *legacy_mem; /* legacy mem */
 288         unsigned int            is_added:1;
 289 };
 290
 291 #define pci_bus_b(n)    list_entry(n, struct pci_bus, node)
 292 #define to_pci_bus(n)   container_of(n, struct pci_bus, dev)
 293
 294 /*
 295  * Error values that may be returned by PCI functions.
 296  */
 297 #define PCIBIOS_SUCCESSFUL              0x00
 298 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
 299 #define PCIBIOS_BAD_VENDOR_ID           0x83
 300 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
 301 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
 302 #define PCIBIOS_SET_FAILED              0x88
 303 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
 304
 305 /* Low-level architecture-dependent routines */
 306
 307 struct pci_ops {
 308         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
 309         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
 310 };
 311
 312 /*
 313  * ACPI needs to be able to access PCI config space before we've done a
 314  * PCI bus scan and created pci_bus structures.
 315  */
 316 extern int raw_pci_read(unsigned int domain, unsigned int bus,
 317                         unsigned int devfn, int reg, int len, u32 *val);
 318 extern int raw_pci_write(unsigned int domain, unsigned int bus,
 319                         unsigned int devfn, int reg, int len, u32 val);
 320
 321 struct pci_bus_region {
 322         resource_size_t start;
 323         resource_size_t end;
 324 };
 325
 326 struct pci_dynids {
 327         spinlock_t lock;            /* protects list, index */
 328         struct list_head list;      /* for IDs added at runtime */
 329         unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
 330 };
 331
 332 /* ---------------------------------------------------------------- */
 333 /** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
 334  *  a set of callbacks in struct pci_error_handlers, then that device driver
 335  *  will be notified of PCI bus errors, and will be driven to recovery
 336  *  when an error occurs.
 337  */
 338
 339 typedef unsigned int __bitwise pci_ers_result_t;
 340
 341 enum pci_ers_result {
 342         /* no result/none/not supported in device driver */
 343         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
 344
 345         /* Device driver can recover without slot reset */
 346         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
 347
 348         /* Device driver wants slot to be reset. */
 349         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
 350
 351         /* Device has completely failed, is unrecoverable */
 352         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
 353
 354         /* Device driver is fully recovered and operational */
 355         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
 356 };
 357
 358 /* PCI bus error event callbacks */
 359 struct pci_error_handlers {
 360         /* PCI bus error detected on this device */
 361         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
 362                                            enum pci_channel_state error);
 363
 364         /* MMIO has been re-enabled, but not DMA */
 365         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
 366
 367         /* PCI Express link has been reset */
 368         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
 369
 370         /* PCI slot has been reset */
 371         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
 372
 373         /* Device driver may resume normal operations */
 374         void (*resume)(struct pci_dev *dev);
 375 };
 376
 377 /* ---------------------------------------------------------------- */
 378
 379 struct module;
 380 struct pci_driver {
 381         struct list_head node;
 382         char *name;
 383         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
 384         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
 385         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
 386         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
 387         int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
 388         int  (*resume_early) (struct pci_dev *dev);
 389         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
 390         void (*shutdown) (struct pci_dev *dev);
 391
 392         struct pci_error_handlers *err_handler;
 393         struct device_driver    driver;
 394         struct pci_dynids dynids;
 395 };
 396
 397 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
 398
 399 /**
 400  * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
 401  * @_table: device table name
 402  *
 403  * This macro is used to create a struct pci_device_id array (a device table)
 404  * in a generic manner.
 405  */
 406 #define DEFINE_PCI_DEVICE_TABLE(_table) \
 407         const struct pci_device_id _table[] __devinitconst
 408
 409 /**
 410  * PCI_DEVICE - macro used to describe a specific pci device
 411  * @vend: the 16 bit PCI Vendor ID
 412  * @dev: the 16 bit PCI Device ID
 413  *
 414  * This macro is used to create a struct pci_device_id that matches a
 415  * specific device.  The subvendor and subdevice fields will be set to
 416  * PCI_ANY_ID.
 417  */
 418 #define PCI_DEVICE(vend,dev) \
 419         .vendor = (vend), .device = (dev), \
 420         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 421
 422 /**
 423  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
 424  * @dev_class: the class, subclass, prog-if triple for this device
 425  * @dev_class_mask: the class mask for this device
 426  *
 427  * This macro is used to create a struct pci_device_id that matches a
 428  * specific PCI class.  The vendor, device, subvendor, and subdevice
 429  * fields will be set to PCI_ANY_ID.
 430  */
 431 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
 432         .class = (dev_class), .class_mask = (dev_class_mask), \
 433         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
 434         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 435
 436 /**
 437  * PCI_VDEVICE - macro used to describe a specific pci device in short form
 438  * @vend: the vendor name
 439  * @dev: the 16 bit PCI Device ID
 440  *
 441  * This macro is used to create a struct pci_device_id that matches a
 442  * specific PCI device.  The subvendor, and subdevice fields will be set
 443  * to PCI_ANY_ID. The macro allows the next field to follow as the device
 444  * private data.
 445  */
 446
 447 #define PCI_VDEVICE(vendor, device)             \
 448         PCI_VENDOR_ID_##vendor, (device),       \
 449         PCI_ANY_ID, PCI_ANY_ID, 0, 0
 450
 451 /* these external functions are only available when PCI support is enabled */
 452 #ifdef CONFIG_PCI
 453
 454 extern struct bus_type pci_bus_type;
 455
 456 /* Do NOT directly access these two variables, unless you are arch specific pci
 457  * code, or pci core code. */
 458 extern struct list_head pci_root_buses; /* list of all known PCI buses */
 459 /* Some device drivers need know if pci is initiated */
 460 extern int no_pci_devices(void);
 461
 462 void pcibios_fixup_bus(struct pci_bus *);
 463 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
 464 char *pcibios_setup(char *str);
 465
 466 /* Used only when drivers/pci/setup.c is used */
 467 void pcibios_align_resource(void *, struct resource *, resource_size_t,
 468                                 resource_size_t);
 469 void pcibios_update_irq(struct pci_dev *, int irq);
 470
 471 /* Generic PCI functions used internally */
 472
 473 extern struct pci_bus *pci_find_bus(int domain, int busnr);
 474 void pci_bus_add_devices(struct pci_bus *bus);
 475 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
 476                                       struct pci_ops *ops, void *sysdata);
 477 static inline struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops,
 478                                            void *sysdata)
 479 {
 480         struct pci_bus *root_bus;
 481         root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
 482         if (root_bus)
 483                 pci_bus_add_devices(root_bus);
 484         return root_bus;
 485 }
 486 struct pci_bus *pci_create_bus(struct device *parent, int bus,
 487                                struct pci_ops *ops, void *sysdata);
 488 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
 489                                 int busnr);
 490 int pci_scan_slot(struct pci_bus *bus, int devfn);
 491 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
 492 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
 493 unsigned int pci_scan_child_bus(struct pci_bus *bus);
 494 int __must_check pci_bus_add_device(struct pci_dev *dev);
 495 void pci_read_bridge_bases(struct pci_bus *child);
 496 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
 497                                           struct resource *res);
 498 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
 499 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
 500 extern void pci_dev_put(struct pci_dev *dev);
 501 extern void pci_remove_bus(struct pci_bus *b);
 502 extern void pci_remove_bus_device(struct pci_dev *dev);
 503 extern void pci_stop_bus_device(struct pci_dev *dev);
 504 void pci_setup_cardbus(struct pci_bus *bus);
 505 extern void pci_sort_breadthfirst(void);
 506
 507 /* Generic PCI functions exported to card drivers */
 508
 509 #ifdef CONFIG_PCI_LEGACY
 510 struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
 511                                              unsigned int device,
 512                                              const struct pci_dev *from);
 513 struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
 514                                            unsigned int devfn);
 515 #endif /* CONFIG_PCI_LEGACY */
 516
 517 int pci_find_capability(struct pci_dev *dev, int cap);
 518 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
 519 int pci_find_ext_capability(struct pci_dev *dev, int cap);
 520 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
 521 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
 522 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
 523
 524 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
 525                                 struct pci_dev *from);
 526 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
 527                                 unsigned int ss_vendor, unsigned int ss_device,
 528                                 const struct pci_dev *from);
 529 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
 530 struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
 531 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
 532 int pci_dev_present(const struct pci_device_id *ids);
 533
 534 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
 535                              int where, u8 *val);
 536 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
 537                              int where, u16 *val);
 538 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
 539                               int where, u32 *val);
 540 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
 541                               int where, u8 val);
 542 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
 543                               int where, u16 val);
 544 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
 545                                int where, u32 val);
 546
 547 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
 548 {
 549         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
 550 }
 551 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
 552 {
 553         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
 554 }
 555 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
 556                                         u32 *val)
 557 {
 558         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
 559 }
 560 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
 561 {
 562         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
 563 }
 564 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
 565 {
 566         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
 567 }
 568 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
 569                                          u32 val)
 570 {
 571         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
 572 }
 573
 574 int __must_check pci_enable_device(struct pci_dev *dev);
 575 int __must_check pci_enable_device_io(struct pci_dev *dev);
 576 int __must_check pci_enable_device_mem(struct pci_dev *dev);
 577 int __must_check pci_reenable_device(struct pci_dev *);
 578 int __must_check pcim_enable_device(struct pci_dev *pdev);
 579 void pcim_pin_device(struct pci_dev *pdev);
 580
 581 static inline int pci_is_managed(struct pci_dev *pdev)
 582 {
 583         return pdev->is_managed;
 584 }
 585
 586 void pci_disable_device(struct pci_dev *dev);
 587 void pci_set_master(struct pci_dev *dev);
 588 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
 589 #define HAVE_PCI_SET_MWI
 590 int __must_check pci_set_mwi(struct pci_dev *dev);
 591 int pci_try_set_mwi(struct pci_dev *dev);
 592 void pci_clear_mwi(struct pci_dev *dev);
 593 void pci_intx(struct pci_dev *dev, int enable);
 594 void pci_msi_off(struct pci_dev *dev);
 595 int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
 596 int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
 597 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
 598 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
 599 int pcix_get_max_mmrbc(struct pci_dev *dev);
 600 int pcix_get_mmrbc(struct pci_dev *dev);
 601 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
 602 int pcie_get_readrq(struct pci_dev *dev);
 603 int pcie_set_readrq(struct pci_dev *dev, int rq);
 604 void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
 605 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
 606 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
 607
 608 /* ROM control related routines */
 609 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
 610 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
 611 size_t pci_get_rom_size(void __iomem *rom, size_t size);
 612
 613 /* Power management related routines */
 614 int pci_save_state(struct pci_dev *dev);
 615 int pci_restore_state(struct pci_dev *dev);
 616 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
 617 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
 618 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
 619
 620 /* Functions for PCI Hotplug drivers to use */
 621 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
 622
 623 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
 624 void pci_bus_assign_resources(struct pci_bus *bus);
 625 void pci_bus_size_bridges(struct pci_bus *bus);
 626 int pci_claim_resource(struct pci_dev *, int);
 627 void pci_assign_unassigned_resources(void);
 628 void pdev_enable_device(struct pci_dev *);
 629 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
 630 int pci_enable_resources(struct pci_dev *, int mask);
 631 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
 632                     int (*)(struct pci_dev *, u8, u8));
 633 #define HAVE_PCI_REQ_REGIONS    2
 634 int __must_check pci_request_regions(struct pci_dev *, const char *);
 635 void pci_release_regions(struct pci_dev *);
 636 int __must_check pci_request_region(struct pci_dev *, int, const char *);
 637 void pci_release_region(struct pci_dev *, int);
 638 int pci_request_selected_regions(struct pci_dev *, int, const char *);
 639 void pci_release_selected_regions(struct pci_dev *, int);
 640
 641 /* drivers/pci/bus.c */
 642 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
 643                         struct resource *res, resource_size_t size,
 644                         resource_size_t align, resource_size_t min,
 645                         unsigned int type_mask,
 646                         void (*alignf)(void *, struct resource *,
 647                                 resource_size_t, resource_size_t),
 648                         void *alignf_data);
 649 void pci_enable_bridges(struct pci_bus *bus);
 650
 651 /* Proper probing supporting hot-pluggable devices */
 652 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
 653                                        const char *mod_name);
 654 static inline int __must_check pci_register_driver(struct pci_driver *driver)
 655 {
 656         return __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
 657 }
 658
 659 void pci_unregister_driver(struct pci_driver *dev);
 660 void pci_remove_behind_bridge(struct pci_dev *dev);
 661 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
 662 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
 663                                          struct pci_dev *dev);
 664 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
 665                     int pass);
 666
 667 void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
 668                   void *userdata);
 669 int pci_cfg_space_size_ext(struct pci_dev *dev, unsigned check_exp_pcix);
 670 int pci_cfg_space_size(struct pci_dev *dev);
 671 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
 672
 673 /* kmem_cache style wrapper around pci_alloc_consistent() */
 674
 675 #include <linux/dmapool.h>
 676
 677 #define pci_pool dma_pool
 678 #define pci_pool_create(name, pdev, size, align, allocation) \
 679                 dma_pool_create(name, &pdev->dev, size, align, allocation)
 680 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
 681 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
 682 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
 683
 684 enum pci_dma_burst_strategy {
 685         PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
 686                                    strategy_parameter is N/A */
 687         PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
 688                                    byte boundaries */
 689         PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
 690                                    strategy_parameter byte boundaries */
 691 };
 692
 693 struct msix_entry {
 694         u16     vector; /* kernel uses to write allocated vector */
 695         u16     entry;  /* driver uses to specify entry, OS writes */
 696 };
 697
 698
 699 #ifndef CONFIG_PCI_MSI
 700 static inline int pci_enable_msi(struct pci_dev *dev)
 701 {
 702         return -1;
 703 }
 704
 705 static inline void pci_msi_shutdown(struct pci_dev *dev)
 706 { }
 707 static inline void pci_disable_msi(struct pci_dev *dev)
 708 { }
 709
 710 static inline int pci_enable_msix(struct pci_dev *dev,
 711                                   struct msix_entry *entries, int nvec)
 712 {
 713         return -1;
 714 }
 715
 716 static inline void pci_msix_shutdown(struct pci_dev *dev)
 717 { }
 718 static inline void pci_disable_msix(struct pci_dev *dev)
 719 { }
 720
 721 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
 722 { }
 723
 724 static inline void pci_restore_msi_state(struct pci_dev *dev)
 725 { }
 726 #else
 727 extern int pci_enable_msi(struct pci_dev *dev);
 728 extern void pci_msi_shutdown(struct pci_dev *dev);
 729 extern void pci_disable_msi(struct pci_dev *dev);
 730 extern int pci_enable_msix(struct pci_dev *dev,
 731         struct msix_entry *entries, int nvec);
 732 extern void pci_msix_shutdown(struct pci_dev *dev);
 733 extern void pci_disable_msix(struct pci_dev *dev);
 734 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
 735 extern void pci_restore_msi_state(struct pci_dev *dev);
 736 #endif
 737
 738 #ifdef CONFIG_HT_IRQ
 739 /* The functions a driver should call */
 740 int  ht_create_irq(struct pci_dev *dev, int idx);
 741 void ht_destroy_irq(unsigned int irq);
 742 #endif /* CONFIG_HT_IRQ */
 743
 744 extern void pci_block_user_cfg_access(struct pci_dev *dev);
 745 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
 746
 747 /*
 748  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
 749  * a PCI domain is defined to be a set of PCI busses which share
 750  * configuration space.
 751  */
 752 #ifdef CONFIG_PCI_DOMAINS
 753 extern int pci_domains_supported;
 754 #else
 755 enum { pci_domains_supported = 0 };
 756 static inline int pci_domain_nr(struct pci_bus *bus)
 757 {
 758         return 0;
 759 }
 760
 761 static inline int pci_proc_domain(struct pci_bus *bus)
 762 {
 763         return 0;
 764 }
 765 #endif /* CONFIG_PCI_DOMAINS */
 766
 767 #else /* CONFIG_PCI is not enabled */
 768
 769 /*
 770  *  If the system does not have PCI, clearly these return errors.  Define
 771  *  these as simple inline functions to avoid hair in drivers.
 772  */
 773
 774 #define _PCI_NOP(o, s, t) \
 775         static inline int pci_##o##_config_##s(struct pci_dev *dev, \
 776                                                 int where, t val) \
 777                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
 778
 779 #define _PCI_NOP_ALL(o, x)      _PCI_NOP(o, byte, u8 x) \
 780                                 _PCI_NOP(o, word, u16 x) \
 781                                 _PCI_NOP(o, dword, u32 x)
 782 _PCI_NOP_ALL(read, *)
 783 _PCI_NOP_ALL(write,)
 784
 785 static inline struct pci_dev *pci_find_device(unsigned int vendor,
 786                                               unsigned int device,
 787                                               const struct pci_dev *from)
 788 {
 789         return NULL;
 790 }
 791
 792 static inline struct pci_dev *pci_find_slot(unsigned int bus,
 793                                             unsigned int devfn)
 794 {
 795         return NULL;
 796 }
 797
 798 static inline struct pci_dev *pci_get_device(unsigned int vendor,
 799                                              unsigned int device,
 800                                              struct pci_dev *from)
 801 {
 802         return NULL;
 803 }
 804
 805 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
 806                                              unsigned int device,
 807                                              unsigned int ss_vendor,
 808                                              unsigned int ss_device,
 809                                              const struct pci_dev *from)
 810 {
 811         return NULL;
 812 }
 813
 814 static inline struct pci_dev *pci_get_class(unsigned int class,
 815                                             struct pci_dev *from)
 816 {
 817         return NULL;
 818 }
 819
 820 #define pci_dev_present(ids)    (0)
 821 #define no_pci_devices()        (1)
 822 #define pci_dev_put(dev)        do { } while (0)
 823
 824 static inline void pci_set_master(struct pci_dev *dev)
 825 { }
 826
 827 static inline int pci_enable_device(struct pci_dev *dev)
 828 {
 829         return -EIO;
 830 }
 831
 832 static inline void pci_disable_device(struct pci_dev *dev)
 833 { }
 834
 835 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
 836 {
 837         return -EIO;
 838 }
 839
 840 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
 841                                         unsigned int size)
 842 {
 843         return -EIO;
 844 }
 845
 846 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
 847                                         unsigned long mask)
 848 {
 849         return -EIO;
 850 }
 851
 852 static inline int pci_assign_resource(struct pci_dev *dev, int i)
 853 {
 854         return -EBUSY;
 855 }
 856
 857 static inline int __pci_register_driver(struct pci_driver *drv,
 858                                         struct module *owner)
 859 {
 860         return 0;
 861 }
 862
 863 static inline int pci_register_driver(struct pci_driver *drv)
 864 {
 865         return 0;
 866 }
 867
 868 static inline void pci_unregister_driver(struct pci_driver *drv)
 869 { }
 870
 871 static inline int pci_find_capability(struct pci_dev *dev, int cap)
 872 {
 873         return 0;
 874 }
 875
 876 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
 877                                            int cap)
 878 {
 879         return 0;
 880 }
 881
 882 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
 883 {
 884         return 0;
 885 }
 886
 887 /* Power management related routines */
 888 static inline int pci_save_state(struct pci_dev *dev)
 889 {
 890         return 0;
 891 }
 892
 893 static inline int pci_restore_state(struct pci_dev *dev)
 894 {
 895         return 0;
 896 }
 897
 898 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
 899 {
 900         return 0;
 901 }
 902
 903 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
 904                                            pm_message_t state)
 905 {
 906         return PCI_D0;
 907 }
 908
 909 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
 910                                   int enable)
 911 {
 912         return 0;
 913 }
 914
 915 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
 916 {
 917         return -EIO;
 918 }
 919
 920 static inline void pci_release_regions(struct pci_dev *dev)
 921 { }
 922
 923 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
 924
 925 static inline void pci_block_user_cfg_access(struct pci_dev *dev)
 926 { }
 927
 928 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
 929 { }
 930
 931 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
 932 { return NULL; }
 933
 934 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
 935                                                 unsigned int devfn)
 936 { return NULL; }
 937
 938 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
 939                                                 unsigned int devfn)
 940 { return NULL; }
 941
 942 #endif /* CONFIG_PCI */
 943
 944 /* Include architecture-dependent settings and functions */
 945
 946 #include <asm/pci.h>
 947
 948 /* these helpers provide future and backwards compatibility
 949  * for accessing popular PCI BAR info */
 950 #define pci_resource_start(dev, bar)    ((dev)->resource[(bar)].start)
 951 #define pci_resource_end(dev, bar)      ((dev)->resource[(bar)].end)
 952 #define pci_resource_flags(dev, bar)    ((dev)->resource[(bar)].flags)
 953 #define pci_resource_len(dev,bar) \
 954         ((pci_resource_start((dev), (bar)) == 0 &&      \
 955           pci_resource_end((dev), (bar)) ==             \
 956           pci_resource_start((dev), (bar))) ? 0 :       \
 957                                                         \
 958          (pci_resource_end((dev), (bar)) -              \
 959           pci_resource_start((dev), (bar)) + 1))
 960
 961 /* Similar to the helpers above, these manipulate per-pci_dev
 962  * driver-specific data.  They are really just a wrapper around
 963  * the generic device structure functions of these calls.
 964  */
 965 static inline void *pci_get_drvdata(struct pci_dev *pdev)
 966 {
 967         return dev_get_drvdata(&pdev->dev);
 968 }
 969
 970 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
 971 {
 972         dev_set_drvdata(&pdev->dev, data);
 973 }
 974
 975 /* If you want to know what to call your pci_dev, ask this function.
 976  * Again, it's a wrapper around the generic device.
 977  */
 978 static inline char *pci_name(struct pci_dev *pdev)
 979 {
 980         return pdev->dev.bus_id;
 981 }
 982
 983
 984 /* Some archs don't want to expose struct resource to userland as-is
 985  * in sysfs and /proc
 986  */
 987 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
 988 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
 989                 const struct resource *rsrc, resource_size_t *start,
 990                 resource_size_t *end)
 991 {
 992         *start = rsrc->start;
 993         *end = rsrc->end;
 994 }
 995 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
 996
 997
 998 /*
 999  *  The world is not perfect and supplies us with broken PCI devices.
1000  *  For at least a part of these bugs we need a work-around, so both
1001  *  generic (drivers/pci/quirks.c) and per-architecture code can define
1002  *  fixup hooks to be called for particular buggy devices.
1003  */
1004
1005 struct pci_fixup {
1006         u16 vendor, device;     /* You can use PCI_ANY_ID here of course */
1007         void (*hook)(struct pci_dev *dev);
1008 };
1009
1010 enum pci_fixup_pass {
1011         pci_fixup_early,        /* Before probing BARs */
1012         pci_fixup_header,       /* After reading configuration header */
1013         pci_fixup_final,        /* Final phase of device fixups */
1014         pci_fixup_enable,       /* pci_enable_device() time */
1015         pci_fixup_resume,       /* pci_enable_device() time */
1016 };
1017
1018 /* Anonymous variables would be nice... */
1019 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook)  \
1020         static const struct pci_fixup __pci_fixup_##name __used         \
1021         __attribute__((__section__(#section))) = { vendor, device, hook };
1022 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
1023         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1024                         vendor##device##hook, vendor, device, hook)
1025 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
1026         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1027                         vendor##device##hook, vendor, device, hook)
1028 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
1029         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1030                         vendor##device##hook, vendor, device, hook)
1031 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
1032         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1033                         vendor##device##hook, vendor, device, hook)
1034 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)                  \
1035         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1036                         resume##vendor##device##hook, vendor, device, hook)
1037
1038
1039 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1040
1041 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1042 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1043 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1044 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1045 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1046                                    const char *name);
1047 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1048
1049 extern int pci_pci_problems;
1050 #define PCIPCI_FAIL             1       /* No PCI PCI DMA */
1051 #define PCIPCI_TRITON           2
1052 #define PCIPCI_NATOMA           4
1053 #define PCIPCI_VIAETBF          8
1054 #define PCIPCI_VSFX             16
1055 #define PCIPCI_ALIMAGIK         32      /* Need low latency setting */
1056 #define PCIAGP_FAIL             64      /* No PCI to AGP DMA */
1057
1058 extern unsigned long pci_cardbus_io_size;
1059 extern unsigned long pci_cardbus_mem_size;
1060
1061 extern int pcibios_add_platform_entries(struct pci_dev *dev);
1062
1063 #ifdef CONFIG_PCI_MMCONFIG
1064 extern void __init pci_mmcfg_early_init(void);
1065 extern void __init pci_mmcfg_late_init(void);
1066 #else
1067 static inline void pci_mmcfg_early_init(void) { }
1068 static inline void pci_mmcfg_late_init(void) { }
1069 #endif
1070
1071 #endif /* __KERNEL__ */
1072 #endif /* LINUX_PCI_H */