blob: 25265bf80a83f292cb90a767e66da4d635c41a13 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Zhao, Yu557848c2008-10-13 19:18:07 +08002#ifndef DRIVERS_PCI_H
3#define DRIVERS_PCI_H
4
Alexandru Gagniuc2209e062018-11-28 16:28:04 -06005#include <linux/pci.h>
6
James Sewartf8bf2ae2019-12-10 15:51:33 -06007/* Number of possible devfns: 0.0 to 1f.7 inclusive */
8#define MAX_NR_DEVFNS 256
9
Wei Yangfff905f2015-06-30 09:16:41 +080010#define PCI_FIND_CAP_TTL 48
11
Lukas Wunner8531e282017-03-10 21:23:45 +010012#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
13
Jacob Keller343e51a2013-07-31 06:53:16 +000014extern const unsigned char pcie_link_speed[];
Sinan Kaya11eb0e02018-06-04 22:16:09 -040015extern bool pci_early_dump;
Jacob Keller343e51a2013-07-31 06:53:16 +000016
Yinghai Lu7a1562d2014-11-11 12:09:46 -080017bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
Patel, Mayurkumaraf65d1a2019-10-18 16:52:21 +000018bool pcie_cap_has_rtctl(const struct pci_dev *dev);
Yinghai Lu7a1562d2014-11-11 12:09:46 -080019
Linus Torvalds1da177e2005-04-16 15:20:36 -070020/* Functions internal to the PCI core code */
21
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060022int pci_create_sysfs_dev_files(struct pci_dev *pdev);
23void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053024#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050025static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050026{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050027static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050028{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050029#else
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060030void pci_create_firmware_label_files(struct pci_dev *pdev);
31void pci_remove_firmware_label_files(struct pci_dev *pdev);
Narendra K911e1c92010-07-26 05:56:50 -050032#endif
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060033void pci_cleanup_rom(struct pci_dev *dev);
David Woodhousef7195822017-04-12 13:25:59 +010034
Martin Wilck3b519e42010-11-10 11:03:21 +010035enum pci_mmap_api {
36 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
37 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
38};
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060039int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
40 enum pci_mmap_api mmap_api);
David Woodhousef7195822017-04-12 13:25:59 +010041
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030042int pci_probe_reset_function(struct pci_dev *dev);
Sinan Kaya381634c2018-07-19 18:04:11 -050043int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
Keith Buschc4eed622018-09-20 10:27:11 -060044int pci_bus_error_reset(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050045
Kelsey Skunbergc776dd52019-07-24 17:38:38 -060046#define PCI_PM_D2_DELAY 200
47#define PCI_PM_D3_WAIT 10
48#define PCI_PM_D3COLD_WAIT 100
49#define PCI_PM_BUS_WAIT 50
50
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020051/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080052 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020053 *
Mika Westerberg26ad34d2018-09-27 16:57:14 -050054 * @bridge_d3: Does the bridge allow entering into D3
55 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080056 * @is_manageable: returns 'true' if given device is power manageable by the
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060057 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020058 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080059 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020060 *
Lukas Wunnercc7cc022016-09-18 05:39:20 +020061 * @get_state: queries the platform firmware for a device's current power state
62 *
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020063 * @refresh_state: asks the platform to refresh the device's power state data
64 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080065 * @choose_state: returns PCI power state of given device preferred by the
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060066 * platform; to be used during system-wide transitions from a
67 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020068 *
Rafael J. Wysocki08476842017-06-24 01:57:35 +020069 * @set_wakeup: enables/disables wakeup capability for the device
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010070 *
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010071 * @need_resume: returns 'true' if the given device (which is currently
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060072 * suspended) needs to be resumed to be configured for system
73 * wakeup.
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010074 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020075 * If given platform is generally capable of power managing PCI devices, all of
76 * these callbacks are mandatory.
77 */
78struct pci_platform_pm_ops {
Mika Westerberg26ad34d2018-09-27 16:57:14 -050079 bool (*bridge_d3)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020080 bool (*is_manageable)(struct pci_dev *dev);
81 int (*set_state)(struct pci_dev *dev, pci_power_t state);
Lukas Wunnercc7cc022016-09-18 05:39:20 +020082 pci_power_t (*get_state)(struct pci_dev *dev);
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020083 void (*refresh_state)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020084 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysocki08476842017-06-24 01:57:35 +020085 int (*set_wakeup)(struct pci_dev *dev, bool enable);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010086 bool (*need_resume)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020087};
88
Julia Lawall299f2ff2015-12-06 17:33:45 +010089int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060090void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020091void pci_refresh_power_state(struct pci_dev *dev);
Rafael J. Wysockiadfac8f2019-11-05 11:27:49 +010092int pci_power_up(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060093void pci_disable_enabled_device(struct pci_dev *dev);
94int pci_finish_runtime_suspend(struct pci_dev *dev);
Bjorn Helgaasdcb04532018-03-09 11:06:53 -060095void pcie_clear_root_pme_status(struct pci_dev *dev);
Kelsey Skunberg669696e2019-07-24 17:38:39 -060096bool pci_check_pme_status(struct pci_dev *dev);
97void pci_pme_wakeup_bus(struct pci_bus *bus);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060098int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +020099void pci_pme_restore(struct pci_dev *dev);
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +0200100bool pci_dev_need_resume(struct pci_dev *dev);
101void pci_dev_adjust_pme(struct pci_dev *dev);
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +0200102void pci_dev_complete_resume(struct pci_dev *pci_dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600103void pci_config_pm_runtime_get(struct pci_dev *dev);
104void pci_config_pm_runtime_put(struct pci_dev *dev);
105void pci_pm_init(struct pci_dev *dev);
Sean O. Stalley938174e2015-10-29 17:35:39 -0500106void pci_ea_init(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600107void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -0800108void pci_free_cap_save_buffers(struct pci_dev *dev);
Lukas Wunnerc6a63302016-10-28 10:52:06 +0200109bool pci_bridge_d3_possible(struct pci_dev *dev);
Lukas Wunner1ed276a2016-10-28 10:52:06 +0200110void pci_bridge_d3_update(struct pci_dev *dev);
Mika Westerbergad9001f2019-11-12 12:16:17 +0300111void pci_bridge_wait_for_secondary_bus(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100112
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +0100113static inline void pci_wakeup_event(struct pci_dev *dev)
114{
115 /* Wait 100 ms before the system can be put into a sleep state. */
116 pm_wakeup_event(&dev->dev, 100);
117}
118
Yijing Wang326c1cd2014-05-04 12:23:36 +0800119static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100120{
121 return !!(pci_dev->subordinate);
122}
David Shaohua Li0f644742005-03-19 00:15:48 -0500123
Mika Westerberg9d26d3a2016-06-02 11:17:12 +0300124static inline bool pci_power_manageable(struct pci_dev *pci_dev)
125{
126 /*
127 * Currently we allow normal PCI devices and PCI bridges transition
128 * into D3 if their bridge_d3 is set.
129 */
130 return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
131}
132
Mika Westerberg984998e2019-08-22 11:55:52 +0300133static inline bool pcie_downstream_port(const struct pci_dev *dev)
134{
135 int type = pci_pcie_type(dev);
136
137 return type == PCI_EXP_TYPE_ROOT_PORT ||
138 type == PCI_EXP_TYPE_DOWNSTREAM ||
139 type == PCI_EXP_TYPE_PCIE_BRIDGE;
140}
141
Bjorn Helgaasf1cd93f2016-02-22 13:58:37 -0600142int pci_vpd_init(struct pci_dev *dev);
Bjorn Helgaas64379072016-02-22 13:58:06 -0600143void pci_vpd_release(struct pci_dev *dev);
Bjorn Helgaasb1c615c2018-03-19 13:06:17 -0500144void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev);
145void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +0000146
Kelsey Skunberg440589d2019-07-24 17:38:41 -0600147/* PCI Virtual Channel */
148int pci_save_vc_state(struct pci_dev *dev);
149void pci_restore_vc_state(struct pci_dev *dev);
150void pci_allocate_vc_save_buffers(struct pci_dev *dev);
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152/* PCI /proc functions */
153#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600154int pci_proc_attach_device(struct pci_dev *dev);
155int pci_proc_detach_device(struct pci_dev *dev);
156int pci_proc_detach_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#else
158static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
159static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
161#endif
162
163/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600164int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000166#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600167void pci_create_legacy_files(struct pci_bus *bus);
168void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000169#else
170static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
171static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
172#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800175extern struct rw_semaphore pci_bus_sem;
Keith Buschc4eed622018-09-20 10:27:11 -0600176extern struct mutex pci_slot_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100178extern raw_spinlock_t pci_lock;
179
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700180extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100181
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700182#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700183void pci_no_msi(void);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700184#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700185static inline void pci_no_msi(void) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700186#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100187
Michael S. Tsirkin6a25f5e2015-05-07 09:52:21 -0500188static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
189{
190 u16 control;
191
192 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
193 control &= ~PCI_MSI_FLAGS_ENABLE;
194 if (enable)
195 control |= PCI_MSI_FLAGS_ENABLE;
196 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
197}
198
199static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
200{
201 u16 ctrl;
202
203 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
204 ctrl &= ~clear;
205 ctrl |= set;
206 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
207}
208
Yinghai Lub55438f2012-02-23 19:23:30 -0800209void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700210
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700211static inline int pci_no_d1d2(struct pci_dev *dev)
212{
213 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700214
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700215 if (dev->bus->self)
216 parent_dstates = dev->bus->self->no_d1d2;
217 return (dev->no_d1d2 || parent_dstates);
218
219}
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -0700220extern const struct attribute_group *pci_dev_groups[];
Greg Kroah-Hartman56039e62013-07-24 15:05:17 -0700221extern const struct attribute_group *pcibus_groups[];
Bhumika Goyal69f2dc22017-09-12 16:43:33 +0530222extern const struct device_type pci_dev_type;
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -0600223extern const struct attribute_group *pci_bus_groups[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600224
Kelsey Skunberg003d3b22019-07-24 17:38:42 -0600225extern unsigned long pci_hotplug_io_size;
Nicholas Johnsond7b8a212019-10-23 12:12:29 +0000226extern unsigned long pci_hotplug_mmio_size;
227extern unsigned long pci_hotplug_mmio_pref_size;
Kelsey Skunberg003d3b22019-07-24 17:38:42 -0600228extern unsigned long pci_hotplug_bus_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230/**
231 * pci_match_one_device - Tell if a PCI device structure has a matching
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600232 * PCI device id structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 * @id: single PCI device id structure to match
234 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800235 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 * Returns the matching pci_device_id structure or %NULL if there is no match.
237 */
238static inline const struct pci_device_id *
239pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
240{
241 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
242 (id->device == PCI_ANY_ID || id->device == dev->device) &&
243 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
244 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
245 !((id->class ^ dev->class) & id->class_mask))
246 return id;
247 return NULL;
248}
249
Alex Chiangf46753c2008-06-10 15:28:50 -0600250/* PCI slot sysfs helper code */
251#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
252
253extern struct kset *pci_slots_kset;
254
255struct pci_slot_attribute {
256 struct attribute attr;
257 ssize_t (*show)(struct pci_slot *, char *);
258 ssize_t (*store)(struct pci_slot *, const char *, size_t);
259};
260#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
261
Yu Zhao0b400c72008-11-22 02:40:40 +0800262enum pci_bar_type {
263 pci_bar_unknown, /* Standard PCI BAR probe */
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600264 pci_bar_io, /* An I/O port BAR */
Yu Zhao0b400c72008-11-22 02:40:40 +0800265 pci_bar_mem32, /* A 32-bit memory BAR */
266 pci_bar_mem64, /* A 64-bit memory BAR */
267};
268
Kelsey Skunberg975e1ac2019-07-24 17:38:40 -0600269struct device *pci_get_host_bridge_device(struct pci_dev *dev);
270void pci_put_host_bridge_device(struct device *dev);
271
Sinan Kaya62ce94a2017-07-12 00:04:14 -0400272int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
Yinghai Luefdc87d2012-01-27 10:55:10 -0800273bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
274 int crs_timeout);
James Puthukattukaranaa667c62018-07-09 11:31:25 -0400275bool pci_bus_generic_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
276 int crs_timeout);
277int pci_idt_bus_quirk(struct pci_bus *bus, int devfn, u32 *pl, int crs_timeout);
278
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600279int pci_setup_device(struct pci_dev *dev);
280int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
281 struct resource *res, unsigned int reg);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600282void pci_configure_ari(struct pci_dev *dev);
Bjorn Helgaas10874f5a2014-04-14 16:11:40 -0600283void __pci_bus_size_bridges(struct pci_bus *bus,
Jiang Liud66ecb72013-06-23 01:01:35 +0200284 struct list_head *realloc_head);
Bjorn Helgaas10874f5a2014-04-14 16:11:40 -0600285void __pci_bus_assign_resources(const struct pci_bus *bus,
286 struct list_head *realloc_head,
287 struct list_head *fail_head);
Yinghai Lu0f7e7ae2015-01-15 16:21:49 -0600288bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700289
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800290void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600291void pci_disable_bridge_window(struct pci_dev *dev);
Kelsey Skunbergecd29c12019-07-24 17:38:43 -0600292struct pci_bus *pci_bus_get(struct pci_bus *bus);
293void pci_bus_put(struct pci_bus *bus);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900294
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500295/* PCIe link information */
296#define PCIE_SPEED2STR(speed) \
297 ((speed) == PCIE_SPEED_16_0GT ? "16 GT/s" : \
298 (speed) == PCIE_SPEED_8_0GT ? "8 GT/s" : \
299 (speed) == PCIE_SPEED_5_0GT ? "5 GT/s" : \
300 (speed) == PCIE_SPEED_2_5GT ? "2.5 GT/s" : \
301 "Unknown speed")
302
Tal Gilboab852f632018-03-30 08:32:03 -0500303/* PCIe speed to Mb/s reduced by encoding overhead */
304#define PCIE_SPEED2MBS_ENC(speed) \
305 ((speed) == PCIE_SPEED_16_0GT ? 16000*128/130 : \
306 (speed) == PCIE_SPEED_8_0GT ? 8000*128/130 : \
307 (speed) == PCIE_SPEED_5_0GT ? 5000*8/10 : \
308 (speed) == PCIE_SPEED_2_5GT ? 2500*8/10 : \
309 0)
310
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500311enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
Tal Gilboac70b65f2018-03-30 08:24:36 -0500312enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
Tal Gilboab852f632018-03-30 08:32:03 -0500313u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
314 enum pcie_link_width *width);
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -0500315void __pcie_print_link_status(struct pci_dev *dev, bool verbose);
Lukas Wunner0fa635a2019-03-20 12:05:30 +0100316void pcie_report_downtraining(struct pci_dev *dev);
Kelsey Skunberg5da78d92019-07-24 17:38:44 -0600317void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500318
Yu Zhaod1b054d2009-03-20 11:25:11 +0800319/* Single Root I/O Virtualization */
320struct pci_sriov {
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600321 int pos; /* Capability position */
322 int nres; /* Number of resources */
323 u32 cap; /* SR-IOV Capabilities */
324 u16 ctrl; /* SR-IOV Control */
325 u16 total_VFs; /* Total VFs associated with the PF */
326 u16 initial_VFs; /* Initial VFs associated with the PF */
327 u16 num_VFs; /* Number of VFs available */
328 u16 offset; /* First VF Routing ID offset */
329 u16 stride; /* Following VF stride */
330 u16 vf_device; /* VF device ID */
331 u32 pgsz; /* Page size for BAR alignment */
332 u8 link; /* Function Dependency Link */
333 u8 max_VF_buses; /* Max buses consumed by VFs */
334 u16 driver_max_VFs; /* Max num VFs driver supports */
335 struct pci_dev *dev; /* Lowest numbered PF */
336 struct pci_dev *self; /* This PF */
KarimAllah Ahmedcf0921b2018-03-19 21:06:00 +0100337 u32 class; /* VF device */
338 u8 hdr_type; /* VF header type */
339 u16 subsystem_vendor; /* VF subsystem vendor */
340 u16 subsystem_device; /* VF subsystem device */
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600341 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
342 bool drivers_autoprobe; /* Auto probing of VFs by driver */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800343};
344
Keith Buscha6bd1012018-09-20 10:27:16 -0600345/**
346 * pci_dev_set_io_state - Set the new error state if possible.
347 *
348 * @dev - pci device to set new error_state
349 * @new - the state we want dev to be in
350 *
351 * Must be called with device_lock held.
352 *
353 * Returns true if state has been changed to the requested state.
354 */
355static inline bool pci_dev_set_io_state(struct pci_dev *dev,
356 pci_channel_state_t new)
357{
358 bool changed = false;
359
360 device_lock_assert(&dev->dev);
361 switch (new) {
362 case pci_channel_io_perm_failure:
363 switch (dev->error_state) {
364 case pci_channel_io_frozen:
365 case pci_channel_io_normal:
366 case pci_channel_io_perm_failure:
367 changed = true;
368 break;
369 }
370 break;
371 case pci_channel_io_frozen:
372 switch (dev->error_state) {
373 case pci_channel_io_frozen:
374 case pci_channel_io_normal:
375 changed = true;
376 break;
377 }
378 break;
379 case pci_channel_io_normal:
380 switch (dev->error_state) {
381 case pci_channel_io_frozen:
382 case pci_channel_io_normal:
383 changed = true;
384 break;
385 }
386 break;
387 }
388 if (changed)
389 dev->error_state = new;
390 return changed;
391}
Keith Busch89ee9f72017-03-29 22:48:59 -0500392
393static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
394{
Keith Buscha6bd1012018-09-20 10:27:16 -0600395 device_lock(&dev->dev);
396 pci_dev_set_io_state(dev, pci_channel_io_perm_failure);
397 device_unlock(&dev->dev);
398
Keith Busch89ee9f72017-03-29 22:48:59 -0500399 return 0;
400}
401
402static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
403{
Keith Buscha6bd1012018-09-20 10:27:16 -0600404 return dev->error_state == pci_channel_io_perm_failure;
Keith Busch89ee9f72017-03-29 22:48:59 -0500405}
406
Keith Buscha6bd1012018-09-20 10:27:16 -0600407/* pci_dev priv_flags */
408#define PCI_DEV_ADDED 0
409
Hari Vyas44bda4b2018-07-03 14:35:41 +0530410static inline void pci_dev_assign_added(struct pci_dev *dev, bool added)
411{
412 assign_bit(PCI_DEV_ADDED, &dev->priv_flags, added);
413}
414
415static inline bool pci_dev_is_added(const struct pci_dev *dev)
416{
417 return test_bit(PCI_DEV_ADDED, &dev->priv_flags);
418}
419
Keith Busch1e451162018-07-19 16:16:55 -0500420#ifdef CONFIG_PCIEAER
421#include <linux/aer.h>
422
423#define AER_MAX_MULTI_ERR_DEVICES 5 /* Not likely to have more */
424
425struct aer_err_info {
426 struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
427 int error_dev_num;
428
429 unsigned int id:16;
430
431 unsigned int severity:2; /* 0:NONFATAL | 1:FATAL | 2:COR */
432 unsigned int __pad1:5;
433 unsigned int multi_error_valid:1;
434
435 unsigned int first_error:5;
436 unsigned int __pad2:2;
437 unsigned int tlp_header_valid:1;
438
439 unsigned int status; /* COR/UNCOR Error Status */
440 unsigned int mask; /* COR/UNCOR Error Mask */
441 struct aer_header_log_regs tlp; /* TLP Header */
442};
443
444int aer_get_device_error_info(struct pci_dev *dev, struct aer_err_info *info);
445void aer_print_error(struct pci_dev *dev, struct aer_err_info *info);
446#endif /* CONFIG_PCIEAER */
447
Keith Busch4f802172018-09-20 10:27:08 -0600448#ifdef CONFIG_PCIE_DPC
449void pci_save_dpc_state(struct pci_dev *dev);
450void pci_restore_dpc_state(struct pci_dev *dev);
Kuppuswamy Sathyanarayanan27005612020-03-23 17:26:04 -0700451void pci_dpc_init(struct pci_dev *pdev);
Kuppuswamy Sathyanarayananaea47412020-03-23 17:26:06 -0700452void dpc_process_error(struct pci_dev *pdev);
453pci_ers_result_t dpc_reset_link(struct pci_dev *pdev);
Keith Busch4f802172018-09-20 10:27:08 -0600454#else
455static inline void pci_save_dpc_state(struct pci_dev *dev) {}
456static inline void pci_restore_dpc_state(struct pci_dev *dev) {}
Kuppuswamy Sathyanarayanan27005612020-03-23 17:26:04 -0700457static inline void pci_dpc_init(struct pci_dev *pdev) {}
Keith Busch4f802172018-09-20 10:27:08 -0600458#endif
459
Hao, Xudong1900ca12011-12-17 21:24:40 +0800460#ifdef CONFIG_PCI_ATS
Kelsey Skunbergb92b5122019-07-24 17:38:45 -0600461/* Address Translation Service */
462void pci_ats_init(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600463void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800464#else
Kelsey Skunbergb92b5122019-07-24 17:38:45 -0600465static inline void pci_ats_init(struct pci_dev *d) { }
466static inline void pci_restore_ats_state(struct pci_dev *dev) { }
Hao, Xudong1900ca12011-12-17 21:24:40 +0800467#endif /* CONFIG_PCI_ATS */
468
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500469#ifdef CONFIG_PCI_PRI
470void pci_pri_init(struct pci_dev *dev);
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500471void pci_restore_pri_state(struct pci_dev *pdev);
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500472#else
473static inline void pci_pri_init(struct pci_dev *dev) { }
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500474static inline void pci_restore_pri_state(struct pci_dev *pdev) { }
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500475#endif
476
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500477#ifdef CONFIG_PCI_PASID
478void pci_pasid_init(struct pci_dev *dev);
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500479void pci_restore_pasid_state(struct pci_dev *pdev);
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500480#else
481static inline void pci_pasid_init(struct pci_dev *dev) { }
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500482static inline void pci_restore_pasid_state(struct pci_dev *pdev) { }
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500483#endif
484
Yu Zhaod1b054d2009-03-20 11:25:11 +0800485#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600486int pci_iov_init(struct pci_dev *dev);
487void pci_iov_release(struct pci_dev *dev);
Jakub Kicinski38972372018-06-29 15:08:52 -0500488void pci_iov_remove(struct pci_dev *dev);
Bjorn Helgaas6ffa2482016-11-28 09:15:52 -0600489void pci_iov_update_resource(struct pci_dev *dev, int resno);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600490resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
491void pci_restore_iov_state(struct pci_dev *dev);
492int pci_iov_bus_range(struct pci_bus *bus);
Kelsey Skunbergaaee0c12019-08-13 14:45:13 -0600493extern const struct attribute_group sriov_dev_attr_group;
Yu Zhaod1b054d2009-03-20 11:25:11 +0800494#else
495static inline int pci_iov_init(struct pci_dev *dev)
496{
497 return -ENODEV;
498}
499static inline void pci_iov_release(struct pci_dev *dev)
500
501{
502}
Jakub Kicinski38972372018-06-29 15:08:52 -0500503static inline void pci_iov_remove(struct pci_dev *dev)
504{
505}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800506static inline void pci_restore_iov_state(struct pci_dev *dev)
507{
508}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800509static inline int pci_iov_bus_range(struct pci_bus *bus)
510{
511 return 0;
512}
Yu Zhao302b4212009-05-18 13:51:32 +0800513
Yu Zhaod1b054d2009-03-20 11:25:11 +0800514#endif /* CONFIG_PCI_IOV */
515
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600516unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700517
Cam Macdonell0e522472010-09-07 17:25:20 -0700518static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600519 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700520{
521#ifdef CONFIG_PCI_IOV
522 int resno = res - dev->resource;
523
524 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
525 return pci_sriov_resource_alignment(dev, resno);
526#endif
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600527 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
Ram Pai0a2daa12011-07-25 13:08:41 -0700528 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700529 return resource_alignment(res);
530}
531
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600532void pci_enable_acs(struct pci_dev *dev);
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500533#ifdef CONFIG_PCI_QUIRKS
534int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
535int pci_dev_specific_enable_acs(struct pci_dev *dev);
Logan Gunthorpe73c47dde2018-08-09 16:51:43 -0500536int pci_dev_specific_disable_acs_redir(struct pci_dev *dev);
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500537#else
538static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
539 u16 acs_flags)
540{
541 return -ENOTTY;
542}
543static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
544{
545 return -ENOTTY;
546}
Logan Gunthorpe73c47dde2018-08-09 16:51:43 -0500547static inline int pci_dev_specific_disable_acs_redir(struct pci_dev *dev)
548{
549 return -ENOTTY;
550}
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500551#endif
Allen Kayae21ee62009-10-07 10:27:17 -0700552
Oza Pawandeep2e28bc82018-05-17 16:44:15 -0500553/* PCI error reporting and recovery */
Kuppuswamy Sathyanarayanane8e5ff22020-03-23 17:26:03 -0700554pci_ers_result_t pcie_do_recovery(struct pci_dev *dev,
555 enum pci_channel_state state,
556 pci_ers_result_t (*reset_link)(struct pci_dev *pdev));
Oza Pawandeep2e28bc82018-05-17 16:44:15 -0500557
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -0500558bool pcie_wait_for_link(struct pci_dev *pdev, bool active);
Bjorn Helgaas7d8e7d12017-12-15 08:57:28 -0600559#ifdef CONFIG_PCIEASPM
560void pcie_aspm_init_link_state(struct pci_dev *pdev);
561void pcie_aspm_exit_link_state(struct pci_dev *pdev);
562void pcie_aspm_pm_state_change(struct pci_dev *pdev);
563void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
564#else
565static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
566static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
567static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
568static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
569#endif
570
Kelsey Skunberg72bde9c2019-07-24 17:38:46 -0600571#ifdef CONFIG_PCIE_ECRC
572void pcie_set_ecrc_checking(struct pci_dev *dev);
573void pcie_ecrc_get_policy(char *str);
574#else
575static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
576static inline void pcie_ecrc_get_policy(char *str) { }
577#endif
578
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500579#ifdef CONFIG_PCIE_PTM
580void pci_ptm_init(struct pci_dev *dev);
Kelsey Skunbergac6c26d2019-07-24 17:38:47 -0600581int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500582#else
583static inline void pci_ptm_init(struct pci_dev *dev) { }
Kelsey Skunbergac6c26d2019-07-24 17:38:47 -0600584static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
585{ return -EINVAL; }
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500586#endif
587
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800588struct pci_dev_reset_methods {
589 u16 vendor;
590 u16 device;
591 int (*reset)(struct pci_dev *dev, int probe);
592};
593
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100594#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600595int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100596#else
597static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
598{
599 return -ENOTTY;
600}
601#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800602
Dongdong Liu169de962016-12-01 00:33:42 -0600603#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#endif
607
Christian König276b7382017-10-24 14:40:20 -0500608u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
609int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
610int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
611static inline u64 pci_rebar_size_to_bytes(int size)
612{
613 return 1ULL << (size + 20);
614}
615
Rob Herring9e2aee82018-05-11 12:15:30 -0500616struct device_node;
617
618#ifdef CONFIG_OF
619int of_pci_parse_bus_range(struct device_node *node, struct resource *res);
620int of_get_pci_domain_nr(struct device_node *node);
621int of_pci_get_max_link_speed(struct device_node *node);
Kelsey Skunberg621f7e32019-07-24 17:38:48 -0600622void pci_set_of_node(struct pci_dev *dev);
623void pci_release_of_node(struct pci_dev *dev);
624void pci_set_bus_of_node(struct pci_bus *bus);
625void pci_release_bus_of_node(struct pci_bus *bus);
Rob Herring9e2aee82018-05-11 12:15:30 -0500626
627#else
628static inline int
629of_pci_parse_bus_range(struct device_node *node, struct resource *res)
630{
631 return -EINVAL;
632}
633
634static inline int
635of_get_pci_domain_nr(struct device_node *node)
636{
637 return -1;
638}
639
640static inline int
641of_pci_get_max_link_speed(struct device_node *node)
642{
643 return -EINVAL;
644}
Kelsey Skunberg621f7e32019-07-24 17:38:48 -0600645
646static inline void pci_set_of_node(struct pci_dev *dev) { }
647static inline void pci_release_of_node(struct pci_dev *dev) { }
648static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
649static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
Rob Herring9e2aee82018-05-11 12:15:30 -0500650#endif /* CONFIG_OF */
651
Rajat Jain60ed9822018-06-21 16:48:26 -0700652#ifdef CONFIG_PCIEAER
653void pci_no_aer(void);
654void pci_aer_init(struct pci_dev *dev);
Rajat Jaindb89ccb2018-06-30 15:07:17 -0500655void pci_aer_exit(struct pci_dev *dev);
Rajat Jain81aa5202018-06-21 16:48:28 -0700656extern const struct attribute_group aer_stats_attr_group;
Bjorn Helgaas7ab92e82018-07-19 17:55:58 -0500657void pci_aer_clear_fatal_status(struct pci_dev *dev);
Oza Pawandeepec752f52018-07-19 17:58:09 -0500658void pci_aer_clear_device_status(struct pci_dev *dev);
Kuppuswamy Sathyanarayanan20e15e62020-03-23 17:26:05 -0700659int pci_aer_raw_clear_status(struct pci_dev *dev);
Rajat Jain60ed9822018-06-21 16:48:26 -0700660#else
661static inline void pci_no_aer(void) { }
Jisheng Zhang31f996e2019-04-12 06:43:06 +0000662static inline void pci_aer_init(struct pci_dev *d) { }
Rajat Jaindb89ccb2018-06-30 15:07:17 -0500663static inline void pci_aer_exit(struct pci_dev *d) { }
Bjorn Helgaas7ab92e82018-07-19 17:55:58 -0500664static inline void pci_aer_clear_fatal_status(struct pci_dev *dev) { }
Oza Pawandeepec752f52018-07-19 17:58:09 -0500665static inline void pci_aer_clear_device_status(struct pci_dev *dev) { }
Kuppuswamy Sathyanarayanan20e15e62020-03-23 17:26:05 -0700666static inline int pci_aer_raw_clear_status(struct pci_dev *dev) { return -EINVAL; }
Rajat Jain60ed9822018-06-21 16:48:26 -0700667#endif
668
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200669#ifdef CONFIG_ACPI
Krzysztof Wilczynski4a2dbed2019-08-27 11:49:51 +0200670int pci_acpi_program_hp_params(struct pci_dev *dev);
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200671#else
Krzysztof Wilczynski4a2dbed2019-08-27 11:49:51 +0200672static inline int pci_acpi_program_hp_params(struct pci_dev *dev)
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200673{
674 return -ENODEV;
675}
676#endif
677
Heiner Kallweit72ea91a2019-10-05 14:07:56 +0200678#ifdef CONFIG_PCIEASPM
679extern const struct attribute_group aspm_ctrl_attr_group;
680#endif
681
Zhao, Yu557848c2008-10-13 19:18:07 +0800682#endif /* DRIVERS_PCI_H */