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 <linux/mod_devicetable.h>
  21
  22 /* Include the pci register defines */
  23 #include <linux/pci_regs.h>
  24
  25 /* Include the ID list */
  26 #include <linux/pci_ids.h>
  27
  28 /*
  29  * The PCI interface treats multi-function devices as independent
  30  * devices.  The slot/function address of each device is encoded
  31  * in a single byte as follows:
  32  *
  33  *      7:3 = slot
  34  *      2:0 = function
  35  */
  36 #define PCI_DEVFN(slot,func)    ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  37 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  38 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  39
  40 /* Ioctls for /proc/bus/pci/X/Y nodes. */
  41 #define PCIIOC_BASE             ('P' << 24 | 'C' << 16 | 'I' << 8)
  42 #define PCIIOC_CONTROLLER       (PCIIOC_BASE | 0x00)    /* Get controller for PCI device. */
  43 #define PCIIOC_MMAP_IS_IO       (PCIIOC_BASE | 0x01)    /* Set mmap state to I/O space. */
  44 #define PCIIOC_MMAP_IS_MEM      (PCIIOC_BASE | 0x02)    /* Set mmap state to MEM space. */
  45 #define PCIIOC_WRITE_COMBINE    (PCIIOC_BASE | 0x03)    /* Enable/disable write-combining. */
  46
  47 #ifdef __KERNEL__
  48
  49 #include <linux/types.h>
  50 #include <linux/config.h>
  51 #include <linux/ioport.h>
  52 #include <linux/list.h>
  53 #include <linux/errno.h>
  54 #include <linux/device.h>
  55
  56 /* File state for mmap()s on /proc/bus/pci/X/Y */
  57 enum pci_mmap_state {
  58         pci_mmap_io,
  59         pci_mmap_mem
  60 };
  61
  62 /* This defines the direction arg to the DMA mapping routines. */
  63 #define PCI_DMA_BIDIRECTIONAL   0
  64 #define PCI_DMA_TODEVICE        1
  65 #define PCI_DMA_FROMDEVICE      2
  66 #define PCI_DMA_NONE            3
  67
  68 #define DEVICE_COUNT_COMPATIBLE 4
  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 short __bitwise pci_bus_flags_t;
  99 enum pci_bus_flags {
 100         PCI_BUS_FLAGS_NO_MSI = (pci_bus_flags_t) 1,
 101 };
 102
 103 /*
 104  * The pci_dev structure is used to describe PCI devices.
 105  */
 106 struct pci_dev {
 107         struct list_head global_list;   /* node in list of all PCI devices */
 108         struct list_head bus_list;      /* node in per-bus list */
 109         struct pci_bus  *bus;           /* bus this device is on */
 110         struct pci_bus  *subordinate;   /* bus this device bridges to */
 111
 112         void            *sysdata;       /* hook for sys-specific extension */
 113         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
 114
 115         unsigned int    devfn;          /* encoded device & function index */
 116         unsigned short  vendor;
 117         unsigned short  device;
 118         unsigned short  subsystem_vendor;
 119         unsigned short  subsystem_device;
 120         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
 121         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
 122         u8              rom_base_reg;   /* which config register controls the ROM */
 123         u8              pin;            /* which interrupt pin this device uses */
 124
 125         struct pci_driver *driver;      /* which driver has allocated this device */
 126         u64             dma_mask;       /* Mask of the bits of bus address this
 127                                            device implements.  Normally this is
 128                                            0xffffffff.  You only need to change
 129                                            this if your device has broken DMA
 130                                            or supports 64-bit transfers.  */
 131
 132         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
 133                                            this is D0-D3, D0 being fully functional,
 134                                            and D3 being off. */
 135
 136         pci_channel_state_t error_state;        /* current connectivity state */
 137         struct  device  dev;            /* Generic device interface */
 138
 139         /* device is compatible with these IDs */
 140         unsigned short vendor_compatible[DEVICE_COUNT_COMPATIBLE];
 141         unsigned short device_compatible[DEVICE_COUNT_COMPATIBLE];
 142
 143         int             cfg_size;       /* Size of configuration space */
 144
 145         /*
 146          * Instead of touching interrupt line and base address registers
 147          * directly, use the values stored here. They might be different!
 148          */
 149         unsigned int    irq;
 150         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
 151
 152         /* These fields are used by common fixups */
 153         unsigned int    transparent:1;  /* Transparent PCI bridge */
 154         unsigned int    multifunction:1;/* Part of multi-function device */
 155         /* keep track of device state */
 156         unsigned int    is_enabled:1;   /* pci_enable_device has been called */
 157         unsigned int    is_busmaster:1; /* device is busmaster */
 158         unsigned int    no_msi:1;       /* device may not use msi */
 159         unsigned int    block_ucfg_access:1;    /* userspace config space access is blocked */
 160
 161         u32             saved_config_space[16]; /* config space saved at suspend time */
 162         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
 163         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
 164         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
 165 };
 166
 167 #define pci_dev_g(n) list_entry(n, struct pci_dev, global_list)
 168 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
 169 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
 170 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
 171
 172 /*
 173  *  For PCI devices, the region numbers are assigned this way:
 174  *
 175  *      0-5     standard PCI regions
 176  *      6       expansion ROM
 177  *      7-10    bridges: address space assigned to buses behind the bridge
 178  */
 179
 180 #define PCI_ROM_RESOURCE        6
 181 #define PCI_BRIDGE_RESOURCES    7
 182 #define PCI_NUM_RESOURCES       11
 183
 184 #ifndef PCI_BUS_NUM_RESOURCES
 185 #define PCI_BUS_NUM_RESOURCES   8
 186 #endif
 187
 188 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
 189
 190 struct pci_bus {
 191         struct list_head node;          /* node in list of buses */
 192         struct pci_bus  *parent;        /* parent bus this bridge is on */
 193         struct list_head children;      /* list of child buses */
 194         struct list_head devices;       /* list of devices on this bus */
 195         struct pci_dev  *self;          /* bridge device as seen by parent */
 196         struct resource *resource[PCI_BUS_NUM_RESOURCES];
 197                                         /* address space routed to this bus */
 198
 199         struct pci_ops  *ops;           /* configuration access functions */
 200         void            *sysdata;       /* hook for sys-specific extension */
 201         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
 202
 203         unsigned char   number;         /* bus number */
 204         unsigned char   primary;        /* number of primary bridge */
 205         unsigned char   secondary;      /* number of secondary bridge */
 206         unsigned char   subordinate;    /* max number of subordinate buses */
 207
 208         char            name[48];
 209
 210         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
 211         pci_bus_flags_t bus_flags;      /* Inherited by child busses */
 212         struct device           *bridge;
 213         struct class_device     class_dev;
 214         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
 215         struct bin_attribute    *legacy_mem; /* legacy mem */
 216 };
 217
 218 #define pci_bus_b(n)    list_entry(n, struct pci_bus, node)
 219 #define to_pci_bus(n)   container_of(n, struct pci_bus, class_dev)
 220
 221 /*
 222  * Error values that may be returned by PCI functions.
 223  */
 224 #define PCIBIOS_SUCCESSFUL              0x00
 225 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
 226 #define PCIBIOS_BAD_VENDOR_ID           0x83
 227 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
 228 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
 229 #define PCIBIOS_SET_FAILED              0x88
 230 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
 231
 232 /* Low-level architecture-dependent routines */
 233
 234 struct pci_ops {
 235         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
 236         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
 237 };
 238
 239 struct pci_raw_ops {
 240         int (*read)(unsigned int domain, unsigned int bus, unsigned int devfn,
 241                     int reg, int len, u32 *val);
 242         int (*write)(unsigned int domain, unsigned int bus, unsigned int devfn,
 243                      int reg, int len, u32 val);
 244 };
 245
 246 extern struct pci_raw_ops *raw_pci_ops;
 247
 248 struct pci_bus_region {
 249         unsigned long start;
 250         unsigned long end;
 251 };
 252
 253 struct pci_dynids {
 254         spinlock_t lock;            /* protects list, index */
 255         struct list_head list;      /* for IDs added at runtime */
 256         unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
 257 };
 258
 259 /* ---------------------------------------------------------------- */
 260 /** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
 261  *  a set fof callbacks in struct pci_error_handlers, then that device driver
 262  *  will be notified of PCI bus errors, and will be driven to recovery
 263  *  when an error occurs.
 264  */
 265
 266 typedef unsigned int __bitwise pci_ers_result_t;
 267
 268 enum pci_ers_result {
 269         /* no result/none/not supported in device driver */
 270         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
 271
 272         /* Device driver can recover without slot reset */
 273         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
 274
 275         /* Device driver wants slot to be reset. */
 276         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
 277
 278         /* Device has completely failed, is unrecoverable */
 279         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
 280
 281         /* Device driver is fully recovered and operational */
 282         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
 283 };
 284
 285 /* PCI bus error event callbacks */
 286 struct pci_error_handlers
 287 {
 288         /* PCI bus error detected on this device */
 289         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
 290                               enum pci_channel_state error);
 291
 292         /* MMIO has been re-enabled, but not DMA */
 293         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
 294
 295         /* PCI Express link has been reset */
 296         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
 297
 298         /* PCI slot has been reset */
 299         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
 300
 301         /* Device driver may resume normal operations */
 302         void (*resume)(struct pci_dev *dev);
 303 };
 304
 305 /* ---------------------------------------------------------------- */
 306
 307 struct module;
 308 struct pci_driver {
 309         struct list_head node;
 310         char *name;
 311         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
 312         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
 313         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
 314         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
 315         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
 316         int  (*enable_wake) (struct pci_dev *dev, pci_power_t state, int enable);   /* Enable wake event */
 317         void (*shutdown) (struct pci_dev *dev);
 318
 319         struct pci_error_handlers *err_handler;
 320         struct device_driver    driver;
 321         struct pci_dynids dynids;
 322 };
 323
 324 #define to_pci_driver(drv) container_of(drv,struct pci_driver, driver)
 325
 326 /**
 327  * PCI_DEVICE - macro used to describe a specific pci device
 328  * @vend: the 16 bit PCI Vendor ID
 329  * @dev: the 16 bit PCI Device ID
 330  *
 331  * This macro is used to create a struct pci_device_id that matches a
 332  * specific device.  The subvendor and subdevice fields will be set to
 333  * PCI_ANY_ID.
 334  */
 335 #define PCI_DEVICE(vend,dev) \
 336         .vendor = (vend), .device = (dev), \
 337         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 338
 339 /**
 340  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
 341  * @dev_class: the class, subclass, prog-if triple for this device
 342  * @dev_class_mask: the class mask for this device
 343  *
 344  * This macro is used to create a struct pci_device_id that matches a
 345  * specific PCI class.  The vendor, device, subvendor, and subdevice
 346  * fields will be set to PCI_ANY_ID.
 347  */
 348 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
 349         .class = (dev_class), .class_mask = (dev_class_mask), \
 350         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
 351         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 352
 353 /*
 354  * pci_module_init is obsolete, this stays here till we fix up all usages of it
 355  * in the tree.
 356  */
 357 #define pci_module_init pci_register_driver
 358
 359 /* these external functions are only available when PCI support is enabled */
 360 #ifdef CONFIG_PCI
 361
 362 extern struct bus_type pci_bus_type;
 363
 364 /* Do NOT directly access these two variables, unless you are arch specific pci
 365  * code, or pci core code. */
 366 extern struct list_head pci_root_buses; /* list of all known PCI buses */
 367 extern struct list_head pci_devices;    /* list of all devices */
 368
 369 void pcibios_fixup_bus(struct pci_bus *);
 370 int pcibios_enable_device(struct pci_dev *, int mask);
 371 char *pcibios_setup (char *str);
 372
 373 /* Used only when drivers/pci/setup.c is used */
 374 void pcibios_align_resource(void *, struct resource *,
 375                             unsigned long, unsigned long);
 376 void pcibios_update_irq(struct pci_dev *, int irq);
 377
 378 /* Generic PCI functions used internally */
 379
 380 extern struct pci_bus *pci_find_bus(int domain, int busnr);
 381 void pci_bus_add_devices(struct pci_bus *bus);
 382 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
 383 static inline struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata)
 384 {
 385         struct pci_bus *root_bus;
 386         root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
 387         if (root_bus)
 388                 pci_bus_add_devices(root_bus);
 389         return root_bus;
 390 }
 391 struct pci_bus *pci_create_bus(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
 392 struct pci_bus * pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev, int busnr);
 393 int pci_scan_slot(struct pci_bus *bus, int devfn);
 394 struct pci_dev * pci_scan_single_device(struct pci_bus *bus, int devfn);
 395 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
 396 unsigned int pci_scan_child_bus(struct pci_bus *bus);
 397 void pci_bus_add_device(struct pci_dev *dev);
 398 void pci_read_bridge_bases(struct pci_bus *child);
 399 struct resource *pci_find_parent_resource(const struct pci_dev *dev, struct resource *res);
 400 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
 401 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
 402 extern void pci_dev_put(struct pci_dev *dev);
 403 extern void pci_remove_bus(struct pci_bus *b);
 404 extern void pci_remove_bus_device(struct pci_dev *dev);
 405 void pci_setup_cardbus(struct pci_bus *bus);
 406
 407 /* Generic PCI functions exported to card drivers */
 408
 409 struct pci_dev *pci_find_device (unsigned int vendor, unsigned int device, const struct pci_dev *from);
 410 struct pci_dev *pci_find_device_reverse (unsigned int vendor, unsigned int device, const struct pci_dev *from);
 411 struct pci_dev *pci_find_slot (unsigned int bus, unsigned int devfn);
 412 int pci_find_capability (struct pci_dev *dev, int cap);
 413 int pci_find_next_capability (struct pci_dev *dev, u8 pos, int cap);
 414 struct pci_bus * pci_find_next_bus(const struct pci_bus *from);
 415
 416 struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from);
 417 struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
 418                                 unsigned int ss_vendor, unsigned int ss_device,
 419                                 struct pci_dev *from);
 420 struct pci_dev *pci_get_slot (struct pci_bus *bus, unsigned int devfn);
 421 struct pci_dev *pci_get_class (unsigned int class, struct pci_dev *from);
 422 int pci_dev_present(const struct pci_device_id *ids);
 423
 424 int pci_bus_read_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 *val);
 425 int pci_bus_read_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 *val);
 426 int pci_bus_read_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 *val);
 427 int pci_bus_write_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 val);
 428 int pci_bus_write_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 val);
 429 int pci_bus_write_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 val);
 430
 431 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
 432 {
 433         return pci_bus_read_config_byte (dev->bus, dev->devfn, where, val);
 434 }
 435 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
 436 {
 437         return pci_bus_read_config_word (dev->bus, dev->devfn, where, val);
 438 }
 439 static inline int pci_read_config_dword(struct pci_dev *dev, int where, u32 *val)
 440 {
 441         return pci_bus_read_config_dword (dev->bus, dev->devfn, where, val);
 442 }
 443 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
 444 {
 445         return pci_bus_write_config_byte (dev->bus, dev->devfn, where, val);
 446 }
 447 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
 448 {
 449         return pci_bus_write_config_word (dev->bus, dev->devfn, where, val);
 450 }
 451 static inline int pci_write_config_dword(struct pci_dev *dev, int where, u32 val)
 452 {
 453         return pci_bus_write_config_dword (dev->bus, dev->devfn, where, val);
 454 }
 455
 456 int pci_enable_device(struct pci_dev *dev);
 457 int pci_enable_device_bars(struct pci_dev *dev, int mask);
 458 void pci_disable_device(struct pci_dev *dev);
 459 void pci_set_master(struct pci_dev *dev);
 460 #define HAVE_PCI_SET_MWI
 461 int pci_set_mwi(struct pci_dev *dev);
 462 void pci_clear_mwi(struct pci_dev *dev);
 463 void pci_intx(struct pci_dev *dev, int enable);
 464 int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
 465 int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
 466 void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
 467 int pci_assign_resource(struct pci_dev *dev, int i);
 468 void pci_restore_bars(struct pci_dev *dev);
 469
 470 /* ROM control related routines */
 471 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
 472 void __iomem __must_check *pci_map_rom_copy(struct pci_dev *pdev, size_t *size);
 473 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
 474 void pci_remove_rom(struct pci_dev *pdev);
 475
 476 /* Power management related routines */
 477 int pci_save_state(struct pci_dev *dev);
 478 int pci_restore_state(struct pci_dev *dev);
 479 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
 480 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
 481 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
 482
 483 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
 484 void pci_bus_assign_resources(struct pci_bus *bus);
 485 void pci_bus_size_bridges(struct pci_bus *bus);
 486 int pci_claim_resource(struct pci_dev *, int);
 487 void pci_assign_unassigned_resources(void);
 488 void pdev_enable_device(struct pci_dev *);
 489 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
 490 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
 491                     int (*)(struct pci_dev *, u8, u8));
 492 #define HAVE_PCI_REQ_REGIONS    2
 493 int pci_request_regions(struct pci_dev *, char *);
 494 void pci_release_regions(struct pci_dev *);
 495 int pci_request_region(struct pci_dev *, int, char *);
 496 void pci_release_region(struct pci_dev *, int);
 497
 498 /* drivers/pci/bus.c */
 499 int pci_bus_alloc_resource(struct pci_bus *bus, struct resource *res,
 500                            unsigned long size, unsigned long align,
 501                            unsigned long min, unsigned int type_mask,
 502                            void (*alignf)(void *, struct resource *,
 503                                           unsigned long, unsigned long),
 504                            void *alignf_data);
 505 void pci_enable_bridges(struct pci_bus *bus);
 506
 507 /* Proper probing supporting hot-pluggable devices */
 508 int __pci_register_driver(struct pci_driver *, struct module *);
 509 static inline int pci_register_driver(struct pci_driver *driver)
 510 {
 511         return __pci_register_driver(driver, THIS_MODULE);
 512 }
 513
 514 void pci_unregister_driver(struct pci_driver *);
 515 void pci_remove_behind_bridge(struct pci_dev *);
 516 struct pci_driver *pci_dev_driver(const struct pci_dev *);
 517 const struct pci_device_id *pci_match_device(struct pci_driver *drv, struct pci_dev *dev);
 518 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, struct pci_dev *dev);
 519 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev * dev, int max, int pass);
 520
 521 void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
 522                   void *userdata);
 523 int pci_cfg_space_size(struct pci_dev *dev);
 524 unsigned char pci_bus_max_busnr(struct pci_bus* bus);
 525
 526 /* kmem_cache style wrapper around pci_alloc_consistent() */
 527
 528 #include <linux/dmapool.h>
 529
 530 #define pci_pool dma_pool
 531 #define pci_pool_create(name, pdev, size, align, allocation) \
 532                 dma_pool_create(name, &pdev->dev, size, align, allocation)
 533 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
 534 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
 535 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
 536
 537 enum pci_dma_burst_strategy {
 538         PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
 539                                    strategy_parameter is N/A */
 540         PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
 541                                    byte boundaries */
 542         PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
 543                                    strategy_parameter byte boundaries */
 544 };
 545
 546 #if defined(CONFIG_ISA) || defined(CONFIG_EISA)
 547 extern struct pci_dev *isa_bridge;
 548 #endif
 549
 550 struct msix_entry {
 551         u16     vector; /* kernel uses to write allocated vector */
 552         u16     entry;  /* driver uses to specify entry, OS writes */
 553 };
 554
 555 #ifndef CONFIG_PCI_MSI
 556 static inline void pci_scan_msi_device(struct pci_dev *dev) {}
 557 static inline int pci_enable_msi(struct pci_dev *dev) {return -1;}
 558 static inline void pci_disable_msi(struct pci_dev *dev) {}
 559 static inline int pci_enable_msix(struct pci_dev* dev,
 560         struct msix_entry *entries, int nvec) {return -1;}
 561 static inline void pci_disable_msix(struct pci_dev *dev) {}
 562 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev) {}
 563 #else
 564 extern void pci_scan_msi_device(struct pci_dev *dev);
 565 extern int pci_enable_msi(struct pci_dev *dev);
 566 extern void pci_disable_msi(struct pci_dev *dev);
 567 extern int pci_enable_msix(struct pci_dev* dev,
 568         struct msix_entry *entries, int nvec);
 569 extern void pci_disable_msix(struct pci_dev *dev);
 570 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
 571 #endif
 572
 573 extern void pci_block_user_cfg_access(struct pci_dev *dev);
 574 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
 575
 576 /*
 577  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
 578  * a PCI domain is defined to be a set of PCI busses which share
 579  * configuration space.
 580  */
 581 #ifndef CONFIG_PCI_DOMAINS
 582 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
 583 static inline int pci_proc_domain(struct pci_bus *bus)
 584 {
 585         return 0;
 586 }
 587 #endif
 588
 589 #else /* CONFIG_PCI is not enabled */
 590
 591 /*
 592  *  If the system does not have PCI, clearly these return errors.  Define
 593  *  these as simple inline functions to avoid hair in drivers.
 594  */
 595
 596 #define _PCI_NOP(o,s,t) \
 597         static inline int pci_##o##_config_##s (struct pci_dev *dev, int where, t val) \
 598                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
 599 #define _PCI_NOP_ALL(o,x)       _PCI_NOP(o,byte,u8 x) \
 600                                 _PCI_NOP(o,word,u16 x) \
 601                                 _PCI_NOP(o,dword,u32 x)
 602 _PCI_NOP_ALL(read, *)
 603 _PCI_NOP_ALL(write,)
 604
 605 static inline struct pci_dev *pci_find_device(unsigned int vendor, unsigned int device, const struct pci_dev *from)
 606 { return NULL; }
 607
 608 static inline struct pci_dev *pci_find_slot(unsigned int bus, unsigned int devfn)
 609 { return NULL; }
 610
 611 static inline struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from)
 612 { return NULL; }
 613
 614 static inline struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
 615 unsigned int ss_vendor, unsigned int ss_device, struct pci_dev *from)
 616 { return NULL; }
 617
 618 static inline struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from)
 619 { return NULL; }
 620
 621 #define pci_dev_present(ids)    (0)
 622 #define pci_dev_put(dev)        do { } while (0)
 623
 624 static inline void pci_set_master(struct pci_dev *dev) { }
 625 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
 626 static inline void pci_disable_device(struct pci_dev *dev) { }
 627 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask) { return -EIO; }
 628 static inline int pci_assign_resource(struct pci_dev *dev, int i) { return -EBUSY;}
 629 static inline int __pci_register_driver(struct pci_driver *drv, struct module *owner) { return 0;}
 630 static inline int pci_register_driver(struct pci_driver *drv) { return 0;}
 631 static inline void pci_unregister_driver(struct pci_driver *drv) { }
 632 static inline int pci_find_capability (struct pci_dev *dev, int cap) {return 0; }
 633 static inline int pci_find_next_capability (struct pci_dev *dev, u8 post, int cap) { return 0; }
 634 static inline const struct pci_device_id *pci_match_device(const struct pci_device_id *ids, const struct pci_dev *dev) { return NULL; }
 635
 636 /* Power management related routines */
 637 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
 638 static inline int pci_restore_state(struct pci_dev *dev) { return 0; }
 639 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state) { return 0; }
 640 static inline pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state) { return PCI_D0; }
 641 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable) { return 0; }
 642
 643 #define isa_bridge      ((struct pci_dev *)NULL)
 644
 645 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
 646
 647 static inline void pci_block_user_cfg_access(struct pci_dev *dev) { }
 648 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev) { }
 649
 650 #endif /* CONFIG_PCI */
 651
 652 /* Include architecture-dependent settings and functions */
 653
 654 #include <asm/pci.h>
 655
 656 /* these helpers provide future and backwards compatibility
 657  * for accessing popular PCI BAR info */
 658 #define pci_resource_start(dev,bar)   ((dev)->resource[(bar)].start)
 659 #define pci_resource_end(dev,bar)     ((dev)->resource[(bar)].end)
 660 #define pci_resource_flags(dev,bar)   ((dev)->resource[(bar)].flags)
 661 #define pci_resource_len(dev,bar) \
 662         ((pci_resource_start((dev),(bar)) == 0 &&       \
 663           pci_resource_end((dev),(bar)) ==              \
 664           pci_resource_start((dev),(bar))) ? 0 :        \
 665                                                         \
 666          (pci_resource_end((dev),(bar)) -               \
 667           pci_resource_start((dev),(bar)) + 1))
 668
 669 /* Similar to the helpers above, these manipulate per-pci_dev
 670  * driver-specific data.  They are really just a wrapper around
 671  * the generic device structure functions of these calls.
 672  */
 673 static inline void *pci_get_drvdata (struct pci_dev *pdev)
 674 {
 675         return dev_get_drvdata(&pdev->dev);
 676 }
 677
 678 static inline void pci_set_drvdata (struct pci_dev *pdev, void *data)
 679 {
 680         dev_set_drvdata(&pdev->dev, data);
 681 }
 682
 683 /* If you want to know what to call your pci_dev, ask this function.
 684  * Again, it's a wrapper around the generic device.
 685  */
 686 static inline char *pci_name(struct pci_dev *pdev)
 687 {
 688         return pdev->dev.bus_id;
 689 }
 690
 691
 692 /* Some archs don't want to expose struct resource to userland as-is
 693  * in sysfs and /proc
 694  */
 695 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
 696 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
 697                 const struct resource *rsrc, u64 *start, u64 *end)
 698 {
 699         *start = rsrc->start;
 700         *end = rsrc->end;
 701 }
 702 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
 703
 704
 705 /*
 706  *  The world is not perfect and supplies us with broken PCI devices.
 707  *  For at least a part of these bugs we need a work-around, so both
 708  *  generic (drivers/pci/quirks.c) and per-architecture code can define
 709  *  fixup hooks to be called for particular buggy devices.
 710  */
 711
 712 struct pci_fixup {
 713         u16 vendor, device;     /* You can use PCI_ANY_ID here of course */
 714         void (*hook)(struct pci_dev *dev);
 715 };
 716
 717 enum pci_fixup_pass {
 718         pci_fixup_early,        /* Before probing BARs */
 719         pci_fixup_header,       /* After reading configuration header */
 720         pci_fixup_final,        /* Final phase of device fixups */
 721         pci_fixup_enable,       /* pci_enable_device() time */
 722 };
 723
 724 /* Anonymous variables would be nice... */
 725 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook)  \
 726         static const struct pci_fixup __pci_fixup_##name __attribute_used__ \
 727         __attribute__((__section__(#section))) = { vendor, device, hook };
 728 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
 729         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
 730                         vendor##device##hook, vendor, device, hook)
 731 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
 732         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
 733                         vendor##device##hook, vendor, device, hook)
 734 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
 735         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
 736                         vendor##device##hook, vendor, device, hook)
 737 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
 738         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
 739                         vendor##device##hook, vendor, device, hook)
 740
 741
 742 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
 743
 744 extern int pci_pci_problems;
 745 #define PCIPCI_FAIL             1
 746 #define PCIPCI_TRITON           2
 747 #define PCIPCI_NATOMA           4
 748 #define PCIPCI_VIAETBF          8
 749 #define PCIPCI_VSFX             16
 750 #define PCIPCI_ALIMAGIK         32
 751
 752 #endif /* __KERNEL__ */
 753 #endif /* LINUX_PCI_H */