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