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