Merge branch 'linux_next' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-2.6.git] / 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/pci_regs.h>     /* The pci register defines */
21
22 /*
23  * The PCI interface treats multi-function devices as independent
24  * devices.  The slot/function address of each device is encoded
25  * in a single byte as follows:
26  *
27  *      7:3 = slot
28  *      2:0 = function
29  */
30 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
31 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
32 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
33
34 /* Ioctls for /proc/bus/pci/X/Y nodes. */
35 #define PCIIOC_BASE             ('P' << 24 | 'C' << 16 | 'I' << 8)
36 #define PCIIOC_CONTROLLER       (PCIIOC_BASE | 0x00)    /* Get controller for PCI device. */
37 #define PCIIOC_MMAP_IS_IO       (PCIIOC_BASE | 0x01)    /* Set mmap state to I/O space. */
38 #define PCIIOC_MMAP_IS_MEM      (PCIIOC_BASE | 0x02)    /* Set mmap state to MEM space. */
39 #define PCIIOC_WRITE_COMBINE    (PCIIOC_BASE | 0x03)    /* Enable/disable write-combining. */
40
41 #ifdef __KERNEL__
42
43 #include <linux/mod_devicetable.h>
44
45 #include <linux/types.h>
46 #include <linux/init.h>
47 #include <linux/ioport.h>
48 #include <linux/list.h>
49 #include <linux/compiler.h>
50 #include <linux/errno.h>
51 #include <linux/kobject.h>
52 #include <asm/atomic.h>
53 #include <linux/device.h>
54 #include <linux/io.h>
55 #include <linux/irqreturn.h>
56
57 /* Include the ID list */
58 #include <linux/pci_ids.h>
59
60 /* pci_slot represents a physical slot */
61 struct pci_slot {
62         struct pci_bus *bus;            /* The bus this slot is on */
63         struct list_head list;          /* node in list of slots on this bus */
64         struct hotplug_slot *hotplug;   /* Hotplug info (migrate over time) */
65         unsigned char number;           /* PCI_SLOT(pci_dev->devfn) */
66         struct kobject kobj;
67 };
68
69 static inline const char *pci_slot_name(const struct pci_slot *slot)
70 {
71         return kobject_name(&slot->kobj);
72 }
73
74 /* File state for mmap()s on /proc/bus/pci/X/Y */
75 enum pci_mmap_state {
76         pci_mmap_io,
77         pci_mmap_mem
78 };
79
80 /* This defines the direction arg to the DMA mapping routines. */
81 #define PCI_DMA_BIDIRECTIONAL   0
82 #define PCI_DMA_TODEVICE        1
83 #define PCI_DMA_FROMDEVICE      2
84 #define PCI_DMA_NONE            3
85
86 /*
87  *  For PCI devices, the region numbers are assigned this way:
88  */
89 enum {
90         /* #0-5: standard PCI resources */
91         PCI_STD_RESOURCES,
92         PCI_STD_RESOURCE_END = 5,
93
94         /* #6: expansion ROM resource */
95         PCI_ROM_RESOURCE,
96
97         /* device specific resources */
98 #ifdef CONFIG_PCI_IOV
99         PCI_IOV_RESOURCES,
100         PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
101 #endif
102
103         /* resources assigned to buses behind the bridge */
104 #define PCI_BRIDGE_RESOURCE_NUM 4
105
106         PCI_BRIDGE_RESOURCES,
107         PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
108                                   PCI_BRIDGE_RESOURCE_NUM - 1,
109
110         /* total resources associated with a PCI device */
111         PCI_NUM_RESOURCES,
112
113         /* preserve this for compatibility */
114         DEVICE_COUNT_RESOURCE
115 };
116
117 typedef int __bitwise pci_power_t;
118
119 #define PCI_D0          ((pci_power_t __force) 0)
120 #define PCI_D1          ((pci_power_t __force) 1)
121 #define PCI_D2          ((pci_power_t __force) 2)
122 #define PCI_D3hot       ((pci_power_t __force) 3)
123 #define PCI_D3cold      ((pci_power_t __force) 4)
124 #define PCI_UNKNOWN     ((pci_power_t __force) 5)
125 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
126
127 /* Remember to update this when the list above changes! */
128 extern const char *pci_power_names[];
129
130 static inline const char *pci_power_name(pci_power_t state)
131 {
132         return pci_power_names[1 + (int) state];
133 }
134
135 #define PCI_PM_D2_DELAY 200
136 #define PCI_PM_D3_WAIT  10
137 #define PCI_PM_BUS_WAIT 50
138
139 /** The pci_channel state describes connectivity between the CPU and
140  *  the pci device.  If some PCI bus between here and the pci device
141  *  has crashed or locked up, this info is reflected here.
142  */
143 typedef unsigned int __bitwise pci_channel_state_t;
144
145 enum pci_channel_state {
146         /* I/O channel is in normal state */
147         pci_channel_io_normal = (__force pci_channel_state_t) 1,
148
149         /* I/O to channel is blocked */
150         pci_channel_io_frozen = (__force pci_channel_state_t) 2,
151
152         /* PCI card is dead */
153         pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
154 };
155
156 typedef unsigned int __bitwise pcie_reset_state_t;
157
158 enum pcie_reset_state {
159         /* Reset is NOT asserted (Use to deassert reset) */
160         pcie_deassert_reset = (__force pcie_reset_state_t) 1,
161
162         /* Use #PERST to reset PCI-E device */
163         pcie_warm_reset = (__force pcie_reset_state_t) 2,
164
165         /* Use PCI-E Hot Reset to reset device */
166         pcie_hot_reset = (__force pcie_reset_state_t) 3
167 };
168
169 typedef unsigned short __bitwise pci_dev_flags_t;
170 enum pci_dev_flags {
171         /* INTX_DISABLE in PCI_COMMAND register disables MSI
172          * generation too.
173          */
174         PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
175         /* Device configuration is irrevocably lost if disabled into D3 */
176         PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
177 };
178
179 enum pci_irq_reroute_variant {
180         INTEL_IRQ_REROUTE_VARIANT = 1,
181         MAX_IRQ_REROUTE_VARIANTS = 3
182 };
183
184 typedef unsigned short __bitwise pci_bus_flags_t;
185 enum pci_bus_flags {
186         PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
187         PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
188 };
189
190 /* Based on the PCI Hotplug Spec, but some values are made up by us */
191 enum pci_bus_speed {
192         PCI_SPEED_33MHz                 = 0x00,
193         PCI_SPEED_66MHz                 = 0x01,
194         PCI_SPEED_66MHz_PCIX            = 0x02,
195         PCI_SPEED_100MHz_PCIX           = 0x03,
196         PCI_SPEED_133MHz_PCIX           = 0x04,
197         PCI_SPEED_66MHz_PCIX_ECC        = 0x05,
198         PCI_SPEED_100MHz_PCIX_ECC       = 0x06,
199         PCI_SPEED_133MHz_PCIX_ECC       = 0x07,
200         PCI_SPEED_66MHz_PCIX_266        = 0x09,
201         PCI_SPEED_100MHz_PCIX_266       = 0x0a,
202         PCI_SPEED_133MHz_PCIX_266       = 0x0b,
203         AGP_UNKNOWN                     = 0x0c,
204         AGP_1X                          = 0x0d,
205         AGP_2X                          = 0x0e,
206         AGP_4X                          = 0x0f,
207         AGP_8X                          = 0x10,
208         PCI_SPEED_66MHz_PCIX_533        = 0x11,
209         PCI_SPEED_100MHz_PCIX_533       = 0x12,
210         PCI_SPEED_133MHz_PCIX_533       = 0x13,
211         PCIE_SPEED_2_5GT                = 0x14,
212         PCIE_SPEED_5_0GT                = 0x15,
213         PCIE_SPEED_8_0GT                = 0x16,
214         PCI_SPEED_UNKNOWN               = 0xff,
215 };
216
217 struct pci_cap_saved_state {
218         struct hlist_node next;
219         char cap_nr;
220         u32 data[0];
221 };
222
223 struct pcie_link_state;
224 struct pci_vpd;
225 struct pci_sriov;
226 struct pci_ats;
227
228 /*
229  * The pci_dev structure is used to describe PCI devices.
230  */
231 struct pci_dev {
232         struct list_head bus_list;      /* node in per-bus list */
233         struct pci_bus  *bus;           /* bus this device is on */
234         struct pci_bus  *subordinate;   /* bus this device bridges to */
235
236         void            *sysdata;       /* hook for sys-specific extension */
237         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
238         struct pci_slot *slot;          /* Physical slot this device is in */
239
240         unsigned int    devfn;          /* encoded device & function index */
241         unsigned short  vendor;
242         unsigned short  device;
243         unsigned short  subsystem_vendor;
244         unsigned short  subsystem_device;
245         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
246         u8              revision;       /* PCI revision, low byte of class word */
247         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
248         u8              pcie_cap;       /* PCI-E capability offset */
249         u8              pcie_type;      /* PCI-E device/port type */
250         u8              rom_base_reg;   /* which config register controls the ROM */
251         u8              pin;            /* which interrupt pin this device uses */
252
253         struct pci_driver *driver;      /* which driver has allocated this device */
254         u64             dma_mask;       /* Mask of the bits of bus address this
255                                            device implements.  Normally this is
256                                            0xffffffff.  You only need to change
257                                            this if your device has broken DMA
258                                            or supports 64-bit transfers.  */
259
260         struct device_dma_parameters dma_parms;
261
262         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
263                                            this is D0-D3, D0 being fully functional,
264                                            and D3 being off. */
265         int             pm_cap;         /* PM capability offset in the
266                                            configuration space */
267         unsigned int    pme_support:5;  /* Bitmask of states from which PME#
268                                            can be generated */
269         unsigned int    pme_interrupt:1;
270         unsigned int    d1_support:1;   /* Low power state D1 is supported */
271         unsigned int    d2_support:1;   /* Low power state D2 is supported */
272         unsigned int    no_d1d2:1;      /* Only allow D0 and D3 */
273         unsigned int    wakeup_prepared:1;
274         unsigned int    d3_delay;       /* D3->D0 transition time in ms */
275
276 #ifdef CONFIG_PCIEASPM
277         struct pcie_link_state  *link_state;    /* ASPM link state. */
278 #endif
279
280         pci_channel_state_t error_state;        /* current connectivity state */
281         struct  device  dev;            /* Generic device interface */
282
283         int             cfg_size;       /* Size of configuration space */
284
285         /*
286          * Instead of touching interrupt line and base address registers
287          * directly, use the values stored here. They might be different!
288          */
289         unsigned int    irq;
290         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
291
292         /* These fields are used by common fixups */
293         unsigned int    transparent:1;  /* Transparent PCI bridge */
294         unsigned int    multifunction:1;/* Part of multi-function device */
295         /* keep track of device state */
296         unsigned int    is_added:1;
297         unsigned int    is_busmaster:1; /* device is busmaster */
298         unsigned int    no_msi:1;       /* device may not use msi */
299         unsigned int    block_ucfg_access:1;    /* userspace config space access is blocked */
300         unsigned int    broken_parity_status:1; /* Device generates false positive parity */
301         unsigned int    irq_reroute_variant:2;  /* device needs IRQ rerouting variant */
302         unsigned int    msi_enabled:1;
303         unsigned int    msix_enabled:1;
304         unsigned int    ari_enabled:1;  /* ARI forwarding */
305         unsigned int    is_managed:1;
306         unsigned int    is_pcie:1;      /* Obsolete. Will be removed.
307                                            Use pci_is_pcie() instead */
308         unsigned int    needs_freset:1; /* Dev requires fundamental reset */
309         unsigned int    state_saved:1;
310         unsigned int    is_physfn:1;
311         unsigned int    is_virtfn:1;
312         unsigned int    reset_fn:1;
313         unsigned int    is_hotplug_bridge:1;
314         unsigned int    __aer_firmware_first_valid:1;
315         unsigned int    __aer_firmware_first:1;
316         pci_dev_flags_t dev_flags;
317         atomic_t        enable_cnt;     /* pci_enable_device has been called */
318
319         u32             saved_config_space[16]; /* config space saved at suspend time */
320         struct hlist_head saved_cap_space;
321         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
322         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
323         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
324         struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
325 #ifdef CONFIG_PCI_MSI
326         struct list_head msi_list;
327 #endif
328         struct pci_vpd *vpd;
329 #ifdef CONFIG_PCI_IOV
330         union {
331                 struct pci_sriov *sriov;        /* SR-IOV capability related */
332                 struct pci_dev *physfn; /* the PF this VF is associated with */
333         };
334         struct pci_ats  *ats;   /* Address Translation Service */
335 #endif
336 };
337
338 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
339 {
340 #ifdef CONFIG_PCI_IOV
341         if (dev->is_virtfn)
342                 dev = dev->physfn;
343 #endif
344
345         return dev;
346 }
347
348 extern struct pci_dev *alloc_pci_dev(void);
349
350 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
351 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
352 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
353
354 static inline int pci_channel_offline(struct pci_dev *pdev)
355 {
356         return (pdev->error_state != pci_channel_io_normal);
357 }
358
359 static inline struct pci_cap_saved_state *pci_find_saved_cap(
360         struct pci_dev *pci_dev, char cap)
361 {
362         struct pci_cap_saved_state *tmp;
363         struct hlist_node *pos;
364
365         hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
366                 if (tmp->cap_nr == cap)
367                         return tmp;
368         }
369         return NULL;
370 }
371
372 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
373         struct pci_cap_saved_state *new_cap)
374 {
375         hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
376 }
377
378 /*
379  * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
380  * to P2P or CardBus bridge windows) go in a table.  Additional ones (for
381  * buses below host bridges or subtractive decode bridges) go in the list.
382  * Use pci_bus_for_each_resource() to iterate through all the resources.
383  */
384
385 /*
386  * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
387  * and there's no way to program the bridge with the details of the window.
388  * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
389  * decode bit set, because they are explicit and can be programmed with _SRS.
390  */
391 #define PCI_SUBTRACTIVE_DECODE  0x1
392
393 struct pci_bus_resource {
394         struct list_head list;
395         struct resource *res;
396         unsigned int flags;
397 };
398
399 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
400
401 struct pci_bus {
402         struct list_head node;          /* node in list of buses */
403         struct pci_bus  *parent;        /* parent bus this bridge is on */
404         struct list_head children;      /* list of child buses */
405         struct list_head devices;       /* list of devices on this bus */
406         struct pci_dev  *self;          /* bridge device as seen by parent */
407         struct list_head slots;         /* list of slots on this bus */
408         struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
409         struct list_head resources;     /* address space routed to this bus */
410
411         struct pci_ops  *ops;           /* configuration access functions */
412         void            *sysdata;       /* hook for sys-specific extension */
413         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
414
415         unsigned char   number;         /* bus number */
416         unsigned char   primary;        /* number of primary bridge */
417         unsigned char   secondary;      /* number of secondary bridge */
418         unsigned char   subordinate;    /* max number of subordinate buses */
419         unsigned char   max_bus_speed;  /* enum pci_bus_speed */
420         unsigned char   cur_bus_speed;  /* enum pci_bus_speed */
421
422         char            name[48];
423
424         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
425         pci_bus_flags_t bus_flags;      /* Inherited by child busses */
426         struct device           *bridge;
427         struct device           dev;
428         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
429         struct bin_attribute    *legacy_mem; /* legacy mem */
430         unsigned int            is_added:1;
431 };
432
433 #define pci_bus_b(n)    list_entry(n, struct pci_bus, node)
434 #define to_pci_bus(n)   container_of(n, struct pci_bus, dev)
435
436 /*
437  * Returns true if the pci bus is root (behind host-pci bridge),
438  * false otherwise
439  */
440 static inline bool pci_is_root_bus(struct pci_bus *pbus)
441 {
442         return !(pbus->parent);
443 }
444
445 #ifdef CONFIG_PCI_MSI
446 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
447 {
448         return pci_dev->msi_enabled || pci_dev->msix_enabled;
449 }
450 #else
451 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
452 #endif
453
454 /*
455  * Error values that may be returned by PCI functions.
456  */
457 #define PCIBIOS_SUCCESSFUL              0x00
458 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
459 #define PCIBIOS_BAD_VENDOR_ID           0x83
460 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
461 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
462 #define PCIBIOS_SET_FAILED              0x88
463 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
464
465 /* Low-level architecture-dependent routines */
466
467 struct pci_ops {
468         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
469         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
470 };
471
472 /*
473  * ACPI needs to be able to access PCI config space before we've done a
474  * PCI bus scan and created pci_bus structures.
475  */
476 extern int raw_pci_read(unsigned int domain, unsigned int bus,
477                         unsigned int devfn, int reg, int len, u32 *val);
478 extern int raw_pci_write(unsigned int domain, unsigned int bus,
479                         unsigned int devfn, int reg, int len, u32 val);
480
481 struct pci_bus_region {
482         resource_size_t start;
483         resource_size_t end;
484 };
485
486 struct pci_dynids {
487         spinlock_t lock;            /* protects list, index */
488         struct list_head list;      /* for IDs added at runtime */
489 };
490
491 /* ---------------------------------------------------------------- */
492 /** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
493  *  a set of callbacks in struct pci_error_handlers, then that device driver
494  *  will be notified of PCI bus errors, and will be driven to recovery
495  *  when an error occurs.
496  */
497
498 typedef unsigned int __bitwise pci_ers_result_t;
499
500 enum pci_ers_result {
501         /* no result/none/not supported in device driver */
502         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
503
504         /* Device driver can recover without slot reset */
505         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
506
507         /* Device driver wants slot to be reset. */
508         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
509
510         /* Device has completely failed, is unrecoverable */
511         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
512
513         /* Device driver is fully recovered and operational */
514         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
515 };
516
517 /* PCI bus error event callbacks */
518 struct pci_error_handlers {
519         /* PCI bus error detected on this device */
520         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
521                                            enum pci_channel_state error);
522
523         /* MMIO has been re-enabled, but not DMA */
524         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
525
526         /* PCI Express link has been reset */
527         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
528
529         /* PCI slot has been reset */
530         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
531
532         /* Device driver may resume normal operations */
533         void (*resume)(struct pci_dev *dev);
534 };
535
536 /* ---------------------------------------------------------------- */
537
538 struct module;
539 struct pci_driver {
540         struct list_head node;
541         char *name;
542         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
543         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
544         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
545         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
546         int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
547         int  (*resume_early) (struct pci_dev *dev);
548         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
549         void (*shutdown) (struct pci_dev *dev);
550         struct pci_error_handlers *err_handler;
551         struct device_driver    driver;
552         struct pci_dynids dynids;
553 };
554
555 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
556
557 /**
558  * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
559  * @_table: device table name
560  *
561  * This macro is used to create a struct pci_device_id array (a device table)
562  * in a generic manner.
563  */
564 #define DEFINE_PCI_DEVICE_TABLE(_table) \
565         const struct pci_device_id _table[] __devinitconst
566
567 /**
568  * PCI_DEVICE - macro used to describe a specific pci device
569  * @vend: the 16 bit PCI Vendor ID
570  * @dev: the 16 bit PCI Device ID
571  *
572  * This macro is used to create a struct pci_device_id that matches a
573  * specific device.  The subvendor and subdevice fields will be set to
574  * PCI_ANY_ID.
575  */
576 #define PCI_DEVICE(vend,dev) \
577         .vendor = (vend), .device = (dev), \
578         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
579
580 /**
581  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
582  * @dev_class: the class, subclass, prog-if triple for this device
583  * @dev_class_mask: the class mask for this device
584  *
585  * This macro is used to create a struct pci_device_id that matches a
586  * specific PCI class.  The vendor, device, subvendor, and subdevice
587  * fields will be set to PCI_ANY_ID.
588  */
589 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
590         .class = (dev_class), .class_mask = (dev_class_mask), \
591         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
592         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
593
594 /**
595  * PCI_VDEVICE - macro used to describe a specific pci device in short form
596  * @vendor: the vendor name
597  * @device: the 16 bit PCI Device ID
598  *
599  * This macro is used to create a struct pci_device_id that matches a
600  * specific PCI device.  The subvendor, and subdevice fields will be set
601  * to PCI_ANY_ID. The macro allows the next field to follow as the device
602  * private data.
603  */
604
605 #define PCI_VDEVICE(vendor, device)             \
606         PCI_VENDOR_ID_##vendor, (device),       \
607         PCI_ANY_ID, PCI_ANY_ID, 0, 0
608
609 /* these external functions are only available when PCI support is enabled */
610 #ifdef CONFIG_PCI
611
612 extern struct bus_type pci_bus_type;
613
614 /* Do NOT directly access these two variables, unless you are arch specific pci
615  * code, or pci core code. */
616 extern struct list_head pci_root_buses; /* list of all known PCI buses */
617 /* Some device drivers need know if pci is initiated */
618 extern int no_pci_devices(void);
619
620 void pcibios_fixup_bus(struct pci_bus *);
621 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
622 char *pcibios_setup(char *str);
623
624 /* Used only when drivers/pci/setup.c is used */
625 resource_size_t pcibios_align_resource(void *, const struct resource *,
626                                 resource_size_t,
627                                 resource_size_t);
628 void pcibios_update_irq(struct pci_dev *, int irq);
629
630 /* Weak but can be overriden by arch */
631 void pci_fixup_cardbus(struct pci_bus *);
632
633 /* Generic PCI functions used internally */
634
635 void pcibios_scan_specific_bus(int busn);
636 extern struct pci_bus *pci_find_bus(int domain, int busnr);
637 void pci_bus_add_devices(const struct pci_bus *bus);
638 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
639                                       struct pci_ops *ops, void *sysdata);
640 static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
641                                            void *sysdata)
642 {
643         struct pci_bus *root_bus;
644         root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
645         if (root_bus)
646                 pci_bus_add_devices(root_bus);
647         return root_bus;
648 }
649 struct pci_bus *pci_create_bus(struct device *parent, int bus,
650                                struct pci_ops *ops, void *sysdata);
651 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
652                                 int busnr);
653 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
654 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
655                                  const char *name,
656                                  struct hotplug_slot *hotplug);
657 void pci_destroy_slot(struct pci_slot *slot);
658 void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
659 int pci_scan_slot(struct pci_bus *bus, int devfn);
660 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
661 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
662 unsigned int pci_scan_child_bus(struct pci_bus *bus);
663 int __must_check pci_bus_add_device(struct pci_dev *dev);
664 void pci_read_bridge_bases(struct pci_bus *child);
665 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
666                                           struct resource *res);
667 u8 pci_swizzle_interrupt_pin(struct pci_dev *dev, u8 pin);
668 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
669 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
670 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
671 extern void pci_dev_put(struct pci_dev *dev);
672 extern void pci_remove_bus(struct pci_bus *b);
673 extern void pci_remove_bus_device(struct pci_dev *dev);
674 extern void pci_stop_bus_device(struct pci_dev *dev);
675 void pci_setup_cardbus(struct pci_bus *bus);
676 extern void pci_sort_breadthfirst(void);
677 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
678 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
679 #define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
680
681 /* Generic PCI functions exported to card drivers */
682
683 enum pci_lost_interrupt_reason {
684         PCI_LOST_IRQ_NO_INFORMATION = 0,
685         PCI_LOST_IRQ_DISABLE_MSI,
686         PCI_LOST_IRQ_DISABLE_MSIX,
687         PCI_LOST_IRQ_DISABLE_ACPI,
688 };
689 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
690 int pci_find_capability(struct pci_dev *dev, int cap);
691 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
692 int pci_find_ext_capability(struct pci_dev *dev, int cap);
693 int pci_bus_find_ext_capability(struct pci_bus *bus, unsigned int devfn,
694                                 int cap);
695 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
696 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
697 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
698
699 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
700                                 struct pci_dev *from);
701 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
702                                 unsigned int ss_vendor, unsigned int ss_device,
703                                 struct pci_dev *from);
704 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
705 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
706                                             unsigned int devfn);
707 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
708                                                    unsigned int devfn)
709 {
710         return pci_get_domain_bus_and_slot(0, bus, devfn);
711 }
712 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
713 int pci_dev_present(const struct pci_device_id *ids);
714
715 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
716                              int where, u8 *val);
717 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
718                              int where, u16 *val);
719 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
720                               int where, u32 *val);
721 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
722                               int where, u8 val);
723 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
724                               int where, u16 val);
725 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
726                                int where, u32 val);
727 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
728
729 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
730 {
731         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
732 }
733 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
734 {
735         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
736 }
737 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
738                                         u32 *val)
739 {
740         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
741 }
742 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
743 {
744         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
745 }
746 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
747 {
748         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
749 }
750 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
751                                          u32 val)
752 {
753         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
754 }
755
756 int __must_check pci_enable_device(struct pci_dev *dev);
757 int __must_check pci_enable_device_io(struct pci_dev *dev);
758 int __must_check pci_enable_device_mem(struct pci_dev *dev);
759 int __must_check pci_reenable_device(struct pci_dev *);
760 int __must_check pcim_enable_device(struct pci_dev *pdev);
761 void pcim_pin_device(struct pci_dev *pdev);
762
763 static inline int pci_is_enabled(struct pci_dev *pdev)
764 {
765         return (atomic_read(&pdev->enable_cnt) > 0);
766 }
767
768 static inline int pci_is_managed(struct pci_dev *pdev)
769 {
770         return pdev->is_managed;
771 }
772
773 void pci_disable_device(struct pci_dev *dev);
774 void pci_set_master(struct pci_dev *dev);
775 void pci_clear_master(struct pci_dev *dev);
776 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
777 int pci_set_cacheline_size(struct pci_dev *dev);
778 #define HAVE_PCI_SET_MWI
779 int __must_check pci_set_mwi(struct pci_dev *dev);
780 int pci_try_set_mwi(struct pci_dev *dev);
781 void pci_clear_mwi(struct pci_dev *dev);
782 void pci_intx(struct pci_dev *dev, int enable);
783 void pci_msi_off(struct pci_dev *dev);
784 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
785 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
786 int pcix_get_max_mmrbc(struct pci_dev *dev);
787 int pcix_get_mmrbc(struct pci_dev *dev);
788 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
789 int pcie_get_readrq(struct pci_dev *dev);
790 int pcie_set_readrq(struct pci_dev *dev, int rq);
791 int __pci_reset_function(struct pci_dev *dev);
792 int pci_reset_function(struct pci_dev *dev);
793 void pci_update_resource(struct pci_dev *dev, int resno);
794 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
795 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
796
797 /* ROM control related routines */
798 int pci_enable_rom(struct pci_dev *pdev);
799 void pci_disable_rom(struct pci_dev *pdev);
800 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
801 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
802 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
803
804 /* Power management related routines */
805 int pci_save_state(struct pci_dev *dev);
806 int pci_restore_state(struct pci_dev *dev);
807 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
808 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
809 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
810 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
811 void pci_pme_active(struct pci_dev *dev, bool enable);
812 int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
813                       bool runtime, bool enable);
814 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
815 pci_power_t pci_target_state(struct pci_dev *dev);
816 int pci_prepare_to_sleep(struct pci_dev *dev);
817 int pci_back_from_sleep(struct pci_dev *dev);
818 bool pci_dev_run_wake(struct pci_dev *dev);
819
820 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
821                                   bool enable)
822 {
823         return __pci_enable_wake(dev, state, false, enable);
824 }
825
826 /* For use by arch with custom probe code */
827 void set_pcie_port_type(struct pci_dev *pdev);
828 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
829
830 /* Functions for PCI Hotplug drivers to use */
831 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
832 #ifdef CONFIG_HOTPLUG
833 unsigned int pci_rescan_bus(struct pci_bus *bus);
834 #endif
835
836 /* Vital product data routines */
837 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
838 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
839 int pci_vpd_truncate(struct pci_dev *dev, size_t size);
840
841 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
842 void pci_bus_assign_resources(const struct pci_bus *bus);
843 void pci_bus_size_bridges(struct pci_bus *bus);
844 int pci_claim_resource(struct pci_dev *, int);
845 void pci_assign_unassigned_resources(void);
846 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
847 void pdev_enable_device(struct pci_dev *);
848 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
849 int pci_enable_resources(struct pci_dev *, int mask);
850 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
851                     int (*)(struct pci_dev *, u8, u8));
852 #define HAVE_PCI_REQ_REGIONS    2
853 int __must_check pci_request_regions(struct pci_dev *, const char *);
854 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
855 void pci_release_regions(struct pci_dev *);
856 int __must_check pci_request_region(struct pci_dev *, int, const char *);
857 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
858 void pci_release_region(struct pci_dev *, int);
859 int pci_request_selected_regions(struct pci_dev *, int, const char *);
860 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
861 void pci_release_selected_regions(struct pci_dev *, int);
862
863 /* drivers/pci/bus.c */
864 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
865 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
866 void pci_bus_remove_resources(struct pci_bus *bus);
867
868 #define pci_bus_for_each_resource(bus, res, i)                          \
869         for (i = 0;                                                     \
870             (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
871              i++)
872
873 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
874                         struct resource *res, resource_size_t size,
875                         resource_size_t align, resource_size_t min,
876                         unsigned int type_mask,
877                         resource_size_t (*alignf)(void *,
878                                                   const struct resource *,
879                                                   resource_size_t,
880                                                   resource_size_t),
881                         void *alignf_data);
882 void pci_enable_bridges(struct pci_bus *bus);
883
884 /* Proper probing supporting hot-pluggable devices */
885 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
886                                        const char *mod_name);
887
888 /*
889  * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
890  */
891 #define pci_register_driver(driver)             \
892         __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
893
894 void pci_unregister_driver(struct pci_driver *dev);
895 void pci_remove_behind_bridge(struct pci_dev *dev);
896 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
897 int pci_add_dynid(struct pci_driver *drv,
898                   unsigned int vendor, unsigned int device,
899                   unsigned int subvendor, unsigned int subdevice,
900                   unsigned int class, unsigned int class_mask,
901                   unsigned long driver_data);
902 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
903                                          struct pci_dev *dev);
904 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
905                     int pass);
906
907 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
908                   void *userdata);
909 int pci_cfg_space_size_ext(struct pci_dev *dev);
910 int pci_cfg_space_size(struct pci_dev *dev);
911 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
912
913 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
914                       unsigned int command_bits, bool change_bridge);
915 /* kmem_cache style wrapper around pci_alloc_consistent() */
916
917 #include <linux/pci-dma.h>
918 #include <linux/dmapool.h>
919
920 #define pci_pool dma_pool
921 #define pci_pool_create(name, pdev, size, align, allocation) \
922                 dma_pool_create(name, &pdev->dev, size, align, allocation)
923 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
924 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
925 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
926
927 enum pci_dma_burst_strategy {
928         PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
929                                    strategy_parameter is N/A */
930         PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
931                                    byte boundaries */
932         PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
933                                    strategy_parameter byte boundaries */
934 };
935
936 struct msix_entry {
937         u32     vector; /* kernel uses to write allocated vector */
938         u16     entry;  /* driver uses to specify entry, OS writes */
939 };
940
941
942 #ifndef CONFIG_PCI_MSI
943 static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
944 {
945         return -1;
946 }
947
948 static inline void pci_msi_shutdown(struct pci_dev *dev)
949 { }
950 static inline void pci_disable_msi(struct pci_dev *dev)
951 { }
952
953 static inline int pci_msix_table_size(struct pci_dev *dev)
954 {
955         return 0;
956 }
957 static inline int pci_enable_msix(struct pci_dev *dev,
958                                   struct msix_entry *entries, int nvec)
959 {
960         return -1;
961 }
962
963 static inline void pci_msix_shutdown(struct pci_dev *dev)
964 { }
965 static inline void pci_disable_msix(struct pci_dev *dev)
966 { }
967
968 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
969 { }
970
971 static inline void pci_restore_msi_state(struct pci_dev *dev)
972 { }
973 static inline int pci_msi_enabled(void)
974 {
975         return 0;
976 }
977 #else
978 extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
979 extern void pci_msi_shutdown(struct pci_dev *dev);
980 extern void pci_disable_msi(struct pci_dev *dev);
981 extern int pci_msix_table_size(struct pci_dev *dev);
982 extern int pci_enable_msix(struct pci_dev *dev,
983         struct msix_entry *entries, int nvec);
984 extern void pci_msix_shutdown(struct pci_dev *dev);
985 extern void pci_disable_msix(struct pci_dev *dev);
986 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
987 extern void pci_restore_msi_state(struct pci_dev *dev);
988 extern int pci_msi_enabled(void);
989 #endif
990
991 #ifndef CONFIG_PCIEASPM
992 static inline int pcie_aspm_enabled(void)
993 {
994         return 0;
995 }
996 #else
997 extern int pcie_aspm_enabled(void);
998 #endif
999
1000 #ifndef CONFIG_PCIE_ECRC
1001 static inline void pcie_set_ecrc_checking(struct pci_dev *dev)
1002 {
1003         return;
1004 }
1005 static inline void pcie_ecrc_get_policy(char *str) {};
1006 #else
1007 extern void pcie_set_ecrc_checking(struct pci_dev *dev);
1008 extern void pcie_ecrc_get_policy(char *str);
1009 #endif
1010
1011 #define pci_enable_msi(pdev)    pci_enable_msi_block(pdev, 1)
1012
1013 #ifdef CONFIG_HT_IRQ
1014 /* The functions a driver should call */
1015 int  ht_create_irq(struct pci_dev *dev, int idx);
1016 void ht_destroy_irq(unsigned int irq);
1017 #endif /* CONFIG_HT_IRQ */
1018
1019 extern void pci_block_user_cfg_access(struct pci_dev *dev);
1020 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
1021
1022 /*
1023  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
1024  * a PCI domain is defined to be a set of PCI busses which share
1025  * configuration space.
1026  */
1027 #ifdef CONFIG_PCI_DOMAINS
1028 extern int pci_domains_supported;
1029 #else
1030 enum { pci_domains_supported = 0 };
1031 static inline int pci_domain_nr(struct pci_bus *bus)
1032 {
1033         return 0;
1034 }
1035
1036 static inline int pci_proc_domain(struct pci_bus *bus)
1037 {
1038         return 0;
1039 }
1040 #endif /* CONFIG_PCI_DOMAINS */
1041
1042 /* some architectures require additional setup to direct VGA traffic */
1043 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1044                       unsigned int command_bits, bool change_bridge);
1045 extern void pci_register_set_vga_state(arch_set_vga_state_t func);
1046
1047 #else /* CONFIG_PCI is not enabled */
1048
1049 /*
1050  *  If the system does not have PCI, clearly these return errors.  Define
1051  *  these as simple inline functions to avoid hair in drivers.
1052  */
1053
1054 #define _PCI_NOP(o, s, t) \
1055         static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1056                                                 int where, t val) \
1057                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1058
1059 #define _PCI_NOP_ALL(o, x)      _PCI_NOP(o, byte, u8 x) \
1060                                 _PCI_NOP(o, word, u16 x) \
1061                                 _PCI_NOP(o, dword, u32 x)
1062 _PCI_NOP_ALL(read, *)
1063 _PCI_NOP_ALL(write,)
1064
1065 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1066                                              unsigned int device,
1067                                              struct pci_dev *from)
1068 {
1069         return NULL;
1070 }
1071
1072 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1073                                              unsigned int device,
1074                                              unsigned int ss_vendor,
1075                                              unsigned int ss_device,
1076                                              struct pci_dev *from)
1077 {
1078         return NULL;
1079 }
1080
1081 static inline struct pci_dev *pci_get_class(unsigned int class,
1082                                             struct pci_dev *from)
1083 {
1084         return NULL;
1085 }
1086
1087 #define pci_dev_present(ids)    (0)
1088 #define no_pci_devices()        (1)
1089 #define pci_dev_put(dev)        do { } while (0)
1090
1091 static inline void pci_set_master(struct pci_dev *dev)
1092 { }
1093
1094 static inline int pci_enable_device(struct pci_dev *dev)
1095 {
1096         return -EIO;
1097 }
1098
1099 static inline void pci_disable_device(struct pci_dev *dev)
1100 { }
1101
1102 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
1103 {
1104         return -EIO;
1105 }
1106
1107 static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
1108 {
1109         return -EIO;
1110 }
1111
1112 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
1113                                         unsigned int size)
1114 {
1115         return -EIO;
1116 }
1117
1118 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
1119                                         unsigned long mask)
1120 {
1121         return -EIO;
1122 }
1123
1124 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1125 {
1126         return -EBUSY;
1127 }
1128
1129 static inline int __pci_register_driver(struct pci_driver *drv,
1130                                         struct module *owner)
1131 {
1132         return 0;
1133 }
1134
1135 static inline int pci_register_driver(struct pci_driver *drv)
1136 {
1137         return 0;
1138 }
1139
1140 static inline void pci_unregister_driver(struct pci_driver *drv)
1141 { }
1142
1143 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1144 {
1145         return 0;
1146 }
1147
1148 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1149                                            int cap)
1150 {
1151         return 0;
1152 }
1153
1154 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1155 {
1156         return 0;
1157 }
1158
1159 /* Power management related routines */
1160 static inline int pci_save_state(struct pci_dev *dev)
1161 {
1162         return 0;
1163 }
1164
1165 static inline int pci_restore_state(struct pci_dev *dev)
1166 {
1167         return 0;
1168 }
1169
1170 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1171 {
1172         return 0;
1173 }
1174
1175 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1176                                            pm_message_t state)
1177 {
1178         return PCI_D0;
1179 }
1180
1181 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1182                                   int enable)
1183 {
1184         return 0;
1185 }
1186
1187 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1188 {
1189         return -EIO;
1190 }
1191
1192 static inline void pci_release_regions(struct pci_dev *dev)
1193 { }
1194
1195 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1196
1197 static inline void pci_block_user_cfg_access(struct pci_dev *dev)
1198 { }
1199
1200 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
1201 { }
1202
1203 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1204 { return NULL; }
1205
1206 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1207                                                 unsigned int devfn)
1208 { return NULL; }
1209
1210 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1211                                                 unsigned int devfn)
1212 { return NULL; }
1213
1214 #define dev_is_pci(d) (false)
1215 #define dev_is_pf(d) (false)
1216 #define dev_num_vf(d) (0)
1217 #endif /* CONFIG_PCI */
1218
1219 /* Include architecture-dependent settings and functions */
1220
1221 #include <asm/pci.h>
1222
1223 #ifndef PCIBIOS_MAX_MEM_32
1224 #define PCIBIOS_MAX_MEM_32 (-1)
1225 #endif
1226
1227 /* these helpers provide future and backwards compatibility
1228  * for accessing popular PCI BAR info */
1229 #define pci_resource_start(dev, bar)    ((dev)->resource[(bar)].start)
1230 #define pci_resource_end(dev, bar)      ((dev)->resource[(bar)].end)
1231 #define pci_resource_flags(dev, bar)    ((dev)->resource[(bar)].flags)
1232 #define pci_resource_len(dev,bar) \
1233         ((pci_resource_start((dev), (bar)) == 0 &&      \
1234           pci_resource_end((dev), (bar)) ==             \
1235           pci_resource_start((dev), (bar))) ? 0 :       \
1236                                                         \
1237          (pci_resource_end((dev), (bar)) -              \
1238           pci_resource_start((dev), (bar)) + 1))
1239
1240 /* Similar to the helpers above, these manipulate per-pci_dev
1241  * driver-specific data.  They are really just a wrapper around
1242  * the generic device structure functions of these calls.
1243  */
1244 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1245 {
1246         return dev_get_drvdata(&pdev->dev);
1247 }
1248
1249 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1250 {
1251         dev_set_drvdata(&pdev->dev, data);
1252 }
1253
1254 /* If you want to know what to call your pci_dev, ask this function.
1255  * Again, it's a wrapper around the generic device.
1256  */
1257 static inline const char *pci_name(const struct pci_dev *pdev)
1258 {
1259         return dev_name(&pdev->dev);
1260 }
1261
1262
1263 /* Some archs don't want to expose struct resource to userland as-is
1264  * in sysfs and /proc
1265  */
1266 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1267 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1268                 const struct resource *rsrc, resource_size_t *start,
1269                 resource_size_t *end)
1270 {
1271         *start = rsrc->start;
1272         *end = rsrc->end;
1273 }
1274 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1275
1276
1277 /*
1278  *  The world is not perfect and supplies us with broken PCI devices.
1279  *  For at least a part of these bugs we need a work-around, so both
1280  *  generic (drivers/pci/quirks.c) and per-architecture code can define
1281  *  fixup hooks to be called for particular buggy devices.
1282  */
1283
1284 struct pci_fixup {
1285         u16 vendor, device;     /* You can use PCI_ANY_ID here of course */
1286         void (*hook)(struct pci_dev *dev);
1287 };
1288
1289 enum pci_fixup_pass {
1290         pci_fixup_early,        /* Before probing BARs */
1291         pci_fixup_header,       /* After reading configuration header */
1292         pci_fixup_final,        /* Final phase of device fixups */
1293         pci_fixup_enable,       /* pci_enable_device() time */
1294         pci_fixup_resume,       /* pci_device_resume() */
1295         pci_fixup_suspend,      /* pci_device_suspend */
1296         pci_fixup_resume_early, /* pci_device_resume_early() */
1297 };
1298
1299 /* Anonymous variables would be nice... */
1300 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook)  \
1301         static const struct pci_fixup __pci_fixup_##name __used         \
1302         __attribute__((__section__(#section))) = { vendor, device, hook };
1303 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
1304         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1305                         vendor##device##hook, vendor, device, hook)
1306 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
1307         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1308                         vendor##device##hook, vendor, device, hook)
1309 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
1310         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1311                         vendor##device##hook, vendor, device, hook)
1312 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
1313         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1314                         vendor##device##hook, vendor, device, hook)
1315 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)                  \
1316         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1317                         resume##vendor##device##hook, vendor, device, hook)
1318 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)            \
1319         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,              \
1320                         resume_early##vendor##device##hook, vendor, device, hook)
1321 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)                 \
1322         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,                   \
1323                         suspend##vendor##device##hook, vendor, device, hook)
1324
1325 #ifdef CONFIG_PCI_QUIRKS
1326 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1327 #else
1328 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1329                                     struct pci_dev *dev) {}
1330 #endif
1331
1332 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1333 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1334 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1335 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1336 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1337                                    const char *name);
1338 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1339
1340 extern int pci_pci_problems;
1341 #define PCIPCI_FAIL             1       /* No PCI PCI DMA */
1342 #define PCIPCI_TRITON           2
1343 #define PCIPCI_NATOMA           4
1344 #define PCIPCI_VIAETBF          8
1345 #define PCIPCI_VSFX             16
1346 #define PCIPCI_ALIMAGIK         32      /* Need low latency setting */
1347 #define PCIAGP_FAIL             64      /* No PCI to AGP DMA */
1348
1349 extern unsigned long pci_cardbus_io_size;
1350 extern unsigned long pci_cardbus_mem_size;
1351 extern u8 __devinitdata pci_dfl_cache_line_size;
1352 extern u8 pci_cache_line_size;
1353
1354 extern unsigned long pci_hotplug_io_size;
1355 extern unsigned long pci_hotplug_mem_size;
1356
1357 int pcibios_add_platform_entries(struct pci_dev *dev);
1358 void pcibios_disable_device(struct pci_dev *dev);
1359 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1360                                  enum pcie_reset_state state);
1361
1362 #ifdef CONFIG_PCI_MMCONFIG
1363 extern void __init pci_mmcfg_early_init(void);
1364 extern void __init pci_mmcfg_late_init(void);
1365 #else
1366 static inline void pci_mmcfg_early_init(void) { }
1367 static inline void pci_mmcfg_late_init(void) { }
1368 #endif
1369
1370 int pci_ext_cfg_avail(struct pci_dev *dev);
1371
1372 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1373
1374 #ifdef CONFIG_PCI_IOV
1375 extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1376 extern void pci_disable_sriov(struct pci_dev *dev);
1377 extern irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1378 extern int pci_num_vf(struct pci_dev *dev);
1379 #else
1380 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1381 {
1382         return -ENODEV;
1383 }
1384 static inline void pci_disable_sriov(struct pci_dev *dev)
1385 {
1386 }
1387 static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
1388 {
1389         return IRQ_NONE;
1390 }
1391 static inline int pci_num_vf(struct pci_dev *dev)
1392 {
1393         return 0;
1394 }
1395 #endif
1396
1397 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1398 extern void pci_hp_create_module_link(struct pci_slot *pci_slot);
1399 extern void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1400 #endif
1401
1402 /**
1403  * pci_pcie_cap - get the saved PCIe capability offset
1404  * @dev: PCI device
1405  *
1406  * PCIe capability offset is calculated at PCI device initialization
1407  * time and saved in the data structure. This function returns saved
1408  * PCIe capability offset. Using this instead of pci_find_capability()
1409  * reduces unnecessary search in the PCI configuration space. If you
1410  * need to calculate PCIe capability offset from raw device for some
1411  * reasons, please use pci_find_capability() instead.
1412  */
1413 static inline int pci_pcie_cap(struct pci_dev *dev)
1414 {
1415         return dev->pcie_cap;
1416 }
1417
1418 /**
1419  * pci_is_pcie - check if the PCI device is PCI Express capable
1420  * @dev: PCI device
1421  *
1422  * Retrun true if the PCI device is PCI Express capable, false otherwise.
1423  */
1424 static inline bool pci_is_pcie(struct pci_dev *dev)
1425 {
1426         return !!pci_pcie_cap(dev);
1427 }
1428
1429 void pci_request_acs(void);
1430
1431
1432 #define PCI_VPD_LRDT                    0x80    /* Large Resource Data Type */
1433 #define PCI_VPD_LRDT_ID(x)              (x | PCI_VPD_LRDT)
1434
1435 /* Large Resource Data Type Tag Item Names */
1436 #define PCI_VPD_LTIN_ID_STRING          0x02    /* Identifier String */
1437 #define PCI_VPD_LTIN_RO_DATA            0x10    /* Read-Only Data */
1438 #define PCI_VPD_LTIN_RW_DATA            0x11    /* Read-Write Data */
1439
1440 #define PCI_VPD_LRDT_ID_STRING          PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
1441 #define PCI_VPD_LRDT_RO_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
1442 #define PCI_VPD_LRDT_RW_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
1443
1444 /* Small Resource Data Type Tag Item Names */
1445 #define PCI_VPD_STIN_END                0x78    /* End */
1446
1447 #define PCI_VPD_SRDT_END                PCI_VPD_STIN_END
1448
1449 #define PCI_VPD_SRDT_TIN_MASK           0x78
1450 #define PCI_VPD_SRDT_LEN_MASK           0x07
1451
1452 #define PCI_VPD_LRDT_TAG_SIZE           3
1453 #define PCI_VPD_SRDT_TAG_SIZE           1
1454
1455 #define PCI_VPD_INFO_FLD_HDR_SIZE       3
1456
1457 #define PCI_VPD_RO_KEYWORD_PARTNO       "PN"
1458 #define PCI_VPD_RO_KEYWORD_MFR_ID       "MN"
1459 #define PCI_VPD_RO_KEYWORD_VENDOR0      "V0"
1460
1461 /**
1462  * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
1463  * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1464  *
1465  * Returns the extracted Large Resource Data Type length.
1466  */
1467 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
1468 {
1469         return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
1470 }
1471
1472 /**
1473  * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
1474  * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1475  *
1476  * Returns the extracted Small Resource Data Type length.
1477  */
1478 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
1479 {
1480         return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
1481 }
1482
1483 /**
1484  * pci_vpd_info_field_size - Extracts the information field length
1485  * @lrdt: Pointer to the beginning of an information field header
1486  *
1487  * Returns the extracted information field length.
1488  */
1489 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
1490 {
1491         return info_field[2];
1492 }
1493
1494 /**
1495  * pci_vpd_find_tag - Locates the Resource Data Type tag provided
1496  * @buf: Pointer to buffered vpd data
1497  * @off: The offset into the buffer at which to begin the search
1498  * @len: The length of the vpd buffer
1499  * @rdt: The Resource Data Type to search for
1500  *
1501  * Returns the index where the Resource Data Type was found or
1502  * -ENOENT otherwise.
1503  */
1504 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
1505
1506 /**
1507  * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
1508  * @buf: Pointer to buffered vpd data
1509  * @off: The offset into the buffer at which to begin the search
1510  * @len: The length of the buffer area, relative to off, in which to search
1511  * @kw: The keyword to search for
1512  *
1513  * Returns the index where the information field keyword was found or
1514  * -ENOENT otherwise.
1515  */
1516 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
1517                               unsigned int len, const char *kw);
1518
1519 #endif /* __KERNEL__ */
1520 #endif /* LINUX_PCI_H */