Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef DRIVERS_PCI_H
3#define DRIVERS_PCI_H
4
5#include <linux/pci.h>
6
7/* Number of possible devfns: 0.0 to 1f.7 inclusive */
8#define MAX_NR_DEVFNS 256
9
10#define PCI_FIND_CAP_TTL 48
11
12#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
13
14extern const unsigned char pcie_link_speed[];
15extern bool pci_early_dump;
16
17bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
18bool pcie_cap_has_lnkctl2(const struct pci_dev *dev);
19bool pcie_cap_has_rtctl(const struct pci_dev *dev);
20
21/* Functions internal to the PCI core code */
22
23int pci_create_sysfs_dev_files(struct pci_dev *pdev);
24void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
25void pci_cleanup_rom(struct pci_dev *dev);
26#ifdef CONFIG_DMI
27extern const struct attribute_group pci_dev_smbios_attr_group;
28#endif
29
30enum pci_mmap_api {
31 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
32 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
33};
34int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
35 enum pci_mmap_api mmap_api);
36
37bool pci_reset_supported(struct pci_dev *dev);
38void pci_init_reset_methods(struct pci_dev *dev);
39int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
40int pci_bus_error_reset(struct pci_dev *dev);
41
42struct pci_cap_saved_data {
43 u16 cap_nr;
44 bool cap_extended;
45 unsigned int size;
46 u32 data[];
47};
48
49struct pci_cap_saved_state {
50 struct hlist_node next;
51 struct pci_cap_saved_data cap;
52};
53
54void pci_allocate_cap_save_buffers(struct pci_dev *dev);
55void pci_free_cap_save_buffers(struct pci_dev *dev);
56int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
57int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
58 u16 cap, unsigned int size);
59struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
60struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
61 u16 cap);
62
63#define PCI_PM_D2_DELAY 200 /* usec; see PCIe r4.0, sec 5.9.1 */
64#define PCI_PM_D3HOT_WAIT 10 /* msec */
65#define PCI_PM_D3COLD_WAIT 100 /* msec */
66
67void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
68void pci_refresh_power_state(struct pci_dev *dev);
69int pci_power_up(struct pci_dev *dev);
70void pci_disable_enabled_device(struct pci_dev *dev);
71int pci_finish_runtime_suspend(struct pci_dev *dev);
72void pcie_clear_device_status(struct pci_dev *dev);
73void pcie_clear_root_pme_status(struct pci_dev *dev);
74bool pci_check_pme_status(struct pci_dev *dev);
75void pci_pme_wakeup_bus(struct pci_bus *bus);
76int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
77void pci_pme_restore(struct pci_dev *dev);
78bool pci_dev_need_resume(struct pci_dev *dev);
79void pci_dev_adjust_pme(struct pci_dev *dev);
80void pci_dev_complete_resume(struct pci_dev *pci_dev);
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);
84void pci_ea_init(struct pci_dev *dev);
85void pci_msi_init(struct pci_dev *dev);
86void pci_msix_init(struct pci_dev *dev);
87bool pci_bridge_d3_possible(struct pci_dev *dev);
88void pci_bridge_d3_update(struct pci_dev *dev);
89void pci_bridge_wait_for_secondary_bus(struct pci_dev *dev);
90void pci_bridge_reconfigure_ltr(struct pci_dev *dev);
91
92static inline void pci_wakeup_event(struct pci_dev *dev)
93{
94 /* Wait 100 ms before the system can be put into a sleep state. */
95 pm_wakeup_event(&dev->dev, 100);
96}
97
98static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
99{
100 return !!(pci_dev->subordinate);
101}
102
103static inline bool pci_power_manageable(struct pci_dev *pci_dev)
104{
105 /*
106 * Currently we allow normal PCI devices and PCI bridges transition
107 * into D3 if their bridge_d3 is set.
108 */
109 return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
110}
111
112static inline bool pcie_downstream_port(const struct pci_dev *dev)
113{
114 int type = pci_pcie_type(dev);
115
116 return type == PCI_EXP_TYPE_ROOT_PORT ||
117 type == PCI_EXP_TYPE_DOWNSTREAM ||
118 type == PCI_EXP_TYPE_PCIE_BRIDGE;
119}
120
121void pci_vpd_init(struct pci_dev *dev);
122void pci_vpd_release(struct pci_dev *dev);
123extern const struct attribute_group pci_dev_vpd_attr_group;
124
125/* PCI Virtual Channel */
126int pci_save_vc_state(struct pci_dev *dev);
127void pci_restore_vc_state(struct pci_dev *dev);
128void pci_allocate_vc_save_buffers(struct pci_dev *dev);
129
130/* PCI /proc functions */
131#ifdef CONFIG_PROC_FS
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);
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; }
138static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
139#endif
140
141/* Functions for PCI Hotplug drivers to use */
142int pci_hp_add_bridge(struct pci_dev *dev);
143
144#ifdef HAVE_PCI_LEGACY
145void pci_create_legacy_files(struct pci_bus *bus);
146void pci_remove_legacy_files(struct pci_bus *bus);
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
151
152/* Lock for read/write access to pci device and bus lists */
153extern struct rw_semaphore pci_bus_sem;
154extern struct mutex pci_slot_mutex;
155
156extern raw_spinlock_t pci_lock;
157
158extern unsigned int pci_pm_d3hot_delay;
159
160#ifdef CONFIG_PCI_MSI
161void pci_no_msi(void);
162#else
163static inline void pci_no_msi(void) { }
164#endif
165
166void pci_realloc_get_opt(char *);
167
168static inline int pci_no_d1d2(struct pci_dev *dev)
169{
170 unsigned int parent_dstates = 0;
171
172 if (dev->bus->self)
173 parent_dstates = dev->bus->self->no_d1d2;
174 return (dev->no_d1d2 || parent_dstates);
175
176}
177extern const struct attribute_group *pci_dev_groups[];
178extern const struct attribute_group *pcibus_groups[];
179extern const struct device_type pci_dev_type;
180extern const struct attribute_group *pci_bus_groups[];
181
182extern unsigned long pci_hotplug_io_size;
183extern unsigned long pci_hotplug_mmio_size;
184extern unsigned long pci_hotplug_mmio_pref_size;
185extern unsigned long pci_hotplug_bus_size;
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
192 *
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
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
219enum pci_bar_type {
220 pci_bar_unknown, /* Standard PCI BAR probe */
221 pci_bar_io, /* An I/O port BAR */
222 pci_bar_mem32, /* A 32-bit memory BAR */
223 pci_bar_mem64, /* A 64-bit memory BAR */
224};
225
226struct device *pci_get_host_bridge_device(struct pci_dev *dev);
227void pci_put_host_bridge_device(struct device *dev);
228
229int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
230bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
231 int crs_timeout);
232bool pci_bus_generic_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
233 int crs_timeout);
234int pci_idt_bus_quirk(struct pci_bus *bus, int devfn, u32 *pl, int crs_timeout);
235
236int pci_setup_device(struct pci_dev *dev);
237int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
238 struct resource *res, unsigned int reg);
239void pci_configure_ari(struct pci_dev *dev);
240void __pci_bus_size_bridges(struct pci_bus *bus,
241 struct list_head *realloc_head);
242void __pci_bus_assign_resources(const struct pci_bus *bus,
243 struct list_head *realloc_head,
244 struct list_head *fail_head);
245bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
246
247void pci_reassigndev_resource_alignment(struct pci_dev *dev);
248void pci_disable_bridge_window(struct pci_dev *dev);
249struct pci_bus *pci_bus_get(struct pci_bus *bus);
250void pci_bus_put(struct pci_bus *bus);
251
252/* PCIe link information from Link Capabilities 2 */
253#define PCIE_LNKCAP2_SLS2SPEED(lnkcap2) \
254 ((lnkcap2) & PCI_EXP_LNKCAP2_SLS_64_0GB ? PCIE_SPEED_64_0GT : \
255 (lnkcap2) & PCI_EXP_LNKCAP2_SLS_32_0GB ? PCIE_SPEED_32_0GT : \
256 (lnkcap2) & PCI_EXP_LNKCAP2_SLS_16_0GB ? PCIE_SPEED_16_0GT : \
257 (lnkcap2) & PCI_EXP_LNKCAP2_SLS_8_0GB ? PCIE_SPEED_8_0GT : \
258 (lnkcap2) & PCI_EXP_LNKCAP2_SLS_5_0GB ? PCIE_SPEED_5_0GT : \
259 (lnkcap2) & PCI_EXP_LNKCAP2_SLS_2_5GB ? PCIE_SPEED_2_5GT : \
260 PCI_SPEED_UNKNOWN)
261
262/* PCIe speed to Mb/s reduced by encoding overhead */
263#define PCIE_SPEED2MBS_ENC(speed) \
264 ((speed) == PCIE_SPEED_64_0GT ? 64000*128/130 : \
265 (speed) == PCIE_SPEED_32_0GT ? 32000*128/130 : \
266 (speed) == PCIE_SPEED_16_0GT ? 16000*128/130 : \
267 (speed) == PCIE_SPEED_8_0GT ? 8000*128/130 : \
268 (speed) == PCIE_SPEED_5_0GT ? 5000*8/10 : \
269 (speed) == PCIE_SPEED_2_5GT ? 2500*8/10 : \
270 0)
271
272const char *pci_speed_string(enum pci_bus_speed speed);
273enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
274enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
275u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
276 enum pcie_link_width *width);
277void __pcie_print_link_status(struct pci_dev *dev, bool verbose);
278void pcie_report_downtraining(struct pci_dev *dev);
279void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
280
281/* Single Root I/O Virtualization */
282struct pci_sriov {
283 int pos; /* Capability position */
284 int nres; /* Number of resources */
285 u32 cap; /* SR-IOV Capabilities */
286 u16 ctrl; /* SR-IOV Control */
287 u16 total_VFs; /* Total VFs associated with the PF */
288 u16 initial_VFs; /* Initial VFs associated with the PF */
289 u16 num_VFs; /* Number of VFs available */
290 u16 offset; /* First VF Routing ID offset */
291 u16 stride; /* Following VF stride */
292 u16 vf_device; /* VF device ID */
293 u32 pgsz; /* Page size for BAR alignment */
294 u8 link; /* Function Dependency Link */
295 u8 max_VF_buses; /* Max buses consumed by VFs */
296 u16 driver_max_VFs; /* Max num VFs driver supports */
297 struct pci_dev *dev; /* Lowest numbered PF */
298 struct pci_dev *self; /* This PF */
299 u32 class; /* VF device */
300 u8 hdr_type; /* VF header type */
301 u16 subsystem_vendor; /* VF subsystem vendor */
302 u16 subsystem_device; /* VF subsystem device */
303 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
304 bool drivers_autoprobe; /* Auto probing of VFs by driver */
305};
306
307/**
308 * pci_dev_set_io_state - Set the new error state if possible.
309 *
310 * @dev: PCI device to set new error_state
311 * @new: the state we want dev to be in
312 *
313 * Must be called with device_lock held.
314 *
315 * Returns true if state has been changed to the requested state.
316 */
317static inline bool pci_dev_set_io_state(struct pci_dev *dev,
318 pci_channel_state_t new)
319{
320 bool changed = false;
321
322 device_lock_assert(&dev->dev);
323 switch (new) {
324 case pci_channel_io_perm_failure:
325 switch (dev->error_state) {
326 case pci_channel_io_frozen:
327 case pci_channel_io_normal:
328 case pci_channel_io_perm_failure:
329 changed = true;
330 break;
331 }
332 break;
333 case pci_channel_io_frozen:
334 switch (dev->error_state) {
335 case pci_channel_io_frozen:
336 case pci_channel_io_normal:
337 changed = true;
338 break;
339 }
340 break;
341 case pci_channel_io_normal:
342 switch (dev->error_state) {
343 case pci_channel_io_frozen:
344 case pci_channel_io_normal:
345 changed = true;
346 break;
347 }
348 break;
349 }
350 if (changed)
351 dev->error_state = new;
352 return changed;
353}
354
355static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
356{
357 device_lock(&dev->dev);
358 pci_dev_set_io_state(dev, pci_channel_io_perm_failure);
359 device_unlock(&dev->dev);
360
361 return 0;
362}
363
364static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
365{
366 return dev->error_state == pci_channel_io_perm_failure;
367}
368
369/* pci_dev priv_flags */
370#define PCI_DEV_ADDED 0
371#define PCI_DPC_RECOVERED 1
372#define PCI_DPC_RECOVERING 2
373
374static inline void pci_dev_assign_added(struct pci_dev *dev, bool added)
375{
376 assign_bit(PCI_DEV_ADDED, &dev->priv_flags, added);
377}
378
379static inline bool pci_dev_is_added(const struct pci_dev *dev)
380{
381 return test_bit(PCI_DEV_ADDED, &dev->priv_flags);
382}
383
384#ifdef CONFIG_PCIEAER
385#include <linux/aer.h>
386
387#define AER_MAX_MULTI_ERR_DEVICES 5 /* Not likely to have more */
388
389struct aer_err_info {
390 struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
391 int error_dev_num;
392
393 unsigned int id:16;
394
395 unsigned int severity:2; /* 0:NONFATAL | 1:FATAL | 2:COR */
396 unsigned int __pad1:5;
397 unsigned int multi_error_valid:1;
398
399 unsigned int first_error:5;
400 unsigned int __pad2:2;
401 unsigned int tlp_header_valid:1;
402
403 unsigned int status; /* COR/UNCOR Error Status */
404 unsigned int mask; /* COR/UNCOR Error Mask */
405 struct aer_header_log_regs tlp; /* TLP Header */
406};
407
408int aer_get_device_error_info(struct pci_dev *dev, struct aer_err_info *info);
409void aer_print_error(struct pci_dev *dev, struct aer_err_info *info);
410#endif /* CONFIG_PCIEAER */
411
412#ifdef CONFIG_PCIEPORTBUS
413/* Cached RCEC Endpoint Association */
414struct rcec_ea {
415 u8 nextbusn;
416 u8 lastbusn;
417 u32 bitmap;
418};
419#endif
420
421#ifdef CONFIG_PCIE_DPC
422void pci_save_dpc_state(struct pci_dev *dev);
423void pci_restore_dpc_state(struct pci_dev *dev);
424void pci_dpc_init(struct pci_dev *pdev);
425void dpc_process_error(struct pci_dev *pdev);
426pci_ers_result_t dpc_reset_link(struct pci_dev *pdev);
427bool pci_dpc_recovered(struct pci_dev *pdev);
428#else
429static inline void pci_save_dpc_state(struct pci_dev *dev) {}
430static inline void pci_restore_dpc_state(struct pci_dev *dev) {}
431static inline void pci_dpc_init(struct pci_dev *pdev) {}
432static inline bool pci_dpc_recovered(struct pci_dev *pdev) { return false; }
433#endif
434
435#ifdef CONFIG_PCIEPORTBUS
436void pci_rcec_init(struct pci_dev *dev);
437void pci_rcec_exit(struct pci_dev *dev);
438void pcie_link_rcec(struct pci_dev *rcec);
439void pcie_walk_rcec(struct pci_dev *rcec,
440 int (*cb)(struct pci_dev *, void *),
441 void *userdata);
442#else
443static inline void pci_rcec_init(struct pci_dev *dev) {}
444static inline void pci_rcec_exit(struct pci_dev *dev) {}
445static inline void pcie_link_rcec(struct pci_dev *rcec) {}
446static inline void pcie_walk_rcec(struct pci_dev *rcec,
447 int (*cb)(struct pci_dev *, void *),
448 void *userdata) {}
449#endif
450
451#ifdef CONFIG_PCI_ATS
452/* Address Translation Service */
453void pci_ats_init(struct pci_dev *dev);
454void pci_restore_ats_state(struct pci_dev *dev);
455#else
456static inline void pci_ats_init(struct pci_dev *d) { }
457static inline void pci_restore_ats_state(struct pci_dev *dev) { }
458#endif /* CONFIG_PCI_ATS */
459
460#ifdef CONFIG_PCI_PRI
461void pci_pri_init(struct pci_dev *dev);
462void pci_restore_pri_state(struct pci_dev *pdev);
463#else
464static inline void pci_pri_init(struct pci_dev *dev) { }
465static inline void pci_restore_pri_state(struct pci_dev *pdev) { }
466#endif
467
468#ifdef CONFIG_PCI_PASID
469void pci_pasid_init(struct pci_dev *dev);
470void pci_restore_pasid_state(struct pci_dev *pdev);
471#else
472static inline void pci_pasid_init(struct pci_dev *dev) { }
473static inline void pci_restore_pasid_state(struct pci_dev *pdev) { }
474#endif
475
476#ifdef CONFIG_PCI_IOV
477int pci_iov_init(struct pci_dev *dev);
478void pci_iov_release(struct pci_dev *dev);
479void pci_iov_remove(struct pci_dev *dev);
480void pci_iov_update_resource(struct pci_dev *dev, int resno);
481resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
482void pci_restore_iov_state(struct pci_dev *dev);
483int pci_iov_bus_range(struct pci_bus *bus);
484extern const struct attribute_group sriov_pf_dev_attr_group;
485extern const struct attribute_group sriov_vf_dev_attr_group;
486#else
487static inline int pci_iov_init(struct pci_dev *dev)
488{
489 return -ENODEV;
490}
491static inline void pci_iov_release(struct pci_dev *dev)
492
493{
494}
495static inline void pci_iov_remove(struct pci_dev *dev)
496{
497}
498static inline void pci_restore_iov_state(struct pci_dev *dev)
499{
500}
501static inline int pci_iov_bus_range(struct pci_bus *bus)
502{
503 return 0;
504}
505
506#endif /* CONFIG_PCI_IOV */
507
508#ifdef CONFIG_PCIE_PTM
509void pci_ptm_init(struct pci_dev *dev);
510void pci_save_ptm_state(struct pci_dev *dev);
511void pci_restore_ptm_state(struct pci_dev *dev);
512void pci_suspend_ptm(struct pci_dev *dev);
513void pci_resume_ptm(struct pci_dev *dev);
514#else
515static inline void pci_ptm_init(struct pci_dev *dev) { }
516static inline void pci_save_ptm_state(struct pci_dev *dev) { }
517static inline void pci_restore_ptm_state(struct pci_dev *dev) { }
518static inline void pci_suspend_ptm(struct pci_dev *dev) { }
519static inline void pci_resume_ptm(struct pci_dev *dev) { }
520#endif
521
522unsigned long pci_cardbus_resource_alignment(struct resource *);
523
524static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
525 struct resource *res)
526{
527#ifdef CONFIG_PCI_IOV
528 int resno = res - dev->resource;
529
530 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
531 return pci_sriov_resource_alignment(dev, resno);
532#endif
533 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
534 return pci_cardbus_resource_alignment(res);
535 return resource_alignment(res);
536}
537
538void pci_acs_init(struct pci_dev *dev);
539#ifdef CONFIG_PCI_QUIRKS
540int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
541int pci_dev_specific_enable_acs(struct pci_dev *dev);
542int pci_dev_specific_disable_acs_redir(struct pci_dev *dev);
543#else
544static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
545 u16 acs_flags)
546{
547 return -ENOTTY;
548}
549static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
550{
551 return -ENOTTY;
552}
553static inline int pci_dev_specific_disable_acs_redir(struct pci_dev *dev)
554{
555 return -ENOTTY;
556}
557#endif
558
559/* PCI error reporting and recovery */
560pci_ers_result_t pcie_do_recovery(struct pci_dev *dev,
561 pci_channel_state_t state,
562 pci_ers_result_t (*reset_subordinates)(struct pci_dev *pdev));
563
564bool pcie_wait_for_link(struct pci_dev *pdev, bool active);
565#ifdef CONFIG_PCIEASPM
566void pcie_aspm_init_link_state(struct pci_dev *pdev);
567void pcie_aspm_exit_link_state(struct pci_dev *pdev);
568void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
569#else
570static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
571static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
572static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
573#endif
574
575#ifdef CONFIG_PCIE_ECRC
576void pcie_set_ecrc_checking(struct pci_dev *dev);
577void pcie_ecrc_get_policy(char *str);
578#else
579static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
580static inline void pcie_ecrc_get_policy(char *str) { }
581#endif
582
583struct pci_dev_reset_methods {
584 u16 vendor;
585 u16 device;
586 int (*reset)(struct pci_dev *dev, bool probe);
587};
588
589struct pci_reset_fn_method {
590 int (*reset_fn)(struct pci_dev *pdev, bool probe);
591 char *name;
592};
593
594#ifdef CONFIG_PCI_QUIRKS
595int pci_dev_specific_reset(struct pci_dev *dev, bool probe);
596#else
597static inline int pci_dev_specific_reset(struct pci_dev *dev, bool probe)
598{
599 return -ENOTTY;
600}
601#endif
602
603#if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
604int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
605 struct resource *res);
606#else
607static inline int acpi_get_rc_resources(struct device *dev, const char *hid,
608 u16 segment, struct resource *res)
609{
610 return -ENODEV;
611}
612#endif
613
614int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
615int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
616static inline u64 pci_rebar_size_to_bytes(int size)
617{
618 return 1ULL << (size + 20);
619}
620
621struct device_node;
622
623#ifdef CONFIG_OF
624int of_pci_parse_bus_range(struct device_node *node, struct resource *res);
625int of_get_pci_domain_nr(struct device_node *node);
626int of_pci_get_max_link_speed(struct device_node *node);
627u32 of_pci_get_slot_power_limit(struct device_node *node,
628 u8 *slot_power_limit_value,
629 u8 *slot_power_limit_scale);
630void pci_set_of_node(struct pci_dev *dev);
631void pci_release_of_node(struct pci_dev *dev);
632void pci_set_bus_of_node(struct pci_bus *bus);
633void pci_release_bus_of_node(struct pci_bus *bus);
634
635int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge);
636
637#else
638static inline int
639of_pci_parse_bus_range(struct device_node *node, struct resource *res)
640{
641 return -EINVAL;
642}
643
644static inline int
645of_get_pci_domain_nr(struct device_node *node)
646{
647 return -1;
648}
649
650static inline int
651of_pci_get_max_link_speed(struct device_node *node)
652{
653 return -EINVAL;
654}
655
656static inline u32
657of_pci_get_slot_power_limit(struct device_node *node,
658 u8 *slot_power_limit_value,
659 u8 *slot_power_limit_scale)
660{
661 if (slot_power_limit_value)
662 *slot_power_limit_value = 0;
663 if (slot_power_limit_scale)
664 *slot_power_limit_scale = 0;
665 return 0;
666}
667
668static inline void pci_set_of_node(struct pci_dev *dev) { }
669static inline void pci_release_of_node(struct pci_dev *dev) { }
670static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
671static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
672
673static inline int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge)
674{
675 return 0;
676}
677
678#endif /* CONFIG_OF */
679
680#ifdef CONFIG_PCIEAER
681void pci_no_aer(void);
682void pci_aer_init(struct pci_dev *dev);
683void pci_aer_exit(struct pci_dev *dev);
684extern const struct attribute_group aer_stats_attr_group;
685void pci_aer_clear_fatal_status(struct pci_dev *dev);
686int pci_aer_clear_status(struct pci_dev *dev);
687int pci_aer_raw_clear_status(struct pci_dev *dev);
688#else
689static inline void pci_no_aer(void) { }
690static inline void pci_aer_init(struct pci_dev *d) { }
691static inline void pci_aer_exit(struct pci_dev *d) { }
692static inline void pci_aer_clear_fatal_status(struct pci_dev *dev) { }
693static inline int pci_aer_clear_status(struct pci_dev *dev) { return -EINVAL; }
694static inline int pci_aer_raw_clear_status(struct pci_dev *dev) { return -EINVAL; }
695#endif
696
697#ifdef CONFIG_ACPI
698int pci_acpi_program_hp_params(struct pci_dev *dev);
699extern const struct attribute_group pci_dev_acpi_attr_group;
700void pci_set_acpi_fwnode(struct pci_dev *dev);
701int pci_dev_acpi_reset(struct pci_dev *dev, bool probe);
702bool acpi_pci_power_manageable(struct pci_dev *dev);
703bool acpi_pci_bridge_d3(struct pci_dev *dev);
704int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state);
705pci_power_t acpi_pci_get_power_state(struct pci_dev *dev);
706void acpi_pci_refresh_power_state(struct pci_dev *dev);
707int acpi_pci_wakeup(struct pci_dev *dev, bool enable);
708bool acpi_pci_need_resume(struct pci_dev *dev);
709pci_power_t acpi_pci_choose_state(struct pci_dev *pdev);
710#else
711static inline int pci_dev_acpi_reset(struct pci_dev *dev, bool probe)
712{
713 return -ENOTTY;
714}
715static inline void pci_set_acpi_fwnode(struct pci_dev *dev) {}
716static inline int pci_acpi_program_hp_params(struct pci_dev *dev)
717{
718 return -ENODEV;
719}
720static inline bool acpi_pci_power_manageable(struct pci_dev *dev)
721{
722 return false;
723}
724static inline bool acpi_pci_bridge_d3(struct pci_dev *dev)
725{
726 return false;
727}
728static inline int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
729{
730 return -ENODEV;
731}
732static inline pci_power_t acpi_pci_get_power_state(struct pci_dev *dev)
733{
734 return PCI_UNKNOWN;
735}
736static inline void acpi_pci_refresh_power_state(struct pci_dev *dev) {}
737static inline int acpi_pci_wakeup(struct pci_dev *dev, bool enable)
738{
739 return -ENODEV;
740}
741static inline bool acpi_pci_need_resume(struct pci_dev *dev)
742{
743 return false;
744}
745static inline pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
746{
747 return PCI_POWER_ERROR;
748}
749#endif
750
751#ifdef CONFIG_PCIEASPM
752extern const struct attribute_group aspm_ctrl_attr_group;
753#endif
754
755extern const struct attribute_group pci_dev_reset_method_attr_group;
756
757#ifdef CONFIG_X86_INTEL_MID
758bool pci_use_mid_pm(void);
759int mid_pci_set_power_state(struct pci_dev *pdev, pci_power_t state);
760pci_power_t mid_pci_get_power_state(struct pci_dev *pdev);
761#else
762static inline bool pci_use_mid_pm(void)
763{
764 return false;
765}
766static inline int mid_pci_set_power_state(struct pci_dev *pdev, pci_power_t state)
767{
768 return -ENODEV;
769}
770static inline pci_power_t mid_pci_get_power_state(struct pci_dev *pdev)
771{
772 return PCI_UNKNOWN;
773}
774#endif
775
776/*
777 * Config Address for PCI Configuration Mechanism #1
778 *
779 * See PCI Local Bus Specification, Revision 3.0,
780 * Section 3.2.2.3.2, Figure 3-2, p. 50.
781 */
782
783#define PCI_CONF1_BUS_SHIFT 16 /* Bus number */
784#define PCI_CONF1_DEV_SHIFT 11 /* Device number */
785#define PCI_CONF1_FUNC_SHIFT 8 /* Function number */
786
787#define PCI_CONF1_BUS_MASK 0xff
788#define PCI_CONF1_DEV_MASK 0x1f
789#define PCI_CONF1_FUNC_MASK 0x7
790#define PCI_CONF1_REG_MASK 0xfc /* Limit aligned offset to a maximum of 256B */
791
792#define PCI_CONF1_ENABLE BIT(31)
793#define PCI_CONF1_BUS(x) (((x) & PCI_CONF1_BUS_MASK) << PCI_CONF1_BUS_SHIFT)
794#define PCI_CONF1_DEV(x) (((x) & PCI_CONF1_DEV_MASK) << PCI_CONF1_DEV_SHIFT)
795#define PCI_CONF1_FUNC(x) (((x) & PCI_CONF1_FUNC_MASK) << PCI_CONF1_FUNC_SHIFT)
796#define PCI_CONF1_REG(x) ((x) & PCI_CONF1_REG_MASK)
797
798#define PCI_CONF1_ADDRESS(bus, dev, func, reg) \
799 (PCI_CONF1_ENABLE | \
800 PCI_CONF1_BUS(bus) | \
801 PCI_CONF1_DEV(dev) | \
802 PCI_CONF1_FUNC(func) | \
803 PCI_CONF1_REG(reg))
804
805/*
806 * Extension of PCI Config Address for accessing extended PCIe registers
807 *
808 * No standardized specification, but used on lot of non-ECAM-compliant ARM SoCs
809 * or on AMD Barcelona and new CPUs. Reserved bits [27:24] of PCI Config Address
810 * are used for specifying additional 4 high bits of PCI Express register.
811 */
812
813#define PCI_CONF1_EXT_REG_SHIFT 16
814#define PCI_CONF1_EXT_REG_MASK 0xf00
815#define PCI_CONF1_EXT_REG(x) (((x) & PCI_CONF1_EXT_REG_MASK) << PCI_CONF1_EXT_REG_SHIFT)
816
817#define PCI_CONF1_EXT_ADDRESS(bus, dev, func, reg) \
818 (PCI_CONF1_ADDRESS(bus, dev, func, reg) | \
819 PCI_CONF1_EXT_REG(reg))
820
821#endif /* DRIVERS_PCI_H */
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
7#define PCI_FIND_CAP_TTL 48
8
9extern const unsigned char pcie_link_speed[];
10
11bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
12
13/* Functions internal to the PCI core code */
14
15int pci_create_sysfs_dev_files(struct pci_dev *pdev);
16void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
17#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
18static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
19{ return; }
20static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
21{ return; }
22#else
23void pci_create_firmware_label_files(struct pci_dev *pdev);
24void pci_remove_firmware_label_files(struct pci_dev *pdev);
25#endif
26void pci_cleanup_rom(struct pci_dev *dev);
27#ifdef HAVE_PCI_MMAP
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};
32int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
33 enum pci_mmap_api mmap_api);
34#endif
35int pci_probe_reset_function(struct pci_dev *dev);
36
37/**
38 * struct pci_platform_pm_ops - Firmware PM callbacks
39 *
40 * @is_manageable: returns 'true' if given device is power manageable by the
41 * platform firmware
42 *
43 * @set_state: invokes the platform firmware to set the device's power state
44 *
45 * @choose_state: returns PCI power state of given device preferred by the
46 * platform; to be used during system-wide transitions from a
47 * sleeping state to the working state and vice versa
48 *
49 * @sleep_wake: enables/disables the system wake up capability of given device
50 *
51 * @run_wake: enables/disables the platform to generate run-time wake-up events
52 * for given device (the device's wake-up capability has to be
53 * enabled by @sleep_wake for this feature to work)
54 *
55 * @need_resume: returns 'true' if the given device (which is currently
56 * suspended) needs to be resumed to be configured for system
57 * wakeup.
58 *
59 * If given platform is generally capable of power managing PCI devices, all of
60 * these callbacks are mandatory.
61 */
62struct pci_platform_pm_ops {
63 bool (*is_manageable)(struct pci_dev *dev);
64 int (*set_state)(struct pci_dev *dev, pci_power_t state);
65 pci_power_t (*choose_state)(struct pci_dev *dev);
66 int (*sleep_wake)(struct pci_dev *dev, bool enable);
67 int (*run_wake)(struct pci_dev *dev, bool enable);
68 bool (*need_resume)(struct pci_dev *dev);
69};
70
71int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
72void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
73void pci_power_up(struct pci_dev *dev);
74void pci_disable_enabled_device(struct pci_dev *dev);
75int pci_finish_runtime_suspend(struct pci_dev *dev);
76int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
77bool pci_dev_keep_suspended(struct pci_dev *dev);
78void pci_dev_complete_resume(struct pci_dev *pci_dev);
79void pci_config_pm_runtime_get(struct pci_dev *dev);
80void pci_config_pm_runtime_put(struct pci_dev *dev);
81void pci_pm_init(struct pci_dev *dev);
82void pci_ea_init(struct pci_dev *dev);
83void pci_allocate_cap_save_buffers(struct pci_dev *dev);
84void pci_free_cap_save_buffers(struct pci_dev *dev);
85
86static inline void pci_wakeup_event(struct pci_dev *dev)
87{
88 /* Wait 100 ms before the system can be put into a sleep state. */
89 pm_wakeup_event(&dev->dev, 100);
90}
91
92static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
93{
94 return !!(pci_dev->subordinate);
95}
96
97struct pci_vpd_ops {
98 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
99 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
100 int (*set_size)(struct pci_dev *dev, size_t len);
101};
102
103struct pci_vpd {
104 const struct pci_vpd_ops *ops;
105 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
106 struct mutex lock;
107 unsigned int len;
108 u16 flag;
109 u8 cap;
110 u8 busy:1;
111 u8 valid:1;
112};
113
114int pci_vpd_init(struct pci_dev *dev);
115void pci_vpd_release(struct pci_dev *dev);
116
117/* PCI /proc functions */
118#ifdef CONFIG_PROC_FS
119int pci_proc_attach_device(struct pci_dev *dev);
120int pci_proc_detach_device(struct pci_dev *dev);
121int pci_proc_detach_bus(struct pci_bus *bus);
122#else
123static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
124static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
125static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
126#endif
127
128/* Functions for PCI Hotplug drivers to use */
129int pci_hp_add_bridge(struct pci_dev *dev);
130
131#ifdef HAVE_PCI_LEGACY
132void pci_create_legacy_files(struct pci_bus *bus);
133void pci_remove_legacy_files(struct pci_bus *bus);
134#else
135static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
136static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
137#endif
138
139/* Lock for read/write access to pci device and bus lists */
140extern struct rw_semaphore pci_bus_sem;
141
142extern raw_spinlock_t pci_lock;
143
144extern unsigned int pci_pm_d3_delay;
145
146#ifdef CONFIG_PCI_MSI
147void pci_no_msi(void);
148#else
149static inline void pci_no_msi(void) { }
150#endif
151
152static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
153{
154 u16 control;
155
156 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
157 control &= ~PCI_MSI_FLAGS_ENABLE;
158 if (enable)
159 control |= PCI_MSI_FLAGS_ENABLE;
160 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
161}
162
163static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
164{
165 u16 ctrl;
166
167 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
168 ctrl &= ~clear;
169 ctrl |= set;
170 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
171}
172
173void pci_realloc_get_opt(char *);
174
175static inline int pci_no_d1d2(struct pci_dev *dev)
176{
177 unsigned int parent_dstates = 0;
178
179 if (dev->bus->self)
180 parent_dstates = dev->bus->self->no_d1d2;
181 return (dev->no_d1d2 || parent_dstates);
182
183}
184extern const struct attribute_group *pci_dev_groups[];
185extern const struct attribute_group *pcibus_groups[];
186extern struct device_type pci_dev_type;
187extern const struct attribute_group *pci_bus_groups[];
188
189
190/**
191 * pci_match_one_device - Tell if a PCI device structure has a matching
192 * PCI device id structure
193 * @id: single PCI device id structure to match
194 * @dev: the PCI device structure to match against
195 *
196 * Returns the matching pci_device_id structure or %NULL if there is no match.
197 */
198static inline const struct pci_device_id *
199pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
200{
201 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
202 (id->device == PCI_ANY_ID || id->device == dev->device) &&
203 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
204 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
205 !((id->class ^ dev->class) & id->class_mask))
206 return id;
207 return NULL;
208}
209
210/* PCI slot sysfs helper code */
211#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
212
213extern struct kset *pci_slots_kset;
214
215struct pci_slot_attribute {
216 struct attribute attr;
217 ssize_t (*show)(struct pci_slot *, char *);
218 ssize_t (*store)(struct pci_slot *, const char *, size_t);
219};
220#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
221
222enum pci_bar_type {
223 pci_bar_unknown, /* Standard PCI BAR probe */
224 pci_bar_io, /* An io port BAR */
225 pci_bar_mem32, /* A 32-bit memory BAR */
226 pci_bar_mem64, /* A 64-bit memory BAR */
227};
228
229bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
230 int crs_timeout);
231int pci_setup_device(struct pci_dev *dev);
232int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
233 struct resource *res, unsigned int reg);
234int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
235void pci_configure_ari(struct pci_dev *dev);
236void __pci_bus_size_bridges(struct pci_bus *bus,
237 struct list_head *realloc_head);
238void __pci_bus_assign_resources(const struct pci_bus *bus,
239 struct list_head *realloc_head,
240 struct list_head *fail_head);
241bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
242
243void pci_reassigndev_resource_alignment(struct pci_dev *dev);
244void pci_disable_bridge_window(struct pci_dev *dev);
245
246/* Single Root I/O Virtualization */
247struct pci_sriov {
248 int pos; /* capability position */
249 int nres; /* number of resources */
250 u32 cap; /* SR-IOV Capabilities */
251 u16 ctrl; /* SR-IOV Control */
252 u16 total_VFs; /* total VFs associated with the PF */
253 u16 initial_VFs; /* initial VFs associated with the PF */
254 u16 num_VFs; /* number of VFs available */
255 u16 offset; /* first VF Routing ID offset */
256 u16 stride; /* following VF stride */
257 u32 pgsz; /* page size for BAR alignment */
258 u8 link; /* Function Dependency Link */
259 u8 max_VF_buses; /* max buses consumed by VFs */
260 u16 driver_max_VFs; /* max num VFs driver supports */
261 struct pci_dev *dev; /* lowest numbered PF */
262 struct pci_dev *self; /* this PF */
263 struct mutex lock; /* lock for VF bus */
264 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
265};
266
267#ifdef CONFIG_PCI_ATS
268void pci_restore_ats_state(struct pci_dev *dev);
269#else
270static inline void pci_restore_ats_state(struct pci_dev *dev)
271{
272}
273#endif /* CONFIG_PCI_ATS */
274
275#ifdef CONFIG_PCI_IOV
276int pci_iov_init(struct pci_dev *dev);
277void pci_iov_release(struct pci_dev *dev);
278int pci_iov_resource_bar(struct pci_dev *dev, int resno);
279resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
280void pci_restore_iov_state(struct pci_dev *dev);
281int pci_iov_bus_range(struct pci_bus *bus);
282
283#else
284static inline int pci_iov_init(struct pci_dev *dev)
285{
286 return -ENODEV;
287}
288static inline void pci_iov_release(struct pci_dev *dev)
289
290{
291}
292static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno)
293{
294 return 0;
295}
296static inline void pci_restore_iov_state(struct pci_dev *dev)
297{
298}
299static inline int pci_iov_bus_range(struct pci_bus *bus)
300{
301 return 0;
302}
303
304#endif /* CONFIG_PCI_IOV */
305
306unsigned long pci_cardbus_resource_alignment(struct resource *);
307
308static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
309 struct resource *res)
310{
311#ifdef CONFIG_PCI_IOV
312 int resno = res - dev->resource;
313
314 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
315 return pci_sriov_resource_alignment(dev, resno);
316#endif
317 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
318 return pci_cardbus_resource_alignment(res);
319 return resource_alignment(res);
320}
321
322void pci_enable_acs(struct pci_dev *dev);
323
324struct pci_dev_reset_methods {
325 u16 vendor;
326 u16 device;
327 int (*reset)(struct pci_dev *dev, int probe);
328};
329
330#ifdef CONFIG_PCI_QUIRKS
331int pci_dev_specific_reset(struct pci_dev *dev, int probe);
332#else
333static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
334{
335 return -ENOTTY;
336}
337#endif
338
339#endif /* DRIVERS_PCI_H */