Merge tags 'for-linus' and 'for-next' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / drivers / pci / pci.h
CommitLineData
557848c3
ZY
1#ifndef DRIVERS_PCI_H
2#define DRIVERS_PCI_H
3
fff905f3
WY
4#define PCI_FIND_CAP_TTL 48
5
8531e283
LW
6#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
7
343e51ae
JK
8extern const unsigned char pcie_link_speed[];
9
7a1562d4
YL
10bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
11
1da177e4
LT
12/* Functions internal to the PCI core code */
13
f39d5b72
BH
14int pci_create_sysfs_dev_files(struct pci_dev *pdev);
15void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
6058989b 16#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
911e1c9b 17static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
b879743f 18{ return; }
911e1c9b 19static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
b879743f 20{ return; }
911e1c9b 21#else
f39d5b72
BH
22void pci_create_firmware_label_files(struct pci_dev *pdev);
23void pci_remove_firmware_label_files(struct pci_dev *pdev);
911e1c9b 24#endif
f39d5b72 25void pci_cleanup_rom(struct pci_dev *dev);
f7195824 26
3b519e4e
MW
27enum pci_mmap_api {
28 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
29 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
30};
f39d5b72
BH
31int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
32 enum pci_mmap_api mmap_api);
f7195824 33
711d5779 34int pci_probe_reset_function(struct pci_dev *dev);
ce5ccdef 35
961d9120 36/**
b33bfdef 37 * struct pci_platform_pm_ops - Firmware PM callbacks
961d9120 38 *
b33bfdef
RD
39 * @is_manageable: returns 'true' if given device is power manageable by the
40 * platform firmware
961d9120 41 *
b33bfdef 42 * @set_state: invokes the platform firmware to set the device's power state
961d9120 43 *
cc7cc02b
LW
44 * @get_state: queries the platform firmware for a device's current power state
45 *
b33bfdef
RD
46 * @choose_state: returns PCI power state of given device preferred by the
47 * platform; to be used during system-wide transitions from a
48 * sleeping state to the working state and vice versa
961d9120 49 *
b33bfdef 50 * @sleep_wake: enables/disables the system wake up capability of given device
eb9d0fe4 51 *
b67ea761
RW
52 * @run_wake: enables/disables the platform to generate run-time wake-up events
53 * for given device (the device's wake-up capability has to be
54 * enabled by @sleep_wake for this feature to work)
55 *
bac2a909
RW
56 * @need_resume: returns 'true' if the given device (which is currently
57 * suspended) needs to be resumed to be configured for system
58 * wakeup.
59 *
961d9120
RW
60 * If given platform is generally capable of power managing PCI devices, all of
61 * these callbacks are mandatory.
62 */
63struct pci_platform_pm_ops {
64 bool (*is_manageable)(struct pci_dev *dev);
65 int (*set_state)(struct pci_dev *dev, pci_power_t state);
cc7cc02b 66 pci_power_t (*get_state)(struct pci_dev *dev);
961d9120 67 pci_power_t (*choose_state)(struct pci_dev *dev);
eb9d0fe4 68 int (*sleep_wake)(struct pci_dev *dev, bool enable);
b67ea761 69 int (*run_wake)(struct pci_dev *dev, bool enable);
bac2a909 70 bool (*need_resume)(struct pci_dev *dev);
961d9120
RW
71};
72
299f2ffe 73int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
f39d5b72
BH
74void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
75void pci_power_up(struct pci_dev *dev);
76void pci_disable_enabled_device(struct pci_dev *dev);
77int pci_finish_runtime_suspend(struct pci_dev *dev);
78int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
bac2a909 79bool pci_dev_keep_suspended(struct pci_dev *dev);
2cef548a 80void pci_dev_complete_resume(struct pci_dev *pci_dev);
f39d5b72
BH
81void pci_config_pm_runtime_get(struct pci_dev *dev);
82void pci_config_pm_runtime_put(struct pci_dev *dev);
83void pci_pm_init(struct pci_dev *dev);
938174e5 84void pci_ea_init(struct pci_dev *dev);
f39d5b72 85void pci_allocate_cap_save_buffers(struct pci_dev *dev);
f796841e 86void pci_free_cap_save_buffers(struct pci_dev *dev);
c6a63307 87bool pci_bridge_d3_possible(struct pci_dev *dev);
1ed276a7 88void pci_bridge_d3_update(struct pci_dev *dev);
aa8c6c93 89
b6e335ae
RW
90static inline void pci_wakeup_event(struct pci_dev *dev)
91{
92 /* Wait 100 ms before the system can be put into a sleep state. */
93 pm_wakeup_event(&dev->dev, 100);
94}
95
326c1cda 96static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
aa8c6c93
RW
97{
98 return !!(pci_dev->subordinate);
99}
0f64474b 100
9d26d3a8
MW
101static inline bool pci_power_manageable(struct pci_dev *pci_dev)
102{
103 /*
104 * Currently we allow normal PCI devices and PCI bridges transition
105 * into D3 if their bridge_d3 is set.
106 */
107 return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
108}
109
94e61088 110struct pci_vpd_ops {
287d19ce
SH
111 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
112 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
cb92148b 113 int (*set_size)(struct pci_dev *dev, size_t len);
94e61088
BH
114};
115
116struct pci_vpd {
287d19ce 117 const struct pci_vpd_ops *ops;
94e61088 118 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
408641e9
BH
119 struct mutex lock;
120 unsigned int len;
121 u16 flag;
122 u8 cap;
123 u8 busy:1;
124 u8 valid:1;
94e61088
BH
125};
126
f1cd93f9 127int pci_vpd_init(struct pci_dev *dev);
64379079 128void pci_vpd_release(struct pci_dev *dev);
94e61088 129
1da177e4
LT
130/* PCI /proc functions */
131#ifdef CONFIG_PROC_FS
f39d5b72
BH
132int pci_proc_attach_device(struct pci_dev *dev);
133int pci_proc_detach_device(struct pci_dev *dev);
134int pci_proc_detach_bus(struct pci_bus *bus);
1da177e4
LT
135#else
136static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
137static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
1da177e4
LT
138static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
139#endif
140
141/* Functions for PCI Hotplug drivers to use */
a8e4b9c1 142int pci_hp_add_bridge(struct pci_dev *dev);
1da177e4 143
f19aeb1f 144#ifdef HAVE_PCI_LEGACY
f39d5b72
BH
145void pci_create_legacy_files(struct pci_bus *bus);
146void pci_remove_legacy_files(struct pci_bus *bus);
f19aeb1f
BH
147#else
148static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
149static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
150#endif
1da177e4
LT
151
152/* Lock for read/write access to pci device and bus lists */
d71374da 153extern struct rw_semaphore pci_bus_sem;
1da177e4 154
a2e27787
JK
155extern raw_spinlock_t pci_lock;
156
ffadcc2f 157extern unsigned int pci_pm_d3_delay;
88187dfa 158
4b47b0ee 159#ifdef CONFIG_PCI_MSI
309e57df 160void pci_no_msi(void);
4b47b0ee 161#else
309e57df 162static inline void pci_no_msi(void) { }
4b47b0ee 163#endif
8fed4b65 164
6a25f5e3
MT
165static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
166{
167 u16 control;
168
169 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
170 control &= ~PCI_MSI_FLAGS_ENABLE;
171 if (enable)
172 control |= PCI_MSI_FLAGS_ENABLE;
173 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
174}
175
176static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
177{
178 u16 ctrl;
179
180 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
181 ctrl &= ~clear;
182 ctrl |= set;
183 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
184}
185
b55438fd 186void pci_realloc_get_opt(char *);
f483d392 187
ffadcc2f
KCA
188static inline int pci_no_d1d2(struct pci_dev *dev)
189{
190 unsigned int parent_dstates = 0;
4b47b0ee 191
ffadcc2f
KCA
192 if (dev->bus->self)
193 parent_dstates = dev->bus->self->no_d1d2;
194 return (dev->no_d1d2 || parent_dstates);
195
196}
5136b2da 197extern const struct attribute_group *pci_dev_groups[];
56039e65 198extern const struct attribute_group *pcibus_groups[];
4e15c46b 199extern struct device_type pci_dev_type;
0f49ba55 200extern const struct attribute_group *pci_bus_groups[];
705b1aaa 201
1da177e4
LT
202
203/**
204 * pci_match_one_device - Tell if a PCI device structure has a matching
205 * PCI device id structure
206 * @id: single PCI device id structure to match
207 * @dev: the PCI device structure to match against
367b09fe 208 *
1da177e4
LT
209 * Returns the matching pci_device_id structure or %NULL if there is no match.
210 */
211static inline const struct pci_device_id *
212pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
213{
214 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
215 (id->device == PCI_ANY_ID || id->device == dev->device) &&
216 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
217 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
218 !((id->class ^ dev->class) & id->class_mask))
219 return id;
220 return NULL;
221}
222
f46753c5
AC
223/* PCI slot sysfs helper code */
224#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
225
226extern struct kset *pci_slots_kset;
227
228struct pci_slot_attribute {
229 struct attribute attr;
230 ssize_t (*show)(struct pci_slot *, char *);
231 ssize_t (*store)(struct pci_slot *, const char *, size_t);
232};
233#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
234
0b400c7e
YZ
235enum pci_bar_type {
236 pci_bar_unknown, /* Standard PCI BAR probe */
237 pci_bar_io, /* An io port BAR */
238 pci_bar_mem32, /* A 32-bit memory BAR */
239 pci_bar_mem64, /* A 64-bit memory BAR */
240};
241
efdc87da
YL
242bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
243 int crs_timeout);
f39d5b72
BH
244int pci_setup_device(struct pci_dev *dev);
245int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
246 struct resource *res, unsigned int reg);
f39d5b72 247void pci_configure_ari(struct pci_dev *dev);
10874f5a 248void __pci_bus_size_bridges(struct pci_bus *bus,
d66ecb72 249 struct list_head *realloc_head);
10874f5a
BH
250void __pci_bus_assign_resources(const struct pci_bus *bus,
251 struct list_head *realloc_head,
252 struct list_head *fail_head);
0f7e7aee 253bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
939de1d6 254
2069ecfb 255void pci_reassigndev_resource_alignment(struct pci_dev *dev);
f39d5b72 256void pci_disable_bridge_window(struct pci_dev *dev);
32a9a682 257
d1b054da
YZ
258/* Single Root I/O Virtualization */
259struct pci_sriov {
260 int pos; /* capability position */
261 int nres; /* number of resources */
262 u32 cap; /* SR-IOV Capabilities */
263 u16 ctrl; /* SR-IOV Control */
6b136724
BH
264 u16 total_VFs; /* total VFs associated with the PF */
265 u16 initial_VFs; /* initial VFs associated with the PF */
266 u16 num_VFs; /* number of VFs available */
d1b054da
YZ
267 u16 offset; /* first VF Routing ID offset */
268 u16 stride; /* following VF stride */
269 u32 pgsz; /* page size for BAR alignment */
270 u8 link; /* Function Dependency Link */
4449f079 271 u8 max_VF_buses; /* max buses consumed by VFs */
6b136724 272 u16 driver_max_VFs; /* max num VFs driver supports */
d1b054da
YZ
273 struct pci_dev *dev; /* lowest numbered PF */
274 struct pci_dev *self; /* this PF */
5b0948df 275 struct mutex lock; /* lock for setting sriov_numvfs in sysfs */
0e6c9122 276 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
0e7df224 277 bool drivers_autoprobe; /* auto probing of VFs by driver */
d1b054da
YZ
278};
279
89ee9f76
KB
280/* pci_dev priv_flags */
281#define PCI_DEV_DISCONNECTED 0
282
283static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
284{
285 set_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
286 return 0;
287}
288
289static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
290{
291 return test_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
292}
293
1900ca13 294#ifdef CONFIG_PCI_ATS
f39d5b72 295void pci_restore_ats_state(struct pci_dev *dev);
1900ca13
HX
296#else
297static inline void pci_restore_ats_state(struct pci_dev *dev)
298{
299}
300#endif /* CONFIG_PCI_ATS */
301
d1b054da 302#ifdef CONFIG_PCI_IOV
f39d5b72
BH
303int pci_iov_init(struct pci_dev *dev);
304void pci_iov_release(struct pci_dev *dev);
6ffa2489 305void pci_iov_update_resource(struct pci_dev *dev, int resno);
f39d5b72
BH
306resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
307void pci_restore_iov_state(struct pci_dev *dev);
308int pci_iov_bus_range(struct pci_bus *bus);
302b4215 309
d1b054da
YZ
310#else
311static inline int pci_iov_init(struct pci_dev *dev)
312{
313 return -ENODEV;
314}
315static inline void pci_iov_release(struct pci_dev *dev)
316
317{
318}
8c5cdb6a
YZ
319static inline void pci_restore_iov_state(struct pci_dev *dev)
320{
321}
a28724b0
YZ
322static inline int pci_iov_bus_range(struct pci_bus *bus)
323{
324 return 0;
325}
302b4215 326
d1b054da
YZ
327#endif /* CONFIG_PCI_IOV */
328
f39d5b72 329unsigned long pci_cardbus_resource_alignment(struct resource *);
0a2daa1c 330
0e52247a 331static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
f39d5b72 332 struct resource *res)
6faf17f6
CW
333{
334#ifdef CONFIG_PCI_IOV
335 int resno = res - dev->resource;
336
337 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
338 return pci_sriov_resource_alignment(dev, resno);
339#endif
0a2daa1c
RP
340 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
341 return pci_cardbus_resource_alignment(res);
6faf17f6
CW
342 return resource_alignment(res);
343}
344
f39d5b72 345void pci_enable_acs(struct pci_dev *dev);
ae21ee65 346
9bb04a0c
JY
347#ifdef CONFIG_PCIE_PTM
348void pci_ptm_init(struct pci_dev *dev);
349#else
350static inline void pci_ptm_init(struct pci_dev *dev) { }
351#endif
352
b9c3b266
DC
353struct pci_dev_reset_methods {
354 u16 vendor;
355 u16 device;
356 int (*reset)(struct pci_dev *dev, int probe);
357};
358
93177a74 359#ifdef CONFIG_PCI_QUIRKS
f39d5b72 360int pci_dev_specific_reset(struct pci_dev *dev, int probe);
93177a74
RW
361#else
362static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
363{
364 return -ENOTTY;
365}
366#endif
b9c3b266 367
169de969
DL
368#if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
369int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
370 struct resource *res);
371#endif
372
557848c3 373#endif /* DRIVERS_PCI_H */