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#define PCI_FIND_CAP_TTL 48
8
9#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
10
11extern const unsigned char pcie_link_speed[];
12extern bool pci_early_dump;
13
14bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
15
16/* Functions internal to the PCI core code */
17
18int pci_create_sysfs_dev_files(struct pci_dev *pdev);
19void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
20#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
21static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
22{ return; }
23static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
24{ return; }
25#else
26void pci_create_firmware_label_files(struct pci_dev *pdev);
27void pci_remove_firmware_label_files(struct pci_dev *pdev);
28#endif
29void pci_cleanup_rom(struct pci_dev *dev);
30
31enum pci_mmap_api {
32 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
33 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
34};
35int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
36 enum pci_mmap_api mmap_api);
37
38int pci_probe_reset_function(struct pci_dev *dev);
39int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
40int pci_bus_error_reset(struct pci_dev *dev);
41
42#define PCI_PM_D2_DELAY 200
43#define PCI_PM_D3_WAIT 10
44#define PCI_PM_D3COLD_WAIT 100
45#define PCI_PM_BUS_WAIT 50
46
47/**
48 * struct pci_platform_pm_ops - Firmware PM callbacks
49 *
50 * @bridge_d3: Does the bridge allow entering into D3
51 *
52 * @is_manageable: returns 'true' if given device is power manageable by the
53 * platform firmware
54 *
55 * @set_state: invokes the platform firmware to set the device's power state
56 *
57 * @get_state: queries the platform firmware for a device's current power state
58 *
59 * @refresh_state: asks the platform to refresh the device's power state data
60 *
61 * @choose_state: returns PCI power state of given device preferred by the
62 * platform; to be used during system-wide transitions from a
63 * sleeping state to the working state and vice versa
64 *
65 * @set_wakeup: enables/disables wakeup capability for the device
66 *
67 * @need_resume: returns 'true' if the given device (which is currently
68 * suspended) needs to be resumed to be configured for system
69 * wakeup.
70 *
71 * If given platform is generally capable of power managing PCI devices, all of
72 * these callbacks are mandatory.
73 */
74struct pci_platform_pm_ops {
75 bool (*bridge_d3)(struct pci_dev *dev);
76 bool (*is_manageable)(struct pci_dev *dev);
77 int (*set_state)(struct pci_dev *dev, pci_power_t state);
78 pci_power_t (*get_state)(struct pci_dev *dev);
79 void (*refresh_state)(struct pci_dev *dev);
80 pci_power_t (*choose_state)(struct pci_dev *dev);
81 int (*set_wakeup)(struct pci_dev *dev, bool enable);
82 bool (*need_resume)(struct pci_dev *dev);
83};
84
85int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
86void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
87void pci_refresh_power_state(struct pci_dev *dev);
88void pci_power_up(struct pci_dev *dev);
89void pci_disable_enabled_device(struct pci_dev *dev);
90int pci_finish_runtime_suspend(struct pci_dev *dev);
91void pcie_clear_root_pme_status(struct pci_dev *dev);
92bool pci_check_pme_status(struct pci_dev *dev);
93void pci_pme_wakeup_bus(struct pci_bus *bus);
94int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
95void pci_pme_restore(struct pci_dev *dev);
96bool pci_dev_need_resume(struct pci_dev *dev);
97void pci_dev_adjust_pme(struct pci_dev *dev);
98void pci_dev_complete_resume(struct pci_dev *pci_dev);
99void pci_config_pm_runtime_get(struct pci_dev *dev);
100void pci_config_pm_runtime_put(struct pci_dev *dev);
101void pci_pm_init(struct pci_dev *dev);
102void pci_ea_init(struct pci_dev *dev);
103void pci_allocate_cap_save_buffers(struct pci_dev *dev);
104void pci_free_cap_save_buffers(struct pci_dev *dev);
105bool pci_bridge_d3_possible(struct pci_dev *dev);
106void pci_bridge_d3_update(struct pci_dev *dev);
107
108static inline void pci_wakeup_event(struct pci_dev *dev)
109{
110 /* Wait 100 ms before the system can be put into a sleep state. */
111 pm_wakeup_event(&dev->dev, 100);
112}
113
114static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
115{
116 return !!(pci_dev->subordinate);
117}
118
119static inline bool pci_power_manageable(struct pci_dev *pci_dev)
120{
121 /*
122 * Currently we allow normal PCI devices and PCI bridges transition
123 * into D3 if their bridge_d3 is set.
124 */
125 return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
126}
127
128static inline bool pcie_downstream_port(const struct pci_dev *dev)
129{
130 int type = pci_pcie_type(dev);
131
132 return type == PCI_EXP_TYPE_ROOT_PORT ||
133 type == PCI_EXP_TYPE_DOWNSTREAM ||
134 type == PCI_EXP_TYPE_PCIE_BRIDGE;
135}
136
137int pci_vpd_init(struct pci_dev *dev);
138void pci_vpd_release(struct pci_dev *dev);
139void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev);
140void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev);
141
142/* PCI Virtual Channel */
143int pci_save_vc_state(struct pci_dev *dev);
144void pci_restore_vc_state(struct pci_dev *dev);
145void pci_allocate_vc_save_buffers(struct pci_dev *dev);
146
147/* PCI /proc functions */
148#ifdef CONFIG_PROC_FS
149int pci_proc_attach_device(struct pci_dev *dev);
150int pci_proc_detach_device(struct pci_dev *dev);
151int pci_proc_detach_bus(struct pci_bus *bus);
152#else
153static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
154static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
155static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
156#endif
157
158/* Functions for PCI Hotplug drivers to use */
159int pci_hp_add_bridge(struct pci_dev *dev);
160
161#ifdef HAVE_PCI_LEGACY
162void pci_create_legacy_files(struct pci_bus *bus);
163void pci_remove_legacy_files(struct pci_bus *bus);
164#else
165static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
166static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
167#endif
168
169/* Lock for read/write access to pci device and bus lists */
170extern struct rw_semaphore pci_bus_sem;
171extern struct mutex pci_slot_mutex;
172
173extern raw_spinlock_t pci_lock;
174
175extern unsigned int pci_pm_d3_delay;
176
177#ifdef CONFIG_PCI_MSI
178void pci_no_msi(void);
179#else
180static inline void pci_no_msi(void) { }
181#endif
182
183static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
184{
185 u16 control;
186
187 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
188 control &= ~PCI_MSI_FLAGS_ENABLE;
189 if (enable)
190 control |= PCI_MSI_FLAGS_ENABLE;
191 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
192}
193
194static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
195{
196 u16 ctrl;
197
198 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
199 ctrl &= ~clear;
200 ctrl |= set;
201 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
202}
203
204void pci_realloc_get_opt(char *);
205
206static inline int pci_no_d1d2(struct pci_dev *dev)
207{
208 unsigned int parent_dstates = 0;
209
210 if (dev->bus->self)
211 parent_dstates = dev->bus->self->no_d1d2;
212 return (dev->no_d1d2 || parent_dstates);
213
214}
215extern const struct attribute_group *pci_dev_groups[];
216extern const struct attribute_group *pcibus_groups[];
217extern const struct device_type pci_dev_type;
218extern const struct attribute_group *pci_bus_groups[];
219
220extern unsigned long pci_hotplug_io_size;
221extern unsigned long pci_hotplug_mem_size;
222extern unsigned long pci_hotplug_bus_size;
223
224/**
225 * pci_match_one_device - Tell if a PCI device structure has a matching
226 * PCI device id structure
227 * @id: single PCI device id structure to match
228 * @dev: the PCI device structure to match against
229 *
230 * Returns the matching pci_device_id structure or %NULL if there is no match.
231 */
232static inline const struct pci_device_id *
233pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
234{
235 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
236 (id->device == PCI_ANY_ID || id->device == dev->device) &&
237 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
238 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
239 !((id->class ^ dev->class) & id->class_mask))
240 return id;
241 return NULL;
242}
243
244/* PCI slot sysfs helper code */
245#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
246
247extern struct kset *pci_slots_kset;
248
249struct pci_slot_attribute {
250 struct attribute attr;
251 ssize_t (*show)(struct pci_slot *, char *);
252 ssize_t (*store)(struct pci_slot *, const char *, size_t);
253};
254#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
255
256enum pci_bar_type {
257 pci_bar_unknown, /* Standard PCI BAR probe */
258 pci_bar_io, /* An I/O port BAR */
259 pci_bar_mem32, /* A 32-bit memory BAR */
260 pci_bar_mem64, /* A 64-bit memory BAR */
261};
262
263struct device *pci_get_host_bridge_device(struct pci_dev *dev);
264void pci_put_host_bridge_device(struct device *dev);
265
266int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
267bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
268 int crs_timeout);
269bool pci_bus_generic_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
270 int crs_timeout);
271int pci_idt_bus_quirk(struct pci_bus *bus, int devfn, u32 *pl, int crs_timeout);
272
273int pci_setup_device(struct pci_dev *dev);
274int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
275 struct resource *res, unsigned int reg);
276void pci_configure_ari(struct pci_dev *dev);
277void __pci_bus_size_bridges(struct pci_bus *bus,
278 struct list_head *realloc_head);
279void __pci_bus_assign_resources(const struct pci_bus *bus,
280 struct list_head *realloc_head,
281 struct list_head *fail_head);
282bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
283
284void pci_reassigndev_resource_alignment(struct pci_dev *dev);
285void pci_disable_bridge_window(struct pci_dev *dev);
286struct pci_bus *pci_bus_get(struct pci_bus *bus);
287void pci_bus_put(struct pci_bus *bus);
288
289/* PCIe link information */
290#define PCIE_SPEED2STR(speed) \
291 ((speed) == PCIE_SPEED_16_0GT ? "16 GT/s" : \
292 (speed) == PCIE_SPEED_8_0GT ? "8 GT/s" : \
293 (speed) == PCIE_SPEED_5_0GT ? "5 GT/s" : \
294 (speed) == PCIE_SPEED_2_5GT ? "2.5 GT/s" : \
295 "Unknown speed")
296
297/* PCIe speed to Mb/s reduced by encoding overhead */
298#define PCIE_SPEED2MBS_ENC(speed) \
299 ((speed) == PCIE_SPEED_16_0GT ? 16000*128/130 : \
300 (speed) == PCIE_SPEED_8_0GT ? 8000*128/130 : \
301 (speed) == PCIE_SPEED_5_0GT ? 5000*8/10 : \
302 (speed) == PCIE_SPEED_2_5GT ? 2500*8/10 : \
303 0)
304
305enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
306enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
307u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
308 enum pcie_link_width *width);
309void __pcie_print_link_status(struct pci_dev *dev, bool verbose);
310void pcie_report_downtraining(struct pci_dev *dev);
311void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
312
313/* Single Root I/O Virtualization */
314struct pci_sriov {
315 int pos; /* Capability position */
316 int nres; /* Number of resources */
317 u32 cap; /* SR-IOV Capabilities */
318 u16 ctrl; /* SR-IOV Control */
319 u16 total_VFs; /* Total VFs associated with the PF */
320 u16 initial_VFs; /* Initial VFs associated with the PF */
321 u16 num_VFs; /* Number of VFs available */
322 u16 offset; /* First VF Routing ID offset */
323 u16 stride; /* Following VF stride */
324 u16 vf_device; /* VF device ID */
325 u32 pgsz; /* Page size for BAR alignment */
326 u8 link; /* Function Dependency Link */
327 u8 max_VF_buses; /* Max buses consumed by VFs */
328 u16 driver_max_VFs; /* Max num VFs driver supports */
329 struct pci_dev *dev; /* Lowest numbered PF */
330 struct pci_dev *self; /* This PF */
331 u32 class; /* VF device */
332 u8 hdr_type; /* VF header type */
333 u16 subsystem_vendor; /* VF subsystem vendor */
334 u16 subsystem_device; /* VF subsystem device */
335 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
336 bool drivers_autoprobe; /* Auto probing of VFs by driver */
337};
338
339/**
340 * pci_dev_set_io_state - Set the new error state if possible.
341 *
342 * @dev - pci device to set new error_state
343 * @new - the state we want dev to be in
344 *
345 * Must be called with device_lock held.
346 *
347 * Returns true if state has been changed to the requested state.
348 */
349static inline bool pci_dev_set_io_state(struct pci_dev *dev,
350 pci_channel_state_t new)
351{
352 bool changed = false;
353
354 device_lock_assert(&dev->dev);
355 switch (new) {
356 case pci_channel_io_perm_failure:
357 switch (dev->error_state) {
358 case pci_channel_io_frozen:
359 case pci_channel_io_normal:
360 case pci_channel_io_perm_failure:
361 changed = true;
362 break;
363 }
364 break;
365 case pci_channel_io_frozen:
366 switch (dev->error_state) {
367 case pci_channel_io_frozen:
368 case pci_channel_io_normal:
369 changed = true;
370 break;
371 }
372 break;
373 case pci_channel_io_normal:
374 switch (dev->error_state) {
375 case pci_channel_io_frozen:
376 case pci_channel_io_normal:
377 changed = true;
378 break;
379 }
380 break;
381 }
382 if (changed)
383 dev->error_state = new;
384 return changed;
385}
386
387static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
388{
389 device_lock(&dev->dev);
390 pci_dev_set_io_state(dev, pci_channel_io_perm_failure);
391 device_unlock(&dev->dev);
392
393 return 0;
394}
395
396static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
397{
398 return dev->error_state == pci_channel_io_perm_failure;
399}
400
401/* pci_dev priv_flags */
402#define PCI_DEV_ADDED 0
403
404static inline void pci_dev_assign_added(struct pci_dev *dev, bool added)
405{
406 assign_bit(PCI_DEV_ADDED, &dev->priv_flags, added);
407}
408
409static inline bool pci_dev_is_added(const struct pci_dev *dev)
410{
411 return test_bit(PCI_DEV_ADDED, &dev->priv_flags);
412}
413
414#ifdef CONFIG_PCIEAER
415#include <linux/aer.h>
416
417#define AER_MAX_MULTI_ERR_DEVICES 5 /* Not likely to have more */
418
419struct aer_err_info {
420 struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
421 int error_dev_num;
422
423 unsigned int id:16;
424
425 unsigned int severity:2; /* 0:NONFATAL | 1:FATAL | 2:COR */
426 unsigned int __pad1:5;
427 unsigned int multi_error_valid:1;
428
429 unsigned int first_error:5;
430 unsigned int __pad2:2;
431 unsigned int tlp_header_valid:1;
432
433 unsigned int status; /* COR/UNCOR Error Status */
434 unsigned int mask; /* COR/UNCOR Error Mask */
435 struct aer_header_log_regs tlp; /* TLP Header */
436};
437
438int aer_get_device_error_info(struct pci_dev *dev, struct aer_err_info *info);
439void aer_print_error(struct pci_dev *dev, struct aer_err_info *info);
440#endif /* CONFIG_PCIEAER */
441
442#ifdef CONFIG_PCIE_DPC
443void pci_save_dpc_state(struct pci_dev *dev);
444void pci_restore_dpc_state(struct pci_dev *dev);
445#else
446static inline void pci_save_dpc_state(struct pci_dev *dev) {}
447static inline void pci_restore_dpc_state(struct pci_dev *dev) {}
448#endif
449
450#ifdef CONFIG_PCI_ATS
451/* Address Translation Service */
452void pci_ats_init(struct pci_dev *dev);
453void pci_restore_ats_state(struct pci_dev *dev);
454#else
455static inline void pci_ats_init(struct pci_dev *d) { }
456static inline void pci_restore_ats_state(struct pci_dev *dev) { }
457#endif /* CONFIG_PCI_ATS */
458
459#ifdef CONFIG_PCI_IOV
460int pci_iov_init(struct pci_dev *dev);
461void pci_iov_release(struct pci_dev *dev);
462void pci_iov_remove(struct pci_dev *dev);
463void pci_iov_update_resource(struct pci_dev *dev, int resno);
464resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
465void pci_restore_iov_state(struct pci_dev *dev);
466int pci_iov_bus_range(struct pci_bus *bus);
467extern const struct attribute_group sriov_dev_attr_group;
468#else
469static inline int pci_iov_init(struct pci_dev *dev)
470{
471 return -ENODEV;
472}
473static inline void pci_iov_release(struct pci_dev *dev)
474
475{
476}
477static inline void pci_iov_remove(struct pci_dev *dev)
478{
479}
480static inline void pci_restore_iov_state(struct pci_dev *dev)
481{
482}
483static inline int pci_iov_bus_range(struct pci_bus *bus)
484{
485 return 0;
486}
487
488#endif /* CONFIG_PCI_IOV */
489
490unsigned long pci_cardbus_resource_alignment(struct resource *);
491
492static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
493 struct resource *res)
494{
495#ifdef CONFIG_PCI_IOV
496 int resno = res - dev->resource;
497
498 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
499 return pci_sriov_resource_alignment(dev, resno);
500#endif
501 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
502 return pci_cardbus_resource_alignment(res);
503 return resource_alignment(res);
504}
505
506void pci_enable_acs(struct pci_dev *dev);
507#ifdef CONFIG_PCI_QUIRKS
508int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
509int pci_dev_specific_enable_acs(struct pci_dev *dev);
510int pci_dev_specific_disable_acs_redir(struct pci_dev *dev);
511#else
512static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
513 u16 acs_flags)
514{
515 return -ENOTTY;
516}
517static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
518{
519 return -ENOTTY;
520}
521static inline int pci_dev_specific_disable_acs_redir(struct pci_dev *dev)
522{
523 return -ENOTTY;
524}
525#endif
526
527/* PCI error reporting and recovery */
528void pcie_do_recovery(struct pci_dev *dev, enum pci_channel_state state,
529 u32 service);
530
531bool pcie_wait_for_link(struct pci_dev *pdev, bool active);
532#ifdef CONFIG_PCIEASPM
533void pcie_aspm_init_link_state(struct pci_dev *pdev);
534void pcie_aspm_exit_link_state(struct pci_dev *pdev);
535void pcie_aspm_pm_state_change(struct pci_dev *pdev);
536void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
537#else
538static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
539static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
540static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
541static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
542#endif
543
544#ifdef CONFIG_PCIEASPM_DEBUG
545void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev);
546void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev);
547#else
548static inline void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev) { }
549static inline void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev) { }
550#endif
551
552#ifdef CONFIG_PCIE_ECRC
553void pcie_set_ecrc_checking(struct pci_dev *dev);
554void pcie_ecrc_get_policy(char *str);
555#else
556static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
557static inline void pcie_ecrc_get_policy(char *str) { }
558#endif
559
560#ifdef CONFIG_PCIE_PTM
561void pci_ptm_init(struct pci_dev *dev);
562int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
563#else
564static inline void pci_ptm_init(struct pci_dev *dev) { }
565static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
566{ return -EINVAL; }
567#endif
568
569struct pci_dev_reset_methods {
570 u16 vendor;
571 u16 device;
572 int (*reset)(struct pci_dev *dev, int probe);
573};
574
575#ifdef CONFIG_PCI_QUIRKS
576int pci_dev_specific_reset(struct pci_dev *dev, int probe);
577#else
578static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
579{
580 return -ENOTTY;
581}
582#endif
583
584#if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
585int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
586 struct resource *res);
587#endif
588
589u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
590int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
591int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
592static inline u64 pci_rebar_size_to_bytes(int size)
593{
594 return 1ULL << (size + 20);
595}
596
597struct device_node;
598
599#ifdef CONFIG_OF
600int of_pci_parse_bus_range(struct device_node *node, struct resource *res);
601int of_get_pci_domain_nr(struct device_node *node);
602int of_pci_get_max_link_speed(struct device_node *node);
603void pci_set_of_node(struct pci_dev *dev);
604void pci_release_of_node(struct pci_dev *dev);
605void pci_set_bus_of_node(struct pci_bus *bus);
606void pci_release_bus_of_node(struct pci_bus *bus);
607
608#else
609static inline int
610of_pci_parse_bus_range(struct device_node *node, struct resource *res)
611{
612 return -EINVAL;
613}
614
615static inline int
616of_get_pci_domain_nr(struct device_node *node)
617{
618 return -1;
619}
620
621static inline int
622of_pci_get_max_link_speed(struct device_node *node)
623{
624 return -EINVAL;
625}
626
627static inline void pci_set_of_node(struct pci_dev *dev) { }
628static inline void pci_release_of_node(struct pci_dev *dev) { }
629static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
630static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
631#endif /* CONFIG_OF */
632
633#if defined(CONFIG_OF_ADDRESS)
634int devm_of_pci_get_host_bridge_resources(struct device *dev,
635 unsigned char busno, unsigned char bus_max,
636 struct list_head *resources, resource_size_t *io_base);
637#else
638static inline int devm_of_pci_get_host_bridge_resources(struct device *dev,
639 unsigned char busno, unsigned char bus_max,
640 struct list_head *resources, resource_size_t *io_base)
641{
642 return -EINVAL;
643}
644#endif
645
646#ifdef CONFIG_PCIEAER
647void pci_no_aer(void);
648void pci_aer_init(struct pci_dev *dev);
649void pci_aer_exit(struct pci_dev *dev);
650extern const struct attribute_group aer_stats_attr_group;
651void pci_aer_clear_fatal_status(struct pci_dev *dev);
652void pci_aer_clear_device_status(struct pci_dev *dev);
653#else
654static inline void pci_no_aer(void) { }
655static inline void pci_aer_init(struct pci_dev *d) { }
656static inline void pci_aer_exit(struct pci_dev *d) { }
657static inline void pci_aer_clear_fatal_status(struct pci_dev *dev) { }
658static inline void pci_aer_clear_device_status(struct pci_dev *dev) { }
659#endif
660
661#ifdef CONFIG_ACPI
662int pci_acpi_program_hp_params(struct pci_dev *dev);
663#else
664static inline int pci_acpi_program_hp_params(struct pci_dev *dev)
665{
666 return -ENODEV;
667}
668#endif
669
670#endif /* DRIVERS_PCI_H */
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef DRIVERS_PCI_H
3#define DRIVERS_PCI_H
4
5#define PCI_FIND_CAP_TTL 48
6
7#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
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
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
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 * @get_state: queries the platform firmware for a device's current power state
46 *
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
50 *
51 * @set_wakeup: enables/disables wakeup capability for the device
52 *
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 *
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 (*get_state)(struct pci_dev *dev);
64 pci_power_t (*choose_state)(struct pci_dev *dev);
65 int (*set_wakeup)(struct pci_dev *dev, bool enable);
66 bool (*need_resume)(struct pci_dev *dev);
67};
68
69int pci_set_platform_pm(const 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);
74void pcie_clear_root_pme_status(struct pci_dev *dev);
75int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
76void pci_pme_restore(struct pci_dev *dev);
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);
85bool pci_bridge_d3_possible(struct pci_dev *dev);
86void pci_bridge_d3_update(struct pci_dev *dev);
87
88static inline void pci_wakeup_event(struct pci_dev *dev)
89{
90 /* Wait 100 ms before the system can be put into a sleep state. */
91 pm_wakeup_event(&dev->dev, 100);
92}
93
94static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
95{
96 return !!(pci_dev->subordinate);
97}
98
99static inline bool pci_power_manageable(struct pci_dev *pci_dev)
100{
101 /*
102 * Currently we allow normal PCI devices and PCI bridges transition
103 * into D3 if their bridge_d3 is set.
104 */
105 return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
106}
107
108int pci_vpd_init(struct pci_dev *dev);
109void pci_vpd_release(struct pci_dev *dev);
110void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev);
111void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev);
112
113/* PCI /proc functions */
114#ifdef CONFIG_PROC_FS
115int pci_proc_attach_device(struct pci_dev *dev);
116int pci_proc_detach_device(struct pci_dev *dev);
117int pci_proc_detach_bus(struct pci_bus *bus);
118#else
119static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
120static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
121static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
122#endif
123
124/* Functions for PCI Hotplug drivers to use */
125int pci_hp_add_bridge(struct pci_dev *dev);
126
127#ifdef HAVE_PCI_LEGACY
128void pci_create_legacy_files(struct pci_bus *bus);
129void pci_remove_legacy_files(struct pci_bus *bus);
130#else
131static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
132static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
133#endif
134
135/* Lock for read/write access to pci device and bus lists */
136extern struct rw_semaphore pci_bus_sem;
137
138extern raw_spinlock_t pci_lock;
139
140extern unsigned int pci_pm_d3_delay;
141
142#ifdef CONFIG_PCI_MSI
143void pci_no_msi(void);
144#else
145static inline void pci_no_msi(void) { }
146#endif
147
148static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
149{
150 u16 control;
151
152 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
153 control &= ~PCI_MSI_FLAGS_ENABLE;
154 if (enable)
155 control |= PCI_MSI_FLAGS_ENABLE;
156 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
157}
158
159static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
160{
161 u16 ctrl;
162
163 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
164 ctrl &= ~clear;
165 ctrl |= set;
166 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
167}
168
169void pci_realloc_get_opt(char *);
170
171static inline int pci_no_d1d2(struct pci_dev *dev)
172{
173 unsigned int parent_dstates = 0;
174
175 if (dev->bus->self)
176 parent_dstates = dev->bus->self->no_d1d2;
177 return (dev->no_d1d2 || parent_dstates);
178
179}
180extern const struct attribute_group *pci_dev_groups[];
181extern const struct attribute_group *pcibus_groups[];
182extern const struct device_type pci_dev_type;
183extern const struct attribute_group *pci_bus_groups[];
184
185
186/**
187 * pci_match_one_device - Tell if a PCI device structure has a matching
188 * PCI device id structure
189 * @id: single PCI device id structure to match
190 * @dev: the PCI device structure to match against
191 *
192 * Returns the matching pci_device_id structure or %NULL if there is no match.
193 */
194static inline const struct pci_device_id *
195pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
196{
197 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
198 (id->device == PCI_ANY_ID || id->device == dev->device) &&
199 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
200 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
201 !((id->class ^ dev->class) & id->class_mask))
202 return id;
203 return NULL;
204}
205
206/* PCI slot sysfs helper code */
207#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
208
209extern struct kset *pci_slots_kset;
210
211struct pci_slot_attribute {
212 struct attribute attr;
213 ssize_t (*show)(struct pci_slot *, char *);
214 ssize_t (*store)(struct pci_slot *, const char *, size_t);
215};
216#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
217
218enum pci_bar_type {
219 pci_bar_unknown, /* Standard PCI BAR probe */
220 pci_bar_io, /* An I/O port BAR */
221 pci_bar_mem32, /* A 32-bit memory BAR */
222 pci_bar_mem64, /* A 64-bit memory BAR */
223};
224
225int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
226bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
227 int crs_timeout);
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);
231void pci_configure_ari(struct pci_dev *dev);
232void __pci_bus_size_bridges(struct pci_bus *bus,
233 struct list_head *realloc_head);
234void __pci_bus_assign_resources(const struct pci_bus *bus,
235 struct list_head *realloc_head,
236 struct list_head *fail_head);
237bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
238
239void pci_reassigndev_resource_alignment(struct pci_dev *dev);
240void pci_disable_bridge_window(struct pci_dev *dev);
241
242/* PCIe link information */
243#define PCIE_SPEED2STR(speed) \
244 ((speed) == PCIE_SPEED_16_0GT ? "16 GT/s" : \
245 (speed) == PCIE_SPEED_8_0GT ? "8 GT/s" : \
246 (speed) == PCIE_SPEED_5_0GT ? "5 GT/s" : \
247 (speed) == PCIE_SPEED_2_5GT ? "2.5 GT/s" : \
248 "Unknown speed")
249
250/* PCIe speed to Mb/s reduced by encoding overhead */
251#define PCIE_SPEED2MBS_ENC(speed) \
252 ((speed) == PCIE_SPEED_16_0GT ? 16000*128/130 : \
253 (speed) == PCIE_SPEED_8_0GT ? 8000*128/130 : \
254 (speed) == PCIE_SPEED_5_0GT ? 5000*8/10 : \
255 (speed) == PCIE_SPEED_2_5GT ? 2500*8/10 : \
256 0)
257
258enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
259enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
260u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
261 enum pcie_link_width *width);
262
263/* Single Root I/O Virtualization */
264struct pci_sriov {
265 int pos; /* Capability position */
266 int nres; /* Number of resources */
267 u32 cap; /* SR-IOV Capabilities */
268 u16 ctrl; /* SR-IOV Control */
269 u16 total_VFs; /* Total VFs associated with the PF */
270 u16 initial_VFs; /* Initial VFs associated with the PF */
271 u16 num_VFs; /* Number of VFs available */
272 u16 offset; /* First VF Routing ID offset */
273 u16 stride; /* Following VF stride */
274 u16 vf_device; /* VF device ID */
275 u32 pgsz; /* Page size for BAR alignment */
276 u8 link; /* Function Dependency Link */
277 u8 max_VF_buses; /* Max buses consumed by VFs */
278 u16 driver_max_VFs; /* Max num VFs driver supports */
279 struct pci_dev *dev; /* Lowest numbered PF */
280 struct pci_dev *self; /* This PF */
281 u32 class; /* VF device */
282 u8 hdr_type; /* VF header type */
283 u16 subsystem_vendor; /* VF subsystem vendor */
284 u16 subsystem_device; /* VF subsystem device */
285 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
286 bool drivers_autoprobe; /* Auto probing of VFs by driver */
287};
288
289/* pci_dev priv_flags */
290#define PCI_DEV_DISCONNECTED 0
291
292static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
293{
294 set_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
295 return 0;
296}
297
298static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
299{
300 return test_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
301}
302
303#ifdef CONFIG_PCI_ATS
304void pci_restore_ats_state(struct pci_dev *dev);
305#else
306static inline void pci_restore_ats_state(struct pci_dev *dev)
307{
308}
309#endif /* CONFIG_PCI_ATS */
310
311#ifdef CONFIG_PCI_IOV
312int pci_iov_init(struct pci_dev *dev);
313void pci_iov_release(struct pci_dev *dev);
314void pci_iov_update_resource(struct pci_dev *dev, int resno);
315resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
316void pci_restore_iov_state(struct pci_dev *dev);
317int pci_iov_bus_range(struct pci_bus *bus);
318
319#else
320static inline int pci_iov_init(struct pci_dev *dev)
321{
322 return -ENODEV;
323}
324static inline void pci_iov_release(struct pci_dev *dev)
325
326{
327}
328static inline void pci_restore_iov_state(struct pci_dev *dev)
329{
330}
331static inline int pci_iov_bus_range(struct pci_bus *bus)
332{
333 return 0;
334}
335
336#endif /* CONFIG_PCI_IOV */
337
338unsigned long pci_cardbus_resource_alignment(struct resource *);
339
340static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
341 struct resource *res)
342{
343#ifdef CONFIG_PCI_IOV
344 int resno = res - dev->resource;
345
346 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
347 return pci_sriov_resource_alignment(dev, resno);
348#endif
349 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
350 return pci_cardbus_resource_alignment(res);
351 return resource_alignment(res);
352}
353
354void pci_enable_acs(struct pci_dev *dev);
355
356#ifdef CONFIG_PCIEASPM
357void pcie_aspm_init_link_state(struct pci_dev *pdev);
358void pcie_aspm_exit_link_state(struct pci_dev *pdev);
359void pcie_aspm_pm_state_change(struct pci_dev *pdev);
360void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
361#else
362static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
363static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
364static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
365static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
366#endif
367
368#ifdef CONFIG_PCIEASPM_DEBUG
369void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev);
370void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev);
371#else
372static inline void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev) { }
373static inline void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev) { }
374#endif
375
376#ifdef CONFIG_PCIE_PTM
377void pci_ptm_init(struct pci_dev *dev);
378#else
379static inline void pci_ptm_init(struct pci_dev *dev) { }
380#endif
381
382struct pci_dev_reset_methods {
383 u16 vendor;
384 u16 device;
385 int (*reset)(struct pci_dev *dev, int probe);
386};
387
388#ifdef CONFIG_PCI_QUIRKS
389int pci_dev_specific_reset(struct pci_dev *dev, int probe);
390#else
391static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
392{
393 return -ENOTTY;
394}
395#endif
396
397#if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
398int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
399 struct resource *res);
400#endif
401
402u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
403int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
404int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
405static inline u64 pci_rebar_size_to_bytes(int size)
406{
407 return 1ULL << (size + 20);
408}
409
410#endif /* DRIVERS_PCI_H */