f1c34e4603e542f7aaa1460dbcea45bc01e0a4ce
[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 <linux/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 = PCI_NUM_RESOURCES,
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         /* Provide indication device is assigned by a Virtual Machine Manager */
178         PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) 4,
179         /* Device causes system crash if in D3 during S3 sleep */
180         PCI_DEV_FLAGS_NO_D3_DURING_SLEEP = (__force pci_dev_flags_t) 8,
181 };
182
183 enum pci_irq_reroute_variant {
184         INTEL_IRQ_REROUTE_VARIANT = 1,
185         MAX_IRQ_REROUTE_VARIANTS = 3
186 };
187
188 typedef unsigned short __bitwise pci_bus_flags_t;
189 enum pci_bus_flags {
190         PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
191         PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
192 };
193
194 /* Based on the PCI Hotplug Spec, but some values are made up by us */
195 enum pci_bus_speed {
196         PCI_SPEED_33MHz                 = 0x00,
197         PCI_SPEED_66MHz                 = 0x01,
198         PCI_SPEED_66MHz_PCIX            = 0x02,
199         PCI_SPEED_100MHz_PCIX           = 0x03,
200         PCI_SPEED_133MHz_PCIX           = 0x04,
201         PCI_SPEED_66MHz_PCIX_ECC        = 0x05,
202         PCI_SPEED_100MHz_PCIX_ECC       = 0x06,
203         PCI_SPEED_133MHz_PCIX_ECC       = 0x07,
204         PCI_SPEED_66MHz_PCIX_266        = 0x09,
205         PCI_SPEED_100MHz_PCIX_266       = 0x0a,
206         PCI_SPEED_133MHz_PCIX_266       = 0x0b,
207         AGP_UNKNOWN                     = 0x0c,
208         AGP_1X                          = 0x0d,
209         AGP_2X                          = 0x0e,
210         AGP_4X                          = 0x0f,
211         AGP_8X                          = 0x10,
212         PCI_SPEED_66MHz_PCIX_533        = 0x11,
213         PCI_SPEED_100MHz_PCIX_533       = 0x12,
214         PCI_SPEED_133MHz_PCIX_533       = 0x13,
215         PCIE_SPEED_2_5GT                = 0x14,
216         PCIE_SPEED_5_0GT                = 0x15,
217         PCIE_SPEED_8_0GT                = 0x16,
218         PCI_SPEED_UNKNOWN               = 0xff,
219 };
220
221 struct pci_cap_saved_data {
222         char cap_nr;
223         unsigned int size;
224         u32 data[0];
225 };
226
227 struct pci_cap_saved_state {
228         struct hlist_node next;
229         struct pci_cap_saved_data cap;
230 };
231
232 struct pcie_link_state;
233 struct pci_vpd;
234 struct pci_sriov;
235 struct pci_ats;
236
237 /*
238  * The pci_dev structure is used to describe PCI devices.
239  */
240 struct pci_dev {
241         struct list_head bus_list;      /* node in per-bus list */
242         struct pci_bus  *bus;           /* bus this device is on */
243         struct pci_bus  *subordinate;   /* bus this device bridges to */
244
245         void            *sysdata;       /* hook for sys-specific extension */
246         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
247         struct pci_slot *slot;          /* Physical slot this device is in */
248
249         unsigned int    devfn;          /* encoded device & function index */
250         unsigned short  vendor;
251         unsigned short  device;
252         unsigned short  subsystem_vendor;
253         unsigned short  subsystem_device;
254         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
255         u8              revision;       /* PCI revision, low byte of class word */
256         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
257         u8              pcie_cap;       /* PCI-E capability offset */
258         u8              pcie_type:4;    /* PCI-E device/port type */
259         u8              pcie_mpss:3;    /* PCI-E Max Payload Size Supported */
260         u8              rom_base_reg;   /* which config register controls the ROM */
261         u8              pin;            /* which interrupt pin this device uses */
262
263         struct pci_driver *driver;      /* which driver has allocated this device */
264         u64             dma_mask;       /* Mask of the bits of bus address this
265                                            device implements.  Normally this is
266                                            0xffffffff.  You only need to change
267                                            this if your device has broken DMA
268                                            or supports 64-bit transfers.  */
269
270         struct device_dma_parameters dma_parms;
271
272         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
273                                            this is D0-D3, D0 being fully functional,
274                                            and D3 being off. */
275         int             pm_cap;         /* PM capability offset in the
276                                            configuration space */
277         unsigned int    pme_support:5;  /* Bitmask of states from which PME#
278                                            can be generated */
279         unsigned int    pme_interrupt:1;
280         unsigned int    pme_poll:1;     /* Poll device's PME status bit */
281         unsigned int    d1_support:1;   /* Low power state D1 is supported */
282         unsigned int    d2_support:1;   /* Low power state D2 is supported */
283         unsigned int    no_d1d2:1;      /* Only allow D0 and D3 */
284         unsigned int    mmio_always_on:1;       /* disallow turning off io/mem
285                                                    decoding during bar sizing */
286         unsigned int    wakeup_prepared:1;
287         unsigned int    d3_delay;       /* D3->D0 transition time in ms */
288
289 #ifdef CONFIG_PCIEASPM
290         struct pcie_link_state  *link_state;    /* ASPM link state. */
291 #endif
292
293         pci_channel_state_t error_state;        /* current connectivity state */
294         struct  device  dev;            /* Generic device interface */
295
296         int             cfg_size;       /* Size of configuration space */
297
298         /*
299          * Instead of touching interrupt line and base address registers
300          * directly, use the values stored here. They might be different!
301          */
302         unsigned int    irq;
303         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
304
305         /* These fields are used by common fixups */
306         unsigned int    transparent:1;  /* Transparent PCI bridge */
307         unsigned int    multifunction:1;/* Part of multi-function device */
308         /* keep track of device state */
309         unsigned int    is_added:1;
310         unsigned int    is_busmaster:1; /* device is busmaster */
311         unsigned int    no_msi:1;       /* device may not use msi */
312         unsigned int    block_cfg_access:1;     /* config space access is blocked */
313         unsigned int    broken_parity_status:1; /* Device generates false positive parity */
314         unsigned int    irq_reroute_variant:2;  /* device needs IRQ rerouting variant */
315         unsigned int    msi_enabled:1;
316         unsigned int    msix_enabled:1;
317         unsigned int    ari_enabled:1;  /* ARI forwarding */
318         unsigned int    is_managed:1;
319         unsigned int    is_pcie:1;      /* Obsolete. Will be removed.
320                                            Use pci_is_pcie() instead */
321         unsigned int    needs_freset:1; /* Dev requires fundamental reset */
322         unsigned int    state_saved:1;
323         unsigned int    is_physfn:1;
324         unsigned int    is_virtfn:1;
325         unsigned int    reset_fn:1;
326         unsigned int    is_hotplug_bridge:1;
327         unsigned int    __aer_firmware_first_valid:1;
328         unsigned int    __aer_firmware_first:1;
329         pci_dev_flags_t dev_flags;
330         atomic_t        enable_cnt;     /* pci_enable_device has been called */
331
332         u32             saved_config_space[16]; /* config space saved at suspend time */
333         struct hlist_head saved_cap_space;
334         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
335         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
336         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
337         struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
338 #ifdef CONFIG_PCI_MSI
339         struct list_head msi_list;
340         struct kset *msi_kset;
341 #endif
342         struct pci_vpd *vpd;
343 #ifdef CONFIG_PCI_ATS
344         union {
345                 struct pci_sriov *sriov;        /* SR-IOV capability related */
346                 struct pci_dev *physfn; /* the PF this VF is associated with */
347         };
348         struct pci_ats  *ats;   /* Address Translation Service */
349 #endif
350 };
351
352 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
353 {
354 #ifdef CONFIG_PCI_IOV
355         if (dev->is_virtfn)
356                 dev = dev->physfn;
357 #endif
358
359         return dev;
360 }
361
362 extern struct pci_dev *alloc_pci_dev(void);
363
364 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
365 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
366 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
367
368 static inline int pci_channel_offline(struct pci_dev *pdev)
369 {
370         return (pdev->error_state != pci_channel_io_normal);
371 }
372
373 struct pci_host_bridge_window {
374         struct list_head list;
375         struct resource *res;           /* host bridge aperture (CPU address) */
376         resource_size_t offset;         /* bus address + offset = CPU address */
377 };
378
379 struct pci_host_bridge {
380         struct list_head list;
381         struct pci_bus *bus;            /* root bus */
382         struct list_head windows;       /* pci_host_bridge_windows */
383 };
384
385 static inline struct pci_cap_saved_state *pci_find_saved_cap(
386         struct pci_dev *pci_dev, char cap)
387 {
388         struct pci_cap_saved_state *tmp;
389         struct hlist_node *pos;
390
391         hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
392                 if (tmp->cap.cap_nr == cap)
393                         return tmp;
394         }
395         return NULL;
396 }
397
398 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
399         struct pci_cap_saved_state *new_cap)
400 {
401         hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
402 }
403
404 /*
405  * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
406  * to P2P or CardBus bridge windows) go in a table.  Additional ones (for
407  * buses below host bridges or subtractive decode bridges) go in the list.
408  * Use pci_bus_for_each_resource() to iterate through all the resources.
409  */
410
411 /*
412  * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
413  * and there's no way to program the bridge with the details of the window.
414  * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
415  * decode bit set, because they are explicit and can be programmed with _SRS.
416  */
417 #define PCI_SUBTRACTIVE_DECODE  0x1
418
419 struct pci_bus_resource {
420         struct list_head list;
421         struct resource *res;
422         unsigned int flags;
423 };
424
425 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
426
427 struct pci_bus {
428         struct list_head node;          /* node in list of buses */
429         struct pci_bus  *parent;        /* parent bus this bridge is on */
430         struct list_head children;      /* list of child buses */
431         struct list_head devices;       /* list of devices on this bus */
432         struct pci_dev  *self;          /* bridge device as seen by parent */
433         struct list_head slots;         /* list of slots on this bus */
434         struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
435         struct list_head resources;     /* address space routed to this bus */
436
437         struct pci_ops  *ops;           /* configuration access functions */
438         void            *sysdata;       /* hook for sys-specific extension */
439         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
440
441         unsigned char   number;         /* bus number */
442         unsigned char   primary;        /* number of primary bridge */
443         unsigned char   secondary;      /* number of secondary bridge */
444         unsigned char   subordinate;    /* max number of subordinate buses */
445         unsigned char   max_bus_speed;  /* enum pci_bus_speed */
446         unsigned char   cur_bus_speed;  /* enum pci_bus_speed */
447
448         char            name[48];
449
450         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
451         pci_bus_flags_t bus_flags;      /* Inherited by child busses */
452         struct device           *bridge;
453         struct device           dev;
454         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
455         struct bin_attribute    *legacy_mem; /* legacy mem */
456         unsigned int            is_added:1;
457 };
458
459 #define pci_bus_b(n)    list_entry(n, struct pci_bus, node)
460 #define to_pci_bus(n)   container_of(n, struct pci_bus, dev)
461
462 /*
463  * Returns true if the pci bus is root (behind host-pci bridge),
464  * false otherwise
465  */
466 static inline bool pci_is_root_bus(struct pci_bus *pbus)
467 {
468         return !(pbus->parent);
469 }
470
471 #ifdef CONFIG_PCI_MSI
472 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
473 {
474         return pci_dev->msi_enabled || pci_dev->msix_enabled;
475 }
476 #else
477 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
478 #endif
479
480 /*
481  * Error values that may be returned by PCI functions.
482  */
483 #define PCIBIOS_SUCCESSFUL              0x00
484 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
485 #define PCIBIOS_BAD_VENDOR_ID           0x83
486 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
487 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
488 #define PCIBIOS_SET_FAILED              0x88
489 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
490
491 /* Low-level architecture-dependent routines */
492
493 struct pci_ops {
494         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
495         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
496 };
497
498 /*
499  * ACPI needs to be able to access PCI config space before we've done a
500  * PCI bus scan and created pci_bus structures.
501  */
502 extern int raw_pci_read(unsigned int domain, unsigned int bus,
503                         unsigned int devfn, int reg, int len, u32 *val);
504 extern int raw_pci_write(unsigned int domain, unsigned int bus,
505                         unsigned int devfn, int reg, int len, u32 val);
506
507 struct pci_bus_region {
508         resource_size_t start;
509         resource_size_t end;
510 };
511
512 struct pci_dynids {
513         spinlock_t lock;            /* protects list, index */
514         struct list_head list;      /* for IDs added at runtime */
515 };
516
517 /* ---------------------------------------------------------------- */
518 /** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
519  *  a set of callbacks in struct pci_error_handlers, then that device driver
520  *  will be notified of PCI bus errors, and will be driven to recovery
521  *  when an error occurs.
522  */
523
524 typedef unsigned int __bitwise pci_ers_result_t;
525
526 enum pci_ers_result {
527         /* no result/none/not supported in device driver */
528         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
529
530         /* Device driver can recover without slot reset */
531         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
532
533         /* Device driver wants slot to be reset. */
534         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
535
536         /* Device has completely failed, is unrecoverable */
537         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
538
539         /* Device driver is fully recovered and operational */
540         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
541 };
542
543 /* PCI bus error event callbacks */
544 struct pci_error_handlers {
545         /* PCI bus error detected on this device */
546         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
547                                            enum pci_channel_state error);
548
549         /* MMIO has been re-enabled, but not DMA */
550         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
551
552         /* PCI Express link has been reset */
553         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
554
555         /* PCI slot has been reset */
556         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
557
558         /* Device driver may resume normal operations */
559         void (*resume)(struct pci_dev *dev);
560 };
561
562 /* ---------------------------------------------------------------- */
563
564 struct module;
565 struct pci_driver {
566         struct list_head node;
567         const char *name;
568         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
569         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
570         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
571         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
572         int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
573         int  (*resume_early) (struct pci_dev *dev);
574         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
575         void (*shutdown) (struct pci_dev *dev);
576         struct pci_error_handlers *err_handler;
577         struct device_driver    driver;
578         struct pci_dynids dynids;
579 };
580
581 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
582
583 /**
584  * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
585  * @_table: device table name
586  *
587  * This macro is used to create a struct pci_device_id array (a device table)
588  * in a generic manner.
589  */
590 #define DEFINE_PCI_DEVICE_TABLE(_table) \
591         const struct pci_device_id _table[] __devinitconst
592
593 /**
594  * PCI_DEVICE - macro used to describe a specific pci device
595  * @vend: the 16 bit PCI Vendor ID
596  * @dev: the 16 bit PCI Device ID
597  *
598  * This macro is used to create a struct pci_device_id that matches a
599  * specific device.  The subvendor and subdevice fields will be set to
600  * PCI_ANY_ID.
601  */
602 #define PCI_DEVICE(vend,dev) \
603         .vendor = (vend), .device = (dev), \
604         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
605
606 /**
607  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
608  * @dev_class: the class, subclass, prog-if triple for this device
609  * @dev_class_mask: the class mask for this device
610  *
611  * This macro is used to create a struct pci_device_id that matches a
612  * specific PCI class.  The vendor, device, subvendor, and subdevice
613  * fields will be set to PCI_ANY_ID.
614  */
615 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
616         .class = (dev_class), .class_mask = (dev_class_mask), \
617         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
618         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
619
620 /**
621  * PCI_VDEVICE - macro used to describe a specific pci device in short form
622  * @vendor: the vendor name
623  * @device: the 16 bit PCI Device ID
624  *
625  * This macro is used to create a struct pci_device_id that matches a
626  * specific PCI device.  The subvendor, and subdevice fields will be set
627  * to PCI_ANY_ID. The macro allows the next field to follow as the device
628  * private data.
629  */
630
631 #define PCI_VDEVICE(vendor, device)             \
632         PCI_VENDOR_ID_##vendor, (device),       \
633         PCI_ANY_ID, PCI_ANY_ID, 0, 0
634
635 /* these external functions are only available when PCI support is enabled */
636 #ifdef CONFIG_PCI
637
638 extern void pcie_bus_configure_settings(struct pci_bus *bus, u8 smpss);
639
640 enum pcie_bus_config_types {
641         PCIE_BUS_TUNE_OFF,
642         PCIE_BUS_SAFE,
643         PCIE_BUS_PERFORMANCE,
644         PCIE_BUS_PEER2PEER,
645 };
646
647 extern enum pcie_bus_config_types pcie_bus_config;
648
649 extern struct bus_type pci_bus_type;
650
651 /* Do NOT directly access these two variables, unless you are arch specific pci
652  * code, or pci core code. */
653 extern struct list_head pci_root_buses; /* list of all known PCI buses */
654 /* Some device drivers need know if pci is initiated */
655 extern int no_pci_devices(void);
656
657 void pcibios_fixup_bus(struct pci_bus *);
658 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
659 char *pcibios_setup(char *str);
660
661 /* Used only when drivers/pci/setup.c is used */
662 resource_size_t pcibios_align_resource(void *, const struct resource *,
663                                 resource_size_t,
664                                 resource_size_t);
665 void pcibios_update_irq(struct pci_dev *, int irq);
666
667 /* Weak but can be overriden by arch */
668 void pci_fixup_cardbus(struct pci_bus *);
669
670 /* Generic PCI functions used internally */
671
672 void pcibios_resource_to_bus(struct pci_dev *dev, struct pci_bus_region *region,
673                              struct resource *res);
674 void pcibios_bus_to_resource(struct pci_dev *dev, struct resource *res,
675                              struct pci_bus_region *region);
676 void pcibios_scan_specific_bus(int busn);
677 extern struct pci_bus *pci_find_bus(int domain, int busnr);
678 void pci_bus_add_devices(const struct pci_bus *bus);
679 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
680                                       struct pci_ops *ops, void *sysdata);
681 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
682 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
683                                     struct pci_ops *ops, void *sysdata,
684                                     struct list_head *resources);
685 struct pci_bus * __devinit pci_scan_root_bus(struct device *parent, int bus,
686                                              struct pci_ops *ops, void *sysdata,
687                                              struct list_head *resources);
688 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
689                                 int busnr);
690 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
691 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
692                                  const char *name,
693                                  struct hotplug_slot *hotplug);
694 void pci_destroy_slot(struct pci_slot *slot);
695 void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
696 int pci_scan_slot(struct pci_bus *bus, int devfn);
697 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
698 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
699 unsigned int pci_scan_child_bus(struct pci_bus *bus);
700 int __must_check pci_bus_add_device(struct pci_dev *dev);
701 void pci_read_bridge_bases(struct pci_bus *child);
702 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
703                                           struct resource *res);
704 u8 pci_swizzle_interrupt_pin(struct pci_dev *dev, u8 pin);
705 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
706 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
707 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
708 extern void pci_dev_put(struct pci_dev *dev);
709 extern void pci_remove_bus(struct pci_bus *b);
710 extern void __pci_remove_bus_device(struct pci_dev *dev);
711 extern void pci_stop_and_remove_bus_device(struct pci_dev *dev);
712 extern void pci_stop_bus_device(struct pci_dev *dev);
713 void pci_setup_cardbus(struct pci_bus *bus);
714 extern void pci_sort_breadthfirst(void);
715 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
716 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
717 #define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
718
719 /* Generic PCI functions exported to card drivers */
720
721 enum pci_lost_interrupt_reason {
722         PCI_LOST_IRQ_NO_INFORMATION = 0,
723         PCI_LOST_IRQ_DISABLE_MSI,
724         PCI_LOST_IRQ_DISABLE_MSIX,
725         PCI_LOST_IRQ_DISABLE_ACPI,
726 };
727 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
728 int pci_find_capability(struct pci_dev *dev, int cap);
729 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
730 int pci_find_ext_capability(struct pci_dev *dev, int cap);
731 int pci_bus_find_ext_capability(struct pci_bus *bus, unsigned int devfn,
732                                 int cap);
733 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
734 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
735 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
736
737 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
738                                 struct pci_dev *from);
739 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
740                                 unsigned int ss_vendor, unsigned int ss_device,
741                                 struct pci_dev *from);
742 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
743 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
744                                             unsigned int devfn);
745 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
746                                                    unsigned int devfn)
747 {
748         return pci_get_domain_bus_and_slot(0, bus, devfn);
749 }
750 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
751 int pci_dev_present(const struct pci_device_id *ids);
752
753 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
754                              int where, u8 *val);
755 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
756                              int where, u16 *val);
757 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
758                               int where, u32 *val);
759 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
760                               int where, u8 val);
761 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
762                               int where, u16 val);
763 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
764                                int where, u32 val);
765 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
766
767 static inline int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
768 {
769         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
770 }
771 static inline int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
772 {
773         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
774 }
775 static inline int pci_read_config_dword(const struct pci_dev *dev, int where,
776                                         u32 *val)
777 {
778         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
779 }
780 static inline int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
781 {
782         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
783 }
784 static inline int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
785 {
786         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
787 }
788 static inline int pci_write_config_dword(const struct pci_dev *dev, int where,
789                                          u32 val)
790 {
791         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
792 }
793
794 int __must_check pci_enable_device(struct pci_dev *dev);
795 int __must_check pci_enable_device_io(struct pci_dev *dev);
796 int __must_check pci_enable_device_mem(struct pci_dev *dev);
797 int __must_check pci_reenable_device(struct pci_dev *);
798 int __must_check pcim_enable_device(struct pci_dev *pdev);
799 void pcim_pin_device(struct pci_dev *pdev);
800
801 static inline int pci_is_enabled(struct pci_dev *pdev)
802 {
803         return (atomic_read(&pdev->enable_cnt) > 0);
804 }
805
806 static inline int pci_is_managed(struct pci_dev *pdev)
807 {
808         return pdev->is_managed;
809 }
810
811 void pci_disable_device(struct pci_dev *dev);
812
813 extern unsigned int pcibios_max_latency;
814 void pci_set_master(struct pci_dev *dev);
815 void pci_clear_master(struct pci_dev *dev);
816
817 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
818 int pci_set_cacheline_size(struct pci_dev *dev);
819 #define HAVE_PCI_SET_MWI
820 int __must_check pci_set_mwi(struct pci_dev *dev);
821 int pci_try_set_mwi(struct pci_dev *dev);
822 void pci_clear_mwi(struct pci_dev *dev);
823 void pci_intx(struct pci_dev *dev, int enable);
824 bool pci_intx_mask_supported(struct pci_dev *dev);
825 bool pci_check_and_mask_intx(struct pci_dev *dev);
826 bool pci_check_and_unmask_intx(struct pci_dev *dev);
827 void pci_msi_off(struct pci_dev *dev);
828 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
829 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
830 int pcix_get_max_mmrbc(struct pci_dev *dev);
831 int pcix_get_mmrbc(struct pci_dev *dev);
832 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
833 int pcie_get_readrq(struct pci_dev *dev);
834 int pcie_set_readrq(struct pci_dev *dev, int rq);
835 int pcie_get_mps(struct pci_dev *dev);
836 int pcie_set_mps(struct pci_dev *dev, int mps);
837 int __pci_reset_function(struct pci_dev *dev);
838 int __pci_reset_function_locked(struct pci_dev *dev);
839 int pci_reset_function(struct pci_dev *dev);
840 void pci_update_resource(struct pci_dev *dev, int resno);
841 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
842 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
843 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
844
845 /* ROM control related routines */
846 int pci_enable_rom(struct pci_dev *pdev);
847 void pci_disable_rom(struct pci_dev *pdev);
848 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
849 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
850 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
851
852 /* Power management related routines */
853 int pci_save_state(struct pci_dev *dev);
854 void pci_restore_state(struct pci_dev *dev);
855 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
856 int pci_load_saved_state(struct pci_dev *dev, struct pci_saved_state *state);
857 int pci_load_and_free_saved_state(struct pci_dev *dev,
858                                   struct pci_saved_state **state);
859 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
860 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
861 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
862 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
863 void pci_pme_active(struct pci_dev *dev, bool enable);
864 int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
865                       bool runtime, bool enable);
866 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
867 pci_power_t pci_target_state(struct pci_dev *dev);
868 int pci_prepare_to_sleep(struct pci_dev *dev);
869 int pci_back_from_sleep(struct pci_dev *dev);
870 bool pci_dev_run_wake(struct pci_dev *dev);
871 bool pci_check_pme_status(struct pci_dev *dev);
872 void pci_pme_wakeup_bus(struct pci_bus *bus);
873
874 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
875                                   bool enable)
876 {
877         return __pci_enable_wake(dev, state, false, enable);
878 }
879
880 #define PCI_EXP_IDO_REQUEST     (1<<0)
881 #define PCI_EXP_IDO_COMPLETION  (1<<1)
882 void pci_enable_ido(struct pci_dev *dev, unsigned long type);
883 void pci_disable_ido(struct pci_dev *dev, unsigned long type);
884
885 enum pci_obff_signal_type {
886         PCI_EXP_OBFF_SIGNAL_L0 = 0,
887         PCI_EXP_OBFF_SIGNAL_ALWAYS = 1,
888 };
889 int pci_enable_obff(struct pci_dev *dev, enum pci_obff_signal_type);
890 void pci_disable_obff(struct pci_dev *dev);
891
892 bool pci_ltr_supported(struct pci_dev *dev);
893 int pci_enable_ltr(struct pci_dev *dev);
894 void pci_disable_ltr(struct pci_dev *dev);
895 int pci_set_ltr(struct pci_dev *dev, int snoop_lat_ns, int nosnoop_lat_ns);
896
897 /* For use by arch with custom probe code */
898 void set_pcie_port_type(struct pci_dev *pdev);
899 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
900
901 /* Functions for PCI Hotplug drivers to use */
902 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
903 #ifdef CONFIG_HOTPLUG
904 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
905 unsigned int pci_rescan_bus(struct pci_bus *bus);
906 #endif
907
908 /* Vital product data routines */
909 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
910 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
911 int pci_vpd_truncate(struct pci_dev *dev, size_t size);
912
913 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
914 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
915 void pci_bus_assign_resources(const struct pci_bus *bus);
916 void pci_bus_size_bridges(struct pci_bus *bus);
917 int pci_claim_resource(struct pci_dev *, int);
918 void pci_assign_unassigned_resources(void);
919 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
920 void pdev_enable_device(struct pci_dev *);
921 int pci_enable_resources(struct pci_dev *, int mask);
922 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
923                     int (*)(const struct pci_dev *, u8, u8));
924 #define HAVE_PCI_REQ_REGIONS    2
925 int __must_check pci_request_regions(struct pci_dev *, const char *);
926 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
927 void pci_release_regions(struct pci_dev *);
928 int __must_check pci_request_region(struct pci_dev *, int, const char *);
929 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
930 void pci_release_region(struct pci_dev *, int);
931 int pci_request_selected_regions(struct pci_dev *, int, const char *);
932 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
933 void pci_release_selected_regions(struct pci_dev *, int);
934
935 /* drivers/pci/bus.c */
936 void pci_add_resource(struct list_head *resources, struct resource *res);
937 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
938                              resource_size_t offset);
939 void pci_free_resource_list(struct list_head *resources);
940 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
941 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
942 void pci_bus_remove_resources(struct pci_bus *bus);
943
944 #define pci_bus_for_each_resource(bus, res, i)                          \
945         for (i = 0;                                                     \
946             (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
947              i++)
948
949 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
950                         struct resource *res, resource_size_t size,
951                         resource_size_t align, resource_size_t min,
952                         unsigned int type_mask,
953                         resource_size_t (*alignf)(void *,
954                                                   const struct resource *,
955                                                   resource_size_t,
956                                                   resource_size_t),
957                         void *alignf_data);
958 void pci_enable_bridges(struct pci_bus *bus);
959
960 /* Proper probing supporting hot-pluggable devices */
961 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
962                                        const char *mod_name);
963
964 /*
965  * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
966  */
967 #define pci_register_driver(driver)             \
968         __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
969
970 void pci_unregister_driver(struct pci_driver *dev);
971
972 /**
973  * module_pci_driver() - Helper macro for registering a PCI driver
974  * @__pci_driver: pci_driver struct
975  *
976  * Helper macro for PCI drivers which do not do anything special in module
977  * init/exit. This eliminates a lot of boilerplate. Each module may only
978  * use this macro once, and calling it replaces module_init() and module_exit()
979  */
980 #define module_pci_driver(__pci_driver) \
981         module_driver(__pci_driver, pci_register_driver, \
982                        pci_unregister_driver)
983
984 void pci_stop_and_remove_behind_bridge(struct pci_dev *dev);
985 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
986 int pci_add_dynid(struct pci_driver *drv,
987                   unsigned int vendor, unsigned int device,
988                   unsigned int subvendor, unsigned int subdevice,
989                   unsigned int class, unsigned int class_mask,
990                   unsigned long driver_data);
991 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
992                                          struct pci_dev *dev);
993 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
994                     int pass);
995
996 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
997                   void *userdata);
998 int pci_cfg_space_size_ext(struct pci_dev *dev);
999 int pci_cfg_space_size(struct pci_dev *dev);
1000 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1001 void pci_setup_bridge(struct pci_bus *bus);
1002
1003 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1004 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1005
1006 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1007                       unsigned int command_bits, u32 flags);
1008 /* kmem_cache style wrapper around pci_alloc_consistent() */
1009
1010 #include <linux/pci-dma.h>
1011 #include <linux/dmapool.h>
1012
1013 #define pci_pool dma_pool
1014 #define pci_pool_create(name, pdev, size, align, allocation) \
1015                 dma_pool_create(name, &pdev->dev, size, align, allocation)
1016 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1017 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1018 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1019
1020 enum pci_dma_burst_strategy {
1021         PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
1022                                    strategy_parameter is N/A */
1023         PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
1024                                    byte boundaries */
1025         PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
1026                                    strategy_parameter byte boundaries */
1027 };
1028
1029 struct msix_entry {
1030         u32     vector; /* kernel uses to write allocated vector */
1031         u16     entry;  /* driver uses to specify entry, OS writes */
1032 };
1033
1034
1035 #ifndef CONFIG_PCI_MSI
1036 static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
1037 {
1038         return -1;
1039 }
1040
1041 static inline void pci_msi_shutdown(struct pci_dev *dev)
1042 { }
1043 static inline void pci_disable_msi(struct pci_dev *dev)
1044 { }
1045
1046 static inline int pci_msix_table_size(struct pci_dev *dev)
1047 {
1048         return 0;
1049 }
1050 static inline int pci_enable_msix(struct pci_dev *dev,
1051                                   struct msix_entry *entries, int nvec)
1052 {
1053         return -1;
1054 }
1055
1056 static inline void pci_msix_shutdown(struct pci_dev *dev)
1057 { }
1058 static inline void pci_disable_msix(struct pci_dev *dev)
1059 { }
1060
1061 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
1062 { }
1063
1064 static inline void pci_restore_msi_state(struct pci_dev *dev)
1065 { }
1066 static inline int pci_msi_enabled(void)
1067 {
1068         return 0;
1069 }
1070 #else
1071 extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
1072 extern void pci_msi_shutdown(struct pci_dev *dev);
1073 extern void pci_disable_msi(struct pci_dev *dev);
1074 extern int pci_msix_table_size(struct pci_dev *dev);
1075 extern int pci_enable_msix(struct pci_dev *dev,
1076         struct msix_entry *entries, int nvec);
1077 extern void pci_msix_shutdown(struct pci_dev *dev);
1078 extern void pci_disable_msix(struct pci_dev *dev);
1079 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
1080 extern void pci_restore_msi_state(struct pci_dev *dev);
1081 extern int pci_msi_enabled(void);
1082 #endif
1083
1084 #ifdef CONFIG_PCIEPORTBUS
1085 extern bool pcie_ports_disabled;
1086 extern bool pcie_ports_auto;
1087 #else
1088 #define pcie_ports_disabled     true
1089 #define pcie_ports_auto         false
1090 #endif
1091
1092 #ifndef CONFIG_PCIEASPM
1093 static inline int pcie_aspm_enabled(void) { return 0; }
1094 static inline bool pcie_aspm_support_enabled(void) { return false; }
1095 #else
1096 extern int pcie_aspm_enabled(void);
1097 extern bool pcie_aspm_support_enabled(void);
1098 #endif
1099
1100 #ifdef CONFIG_PCIEAER
1101 void pci_no_aer(void);
1102 bool pci_aer_available(void);
1103 #else
1104 static inline void pci_no_aer(void) { }
1105 static inline bool pci_aer_available(void) { return false; }
1106 #endif
1107
1108 #ifndef CONFIG_PCIE_ECRC
1109 static inline void pcie_set_ecrc_checking(struct pci_dev *dev)
1110 {
1111         return;
1112 }
1113 static inline void pcie_ecrc_get_policy(char *str) {};
1114 #else
1115 extern void pcie_set_ecrc_checking(struct pci_dev *dev);
1116 extern void pcie_ecrc_get_policy(char *str);
1117 #endif
1118
1119 #define pci_enable_msi(pdev)    pci_enable_msi_block(pdev, 1)
1120
1121 #ifdef CONFIG_HT_IRQ
1122 /* The functions a driver should call */
1123 int  ht_create_irq(struct pci_dev *dev, int idx);
1124 void ht_destroy_irq(unsigned int irq);
1125 #endif /* CONFIG_HT_IRQ */
1126
1127 extern void pci_cfg_access_lock(struct pci_dev *dev);
1128 extern bool pci_cfg_access_trylock(struct pci_dev *dev);
1129 extern void pci_cfg_access_unlock(struct pci_dev *dev);
1130
1131 /*
1132  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
1133  * a PCI domain is defined to be a set of PCI busses which share
1134  * configuration space.
1135  */
1136 #ifdef CONFIG_PCI_DOMAINS
1137 extern int pci_domains_supported;
1138 #else
1139 enum { pci_domains_supported = 0 };
1140 static inline int pci_domain_nr(struct pci_bus *bus)
1141 {
1142         return 0;
1143 }
1144
1145 static inline int pci_proc_domain(struct pci_bus *bus)
1146 {
1147         return 0;
1148 }
1149 #endif /* CONFIG_PCI_DOMAINS */
1150
1151 /* some architectures require additional setup to direct VGA traffic */
1152 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1153                       unsigned int command_bits, u32 flags);
1154 extern void pci_register_set_vga_state(arch_set_vga_state_t func);
1155
1156 #else /* CONFIG_PCI is not enabled */
1157
1158 /*
1159  *  If the system does not have PCI, clearly these return errors.  Define
1160  *  these as simple inline functions to avoid hair in drivers.
1161  */
1162
1163 #define _PCI_NOP(o, s, t) \
1164         static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1165                                                 int where, t val) \
1166                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1167
1168 #define _PCI_NOP_ALL(o, x)      _PCI_NOP(o, byte, u8 x) \
1169                                 _PCI_NOP(o, word, u16 x) \
1170                                 _PCI_NOP(o, dword, u32 x)
1171 _PCI_NOP_ALL(read, *)
1172 _PCI_NOP_ALL(write,)
1173
1174 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1175                                              unsigned int device,
1176                                              struct pci_dev *from)
1177 {
1178         return NULL;
1179 }
1180
1181 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1182                                              unsigned int device,
1183                                              unsigned int ss_vendor,
1184                                              unsigned int ss_device,
1185                                              struct pci_dev *from)
1186 {
1187         return NULL;
1188 }
1189
1190 static inline struct pci_dev *pci_get_class(unsigned int class,
1191                                             struct pci_dev *from)
1192 {
1193         return NULL;
1194 }
1195
1196 #define pci_dev_present(ids)    (0)
1197 #define no_pci_devices()        (1)
1198 #define pci_dev_put(dev)        do { } while (0)
1199
1200 static inline void pci_set_master(struct pci_dev *dev)
1201 { }
1202
1203 static inline int pci_enable_device(struct pci_dev *dev)
1204 {
1205         return -EIO;
1206 }
1207
1208 static inline void pci_disable_device(struct pci_dev *dev)
1209 { }
1210
1211 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
1212 {
1213         return -EIO;
1214 }
1215
1216 static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
1217 {
1218         return -EIO;
1219 }
1220
1221 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
1222                                         unsigned int size)
1223 {
1224         return -EIO;
1225 }
1226
1227 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
1228                                         unsigned long mask)
1229 {
1230         return -EIO;
1231 }
1232
1233 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1234 {
1235         return -EBUSY;
1236 }
1237
1238 static inline int __pci_register_driver(struct pci_driver *drv,
1239                                         struct module *owner)
1240 {
1241         return 0;
1242 }
1243
1244 static inline int pci_register_driver(struct pci_driver *drv)
1245 {
1246         return 0;
1247 }
1248
1249 static inline void pci_unregister_driver(struct pci_driver *drv)
1250 { }
1251
1252 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1253 {
1254         return 0;
1255 }
1256
1257 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1258                                            int cap)
1259 {
1260         return 0;
1261 }
1262
1263 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1264 {
1265         return 0;
1266 }
1267
1268 /* Power management related routines */
1269 static inline int pci_save_state(struct pci_dev *dev)
1270 {
1271         return 0;
1272 }
1273
1274 static inline void pci_restore_state(struct pci_dev *dev)
1275 { }
1276
1277 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1278 {
1279         return 0;
1280 }
1281
1282 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1283 {
1284         return 0;
1285 }
1286
1287 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1288                                            pm_message_t state)
1289 {
1290         return PCI_D0;
1291 }
1292
1293 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1294                                   int enable)
1295 {
1296         return 0;
1297 }
1298
1299 static inline void pci_enable_ido(struct pci_dev *dev, unsigned long type)
1300 {
1301 }
1302
1303 static inline void pci_disable_ido(struct pci_dev *dev, unsigned long type)
1304 {
1305 }
1306
1307 static inline int pci_enable_obff(struct pci_dev *dev, unsigned long type)
1308 {
1309         return 0;
1310 }
1311
1312 static inline void pci_disable_obff(struct pci_dev *dev)
1313 {
1314 }
1315
1316 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1317 {
1318         return -EIO;
1319 }
1320
1321 static inline void pci_release_regions(struct pci_dev *dev)
1322 { }
1323
1324 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1325
1326 static inline void pci_block_cfg_access(struct pci_dev *dev)
1327 { }
1328
1329 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1330 { return 0; }
1331
1332 static inline void pci_unblock_cfg_access(struct pci_dev *dev)
1333 { }
1334
1335 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1336 { return NULL; }
1337
1338 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1339                                                 unsigned int devfn)
1340 { return NULL; }
1341
1342 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1343                                                 unsigned int devfn)
1344 { return NULL; }
1345
1346 static inline int pci_domain_nr(struct pci_bus *bus)
1347 { return 0; }
1348
1349 #define dev_is_pci(d) (false)
1350 #define dev_is_pf(d) (false)
1351 #define dev_num_vf(d) (0)
1352 #endif /* CONFIG_PCI */
1353
1354 /* Include architecture-dependent settings and functions */
1355
1356 #include <asm/pci.h>
1357
1358 #ifndef PCIBIOS_MAX_MEM_32
1359 #define PCIBIOS_MAX_MEM_32 (-1)
1360 #endif
1361
1362 /* these helpers provide future and backwards compatibility
1363  * for accessing popular PCI BAR info */
1364 #define pci_resource_start(dev, bar)    ((dev)->resource[(bar)].start)
1365 #define pci_resource_end(dev, bar)      ((dev)->resource[(bar)].end)
1366 #define pci_resource_flags(dev, bar)    ((dev)->resource[(bar)].flags)
1367 #define pci_resource_len(dev,bar) \
1368         ((pci_resource_start((dev), (bar)) == 0 &&      \
1369           pci_resource_end((dev), (bar)) ==             \
1370           pci_resource_start((dev), (bar))) ? 0 :       \
1371                                                         \
1372          (pci_resource_end((dev), (bar)) -              \
1373           pci_resource_start((dev), (bar)) + 1))
1374
1375 /* Similar to the helpers above, these manipulate per-pci_dev
1376  * driver-specific data.  They are really just a wrapper around
1377  * the generic device structure functions of these calls.
1378  */
1379 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1380 {
1381         return dev_get_drvdata(&pdev->dev);
1382 }
1383
1384 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1385 {
1386         dev_set_drvdata(&pdev->dev, data);
1387 }
1388
1389 /* If you want to know what to call your pci_dev, ask this function.
1390  * Again, it's a wrapper around the generic device.
1391  */
1392 static inline const char *pci_name(const struct pci_dev *pdev)
1393 {
1394         return dev_name(&pdev->dev);
1395 }
1396
1397
1398 /* Some archs don't want to expose struct resource to userland as-is
1399  * in sysfs and /proc
1400  */
1401 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1402 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1403                 const struct resource *rsrc, resource_size_t *start,
1404                 resource_size_t *end)
1405 {
1406         *start = rsrc->start;
1407         *end = rsrc->end;
1408 }
1409 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1410
1411
1412 /*
1413  *  The world is not perfect and supplies us with broken PCI devices.
1414  *  For at least a part of these bugs we need a work-around, so both
1415  *  generic (drivers/pci/quirks.c) and per-architecture code can define
1416  *  fixup hooks to be called for particular buggy devices.
1417  */
1418
1419 struct pci_fixup {
1420         u16 vendor;             /* You can use PCI_ANY_ID here of course */
1421         u16 device;             /* You can use PCI_ANY_ID here of course */
1422         u32 class;              /* You can use PCI_ANY_ID here too */
1423         unsigned int class_shift;       /* should be 0, 8, 16 */
1424         void (*hook)(struct pci_dev *dev);
1425 };
1426
1427 enum pci_fixup_pass {
1428         pci_fixup_early,        /* Before probing BARs */
1429         pci_fixup_header,       /* After reading configuration header */
1430         pci_fixup_final,        /* Final phase of device fixups */
1431         pci_fixup_enable,       /* pci_enable_device() time */
1432         pci_fixup_resume,       /* pci_device_resume() */
1433         pci_fixup_suspend,      /* pci_device_suspend */
1434         pci_fixup_resume_early, /* pci_device_resume_early() */
1435 };
1436
1437 /* Anonymous variables would be nice... */
1438 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1439                                   class_shift, hook)                    \
1440         static const struct pci_fixup const __pci_fixup_##name __used   \
1441         __attribute__((__section__(#section), aligned((sizeof(void *)))))    \
1442                 = { vendor, device, class, class_shift, hook };
1443
1444 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class,            \
1445                                          class_shift, hook)             \
1446         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1447                 vendor##device##hook, vendor, device, class, class_shift, hook)
1448 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class,           \
1449                                          class_shift, hook)             \
1450         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1451                 vendor##device##hook, vendor, device, class, class_shift, hook)
1452 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class,            \
1453                                          class_shift, hook)             \
1454         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1455                 vendor##device##hook, vendor, device, class, class_shift, hook)
1456 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class,           \
1457                                          class_shift, hook)             \
1458         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1459                 vendor##device##hook, vendor, device, class, class_shift, hook)
1460 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class,           \
1461                                          class_shift, hook)             \
1462         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1463                 resume##vendor##device##hook, vendor, device, class,    \
1464                 class_shift, hook)
1465 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class,     \
1466                                          class_shift, hook)             \
1467         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,              \
1468                 resume_early##vendor##device##hook, vendor, device,     \
1469                 class, class_shift, hook)
1470 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class,          \
1471                                          class_shift, hook)             \
1472         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,                   \
1473                 suspend##vendor##device##hook, vendor, device, class,   \
1474                 class_shift, hook)
1475
1476 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
1477         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1478                 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1479 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
1480         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1481                 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1482 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
1483         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1484                 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1485 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
1486         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1487                 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1488 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)                  \
1489         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1490                 resume##vendor##device##hook, vendor, device,           \
1491                 PCI_ANY_ID, 0, hook)
1492 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)            \
1493         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,              \
1494                 resume_early##vendor##device##hook, vendor, device,     \
1495                 PCI_ANY_ID, 0, hook)
1496 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)                 \
1497         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,                   \
1498                 suspend##vendor##device##hook, vendor, device,          \
1499                 PCI_ANY_ID, 0, hook)
1500
1501 #ifdef CONFIG_PCI_QUIRKS
1502 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1503 #else
1504 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1505                                     struct pci_dev *dev) {}
1506 #endif
1507
1508 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1509 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1510 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1511 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1512 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1513                                    const char *name);
1514 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
1515
1516 extern int pci_pci_problems;
1517 #define PCIPCI_FAIL             1       /* No PCI PCI DMA */
1518 #define PCIPCI_TRITON           2
1519 #define PCIPCI_NATOMA           4
1520 #define PCIPCI_VIAETBF          8
1521 #define PCIPCI_VSFX             16
1522 #define PCIPCI_ALIMAGIK         32      /* Need low latency setting */
1523 #define PCIAGP_FAIL             64      /* No PCI to AGP DMA */
1524
1525 extern unsigned long pci_cardbus_io_size;
1526 extern unsigned long pci_cardbus_mem_size;
1527 extern u8 __devinitdata pci_dfl_cache_line_size;
1528 extern u8 pci_cache_line_size;
1529
1530 extern unsigned long pci_hotplug_io_size;
1531 extern unsigned long pci_hotplug_mem_size;
1532
1533 /* Architecture specific versions may override these (weak) */
1534 int pcibios_add_platform_entries(struct pci_dev *dev);
1535 void pcibios_disable_device(struct pci_dev *dev);
1536 void pcibios_set_master(struct pci_dev *dev);
1537 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1538                                  enum pcie_reset_state state);
1539
1540 #ifdef CONFIG_PCI_MMCONFIG
1541 extern void __init pci_mmcfg_early_init(void);
1542 extern void __init pci_mmcfg_late_init(void);
1543 #else
1544 static inline void pci_mmcfg_early_init(void) { }
1545 static inline void pci_mmcfg_late_init(void) { }
1546 #endif
1547
1548 int pci_ext_cfg_avail(struct pci_dev *dev);
1549
1550 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1551
1552 #ifdef CONFIG_PCI_IOV
1553 extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1554 extern void pci_disable_sriov(struct pci_dev *dev);
1555 extern irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1556 extern int pci_num_vf(struct pci_dev *dev);
1557 #else
1558 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1559 {
1560         return -ENODEV;
1561 }
1562 static inline void pci_disable_sriov(struct pci_dev *dev)
1563 {
1564 }
1565 static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
1566 {
1567         return IRQ_NONE;
1568 }
1569 static inline int pci_num_vf(struct pci_dev *dev)
1570 {
1571         return 0;
1572 }
1573 #endif
1574
1575 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1576 extern void pci_hp_create_module_link(struct pci_slot *pci_slot);
1577 extern void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1578 #endif
1579
1580 /**
1581  * pci_pcie_cap - get the saved PCIe capability offset
1582  * @dev: PCI device
1583  *
1584  * PCIe capability offset is calculated at PCI device initialization
1585  * time and saved in the data structure. This function returns saved
1586  * PCIe capability offset. Using this instead of pci_find_capability()
1587  * reduces unnecessary search in the PCI configuration space. If you
1588  * need to calculate PCIe capability offset from raw device for some
1589  * reasons, please use pci_find_capability() instead.
1590  */
1591 static inline int pci_pcie_cap(struct pci_dev *dev)
1592 {
1593         return dev->pcie_cap;
1594 }
1595
1596 /**
1597  * pci_is_pcie - check if the PCI device is PCI Express capable
1598  * @dev: PCI device
1599  *
1600  * Retrun true if the PCI device is PCI Express capable, false otherwise.
1601  */
1602 static inline bool pci_is_pcie(struct pci_dev *dev)
1603 {
1604         return !!pci_pcie_cap(dev);
1605 }
1606
1607 void pci_request_acs(void);
1608
1609
1610 #define PCI_VPD_LRDT                    0x80    /* Large Resource Data Type */
1611 #define PCI_VPD_LRDT_ID(x)              (x | PCI_VPD_LRDT)
1612
1613 /* Large Resource Data Type Tag Item Names */
1614 #define PCI_VPD_LTIN_ID_STRING          0x02    /* Identifier String */
1615 #define PCI_VPD_LTIN_RO_DATA            0x10    /* Read-Only Data */
1616 #define PCI_VPD_LTIN_RW_DATA            0x11    /* Read-Write Data */
1617
1618 #define PCI_VPD_LRDT_ID_STRING          PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
1619 #define PCI_VPD_LRDT_RO_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
1620 #define PCI_VPD_LRDT_RW_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
1621
1622 /* Small Resource Data Type Tag Item Names */
1623 #define PCI_VPD_STIN_END                0x78    /* End */
1624
1625 #define PCI_VPD_SRDT_END                PCI_VPD_STIN_END
1626
1627 #define PCI_VPD_SRDT_TIN_MASK           0x78
1628 #define PCI_VPD_SRDT_LEN_MASK           0x07
1629
1630 #define PCI_VPD_LRDT_TAG_SIZE           3
1631 #define PCI_VPD_SRDT_TAG_SIZE           1
1632
1633 #define PCI_VPD_INFO_FLD_HDR_SIZE       3
1634
1635 #define PCI_VPD_RO_KEYWORD_PARTNO       "PN"
1636 #define PCI_VPD_RO_KEYWORD_MFR_ID       "MN"
1637 #define PCI_VPD_RO_KEYWORD_VENDOR0      "V0"
1638 #define PCI_VPD_RO_KEYWORD_CHKSUM       "RV"
1639
1640 /**
1641  * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
1642  * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1643  *
1644  * Returns the extracted Large Resource Data Type length.
1645  */
1646 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
1647 {
1648         return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
1649 }
1650
1651 /**
1652  * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
1653  * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1654  *
1655  * Returns the extracted Small Resource Data Type length.
1656  */
1657 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
1658 {
1659         return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
1660 }
1661
1662 /**
1663  * pci_vpd_info_field_size - Extracts the information field length
1664  * @lrdt: Pointer to the beginning of an information field header
1665  *
1666  * Returns the extracted information field length.
1667  */
1668 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
1669 {
1670         return info_field[2];
1671 }
1672
1673 /**
1674  * pci_vpd_find_tag - Locates the Resource Data Type tag provided
1675  * @buf: Pointer to buffered vpd data
1676  * @off: The offset into the buffer at which to begin the search
1677  * @len: The length of the vpd buffer
1678  * @rdt: The Resource Data Type to search for
1679  *
1680  * Returns the index where the Resource Data Type was found or
1681  * -ENOENT otherwise.
1682  */
1683 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
1684
1685 /**
1686  * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
1687  * @buf: Pointer to buffered vpd data
1688  * @off: The offset into the buffer at which to begin the search
1689  * @len: The length of the buffer area, relative to off, in which to search
1690  * @kw: The keyword to search for
1691  *
1692  * Returns the index where the information field keyword was found or
1693  * -ENOENT otherwise.
1694  */
1695 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
1696                               unsigned int len, const char *kw);
1697
1698 /* PCI <-> OF binding helpers */
1699 #ifdef CONFIG_OF
1700 struct device_node;
1701 extern void pci_set_of_node(struct pci_dev *dev);
1702 extern void pci_release_of_node(struct pci_dev *dev);
1703 extern void pci_set_bus_of_node(struct pci_bus *bus);
1704 extern void pci_release_bus_of_node(struct pci_bus *bus);
1705
1706 /* Arch may override this (weak) */
1707 extern struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus);
1708
1709 static inline struct device_node *pci_device_to_OF_node(struct pci_dev *pdev)
1710 {
1711         return pdev ? pdev->dev.of_node : NULL;
1712 }
1713
1714 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
1715 {
1716         return bus ? bus->dev.of_node : NULL;
1717 }
1718
1719 #else /* CONFIG_OF */
1720 static inline void pci_set_of_node(struct pci_dev *dev) { }
1721 static inline void pci_release_of_node(struct pci_dev *dev) { }
1722 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
1723 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
1724 #endif  /* CONFIG_OF */
1725
1726 #ifdef CONFIG_EEH
1727 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
1728 {
1729         return pdev->dev.archdata.edev;
1730 }
1731 #endif
1732
1733 /**
1734  * pci_find_upstream_pcie_bridge - find upstream PCIe-to-PCI bridge of a device
1735  * @pdev: the PCI device
1736  *
1737  * if the device is PCIE, return NULL
1738  * if the device isn't connected to a PCIe bridge (that is its parent is a
1739  * legacy PCI bridge and the bridge is directly connected to bus 0), return its
1740  * parent
1741  */
1742 struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
1743
1744 #endif /* __KERNEL__ */
1745 #endif /* LINUX_PCI_H */