blob: e6b46d2b9846b7fde30c8e4a6ca5c824bca0b3c3 [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
Wei Yangfff905f2015-06-30 09:16:41 +08007#define PCI_FIND_CAP_TTL 48
8
Lukas Wunner8531e282017-03-10 21:23:45 +01009#define PCI_VSEC_ID_INTEL_TBT 0x1234 /* Thunderbolt */
10
Jacob Keller343e51a2013-07-31 06:53:16 +000011extern const unsigned char pcie_link_speed[];
Sinan Kaya11eb0e0e2018-06-04 22:16:09 -040012extern bool pci_early_dump;
Jacob Keller343e51a2013-07-31 06:53:16 +000013
Yinghai Lu7a1562d2014-11-11 12:09:46 -080014bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016/* Functions internal to the PCI core code */
17
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060018int pci_create_sysfs_dev_files(struct pci_dev *pdev);
19void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053020#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050021static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050022{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050023static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050024{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050025#else
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060026void pci_create_firmware_label_files(struct pci_dev *pdev);
27void pci_remove_firmware_label_files(struct pci_dev *pdev);
Narendra K911e1c92010-07-26 05:56:50 -050028#endif
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060029void pci_cleanup_rom(struct pci_dev *dev);
David Woodhousef7195822017-04-12 13:25:59 +010030
Martin Wilck3b519e42010-11-10 11:03:21 +010031enum 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};
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060035int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
36 enum pci_mmap_api mmap_api);
David Woodhousef7195822017-04-12 13:25:59 +010037
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030038int pci_probe_reset_function(struct pci_dev *dev);
Sinan Kaya381634c2018-07-19 18:04:11 -050039int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
Keith Buschc4eed622018-09-20 10:27:11 -060040int pci_bus_error_reset(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050041
Kelsey Skunbergc776dd52019-07-24 17:38:38 -060042#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
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020047/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080048 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020049 *
Mika Westerberg26ad34d2018-09-27 16:57:14 -050050 * @bridge_d3: Does the bridge allow entering into D3
51 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080052 * @is_manageable: returns 'true' if given device is power manageable by the
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060053 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020054 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080055 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020056 *
Lukas Wunnercc7cc022016-09-18 05:39:20 +020057 * @get_state: queries the platform firmware for a device's current power state
58 *
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020059 * @refresh_state: asks the platform to refresh the device's power state data
60 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080061 * @choose_state: returns PCI power state of given device preferred by the
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060062 * platform; to be used during system-wide transitions from a
63 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020064 *
Rafael J. Wysocki08476842017-06-24 01:57:35 +020065 * @set_wakeup: enables/disables wakeup capability for the device
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010066 *
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010067 * @need_resume: returns 'true' if the given device (which is currently
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -060068 * suspended) needs to be resumed to be configured for system
69 * wakeup.
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010070 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020071 * If given platform is generally capable of power managing PCI devices, all of
72 * these callbacks are mandatory.
73 */
74struct pci_platform_pm_ops {
Mika Westerberg26ad34d2018-09-27 16:57:14 -050075 bool (*bridge_d3)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020076 bool (*is_manageable)(struct pci_dev *dev);
77 int (*set_state)(struct pci_dev *dev, pci_power_t state);
Lukas Wunnercc7cc022016-09-18 05:39:20 +020078 pci_power_t (*get_state)(struct pci_dev *dev);
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020079 void (*refresh_state)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020080 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysocki08476842017-06-24 01:57:35 +020081 int (*set_wakeup)(struct pci_dev *dev, bool enable);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010082 bool (*need_resume)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020083};
84
Julia Lawall299f2ff2015-12-06 17:33:45 +010085int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060086void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
Rafael J. Wysockib51033e2019-06-25 14:09:12 +020087void pci_refresh_power_state(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060088void 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);
Bjorn Helgaasdcb04532018-03-09 11:06:53 -060091void pcie_clear_root_pme_status(struct pci_dev *dev);
Kelsey Skunberg669696e2019-07-24 17:38:39 -060092bool pci_check_pme_status(struct pci_dev *dev);
93void pci_pme_wakeup_bus(struct pci_bus *bus);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060094int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +020095void pci_pme_restore(struct pci_dev *dev);
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +020096bool pci_dev_need_resume(struct pci_dev *dev);
97void pci_dev_adjust_pme(struct pci_dev *dev);
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +020098void pci_dev_complete_resume(struct pci_dev *pci_dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060099void 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);
Sean O. Stalley938174e2015-10-29 17:35:39 -0500102void pci_ea_init(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600103void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -0800104void pci_free_cap_save_buffers(struct pci_dev *dev);
Lukas Wunnerc6a63302016-10-28 10:52:06 +0200105bool pci_bridge_d3_possible(struct pci_dev *dev);
Lukas Wunner1ed276a2016-10-28 10:52:06 +0200106void pci_bridge_d3_update(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100107
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +0100108static 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
Yijing Wang326c1cd2014-05-04 12:23:36 +0800114static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100115{
116 return !!(pci_dev->subordinate);
117}
David Shaohua Li0f644742005-03-19 00:15:48 -0500118
Mika Westerberg9d26d3a2016-06-02 11:17:12 +0300119static 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
Mika Westerberg984998e2019-08-22 11:55:52 +0300128static 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
Bjorn Helgaasf1cd93f2016-02-22 13:58:37 -0600137int pci_vpd_init(struct pci_dev *dev);
Bjorn Helgaas64379072016-02-22 13:58:06 -0600138void pci_vpd_release(struct pci_dev *dev);
Bjorn Helgaasb1c615c2018-03-19 13:06:17 -0500139void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev);
140void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +0000141
Kelsey Skunberg440589d2019-07-24 17:38:41 -0600142/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147/* PCI /proc functions */
148#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600149int 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#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; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
156#endif
157
158/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600159int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000161#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600162void pci_create_legacy_files(struct pci_bus *bus);
163void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000164#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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800170extern struct rw_semaphore pci_bus_sem;
Keith Buschc4eed622018-09-20 10:27:11 -0600171extern struct mutex pci_slot_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100173extern raw_spinlock_t pci_lock;
174
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700175extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100176
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700177#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700178void pci_no_msi(void);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700179#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700180static inline void pci_no_msi(void) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700181#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100182
Michael S. Tsirkin6a25f5e2015-05-07 09:52:21 -0500183static 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
Yinghai Lub55438f2012-02-23 19:23:30 -0800204void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700205
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700206static inline int pci_no_d1d2(struct pci_dev *dev)
207{
208 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700209
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700210 if (dev->bus->self)
211 parent_dstates = dev->bus->self->no_d1d2;
212 return (dev->no_d1d2 || parent_dstates);
213
214}
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -0700215extern const struct attribute_group *pci_dev_groups[];
Greg Kroah-Hartman56039e62013-07-24 15:05:17 -0700216extern const struct attribute_group *pcibus_groups[];
Bhumika Goyal69f2dc22017-09-12 16:43:33 +0530217extern const struct device_type pci_dev_type;
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -0600218extern const struct attribute_group *pci_bus_groups[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600219
Kelsey Skunberg003d3b22019-07-24 17:38:42 -0600220extern unsigned long pci_hotplug_io_size;
221extern unsigned long pci_hotplug_mem_size;
222extern unsigned long pci_hotplug_bus_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
224/**
225 * pci_match_one_device - Tell if a PCI device structure has a matching
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600226 * PCI device id structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 * @id: single PCI device id structure to match
228 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800229 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 * 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
Alex Chiangf46753c2008-06-10 15:28:50 -0600244/* 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
Yu Zhao0b400c72008-11-22 02:40:40 +0800256enum pci_bar_type {
257 pci_bar_unknown, /* Standard PCI BAR probe */
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600258 pci_bar_io, /* An I/O port BAR */
Yu Zhao0b400c72008-11-22 02:40:40 +0800259 pci_bar_mem32, /* A 32-bit memory BAR */
260 pci_bar_mem64, /* A 64-bit memory BAR */
261};
262
Kelsey Skunberg975e1ac2019-07-24 17:38:40 -0600263struct device *pci_get_host_bridge_device(struct pci_dev *dev);
264void pci_put_host_bridge_device(struct device *dev);
265
Sinan Kaya62ce94a2017-07-12 00:04:14 -0400266int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
Yinghai Luefdc87d2012-01-27 10:55:10 -0800267bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
268 int crs_timeout);
James Puthukattukaranaa667c62018-07-09 11:31:25 -0400269bool 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
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600273int 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);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600276void pci_configure_ari(struct pci_dev *dev);
Bjorn Helgaas10874f5a2014-04-14 16:11:40 -0600277void __pci_bus_size_bridges(struct pci_bus *bus,
Jiang Liud66ecb72013-06-23 01:01:35 +0200278 struct list_head *realloc_head);
Bjorn Helgaas10874f5a2014-04-14 16:11:40 -0600279void __pci_bus_assign_resources(const struct pci_bus *bus,
280 struct list_head *realloc_head,
281 struct list_head *fail_head);
Yinghai Lu0f7e7ae2015-01-15 16:21:49 -0600282bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700283
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800284void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600285void pci_disable_bridge_window(struct pci_dev *dev);
Kelsey Skunbergecd29c12019-07-24 17:38:43 -0600286struct pci_bus *pci_bus_get(struct pci_bus *bus);
287void pci_bus_put(struct pci_bus *bus);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900288
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500289/* 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
Tal Gilboab852f632018-03-30 08:32:03 -0500297/* 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
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500305enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
Tal Gilboac70b65f2018-03-30 08:24:36 -0500306enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
Tal Gilboab852f632018-03-30 08:32:03 -0500307u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
308 enum pcie_link_width *width);
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -0500309void __pcie_print_link_status(struct pci_dev *dev, bool verbose);
Lukas Wunner0fa635a2019-03-20 12:05:30 +0100310void pcie_report_downtraining(struct pci_dev *dev);
Kelsey Skunberg5da78d92019-07-24 17:38:44 -0600311void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
Tal Gilboa6cf57be2018-03-30 07:44:05 -0500312
Yu Zhaod1b054d2009-03-20 11:25:11 +0800313/* Single Root I/O Virtualization */
314struct pci_sriov {
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600315 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 */
KarimAllah Ahmedcf0921b2018-03-19 21:06:00 +0100331 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 */
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600335 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
336 bool drivers_autoprobe; /* Auto probing of VFs by driver */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800337};
338
Keith Buscha6bd1012018-09-20 10:27:16 -0600339/**
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}
Keith Busch89ee9f72017-03-29 22:48:59 -0500386
387static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
388{
Keith Buscha6bd1012018-09-20 10:27:16 -0600389 device_lock(&dev->dev);
390 pci_dev_set_io_state(dev, pci_channel_io_perm_failure);
391 device_unlock(&dev->dev);
392
Keith Busch89ee9f72017-03-29 22:48:59 -0500393 return 0;
394}
395
396static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
397{
Keith Buscha6bd1012018-09-20 10:27:16 -0600398 return dev->error_state == pci_channel_io_perm_failure;
Keith Busch89ee9f72017-03-29 22:48:59 -0500399}
400
Keith Buscha6bd1012018-09-20 10:27:16 -0600401/* pci_dev priv_flags */
402#define PCI_DEV_ADDED 0
403
Hari Vyas44bda4b2018-07-03 14:35:41 +0530404static 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
Keith Busch1e451162018-07-19 16:16:55 -0500414#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
Keith Busch4f802172018-09-20 10:27:08 -0600442#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
Hao, Xudong1900ca12011-12-17 21:24:40 +0800450#ifdef CONFIG_PCI_ATS
Kelsey Skunbergb92b5122019-07-24 17:38:45 -0600451/* Address Translation Service */
452void pci_ats_init(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600453void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800454#else
Kelsey Skunbergb92b5122019-07-24 17:38:45 -0600455static inline void pci_ats_init(struct pci_dev *d) { }
456static inline void pci_restore_ats_state(struct pci_dev *dev) { }
Hao, Xudong1900ca12011-12-17 21:24:40 +0800457#endif /* CONFIG_PCI_ATS */
458
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500459#ifdef CONFIG_PCI_PRI
460void pci_pri_init(struct pci_dev *dev);
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500461void pci_restore_pri_state(struct pci_dev *pdev);
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500462#else
463static inline void pci_pri_init(struct pci_dev *dev) { }
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500464static inline void pci_restore_pri_state(struct pci_dev *pdev) { }
Kuppuswamy Sathyanarayananc0651902019-09-05 14:31:45 -0500465#endif
466
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500467#ifdef CONFIG_PCI_PASID
468void pci_pasid_init(struct pci_dev *dev);
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500469void pci_restore_pasid_state(struct pci_dev *pdev);
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500470#else
471static inline void pci_pasid_init(struct pci_dev *dev) { }
Bjorn Helgaasfef2dd82019-10-09 16:47:15 -0500472static inline void pci_restore_pasid_state(struct pci_dev *pdev) { }
Kuppuswamy Sathyanarayanan751035b2019-09-05 14:31:46 -0500473#endif
474
Yu Zhaod1b054d2009-03-20 11:25:11 +0800475#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600476int pci_iov_init(struct pci_dev *dev);
477void pci_iov_release(struct pci_dev *dev);
Jakub Kicinski38972372018-06-29 15:08:52 -0500478void pci_iov_remove(struct pci_dev *dev);
Bjorn Helgaas6ffa2482016-11-28 09:15:52 -0600479void pci_iov_update_resource(struct pci_dev *dev, int resno);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600480resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
481void pci_restore_iov_state(struct pci_dev *dev);
482int pci_iov_bus_range(struct pci_bus *bus);
Kelsey Skunbergaaee0c12019-08-13 14:45:13 -0600483extern const struct attribute_group sriov_dev_attr_group;
Yu Zhaod1b054d2009-03-20 11:25:11 +0800484#else
485static inline int pci_iov_init(struct pci_dev *dev)
486{
487 return -ENODEV;
488}
489static inline void pci_iov_release(struct pci_dev *dev)
490
491{
492}
Jakub Kicinski38972372018-06-29 15:08:52 -0500493static inline void pci_iov_remove(struct pci_dev *dev)
494{
495}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800496static inline void pci_restore_iov_state(struct pci_dev *dev)
497{
498}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800499static inline int pci_iov_bus_range(struct pci_bus *bus)
500{
501 return 0;
502}
Yu Zhao302b4212009-05-18 13:51:32 +0800503
Yu Zhaod1b054d2009-03-20 11:25:11 +0800504#endif /* CONFIG_PCI_IOV */
505
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600506unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700507
Cam Macdonell0e522472010-09-07 17:25:20 -0700508static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600509 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700510{
511#ifdef CONFIG_PCI_IOV
512 int resno = res - dev->resource;
513
514 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
515 return pci_sriov_resource_alignment(dev, resno);
516#endif
Bjorn Helgaas0aa0f5d2017-12-02 13:21:37 -0600517 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
Ram Pai0a2daa12011-07-25 13:08:41 -0700518 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700519 return resource_alignment(res);
520}
521
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600522void pci_enable_acs(struct pci_dev *dev);
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500523#ifdef CONFIG_PCI_QUIRKS
524int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
525int pci_dev_specific_enable_acs(struct pci_dev *dev);
Logan Gunthorpe73c47dde2018-08-09 16:51:43 -0500526int pci_dev_specific_disable_acs_redir(struct pci_dev *dev);
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500527#else
528static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
529 u16 acs_flags)
530{
531 return -ENOTTY;
532}
533static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
534{
535 return -ENOTTY;
536}
Logan Gunthorpe73c47dde2018-08-09 16:51:43 -0500537static inline int pci_dev_specific_disable_acs_redir(struct pci_dev *dev)
538{
539 return -ENOTTY;
540}
Bjorn Helgaasbd2e9562018-08-09 16:19:52 -0500541#endif
Allen Kayae21ee62009-10-07 10:27:17 -0700542
Oza Pawandeep2e28bc82018-05-17 16:44:15 -0500543/* PCI error reporting and recovery */
Keith Buschbdb5ac852018-09-20 10:27:12 -0600544void pcie_do_recovery(struct pci_dev *dev, enum pci_channel_state state,
545 u32 service);
Oza Pawandeep2e28bc82018-05-17 16:44:15 -0500546
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -0500547bool pcie_wait_for_link(struct pci_dev *pdev, bool active);
Bjorn Helgaas7d8e7d12017-12-15 08:57:28 -0600548#ifdef CONFIG_PCIEASPM
549void pcie_aspm_init_link_state(struct pci_dev *pdev);
550void pcie_aspm_exit_link_state(struct pci_dev *pdev);
551void pcie_aspm_pm_state_change(struct pci_dev *pdev);
552void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
553#else
554static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
555static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
556static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
557static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
558#endif
559
560#ifdef CONFIG_PCIEASPM_DEBUG
561void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev);
562void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev);
563#else
564static inline void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev) { }
565static inline void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev) { }
566#endif
567
Kelsey Skunberg72bde9c2019-07-24 17:38:46 -0600568#ifdef CONFIG_PCIE_ECRC
569void pcie_set_ecrc_checking(struct pci_dev *dev);
570void pcie_ecrc_get_policy(char *str);
571#else
572static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
573static inline void pcie_ecrc_get_policy(char *str) { }
574#endif
575
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500576#ifdef CONFIG_PCIE_PTM
577void pci_ptm_init(struct pci_dev *dev);
Kelsey Skunbergac6c26d2019-07-24 17:38:47 -0600578int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500579#else
580static inline void pci_ptm_init(struct pci_dev *dev) { }
Kelsey Skunbergac6c26d2019-07-24 17:38:47 -0600581static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
582{ return -EINVAL; }
Jonathan Yong9bb04a02016-06-11 14:13:38 -0500583#endif
584
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800585struct pci_dev_reset_methods {
586 u16 vendor;
587 u16 device;
588 int (*reset)(struct pci_dev *dev, int probe);
589};
590
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100591#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600592int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100593#else
594static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
595{
596 return -ENOTTY;
597}
598#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800599
Dongdong Liu169de962016-12-01 00:33:42 -0600600#if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
601int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
602 struct resource *res);
603#endif
604
Christian König276b7382017-10-24 14:40:20 -0500605u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
606int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
607int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
608static inline u64 pci_rebar_size_to_bytes(int size)
609{
610 return 1ULL << (size + 20);
611}
612
Rob Herring9e2aee82018-05-11 12:15:30 -0500613struct device_node;
614
615#ifdef CONFIG_OF
616int of_pci_parse_bus_range(struct device_node *node, struct resource *res);
617int of_get_pci_domain_nr(struct device_node *node);
618int of_pci_get_max_link_speed(struct device_node *node);
Kelsey Skunberg621f7e32019-07-24 17:38:48 -0600619void pci_set_of_node(struct pci_dev *dev);
620void pci_release_of_node(struct pci_dev *dev);
621void pci_set_bus_of_node(struct pci_bus *bus);
622void pci_release_bus_of_node(struct pci_bus *bus);
Rob Herring9e2aee82018-05-11 12:15:30 -0500623
624#else
625static inline int
626of_pci_parse_bus_range(struct device_node *node, struct resource *res)
627{
628 return -EINVAL;
629}
630
631static inline int
632of_get_pci_domain_nr(struct device_node *node)
633{
634 return -1;
635}
636
637static inline int
638of_pci_get_max_link_speed(struct device_node *node)
639{
640 return -EINVAL;
641}
Kelsey Skunberg621f7e32019-07-24 17:38:48 -0600642
643static inline void pci_set_of_node(struct pci_dev *dev) { }
644static inline void pci_release_of_node(struct pci_dev *dev) { }
645static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
646static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
Rob Herring9e2aee82018-05-11 12:15:30 -0500647#endif /* CONFIG_OF */
648
649#if defined(CONFIG_OF_ADDRESS)
Bjorn Helgaasf03c7aa2018-06-06 16:10:27 -0500650int devm_of_pci_get_host_bridge_resources(struct device *dev,
Rob Herring9e2aee82018-05-11 12:15:30 -0500651 unsigned char busno, unsigned char bus_max,
652 struct list_head *resources, resource_size_t *io_base);
653#else
Bjorn Helgaasf03c7aa2018-06-06 16:10:27 -0500654static inline int devm_of_pci_get_host_bridge_resources(struct device *dev,
Rob Herring9e2aee82018-05-11 12:15:30 -0500655 unsigned char busno, unsigned char bus_max,
656 struct list_head *resources, resource_size_t *io_base)
657{
658 return -EINVAL;
659}
660#endif
661
Rajat Jain60ed9822018-06-21 16:48:26 -0700662#ifdef CONFIG_PCIEAER
663void pci_no_aer(void);
664void pci_aer_init(struct pci_dev *dev);
Rajat Jaindb89ccb2018-06-30 15:07:17 -0500665void pci_aer_exit(struct pci_dev *dev);
Rajat Jain81aa5202018-06-21 16:48:28 -0700666extern const struct attribute_group aer_stats_attr_group;
Bjorn Helgaas7ab92e82018-07-19 17:55:58 -0500667void pci_aer_clear_fatal_status(struct pci_dev *dev);
Oza Pawandeepec752f52018-07-19 17:58:09 -0500668void pci_aer_clear_device_status(struct pci_dev *dev);
Rajat Jain60ed9822018-06-21 16:48:26 -0700669#else
670static inline void pci_no_aer(void) { }
Jisheng Zhang31f996e2019-04-12 06:43:06 +0000671static inline void pci_aer_init(struct pci_dev *d) { }
Rajat Jaindb89ccb2018-06-30 15:07:17 -0500672static inline void pci_aer_exit(struct pci_dev *d) { }
Bjorn Helgaas7ab92e82018-07-19 17:55:58 -0500673static inline void pci_aer_clear_fatal_status(struct pci_dev *dev) { }
Oza Pawandeepec752f52018-07-19 17:58:09 -0500674static inline void pci_aer_clear_device_status(struct pci_dev *dev) { }
Rajat Jain60ed9822018-06-21 16:48:26 -0700675#endif
676
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200677#ifdef CONFIG_ACPI
Krzysztof Wilczynski4a2dbed2019-08-27 11:49:51 +0200678int pci_acpi_program_hp_params(struct pci_dev *dev);
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200679#else
Krzysztof Wilczynski4a2dbed2019-08-27 11:49:51 +0200680static inline int pci_acpi_program_hp_params(struct pci_dev *dev)
Krzysztof Wilczynski8c3aac62019-08-27 11:49:50 +0200681{
682 return -ENODEV;
683}
684#endif
685
Zhao, Yu557848c2008-10-13 19:18:07 +0800686#endif /* DRIVERS_PCI_H */