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