Merge branch 'pci/host-designware' into next
[cascardo/linux.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 #ifndef LINUX_PCI_H
17 #define LINUX_PCI_H
18
19
20 #include <linux/mod_devicetable.h>
21
22 #include <linux/types.h>
23 #include <linux/init.h>
24 #include <linux/ioport.h>
25 #include <linux/list.h>
26 #include <linux/compiler.h>
27 #include <linux/errno.h>
28 #include <linux/kobject.h>
29 #include <linux/atomic.h>
30 #include <linux/device.h>
31 #include <linux/io.h>
32 #include <linux/resource_ext.h>
33 #include <uapi/linux/pci.h>
34
35 #include <linux/pci_ids.h>
36
37 /*
38  * The PCI interface treats multi-function devices as independent
39  * devices.  The slot/function address of each device is encoded
40  * in a single byte as follows:
41  *
42  *      7:3 = slot
43  *      2:0 = function
44  *
45  * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
46  * In the interest of not exposing interfaces to user-space unnecessarily,
47  * the following kernel-only defines are being added here.
48  */
49 #define PCI_DEVID(bus, devfn)  ((((u16)(bus)) << 8) | (devfn))
50 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
51 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
52
53 /* pci_slot represents a physical slot */
54 struct pci_slot {
55         struct pci_bus *bus;            /* The bus this slot is on */
56         struct list_head list;          /* node in list of slots on this bus */
57         struct hotplug_slot *hotplug;   /* Hotplug info (migrate over time) */
58         unsigned char number;           /* PCI_SLOT(pci_dev->devfn) */
59         struct kobject kobj;
60 };
61
62 static inline const char *pci_slot_name(const struct pci_slot *slot)
63 {
64         return kobject_name(&slot->kobj);
65 }
66
67 /* File state for mmap()s on /proc/bus/pci/X/Y */
68 enum pci_mmap_state {
69         pci_mmap_io,
70         pci_mmap_mem
71 };
72
73 /*
74  *  For PCI devices, the region numbers are assigned this way:
75  */
76 enum {
77         /* #0-5: standard PCI resources */
78         PCI_STD_RESOURCES,
79         PCI_STD_RESOURCE_END = 5,
80
81         /* #6: expansion ROM resource */
82         PCI_ROM_RESOURCE,
83
84         /* device specific resources */
85 #ifdef CONFIG_PCI_IOV
86         PCI_IOV_RESOURCES,
87         PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
88 #endif
89
90         /* resources assigned to buses behind the bridge */
91 #define PCI_BRIDGE_RESOURCE_NUM 4
92
93         PCI_BRIDGE_RESOURCES,
94         PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
95                                   PCI_BRIDGE_RESOURCE_NUM - 1,
96
97         /* total resources associated with a PCI device */
98         PCI_NUM_RESOURCES,
99
100         /* preserve this for compatibility */
101         DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
102 };
103
104 typedef int __bitwise pci_power_t;
105
106 #define PCI_D0          ((pci_power_t __force) 0)
107 #define PCI_D1          ((pci_power_t __force) 1)
108 #define PCI_D2          ((pci_power_t __force) 2)
109 #define PCI_D3hot       ((pci_power_t __force) 3)
110 #define PCI_D3cold      ((pci_power_t __force) 4)
111 #define PCI_UNKNOWN     ((pci_power_t __force) 5)
112 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
113
114 /* Remember to update this when the list above changes! */
115 extern const char *pci_power_names[];
116
117 static inline const char *pci_power_name(pci_power_t state)
118 {
119         return pci_power_names[1 + (int) state];
120 }
121
122 #define PCI_PM_D2_DELAY         200
123 #define PCI_PM_D3_WAIT          10
124 #define PCI_PM_D3COLD_WAIT      100
125 #define PCI_PM_BUS_WAIT         50
126
127 /** The pci_channel state describes connectivity between the CPU and
128  *  the pci device.  If some PCI bus between here and the pci device
129  *  has crashed or locked up, this info is reflected here.
130  */
131 typedef unsigned int __bitwise pci_channel_state_t;
132
133 enum pci_channel_state {
134         /* I/O channel is in normal state */
135         pci_channel_io_normal = (__force pci_channel_state_t) 1,
136
137         /* I/O to channel is blocked */
138         pci_channel_io_frozen = (__force pci_channel_state_t) 2,
139
140         /* PCI card is dead */
141         pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
142 };
143
144 typedef unsigned int __bitwise pcie_reset_state_t;
145
146 enum pcie_reset_state {
147         /* Reset is NOT asserted (Use to deassert reset) */
148         pcie_deassert_reset = (__force pcie_reset_state_t) 1,
149
150         /* Use #PERST to reset PCIe device */
151         pcie_warm_reset = (__force pcie_reset_state_t) 2,
152
153         /* Use PCIe Hot Reset to reset device */
154         pcie_hot_reset = (__force pcie_reset_state_t) 3
155 };
156
157 typedef unsigned short __bitwise pci_dev_flags_t;
158 enum pci_dev_flags {
159         /* INTX_DISABLE in PCI_COMMAND register disables MSI
160          * generation too.
161          */
162         PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
163         /* Device configuration is irrevocably lost if disabled into D3 */
164         PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
165         /* Provide indication device is assigned by a Virtual Machine Manager */
166         PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
167         /* Flag for quirk use to store if quirk-specific ACS is enabled */
168         PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
169         /* Flag to indicate the device uses dma_alias_devfn */
170         PCI_DEV_FLAGS_DMA_ALIAS_DEVFN = (__force pci_dev_flags_t) (1 << 4),
171         /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
172         PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
173         /* Do not use bus resets for device */
174         PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
175         /* Do not use PM reset even if device advertises NoSoftRst- */
176         PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
177         /* Get VPD from function 0 VPD */
178         PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
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 /* These values come from the PCI Express Spec */
193 enum pcie_link_width {
194         PCIE_LNK_WIDTH_RESRV    = 0x00,
195         PCIE_LNK_X1             = 0x01,
196         PCIE_LNK_X2             = 0x02,
197         PCIE_LNK_X4             = 0x04,
198         PCIE_LNK_X8             = 0x08,
199         PCIE_LNK_X12            = 0x0C,
200         PCIE_LNK_X16            = 0x10,
201         PCIE_LNK_X32            = 0x20,
202         PCIE_LNK_WIDTH_UNKNOWN  = 0xFF,
203 };
204
205 /* Based on the PCI Hotplug Spec, but some values are made up by us */
206 enum pci_bus_speed {
207         PCI_SPEED_33MHz                 = 0x00,
208         PCI_SPEED_66MHz                 = 0x01,
209         PCI_SPEED_66MHz_PCIX            = 0x02,
210         PCI_SPEED_100MHz_PCIX           = 0x03,
211         PCI_SPEED_133MHz_PCIX           = 0x04,
212         PCI_SPEED_66MHz_PCIX_ECC        = 0x05,
213         PCI_SPEED_100MHz_PCIX_ECC       = 0x06,
214         PCI_SPEED_133MHz_PCIX_ECC       = 0x07,
215         PCI_SPEED_66MHz_PCIX_266        = 0x09,
216         PCI_SPEED_100MHz_PCIX_266       = 0x0a,
217         PCI_SPEED_133MHz_PCIX_266       = 0x0b,
218         AGP_UNKNOWN                     = 0x0c,
219         AGP_1X                          = 0x0d,
220         AGP_2X                          = 0x0e,
221         AGP_4X                          = 0x0f,
222         AGP_8X                          = 0x10,
223         PCI_SPEED_66MHz_PCIX_533        = 0x11,
224         PCI_SPEED_100MHz_PCIX_533       = 0x12,
225         PCI_SPEED_133MHz_PCIX_533       = 0x13,
226         PCIE_SPEED_2_5GT                = 0x14,
227         PCIE_SPEED_5_0GT                = 0x15,
228         PCIE_SPEED_8_0GT                = 0x16,
229         PCI_SPEED_UNKNOWN               = 0xff,
230 };
231
232 struct pci_cap_saved_data {
233         u16 cap_nr;
234         bool cap_extended;
235         unsigned int size;
236         u32 data[0];
237 };
238
239 struct pci_cap_saved_state {
240         struct hlist_node next;
241         struct pci_cap_saved_data cap;
242 };
243
244 struct pcie_link_state;
245 struct pci_vpd;
246 struct pci_sriov;
247 struct pci_ats;
248
249 /*
250  * The pci_dev structure is used to describe PCI devices.
251  */
252 struct pci_dev {
253         struct list_head bus_list;      /* node in per-bus list */
254         struct pci_bus  *bus;           /* bus this device is on */
255         struct pci_bus  *subordinate;   /* bus this device bridges to */
256
257         void            *sysdata;       /* hook for sys-specific extension */
258         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
259         struct pci_slot *slot;          /* Physical slot this device is in */
260
261         unsigned int    devfn;          /* encoded device & function index */
262         unsigned short  vendor;
263         unsigned short  device;
264         unsigned short  subsystem_vendor;
265         unsigned short  subsystem_device;
266         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
267         u8              revision;       /* PCI revision, low byte of class word */
268         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
269         u8              pcie_cap;       /* PCIe capability offset */
270         u8              msi_cap;        /* MSI capability offset */
271         u8              msix_cap;       /* MSI-X capability offset */
272         u8              pcie_mpss:3;    /* PCIe Max Payload Size Supported */
273         u8              rom_base_reg;   /* which config register controls the ROM */
274         u8              pin;            /* which interrupt pin this device uses */
275         u16             pcie_flags_reg; /* cached PCIe Capabilities Register */
276         u8              dma_alias_devfn;/* devfn of DMA alias, if any */
277
278         struct pci_driver *driver;      /* which driver has allocated this device */
279         u64             dma_mask;       /* Mask of the bits of bus address this
280                                            device implements.  Normally this is
281                                            0xffffffff.  You only need to change
282                                            this if your device has broken DMA
283                                            or supports 64-bit transfers.  */
284
285         struct device_dma_parameters dma_parms;
286
287         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
288                                            this is D0-D3, D0 being fully functional,
289                                            and D3 being off. */
290         u8              pm_cap;         /* PM capability offset */
291         unsigned int    pme_support:5;  /* Bitmask of states from which PME#
292                                            can be generated */
293         unsigned int    pme_interrupt:1;
294         unsigned int    pme_poll:1;     /* Poll device's PME status bit */
295         unsigned int    d1_support:1;   /* Low power state D1 is supported */
296         unsigned int    d2_support:1;   /* Low power state D2 is supported */
297         unsigned int    no_d1d2:1;      /* D1 and D2 are forbidden */
298         unsigned int    no_d3cold:1;    /* D3cold is forbidden */
299         unsigned int    d3cold_allowed:1;       /* D3cold is allowed by user */
300         unsigned int    mmio_always_on:1;       /* disallow turning off io/mem
301                                                    decoding during bar sizing */
302         unsigned int    wakeup_prepared:1;
303         unsigned int    runtime_d3cold:1;       /* whether go through runtime
304                                                    D3cold, not set for devices
305                                                    powered on/off by the
306                                                    corresponding bridge */
307         unsigned int    ignore_hotplug:1;       /* Ignore hotplug events */
308         unsigned int    d3_delay;       /* D3->D0 transition time in ms */
309         unsigned int    d3cold_delay;   /* D3cold->D0 transition time in ms */
310
311 #ifdef CONFIG_PCIEASPM
312         struct pcie_link_state  *link_state;    /* ASPM link state */
313 #endif
314
315         pci_channel_state_t error_state;        /* current connectivity state */
316         struct  device  dev;            /* Generic device interface */
317
318         int             cfg_size;       /* Size of configuration space */
319
320         /*
321          * Instead of touching interrupt line and base address registers
322          * directly, use the values stored here. They might be different!
323          */
324         unsigned int    irq;
325         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
326
327         bool match_driver;              /* Skip attaching driver */
328         /* These fields are used by common fixups */
329         unsigned int    transparent:1;  /* Subtractive decode PCI bridge */
330         unsigned int    multifunction:1;/* Part of multi-function device */
331         /* keep track of device state */
332         unsigned int    is_added:1;
333         unsigned int    is_busmaster:1; /* device is busmaster */
334         unsigned int    no_msi:1;       /* device may not use msi */
335         unsigned int    no_64bit_msi:1; /* device may only use 32-bit MSIs */
336         unsigned int    block_cfg_access:1;     /* config space access is blocked */
337         unsigned int    broken_parity_status:1; /* Device generates false positive parity */
338         unsigned int    irq_reroute_variant:2;  /* device needs IRQ rerouting variant */
339         unsigned int    msi_enabled:1;
340         unsigned int    msix_enabled:1;
341         unsigned int    ari_enabled:1;  /* ARI forwarding */
342         unsigned int    ats_enabled:1;  /* Address Translation Service */
343         unsigned int    is_managed:1;
344         unsigned int    needs_freset:1; /* Dev requires fundamental reset */
345         unsigned int    state_saved:1;
346         unsigned int    is_physfn:1;
347         unsigned int    is_virtfn:1;
348         unsigned int    reset_fn:1;
349         unsigned int    is_hotplug_bridge:1;
350         unsigned int    __aer_firmware_first_valid:1;
351         unsigned int    __aer_firmware_first:1;
352         unsigned int    broken_intx_masking:1;
353         unsigned int    io_window_1k:1; /* Intel P2P bridge 1K I/O windows */
354         unsigned int    irq_managed:1;
355         unsigned int    has_secondary_link:1;
356         pci_dev_flags_t dev_flags;
357         atomic_t        enable_cnt;     /* pci_enable_device has been called */
358
359         u32             saved_config_space[16]; /* config space saved at suspend time */
360         struct hlist_head saved_cap_space;
361         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
362         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
363         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
364         struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
365 #ifdef CONFIG_PCI_MSI
366         const struct attribute_group **msi_irq_groups;
367 #endif
368         struct pci_vpd *vpd;
369 #ifdef CONFIG_PCI_ATS
370         union {
371                 struct pci_sriov *sriov;        /* SR-IOV capability related */
372                 struct pci_dev *physfn; /* the PF this VF is associated with */
373         };
374         u16             ats_cap;        /* ATS Capability offset */
375         u8              ats_stu;        /* ATS Smallest Translation Unit */
376         atomic_t        ats_ref_cnt;    /* number of VFs with ATS enabled */
377 #endif
378         phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
379         size_t romlen; /* Length of ROM if it's not from the BAR */
380         char *driver_override; /* Driver name to force a match */
381 };
382
383 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
384 {
385 #ifdef CONFIG_PCI_IOV
386         if (dev->is_virtfn)
387                 dev = dev->physfn;
388 #endif
389         return dev;
390 }
391
392 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
393
394 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
395 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
396
397 static inline int pci_channel_offline(struct pci_dev *pdev)
398 {
399         return (pdev->error_state != pci_channel_io_normal);
400 }
401
402 struct pci_host_bridge {
403         struct device dev;
404         struct pci_bus *bus;            /* root bus */
405         struct list_head windows;       /* resource_entry */
406         void (*release_fn)(struct pci_host_bridge *);
407         void *release_data;
408         unsigned int ignore_reset_delay:1;      /* for entire hierarchy */
409         /* Resource alignment requirements */
410         resource_size_t (*align_resource)(struct pci_dev *dev,
411                         const struct resource *res,
412                         resource_size_t start,
413                         resource_size_t size,
414                         resource_size_t align);
415 };
416
417 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
418
419 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
420
421 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
422                      void (*release_fn)(struct pci_host_bridge *),
423                      void *release_data);
424
425 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
426
427 /*
428  * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
429  * to P2P or CardBus bridge windows) go in a table.  Additional ones (for
430  * buses below host bridges or subtractive decode bridges) go in the list.
431  * Use pci_bus_for_each_resource() to iterate through all the resources.
432  */
433
434 /*
435  * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
436  * and there's no way to program the bridge with the details of the window.
437  * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
438  * decode bit set, because they are explicit and can be programmed with _SRS.
439  */
440 #define PCI_SUBTRACTIVE_DECODE  0x1
441
442 struct pci_bus_resource {
443         struct list_head list;
444         struct resource *res;
445         unsigned int flags;
446 };
447
448 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
449
450 struct pci_bus {
451         struct list_head node;          /* node in list of buses */
452         struct pci_bus  *parent;        /* parent bus this bridge is on */
453         struct list_head children;      /* list of child buses */
454         struct list_head devices;       /* list of devices on this bus */
455         struct pci_dev  *self;          /* bridge device as seen by parent */
456         struct list_head slots;         /* list of slots on this bus;
457                                            protected by pci_slot_mutex */
458         struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
459         struct list_head resources;     /* address space routed to this bus */
460         struct resource busn_res;       /* bus numbers routed to this bus */
461
462         struct pci_ops  *ops;           /* configuration access functions */
463         struct msi_controller *msi;     /* MSI controller */
464         void            *sysdata;       /* hook for sys-specific extension */
465         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
466
467         unsigned char   number;         /* bus number */
468         unsigned char   primary;        /* number of primary bridge */
469         unsigned char   max_bus_speed;  /* enum pci_bus_speed */
470         unsigned char   cur_bus_speed;  /* enum pci_bus_speed */
471 #ifdef CONFIG_PCI_DOMAINS_GENERIC
472         int             domain_nr;
473 #endif
474
475         char            name[48];
476
477         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
478         pci_bus_flags_t bus_flags;      /* inherited by child buses */
479         struct device           *bridge;
480         struct device           dev;
481         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
482         struct bin_attribute    *legacy_mem; /* legacy mem */
483         unsigned int            is_added:1;
484 };
485
486 #define to_pci_bus(n)   container_of(n, struct pci_bus, dev)
487
488 /*
489  * Returns true if the PCI bus is root (behind host-PCI bridge),
490  * false otherwise
491  *
492  * Some code assumes that "bus->self == NULL" means that bus is a root bus.
493  * This is incorrect because "virtual" buses added for SR-IOV (via
494  * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
495  */
496 static inline bool pci_is_root_bus(struct pci_bus *pbus)
497 {
498         return !(pbus->parent);
499 }
500
501 /**
502  * pci_is_bridge - check if the PCI device is a bridge
503  * @dev: PCI device
504  *
505  * Return true if the PCI device is bridge whether it has subordinate
506  * or not.
507  */
508 static inline bool pci_is_bridge(struct pci_dev *dev)
509 {
510         return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
511                 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
512 }
513
514 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
515 {
516         dev = pci_physfn(dev);
517         if (pci_is_root_bus(dev->bus))
518                 return NULL;
519
520         return dev->bus->self;
521 }
522
523 struct device *pci_get_host_bridge_device(struct pci_dev *dev);
524 void pci_put_host_bridge_device(struct device *dev);
525
526 #ifdef CONFIG_PCI_MSI
527 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
528 {
529         return pci_dev->msi_enabled || pci_dev->msix_enabled;
530 }
531 #else
532 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
533 #endif
534
535 /*
536  * Error values that may be returned by PCI functions.
537  */
538 #define PCIBIOS_SUCCESSFUL              0x00
539 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
540 #define PCIBIOS_BAD_VENDOR_ID           0x83
541 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
542 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
543 #define PCIBIOS_SET_FAILED              0x88
544 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
545
546 /*
547  * Translate above to generic errno for passing back through non-PCI code.
548  */
549 static inline int pcibios_err_to_errno(int err)
550 {
551         if (err <= PCIBIOS_SUCCESSFUL)
552                 return err; /* Assume already errno */
553
554         switch (err) {
555         case PCIBIOS_FUNC_NOT_SUPPORTED:
556                 return -ENOENT;
557         case PCIBIOS_BAD_VENDOR_ID:
558                 return -ENOTTY;
559         case PCIBIOS_DEVICE_NOT_FOUND:
560                 return -ENODEV;
561         case PCIBIOS_BAD_REGISTER_NUMBER:
562                 return -EFAULT;
563         case PCIBIOS_SET_FAILED:
564                 return -EIO;
565         case PCIBIOS_BUFFER_TOO_SMALL:
566                 return -ENOSPC;
567         }
568
569         return -ERANGE;
570 }
571
572 /* Low-level architecture-dependent routines */
573
574 struct pci_ops {
575         int (*add_bus)(struct pci_bus *bus);
576         void (*remove_bus)(struct pci_bus *bus);
577         void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
578         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
579         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
580 };
581
582 /*
583  * ACPI needs to be able to access PCI config space before we've done a
584  * PCI bus scan and created pci_bus structures.
585  */
586 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
587                  int reg, int len, u32 *val);
588 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
589                   int reg, int len, u32 val);
590
591 #ifdef CONFIG_PCI_BUS_ADDR_T_64BIT
592 typedef u64 pci_bus_addr_t;
593 #else
594 typedef u32 pci_bus_addr_t;
595 #endif
596
597 struct pci_bus_region {
598         pci_bus_addr_t start;
599         pci_bus_addr_t end;
600 };
601
602 struct pci_dynids {
603         spinlock_t lock;            /* protects list, index */
604         struct list_head list;      /* for IDs added at runtime */
605 };
606
607
608 /*
609  * PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
610  * a set of callbacks in struct pci_error_handlers, that device driver
611  * will be notified of PCI bus errors, and will be driven to recovery
612  * when an error occurs.
613  */
614
615 typedef unsigned int __bitwise pci_ers_result_t;
616
617 enum pci_ers_result {
618         /* no result/none/not supported in device driver */
619         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
620
621         /* Device driver can recover without slot reset */
622         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
623
624         /* Device driver wants slot to be reset. */
625         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
626
627         /* Device has completely failed, is unrecoverable */
628         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
629
630         /* Device driver is fully recovered and operational */
631         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
632
633         /* No AER capabilities registered for the driver */
634         PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
635 };
636
637 /* PCI bus error event callbacks */
638 struct pci_error_handlers {
639         /* PCI bus error detected on this device */
640         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
641                                            enum pci_channel_state error);
642
643         /* MMIO has been re-enabled, but not DMA */
644         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
645
646         /* PCI Express link has been reset */
647         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
648
649         /* PCI slot has been reset */
650         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
651
652         /* PCI function reset prepare or completed */
653         void (*reset_notify)(struct pci_dev *dev, bool prepare);
654
655         /* Device driver may resume normal operations */
656         void (*resume)(struct pci_dev *dev);
657 };
658
659
660 struct module;
661 struct pci_driver {
662         struct list_head node;
663         const char *name;
664         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
665         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
666         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
667         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
668         int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
669         int  (*resume_early) (struct pci_dev *dev);
670         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
671         void (*shutdown) (struct pci_dev *dev);
672         int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
673         const struct pci_error_handlers *err_handler;
674         struct device_driver    driver;
675         struct pci_dynids dynids;
676 };
677
678 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
679
680 /**
681  * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
682  * @_table: device table name
683  *
684  * This macro is deprecated and should not be used in new code.
685  */
686 #define DEFINE_PCI_DEVICE_TABLE(_table) \
687         const struct pci_device_id _table[]
688
689 /**
690  * PCI_DEVICE - macro used to describe a specific pci device
691  * @vend: the 16 bit PCI Vendor ID
692  * @dev: the 16 bit PCI Device ID
693  *
694  * This macro is used to create a struct pci_device_id that matches a
695  * specific device.  The subvendor and subdevice fields will be set to
696  * PCI_ANY_ID.
697  */
698 #define PCI_DEVICE(vend,dev) \
699         .vendor = (vend), .device = (dev), \
700         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
701
702 /**
703  * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
704  * @vend: the 16 bit PCI Vendor ID
705  * @dev: the 16 bit PCI Device ID
706  * @subvend: the 16 bit PCI Subvendor ID
707  * @subdev: the 16 bit PCI Subdevice ID
708  *
709  * This macro is used to create a struct pci_device_id that matches a
710  * specific device with subsystem information.
711  */
712 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
713         .vendor = (vend), .device = (dev), \
714         .subvendor = (subvend), .subdevice = (subdev)
715
716 /**
717  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
718  * @dev_class: the class, subclass, prog-if triple for this device
719  * @dev_class_mask: the class mask for this device
720  *
721  * This macro is used to create a struct pci_device_id that matches a
722  * specific PCI class.  The vendor, device, subvendor, and subdevice
723  * fields will be set to PCI_ANY_ID.
724  */
725 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
726         .class = (dev_class), .class_mask = (dev_class_mask), \
727         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
728         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
729
730 /**
731  * PCI_VDEVICE - macro used to describe a specific pci device in short form
732  * @vend: the vendor name
733  * @dev: the 16 bit PCI Device ID
734  *
735  * This macro is used to create a struct pci_device_id that matches a
736  * specific PCI device.  The subvendor, and subdevice fields will be set
737  * to PCI_ANY_ID. The macro allows the next field to follow as the device
738  * private data.
739  */
740
741 #define PCI_VDEVICE(vend, dev) \
742         .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
743         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
744
745 enum {
746         PCI_REASSIGN_ALL_RSRC   = 0x00000001,   /* ignore firmware setup */
747         PCI_REASSIGN_ALL_BUS    = 0x00000002,   /* reassign all bus numbers */
748         PCI_PROBE_ONLY          = 0x00000004,   /* use existing setup */
749         PCI_CAN_SKIP_ISA_ALIGN  = 0x00000008,   /* don't do ISA alignment */
750         PCI_ENABLE_PROC_DOMAINS = 0x00000010,   /* enable domains in /proc */
751         PCI_COMPAT_DOMAIN_0     = 0x00000020,   /* ... except domain 0 */
752         PCI_SCAN_ALL_PCIE_DEVS  = 0x00000040,   /* scan all, not just dev 0 */
753 };
754
755 /* these external functions are only available when PCI support is enabled */
756 #ifdef CONFIG_PCI
757
758 extern unsigned int pci_flags;
759
760 static inline void pci_set_flags(int flags) { pci_flags = flags; }
761 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
762 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
763 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
764
765 void pcie_bus_configure_settings(struct pci_bus *bus);
766
767 enum pcie_bus_config_types {
768         PCIE_BUS_TUNE_OFF,      /* don't touch MPS at all */
769         PCIE_BUS_DEFAULT,       /* ensure MPS matches upstream bridge */
770         PCIE_BUS_SAFE,          /* use largest MPS boot-time devices support */
771         PCIE_BUS_PERFORMANCE,   /* use MPS and MRRS for best performance */
772         PCIE_BUS_PEER2PEER,     /* set MPS = 128 for all devices */
773 };
774
775 extern enum pcie_bus_config_types pcie_bus_config;
776
777 extern struct bus_type pci_bus_type;
778
779 /* Do NOT directly access these two variables, unless you are arch-specific PCI
780  * code, or PCI core code. */
781 extern struct list_head pci_root_buses; /* list of all known PCI buses */
782 /* Some device drivers need know if PCI is initiated */
783 int no_pci_devices(void);
784
785 void pcibios_resource_survey_bus(struct pci_bus *bus);
786 void pcibios_add_bus(struct pci_bus *bus);
787 void pcibios_remove_bus(struct pci_bus *bus);
788 void pcibios_fixup_bus(struct pci_bus *);
789 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
790 /* Architecture-specific versions may override this (weak) */
791 char *pcibios_setup(char *str);
792
793 /* Used only when drivers/pci/setup.c is used */
794 resource_size_t pcibios_align_resource(void *, const struct resource *,
795                                 resource_size_t,
796                                 resource_size_t);
797 void pcibios_update_irq(struct pci_dev *, int irq);
798
799 /* Weak but can be overriden by arch */
800 void pci_fixup_cardbus(struct pci_bus *);
801
802 /* Generic PCI functions used internally */
803
804 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
805                              struct resource *res);
806 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
807                              struct pci_bus_region *region);
808 void pcibios_scan_specific_bus(int busn);
809 struct pci_bus *pci_find_bus(int domain, int busnr);
810 void pci_bus_add_devices(const struct pci_bus *bus);
811 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
812 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
813                                     struct pci_ops *ops, void *sysdata,
814                                     struct list_head *resources);
815 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
816 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
817 void pci_bus_release_busn_res(struct pci_bus *b);
818 struct pci_bus *pci_scan_root_bus_msi(struct device *parent, int bus,
819                                       struct pci_ops *ops, void *sysdata,
820                                       struct list_head *resources,
821                                       struct msi_controller *msi);
822 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
823                                              struct pci_ops *ops, void *sysdata,
824                                              struct list_head *resources);
825 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
826                                 int busnr);
827 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
828 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
829                                  const char *name,
830                                  struct hotplug_slot *hotplug);
831 void pci_destroy_slot(struct pci_slot *slot);
832 #ifdef CONFIG_SYSFS
833 void pci_dev_assign_slot(struct pci_dev *dev);
834 #else
835 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
836 #endif
837 int pci_scan_slot(struct pci_bus *bus, int devfn);
838 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
839 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
840 unsigned int pci_scan_child_bus(struct pci_bus *bus);
841 void pci_bus_add_device(struct pci_dev *dev);
842 void pci_read_bridge_bases(struct pci_bus *child);
843 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
844                                           struct resource *res);
845 struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev);
846 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
847 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
848 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
849 struct pci_dev *pci_dev_get(struct pci_dev *dev);
850 void pci_dev_put(struct pci_dev *dev);
851 void pci_remove_bus(struct pci_bus *b);
852 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
853 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
854 void pci_stop_root_bus(struct pci_bus *bus);
855 void pci_remove_root_bus(struct pci_bus *bus);
856 void pci_setup_cardbus(struct pci_bus *bus);
857 void pci_sort_breadthfirst(void);
858 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
859 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
860 #define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
861
862 /* Generic PCI functions exported to card drivers */
863
864 enum pci_lost_interrupt_reason {
865         PCI_LOST_IRQ_NO_INFORMATION = 0,
866         PCI_LOST_IRQ_DISABLE_MSI,
867         PCI_LOST_IRQ_DISABLE_MSIX,
868         PCI_LOST_IRQ_DISABLE_ACPI,
869 };
870 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
871 int pci_find_capability(struct pci_dev *dev, int cap);
872 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
873 int pci_find_ext_capability(struct pci_dev *dev, int cap);
874 int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
875 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
876 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
877 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
878
879 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
880                                 struct pci_dev *from);
881 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
882                                 unsigned int ss_vendor, unsigned int ss_device,
883                                 struct pci_dev *from);
884 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
885 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
886                                             unsigned int devfn);
887 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
888                                                    unsigned int devfn)
889 {
890         return pci_get_domain_bus_and_slot(0, bus, devfn);
891 }
892 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
893 int pci_dev_present(const struct pci_device_id *ids);
894
895 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
896                              int where, u8 *val);
897 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
898                              int where, u16 *val);
899 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
900                               int where, u32 *val);
901 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
902                               int where, u8 val);
903 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
904                               int where, u16 val);
905 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
906                                int where, u32 val);
907
908 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
909                             int where, int size, u32 *val);
910 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
911                             int where, int size, u32 val);
912 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
913                               int where, int size, u32 *val);
914 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
915                                int where, int size, u32 val);
916
917 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
918
919 static inline int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
920 {
921         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
922 }
923 static inline int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
924 {
925         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
926 }
927 static inline int pci_read_config_dword(const struct pci_dev *dev, int where,
928                                         u32 *val)
929 {
930         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
931 }
932 static inline int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
933 {
934         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
935 }
936 static inline int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
937 {
938         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
939 }
940 static inline int pci_write_config_dword(const struct pci_dev *dev, int where,
941                                          u32 val)
942 {
943         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
944 }
945
946 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
947 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
948 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
949 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
950 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
951                                        u16 clear, u16 set);
952 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
953                                         u32 clear, u32 set);
954
955 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
956                                            u16 set)
957 {
958         return pcie_capability_clear_and_set_word(dev, pos, 0, set);
959 }
960
961 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
962                                             u32 set)
963 {
964         return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
965 }
966
967 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
968                                              u16 clear)
969 {
970         return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
971 }
972
973 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
974                                               u32 clear)
975 {
976         return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
977 }
978
979 /* user-space driven config access */
980 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
981 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
982 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
983 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
984 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
985 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
986
987 int __must_check pci_enable_device(struct pci_dev *dev);
988 int __must_check pci_enable_device_io(struct pci_dev *dev);
989 int __must_check pci_enable_device_mem(struct pci_dev *dev);
990 int __must_check pci_reenable_device(struct pci_dev *);
991 int __must_check pcim_enable_device(struct pci_dev *pdev);
992 void pcim_pin_device(struct pci_dev *pdev);
993
994 static inline int pci_is_enabled(struct pci_dev *pdev)
995 {
996         return (atomic_read(&pdev->enable_cnt) > 0);
997 }
998
999 static inline int pci_is_managed(struct pci_dev *pdev)
1000 {
1001         return pdev->is_managed;
1002 }
1003
1004 static inline void pci_set_managed_irq(struct pci_dev *pdev, unsigned int irq)
1005 {
1006         pdev->irq = irq;
1007         pdev->irq_managed = 1;
1008 }
1009
1010 static inline void pci_reset_managed_irq(struct pci_dev *pdev)
1011 {
1012         pdev->irq = 0;
1013         pdev->irq_managed = 0;
1014 }
1015
1016 static inline bool pci_has_managed_irq(struct pci_dev *pdev)
1017 {
1018         return pdev->irq_managed && pdev->irq > 0;
1019 }
1020
1021 void pci_disable_device(struct pci_dev *dev);
1022
1023 extern unsigned int pcibios_max_latency;
1024 void pci_set_master(struct pci_dev *dev);
1025 void pci_clear_master(struct pci_dev *dev);
1026
1027 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1028 int pci_set_cacheline_size(struct pci_dev *dev);
1029 #define HAVE_PCI_SET_MWI
1030 int __must_check pci_set_mwi(struct pci_dev *dev);
1031 int pci_try_set_mwi(struct pci_dev *dev);
1032 void pci_clear_mwi(struct pci_dev *dev);
1033 void pci_intx(struct pci_dev *dev, int enable);
1034 bool pci_intx_mask_supported(struct pci_dev *dev);
1035 bool pci_check_and_mask_intx(struct pci_dev *dev);
1036 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1037 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1038 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1039 int pcix_get_max_mmrbc(struct pci_dev *dev);
1040 int pcix_get_mmrbc(struct pci_dev *dev);
1041 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1042 int pcie_get_readrq(struct pci_dev *dev);
1043 int pcie_set_readrq(struct pci_dev *dev, int rq);
1044 int pcie_get_mps(struct pci_dev *dev);
1045 int pcie_set_mps(struct pci_dev *dev, int mps);
1046 int pcie_get_minimum_link(struct pci_dev *dev, enum pci_bus_speed *speed,
1047                           enum pcie_link_width *width);
1048 int __pci_reset_function(struct pci_dev *dev);
1049 int __pci_reset_function_locked(struct pci_dev *dev);
1050 int pci_reset_function(struct pci_dev *dev);
1051 int pci_try_reset_function(struct pci_dev *dev);
1052 int pci_probe_reset_slot(struct pci_slot *slot);
1053 int pci_reset_slot(struct pci_slot *slot);
1054 int pci_try_reset_slot(struct pci_slot *slot);
1055 int pci_probe_reset_bus(struct pci_bus *bus);
1056 int pci_reset_bus(struct pci_bus *bus);
1057 int pci_try_reset_bus(struct pci_bus *bus);
1058 void pci_reset_secondary_bus(struct pci_dev *dev);
1059 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1060 void pci_reset_bridge_secondary_bus(struct pci_dev *dev);
1061 void pci_update_resource(struct pci_dev *dev, int resno);
1062 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1063 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1064 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1065 bool pci_device_is_present(struct pci_dev *pdev);
1066 void pci_ignore_hotplug(struct pci_dev *dev);
1067
1068 /* ROM control related routines */
1069 int pci_enable_rom(struct pci_dev *pdev);
1070 void pci_disable_rom(struct pci_dev *pdev);
1071 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1072 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1073 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
1074 void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
1075
1076 /* Power management related routines */
1077 int pci_save_state(struct pci_dev *dev);
1078 void pci_restore_state(struct pci_dev *dev);
1079 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1080 int pci_load_saved_state(struct pci_dev *dev,
1081                          struct pci_saved_state *state);
1082 int pci_load_and_free_saved_state(struct pci_dev *dev,
1083                                   struct pci_saved_state **state);
1084 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
1085 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
1086                                                    u16 cap);
1087 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
1088 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
1089                                 u16 cap, unsigned int size);
1090 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
1091 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1092 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1093 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1094 void pci_pme_active(struct pci_dev *dev, bool enable);
1095 int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1096                       bool runtime, bool enable);
1097 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1098 int pci_prepare_to_sleep(struct pci_dev *dev);
1099 int pci_back_from_sleep(struct pci_dev *dev);
1100 bool pci_dev_run_wake(struct pci_dev *dev);
1101 bool pci_check_pme_status(struct pci_dev *dev);
1102 void pci_pme_wakeup_bus(struct pci_bus *bus);
1103
1104 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1105                                   bool enable)
1106 {
1107         return __pci_enable_wake(dev, state, false, enable);
1108 }
1109
1110 /* PCI Virtual Channel */
1111 int pci_save_vc_state(struct pci_dev *dev);
1112 void pci_restore_vc_state(struct pci_dev *dev);
1113 void pci_allocate_vc_save_buffers(struct pci_dev *dev);
1114
1115 /* For use by arch with custom probe code */
1116 void set_pcie_port_type(struct pci_dev *pdev);
1117 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1118
1119 /* Functions for PCI Hotplug drivers to use */
1120 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1121 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1122 unsigned int pci_rescan_bus(struct pci_bus *bus);
1123 void pci_lock_rescan_remove(void);
1124 void pci_unlock_rescan_remove(void);
1125
1126 /* Vital product data routines */
1127 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1128 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1129
1130 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1131 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1132 void pci_bus_assign_resources(const struct pci_bus *bus);
1133 void pci_bus_size_bridges(struct pci_bus *bus);
1134 int pci_claim_resource(struct pci_dev *, int);
1135 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1136 void pci_assign_unassigned_resources(void);
1137 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1138 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1139 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1140 void pdev_enable_device(struct pci_dev *);
1141 int pci_enable_resources(struct pci_dev *, int mask);
1142 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
1143                     int (*)(const struct pci_dev *, u8, u8));
1144 #define HAVE_PCI_REQ_REGIONS    2
1145 int __must_check pci_request_regions(struct pci_dev *, const char *);
1146 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1147 void pci_release_regions(struct pci_dev *);
1148 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1149 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
1150 void pci_release_region(struct pci_dev *, int);
1151 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1152 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1153 void pci_release_selected_regions(struct pci_dev *, int);
1154
1155 /* drivers/pci/bus.c */
1156 struct pci_bus *pci_bus_get(struct pci_bus *bus);
1157 void pci_bus_put(struct pci_bus *bus);
1158 void pci_add_resource(struct list_head *resources, struct resource *res);
1159 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1160                              resource_size_t offset);
1161 void pci_free_resource_list(struct list_head *resources);
1162 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
1163 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1164 void pci_bus_remove_resources(struct pci_bus *bus);
1165
1166 #define pci_bus_for_each_resource(bus, res, i)                          \
1167         for (i = 0;                                                     \
1168             (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1169              i++)
1170
1171 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1172                         struct resource *res, resource_size_t size,
1173                         resource_size_t align, resource_size_t min,
1174                         unsigned long type_mask,
1175                         resource_size_t (*alignf)(void *,
1176                                                   const struct resource *,
1177                                                   resource_size_t,
1178                                                   resource_size_t),
1179                         void *alignf_data);
1180
1181
1182 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1183
1184 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1185 {
1186         struct pci_bus_region region;
1187
1188         pcibios_resource_to_bus(pdev->bus, &region, &pdev->resource[bar]);
1189         return region.start;
1190 }
1191
1192 /* Proper probing supporting hot-pluggable devices */
1193 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1194                                        const char *mod_name);
1195
1196 /*
1197  * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
1198  */
1199 #define pci_register_driver(driver)             \
1200         __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1201
1202 void pci_unregister_driver(struct pci_driver *dev);
1203
1204 /**
1205  * module_pci_driver() - Helper macro for registering a PCI driver
1206  * @__pci_driver: pci_driver struct
1207  *
1208  * Helper macro for PCI drivers which do not do anything special in module
1209  * init/exit. This eliminates a lot of boilerplate. Each module may only
1210  * use this macro once, and calling it replaces module_init() and module_exit()
1211  */
1212 #define module_pci_driver(__pci_driver) \
1213         module_driver(__pci_driver, pci_register_driver, \
1214                        pci_unregister_driver)
1215
1216 /**
1217  * builtin_pci_driver() - Helper macro for registering a PCI driver
1218  * @__pci_driver: pci_driver struct
1219  *
1220  * Helper macro for PCI drivers which do not do anything special in their
1221  * init code. This eliminates a lot of boilerplate. Each driver may only
1222  * use this macro once, and calling it replaces device_initcall(...)
1223  */
1224 #define builtin_pci_driver(__pci_driver) \
1225         builtin_driver(__pci_driver, pci_register_driver)
1226
1227 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1228 int pci_add_dynid(struct pci_driver *drv,
1229                   unsigned int vendor, unsigned int device,
1230                   unsigned int subvendor, unsigned int subdevice,
1231                   unsigned int class, unsigned int class_mask,
1232                   unsigned long driver_data);
1233 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1234                                          struct pci_dev *dev);
1235 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1236                     int pass);
1237
1238 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1239                   void *userdata);
1240 int pci_cfg_space_size(struct pci_dev *dev);
1241 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1242 void pci_setup_bridge(struct pci_bus *bus);
1243 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1244                                          unsigned long type);
1245 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
1246
1247 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1248 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1249
1250 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1251                       unsigned int command_bits, u32 flags);
1252
1253 /* kmem_cache style wrapper around pci_alloc_consistent() */
1254
1255 #include <linux/pci-dma.h>
1256 #include <linux/dmapool.h>
1257
1258 #define pci_pool dma_pool
1259 #define pci_pool_create(name, pdev, size, align, allocation) \
1260                 dma_pool_create(name, &pdev->dev, size, align, allocation)
1261 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1262 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1263 #define pci_pool_zalloc(pool, flags, handle) \
1264                 dma_pool_zalloc(pool, flags, handle)
1265 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1266
1267 struct msix_entry {
1268         u32     vector; /* kernel uses to write allocated vector */
1269         u16     entry;  /* driver uses to specify entry, OS writes */
1270 };
1271
1272 #ifdef CONFIG_PCI_MSI
1273 int pci_msi_vec_count(struct pci_dev *dev);
1274 void pci_msi_shutdown(struct pci_dev *dev);
1275 void pci_disable_msi(struct pci_dev *dev);
1276 int pci_msix_vec_count(struct pci_dev *dev);
1277 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec);
1278 void pci_msix_shutdown(struct pci_dev *dev);
1279 void pci_disable_msix(struct pci_dev *dev);
1280 void pci_restore_msi_state(struct pci_dev *dev);
1281 int pci_msi_enabled(void);
1282 int pci_enable_msi_range(struct pci_dev *dev, int minvec, int maxvec);
1283 static inline int pci_enable_msi_exact(struct pci_dev *dev, int nvec)
1284 {
1285         int rc = pci_enable_msi_range(dev, nvec, nvec);
1286         if (rc < 0)
1287                 return rc;
1288         return 0;
1289 }
1290 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1291                           int minvec, int maxvec);
1292 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1293                                         struct msix_entry *entries, int nvec)
1294 {
1295         int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1296         if (rc < 0)
1297                 return rc;
1298         return 0;
1299 }
1300 #else
1301 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1302 static inline void pci_msi_shutdown(struct pci_dev *dev) { }
1303 static inline void pci_disable_msi(struct pci_dev *dev) { }
1304 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1305 static inline int pci_enable_msix(struct pci_dev *dev,
1306                                   struct msix_entry *entries, int nvec)
1307 { return -ENOSYS; }
1308 static inline void pci_msix_shutdown(struct pci_dev *dev) { }
1309 static inline void pci_disable_msix(struct pci_dev *dev) { }
1310 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1311 static inline int pci_msi_enabled(void) { return 0; }
1312 static inline int pci_enable_msi_range(struct pci_dev *dev, int minvec,
1313                                        int maxvec)
1314 { return -ENOSYS; }
1315 static inline int pci_enable_msi_exact(struct pci_dev *dev, int nvec)
1316 { return -ENOSYS; }
1317 static inline int pci_enable_msix_range(struct pci_dev *dev,
1318                       struct msix_entry *entries, int minvec, int maxvec)
1319 { return -ENOSYS; }
1320 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1321                       struct msix_entry *entries, int nvec)
1322 { return -ENOSYS; }
1323 #endif
1324
1325 #ifdef CONFIG_PCIEPORTBUS
1326 extern bool pcie_ports_disabled;
1327 extern bool pcie_ports_auto;
1328 #else
1329 #define pcie_ports_disabled     true
1330 #define pcie_ports_auto         false
1331 #endif
1332
1333 #ifdef CONFIG_PCIEASPM
1334 bool pcie_aspm_support_enabled(void);
1335 #else
1336 static inline bool pcie_aspm_support_enabled(void) { return false; }
1337 #endif
1338
1339 #ifdef CONFIG_PCIEAER
1340 void pci_no_aer(void);
1341 bool pci_aer_available(void);
1342 #else
1343 static inline void pci_no_aer(void) { }
1344 static inline bool pci_aer_available(void) { return false; }
1345 #endif
1346
1347 #ifdef CONFIG_PCIE_ECRC
1348 void pcie_set_ecrc_checking(struct pci_dev *dev);
1349 void pcie_ecrc_get_policy(char *str);
1350 #else
1351 static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
1352 static inline void pcie_ecrc_get_policy(char *str) { }
1353 #endif
1354
1355 #define pci_enable_msi(pdev)    pci_enable_msi_exact(pdev, 1)
1356
1357 #ifdef CONFIG_HT_IRQ
1358 /* The functions a driver should call */
1359 int  ht_create_irq(struct pci_dev *dev, int idx);
1360 void ht_destroy_irq(unsigned int irq);
1361 #endif /* CONFIG_HT_IRQ */
1362
1363 #ifdef CONFIG_PCI_ATS
1364 /* Address Translation Service */
1365 void pci_ats_init(struct pci_dev *dev);
1366 int pci_enable_ats(struct pci_dev *dev, int ps);
1367 void pci_disable_ats(struct pci_dev *dev);
1368 int pci_ats_queue_depth(struct pci_dev *dev);
1369 #else
1370 static inline void pci_ats_init(struct pci_dev *d) { }
1371 static inline int pci_enable_ats(struct pci_dev *d, int ps) { return -ENODEV; }
1372 static inline void pci_disable_ats(struct pci_dev *d) { }
1373 static inline int pci_ats_queue_depth(struct pci_dev *d) { return -ENODEV; }
1374 #endif
1375
1376 void pci_cfg_access_lock(struct pci_dev *dev);
1377 bool pci_cfg_access_trylock(struct pci_dev *dev);
1378 void pci_cfg_access_unlock(struct pci_dev *dev);
1379
1380 /*
1381  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
1382  * a PCI domain is defined to be a set of PCI buses which share
1383  * configuration space.
1384  */
1385 #ifdef CONFIG_PCI_DOMAINS
1386 extern int pci_domains_supported;
1387 int pci_get_new_domain_nr(void);
1388 #else
1389 enum { pci_domains_supported = 0 };
1390 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1391 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1392 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1393 #endif /* CONFIG_PCI_DOMAINS */
1394
1395 /*
1396  * Generic implementation for PCI domain support. If your
1397  * architecture does not need custom management of PCI
1398  * domains then this implementation will be used
1399  */
1400 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1401 static inline int pci_domain_nr(struct pci_bus *bus)
1402 {
1403         return bus->domain_nr;
1404 }
1405 void pci_bus_assign_domain_nr(struct pci_bus *bus, struct device *parent);
1406 #else
1407 static inline void pci_bus_assign_domain_nr(struct pci_bus *bus,
1408                                         struct device *parent)
1409 {
1410 }
1411 #endif
1412
1413 /* some architectures require additional setup to direct VGA traffic */
1414 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1415                       unsigned int command_bits, u32 flags);
1416 void pci_register_set_vga_state(arch_set_vga_state_t func);
1417
1418 #else /* CONFIG_PCI is not enabled */
1419
1420 static inline void pci_set_flags(int flags) { }
1421 static inline void pci_add_flags(int flags) { }
1422 static inline void pci_clear_flags(int flags) { }
1423 static inline int pci_has_flag(int flag) { return 0; }
1424
1425 /*
1426  *  If the system does not have PCI, clearly these return errors.  Define
1427  *  these as simple inline functions to avoid hair in drivers.
1428  */
1429
1430 #define _PCI_NOP(o, s, t) \
1431         static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1432                                                 int where, t val) \
1433                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1434
1435 #define _PCI_NOP_ALL(o, x)      _PCI_NOP(o, byte, u8 x) \
1436                                 _PCI_NOP(o, word, u16 x) \
1437                                 _PCI_NOP(o, dword, u32 x)
1438 _PCI_NOP_ALL(read, *)
1439 _PCI_NOP_ALL(write,)
1440
1441 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1442                                              unsigned int device,
1443                                              struct pci_dev *from)
1444 { return NULL; }
1445
1446 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1447                                              unsigned int device,
1448                                              unsigned int ss_vendor,
1449                                              unsigned int ss_device,
1450                                              struct pci_dev *from)
1451 { return NULL; }
1452
1453 static inline struct pci_dev *pci_get_class(unsigned int class,
1454                                             struct pci_dev *from)
1455 { return NULL; }
1456
1457 #define pci_dev_present(ids)    (0)
1458 #define no_pci_devices()        (1)
1459 #define pci_dev_put(dev)        do { } while (0)
1460
1461 static inline void pci_set_master(struct pci_dev *dev) { }
1462 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1463 static inline void pci_disable_device(struct pci_dev *dev) { }
1464 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1465 { return -EBUSY; }
1466 static inline int __pci_register_driver(struct pci_driver *drv,
1467                                         struct module *owner)
1468 { return 0; }
1469 static inline int pci_register_driver(struct pci_driver *drv)
1470 { return 0; }
1471 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1472 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1473 { return 0; }
1474 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1475                                            int cap)
1476 { return 0; }
1477 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1478 { return 0; }
1479
1480 /* Power management related routines */
1481 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
1482 static inline void pci_restore_state(struct pci_dev *dev) { }
1483 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1484 { return 0; }
1485 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1486 { return 0; }
1487 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1488                                            pm_message_t state)
1489 { return PCI_D0; }
1490 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1491                                   int enable)
1492 { return 0; }
1493
1494 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1495 { return -EIO; }
1496 static inline void pci_release_regions(struct pci_dev *dev) { }
1497
1498 static inline void pci_block_cfg_access(struct pci_dev *dev) { }
1499 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1500 { return 0; }
1501 static inline void pci_unblock_cfg_access(struct pci_dev *dev) { }
1502
1503 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1504 { return NULL; }
1505 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1506                                                 unsigned int devfn)
1507 { return NULL; }
1508 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1509                                                 unsigned int devfn)
1510 { return NULL; }
1511
1512 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1513 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
1514 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1515
1516 #define dev_is_pci(d) (false)
1517 #define dev_is_pf(d) (false)
1518 #define dev_num_vf(d) (0)
1519 #endif /* CONFIG_PCI */
1520
1521 /* Include architecture-dependent settings and functions */
1522
1523 #include <asm/pci.h>
1524
1525 /* these helpers provide future and backwards compatibility
1526  * for accessing popular PCI BAR info */
1527 #define pci_resource_start(dev, bar)    ((dev)->resource[(bar)].start)
1528 #define pci_resource_end(dev, bar)      ((dev)->resource[(bar)].end)
1529 #define pci_resource_flags(dev, bar)    ((dev)->resource[(bar)].flags)
1530 #define pci_resource_len(dev,bar) \
1531         ((pci_resource_start((dev), (bar)) == 0 &&      \
1532           pci_resource_end((dev), (bar)) ==             \
1533           pci_resource_start((dev), (bar))) ? 0 :       \
1534                                                         \
1535          (pci_resource_end((dev), (bar)) -              \
1536           pci_resource_start((dev), (bar)) + 1))
1537
1538 /* Similar to the helpers above, these manipulate per-pci_dev
1539  * driver-specific data.  They are really just a wrapper around
1540  * the generic device structure functions of these calls.
1541  */
1542 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1543 {
1544         return dev_get_drvdata(&pdev->dev);
1545 }
1546
1547 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1548 {
1549         dev_set_drvdata(&pdev->dev, data);
1550 }
1551
1552 /* If you want to know what to call your pci_dev, ask this function.
1553  * Again, it's a wrapper around the generic device.
1554  */
1555 static inline const char *pci_name(const struct pci_dev *pdev)
1556 {
1557         return dev_name(&pdev->dev);
1558 }
1559
1560
1561 /* Some archs don't want to expose struct resource to userland as-is
1562  * in sysfs and /proc
1563  */
1564 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1565 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1566                 const struct resource *rsrc, resource_size_t *start,
1567                 resource_size_t *end)
1568 {
1569         *start = rsrc->start;
1570         *end = rsrc->end;
1571 }
1572 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1573
1574
1575 /*
1576  *  The world is not perfect and supplies us with broken PCI devices.
1577  *  For at least a part of these bugs we need a work-around, so both
1578  *  generic (drivers/pci/quirks.c) and per-architecture code can define
1579  *  fixup hooks to be called for particular buggy devices.
1580  */
1581
1582 struct pci_fixup {
1583         u16 vendor;             /* You can use PCI_ANY_ID here of course */
1584         u16 device;             /* You can use PCI_ANY_ID here of course */
1585         u32 class;              /* You can use PCI_ANY_ID here too */
1586         unsigned int class_shift;       /* should be 0, 8, 16 */
1587         void (*hook)(struct pci_dev *dev);
1588 };
1589
1590 enum pci_fixup_pass {
1591         pci_fixup_early,        /* Before probing BARs */
1592         pci_fixup_header,       /* After reading configuration header */
1593         pci_fixup_final,        /* Final phase of device fixups */
1594         pci_fixup_enable,       /* pci_enable_device() time */
1595         pci_fixup_resume,       /* pci_device_resume() */
1596         pci_fixup_suspend,      /* pci_device_suspend() */
1597         pci_fixup_resume_early, /* pci_device_resume_early() */
1598         pci_fixup_suspend_late, /* pci_device_suspend_late() */
1599 };
1600
1601 /* Anonymous variables would be nice... */
1602 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1603                                   class_shift, hook)                    \
1604         static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used       \
1605         __attribute__((__section__(#section), aligned((sizeof(void *)))))    \
1606                 = { vendor, device, class, class_shift, hook };
1607
1608 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class,            \
1609                                          class_shift, hook)             \
1610         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1611                 hook, vendor, device, class, class_shift, hook)
1612 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class,           \
1613                                          class_shift, hook)             \
1614         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1615                 hook, vendor, device, class, class_shift, hook)
1616 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class,            \
1617                                          class_shift, hook)             \
1618         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1619                 hook, vendor, device, class, class_shift, hook)
1620 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class,           \
1621                                          class_shift, hook)             \
1622         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1623                 hook, vendor, device, class, class_shift, hook)
1624 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class,           \
1625                                          class_shift, hook)             \
1626         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1627                 resume##hook, vendor, device, class,    \
1628                 class_shift, hook)
1629 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class,     \
1630                                          class_shift, hook)             \
1631         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,              \
1632                 resume_early##hook, vendor, device,     \
1633                 class, class_shift, hook)
1634 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class,          \
1635                                          class_shift, hook)             \
1636         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,                   \
1637                 suspend##hook, vendor, device, class,   \
1638                 class_shift, hook)
1639 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class,     \
1640                                          class_shift, hook)             \
1641         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late,              \
1642                 suspend_late##hook, vendor, device,     \
1643                 class, class_shift, hook)
1644
1645 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
1646         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1647                 hook, vendor, device, PCI_ANY_ID, 0, hook)
1648 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
1649         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1650                 hook, vendor, device, PCI_ANY_ID, 0, hook)
1651 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
1652         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1653                 hook, vendor, device, PCI_ANY_ID, 0, hook)
1654 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
1655         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1656                 hook, vendor, device, PCI_ANY_ID, 0, hook)
1657 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)                  \
1658         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1659                 resume##hook, vendor, device,           \
1660                 PCI_ANY_ID, 0, hook)
1661 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)            \
1662         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,              \
1663                 resume_early##hook, vendor, device,     \
1664                 PCI_ANY_ID, 0, hook)
1665 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)                 \
1666         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,                   \
1667                 suspend##hook, vendor, device,          \
1668                 PCI_ANY_ID, 0, hook)
1669 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook)            \
1670         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late,              \
1671                 suspend_late##hook, vendor, device,     \
1672                 PCI_ANY_ID, 0, hook)
1673
1674 #ifdef CONFIG_PCI_QUIRKS
1675 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1676 int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1677 void pci_dev_specific_enable_acs(struct pci_dev *dev);
1678 #else
1679 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1680                                     struct pci_dev *dev) { }
1681 static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
1682                                                u16 acs_flags)
1683 {
1684         return -ENOTTY;
1685 }
1686 static inline void pci_dev_specific_enable_acs(struct pci_dev *dev) { }
1687 #endif
1688
1689 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1690 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1691 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1692 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1693 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1694                                    const char *name);
1695 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
1696
1697 extern int pci_pci_problems;
1698 #define PCIPCI_FAIL             1       /* No PCI PCI DMA */
1699 #define PCIPCI_TRITON           2
1700 #define PCIPCI_NATOMA           4
1701 #define PCIPCI_VIAETBF          8
1702 #define PCIPCI_VSFX             16
1703 #define PCIPCI_ALIMAGIK         32      /* Need low latency setting */
1704 #define PCIAGP_FAIL             64      /* No PCI to AGP DMA */
1705
1706 extern unsigned long pci_cardbus_io_size;
1707 extern unsigned long pci_cardbus_mem_size;
1708 extern u8 pci_dfl_cache_line_size;
1709 extern u8 pci_cache_line_size;
1710
1711 extern unsigned long pci_hotplug_io_size;
1712 extern unsigned long pci_hotplug_mem_size;
1713
1714 /* Architecture-specific versions may override these (weak) */
1715 void pcibios_disable_device(struct pci_dev *dev);
1716 void pcibios_set_master(struct pci_dev *dev);
1717 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1718                                  enum pcie_reset_state state);
1719 int pcibios_add_device(struct pci_dev *dev);
1720 void pcibios_release_device(struct pci_dev *dev);
1721 void pcibios_penalize_isa_irq(int irq, int active);
1722 int pcibios_alloc_irq(struct pci_dev *dev);
1723 void pcibios_free_irq(struct pci_dev *dev);
1724
1725 #ifdef CONFIG_HIBERNATE_CALLBACKS
1726 extern struct dev_pm_ops pcibios_pm_ops;
1727 #endif
1728
1729 #ifdef CONFIG_PCI_MMCONFIG
1730 void __init pci_mmcfg_early_init(void);
1731 void __init pci_mmcfg_late_init(void);
1732 #else
1733 static inline void pci_mmcfg_early_init(void) { }
1734 static inline void pci_mmcfg_late_init(void) { }
1735 #endif
1736
1737 int pci_ext_cfg_avail(void);
1738
1739 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1740 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
1741
1742 #ifdef CONFIG_PCI_IOV
1743 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
1744 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
1745
1746 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1747 void pci_disable_sriov(struct pci_dev *dev);
1748 int pci_num_vf(struct pci_dev *dev);
1749 int pci_vfs_assigned(struct pci_dev *dev);
1750 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
1751 int pci_sriov_get_totalvfs(struct pci_dev *dev);
1752 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
1753 #else
1754 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
1755 {
1756         return -ENOSYS;
1757 }
1758 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
1759 {
1760         return -ENOSYS;
1761 }
1762 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1763 { return -ENODEV; }
1764 static inline void pci_disable_sriov(struct pci_dev *dev) { }
1765 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
1766 static inline int pci_vfs_assigned(struct pci_dev *dev)
1767 { return 0; }
1768 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
1769 { return 0; }
1770 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
1771 { return 0; }
1772 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
1773 { return 0; }
1774 #endif
1775
1776 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1777 void pci_hp_create_module_link(struct pci_slot *pci_slot);
1778 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1779 #endif
1780
1781 /**
1782  * pci_pcie_cap - get the saved PCIe capability offset
1783  * @dev: PCI device
1784  *
1785  * PCIe capability offset is calculated at PCI device initialization
1786  * time and saved in the data structure. This function returns saved
1787  * PCIe capability offset. Using this instead of pci_find_capability()
1788  * reduces unnecessary search in the PCI configuration space. If you
1789  * need to calculate PCIe capability offset from raw device for some
1790  * reasons, please use pci_find_capability() instead.
1791  */
1792 static inline int pci_pcie_cap(struct pci_dev *dev)
1793 {
1794         return dev->pcie_cap;
1795 }
1796
1797 /**
1798  * pci_is_pcie - check if the PCI device is PCI Express capable
1799  * @dev: PCI device
1800  *
1801  * Returns: true if the PCI device is PCI Express capable, false otherwise.
1802  */
1803 static inline bool pci_is_pcie(struct pci_dev *dev)
1804 {
1805         return pci_pcie_cap(dev);
1806 }
1807
1808 /**
1809  * pcie_caps_reg - get the PCIe Capabilities Register
1810  * @dev: PCI device
1811  */
1812 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
1813 {
1814         return dev->pcie_flags_reg;
1815 }
1816
1817 /**
1818  * pci_pcie_type - get the PCIe device/port type
1819  * @dev: PCI device
1820  */
1821 static inline int pci_pcie_type(const struct pci_dev *dev)
1822 {
1823         return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
1824 }
1825
1826 void pci_request_acs(void);
1827 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
1828 bool pci_acs_path_enabled(struct pci_dev *start,
1829                           struct pci_dev *end, u16 acs_flags);
1830
1831 #define PCI_VPD_LRDT                    0x80    /* Large Resource Data Type */
1832 #define PCI_VPD_LRDT_ID(x)              ((x) | PCI_VPD_LRDT)
1833
1834 /* Large Resource Data Type Tag Item Names */
1835 #define PCI_VPD_LTIN_ID_STRING          0x02    /* Identifier String */
1836 #define PCI_VPD_LTIN_RO_DATA            0x10    /* Read-Only Data */
1837 #define PCI_VPD_LTIN_RW_DATA            0x11    /* Read-Write Data */
1838
1839 #define PCI_VPD_LRDT_ID_STRING          PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
1840 #define PCI_VPD_LRDT_RO_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
1841 #define PCI_VPD_LRDT_RW_DATA            PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
1842
1843 /* Small Resource Data Type Tag Item Names */
1844 #define PCI_VPD_STIN_END                0x0f    /* End */
1845
1846 #define PCI_VPD_SRDT_END                (PCI_VPD_STIN_END << 3)
1847
1848 #define PCI_VPD_SRDT_TIN_MASK           0x78
1849 #define PCI_VPD_SRDT_LEN_MASK           0x07
1850 #define PCI_VPD_LRDT_TIN_MASK           0x7f
1851
1852 #define PCI_VPD_LRDT_TAG_SIZE           3
1853 #define PCI_VPD_SRDT_TAG_SIZE           1
1854
1855 #define PCI_VPD_INFO_FLD_HDR_SIZE       3
1856
1857 #define PCI_VPD_RO_KEYWORD_PARTNO       "PN"
1858 #define PCI_VPD_RO_KEYWORD_MFR_ID       "MN"
1859 #define PCI_VPD_RO_KEYWORD_VENDOR0      "V0"
1860 #define PCI_VPD_RO_KEYWORD_CHKSUM       "RV"
1861
1862 /**
1863  * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
1864  * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1865  *
1866  * Returns the extracted Large Resource Data Type length.
1867  */
1868 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
1869 {
1870         return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
1871 }
1872
1873 /**
1874  * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item
1875  * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1876  *
1877  * Returns the extracted Large Resource Data Type Tag item.
1878  */
1879 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt)
1880 {
1881     return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK);
1882 }
1883
1884 /**
1885  * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
1886  * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1887  *
1888  * Returns the extracted Small Resource Data Type length.
1889  */
1890 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
1891 {
1892         return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
1893 }
1894
1895 /**
1896  * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item
1897  * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1898  *
1899  * Returns the extracted Small Resource Data Type Tag Item.
1900  */
1901 static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
1902 {
1903         return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3;
1904 }
1905
1906 /**
1907  * pci_vpd_info_field_size - Extracts the information field length
1908  * @lrdt: Pointer to the beginning of an information field header
1909  *
1910  * Returns the extracted information field length.
1911  */
1912 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
1913 {
1914         return info_field[2];
1915 }
1916
1917 /**
1918  * pci_vpd_find_tag - Locates the Resource Data Type tag provided
1919  * @buf: Pointer to buffered vpd data
1920  * @off: The offset into the buffer at which to begin the search
1921  * @len: The length of the vpd buffer
1922  * @rdt: The Resource Data Type to search for
1923  *
1924  * Returns the index where the Resource Data Type was found or
1925  * -ENOENT otherwise.
1926  */
1927 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
1928
1929 /**
1930  * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
1931  * @buf: Pointer to buffered vpd data
1932  * @off: The offset into the buffer at which to begin the search
1933  * @len: The length of the buffer area, relative to off, in which to search
1934  * @kw: The keyword to search for
1935  *
1936  * Returns the index where the information field keyword was found or
1937  * -ENOENT otherwise.
1938  */
1939 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
1940                               unsigned int len, const char *kw);
1941
1942 /* PCI <-> OF binding helpers */
1943 #ifdef CONFIG_OF
1944 struct device_node;
1945 struct irq_domain;
1946 void pci_set_of_node(struct pci_dev *dev);
1947 void pci_release_of_node(struct pci_dev *dev);
1948 void pci_set_bus_of_node(struct pci_bus *bus);
1949 void pci_release_bus_of_node(struct pci_bus *bus);
1950 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
1951
1952 /* Arch may override this (weak) */
1953 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
1954
1955 static inline struct device_node *
1956 pci_device_to_OF_node(const struct pci_dev *pdev)
1957 {
1958         return pdev ? pdev->dev.of_node : NULL;
1959 }
1960
1961 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
1962 {
1963         return bus ? bus->dev.of_node : NULL;
1964 }
1965
1966 #else /* CONFIG_OF */
1967 static inline void pci_set_of_node(struct pci_dev *dev) { }
1968 static inline void pci_release_of_node(struct pci_dev *dev) { }
1969 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
1970 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
1971 static inline struct device_node *
1972 pci_device_to_OF_node(const struct pci_dev *pdev) { return NULL; }
1973 static inline struct irq_domain *
1974 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
1975 #endif  /* CONFIG_OF */
1976
1977 #ifdef CONFIG_ACPI
1978 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
1979
1980 void
1981 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
1982 #else
1983 static inline struct irq_domain *
1984 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
1985 #endif
1986
1987 #ifdef CONFIG_EEH
1988 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
1989 {
1990         return pdev->dev.archdata.edev;
1991 }
1992 #endif
1993
1994 int pci_for_each_dma_alias(struct pci_dev *pdev,
1995                            int (*fn)(struct pci_dev *pdev,
1996                                      u16 alias, void *data), void *data);
1997
1998 /* helper functions for operation of device flag */
1999 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2000 {
2001         pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2002 }
2003 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2004 {
2005         pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2006 }
2007 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2008 {
2009         return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2010 }
2011
2012 /**
2013  * pci_ari_enabled - query ARI forwarding status
2014  * @bus: the PCI bus
2015  *
2016  * Returns true if ARI forwarding is enabled.
2017  */
2018 static inline bool pci_ari_enabled(struct pci_bus *bus)
2019 {
2020         return bus->self && bus->self->ari_enabled;
2021 }
2022
2023 /* provide the legacy pci_dma_* API */
2024 #include <linux/pci-dma-compat.h>
2025
2026 #endif /* LINUX_PCI_H */