blob: 50b55a1e3d766883f19cb8e7dc33984c269f58b6 [file] [log] [blame]
Bjorn Helgaas7328c8f2018-01-26 11:45:16 -06001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Bjorn Helgaasdf62ab52018-03-09 16:36:33 -06003 * PCI Bus Services, see include/linux/pci.h for further explanation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Bjorn Helgaasdf62ab52018-03-09 16:36:33 -06005 * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
6 * David Mosberger-Tang
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
Bjorn Helgaasdf62ab52018-03-09 16:36:33 -06008 * Copyright 1997 -- 2000 Martin Mares <mj@ucw.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10
Tomasz Nowicki2ab51dd2016-06-10 15:36:26 -050011#include <linux/acpi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/kernel.h>
13#include <linux/delay.h>
Mika Westerberg9d26d3a2016-06-02 11:17:12 +030014#include <linux/dmi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/init.h>
Krzysztof Wilczynskibbd8810d2019-09-03 13:30:59 +020016#include <linux/msi.h>
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -070017#include <linux/of.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/pci.h>
David Brownell075c1772007-04-26 00:12:06 -070019#include <linux/pm.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/module.h>
22#include <linux/spinlock.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080023#include <linux/string.h>
vignesh babu229f5af2007-08-13 18:23:14 +053024#include <linux/log2.h>
Zhichang Yuan57453922018-03-15 02:15:53 +080025#include <linux/logic_pio.h>
Stephen Rothwellc300bd2fb2008-07-10 02:16:44 +020026#include <linux/pm_wakeup.h>
Sheng Yang8dd7f802008-10-21 17:38:25 +080027#include <linux/interrupt.h>
Yuji Shimada32a9a6822009-03-16 17:13:39 +090028#include <linux/device.h>
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010029#include <linux/pm_runtime.h>
Alex Williamson608c3882013-08-08 14:09:43 -060030#include <linux/pci_hotplug.h>
Sinan Kaya4d3f1382016-06-10 21:55:11 +020031#include <linux/vmalloc.h>
Ben Dooks2a2aca32016-06-17 16:05:13 +010032#include <asm/dma.h>
Taku Izumib07461a2015-09-17 10:09:37 -050033#include <linux/aer.h>
Greg KHbc56b9e2005-04-08 14:53:31 +090034#include "pci.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Keith Buschc4eed622018-09-20 10:27:11 -060036DEFINE_MUTEX(pci_slot_mutex);
37
Alan Stern00240c32009-04-27 13:33:16 -040038const char *pci_power_names[] = {
39 "error", "D0", "D1", "D2", "D3hot", "D3cold", "unknown",
40};
41EXPORT_SYMBOL_GPL(pci_power_names);
42
Rafael J. Wysocki93177a72010-01-02 22:57:24 +010043int isa_dma_bridge_buggy;
44EXPORT_SYMBOL(isa_dma_bridge_buggy);
45
46int pci_pci_problems;
47EXPORT_SYMBOL(pci_pci_problems);
48
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +000049unsigned int pci_pm_d3hot_delay;
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010050
Matthew Garrettdf17e622010-10-04 14:22:29 -040051static void pci_pme_list_scan(struct work_struct *work);
52
53static LIST_HEAD(pci_pme_list);
54static DEFINE_MUTEX(pci_pme_list_mutex);
55static DECLARE_DELAYED_WORK(pci_pme_work, pci_pme_list_scan);
56
57struct pci_pme_device {
58 struct list_head list;
59 struct pci_dev *dev;
60};
61
62#define PME_TIMEOUT 1000 /* How long between PME checks */
63
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010064static void pci_dev_d3_sleep(struct pci_dev *dev)
65{
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +000066 unsigned int delay = dev->d3hot_delay;
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010067
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +000068 if (delay < pci_pm_d3hot_delay)
69 delay = pci_pm_d3hot_delay;
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010070
Adrian Hunter50b2b542017-03-14 15:21:58 +020071 if (delay)
72 msleep(delay);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010073}
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Jeff Garzik32a2eea2007-10-11 16:57:27 -040075#ifdef CONFIG_PCI_DOMAINS
76int pci_domains_supported = 1;
77#endif
78
Atsushi Nemoto4516a612007-02-05 16:36:06 -080079#define DEFAULT_CARDBUS_IO_SIZE (256)
80#define DEFAULT_CARDBUS_MEM_SIZE (64*1024*1024)
81/* pci=cbmemsize=nnM,cbiosize=nn can override this */
82unsigned long pci_cardbus_io_size = DEFAULT_CARDBUS_IO_SIZE;
83unsigned long pci_cardbus_mem_size = DEFAULT_CARDBUS_MEM_SIZE;
84
Eric W. Biederman28760482009-09-09 14:09:24 -070085#define DEFAULT_HOTPLUG_IO_SIZE (256)
Nicholas Johnsond7b8a212019-10-23 12:12:29 +000086#define DEFAULT_HOTPLUG_MMIO_SIZE (2*1024*1024)
87#define DEFAULT_HOTPLUG_MMIO_PREF_SIZE (2*1024*1024)
88/* hpiosize=nn can override this */
Eric W. Biederman28760482009-09-09 14:09:24 -070089unsigned long pci_hotplug_io_size = DEFAULT_HOTPLUG_IO_SIZE;
Nicholas Johnsond7b8a212019-10-23 12:12:29 +000090/*
91 * pci=hpmmiosize=nnM overrides non-prefetchable MMIO size,
92 * pci=hpmmioprefsize=nnM overrides prefetchable MMIO size;
93 * pci=hpmemsize=nnM overrides both
94 */
95unsigned long pci_hotplug_mmio_size = DEFAULT_HOTPLUG_MMIO_SIZE;
96unsigned long pci_hotplug_mmio_pref_size = DEFAULT_HOTPLUG_MMIO_PREF_SIZE;
Eric W. Biederman28760482009-09-09 14:09:24 -070097
Keith Busche16b4662016-07-21 21:40:28 -060098#define DEFAULT_HOTPLUG_BUS_SIZE 1
99unsigned long pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
100
Jim Quinlanb0e85c32020-09-28 15:46:51 -0400101
102/* PCIe MPS/MRRS strategy; can be overridden by kernel command-line param */
103#ifdef CONFIG_PCIE_BUS_TUNE_OFF
104enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_TUNE_OFF;
105#elif defined CONFIG_PCIE_BUS_SAFE
106enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_SAFE;
107#elif defined CONFIG_PCIE_BUS_PERFORMANCE
108enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_PERFORMANCE;
109#elif defined CONFIG_PCIE_BUS_PEER2PEER
110enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_PEER2PEER;
111#else
Keith Busch27d868b2015-08-24 08:48:16 -0500112enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_DEFAULT;
Jim Quinlanb0e85c32020-09-28 15:46:51 -0400113#endif
Jon Masonb03e7492011-07-20 15:20:54 -0500114
Jesse Barnesac1aa472009-10-26 13:20:44 -0700115/*
116 * The default CLS is used if arch didn't set CLS explicitly and not
117 * all pci devices agree on the same value. Arch can override either
118 * the dfl or actual value as it sees fit. Don't forget this is
119 * measured in 32-bit words, not bytes.
120 */
Bill Pemberton15856ad2012-11-21 15:35:00 -0500121u8 pci_dfl_cache_line_size = L1_CACHE_BYTES >> 2;
Jesse Barnesac1aa472009-10-26 13:20:44 -0700122u8 pci_cache_line_size;
123
Myron Stowe96c55902011-10-28 15:48:38 -0600124/*
125 * If we set up a device for bus mastering, we need to check the latency
126 * timer as certain BIOSes forget to set it properly.
127 */
128unsigned int pcibios_max_latency = 255;
129
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +0100130/* If set, the PCIe ARI capability will not be used. */
131static bool pcie_ari_disabled;
132
Gil Kupfercef74402018-05-10 17:56:02 -0500133/* If set, the PCIe ATS capability will not be used. */
134static bool pcie_ats_disabled;
135
Sinan Kaya11eb0e02018-06-04 22:16:09 -0400136/* If set, the PCI config space of each device is printed during boot. */
137bool pci_early_dump;
138
Gil Kupfercef74402018-05-10 17:56:02 -0500139bool pci_ats_disabled(void)
140{
141 return pcie_ats_disabled;
142}
Will Deacon1a373a72019-12-19 12:03:40 +0000143EXPORT_SYMBOL_GPL(pci_ats_disabled);
Gil Kupfercef74402018-05-10 17:56:02 -0500144
Mika Westerberg9d26d3a2016-06-02 11:17:12 +0300145/* Disable bridge_d3 for all PCIe ports */
146static bool pci_bridge_d3_disable;
147/* Force bridge_d3 for all PCIe ports */
148static bool pci_bridge_d3_force;
149
150static int __init pcie_port_pm_setup(char *str)
151{
152 if (!strcmp(str, "off"))
153 pci_bridge_d3_disable = true;
154 else if (!strcmp(str, "force"))
155 pci_bridge_d3_force = true;
156 return 1;
157}
158__setup("pcie_port_pm=", pcie_port_pm_setup);
159
Sinan Kayaa2758b62018-02-27 14:14:10 -0600160/* Time to wait after a reset for device to become responsive */
161#define PCIE_RESET_READY_POLL_MS 60000
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163/**
164 * pci_bus_max_busnr - returns maximum PCI bus number of given bus' children
165 * @bus: pointer to PCI bus structure to search
166 *
167 * Given a PCI bus, returns the highest PCI bus number present in the set
168 * including the given PCI bus and its list of child PCI buses.
169 */
Ryan Desfosses07656d83082014-04-11 01:01:53 -0400170unsigned char pci_bus_max_busnr(struct pci_bus *bus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Yijing Wang94e6a9b2014-02-13 21:14:03 +0800172 struct pci_bus *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 unsigned char max, n;
174
Yinghai Lub918c622012-05-17 18:51:11 -0700175 max = bus->busn_res.end;
Yijing Wang94e6a9b2014-02-13 21:14:03 +0800176 list_for_each_entry(tmp, &bus->children, node) {
177 n = pci_bus_max_busnr(tmp);
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400178 if (n > max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 max = n;
180 }
181 return max;
182}
Kristen Accardib82db5c2006-01-17 16:56:56 -0800183EXPORT_SYMBOL_GPL(pci_bus_max_busnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Heiner Kallweitec5d9e82020-02-29 23:24:23 +0100185/**
186 * pci_status_get_and_clear_errors - return and clear error bits in PCI_STATUS
187 * @pdev: the PCI device
188 *
189 * Returns error bits set in PCI_STATUS and clears them.
190 */
191int pci_status_get_and_clear_errors(struct pci_dev *pdev)
192{
193 u16 status;
194 int ret;
195
196 ret = pci_read_config_word(pdev, PCI_STATUS, &status);
197 if (ret != PCIBIOS_SUCCESSFUL)
198 return -EIO;
199
200 status &= PCI_STATUS_ERROR_BITS;
201 if (status)
202 pci_write_config_word(pdev, PCI_STATUS, status);
203
204 return status;
205}
206EXPORT_SYMBOL_GPL(pci_status_get_and_clear_errors);
207
Andrew Morton1684f5d2008-12-01 14:30:30 -0800208#ifdef CONFIG_HAS_IOMEM
209void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar)
210{
Bjorn Helgaas1f7bf3bf2015-03-12 12:30:11 -0500211 struct resource *res = &pdev->resource[bar];
212
Andrew Morton1684f5d2008-12-01 14:30:30 -0800213 /*
214 * Make sure the BAR is actually a memory resource, not an IO resource
215 */
Bjorn Helgaas646c0282015-03-12 12:30:15 -0500216 if (res->flags & IORESOURCE_UNSET || !(res->flags & IORESOURCE_MEM)) {
Frederick Lawler7506dc72018-01-18 12:55:24 -0600217 pci_warn(pdev, "can't ioremap BAR %d: %pR\n", bar, res);
Andrew Morton1684f5d2008-12-01 14:30:30 -0800218 return NULL;
219 }
Christoph Hellwig4bdc0d62020-01-06 09:43:50 +0100220 return ioremap(res->start, resource_size(res));
Andrew Morton1684f5d2008-12-01 14:30:30 -0800221}
222EXPORT_SYMBOL_GPL(pci_ioremap_bar);
Luis R. Rodriguezc43996f2015-08-24 12:13:23 -0700223
224void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar)
225{
226 /*
227 * Make sure the BAR is actually a memory resource, not an IO resource
228 */
229 if (!(pci_resource_flags(pdev, bar) & IORESOURCE_MEM)) {
230 WARN_ON(1);
231 return NULL;
232 }
233 return ioremap_wc(pci_resource_start(pdev, bar),
234 pci_resource_len(pdev, bar));
235}
236EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
Andrew Morton1684f5d2008-12-01 14:30:30 -0800237#endif
238
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600239/**
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600240 * pci_dev_str_match_path - test if a path string matches a device
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600241 * @dev: the PCI device to test
242 * @path: string to match the device against
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600243 * @endptr: pointer to the string after the match
244 *
245 * Test if a string (typically from a kernel parameter) formatted as a
246 * path of device/function addresses matches a PCI device. The string must
247 * be of the form:
248 *
249 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
250 *
251 * A path for a device can be obtained using 'lspci -t'. Using a path
252 * is more robust against bus renumbering than using only a single bus,
253 * device and function address.
254 *
255 * Returns 1 if the string matches the device, 0 if it does not and
256 * a negative error code if it fails to parse the string.
257 */
258static int pci_dev_str_match_path(struct pci_dev *dev, const char *path,
259 const char **endptr)
260{
261 int ret;
262 int seg, bus, slot, func;
263 char *wpath, *p;
264 char end;
265
266 *endptr = strchrnul(path, ';');
267
268 wpath = kmemdup_nul(path, *endptr - path, GFP_KERNEL);
269 if (!wpath)
270 return -ENOMEM;
271
272 while (1) {
273 p = strrchr(wpath, '/');
274 if (!p)
275 break;
276 ret = sscanf(p, "/%x.%x%c", &slot, &func, &end);
277 if (ret != 2) {
278 ret = -EINVAL;
279 goto free_and_exit;
280 }
281
282 if (dev->devfn != PCI_DEVFN(slot, func)) {
283 ret = 0;
284 goto free_and_exit;
285 }
286
287 /*
288 * Note: we don't need to get a reference to the upstream
289 * bridge because we hold a reference to the top level
290 * device which should hold a reference to the bridge,
291 * and so on.
292 */
293 dev = pci_upstream_bridge(dev);
294 if (!dev) {
295 ret = 0;
296 goto free_and_exit;
297 }
298
299 *p = 0;
300 }
301
302 ret = sscanf(wpath, "%x:%x:%x.%x%c", &seg, &bus, &slot,
303 &func, &end);
304 if (ret != 4) {
305 seg = 0;
306 ret = sscanf(wpath, "%x:%x.%x%c", &bus, &slot, &func, &end);
307 if (ret != 3) {
308 ret = -EINVAL;
309 goto free_and_exit;
310 }
311 }
312
313 ret = (seg == pci_domain_nr(dev->bus) &&
314 bus == dev->bus->number &&
315 dev->devfn == PCI_DEVFN(slot, func));
316
317free_and_exit:
318 kfree(wpath);
319 return ret;
320}
321
322/**
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600323 * pci_dev_str_match - test if a string matches a device
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600324 * @dev: the PCI device to test
325 * @p: string to match the device against
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600326 * @endptr: pointer to the string after the match
327 *
328 * Test if a string (typically from a kernel parameter) matches a specified
329 * PCI device. The string may be of one of the following formats:
330 *
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600331 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600332 * pci:<vendor>:<device>[:<subvendor>:<subdevice>]
333 *
334 * The first format specifies a PCI bus/device/function address which
335 * may change if new hardware is inserted, if motherboard firmware changes,
336 * or due to changes caused in kernel parameters. If the domain is
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600337 * left unspecified, it is taken to be 0. In order to be robust against
338 * bus renumbering issues, a path of PCI device/function numbers may be used
339 * to address the specific device. The path for a device can be determined
340 * through the use of 'lspci -t'.
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600341 *
342 * The second format matches devices using IDs in the configuration
343 * space which may match multiple devices in the system. A value of 0
344 * for any field will match all devices. (Note: this differs from
345 * in-kernel code that uses PCI_ANY_ID which is ~0; this is for
346 * legacy reasons and convenience so users don't have to specify
347 * FFFFFFFFs on the command line.)
348 *
349 * Returns 1 if the string matches the device, 0 if it does not and
350 * a negative error code if the string cannot be parsed.
351 */
352static int pci_dev_str_match(struct pci_dev *dev, const char *p,
353 const char **endptr)
354{
355 int ret;
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600356 int count;
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600357 unsigned short vendor, device, subsystem_vendor, subsystem_device;
358
359 if (strncmp(p, "pci:", 4) == 0) {
360 /* PCI vendor/device (subvendor/subdevice) IDs are specified */
361 p += 4;
362 ret = sscanf(p, "%hx:%hx:%hx:%hx%n", &vendor, &device,
363 &subsystem_vendor, &subsystem_device, &count);
364 if (ret != 4) {
365 ret = sscanf(p, "%hx:%hx%n", &vendor, &device, &count);
366 if (ret != 2)
367 return -EINVAL;
368
369 subsystem_vendor = 0;
370 subsystem_device = 0;
371 }
372
373 p += count;
374
375 if ((!vendor || vendor == dev->vendor) &&
376 (!device || device == dev->device) &&
377 (!subsystem_vendor ||
378 subsystem_vendor == dev->subsystem_vendor) &&
379 (!subsystem_device ||
380 subsystem_device == dev->subsystem_device))
381 goto found;
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600382 } else {
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600383 /*
384 * PCI Bus, Device, Function IDs are specified
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600385 * (optionally, may include a path of devfns following it)
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600386 */
387 ret = pci_dev_str_match_path(dev, p, &p);
388 if (ret < 0)
389 return ret;
390 else if (ret)
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600391 goto found;
392 }
393
394 *endptr = p;
395 return 0;
396
397found:
398 *endptr = p;
399 return 1;
400}
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100401
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530402static u8 __pci_find_next_cap_ttl(struct pci_bus *bus, unsigned int devfn,
403 u8 pos, int cap, int *ttl)
Roland Dreier24a4e372005-10-28 17:35:34 -0700404{
405 u8 id;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700406 u16 ent;
407
408 pci_bus_read_config_byte(bus, devfn, pos, &pos);
Roland Dreier24a4e372005-10-28 17:35:34 -0700409
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100410 while ((*ttl)--) {
Roland Dreier24a4e372005-10-28 17:35:34 -0700411 if (pos < 0x40)
412 break;
413 pos &= ~3;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700414 pci_bus_read_config_word(bus, devfn, pos, &ent);
415
416 id = ent & 0xff;
Roland Dreier24a4e372005-10-28 17:35:34 -0700417 if (id == 0xff)
418 break;
419 if (id == cap)
420 return pos;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700421 pos = (ent >> 8);
Roland Dreier24a4e372005-10-28 17:35:34 -0700422 }
423 return 0;
424}
425
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530426static u8 __pci_find_next_cap(struct pci_bus *bus, unsigned int devfn,
427 u8 pos, int cap)
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100428{
429 int ttl = PCI_FIND_CAP_TTL;
430
431 return __pci_find_next_cap_ttl(bus, devfn, pos, cap, &ttl);
432}
433
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530434u8 pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap)
Roland Dreier24a4e372005-10-28 17:35:34 -0700435{
436 return __pci_find_next_cap(dev->bus, dev->devfn,
437 pos + PCI_CAP_LIST_NEXT, cap);
438}
439EXPORT_SYMBOL_GPL(pci_find_next_capability);
440
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530441static u8 __pci_bus_find_cap_start(struct pci_bus *bus,
Michael Ellermand3bac112006-11-22 18:26:16 +1100442 unsigned int devfn, u8 hdr_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 u16 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446 pci_bus_read_config_word(bus, devfn, PCI_STATUS, &status);
447 if (!(status & PCI_STATUS_CAP_LIST))
448 return 0;
449
450 switch (hdr_type) {
451 case PCI_HEADER_TYPE_NORMAL:
452 case PCI_HEADER_TYPE_BRIDGE:
Michael Ellermand3bac112006-11-22 18:26:16 +1100453 return PCI_CAPABILITY_LIST;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 case PCI_HEADER_TYPE_CARDBUS:
Michael Ellermand3bac112006-11-22 18:26:16 +1100455 return PCI_CB_CAPABILITY_LIST;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 }
Michael Ellermand3bac112006-11-22 18:26:16 +1100457
458 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459}
460
461/**
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700462 * pci_find_capability - query for devices' capabilities
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 * @dev: PCI device to query
464 * @cap: capability code
465 *
466 * Tell if a device supports a given PCI capability.
467 * Returns the address of the requested capability structure within the
468 * device's PCI configuration space or 0 in case the device does not
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600469 * support it. Possible values for @cap include:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700471 * %PCI_CAP_ID_PM Power Management
472 * %PCI_CAP_ID_AGP Accelerated Graphics Port
473 * %PCI_CAP_ID_VPD Vital Product Data
474 * %PCI_CAP_ID_SLOTID Slot Identification
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 * %PCI_CAP_ID_MSI Message Signalled Interrupts
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700476 * %PCI_CAP_ID_CHSWP CompactPCI HotSwap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 * %PCI_CAP_ID_PCIX PCI-X
478 * %PCI_CAP_ID_EXP PCI Express
479 */
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530480u8 pci_find_capability(struct pci_dev *dev, int cap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530482 u8 pos;
Michael Ellermand3bac112006-11-22 18:26:16 +1100483
484 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
485 if (pos)
486 pos = __pci_find_next_cap(dev->bus, dev->devfn, pos, cap);
487
488 return pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600490EXPORT_SYMBOL(pci_find_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492/**
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700493 * pci_bus_find_capability - query for devices' capabilities
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600494 * @bus: the PCI bus to query
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 * @devfn: PCI device to query
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600496 * @cap: capability code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600498 * Like pci_find_capability() but works for PCI devices that do not have a
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700499 * pci_dev structure set up yet.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 *
501 * Returns the address of the requested capability structure within the
502 * device's PCI configuration space or 0 in case the device does not
503 * support it.
504 */
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530505u8 pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530507 u8 hdr_type, pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509 pci_bus_read_config_byte(bus, devfn, PCI_HEADER_TYPE, &hdr_type);
510
Michael Ellermand3bac112006-11-22 18:26:16 +1100511 pos = __pci_bus_find_cap_start(bus, devfn, hdr_type & 0x7f);
512 if (pos)
513 pos = __pci_find_next_cap(bus, devfn, pos, cap);
514
515 return pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600517EXPORT_SYMBOL(pci_bus_find_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519/**
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600520 * pci_find_next_ext_capability - Find an extended capability
521 * @dev: PCI device to query
522 * @start: address at which to start looking (0 to start at beginning of list)
523 * @cap: capability code
524 *
525 * Returns the address of the next matching extended capability structure
526 * within the device's PCI configuration space or 0 if the device does
527 * not support it. Some capabilities can occur several times, e.g., the
528 * vendor-specific capability, and this provides a way to find them all.
529 */
Bjorn Helgaasee8b1c42020-12-04 15:14:07 -0600530u16 pci_find_next_ext_capability(struct pci_dev *dev, u16 start, int cap)
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600531{
532 u32 header;
533 int ttl;
Bjorn Helgaasee8b1c42020-12-04 15:14:07 -0600534 u16 pos = PCI_CFG_SPACE_SIZE;
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600535
536 /* minimum 8 bytes per capability */
537 ttl = (PCI_CFG_SPACE_EXP_SIZE - PCI_CFG_SPACE_SIZE) / 8;
538
539 if (dev->cfg_size <= PCI_CFG_SPACE_SIZE)
540 return 0;
541
542 if (start)
543 pos = start;
544
545 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
546 return 0;
547
548 /*
549 * If we have no capabilities, this is indicated by cap ID,
550 * cap version and next pointer all being 0.
551 */
552 if (header == 0)
553 return 0;
554
555 while (ttl-- > 0) {
556 if (PCI_EXT_CAP_ID(header) == cap && pos != start)
557 return pos;
558
559 pos = PCI_EXT_CAP_NEXT(header);
560 if (pos < PCI_CFG_SPACE_SIZE)
561 break;
562
563 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
564 break;
565 }
566
567 return 0;
568}
569EXPORT_SYMBOL_GPL(pci_find_next_ext_capability);
570
571/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 * pci_find_ext_capability - Find an extended capability
573 * @dev: PCI device to query
574 * @cap: capability code
575 *
576 * Returns the address of the requested extended capability structure
577 * within the device's PCI configuration space or 0 if the device does
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600578 * not support it. Possible values for @cap include:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 *
580 * %PCI_EXT_CAP_ID_ERR Advanced Error Reporting
581 * %PCI_EXT_CAP_ID_VC Virtual Channel
582 * %PCI_EXT_CAP_ID_DSN Device Serial Number
583 * %PCI_EXT_CAP_ID_PWR Power Budgeting
584 */
Bjorn Helgaasee8b1c42020-12-04 15:14:07 -0600585u16 pci_find_ext_capability(struct pci_dev *dev, int cap)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586{
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600587 return pci_find_next_ext_capability(dev, 0, cap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588}
Brice Goglin3a720d72006-05-23 06:10:01 -0400589EXPORT_SYMBOL_GPL(pci_find_ext_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Jacob Keller70c09232020-03-02 18:25:00 -0800591/**
592 * pci_get_dsn - Read and return the 8-byte Device Serial Number
593 * @dev: PCI device to query
594 *
595 * Looks up the PCI_EXT_CAP_ID_DSN and reads the 8 bytes of the Device Serial
596 * Number.
597 *
598 * Returns the DSN, or zero if the capability does not exist.
599 */
600u64 pci_get_dsn(struct pci_dev *dev)
601{
602 u32 dword;
603 u64 dsn;
604 int pos;
605
606 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DSN);
607 if (!pos)
608 return 0;
609
610 /*
611 * The Device Serial Number is two dwords offset 4 bytes from the
612 * capability position. The specification says that the first dword is
613 * the lower half, and the second dword is the upper half.
614 */
615 pos += 4;
616 pci_read_config_dword(dev, pos, &dword);
617 dsn = (u64)dword;
618 pci_read_config_dword(dev, pos + 4, &dword);
619 dsn |= ((u64)dword) << 32;
620
621 return dsn;
622}
623EXPORT_SYMBOL_GPL(pci_get_dsn);
624
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530625static u8 __pci_find_next_ht_cap(struct pci_dev *dev, u8 pos, int ht_cap)
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100626{
627 int rc, ttl = PCI_FIND_CAP_TTL;
628 u8 cap, mask;
629
630 if (ht_cap == HT_CAPTYPE_SLAVE || ht_cap == HT_CAPTYPE_HOST)
631 mask = HT_3BIT_CAP_MASK;
632 else
633 mask = HT_5BIT_CAP_MASK;
634
635 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn, pos,
636 PCI_CAP_ID_HT, &ttl);
637 while (pos) {
638 rc = pci_read_config_byte(dev, pos + 3, &cap);
639 if (rc != PCIBIOS_SUCCESSFUL)
640 return 0;
641
642 if ((cap & mask) == ht_cap)
643 return pos;
644
Brice Goglin47a4d5b2007-01-10 23:15:29 -0800645 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn,
646 pos + PCI_CAP_LIST_NEXT,
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100647 PCI_CAP_ID_HT, &ttl);
648 }
649
650 return 0;
651}
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530652
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100653/**
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530654 * pci_find_next_ht_capability - query a device's HyperTransport capabilities
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100655 * @dev: PCI device to query
656 * @pos: Position from which to continue searching
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530657 * @ht_cap: HyperTransport capability code
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100658 *
659 * To be used in conjunction with pci_find_ht_capability() to search for
660 * all capabilities matching @ht_cap. @pos should always be a value returned
661 * from pci_find_ht_capability().
662 *
663 * NB. To be 100% safe against broken PCI devices, the caller should take
664 * steps to avoid an infinite loop.
665 */
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530666u8 pci_find_next_ht_capability(struct pci_dev *dev, u8 pos, int ht_cap)
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100667{
668 return __pci_find_next_ht_cap(dev, pos + PCI_CAP_LIST_NEXT, ht_cap);
669}
670EXPORT_SYMBOL_GPL(pci_find_next_ht_capability);
671
672/**
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530673 * pci_find_ht_capability - query a device's HyperTransport capabilities
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100674 * @dev: PCI device to query
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530675 * @ht_cap: HyperTransport capability code
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100676 *
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530677 * Tell if a device supports a given HyperTransport capability.
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100678 * Returns an address within the device's PCI configuration space
679 * or 0 in case the device does not support the request capability.
680 * The address points to the PCI capability, of type PCI_CAP_ID_HT,
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530681 * which has a HyperTransport capability matching @ht_cap.
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100682 */
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530683u8 pci_find_ht_capability(struct pci_dev *dev, int ht_cap)
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100684{
Puranjay Mohanf646c2a2020-11-29 22:16:26 +0530685 u8 pos;
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100686
687 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
688 if (pos)
689 pos = __pci_find_next_ht_cap(dev, pos, ht_cap);
690
691 return pos;
692}
693EXPORT_SYMBOL_GPL(pci_find_ht_capability);
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600696 * pci_find_parent_resource - return resource region of parent bus of given
697 * region
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 * @dev: PCI device structure contains resources to be searched
699 * @res: child resource record for which parent is sought
700 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600701 * For given resource region of given device, return the resource region of
702 * parent bus the given region is contained in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400704struct resource *pci_find_parent_resource(const struct pci_dev *dev,
705 struct resource *res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
707 const struct pci_bus *bus = dev->bus;
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700708 struct resource *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Bjorn Helgaas89a74ec2010-02-23 10:24:31 -0700711 pci_bus_for_each_resource(bus, r, i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 if (!r)
713 continue;
Ard Biesheuvel31342332017-04-11 17:33:12 +0100714 if (resource_contains(r, res)) {
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700715
716 /*
717 * If the window is prefetchable but the BAR is
718 * not, the allocator made a mistake.
719 */
720 if (r->flags & IORESOURCE_PREFETCH &&
721 !(res->flags & IORESOURCE_PREFETCH))
722 return NULL;
723
724 /*
725 * If we're below a transparent bridge, there may
726 * be both a positively-decoded aperture and a
727 * subtractively-decoded region that contain the BAR.
728 * We want the positively-decoded one, so this depends
729 * on pci_bus_for_each_resource() giving us those
730 * first.
731 */
732 return r;
733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 }
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700735 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600737EXPORT_SYMBOL(pci_find_parent_resource);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
739/**
Mika Westerbergafd29f92016-09-15 11:07:03 +0300740 * pci_find_resource - Return matching PCI device resource
741 * @dev: PCI device to query
742 * @res: Resource to look for
743 *
744 * Goes over standard PCI resources (BARs) and checks if the given resource
745 * is partially or fully contained in any of them. In that case the
746 * matching resource is returned, %NULL otherwise.
747 */
748struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res)
749{
750 int i;
751
Denis Efremovc9c13ba2019-09-28 02:43:08 +0300752 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
Mika Westerbergafd29f92016-09-15 11:07:03 +0300753 struct resource *r = &dev->resource[i];
754
755 if (r->start && resource_contains(r, res))
756 return r;
757 }
758
759 return NULL;
760}
761EXPORT_SYMBOL(pci_find_resource);
762
763/**
Alex Williamson157e8762013-12-17 16:43:39 -0700764 * pci_wait_for_pending - wait for @mask bit(s) to clear in status word @pos
765 * @dev: the PCI device to operate on
766 * @pos: config space offset of status word
767 * @mask: mask of bit(s) to care about in status word
768 *
769 * Return 1 when mask bit(s) in status word clear, 0 otherwise.
770 */
771int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask)
772{
773 int i;
774
775 /* Wait for Transaction Pending bit clean */
776 for (i = 0; i < 4; i++) {
777 u16 status;
778 if (i)
779 msleep((1 << (i - 1)) * 100);
780
781 pci_read_config_word(dev, pos, &status);
782 if (!(status & mask))
783 return 1;
784 }
785
786 return 0;
787}
788
Rajat Jaincbe42032020-07-07 15:46:01 -0700789static int pci_acs_enable;
790
791/**
792 * pci_request_acs - ask for ACS to be enabled if supported
793 */
794void pci_request_acs(void)
795{
796 pci_acs_enable = 1;
797}
798
799static const char *disable_acs_redir_param;
800
801/**
802 * pci_disable_acs_redir - disable ACS redirect capabilities
803 * @dev: the PCI device
804 *
805 * For only devices specified in the disable_acs_redir parameter.
806 */
807static void pci_disable_acs_redir(struct pci_dev *dev)
808{
809 int ret = 0;
810 const char *p;
811 int pos;
812 u16 ctrl;
813
814 if (!disable_acs_redir_param)
815 return;
816
817 p = disable_acs_redir_param;
818 while (*p) {
819 ret = pci_dev_str_match(dev, p, &p);
820 if (ret < 0) {
821 pr_info_once("PCI: Can't parse disable_acs_redir parameter: %s\n",
822 disable_acs_redir_param);
823
824 break;
825 } else if (ret == 1) {
826 /* Found a match */
827 break;
828 }
829
830 if (*p != ';' && *p != ',') {
831 /* End of param or invalid format */
832 break;
833 }
834 p++;
835 }
836
837 if (ret != 1)
838 return;
839
840 if (!pci_dev_specific_disable_acs_redir(dev))
841 return;
842
Rajat Jain52fbf5b2020-07-07 15:46:02 -0700843 pos = dev->acs_cap;
Rajat Jaincbe42032020-07-07 15:46:01 -0700844 if (!pos) {
845 pci_warn(dev, "cannot disable ACS redirect for this hardware as it does not have ACS capabilities\n");
846 return;
847 }
848
849 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
850
851 /* P2P Request & Completion Redirect */
852 ctrl &= ~(PCI_ACS_RR | PCI_ACS_CR | PCI_ACS_EC);
853
854 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
855
856 pci_info(dev, "disabled ACS redirect\n");
857}
858
859/**
860 * pci_std_enable_acs - enable ACS on devices using standard ACS capabilities
861 * @dev: the PCI device
862 */
863static void pci_std_enable_acs(struct pci_dev *dev)
864{
865 int pos;
866 u16 cap;
867 u16 ctrl;
868
Rajat Jain52fbf5b2020-07-07 15:46:02 -0700869 pos = dev->acs_cap;
Rajat Jaincbe42032020-07-07 15:46:01 -0700870 if (!pos)
871 return;
872
873 pci_read_config_word(dev, pos + PCI_ACS_CAP, &cap);
874 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
875
876 /* Source Validation */
877 ctrl |= (cap & PCI_ACS_SV);
878
879 /* P2P Request Redirect */
880 ctrl |= (cap & PCI_ACS_RR);
881
882 /* P2P Completion Redirect */
883 ctrl |= (cap & PCI_ACS_CR);
884
885 /* Upstream Forwarding */
886 ctrl |= (cap & PCI_ACS_UF);
887
Rajat Jain76fc8e82020-07-07 15:46:04 -0700888 /* Enable Translation Blocking for external devices */
889 if (dev->external_facing || dev->untrusted)
890 ctrl |= (cap & PCI_ACS_TB);
891
Rajat Jaincbe42032020-07-07 15:46:01 -0700892 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
893}
894
895/**
896 * pci_enable_acs - enable ACS if hardware support it
897 * @dev: the PCI device
898 */
Rajat Jain52fbf5b2020-07-07 15:46:02 -0700899static void pci_enable_acs(struct pci_dev *dev)
Rajat Jaincbe42032020-07-07 15:46:01 -0700900{
901 if (!pci_acs_enable)
902 goto disable_acs_redir;
903
904 if (!pci_dev_specific_enable_acs(dev))
905 goto disable_acs_redir;
906
907 pci_std_enable_acs(dev);
908
909disable_acs_redir:
910 /*
911 * Note: pci_disable_acs_redir() must be called even if ACS was not
912 * enabled by the kernel because it may have been enabled by
913 * platform firmware. So if we are told to disable it, we should
914 * always disable it after setting the kernel's default
915 * preferences.
916 */
917 pci_disable_acs_redir(dev);
918}
919
Alex Williamson157e8762013-12-17 16:43:39 -0700920/**
Wei Yang70675e02015-07-29 16:52:58 +0800921 * pci_restore_bars - restore a device's BAR values (e.g. after wake-up)
John W. Linville064b53db2005-07-27 10:19:44 -0400922 * @dev: PCI device to have its BARs restored
923 *
924 * Restore the BAR values for a given device, so as to make it
925 * accessible by its driver.
926 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400927static void pci_restore_bars(struct pci_dev *dev)
John W. Linville064b53db2005-07-27 10:19:44 -0400928{
Yu Zhaobc5f5a82008-11-22 02:40:00 +0800929 int i;
John W. Linville064b53db2005-07-27 10:19:44 -0400930
Yu Zhaobc5f5a82008-11-22 02:40:00 +0800931 for (i = 0; i < PCI_BRIDGE_RESOURCES; i++)
Yu Zhao14add802008-11-22 02:38:52 +0800932 pci_update_resource(dev, i);
John W. Linville064b53db2005-07-27 10:19:44 -0400933}
934
Julia Lawall299f2ff2015-12-06 17:33:45 +0100935static const struct pci_platform_pm_ops *pci_platform_pm;
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200936
Julia Lawall299f2ff2015-12-06 17:33:45 +0100937int pci_set_platform_pm(const struct pci_platform_pm_ops *ops)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200938{
Lukas Wunnercc7cc022016-09-18 05:39:20 +0200939 if (!ops->is_manageable || !ops->set_state || !ops->get_state ||
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200940 !ops->choose_state || !ops->set_wakeup || !ops->need_resume)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200941 return -EINVAL;
942 pci_platform_pm = ops;
943 return 0;
944}
945
946static inline bool platform_pci_power_manageable(struct pci_dev *dev)
947{
948 return pci_platform_pm ? pci_platform_pm->is_manageable(dev) : false;
949}
950
951static inline int platform_pci_set_power_state(struct pci_dev *dev,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400952 pci_power_t t)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200953{
954 return pci_platform_pm ? pci_platform_pm->set_state(dev, t) : -ENOSYS;
955}
956
Lukas Wunnercc7cc022016-09-18 05:39:20 +0200957static inline pci_power_t platform_pci_get_power_state(struct pci_dev *dev)
958{
959 return pci_platform_pm ? pci_platform_pm->get_state(dev) : PCI_UNKNOWN;
960}
961
Rafael J. Wysockib51033e2019-06-25 14:09:12 +0200962static inline void platform_pci_refresh_power_state(struct pci_dev *dev)
963{
964 if (pci_platform_pm && pci_platform_pm->refresh_state)
965 pci_platform_pm->refresh_state(dev);
966}
967
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200968static inline pci_power_t platform_pci_choose_state(struct pci_dev *dev)
969{
970 return pci_platform_pm ?
971 pci_platform_pm->choose_state(dev) : PCI_POWER_ERROR;
972}
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700973
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200974static inline int platform_pci_set_wakeup(struct pci_dev *dev, bool enable)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200975{
976 return pci_platform_pm ?
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200977 pci_platform_pm->set_wakeup(dev, enable) : -ENODEV;
Rafael J. Wysockib67ea762010-02-17 23:44:09 +0100978}
979
Rafael J. Wysockibac2a902015-01-21 02:17:42 +0100980static inline bool platform_pci_need_resume(struct pci_dev *dev)
981{
982 return pci_platform_pm ? pci_platform_pm->need_resume(dev) : false;
983}
984
Mika Westerberg26ad34d2018-09-27 16:57:14 -0500985static inline bool platform_pci_bridge_d3(struct pci_dev *dev)
986{
Bjorn Helgaasc3aaf082020-04-07 18:23:15 -0500987 if (pci_platform_pm && pci_platform_pm->bridge_d3)
988 return pci_platform_pm->bridge_d3(dev);
989 return false;
Mika Westerberg26ad34d2018-09-27 16:57:14 -0500990}
991
John W. Linville064b53db2005-07-27 10:19:44 -0400992/**
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200993 * pci_raw_set_power_state - Use PCI PM registers to set the power state of
Bjorn Helgaas74356ad2019-01-09 14:14:42 -0600994 * given PCI device
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200995 * @dev: PCI device to handle.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200996 * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 *
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200998 * RETURN VALUE:
999 * -EINVAL if the requested state is invalid.
1000 * -EIO if device does not support PCI PM or its PM capabilities register has a
1001 * wrong version, or device doesn't support the requested state.
1002 * 0 if device already is in the requested state.
1003 * 0 if device's power state has been successfully changed.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 */
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +01001005static int pci_raw_set_power_state(struct pci_dev *dev, pci_power_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001007 u16 pmcsr;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001008 bool need_restore = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Rafael J. Wysocki4a865902009-03-16 22:40:36 +01001010 /* Check if we're already there */
1011 if (dev->current_state == state)
1012 return 0;
1013
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001014 if (!dev->pm_cap)
Andrew Lunncca03de2007-07-09 11:55:58 -07001015 return -EIO;
1016
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001017 if (state < PCI_D0 || state > PCI_D3hot)
1018 return -EINVAL;
1019
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001020 /*
Bjorn Helgaase43f15e2019-08-02 18:47:22 -05001021 * Validate transition: We can enter D0 from any state, but if
1022 * we're already in a low-power state, we can only go deeper. E.g.,
1023 * we can go from D1 to D3, but we can't go directly from D3 to D1;
1024 * we'd have to go from D3 to D0, then to D1.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 */
Rafael J. Wysocki4a865902009-03-16 22:40:36 +01001026 if (state != PCI_D0 && dev->current_state <= PCI_D3cold
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001027 && dev->current_state > state) {
Bjorn Helgaase43f15e2019-08-02 18:47:22 -05001028 pci_err(dev, "invalid power transition (from %s to %s)\n",
1029 pci_power_name(dev->current_state),
1030 pci_power_name(state));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 return -EINVAL;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001034 /* Check if this device supports the desired state */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001035 if ((state == PCI_D1 && !dev->d1_support)
1036 || (state == PCI_D2 && !dev->d2_support))
Daniel Ritz3fe9d192005-08-17 15:32:19 -07001037 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001039 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
Bjorn Helgaas327ccbb2019-08-01 11:50:56 -05001040 if (pmcsr == (u16) ~0) {
1041 pci_err(dev, "can't change power state from %s to %s (config space inaccessible)\n",
1042 pci_power_name(dev->current_state),
1043 pci_power_name(state));
1044 return -EIO;
1045 }
John W. Linville064b53db2005-07-27 10:19:44 -04001046
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001047 /*
1048 * If we're (effectively) in D3, force entire word to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 * This doesn't affect PME_Status, disables PME_En, and
1050 * sets PowerState to 0.
1051 */
John W. Linville32a36582005-09-14 09:52:42 -04001052 switch (dev->current_state) {
John W. Linvilled3535fb2005-09-28 17:50:51 -04001053 case PCI_D0:
1054 case PCI_D1:
1055 case PCI_D2:
1056 pmcsr &= ~PCI_PM_CTRL_STATE_MASK;
1057 pmcsr |= state;
1058 break;
Rafael J. Wysockif62795f2009-05-18 22:51:12 +02001059 case PCI_D3hot:
1060 case PCI_D3cold:
John W. Linville32a36582005-09-14 09:52:42 -04001061 case PCI_UNKNOWN: /* Boot-up */
1062 if ((pmcsr & PCI_PM_CTRL_STATE_MASK) == PCI_D3hot
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +01001063 && !(pmcsr & PCI_PM_CTRL_NO_SOFT_RESET))
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001064 need_restore = true;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05001065 fallthrough; /* force to D0 */
John W. Linville32a36582005-09-14 09:52:42 -04001066 default:
John W. Linvilled3535fb2005-09-28 17:50:51 -04001067 pmcsr = 0;
John W. Linville32a36582005-09-14 09:52:42 -04001068 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 }
1070
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001071 /* Enter specified state */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001072 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001074 /*
1075 * Mandatory power management transition delays; see PCI PM 1.1
1076 * 5.6.1 table 18
1077 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 if (state == PCI_D3hot || dev->current_state == PCI_D3hot)
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01001079 pci_dev_d3_sleep(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 else if (state == PCI_D2 || dev->current_state == PCI_D2)
Bjorn Helgaas638c133e2020-09-29 14:24:11 -05001081 udelay(PCI_PM_D2_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
Rafael J. Wysockie13cdbd2009-10-05 00:48:40 +02001083 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1084 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
Krzysztof Wilczynski7f1c62c2019-08-26 00:46:16 +02001085 if (dev->current_state != state)
Bjorn Helgaase43f15e2019-08-02 18:47:22 -05001086 pci_info_ratelimited(dev, "refused to change power state from %s to %s\n",
1087 pci_power_name(dev->current_state),
1088 pci_power_name(state));
John W. Linville064b53db2005-07-27 10:19:44 -04001089
Huang Ying448bd852012-06-23 10:23:51 +08001090 /*
1091 * According to section 5.4.1 of the "PCI BUS POWER MANAGEMENT
John W. Linville064b53db2005-07-27 10:19:44 -04001092 * INTERFACE SPECIFICATION, REV. 1.2", a device transitioning
1093 * from D3hot to D0 _may_ perform an internal reset, thereby
1094 * going to "D0 Uninitialized" rather than "D0 Initialized".
1095 * For example, at least some versions of the 3c905B and the
1096 * 3c556B exhibit this behaviour.
1097 *
1098 * At least some laptop BIOSen (e.g. the Thinkpad T21) leave
1099 * devices in a D3hot state at boot. Consequently, we need to
1100 * restore at least the BARs so that the device will be
1101 * accessible to its driver.
1102 */
1103 if (need_restore)
1104 pci_restore_bars(dev);
1105
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +01001106 if (dev->bus->self)
Shaohua Li7d715a62008-02-25 09:46:41 +08001107 pcie_aspm_pm_state_change(dev->bus->self);
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 return 0;
1110}
1111
1112/**
Lukas Wunnera6a64022016-09-18 05:39:20 +02001113 * pci_update_current_state - Read power state of given device and cache it
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001114 * @dev: PCI device to handle.
Rafael J. Wysockif06fc0b2008-12-27 16:30:52 +01001115 * @state: State to cache in case the device doesn't have the PM capability
Lukas Wunnera6a64022016-09-18 05:39:20 +02001116 *
1117 * The power state is read from the PMCSR register, which however is
1118 * inaccessible in D3cold. The platform firmware is therefore queried first
1119 * to detect accessibility of the register. In case the platform firmware
1120 * reports an incorrect state or the device isn't power manageable by the
1121 * platform at all, we try to detect D3cold by testing accessibility of the
1122 * vendor ID in config space.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001123 */
Rafael J. Wysocki734104292009-01-07 13:07:15 +01001124void pci_update_current_state(struct pci_dev *dev, pci_power_t state)
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001125{
Lukas Wunnera6a64022016-09-18 05:39:20 +02001126 if (platform_pci_get_power_state(dev) == PCI_D3cold ||
1127 !pci_device_is_present(dev)) {
1128 dev->current_state = PCI_D3cold;
1129 } else if (dev->pm_cap) {
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001130 u16 pmcsr;
1131
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001132 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001133 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
Rafael J. Wysockif06fc0b2008-12-27 16:30:52 +01001134 } else {
1135 dev->current_state = state;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001136 }
1137}
1138
1139/**
Rafael J. Wysockib51033e2019-06-25 14:09:12 +02001140 * pci_refresh_power_state - Refresh the given device's power state data
1141 * @dev: Target PCI device.
1142 *
1143 * Ask the platform to refresh the devices power state information and invoke
1144 * pci_update_current_state() to update its current PCI power state.
1145 */
1146void pci_refresh_power_state(struct pci_dev *dev)
1147{
1148 if (platform_pci_power_manageable(dev))
1149 platform_pci_refresh_power_state(dev);
1150
1151 pci_update_current_state(dev, dev->current_state);
1152}
1153
1154/**
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001155 * pci_platform_power_transition - Use platform to change device power state
1156 * @dev: PCI device to handle.
1157 * @state: State to put the device into.
1158 */
Rafael J. Wysockid6aa37c2019-11-05 11:30:36 +01001159int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state)
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001160{
1161 int error;
1162
1163 if (platform_pci_power_manageable(dev)) {
1164 error = platform_pci_set_power_state(dev, state);
1165 if (!error)
1166 pci_update_current_state(dev, state);
Rafael J. Wysocki769ba722013-04-12 13:58:17 +00001167 } else
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001168 error = -ENODEV;
Rafael J. Wysocki769ba722013-04-12 13:58:17 +00001169
1170 if (error && !dev->pm_cap) /* Fall back to PCI_D0 */
1171 dev->current_state = PCI_D0;
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001172
1173 return error;
1174}
Rafael J. Wysockid6aa37c2019-11-05 11:30:36 +01001175EXPORT_SYMBOL_GPL(pci_platform_power_transition);
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001176
Mika Westerberg99efde62020-11-25 12:07:33 +03001177static int pci_resume_one(struct pci_dev *pci_dev, void *ign)
Stephen Hemminger0b950f02014-01-10 17:14:48 -07001178{
Stephen Hemminger0b950f02014-01-10 17:14:48 -07001179 pm_request_resume(&pci_dev->dev);
1180 return 0;
1181}
1182
1183/**
Mika Westerberg99efde62020-11-25 12:07:33 +03001184 * pci_resume_bus - Walk given bus and runtime resume devices on it
Stephen Hemminger0b950f02014-01-10 17:14:48 -07001185 * @bus: Top bus of the subtree to walk.
1186 */
Mika Westerberg99efde62020-11-25 12:07:33 +03001187void pci_resume_bus(struct pci_bus *bus)
Stephen Hemminger0b950f02014-01-10 17:14:48 -07001188{
1189 if (bus)
Mika Westerberg99efde62020-11-25 12:07:33 +03001190 pci_walk_bus(bus, pci_resume_one, NULL);
Stephen Hemminger0b950f02014-01-10 17:14:48 -07001191}
1192
Vidya Sagarbae26842019-11-20 10:47:42 +05301193static int pci_dev_wait(struct pci_dev *dev, char *reset_type, int timeout)
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001194{
Vidya Sagarbae26842019-11-20 10:47:42 +05301195 int delay = 1;
1196 u32 id;
1197
1198 /*
1199 * After reset, the device should not silently discard config
1200 * requests, but it may still indicate that it needs more time by
1201 * responding to them with CRS completions. The Root Port will
1202 * generally synthesize ~0 data to complete the read (except when
1203 * CRS SV is enabled and the read was for the Vendor ID; in that
1204 * case it synthesizes 0x0001 data).
1205 *
1206 * Wait for the device to return a non-CRS completion. Read the
1207 * Command register instead of Vendor ID so we don't have to
1208 * contend with the CRS SV value.
1209 */
1210 pci_read_config_dword(dev, PCI_COMMAND, &id);
1211 while (id == ~0) {
1212 if (delay > timeout) {
1213 pci_warn(dev, "not ready %dms after %s; giving up\n",
1214 delay - 1, reset_type);
1215 return -ENOTTY;
Huang Ying448bd852012-06-23 10:23:51 +08001216 }
Vidya Sagarbae26842019-11-20 10:47:42 +05301217
1218 if (delay > 1000)
1219 pci_info(dev, "not ready %dms after %s; waiting\n",
1220 delay - 1, reset_type);
1221
1222 msleep(delay);
1223 delay *= 2;
1224 pci_read_config_dword(dev, PCI_COMMAND, &id);
Huang Ying448bd852012-06-23 10:23:51 +08001225 }
Vidya Sagarbae26842019-11-20 10:47:42 +05301226
1227 if (delay > 1000)
1228 pci_info(dev, "ready %dms after %s\n", delay - 1,
1229 reset_type);
1230
1231 return 0;
1232}
1233
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001234/**
Rafael J. Wysockiadfac8f2019-11-05 11:27:49 +01001235 * pci_power_up - Put the given device into D0
1236 * @dev: PCI device to power up
1237 */
1238int pci_power_up(struct pci_dev *dev)
1239{
Rafael J. Wysockidc2256b2019-11-05 11:29:16 +01001240 pci_platform_power_transition(dev, PCI_D0);
1241
1242 /*
Mika Westerbergad9001f2019-11-12 12:16:17 +03001243 * Mandatory power management transition delays are handled in
1244 * pci_pm_resume_noirq() and pci_pm_runtime_resume() of the
1245 * corresponding bridge.
Rafael J. Wysockidc2256b2019-11-05 11:29:16 +01001246 */
1247 if (dev->runtime_d3cold) {
Rafael J. Wysockidc2256b2019-11-05 11:29:16 +01001248 /*
1249 * When powering on a bridge from D3cold, the whole hierarchy
1250 * may be powered on into D0uninitialized state, resume them to
1251 * give them a chance to suspend again
1252 */
Mika Westerberg99efde62020-11-25 12:07:33 +03001253 pci_resume_bus(dev->subordinate);
Rafael J. Wysockidc2256b2019-11-05 11:29:16 +01001254 }
1255
Rafael J. Wysockiadfac8f2019-11-05 11:27:49 +01001256 return pci_raw_set_power_state(dev, PCI_D0);
Huang Ying448bd852012-06-23 10:23:51 +08001257}
1258
1259/**
1260 * __pci_dev_set_current_state - Set current state of a PCI device
1261 * @dev: Device to handle
1262 * @data: pointer to state to be set
1263 */
1264static int __pci_dev_set_current_state(struct pci_dev *dev, void *data)
1265{
1266 pci_power_t state = *(pci_power_t *)data;
1267
1268 dev->current_state = state;
1269 return 0;
1270}
1271
1272/**
Lukas Wunner2a4d2c42018-03-03 10:53:24 +01001273 * pci_bus_set_current_state - Walk given bus and set current state of devices
Huang Ying448bd852012-06-23 10:23:51 +08001274 * @bus: Top bus of the subtree to walk.
1275 * @state: state to be set
1276 */
Lukas Wunner2a4d2c42018-03-03 10:53:24 +01001277void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state)
Huang Ying448bd852012-06-23 10:23:51 +08001278{
1279 if (bus)
1280 pci_walk_bus(bus, __pci_dev_set_current_state, &state);
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001281}
1282
1283/**
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001284 * pci_set_power_state - Set the power state of a PCI device
1285 * @dev: PCI device to handle.
1286 * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
1287 *
Nick Andrew877d0312009-01-26 11:06:57 +01001288 * Transition a device to a new power state, using the platform firmware and/or
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001289 * the device's PCI PM registers.
1290 *
1291 * RETURN VALUE:
1292 * -EINVAL if the requested state is invalid.
1293 * -EIO if device does not support PCI PM or its PM capabilities register has a
1294 * wrong version, or device doesn't support the requested state.
Piotr Gregorab4b8a42017-08-02 20:42:18 +01001295 * 0 if the transition is to D1 or D2 but D1 and D2 are not supported.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001296 * 0 if device already is in the requested state.
Piotr Gregorab4b8a42017-08-02 20:42:18 +01001297 * 0 if the transition is to D3 but D3 is not supported.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001298 * 0 if device's power state has been successfully changed.
1299 */
1300int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1301{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001302 int error;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001303
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001304 /* Bound the state we're entering */
Huang Ying448bd852012-06-23 10:23:51 +08001305 if (state > PCI_D3cold)
1306 state = PCI_D3cold;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001307 else if (state < PCI_D0)
1308 state = PCI_D0;
1309 else if ((state == PCI_D1 || state == PCI_D2) && pci_no_d1d2(dev))
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001310
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001311 /*
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001312 * If the device or the parent bridge do not support PCI
1313 * PM, ignore the request if we're doing anything other
1314 * than putting it into D0 (which would only happen on
1315 * boot).
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001316 */
1317 return 0;
1318
Rafael J. Wysockidb288c92012-07-05 15:20:00 -06001319 /* Check if we're already there */
1320 if (dev->current_state == state)
1321 return 0;
1322
Rafael J. Wysockiadfac8f2019-11-05 11:27:49 +01001323 if (state == PCI_D0)
1324 return pci_power_up(dev);
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001325
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001326 /*
1327 * This device is quirked not to be put into D3, so don't put it in
1328 * D3
1329 */
Huang Ying448bd852012-06-23 10:23:51 +08001330 if (state >= PCI_D3hot && (dev->dev_flags & PCI_DEV_FLAGS_NO_D3))
Alan Cox979b1792008-07-24 17:18:38 +01001331 return 0;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001332
Huang Ying448bd852012-06-23 10:23:51 +08001333 /*
1334 * To put device in D3cold, we put device into D3hot in native
1335 * way, then put device into D3cold with platform ops
1336 */
1337 error = pci_raw_set_power_state(dev, state > PCI_D3hot ?
1338 PCI_D3hot : state);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001339
Rafael J. Wysocki9c77e632019-11-05 17:32:08 +01001340 if (pci_platform_power_transition(dev, state))
1341 return error;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001342
Rafael J. Wysocki9c77e632019-11-05 17:32:08 +01001343 /* Powering off a bridge may power off the whole hierarchy */
1344 if (state == PCI_D3cold)
1345 pci_bus_set_current_state(dev->subordinate, PCI_D3cold);
1346
1347 return 0;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001348}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001349EXPORT_SYMBOL(pci_set_power_state);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001350
1351/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 * pci_choose_state - Choose the power state of a PCI device
1353 * @dev: PCI device to be suspended
1354 * @state: target sleep state for the whole system. This is the value
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001355 * that is passed to suspend() function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 *
1357 * Returns PCI power state suitable for given device and given system
1358 * message.
1359 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state)
1361{
Shaohua Liab826ca2007-07-20 10:03:22 +08001362 pci_power_t ret;
David Shaohua Li0f644742005-03-19 00:15:48 -05001363
Yijing Wang728cdb72013-06-18 16:22:14 +08001364 if (!dev->pm_cap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 return PCI_D0;
1366
Rafael J. Wysocki961d9122008-07-07 03:32:02 +02001367 ret = platform_pci_choose_state(dev);
1368 if (ret != PCI_POWER_ERROR)
1369 return ret;
Pavel Machekca078ba2005-09-03 15:56:57 -07001370
1371 switch (state.event) {
1372 case PM_EVENT_ON:
1373 return PCI_D0;
1374 case PM_EVENT_FREEZE:
David Brownellb887d2e2006-08-14 23:11:05 -07001375 case PM_EVENT_PRETHAW:
1376 /* REVISIT both freeze and pre-thaw "should" use D0 */
Pavel Machekca078ba2005-09-03 15:56:57 -07001377 case PM_EVENT_SUSPEND:
Rafael J. Wysocki3a2d5b72008-02-23 19:13:25 +01001378 case PM_EVENT_HIBERNATE:
Pavel Machekca078ba2005-09-03 15:56:57 -07001379 return PCI_D3hot;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 default:
Frederick Lawler7506dc72018-01-18 12:55:24 -06001381 pci_info(dev, "unrecognized suspend event %d\n",
Bjorn Helgaas80ccba12008-06-13 10:52:11 -06001382 state.event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 BUG();
1384 }
1385 return PCI_D0;
1386}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387EXPORT_SYMBOL(pci_choose_state);
1388
Yu Zhao89858512009-02-16 02:55:47 +08001389#define PCI_EXP_SAVE_REGS 7
1390
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001391static struct pci_cap_saved_state *_pci_find_saved_cap(struct pci_dev *pci_dev,
1392 u16 cap, bool extended)
Yinghai Lu34a48762012-02-11 00:18:41 -08001393{
1394 struct pci_cap_saved_state *tmp;
Yinghai Lu34a48762012-02-11 00:18:41 -08001395
Sasha Levinb67bfe02013-02-27 17:06:00 -08001396 hlist_for_each_entry(tmp, &pci_dev->saved_cap_space, next) {
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001397 if (tmp->cap.cap_extended == extended && tmp->cap.cap_nr == cap)
Yinghai Lu34a48762012-02-11 00:18:41 -08001398 return tmp;
1399 }
1400 return NULL;
1401}
1402
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001403struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap)
1404{
1405 return _pci_find_saved_cap(dev, cap, false);
1406}
1407
1408struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev, u16 cap)
1409{
1410 return _pci_find_saved_cap(dev, cap, true);
1411}
1412
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001413static int pci_save_pcie_state(struct pci_dev *dev)
1414{
Jiang Liu59875ae2012-07-24 17:20:06 +08001415 int i = 0;
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001416 struct pci_cap_saved_state *save_state;
1417 u16 *cap;
1418
Jiang Liu59875ae2012-07-24 17:20:06 +08001419 if (!pci_is_pcie(dev))
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001420 return 0;
1421
Eric W. Biederman9f355752007-03-08 13:06:13 -07001422 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001423 if (!save_state) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001424 pci_err(dev, "buffer not found in %s\n", __func__);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001425 return -ENOMEM;
1426 }
Jiang Liu59875ae2012-07-24 17:20:06 +08001427
Alex Williamson24a4742f2011-05-10 10:02:11 -06001428 cap = (u16 *)&save_state->cap.data[0];
Jiang Liu59875ae2012-07-24 17:20:06 +08001429 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &cap[i++]);
1430 pcie_capability_read_word(dev, PCI_EXP_LNKCTL, &cap[i++]);
1431 pcie_capability_read_word(dev, PCI_EXP_SLTCTL, &cap[i++]);
1432 pcie_capability_read_word(dev, PCI_EXP_RTCTL, &cap[i++]);
1433 pcie_capability_read_word(dev, PCI_EXP_DEVCTL2, &cap[i++]);
1434 pcie_capability_read_word(dev, PCI_EXP_LNKCTL2, &cap[i++]);
1435 pcie_capability_read_word(dev, PCI_EXP_SLTCTL2, &cap[i++]);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001436
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001437 return 0;
1438}
1439
1440static void pci_restore_pcie_state(struct pci_dev *dev)
1441{
Jiang Liu59875ae2012-07-24 17:20:06 +08001442 int i = 0;
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001443 struct pci_cap_saved_state *save_state;
1444 u16 *cap;
1445
1446 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
Jiang Liu59875ae2012-07-24 17:20:06 +08001447 if (!save_state)
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001448 return;
Jiang Liu59875ae2012-07-24 17:20:06 +08001449
Alex Williamson24a4742f2011-05-10 10:02:11 -06001450 cap = (u16 *)&save_state->cap.data[0];
Jiang Liu59875ae2012-07-24 17:20:06 +08001451 pcie_capability_write_word(dev, PCI_EXP_DEVCTL, cap[i++]);
1452 pcie_capability_write_word(dev, PCI_EXP_LNKCTL, cap[i++]);
1453 pcie_capability_write_word(dev, PCI_EXP_SLTCTL, cap[i++]);
1454 pcie_capability_write_word(dev, PCI_EXP_RTCTL, cap[i++]);
1455 pcie_capability_write_word(dev, PCI_EXP_DEVCTL2, cap[i++]);
1456 pcie_capability_write_word(dev, PCI_EXP_LNKCTL2, cap[i++]);
1457 pcie_capability_write_word(dev, PCI_EXP_SLTCTL2, cap[i++]);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001458}
1459
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001460static int pci_save_pcix_state(struct pci_dev *dev)
1461{
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01001462 int pos;
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001463 struct pci_cap_saved_state *save_state;
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001464
1465 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
Wei Yang0a1a9b42015-06-30 09:16:44 +08001466 if (!pos)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001467 return 0;
1468
Shaohua Lif34303d2007-12-18 09:56:47 +08001469 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001470 if (!save_state) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001471 pci_err(dev, "buffer not found in %s\n", __func__);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001472 return -ENOMEM;
1473 }
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001474
Alex Williamson24a4742f2011-05-10 10:02:11 -06001475 pci_read_config_word(dev, pos + PCI_X_CMD,
1476 (u16 *)save_state->cap.data);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01001477
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001478 return 0;
1479}
1480
1481static void pci_restore_pcix_state(struct pci_dev *dev)
1482{
1483 int i = 0, pos;
1484 struct pci_cap_saved_state *save_state;
1485 u16 *cap;
1486
1487 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1488 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
Wei Yang0a1a9b42015-06-30 09:16:44 +08001489 if (!save_state || !pos)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001490 return;
Alex Williamson24a4742f2011-05-10 10:02:11 -06001491 cap = (u16 *)&save_state->cap.data[0];
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001492
1493 pci_write_config_word(dev, pos + PCI_X_CMD, cap[i++]);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001494}
1495
Bjorn Helgaasdbbfadf2019-01-09 08:22:08 -06001496static void pci_save_ltr_state(struct pci_dev *dev)
1497{
1498 int ltr;
1499 struct pci_cap_saved_state *save_state;
1500 u16 *cap;
1501
1502 if (!pci_is_pcie(dev))
1503 return;
1504
1505 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1506 if (!ltr)
1507 return;
1508
1509 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1510 if (!save_state) {
1511 pci_err(dev, "no suspend buffer for LTR; ASPM issues possible after resume\n");
1512 return;
1513 }
1514
1515 cap = (u16 *)&save_state->cap.data[0];
1516 pci_read_config_word(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, cap++);
1517 pci_read_config_word(dev, ltr + PCI_LTR_MAX_NOSNOOP_LAT, cap++);
1518}
1519
1520static void pci_restore_ltr_state(struct pci_dev *dev)
1521{
1522 struct pci_cap_saved_state *save_state;
1523 int ltr;
1524 u16 *cap;
1525
1526 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1527 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1528 if (!save_state || !ltr)
1529 return;
1530
1531 cap = (u16 *)&save_state->cap.data[0];
1532 pci_write_config_word(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, *cap++);
1533 pci_write_config_word(dev, ltr + PCI_LTR_MAX_NOSNOOP_LAT, *cap++);
1534}
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001535
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001537 * pci_save_state - save the PCI configuration space of a device before
1538 * suspending
1539 * @dev: PCI device that we're dealing with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001541int pci_save_state(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542{
1543 int i;
1544 /* XXX: 100% dword access ok here? */
Chen Yu47b802d2020-01-13 14:07:24 +08001545 for (i = 0; i < 16; i++) {
Kleber Sacilotto de Souza9e0b5b22009-11-25 00:55:51 -02001546 pci_read_config_dword(dev, i * 4, &dev->saved_config_space[i]);
Chen Yu47b802d2020-01-13 14:07:24 +08001547 pci_dbg(dev, "saving config space at offset %#x (reading %#x)\n",
1548 i * 4, dev->saved_config_space[i]);
1549 }
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +01001550 dev->state_saved = true;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001551
1552 i = pci_save_pcie_state(dev);
1553 if (i != 0)
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001554 return i;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001555
1556 i = pci_save_pcix_state(dev);
1557 if (i != 0)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001558 return i;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001559
Bjorn Helgaasdbbfadf2019-01-09 08:22:08 -06001560 pci_save_ltr_state(dev);
Vidya Sagar4257f7e2020-10-25 00:34:42 +05301561 pci_save_aspm_l1ss_state(dev);
Keith Busch4f802172018-09-20 10:27:08 -06001562 pci_save_dpc_state(dev);
Patel, Mayurkumaraf65d1a2019-10-18 16:52:21 +00001563 pci_save_aer_state(dev);
David E. Box39850ed2020-12-07 14:39:50 -08001564 pci_save_ptm_state(dev);
Quentin Lambert754834b2014-11-06 17:45:55 +01001565 return pci_save_vc_state(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001567EXPORT_SYMBOL(pci_save_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001569static void pci_restore_config_dword(struct pci_dev *pdev, int offset,
Daniel Drake08387452018-09-27 15:47:33 -05001570 u32 saved_val, int retry, bool force)
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001571{
1572 u32 val;
1573
1574 pci_read_config_dword(pdev, offset, &val);
Daniel Drake08387452018-09-27 15:47:33 -05001575 if (!force && val == saved_val)
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001576 return;
1577
1578 for (;;) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001579 pci_dbg(pdev, "restoring config space at offset %#x (was %#x, writing %#x)\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -04001580 offset, val, saved_val);
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001581 pci_write_config_dword(pdev, offset, saved_val);
1582 if (retry-- <= 0)
1583 return;
1584
1585 pci_read_config_dword(pdev, offset, &val);
1586 if (val == saved_val)
1587 return;
1588
1589 mdelay(1);
1590 }
1591}
1592
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001593static void pci_restore_config_space_range(struct pci_dev *pdev,
Daniel Drake08387452018-09-27 15:47:33 -05001594 int start, int end, int retry,
1595 bool force)
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001596{
1597 int index;
1598
1599 for (index = end; index >= start; index--)
1600 pci_restore_config_dword(pdev, 4 * index,
1601 pdev->saved_config_space[index],
Daniel Drake08387452018-09-27 15:47:33 -05001602 retry, force);
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001603}
1604
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001605static void pci_restore_config_space(struct pci_dev *pdev)
1606{
1607 if (pdev->hdr_type == PCI_HEADER_TYPE_NORMAL) {
Daniel Drake08387452018-09-27 15:47:33 -05001608 pci_restore_config_space_range(pdev, 10, 15, 0, false);
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001609 /* Restore BARs before the command register. */
Daniel Drake08387452018-09-27 15:47:33 -05001610 pci_restore_config_space_range(pdev, 4, 9, 10, false);
1611 pci_restore_config_space_range(pdev, 0, 3, 0, false);
1612 } else if (pdev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
1613 pci_restore_config_space_range(pdev, 12, 15, 0, false);
1614
1615 /*
1616 * Force rewriting of prefetch registers to avoid S3 resume
1617 * issues on Intel PCI bridges that occur when these
1618 * registers are not explicitly written.
1619 */
1620 pci_restore_config_space_range(pdev, 9, 11, 0, true);
1621 pci_restore_config_space_range(pdev, 0, 8, 0, false);
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001622 } else {
Daniel Drake08387452018-09-27 15:47:33 -05001623 pci_restore_config_space_range(pdev, 0, 15, 0, false);
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001624 }
1625}
1626
Christian Königd3252ac2018-06-29 19:54:55 -05001627static void pci_restore_rebar_state(struct pci_dev *pdev)
1628{
1629 unsigned int pos, nbars, i;
1630 u32 ctrl;
1631
1632 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
1633 if (!pos)
1634 return;
1635
1636 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1637 nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
1638 PCI_REBAR_CTRL_NBAR_SHIFT;
1639
1640 for (i = 0; i < nbars; i++, pos += 8) {
1641 struct resource *res;
1642 int bar_idx, size;
1643
1644 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1645 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
1646 res = pdev->resource + bar_idx;
Sumit Saxenad2182b22019-07-26 00:55:52 +05301647 size = ilog2(resource_size(res)) - 20;
Christian Königd3252ac2018-06-29 19:54:55 -05001648 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
Christian Königb1277a22018-06-29 19:55:03 -05001649 ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
Christian Königd3252ac2018-06-29 19:54:55 -05001650 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
1651 }
1652}
1653
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001654/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 * pci_restore_state - Restore the saved state of a PCI device
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001656 * @dev: PCI device that we're dealing with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 */
Jon Mason1d3c16a2010-11-30 17:43:26 -06001658void pci_restore_state(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659{
Alek Duc82f63e2009-08-08 08:46:19 +08001660 if (!dev->state_saved)
Jon Mason1d3c16a2010-11-30 17:43:26 -06001661 return;
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +02001662
Bjorn Helgaasdbbfadf2019-01-09 08:22:08 -06001663 /*
1664 * Restore max latencies (in the LTR capability) before enabling
1665 * LTR itself (in the PCIe capability).
1666 */
1667 pci_restore_ltr_state(dev);
Vidya Sagar4257f7e2020-10-25 00:34:42 +05301668 pci_restore_aspm_l1ss_state(dev);
Bjorn Helgaasdbbfadf2019-01-09 08:22:08 -06001669
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001670 pci_restore_pcie_state(dev);
CQ Tang4ebeb1e2017-05-30 09:25:49 -07001671 pci_restore_pasid_state(dev);
1672 pci_restore_pri_state(dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +08001673 pci_restore_ats_state(dev);
Alex Williamson425c1b22013-12-17 16:43:51 -07001674 pci_restore_vc_state(dev);
Christian Königd3252ac2018-06-29 19:54:55 -05001675 pci_restore_rebar_state(dev);
Keith Busch4f802172018-09-20 10:27:08 -06001676 pci_restore_dpc_state(dev);
David E. Box39850ed2020-12-07 14:39:50 -08001677 pci_restore_ptm_state(dev);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001678
Kuppuswamy Sathyanarayanan894020f2020-03-23 17:26:08 -07001679 pci_aer_clear_status(dev);
Patel, Mayurkumaraf65d1a2019-10-18 16:52:21 +00001680 pci_restore_aer_state(dev);
Taku Izumib07461a2015-09-17 10:09:37 -05001681
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001682 pci_restore_config_space(dev);
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001683
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001684 pci_restore_pcix_state(dev);
Shaohua Li41017f02006-02-08 17:11:38 +08001685 pci_restore_msi_state(dev);
Alexander Duyckccbc1752015-07-07 12:24:35 -07001686
1687 /* Restore ACS and IOV configuration state */
1688 pci_enable_acs(dev);
Yu Zhao8c5cdb62009-03-20 11:25:12 +08001689 pci_restore_iov_state(dev);
Michael Ellerman8fed4b62007-01-25 19:34:08 +11001690
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +02001691 dev->state_saved = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001693EXPORT_SYMBOL(pci_restore_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001695struct pci_saved_state {
1696 u32 config_space[16];
Gustavo A. R. Silva914a1952020-05-07 14:05:44 -05001697 struct pci_cap_saved_data cap[];
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001698};
1699
1700/**
1701 * pci_store_saved_state - Allocate and return an opaque struct containing
1702 * the device saved state.
1703 * @dev: PCI device that we're dealing with
1704 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001705 * Return NULL if no state or error.
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001706 */
1707struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev)
1708{
1709 struct pci_saved_state *state;
1710 struct pci_cap_saved_state *tmp;
1711 struct pci_cap_saved_data *cap;
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001712 size_t size;
1713
1714 if (!dev->state_saved)
1715 return NULL;
1716
1717 size = sizeof(*state) + sizeof(struct pci_cap_saved_data);
1718
Sasha Levinb67bfe02013-02-27 17:06:00 -08001719 hlist_for_each_entry(tmp, &dev->saved_cap_space, next)
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001720 size += sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1721
1722 state = kzalloc(size, GFP_KERNEL);
1723 if (!state)
1724 return NULL;
1725
1726 memcpy(state->config_space, dev->saved_config_space,
1727 sizeof(state->config_space));
1728
1729 cap = state->cap;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001730 hlist_for_each_entry(tmp, &dev->saved_cap_space, next) {
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001731 size_t len = sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1732 memcpy(cap, &tmp->cap, len);
1733 cap = (struct pci_cap_saved_data *)((u8 *)cap + len);
1734 }
1735 /* Empty cap_save terminates list */
1736
1737 return state;
1738}
1739EXPORT_SYMBOL_GPL(pci_store_saved_state);
1740
1741/**
1742 * pci_load_saved_state - Reload the provided save state into struct pci_dev.
1743 * @dev: PCI device that we're dealing with
1744 * @state: Saved state returned from pci_store_saved_state()
1745 */
Konrad Rzeszutek Wilk98d9b272014-12-03 16:40:31 -05001746int pci_load_saved_state(struct pci_dev *dev,
1747 struct pci_saved_state *state)
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001748{
1749 struct pci_cap_saved_data *cap;
1750
1751 dev->state_saved = false;
1752
1753 if (!state)
1754 return 0;
1755
1756 memcpy(dev->saved_config_space, state->config_space,
1757 sizeof(state->config_space));
1758
1759 cap = state->cap;
1760 while (cap->size) {
1761 struct pci_cap_saved_state *tmp;
1762
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001763 tmp = _pci_find_saved_cap(dev, cap->cap_nr, cap->cap_extended);
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001764 if (!tmp || tmp->cap.size != cap->size)
1765 return -EINVAL;
1766
1767 memcpy(tmp->cap.data, cap->data, tmp->cap.size);
1768 cap = (struct pci_cap_saved_data *)((u8 *)cap +
1769 sizeof(struct pci_cap_saved_data) + cap->size);
1770 }
1771
1772 dev->state_saved = true;
1773 return 0;
1774}
Konrad Rzeszutek Wilk98d9b272014-12-03 16:40:31 -05001775EXPORT_SYMBOL_GPL(pci_load_saved_state);
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001776
1777/**
1778 * pci_load_and_free_saved_state - Reload the save state pointed to by state,
1779 * and free the memory allocated for it.
1780 * @dev: PCI device that we're dealing with
1781 * @state: Pointer to saved state returned from pci_store_saved_state()
1782 */
1783int pci_load_and_free_saved_state(struct pci_dev *dev,
1784 struct pci_saved_state **state)
1785{
1786 int ret = pci_load_saved_state(dev, *state);
1787 kfree(*state);
1788 *state = NULL;
1789 return ret;
1790}
1791EXPORT_SYMBOL_GPL(pci_load_and_free_saved_state);
1792
Bjorn Helgaas8a9d5602014-02-26 11:26:00 -07001793int __weak pcibios_enable_device(struct pci_dev *dev, int bars)
1794{
1795 return pci_enable_resources(dev, bars);
1796}
1797
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001798static int do_pci_enable_device(struct pci_dev *dev, int bars)
1799{
1800 int err;
Vidya Sagar1f6ae472014-07-16 15:33:42 +05301801 struct pci_dev *bridge;
Bjorn Helgaas1e2571a2014-01-29 16:13:51 -07001802 u16 cmd;
1803 u8 pin;
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001804
1805 err = pci_set_power_state(dev, PCI_D0);
1806 if (err < 0 && err != -EIO)
1807 return err;
Vidya Sagar1f6ae472014-07-16 15:33:42 +05301808
1809 bridge = pci_upstream_bridge(dev);
1810 if (bridge)
1811 pcie_aspm_powersave_config_link(bridge);
1812
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001813 err = pcibios_enable_device(dev, bars);
1814 if (err < 0)
1815 return err;
1816 pci_fixup_device(pci_fixup_enable, dev);
1817
Bjorn Helgaas866d5412014-03-07 16:06:05 -07001818 if (dev->msi_enabled || dev->msix_enabled)
1819 return 0;
1820
Bjorn Helgaas1e2571a2014-01-29 16:13:51 -07001821 pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
1822 if (pin) {
1823 pci_read_config_word(dev, PCI_COMMAND, &cmd);
1824 if (cmd & PCI_COMMAND_INTX_DISABLE)
1825 pci_write_config_word(dev, PCI_COMMAND,
1826 cmd & ~PCI_COMMAND_INTX_DISABLE);
1827 }
1828
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001829 return 0;
1830}
1831
1832/**
Tejun Heo0b62e132007-07-27 14:43:35 +09001833 * pci_reenable_device - Resume abandoned device
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001834 * @dev: PCI device to be resumed
1835 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001836 * NOTE: This function is a backend of pci_default_resume() and is not supposed
1837 * to be called by normal code, write proper resume handler and use it instead.
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001838 */
Tejun Heo0b62e132007-07-27 14:43:35 +09001839int pci_reenable_device(struct pci_dev *dev)
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001840{
Yuji Shimada296ccb02009-04-03 16:41:46 +09001841 if (pci_is_enabled(dev))
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001842 return do_pci_enable_device(dev, (1 << PCI_NUM_RESOURCES) - 1);
1843 return 0;
1844}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001845EXPORT_SYMBOL(pci_reenable_device);
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001846
Yinghai Lu928bea92013-07-22 14:37:17 -07001847static void pci_enable_bridge(struct pci_dev *dev)
1848{
Bjorn Helgaas79272132013-11-06 10:00:51 -07001849 struct pci_dev *bridge;
Yinghai Lu928bea92013-07-22 14:37:17 -07001850 int retval;
1851
Bjorn Helgaas79272132013-11-06 10:00:51 -07001852 bridge = pci_upstream_bridge(dev);
1853 if (bridge)
1854 pci_enable_bridge(bridge);
Yinghai Lu928bea92013-07-22 14:37:17 -07001855
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001856 if (pci_is_enabled(dev)) {
Bjorn Helgaasfbeeb822013-11-05 13:34:51 -07001857 if (!dev->is_busmaster)
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001858 pci_set_master(dev);
Bjorn Helgaas0f50a492017-09-15 01:33:51 -05001859 return;
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001860 }
1861
Yinghai Lu928bea92013-07-22 14:37:17 -07001862 retval = pci_enable_device(dev);
1863 if (retval)
Frederick Lawler7506dc72018-01-18 12:55:24 -06001864 pci_err(dev, "Error enabling bridge (%d), continuing\n",
Yinghai Lu928bea92013-07-22 14:37:17 -07001865 retval);
1866 pci_set_master(dev);
1867}
1868
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001869static int pci_enable_device_flags(struct pci_dev *dev, unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
Bjorn Helgaas79272132013-11-06 10:00:51 -07001871 struct pci_dev *bridge;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 int err;
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001873 int i, bars = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
Jesse Barnes97c145f2010-11-05 15:16:36 -04001875 /*
1876 * Power state could be unknown at this point, either due to a fresh
1877 * boot or a device removal call. So get the current power state
1878 * so that things like MSI message writing will behave as expected
1879 * (e.g. if the device really is in D0 at enable time).
1880 */
1881 if (dev->pm_cap) {
1882 u16 pmcsr;
1883 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1884 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
1885 }
1886
Bjorn Helgaascc7ba392013-02-11 16:47:01 -07001887 if (atomic_inc_return(&dev->enable_cnt) > 1)
Hidetoshi Seto9fb625c2006-12-18 10:28:43 +09001888 return 0; /* already enabled */
1889
Bjorn Helgaas79272132013-11-06 10:00:51 -07001890 bridge = pci_upstream_bridge(dev);
Bjorn Helgaas0f50a492017-09-15 01:33:51 -05001891 if (bridge)
Bjorn Helgaas79272132013-11-06 10:00:51 -07001892 pci_enable_bridge(bridge);
Yinghai Lu928bea92013-07-22 14:37:17 -07001893
Yinghai Lu497f16f2011-12-17 18:33:37 -08001894 /* only skip sriov related */
1895 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1896 if (dev->resource[i].flags & flags)
1897 bars |= (1 << i);
1898 for (i = PCI_BRIDGE_RESOURCES; i < DEVICE_COUNT_RESOURCE; i++)
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001899 if (dev->resource[i].flags & flags)
1900 bars |= (1 << i);
1901
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001902 err = do_pci_enable_device(dev, bars);
Greg Kroah-Hartman95a62962005-07-28 11:37:33 -07001903 if (err < 0)
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001904 atomic_dec(&dev->enable_cnt);
Hidetoshi Seto9fb625c2006-12-18 10:28:43 +09001905 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906}
1907
1908/**
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001909 * pci_enable_device_io - Initialize a device for use with IO space
1910 * @dev: PCI device to be initialized
1911 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001912 * Initialize device before it's used by a driver. Ask low-level code
1913 * to enable I/O resources. Wake up the device if it was suspended.
1914 * Beware, this function can fail.
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001915 */
1916int pci_enable_device_io(struct pci_dev *dev)
1917{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001918 return pci_enable_device_flags(dev, IORESOURCE_IO);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001919}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001920EXPORT_SYMBOL(pci_enable_device_io);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001921
1922/**
1923 * pci_enable_device_mem - Initialize a device for use with Memory space
1924 * @dev: PCI device to be initialized
1925 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001926 * Initialize device before it's used by a driver. Ask low-level code
1927 * to enable Memory resources. Wake up the device if it was suspended.
1928 * Beware, this function can fail.
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001929 */
1930int pci_enable_device_mem(struct pci_dev *dev)
1931{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001932 return pci_enable_device_flags(dev, IORESOURCE_MEM);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001933}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001934EXPORT_SYMBOL(pci_enable_device_mem);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936/**
1937 * pci_enable_device - Initialize device before it's used by a driver.
1938 * @dev: PCI device to be initialized
1939 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001940 * Initialize device before it's used by a driver. Ask low-level code
1941 * to enable I/O and memory. Wake up the device if it was suspended.
1942 * Beware, this function can fail.
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001943 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001944 * Note we don't actually enable the device many times if we call
1945 * this function repeatedly (we just increment the count).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 */
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001947int pci_enable_device(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001949 return pci_enable_device_flags(dev, IORESOURCE_MEM | IORESOURCE_IO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001951EXPORT_SYMBOL(pci_enable_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
Tejun Heo9ac78492007-01-20 16:00:26 +09001953/*
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06001954 * Managed PCI resources. This manages device on/off, INTx/MSI/MSI-X
1955 * on/off and BAR regions. pci_dev itself records MSI/MSI-X status, so
Tejun Heo9ac78492007-01-20 16:00:26 +09001956 * there's no need to track it separately. pci_devres is initialized
1957 * when a device is enabled using managed PCI device enable interface.
1958 */
1959struct pci_devres {
Tejun Heo7f375f32007-02-25 04:36:01 -08001960 unsigned int enabled:1;
1961 unsigned int pinned:1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001962 unsigned int orig_intx:1;
1963 unsigned int restore_intx:1;
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01001964 unsigned int mwi:1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001965 u32 region_mask;
1966};
1967
1968static void pcim_release(struct device *gendev, void *res)
1969{
Geliang Tangf3d2f1652016-01-08 12:05:39 -06001970 struct pci_dev *dev = to_pci_dev(gendev);
Tejun Heo9ac78492007-01-20 16:00:26 +09001971 struct pci_devres *this = res;
1972 int i;
1973
1974 if (dev->msi_enabled)
1975 pci_disable_msi(dev);
1976 if (dev->msix_enabled)
1977 pci_disable_msix(dev);
1978
1979 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++)
1980 if (this->region_mask & (1 << i))
1981 pci_release_region(dev, i);
1982
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01001983 if (this->mwi)
1984 pci_clear_mwi(dev);
1985
Tejun Heo9ac78492007-01-20 16:00:26 +09001986 if (this->restore_intx)
1987 pci_intx(dev, this->orig_intx);
1988
Tejun Heo7f375f32007-02-25 04:36:01 -08001989 if (this->enabled && !this->pinned)
Tejun Heo9ac78492007-01-20 16:00:26 +09001990 pci_disable_device(dev);
1991}
1992
Ryan Desfosses07656d83082014-04-11 01:01:53 -04001993static struct pci_devres *get_pci_dr(struct pci_dev *pdev)
Tejun Heo9ac78492007-01-20 16:00:26 +09001994{
1995 struct pci_devres *dr, *new_dr;
1996
1997 dr = devres_find(&pdev->dev, pcim_release, NULL, NULL);
1998 if (dr)
1999 return dr;
2000
2001 new_dr = devres_alloc(pcim_release, sizeof(*new_dr), GFP_KERNEL);
2002 if (!new_dr)
2003 return NULL;
2004 return devres_get(&pdev->dev, new_dr, NULL, NULL);
2005}
2006
Ryan Desfosses07656d83082014-04-11 01:01:53 -04002007static struct pci_devres *find_pci_dr(struct pci_dev *pdev)
Tejun Heo9ac78492007-01-20 16:00:26 +09002008{
2009 if (pci_is_managed(pdev))
2010 return devres_find(&pdev->dev, pcim_release, NULL, NULL);
2011 return NULL;
2012}
2013
2014/**
2015 * pcim_enable_device - Managed pci_enable_device()
2016 * @pdev: PCI device to be initialized
2017 *
2018 * Managed pci_enable_device().
2019 */
2020int pcim_enable_device(struct pci_dev *pdev)
2021{
2022 struct pci_devres *dr;
2023 int rc;
2024
2025 dr = get_pci_dr(pdev);
2026 if (unlikely(!dr))
2027 return -ENOMEM;
Tejun Heob95d58e2008-01-30 18:20:04 +09002028 if (dr->enabled)
2029 return 0;
Tejun Heo9ac78492007-01-20 16:00:26 +09002030
2031 rc = pci_enable_device(pdev);
2032 if (!rc) {
2033 pdev->is_managed = 1;
Tejun Heo7f375f32007-02-25 04:36:01 -08002034 dr->enabled = 1;
Tejun Heo9ac78492007-01-20 16:00:26 +09002035 }
2036 return rc;
2037}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002038EXPORT_SYMBOL(pcim_enable_device);
Tejun Heo9ac78492007-01-20 16:00:26 +09002039
2040/**
2041 * pcim_pin_device - Pin managed PCI device
2042 * @pdev: PCI device to pin
2043 *
2044 * Pin managed PCI device @pdev. Pinned device won't be disabled on
2045 * driver detach. @pdev must have been enabled with
2046 * pcim_enable_device().
2047 */
2048void pcim_pin_device(struct pci_dev *pdev)
2049{
2050 struct pci_devres *dr;
2051
2052 dr = find_pci_dr(pdev);
Tejun Heo7f375f32007-02-25 04:36:01 -08002053 WARN_ON(!dr || !dr->enabled);
Tejun Heo9ac78492007-01-20 16:00:26 +09002054 if (dr)
Tejun Heo7f375f32007-02-25 04:36:01 -08002055 dr->pinned = 1;
Tejun Heo9ac78492007-01-20 16:00:26 +09002056}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002057EXPORT_SYMBOL(pcim_pin_device);
Tejun Heo9ac78492007-01-20 16:00:26 +09002058
Matthew Garretteca0d4672012-12-05 14:33:27 -07002059/*
2060 * pcibios_add_device - provide arch specific hooks when adding device dev
2061 * @dev: the PCI device being added
2062 *
2063 * Permits the platform to provide architecture specific functionality when
2064 * devices are added. This is the default implementation. Architecture
2065 * implementations can override this.
2066 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04002067int __weak pcibios_add_device(struct pci_dev *dev)
Matthew Garretteca0d4672012-12-05 14:33:27 -07002068{
2069 return 0;
2070}
2071
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06002073 * pcibios_release_device - provide arch specific hooks when releasing
2074 * device dev
Sebastian Ott6ae32c52013-06-04 19:18:14 +02002075 * @dev: the PCI device being released
2076 *
2077 * Permits the platform to provide architecture specific functionality when
2078 * devices are released. This is the default implementation. Architecture
2079 * implementations can override this.
2080 */
2081void __weak pcibios_release_device(struct pci_dev *dev) {}
2082
2083/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 * pcibios_disable_device - disable arch specific PCI resources for device dev
2085 * @dev: the PCI device to disable
2086 *
2087 * Disables architecture specific PCI resources for the device. This
2088 * is the default implementation. Architecture implementations can
2089 * override this.
2090 */
Bogicevic Sasaff3ce482015-12-27 13:21:11 -08002091void __weak pcibios_disable_device(struct pci_dev *dev) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Hanjun Guoa43ae582014-05-06 11:29:52 +08002093/**
2094 * pcibios_penalize_isa_irq - penalize an ISA IRQ
2095 * @irq: ISA IRQ to penalize
2096 * @active: IRQ active or not
2097 *
2098 * Permits the platform to provide architecture-specific functionality when
2099 * penalizing ISA IRQs. This is the default implementation. Architecture
2100 * implementations can override this.
2101 */
2102void __weak pcibios_penalize_isa_irq(int irq, int active) {}
2103
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01002104static void do_pci_disable_device(struct pci_dev *dev)
2105{
2106 u16 pci_command;
2107
2108 pci_read_config_word(dev, PCI_COMMAND, &pci_command);
2109 if (pci_command & PCI_COMMAND_MASTER) {
2110 pci_command &= ~PCI_COMMAND_MASTER;
2111 pci_write_config_word(dev, PCI_COMMAND, pci_command);
2112 }
2113
2114 pcibios_disable_device(dev);
2115}
2116
2117/**
2118 * pci_disable_enabled_device - Disable device without updating enable_cnt
2119 * @dev: PCI device to disable
2120 *
2121 * NOTE: This function is a backend of PCI power management routines and is
2122 * not supposed to be called drivers.
2123 */
2124void pci_disable_enabled_device(struct pci_dev *dev)
2125{
Yuji Shimada296ccb02009-04-03 16:41:46 +09002126 if (pci_is_enabled(dev))
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01002127 do_pci_disable_device(dev);
2128}
2129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130/**
2131 * pci_disable_device - Disable PCI device after use
2132 * @dev: PCI device to be disabled
2133 *
2134 * Signal to the system that the PCI device is not in use by the system
2135 * anymore. This only involves disabling PCI bus-mastering, if active.
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08002136 *
2137 * Note we don't actually disable the device until all callers of
Roman Fietzeee6583f2010-05-18 14:45:47 +02002138 * pci_enable_device() have called pci_disable_device().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04002140void pci_disable_device(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141{
Tejun Heo9ac78492007-01-20 16:00:26 +09002142 struct pci_devres *dr;
Shaohua Li99dc8042006-05-26 10:58:27 +08002143
Tejun Heo9ac78492007-01-20 16:00:26 +09002144 dr = find_pci_dr(dev);
2145 if (dr)
Tejun Heo7f375f32007-02-25 04:36:01 -08002146 dr->enabled = 0;
Tejun Heo9ac78492007-01-20 16:00:26 +09002147
Konstantin Khlebnikovfd6dcea2013-02-04 15:56:01 +04002148 dev_WARN_ONCE(&dev->dev, atomic_read(&dev->enable_cnt) <= 0,
2149 "disabling already-disabled device");
2150
Bjorn Helgaascc7ba392013-02-11 16:47:01 -07002151 if (atomic_dec_return(&dev->enable_cnt) != 0)
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08002152 return;
2153
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01002154 do_pci_disable_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01002156 dev->is_busmaster = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002158EXPORT_SYMBOL(pci_disable_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159
2160/**
Brian Kingf7bdd122007-04-06 16:39:36 -05002161 * pcibios_set_pcie_reset_state - set reset state for device dev
Stefan Assmann45e829e2009-12-03 06:49:24 -05002162 * @dev: the PCIe device reset
Brian Kingf7bdd122007-04-06 16:39:36 -05002163 * @state: Reset state to enter into
2164 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06002165 * Set the PCIe reset state for the device. This is the default
Brian Kingf7bdd122007-04-06 16:39:36 -05002166 * implementation. Architecture implementations can override this.
2167 */
Bjorn Helgaasd6d88c82012-06-19 06:54:49 -06002168int __weak pcibios_set_pcie_reset_state(struct pci_dev *dev,
2169 enum pcie_reset_state state)
Brian Kingf7bdd122007-04-06 16:39:36 -05002170{
2171 return -EINVAL;
2172}
2173
2174/**
2175 * pci_set_pcie_reset_state - set reset state for device dev
Stefan Assmann45e829e2009-12-03 06:49:24 -05002176 * @dev: the PCIe device reset
Brian Kingf7bdd122007-04-06 16:39:36 -05002177 * @state: Reset state to enter into
2178 *
Brian Kingf7bdd122007-04-06 16:39:36 -05002179 * Sets the PCI reset state for the device.
2180 */
2181int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state)
2182{
2183 return pcibios_set_pcie_reset_state(dev, state);
2184}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002185EXPORT_SYMBOL_GPL(pci_set_pcie_reset_state);
Brian Kingf7bdd122007-04-06 16:39:36 -05002186
Bjorn Helgaas600a5b42020-07-16 17:34:30 -05002187void pcie_clear_device_status(struct pci_dev *dev)
2188{
2189 u16 sta;
2190
2191 pcie_capability_read_word(dev, PCI_EXP_DEVSTA, &sta);
2192 pcie_capability_write_word(dev, PCI_EXP_DEVSTA, sta);
2193}
2194
Brian Kingf7bdd122007-04-06 16:39:36 -05002195/**
Bjorn Helgaasdcb04532018-03-09 11:06:53 -06002196 * pcie_clear_root_pme_status - Clear root port PME interrupt status.
2197 * @dev: PCIe root port or event collector.
2198 */
2199void pcie_clear_root_pme_status(struct pci_dev *dev)
2200{
2201 pcie_capability_set_dword(dev, PCI_EXP_RTSTA, PCI_EXP_RTSTA_PME);
2202}
2203
2204/**
Rafael J. Wysocki58ff4632010-02-17 23:36:58 +01002205 * pci_check_pme_status - Check if given device has generated PME.
2206 * @dev: Device to check.
2207 *
2208 * Check the PME status of the device and if set, clear it and clear PME enable
2209 * (if set). Return 'true' if PME status and PME enable were both set or
2210 * 'false' otherwise.
2211 */
2212bool pci_check_pme_status(struct pci_dev *dev)
2213{
2214 int pmcsr_pos;
2215 u16 pmcsr;
2216 bool ret = false;
2217
2218 if (!dev->pm_cap)
2219 return false;
2220
2221 pmcsr_pos = dev->pm_cap + PCI_PM_CTRL;
2222 pci_read_config_word(dev, pmcsr_pos, &pmcsr);
2223 if (!(pmcsr & PCI_PM_CTRL_PME_STATUS))
2224 return false;
2225
2226 /* Clear PME status. */
2227 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2228 if (pmcsr & PCI_PM_CTRL_PME_ENABLE) {
2229 /* Disable PME to avoid interrupt flood. */
2230 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2231 ret = true;
2232 }
2233
2234 pci_write_config_word(dev, pmcsr_pos, pmcsr);
2235
2236 return ret;
2237}
2238
2239/**
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002240 * pci_pme_wakeup - Wake up a PCI device if its PME Status bit is set.
2241 * @dev: Device to handle.
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002242 * @pme_poll_reset: Whether or not to reset the device's pme_poll flag.
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002243 *
2244 * Check if @dev has generated PME and queue a resume request for it in that
2245 * case.
2246 */
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002247static int pci_pme_wakeup(struct pci_dev *dev, void *pme_poll_reset)
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002248{
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002249 if (pme_poll_reset && dev->pme_poll)
2250 dev->pme_poll = false;
2251
Rafael J. Wysockic125e962010-07-05 22:43:53 +02002252 if (pci_check_pme_status(dev)) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +02002253 pci_wakeup_event(dev);
Rafael J. Wysocki0f953bf2010-12-29 13:22:08 +01002254 pm_request_resume(&dev->dev);
Rafael J. Wysockic125e962010-07-05 22:43:53 +02002255 }
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002256 return 0;
2257}
2258
2259/**
2260 * pci_pme_wakeup_bus - Walk given bus and wake up devices on it, if necessary.
2261 * @bus: Top bus of the subtree to walk.
2262 */
2263void pci_pme_wakeup_bus(struct pci_bus *bus)
2264{
2265 if (bus)
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002266 pci_walk_bus(bus, pci_pme_wakeup, (void *)true);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002267}
2268
Huang Ying448bd852012-06-23 10:23:51 +08002269
2270/**
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002271 * pci_pme_capable - check the capability of PCI device to generate PME#
2272 * @dev: PCI device to handle.
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002273 * @state: PCI state from which device will issue PME#.
2274 */
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002275bool pci_pme_capable(struct pci_dev *dev, pci_power_t state)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002276{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002277 if (!dev->pm_cap)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002278 return false;
2279
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002280 return !!(dev->pme_support & (1 << state));
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002281}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002282EXPORT_SYMBOL(pci_pme_capable);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002283
Matthew Garrettdf17e622010-10-04 14:22:29 -04002284static void pci_pme_list_scan(struct work_struct *work)
2285{
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002286 struct pci_pme_device *pme_dev, *n;
Matthew Garrettdf17e622010-10-04 14:22:29 -04002287
2288 mutex_lock(&pci_pme_list_mutex);
Bjorn Helgaasce300002014-01-24 09:51:06 -07002289 list_for_each_entry_safe(pme_dev, n, &pci_pme_list, list) {
2290 if (pme_dev->dev->pme_poll) {
2291 struct pci_dev *bridge;
Zheng Yan71a83bd2012-06-23 10:23:49 +08002292
Bjorn Helgaasce300002014-01-24 09:51:06 -07002293 bridge = pme_dev->dev->bus->self;
2294 /*
2295 * If bridge is in low power state, the
2296 * configuration space of subordinate devices
2297 * may be not accessible
2298 */
2299 if (bridge && bridge->current_state != PCI_D0)
2300 continue;
Mika Westerberg000dd532019-06-12 13:57:39 +03002301 /*
2302 * If the device is in D3cold it should not be
2303 * polled either.
2304 */
2305 if (pme_dev->dev->current_state == PCI_D3cold)
2306 continue;
2307
Bjorn Helgaasce300002014-01-24 09:51:06 -07002308 pci_pme_wakeup(pme_dev->dev, NULL);
2309 } else {
2310 list_del(&pme_dev->list);
2311 kfree(pme_dev);
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002312 }
Matthew Garrettdf17e622010-10-04 14:22:29 -04002313 }
Bjorn Helgaasce300002014-01-24 09:51:06 -07002314 if (!list_empty(&pci_pme_list))
Lukas Wunnerea003532017-04-18 20:44:30 +02002315 queue_delayed_work(system_freezable_wq, &pci_pme_work,
2316 msecs_to_jiffies(PME_TIMEOUT));
Matthew Garrettdf17e622010-10-04 14:22:29 -04002317 mutex_unlock(&pci_pme_list_mutex);
2318}
2319
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002320static void __pci_pme_active(struct pci_dev *dev, bool enable)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002321{
2322 u16 pmcsr;
2323
Rafael J. Wysockiffaddbe2013-04-10 10:32:51 +00002324 if (!dev->pme_support)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002325 return;
2326
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002327 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002328 /* Clear PME_Status by writing 1 to it and enable PME# */
2329 pmcsr |= PCI_PM_CTRL_PME_STATUS | PCI_PM_CTRL_PME_ENABLE;
2330 if (!enable)
2331 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2332
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002333 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002334}
2335
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002336/**
2337 * pci_pme_restore - Restore PME configuration after config space restore.
2338 * @dev: PCI device to update.
2339 */
2340void pci_pme_restore(struct pci_dev *dev)
Rafael J. Wysockidc15e712017-06-12 22:53:36 +02002341{
2342 u16 pmcsr;
2343
2344 if (!dev->pme_support)
2345 return;
2346
2347 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2348 if (dev->wakeup_prepared) {
2349 pmcsr |= PCI_PM_CTRL_PME_ENABLE;
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002350 pmcsr &= ~PCI_PM_CTRL_PME_STATUS;
Rafael J. Wysockidc15e712017-06-12 22:53:36 +02002351 } else {
2352 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2353 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2354 }
2355 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2356}
2357
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002358/**
2359 * pci_pme_active - enable or disable PCI device's PME# function
2360 * @dev: PCI device to handle.
2361 * @enable: 'true' to enable PME# generation; 'false' to disable it.
2362 *
2363 * The caller must verify that the device is capable of generating PME# before
2364 * calling this function with @enable equal to 'true'.
2365 */
2366void pci_pme_active(struct pci_dev *dev, bool enable)
2367{
2368 __pci_pme_active(dev, enable);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002369
Huang Ying6e965e02012-10-26 13:07:51 +08002370 /*
2371 * PCI (as opposed to PCIe) PME requires that the device have
2372 * its PME# line hooked up correctly. Not all hardware vendors
2373 * do this, so the PME never gets delivered and the device
2374 * remains asleep. The easiest way around this is to
2375 * periodically walk the list of suspended devices and check
2376 * whether any have their PME flag set. The assumption is that
2377 * we'll wake up often enough anyway that this won't be a huge
2378 * hit, and the power savings from the devices will still be a
2379 * win.
2380 *
2381 * Although PCIe uses in-band PME message instead of PME# line
2382 * to report PME, PME does not work for some PCIe devices in
2383 * reality. For example, there are devices that set their PME
2384 * status bits, but don't really bother to send a PME message;
2385 * there are PCI Express Root Ports that don't bother to
2386 * trigger interrupts when they receive PME messages from the
2387 * devices below. So PME poll is used for PCIe devices too.
2388 */
Matthew Garrettdf17e622010-10-04 14:22:29 -04002389
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002390 if (dev->pme_poll) {
Matthew Garrettdf17e622010-10-04 14:22:29 -04002391 struct pci_pme_device *pme_dev;
2392 if (enable) {
2393 pme_dev = kmalloc(sizeof(struct pci_pme_device),
2394 GFP_KERNEL);
Bjorn Helgaas0394cb12013-10-16 12:32:53 -06002395 if (!pme_dev) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002396 pci_warn(dev, "can't enable PME#\n");
Bjorn Helgaas0394cb12013-10-16 12:32:53 -06002397 return;
2398 }
Matthew Garrettdf17e622010-10-04 14:22:29 -04002399 pme_dev->dev = dev;
2400 mutex_lock(&pci_pme_list_mutex);
2401 list_add(&pme_dev->list, &pci_pme_list);
2402 if (list_is_singular(&pci_pme_list))
Lukas Wunnerea003532017-04-18 20:44:30 +02002403 queue_delayed_work(system_freezable_wq,
2404 &pci_pme_work,
2405 msecs_to_jiffies(PME_TIMEOUT));
Matthew Garrettdf17e622010-10-04 14:22:29 -04002406 mutex_unlock(&pci_pme_list_mutex);
2407 } else {
2408 mutex_lock(&pci_pme_list_mutex);
2409 list_for_each_entry(pme_dev, &pci_pme_list, list) {
2410 if (pme_dev->dev == dev) {
2411 list_del(&pme_dev->list);
2412 kfree(pme_dev);
2413 break;
2414 }
2415 }
2416 mutex_unlock(&pci_pme_list_mutex);
2417 }
2418 }
2419
Frederick Lawler7506dc72018-01-18 12:55:24 -06002420 pci_dbg(dev, "PME# %s\n", enable ? "enabled" : "disabled");
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002421}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002422EXPORT_SYMBOL(pci_pme_active);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002423
2424/**
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002425 * __pci_enable_wake - enable PCI device as wakeup event source
David Brownell075c1772007-04-26 00:12:06 -07002426 * @dev: PCI device affected
2427 * @state: PCI state from which device will issue wakeup events
2428 * @enable: True to enable event generation; false to disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 *
David Brownell075c1772007-04-26 00:12:06 -07002430 * This enables the device as a wakeup event source, or disables it.
2431 * When such events involves platform-specific hooks, those hooks are
2432 * called automatically by this routine.
2433 *
2434 * Devices with legacy power management (no standard PCI PM capabilities)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002435 * always require such platform hooks.
David Brownell075c1772007-04-26 00:12:06 -07002436 *
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002437 * RETURN VALUE:
2438 * 0 is returned on success
2439 * -EINVAL is returned if device is not supposed to wake up the system
2440 * Error code depending on the platform is returned if both the platform and
2441 * the native mechanism fail to enable the generation of wake-up events
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 */
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002443static int __pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444{
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002445 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002447 /*
Mika Westerbergac86e8e2018-09-27 16:53:53 -05002448 * Bridges that are not power-manageable directly only signal
2449 * wakeup on behalf of subordinate devices which is set up
2450 * elsewhere, so skip them. However, bridges that are
2451 * power-manageable may signal wakeup for themselves (for example,
2452 * on a hotplug event) and they need to be covered here.
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002453 */
Mika Westerbergac86e8e2018-09-27 16:53:53 -05002454 if (!pci_power_manageable(dev))
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002455 return 0;
2456
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002457 /* Don't do the same thing twice in a row for one device. */
2458 if (!!enable == !!dev->wakeup_prepared)
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002459 return 0;
2460
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002461 /*
2462 * According to "PCI System Architecture" 4th ed. by Tom Shanley & Don
2463 * Anderson we should be doing PME# wake enable followed by ACPI wake
2464 * enable. To disable wake-up we call the platform first, for symmetry.
David Brownell075c1772007-04-26 00:12:06 -07002465 */
2466
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002467 if (enable) {
2468 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002469
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002470 if (pci_pme_capable(dev, state))
2471 pci_pme_active(dev, true);
2472 else
2473 ret = 1;
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002474 error = platform_pci_set_wakeup(dev, true);
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002475 if (ret)
2476 ret = error;
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002477 if (!ret)
2478 dev->wakeup_prepared = true;
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002479 } else {
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002480 platform_pci_set_wakeup(dev, false);
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002481 pci_pme_active(dev, false);
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002482 dev->wakeup_prepared = false;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002483 }
2484
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002485 return ret;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002486}
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002487
2488/**
2489 * pci_enable_wake - change wakeup settings for a PCI device
2490 * @pci_dev: Target device
2491 * @state: PCI state from which device will issue wakeup events
2492 * @enable: Whether or not to enable event generation
2493 *
2494 * If @enable is set, check device_may_wakeup() for the device before calling
2495 * __pci_enable_wake() for it.
2496 */
2497int pci_enable_wake(struct pci_dev *pci_dev, pci_power_t state, bool enable)
2498{
2499 if (enable && !device_may_wakeup(&pci_dev->dev))
2500 return -EINVAL;
2501
2502 return __pci_enable_wake(pci_dev, state, enable);
2503}
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002504EXPORT_SYMBOL(pci_enable_wake);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002505
2506/**
Rafael J. Wysocki0235c4f2008-08-18 21:38:00 +02002507 * pci_wake_from_d3 - enable/disable device to wake up from D3_hot or D3_cold
2508 * @dev: PCI device to prepare
2509 * @enable: True to enable wake-up event generation; false to disable
2510 *
2511 * Many drivers want the device to wake up the system from D3_hot or D3_cold
2512 * and this function allows them to set that up cleanly - pci_enable_wake()
2513 * should not be called twice in a row to enable wake-up due to PCI PM vs ACPI
2514 * ordering constraints.
2515 *
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002516 * This function only returns error code if the device is not allowed to wake
2517 * up the system from sleep or it is not capable of generating PME# from both
2518 * D3_hot and D3_cold and the platform is unable to enable wake-up power for it.
Rafael J. Wysocki0235c4f2008-08-18 21:38:00 +02002519 */
2520int pci_wake_from_d3(struct pci_dev *dev, bool enable)
2521{
2522 return pci_pme_capable(dev, PCI_D3cold) ?
2523 pci_enable_wake(dev, PCI_D3cold, enable) :
2524 pci_enable_wake(dev, PCI_D3hot, enable);
2525}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002526EXPORT_SYMBOL(pci_wake_from_d3);
Rafael J. Wysocki0235c4f2008-08-18 21:38:00 +02002527
2528/**
Jesse Barnes37139072008-07-28 11:49:26 -07002529 * pci_target_state - find an appropriate low power state for a given PCI dev
2530 * @dev: PCI device
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002531 * @wakeup: Whether or not wakeup functionality will be enabled for the device.
Jesse Barnes37139072008-07-28 11:49:26 -07002532 *
2533 * Use underlying platform code to find a supported low power state for @dev.
2534 * If the platform can't manage @dev, return the deepest state from which it
2535 * can generate wake events, based on any available PME info.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002536 */
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002537static pci_power_t pci_target_state(struct pci_dev *dev, bool wakeup)
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002538{
2539 pci_power_t target_state = PCI_D3hot;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002540
2541 if (platform_pci_power_manageable(dev)) {
2542 /*
Rafael J. Wysocki60ee031a2018-05-21 13:11:12 +02002543 * Call the platform to find the target state for the device.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002544 */
2545 pci_power_t state = platform_pci_choose_state(dev);
2546
2547 switch (state) {
2548 case PCI_POWER_ERROR:
2549 case PCI_UNKNOWN:
2550 break;
2551 case PCI_D1:
2552 case PCI_D2:
2553 if (pci_no_d1d2(dev))
2554 break;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -05002555 fallthrough;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002556 default:
2557 target_state = state;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002558 }
Lukas Wunner4132a572016-09-18 05:39:20 +02002559
2560 return target_state;
2561 }
2562
2563 if (!dev->pm_cap)
Rafael J. Wysockid2abdf62009-06-14 21:25:02 +02002564 target_state = PCI_D0;
Lukas Wunner4132a572016-09-18 05:39:20 +02002565
2566 /*
2567 * If the device is in D3cold even though it's not power-manageable by
2568 * the platform, it may have been powered down by non-standard means.
2569 * Best to let it slumber.
2570 */
2571 if (dev->current_state == PCI_D3cold)
2572 target_state = PCI_D3cold;
2573
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002574 if (wakeup) {
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002575 /*
2576 * Find the deepest state from which the device can generate
Rafael J. Wysocki60ee031a2018-05-21 13:11:12 +02002577 * PME#.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002578 */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002579 if (dev->pme_support) {
2580 while (target_state
2581 && !(dev->pme_support & (1 << target_state)))
2582 target_state--;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002583 }
2584 }
2585
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002586 return target_state;
2587}
2588
2589/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06002590 * pci_prepare_to_sleep - prepare PCI device for system-wide transition
2591 * into a sleep state
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002592 * @dev: Device to handle.
2593 *
2594 * Choose the power state appropriate for the device depending on whether
2595 * it can wake up the system and/or is power manageable by the platform
2596 * (PCI_D3hot is the default) and put the device into that state.
2597 */
2598int pci_prepare_to_sleep(struct pci_dev *dev)
2599{
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002600 bool wakeup = device_may_wakeup(&dev->dev);
2601 pci_power_t target_state = pci_target_state(dev, wakeup);
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002602 int error;
2603
2604 if (target_state == PCI_POWER_ERROR)
2605 return -EIO;
2606
David E. Boxa697f072020-12-07 14:39:51 -08002607 /*
2608 * There are systems (for example, Intel mobile chips since Coffee
2609 * Lake) where the power drawn while suspended can be significantly
2610 * reduced by disabling PTM on PCIe root ports as this allows the
2611 * port to enter a lower-power PM state and the SoC to reach a
2612 * lower-power idle state as a whole.
2613 */
2614 if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2615 pci_disable_ptm(dev);
2616
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002617 pci_enable_wake(dev, target_state, wakeup);
Rafael J. Wysockic157dfa2008-07-13 22:45:06 +02002618
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002619 error = pci_set_power_state(dev, target_state);
2620
David E. Boxa697f072020-12-07 14:39:51 -08002621 if (error) {
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002622 pci_enable_wake(dev, target_state, false);
David E. Boxa697f072020-12-07 14:39:51 -08002623 pci_restore_ptm_state(dev);
2624 }
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002625
2626 return error;
2627}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002628EXPORT_SYMBOL(pci_prepare_to_sleep);
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002629
2630/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06002631 * pci_back_from_sleep - turn PCI device on during system-wide transition
2632 * into working state
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002633 * @dev: Device to handle.
2634 *
Thomas Weber88393162010-03-16 11:47:56 +01002635 * Disable device's system wake-up capability and put it into D0.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002636 */
2637int pci_back_from_sleep(struct pci_dev *dev)
2638{
2639 pci_enable_wake(dev, PCI_D0, false);
2640 return pci_set_power_state(dev, PCI_D0);
2641}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002642EXPORT_SYMBOL(pci_back_from_sleep);
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002643
2644/**
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002645 * pci_finish_runtime_suspend - Carry out PCI-specific part of runtime suspend.
2646 * @dev: PCI device being suspended.
2647 *
2648 * Prepare @dev to generate wake-up events at run time and put it into a low
2649 * power state.
2650 */
2651int pci_finish_runtime_suspend(struct pci_dev *dev)
2652{
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002653 pci_power_t target_state;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002654 int error;
2655
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002656 target_state = pci_target_state(dev, device_can_wakeup(&dev->dev));
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002657 if (target_state == PCI_POWER_ERROR)
2658 return -EIO;
2659
Huang Ying448bd852012-06-23 10:23:51 +08002660 dev->runtime_d3cold = target_state == PCI_D3cold;
2661
David E. Boxa697f072020-12-07 14:39:51 -08002662 /*
2663 * There are systems (for example, Intel mobile chips since Coffee
2664 * Lake) where the power drawn while suspended can be significantly
2665 * reduced by disabling PTM on PCIe root ports as this allows the
2666 * port to enter a lower-power PM state and the SoC to reach a
2667 * lower-power idle state as a whole.
2668 */
2669 if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2670 pci_disable_ptm(dev);
2671
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002672 __pci_enable_wake(dev, target_state, pci_dev_run_wake(dev));
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002673
2674 error = pci_set_power_state(dev, target_state);
2675
Huang Ying448bd852012-06-23 10:23:51 +08002676 if (error) {
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002677 pci_enable_wake(dev, target_state, false);
David E. Boxa697f072020-12-07 14:39:51 -08002678 pci_restore_ptm_state(dev);
Huang Ying448bd852012-06-23 10:23:51 +08002679 dev->runtime_d3cold = false;
2680 }
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002681
2682 return error;
2683}
2684
2685/**
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002686 * pci_dev_run_wake - Check if device can generate run-time wake-up events.
2687 * @dev: Device to check.
2688 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07002689 * Return true if the device itself is capable of generating wake-up events
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002690 * (through the platform or using the native PCIe PME) or if the device supports
2691 * PME and one of its upstream bridges can generate wake-up events.
2692 */
2693bool pci_dev_run_wake(struct pci_dev *dev)
2694{
2695 struct pci_bus *bus = dev->bus;
2696
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002697 if (!dev->pme_support)
2698 return false;
2699
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002700 /* PME-capable in principle, but not from the target power state */
Kai Heng Feng8feaec32018-05-07 14:11:20 +08002701 if (!pci_pme_capable(dev, pci_target_state(dev, true)))
Alan Stern6496ebd2016-10-21 16:45:38 -04002702 return false;
2703
Kai Heng Feng8feaec32018-05-07 14:11:20 +08002704 if (device_can_wakeup(&dev->dev))
2705 return true;
2706
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002707 while (bus->parent) {
2708 struct pci_dev *bridge = bus->self;
2709
Rafael J. Wysockide3ef1e2017-06-24 01:58:53 +02002710 if (device_can_wakeup(&bridge->dev))
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002711 return true;
2712
2713 bus = bus->parent;
2714 }
2715
2716 /* We have reached the root bus. */
2717 if (bus->bridge)
Rafael J. Wysockide3ef1e2017-06-24 01:58:53 +02002718 return device_can_wakeup(bus->bridge);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002719
2720 return false;
2721}
2722EXPORT_SYMBOL_GPL(pci_dev_run_wake);
2723
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002724/**
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002725 * pci_dev_need_resume - Check if it is necessary to resume the device.
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002726 * @pci_dev: Device to check.
2727 *
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002728 * Return 'true' if the device is not runtime-suspended or it has to be
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002729 * reconfigured due to wakeup settings difference between system and runtime
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002730 * suspend, or the current power state of it is not suitable for the upcoming
2731 * (system-wide) transition.
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002732 */
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002733bool pci_dev_need_resume(struct pci_dev *pci_dev)
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002734{
2735 struct device *dev = &pci_dev->dev;
Rafael J. Wysocki234f2232019-06-07 00:30:58 +02002736 pci_power_t target_state;
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002737
Rafael J. Wysocki234f2232019-06-07 00:30:58 +02002738 if (!pm_runtime_suspended(dev) || platform_pci_need_resume(pci_dev))
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002739 return true;
Rafael J. Wysocki234f2232019-06-07 00:30:58 +02002740
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002741 target_state = pci_target_state(pci_dev, device_may_wakeup(dev));
Rafael J. Wysocki234f2232019-06-07 00:30:58 +02002742
2743 /*
2744 * If the earlier platform check has not triggered, D3cold is just power
2745 * removal on top of D3hot, so no need to resume the device in that
2746 * case.
2747 */
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002748 return target_state != pci_dev->current_state &&
2749 target_state != PCI_D3cold &&
2750 pci_dev->current_state != PCI_D3hot;
2751}
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002752
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002753/**
2754 * pci_dev_adjust_pme - Adjust PME setting for a suspended device.
2755 * @pci_dev: Device to check.
2756 *
2757 * If the device is suspended and it is not configured for system wakeup,
2758 * disable PME for it to prevent it from waking up the system unnecessarily.
2759 *
2760 * Note that if the device's power state is D3cold and the platform check in
2761 * pci_dev_need_resume() has not triggered, the device's configuration need not
2762 * be changed.
2763 */
2764void pci_dev_adjust_pme(struct pci_dev *pci_dev)
2765{
2766 struct device *dev = &pci_dev->dev;
2767
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002768 spin_lock_irq(&dev->power.lock);
2769
Rafael J. Wysocki0c7376a2019-06-07 00:32:31 +02002770 if (pm_runtime_suspended(dev) && !device_may_wakeup(dev) &&
2771 pci_dev->current_state < PCI_D3cold)
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002772 __pci_pme_active(pci_dev, false);
2773
2774 spin_unlock_irq(&dev->power.lock);
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002775}
2776
2777/**
2778 * pci_dev_complete_resume - Finalize resume from system sleep for a device.
2779 * @pci_dev: Device to handle.
2780 *
2781 * If the device is runtime suspended and wakeup-capable, enable PME for it as
2782 * it might have been disabled during the prepare phase of system suspend if
2783 * the device was not configured for system wakeup.
2784 */
2785void pci_dev_complete_resume(struct pci_dev *pci_dev)
2786{
2787 struct device *dev = &pci_dev->dev;
2788
2789 if (!pci_dev_run_wake(pci_dev))
2790 return;
2791
2792 spin_lock_irq(&dev->power.lock);
2793
2794 if (pm_runtime_suspended(dev) && pci_dev->current_state < PCI_D3cold)
2795 __pci_pme_active(pci_dev, true);
2796
2797 spin_unlock_irq(&dev->power.lock);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002798}
2799
Huang Yingb3c32c42012-10-25 09:36:03 +08002800void pci_config_pm_runtime_get(struct pci_dev *pdev)
2801{
2802 struct device *dev = &pdev->dev;
2803 struct device *parent = dev->parent;
2804
2805 if (parent)
2806 pm_runtime_get_sync(parent);
2807 pm_runtime_get_noresume(dev);
2808 /*
2809 * pdev->current_state is set to PCI_D3cold during suspending,
2810 * so wait until suspending completes
2811 */
2812 pm_runtime_barrier(dev);
2813 /*
2814 * Only need to resume devices in D3cold, because config
2815 * registers are still accessible for devices suspended but
2816 * not in D3cold.
2817 */
2818 if (pdev->current_state == PCI_D3cold)
2819 pm_runtime_resume(dev);
2820}
2821
2822void pci_config_pm_runtime_put(struct pci_dev *pdev)
2823{
2824 struct device *dev = &pdev->dev;
2825 struct device *parent = dev->parent;
2826
2827 pm_runtime_put(dev);
2828 if (parent)
2829 pm_runtime_put_sync(parent);
2830}
2831
Mika Westerberg85b0cae2019-01-31 19:38:56 +03002832static const struct dmi_system_id bridge_d3_blacklist[] = {
2833#ifdef CONFIG_X86
2834 {
2835 /*
2836 * Gigabyte X299 root port is not marked as hotplug capable
2837 * which allows Linux to power manage it. However, this
2838 * confuses the BIOS SMI handler so don't power manage root
2839 * ports on that system.
2840 */
2841 .ident = "X299 DESIGNARE EX-CF",
2842 .matches = {
2843 DMI_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
2844 DMI_MATCH(DMI_BOARD_NAME, "X299 DESIGNARE EX-CF"),
2845 },
2846 },
2847#endif
2848 { }
2849};
2850
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002851/**
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002852 * pci_bridge_d3_possible - Is it possible to put the bridge into D3
2853 * @bridge: Bridge to check
2854 *
2855 * This function checks if it is possible to move the bridge to D3.
Lukas Wunner47a8e232018-07-19 17:28:00 -05002856 * Currently we only allow D3 for recent enough PCIe ports and Thunderbolt.
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002857 */
Lukas Wunnerc6a63302016-10-28 10:52:06 +02002858bool pci_bridge_d3_possible(struct pci_dev *bridge)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002859{
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002860 if (!pci_is_pcie(bridge))
2861 return false;
2862
2863 switch (pci_pcie_type(bridge)) {
2864 case PCI_EXP_TYPE_ROOT_PORT:
2865 case PCI_EXP_TYPE_UPSTREAM:
2866 case PCI_EXP_TYPE_DOWNSTREAM:
2867 if (pci_bridge_d3_disable)
2868 return false;
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002869
2870 /*
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002871 * Hotplug ports handled by firmware in System Management Mode
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002872 * may not be put into D3 by the OS (Thunderbolt on non-Macs).
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002873 */
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002874 if (bridge->is_hotplug_bridge && !pciehp_is_native(bridge))
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002875 return false;
2876
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002877 if (pci_bridge_d3_force)
2878 return true;
2879
Lukas Wunner47a8e232018-07-19 17:28:00 -05002880 /* Even the oldest 2010 Thunderbolt controller supports D3. */
2881 if (bridge->is_thunderbolt)
2882 return true;
2883
Mika Westerberg26ad34d2018-09-27 16:57:14 -05002884 /* Platform might know better if the bridge supports D3 */
2885 if (platform_pci_bridge_d3(bridge))
2886 return true;
2887
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002888 /*
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002889 * Hotplug ports handled natively by the OS were not validated
2890 * by vendors for runtime D3 at least until 2018 because there
2891 * was no OS support.
2892 */
2893 if (bridge->is_hotplug_bridge)
2894 return false;
2895
Mika Westerberg85b0cae2019-01-31 19:38:56 +03002896 if (dmi_check_system(bridge_d3_blacklist))
2897 return false;
2898
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002899 /*
2900 * It should be safe to put PCIe ports from 2015 or newer
2901 * to D3.
2902 */
Andy Shevchenkoac950902018-02-22 14:59:23 +02002903 if (dmi_get_bios_year() >= 2015)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002904 return true;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002905 break;
2906 }
2907
2908 return false;
2909}
2910
2911static int pci_dev_check_d3cold(struct pci_dev *dev, void *data)
2912{
2913 bool *d3cold_ok = data;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002914
Lukas Wunner718a0602016-10-28 10:52:06 +02002915 if (/* The device needs to be allowed to go D3cold ... */
2916 dev->no_d3cold || !dev->d3cold_allowed ||
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002917
Lukas Wunner718a0602016-10-28 10:52:06 +02002918 /* ... and if it is wakeup capable to do so from D3cold. */
2919 (device_may_wakeup(&dev->dev) &&
2920 !pci_pme_capable(dev, PCI_D3cold)) ||
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002921
Lukas Wunner718a0602016-10-28 10:52:06 +02002922 /* If it is a bridge it must be allowed to go to D3. */
Bjorn Helgaasd98e0922017-02-03 08:53:51 -06002923 !pci_power_manageable(dev))
Lukas Wunner718a0602016-10-28 10:52:06 +02002924
2925 *d3cold_ok = false;
2926
2927 return !*d3cold_ok;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002928}
2929
2930/*
2931 * pci_bridge_d3_update - Update bridge D3 capabilities
2932 * @dev: PCI device which is changed
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002933 *
2934 * Update upstream bridge PM capabilities accordingly depending on if the
2935 * device PM configuration was changed or the device is being removed. The
2936 * change is also propagated upstream.
2937 */
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002938void pci_bridge_d3_update(struct pci_dev *dev)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002939{
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002940 bool remove = !device_is_registered(&dev->dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002941 struct pci_dev *bridge;
2942 bool d3cold_ok = true;
2943
2944 bridge = pci_upstream_bridge(dev);
2945 if (!bridge || !pci_bridge_d3_possible(bridge))
2946 return;
2947
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002948 /*
Lukas Wunnere8559b712016-10-28 10:52:06 +02002949 * If D3 is currently allowed for the bridge, removing one of its
2950 * children won't change that.
2951 */
2952 if (remove && bridge->bridge_d3)
2953 return;
2954
2955 /*
2956 * If D3 is currently allowed for the bridge and a child is added or
2957 * changed, disallowance of D3 can only be caused by that child, so
2958 * we only need to check that single device, not any of its siblings.
2959 *
2960 * If D3 is currently not allowed for the bridge, checking the device
2961 * first may allow us to skip checking its siblings.
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002962 */
2963 if (!remove)
2964 pci_dev_check_d3cold(dev, &d3cold_ok);
2965
Lukas Wunnere8559b712016-10-28 10:52:06 +02002966 /*
2967 * If D3 is currently not allowed for the bridge, this may be caused
2968 * either by the device being changed/removed or any of its siblings,
2969 * so we need to go through all children to find out if one of them
2970 * continues to block D3.
2971 */
2972 if (d3cold_ok && !bridge->bridge_d3)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002973 pci_walk_bus(bridge->subordinate, pci_dev_check_d3cold,
2974 &d3cold_ok);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002975
2976 if (bridge->bridge_d3 != d3cold_ok) {
2977 bridge->bridge_d3 = d3cold_ok;
2978 /* Propagate change to upstream bridges */
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002979 pci_bridge_d3_update(bridge);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002980 }
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002981}
2982
2983/**
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002984 * pci_d3cold_enable - Enable D3cold for device
2985 * @dev: PCI device to handle
2986 *
2987 * This function can be used in drivers to enable D3cold from the device
2988 * they handle. It also updates upstream PCI bridge PM capabilities
2989 * accordingly.
2990 */
2991void pci_d3cold_enable(struct pci_dev *dev)
2992{
2993 if (dev->no_d3cold) {
2994 dev->no_d3cold = false;
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002995 pci_bridge_d3_update(dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002996 }
2997}
2998EXPORT_SYMBOL_GPL(pci_d3cold_enable);
2999
3000/**
3001 * pci_d3cold_disable - Disable D3cold for device
3002 * @dev: PCI device to handle
3003 *
3004 * This function can be used in drivers to disable D3cold from the device
3005 * they handle. It also updates upstream PCI bridge PM capabilities
3006 * accordingly.
3007 */
3008void pci_d3cold_disable(struct pci_dev *dev)
3009{
3010 if (!dev->no_d3cold) {
3011 dev->no_d3cold = true;
Lukas Wunner1ed276a2016-10-28 10:52:06 +02003012 pci_bridge_d3_update(dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03003013 }
3014}
3015EXPORT_SYMBOL_GPL(pci_d3cold_disable);
3016
3017/**
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003018 * pci_pm_init - Initialize PM functions of given PCI device
3019 * @dev: PCI device to handle.
3020 */
3021void pci_pm_init(struct pci_dev *dev)
3022{
3023 int pm;
Felipe Balbid6112f82018-09-07 09:16:51 +03003024 u16 status;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003025 u16 pmc;
David Brownell075c1772007-04-26 00:12:06 -07003026
Rafael J. Wysockibb910a72010-02-27 21:37:37 +01003027 pm_runtime_forbid(&dev->dev);
Huang Ying967577b2012-11-20 16:08:22 +08003028 pm_runtime_set_active(&dev->dev);
3029 pm_runtime_enable(&dev->dev);
Rafael J. Wysockia1e4d722010-02-08 19:16:33 +01003030 device_enable_async_suspend(&dev->dev);
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02003031 dev->wakeup_prepared = false;
Rafael J. Wysockibb910a72010-02-27 21:37:37 +01003032
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003033 dev->pm_cap = 0;
Rafael J. Wysockiffaddbe2013-04-10 10:32:51 +00003034 dev->pme_support = 0;
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003035
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036 /* find PCI PM capability in list */
3037 pm = pci_find_capability(dev, PCI_CAP_ID_PM);
David Brownell075c1772007-04-26 00:12:06 -07003038 if (!pm)
Linus Torvalds50246dd2009-01-16 08:14:51 -08003039 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040 /* Check device's ability to generate PME# */
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003041 pci_read_config_word(dev, pm + PCI_PM_PMC, &pmc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003043 if ((pmc & PCI_PM_CAP_VER_MASK) > 3) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003044 pci_err(dev, "unsupported PM cap regs version (%u)\n",
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003045 pmc & PCI_PM_CAP_VER_MASK);
Linus Torvalds50246dd2009-01-16 08:14:51 -08003046 return;
David Brownell075c1772007-04-26 00:12:06 -07003047 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003049 dev->pm_cap = pm;
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +00003050 dev->d3hot_delay = PCI_PM_D3HOT_WAIT;
Huang Ying448bd852012-06-23 10:23:51 +08003051 dev->d3cold_delay = PCI_PM_D3COLD_WAIT;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03003052 dev->bridge_d3 = pci_bridge_d3_possible(dev);
Huang Ying4f9c1392012-08-08 09:07:38 +08003053 dev->d3cold_allowed = true;
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003054
3055 dev->d1_support = false;
3056 dev->d2_support = false;
3057 if (!pci_no_d1d2(dev)) {
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06003058 if (pmc & PCI_PM_CAP_D1)
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003059 dev->d1_support = true;
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06003060 if (pmc & PCI_PM_CAP_D2)
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003061 dev->d2_support = true;
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06003062
3063 if (dev->d1_support || dev->d2_support)
Mohan Kumar34c6b712019-04-20 07:07:20 +03003064 pci_info(dev, "supports%s%s\n",
Jesse Barnesec84f122008-09-23 11:43:34 -07003065 dev->d1_support ? " D1" : "",
3066 dev->d2_support ? " D2" : "");
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003067 }
3068
3069 pmc &= PCI_PM_CAP_PME_MASK;
3070 if (pmc) {
Mohan Kumar34c6b712019-04-20 07:07:20 +03003071 pci_info(dev, "PME# supported from%s%s%s%s%s\n",
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06003072 (pmc & PCI_PM_CAP_PME_D0) ? " D0" : "",
3073 (pmc & PCI_PM_CAP_PME_D1) ? " D1" : "",
3074 (pmc & PCI_PM_CAP_PME_D2) ? " D2" : "",
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +00003075 (pmc & PCI_PM_CAP_PME_D3hot) ? " D3hot" : "",
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06003076 (pmc & PCI_PM_CAP_PME_D3cold) ? " D3cold" : "");
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003077 dev->pme_support = pmc >> PCI_PM_CAP_PME_SHIFT;
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02003078 dev->pme_poll = true;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003079 /*
3080 * Make device's PM flags reflect the wake-up capability, but
3081 * let the user space enable it to wake up the system as needed.
3082 */
3083 device_set_wakeup_capable(&dev->dev, true);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003084 /* Disable the PME# generation functionality */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02003085 pci_pme_active(dev, false);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02003086 }
Felipe Balbid6112f82018-09-07 09:16:51 +03003087
3088 pci_read_config_word(dev, PCI_STATUS, &status);
3089 if (status & PCI_STATUS_IMM_READY)
3090 dev->imm_ready = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091}
3092
Sean O. Stalley938174e2015-10-29 17:35:39 -05003093static unsigned long pci_ea_flags(struct pci_dev *dev, u8 prop)
3094{
Alex Williamson92efb1b2016-05-16 15:12:02 -05003095 unsigned long flags = IORESOURCE_PCI_FIXED | IORESOURCE_PCI_EA_BEI;
Sean O. Stalley938174e2015-10-29 17:35:39 -05003096
3097 switch (prop) {
3098 case PCI_EA_P_MEM:
3099 case PCI_EA_P_VF_MEM:
3100 flags |= IORESOURCE_MEM;
3101 break;
3102 case PCI_EA_P_MEM_PREFETCH:
3103 case PCI_EA_P_VF_MEM_PREFETCH:
3104 flags |= IORESOURCE_MEM | IORESOURCE_PREFETCH;
3105 break;
3106 case PCI_EA_P_IO:
3107 flags |= IORESOURCE_IO;
3108 break;
3109 default:
3110 return 0;
3111 }
3112
3113 return flags;
3114}
3115
3116static struct resource *pci_ea_get_resource(struct pci_dev *dev, u8 bei,
3117 u8 prop)
3118{
3119 if (bei <= PCI_EA_BEI_BAR5 && prop <= PCI_EA_P_IO)
3120 return &dev->resource[bei];
David Daney11183992015-10-29 17:35:40 -05003121#ifdef CONFIG_PCI_IOV
3122 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5 &&
3123 (prop == PCI_EA_P_VF_MEM || prop == PCI_EA_P_VF_MEM_PREFETCH))
3124 return &dev->resource[PCI_IOV_RESOURCES +
3125 bei - PCI_EA_BEI_VF_BAR0];
3126#endif
Sean O. Stalley938174e2015-10-29 17:35:39 -05003127 else if (bei == PCI_EA_BEI_ROM)
3128 return &dev->resource[PCI_ROM_RESOURCE];
3129 else
3130 return NULL;
3131}
3132
3133/* Read an Enhanced Allocation (EA) entry */
3134static int pci_ea_read(struct pci_dev *dev, int offset)
3135{
3136 struct resource *res;
3137 int ent_size, ent_offset = offset;
3138 resource_size_t start, end;
3139 unsigned long flags;
Bjorn Helgaas26635112015-10-29 17:35:40 -05003140 u32 dw0, bei, base, max_offset;
Sean O. Stalley938174e2015-10-29 17:35:39 -05003141 u8 prop;
3142 bool support_64 = (sizeof(resource_size_t) >= 8);
3143
3144 pci_read_config_dword(dev, ent_offset, &dw0);
3145 ent_offset += 4;
3146
3147 /* Entry size field indicates DWORDs after 1st */
3148 ent_size = ((dw0 & PCI_EA_ES) + 1) << 2;
3149
3150 if (!(dw0 & PCI_EA_ENABLE)) /* Entry not enabled */
3151 goto out;
3152
Bjorn Helgaas26635112015-10-29 17:35:40 -05003153 bei = (dw0 & PCI_EA_BEI) >> 4;
3154 prop = (dw0 & PCI_EA_PP) >> 8;
3155
Sean O. Stalley938174e2015-10-29 17:35:39 -05003156 /*
3157 * If the Property is in the reserved range, try the Secondary
3158 * Property instead.
3159 */
3160 if (prop > PCI_EA_P_BRIDGE_IO && prop < PCI_EA_P_MEM_RESERVED)
Bjorn Helgaas26635112015-10-29 17:35:40 -05003161 prop = (dw0 & PCI_EA_SP) >> 16;
Sean O. Stalley938174e2015-10-29 17:35:39 -05003162 if (prop > PCI_EA_P_BRIDGE_IO)
3163 goto out;
3164
Bjorn Helgaas26635112015-10-29 17:35:40 -05003165 res = pci_ea_get_resource(dev, bei, prop);
Sean O. Stalley938174e2015-10-29 17:35:39 -05003166 if (!res) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003167 pci_err(dev, "Unsupported EA entry BEI: %u\n", bei);
Sean O. Stalley938174e2015-10-29 17:35:39 -05003168 goto out;
3169 }
3170
3171 flags = pci_ea_flags(dev, prop);
3172 if (!flags) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003173 pci_err(dev, "Unsupported EA properties: %#x\n", prop);
Sean O. Stalley938174e2015-10-29 17:35:39 -05003174 goto out;
3175 }
3176
3177 /* Read Base */
3178 pci_read_config_dword(dev, ent_offset, &base);
3179 start = (base & PCI_EA_FIELD_MASK);
3180 ent_offset += 4;
3181
3182 /* Read MaxOffset */
3183 pci_read_config_dword(dev, ent_offset, &max_offset);
3184 ent_offset += 4;
3185
3186 /* Read Base MSBs (if 64-bit entry) */
3187 if (base & PCI_EA_IS_64) {
3188 u32 base_upper;
3189
3190 pci_read_config_dword(dev, ent_offset, &base_upper);
3191 ent_offset += 4;
3192
3193 flags |= IORESOURCE_MEM_64;
3194
3195 /* entry starts above 32-bit boundary, can't use */
3196 if (!support_64 && base_upper)
3197 goto out;
3198
3199 if (support_64)
3200 start |= ((u64)base_upper << 32);
3201 }
3202
3203 end = start + (max_offset | 0x03);
3204
3205 /* Read MaxOffset MSBs (if 64-bit entry) */
3206 if (max_offset & PCI_EA_IS_64) {
3207 u32 max_offset_upper;
3208
3209 pci_read_config_dword(dev, ent_offset, &max_offset_upper);
3210 ent_offset += 4;
3211
3212 flags |= IORESOURCE_MEM_64;
3213
3214 /* entry too big, can't use */
3215 if (!support_64 && max_offset_upper)
3216 goto out;
3217
3218 if (support_64)
3219 end += ((u64)max_offset_upper << 32);
3220 }
3221
3222 if (end < start) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003223 pci_err(dev, "EA Entry crosses address boundary\n");
Sean O. Stalley938174e2015-10-29 17:35:39 -05003224 goto out;
3225 }
3226
3227 if (ent_size != ent_offset - offset) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003228 pci_err(dev, "EA Entry Size (%d) does not match length read (%d)\n",
Sean O. Stalley938174e2015-10-29 17:35:39 -05003229 ent_size, ent_offset - offset);
3230 goto out;
3231 }
3232
3233 res->name = pci_name(dev);
3234 res->start = start;
3235 res->end = end;
3236 res->flags = flags;
Bjorn Helgaas597becb2015-10-29 17:35:40 -05003237
3238 if (bei <= PCI_EA_BEI_BAR5)
Mohan Kumar34c6b712019-04-20 07:07:20 +03003239 pci_info(dev, "BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05003240 bei, res, prop);
3241 else if (bei == PCI_EA_BEI_ROM)
Mohan Kumar34c6b712019-04-20 07:07:20 +03003242 pci_info(dev, "ROM: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05003243 res, prop);
3244 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5)
Mohan Kumar34c6b712019-04-20 07:07:20 +03003245 pci_info(dev, "VF BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05003246 bei - PCI_EA_BEI_VF_BAR0, res, prop);
3247 else
Mohan Kumar34c6b712019-04-20 07:07:20 +03003248 pci_info(dev, "BEI %d res: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05003249 bei, res, prop);
3250
Sean O. Stalley938174e2015-10-29 17:35:39 -05003251out:
3252 return offset + ent_size;
3253}
3254
Colin Ian Kingdcbb4082016-04-05 12:12:45 -05003255/* Enhanced Allocation Initialization */
Sean O. Stalley938174e2015-10-29 17:35:39 -05003256void pci_ea_init(struct pci_dev *dev)
3257{
3258 int ea;
3259 u8 num_ent;
3260 int offset;
3261 int i;
3262
3263 /* find PCI EA capability in list */
3264 ea = pci_find_capability(dev, PCI_CAP_ID_EA);
3265 if (!ea)
3266 return;
3267
3268 /* determine the number of entries */
3269 pci_bus_read_config_byte(dev->bus, dev->devfn, ea + PCI_EA_NUM_ENT,
3270 &num_ent);
3271 num_ent &= PCI_EA_NUM_ENT_MASK;
3272
3273 offset = ea + PCI_EA_FIRST_ENT;
3274
3275 /* Skip DWORD 2 for type 1 functions */
3276 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE)
3277 offset += 4;
3278
3279 /* parse each EA entry */
3280 for (i = 0; i < num_ent; ++i)
3281 offset = pci_ea_read(dev, offset);
3282}
3283
Yinghai Lu34a48762012-02-11 00:18:41 -08003284static void pci_add_saved_cap(struct pci_dev *pci_dev,
3285 struct pci_cap_saved_state *new_cap)
3286{
3287 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
3288}
3289
Jesse Barneseb9c39d2008-12-17 12:10:05 -08003290/**
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003291 * _pci_add_cap_save_buffer - allocate buffer for saving given
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003292 * capability registers
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003293 * @dev: the PCI device
3294 * @cap: the capability to allocate the buffer for
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003295 * @extended: Standard or Extended capability ID
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003296 * @size: requested size of the buffer
3297 */
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003298static int _pci_add_cap_save_buffer(struct pci_dev *dev, u16 cap,
3299 bool extended, unsigned int size)
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003300{
3301 int pos;
3302 struct pci_cap_saved_state *save_state;
3303
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003304 if (extended)
3305 pos = pci_find_ext_capability(dev, cap);
3306 else
3307 pos = pci_find_capability(dev, cap);
3308
Wei Yang0a1a9b42015-06-30 09:16:44 +08003309 if (!pos)
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003310 return 0;
3311
3312 save_state = kzalloc(sizeof(*save_state) + size, GFP_KERNEL);
3313 if (!save_state)
3314 return -ENOMEM;
3315
Alex Williamson24a4742f2011-05-10 10:02:11 -06003316 save_state->cap.cap_nr = cap;
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003317 save_state->cap.cap_extended = extended;
Alex Williamson24a4742f2011-05-10 10:02:11 -06003318 save_state->cap.size = size;
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003319 pci_add_saved_cap(dev, save_state);
3320
3321 return 0;
3322}
3323
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07003324int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size)
3325{
3326 return _pci_add_cap_save_buffer(dev, cap, false, size);
3327}
3328
3329int pci_add_ext_cap_save_buffer(struct pci_dev *dev, u16 cap, unsigned int size)
3330{
3331 return _pci_add_cap_save_buffer(dev, cap, true, size);
3332}
3333
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003334/**
3335 * pci_allocate_cap_save_buffers - allocate buffers for saving capabilities
3336 * @dev: the PCI device
3337 */
3338void pci_allocate_cap_save_buffers(struct pci_dev *dev)
3339{
3340 int error;
3341
Yu Zhao89858512009-02-16 02:55:47 +08003342 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_EXP,
3343 PCI_EXP_SAVE_REGS * sizeof(u16));
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003344 if (error)
Frederick Lawler7506dc72018-01-18 12:55:24 -06003345 pci_err(dev, "unable to preallocate PCI Express save buffer\n");
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003346
3347 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_PCIX, sizeof(u16));
3348 if (error)
Frederick Lawler7506dc72018-01-18 12:55:24 -06003349 pci_err(dev, "unable to preallocate PCI-X save buffer\n");
Alex Williamson425c1b22013-12-17 16:43:51 -07003350
Bjorn Helgaasdbbfadf2019-01-09 08:22:08 -06003351 error = pci_add_ext_cap_save_buffer(dev, PCI_EXT_CAP_ID_LTR,
3352 2 * sizeof(u16));
3353 if (error)
3354 pci_err(dev, "unable to allocate suspend buffer for LTR\n");
3355
Vidya Sagar4257f7e2020-10-25 00:34:42 +05303356 error = pci_add_ext_cap_save_buffer(dev, PCI_EXT_CAP_ID_L1SS,
3357 2 * sizeof(u32));
3358 if (error)
3359 pci_err(dev, "unable to allocate suspend buffer for ASPM-L1SS\n");
3360
Alex Williamson425c1b22013-12-17 16:43:51 -07003361 pci_allocate_vc_save_buffers(dev);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003362}
3363
Yinghai Luf7968412012-02-11 00:18:30 -08003364void pci_free_cap_save_buffers(struct pci_dev *dev)
3365{
3366 struct pci_cap_saved_state *tmp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08003367 struct hlist_node *n;
Yinghai Luf7968412012-02-11 00:18:30 -08003368
Sasha Levinb67bfe02013-02-27 17:06:00 -08003369 hlist_for_each_entry_safe(tmp, n, &dev->saved_cap_space, next)
Yinghai Luf7968412012-02-11 00:18:30 -08003370 kfree(tmp);
3371}
3372
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01003373/**
Yijing Wang31ab2472013-01-15 11:12:17 +08003374 * pci_configure_ari - enable or disable ARI forwarding
Yu Zhao58c3a722008-10-14 14:02:53 +08003375 * @dev: the PCI device
Yijing Wangb0cc6022013-01-15 11:12:16 +08003376 *
3377 * If @dev and its upstream bridge both support ARI, enable ARI in the
3378 * bridge. Otherwise, disable ARI in the bridge.
Yu Zhao58c3a722008-10-14 14:02:53 +08003379 */
Yijing Wang31ab2472013-01-15 11:12:17 +08003380void pci_configure_ari(struct pci_dev *dev)
Yu Zhao58c3a722008-10-14 14:02:53 +08003381{
Yu Zhao58c3a722008-10-14 14:02:53 +08003382 u32 cap;
Zhao, Yu81135872008-10-23 13:15:39 +08003383 struct pci_dev *bridge;
Yu Zhao58c3a722008-10-14 14:02:53 +08003384
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +01003385 if (pcie_ari_disabled || !pci_is_pcie(dev) || dev->devfn)
Yu Zhao58c3a722008-10-14 14:02:53 +08003386 return;
3387
Zhao, Yu81135872008-10-23 13:15:39 +08003388 bridge = dev->bus->self;
Myron Stowecb97ae32012-06-01 15:16:31 -06003389 if (!bridge)
Zhao, Yu81135872008-10-23 13:15:39 +08003390 return;
3391
Jiang Liu59875ae2012-07-24 17:20:06 +08003392 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
Yu Zhao58c3a722008-10-14 14:02:53 +08003393 if (!(cap & PCI_EXP_DEVCAP2_ARI))
3394 return;
3395
Yijing Wangb0cc6022013-01-15 11:12:16 +08003396 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ARI)) {
3397 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
3398 PCI_EXP_DEVCTL2_ARI);
3399 bridge->ari_enabled = 1;
3400 } else {
3401 pcie_capability_clear_word(bridge, PCI_EXP_DEVCTL2,
3402 PCI_EXP_DEVCTL2_ARI);
3403 bridge->ari_enabled = 0;
3404 }
Yu Zhao58c3a722008-10-14 14:02:53 +08003405}
3406
Alex Williamson0a671192013-06-27 16:39:48 -06003407static bool pci_acs_flags_enabled(struct pci_dev *pdev, u16 acs_flags)
3408{
3409 int pos;
Alex Williamson83db7e02013-06-27 16:39:54 -06003410 u16 cap, ctrl;
Alex Williamson0a671192013-06-27 16:39:48 -06003411
Rajat Jain52fbf5b2020-07-07 15:46:02 -07003412 pos = pdev->acs_cap;
Alex Williamson0a671192013-06-27 16:39:48 -06003413 if (!pos)
3414 return false;
3415
Alex Williamson83db7e02013-06-27 16:39:54 -06003416 /*
3417 * Except for egress control, capabilities are either required
3418 * or only required if controllable. Features missing from the
3419 * capability field can therefore be assumed as hard-wired enabled.
3420 */
3421 pci_read_config_word(pdev, pos + PCI_ACS_CAP, &cap);
3422 acs_flags &= (cap | PCI_ACS_EC);
3423
Alex Williamson0a671192013-06-27 16:39:48 -06003424 pci_read_config_word(pdev, pos + PCI_ACS_CTRL, &ctrl);
3425 return (ctrl & acs_flags) == acs_flags;
3426}
3427
Allen Kayae21ee62009-10-07 10:27:17 -07003428/**
Alex Williamsonad805752012-06-11 05:27:07 +00003429 * pci_acs_enabled - test ACS against required flags for a given device
3430 * @pdev: device to test
3431 * @acs_flags: required PCI ACS flags
3432 *
3433 * Return true if the device supports the provided flags. Automatically
3434 * filters out flags that are not implemented on multifunction devices.
Alex Williamson0a671192013-06-27 16:39:48 -06003435 *
3436 * Note that this interface checks the effective ACS capabilities of the
3437 * device rather than the actual capabilities. For instance, most single
3438 * function endpoints are not required to support ACS because they have no
3439 * opportunity for peer-to-peer access. We therefore return 'true'
3440 * regardless of whether the device exposes an ACS capability. This makes
3441 * it much easier for callers of this function to ignore the actual type
3442 * or topology of the device when testing ACS support.
Alex Williamsonad805752012-06-11 05:27:07 +00003443 */
3444bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
3445{
Alex Williamson0a671192013-06-27 16:39:48 -06003446 int ret;
Alex Williamsonad805752012-06-11 05:27:07 +00003447
3448 ret = pci_dev_specific_acs_enabled(pdev, acs_flags);
3449 if (ret >= 0)
3450 return ret > 0;
3451
Alex Williamson0a671192013-06-27 16:39:48 -06003452 /*
3453 * Conventional PCI and PCI-X devices never support ACS, either
3454 * effectively or actually. The shared bus topology implies that
3455 * any device on the bus can receive or snoop DMA.
3456 */
Alex Williamsonad805752012-06-11 05:27:07 +00003457 if (!pci_is_pcie(pdev))
3458 return false;
3459
Alex Williamson0a671192013-06-27 16:39:48 -06003460 switch (pci_pcie_type(pdev)) {
3461 /*
3462 * PCI/X-to-PCIe bridges are not specifically mentioned by the spec,
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003463 * but since their primary interface is PCI/X, we conservatively
Alex Williamson0a671192013-06-27 16:39:48 -06003464 * handle them as we would a non-PCIe device.
3465 */
3466 case PCI_EXP_TYPE_PCIE_BRIDGE:
3467 /*
3468 * PCIe 3.0, 6.12.1 excludes ACS on these devices. "ACS is never
3469 * applicable... must never implement an ACS Extended Capability...".
3470 * This seems arbitrary, but we take a conservative interpretation
3471 * of this statement.
3472 */
3473 case PCI_EXP_TYPE_PCI_BRIDGE:
3474 case PCI_EXP_TYPE_RC_EC:
3475 return false;
3476 /*
3477 * PCIe 3.0, 6.12.1.1 specifies that downstream and root ports should
3478 * implement ACS in order to indicate their peer-to-peer capabilities,
3479 * regardless of whether they are single- or multi-function devices.
3480 */
3481 case PCI_EXP_TYPE_DOWNSTREAM:
3482 case PCI_EXP_TYPE_ROOT_PORT:
3483 return pci_acs_flags_enabled(pdev, acs_flags);
3484 /*
3485 * PCIe 3.0, 6.12.1.2 specifies ACS capabilities that should be
3486 * implemented by the remaining PCIe types to indicate peer-to-peer
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003487 * capabilities, but only when they are part of a multifunction
Alex Williamson0a671192013-06-27 16:39:48 -06003488 * device. The footnote for section 6.12 indicates the specific
3489 * PCIe types included here.
3490 */
3491 case PCI_EXP_TYPE_ENDPOINT:
3492 case PCI_EXP_TYPE_UPSTREAM:
3493 case PCI_EXP_TYPE_LEG_END:
3494 case PCI_EXP_TYPE_RC_END:
3495 if (!pdev->multifunction)
3496 break;
3497
Alex Williamson0a671192013-06-27 16:39:48 -06003498 return pci_acs_flags_enabled(pdev, acs_flags);
Alex Williamsonad805752012-06-11 05:27:07 +00003499 }
3500
Alex Williamson0a671192013-06-27 16:39:48 -06003501 /*
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003502 * PCIe 3.0, 6.12.1.3 specifies no ACS capabilities are applicable
Alex Williamson0a671192013-06-27 16:39:48 -06003503 * to single function devices with the exception of downstream ports.
3504 */
Alex Williamsonad805752012-06-11 05:27:07 +00003505 return true;
3506}
3507
3508/**
Mauro Carvalho Chehab2f0cd592020-10-23 18:33:10 +02003509 * pci_acs_path_enabled - test ACS flags from start to end in a hierarchy
Alex Williamsonad805752012-06-11 05:27:07 +00003510 * @start: starting downstream device
3511 * @end: ending upstream device or NULL to search to the root bus
3512 * @acs_flags: required flags
3513 *
3514 * Walk up a device tree from start to end testing PCI ACS support. If
3515 * any step along the way does not support the required flags, return false.
3516 */
3517bool pci_acs_path_enabled(struct pci_dev *start,
3518 struct pci_dev *end, u16 acs_flags)
3519{
3520 struct pci_dev *pdev, *parent = start;
3521
3522 do {
3523 pdev = parent;
3524
3525 if (!pci_acs_enabled(pdev, acs_flags))
3526 return false;
3527
3528 if (pci_is_root_bus(pdev->bus))
3529 return (end == NULL);
3530
3531 parent = pdev->bus->self;
3532 } while (pdev != end);
3533
3534 return true;
3535}
3536
3537/**
Rajat Jain52fbf5b2020-07-07 15:46:02 -07003538 * pci_acs_init - Initialize ACS if hardware supports it
3539 * @dev: the PCI device
3540 */
3541void pci_acs_init(struct pci_dev *dev)
3542{
3543 dev->acs_cap = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3544
Rajat Jain462b58f2020-10-28 16:15:45 -07003545 /*
3546 * Attempt to enable ACS regardless of capability because some Root
3547 * Ports (e.g. those quirked with *_intel_pch_acs_*) do not have
3548 * the standard ACS capability but still support ACS via those
3549 * quirks.
3550 */
3551 pci_enable_acs(dev);
Rajat Jain52fbf5b2020-07-07 15:46:02 -07003552}
3553
3554/**
Christian König276b7382017-10-24 14:40:20 -05003555 * pci_rebar_find_pos - find position of resize ctrl reg for BAR
3556 * @pdev: PCI device
3557 * @bar: BAR to find
3558 *
3559 * Helper to find the position of the ctrl register for a BAR.
3560 * Returns -ENOTSUPP if resizable BARs are not supported at all.
3561 * Returns -ENOENT if no ctrl register for the BAR could be found.
3562 */
3563static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
3564{
3565 unsigned int pos, nbars, i;
3566 u32 ctrl;
3567
3568 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
3569 if (!pos)
3570 return -ENOTSUPP;
3571
3572 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3573 nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
3574 PCI_REBAR_CTRL_NBAR_SHIFT;
3575
3576 for (i = 0; i < nbars; i++, pos += 8) {
3577 int bar_idx;
3578
3579 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3580 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
3581 if (bar_idx == bar)
3582 return pos;
3583 }
3584
3585 return -ENOENT;
3586}
3587
3588/**
3589 * pci_rebar_get_possible_sizes - get possible sizes for BAR
3590 * @pdev: PCI device
3591 * @bar: BAR to query
3592 *
3593 * Get the possible sizes of a resizable BAR as bitmask defined in the spec
3594 * (bit 0=1MB, bit 19=512GB). Returns 0 if BAR isn't resizable.
3595 */
3596u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
3597{
3598 int pos;
3599 u32 cap;
3600
3601 pos = pci_rebar_find_pos(pdev, bar);
3602 if (pos < 0)
3603 return 0;
3604
3605 pci_read_config_dword(pdev, pos + PCI_REBAR_CAP, &cap);
3606 return (cap & PCI_REBAR_CAP_SIZES) >> 4;
3607}
3608
3609/**
3610 * pci_rebar_get_current_size - get the current size of a BAR
3611 * @pdev: PCI device
3612 * @bar: BAR to set size to
3613 *
3614 * Read the size of a BAR from the resizable BAR config.
3615 * Returns size if found or negative error code.
3616 */
3617int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
3618{
3619 int pos;
3620 u32 ctrl;
3621
3622 pos = pci_rebar_find_pos(pdev, bar);
3623 if (pos < 0)
3624 return pos;
3625
3626 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
Christian Königb1277a22018-06-29 19:55:03 -05003627 return (ctrl & PCI_REBAR_CTRL_BAR_SIZE) >> PCI_REBAR_CTRL_BAR_SHIFT;
Christian König276b7382017-10-24 14:40:20 -05003628}
3629
3630/**
3631 * pci_rebar_set_size - set a new size for a BAR
3632 * @pdev: PCI device
3633 * @bar: BAR to set size to
3634 * @size: new size as defined in the spec (0=1MB, 19=512GB)
3635 *
3636 * Set the new size of a BAR as defined in the spec.
3637 * Returns zero if resizing was successful, error code otherwise.
3638 */
3639int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size)
3640{
3641 int pos;
3642 u32 ctrl;
3643
3644 pos = pci_rebar_find_pos(pdev, bar);
3645 if (pos < 0)
3646 return pos;
3647
3648 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3649 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
Christian Königb1277a22018-06-29 19:55:03 -05003650 ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
Christian König276b7382017-10-24 14:40:20 -05003651 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
3652 return 0;
3653}
3654
3655/**
Jay Cornwall430a2362018-01-04 19:44:59 -05003656 * pci_enable_atomic_ops_to_root - enable AtomicOp requests to root port
3657 * @dev: the PCI device
3658 * @cap_mask: mask of desired AtomicOp sizes, including one or more of:
3659 * PCI_EXP_DEVCAP2_ATOMIC_COMP32
3660 * PCI_EXP_DEVCAP2_ATOMIC_COMP64
3661 * PCI_EXP_DEVCAP2_ATOMIC_COMP128
3662 *
3663 * Return 0 if all upstream bridges support AtomicOp routing, egress
3664 * blocking is disabled on all upstream ports, and the root port supports
3665 * the requested completion capabilities (32-bit, 64-bit and/or 128-bit
3666 * AtomicOp completion), or negative otherwise.
3667 */
3668int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask)
3669{
3670 struct pci_bus *bus = dev->bus;
3671 struct pci_dev *bridge;
3672 u32 cap, ctl2;
3673
3674 if (!pci_is_pcie(dev))
3675 return -EINVAL;
3676
3677 /*
3678 * Per PCIe r4.0, sec 6.15, endpoints and root ports may be
3679 * AtomicOp requesters. For now, we only support endpoints as
3680 * requesters and root ports as completers. No endpoints as
3681 * completers, and no peer-to-peer.
3682 */
3683
3684 switch (pci_pcie_type(dev)) {
3685 case PCI_EXP_TYPE_ENDPOINT:
3686 case PCI_EXP_TYPE_LEG_END:
3687 case PCI_EXP_TYPE_RC_END:
3688 break;
3689 default:
3690 return -EINVAL;
3691 }
3692
3693 while (bus->parent) {
3694 bridge = bus->self;
3695
3696 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3697
3698 switch (pci_pcie_type(bridge)) {
3699 /* Ensure switch ports support AtomicOp routing */
3700 case PCI_EXP_TYPE_UPSTREAM:
3701 case PCI_EXP_TYPE_DOWNSTREAM:
3702 if (!(cap & PCI_EXP_DEVCAP2_ATOMIC_ROUTE))
3703 return -EINVAL;
3704 break;
3705
3706 /* Ensure root port supports all the sizes we care about */
3707 case PCI_EXP_TYPE_ROOT_PORT:
3708 if ((cap & cap_mask) != cap_mask)
3709 return -EINVAL;
3710 break;
3711 }
3712
3713 /* Ensure upstream ports don't block AtomicOps on egress */
Mika Westerbergca784102019-08-22 11:55:53 +03003714 if (pci_pcie_type(bridge) == PCI_EXP_TYPE_UPSTREAM) {
Jay Cornwall430a2362018-01-04 19:44:59 -05003715 pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2,
3716 &ctl2);
3717 if (ctl2 & PCI_EXP_DEVCTL2_ATOMIC_EGRESS_BLOCK)
3718 return -EINVAL;
3719 }
3720
3721 bus = bus->parent;
3722 }
3723
3724 pcie_capability_set_word(dev, PCI_EXP_DEVCTL2,
3725 PCI_EXP_DEVCTL2_ATOMIC_REQ);
3726 return 0;
3727}
3728EXPORT_SYMBOL(pci_enable_atomic_ops_to_root);
3729
3730/**
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003731 * pci_swizzle_interrupt_pin - swizzle INTx for device behind bridge
3732 * @dev: the PCI device
Wang Sheng-Huibb5c2de2013-05-28 11:17:41 +08003733 * @pin: the INTx pin (1=INTA, 2=INTB, 3=INTC, 4=INTD)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003734 *
3735 * Perform INTx swizzling for a device behind one level of bridge. This is
3736 * required by section 9.1 of the PCI-to-PCI bridge specification for devices
Matthew Wilcox46b952a2009-07-01 14:24:30 -07003737 * behind bridges on add-in cards. For devices with ARI enabled, the slot
3738 * number is always 0 (see the Implementation Note in section 2.2.8.1 of
3739 * the PCI Express Base Specification, Revision 2.1)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003740 */
John Crispin3df425f2012-04-12 17:33:07 +02003741u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003742{
Matthew Wilcox46b952a2009-07-01 14:24:30 -07003743 int slot;
3744
3745 if (pci_ari_enabled(dev->bus))
3746 slot = 0;
3747 else
3748 slot = PCI_SLOT(dev->devfn);
3749
3750 return (((pin - 1) + slot) % 4) + 1;
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003751}
3752
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003753int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003754{
3755 u8 pin;
3756
Kristen Accardi514d2072005-11-02 16:24:39 -08003757 pin = dev->pin;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003758 if (!pin)
3759 return -1;
Bjorn Helgaas878f2e52008-12-09 16:11:46 -07003760
Kenji Kaneshige8784fd42009-05-26 16:07:33 +09003761 while (!pci_is_root_bus(dev->bus)) {
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003762 pin = pci_swizzle_interrupt_pin(dev, pin);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003763 dev = dev->bus->self;
3764 }
3765 *bridge = dev;
3766 return pin;
3767}
3768
3769/**
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003770 * pci_common_swizzle - swizzle INTx all the way to root bridge
3771 * @dev: the PCI device
3772 * @pinp: pointer to the INTx pin value (1=INTA, 2=INTB, 3=INTD, 4=INTD)
3773 *
3774 * Perform INTx swizzling for a device. This traverses through all PCI-to-PCI
3775 * bridges all the way up to a PCI root bus.
3776 */
3777u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp)
3778{
3779 u8 pin = *pinp;
3780
Kenji Kaneshige1eb39482009-05-26 16:08:36 +09003781 while (!pci_is_root_bus(dev->bus)) {
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003782 pin = pci_swizzle_interrupt_pin(dev, pin);
3783 dev = dev->bus->self;
3784 }
3785 *pinp = pin;
3786 return PCI_SLOT(dev->devfn);
3787}
Ray Juie6b29de2015-04-08 11:21:33 -07003788EXPORT_SYMBOL_GPL(pci_common_swizzle);
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003789
3790/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003791 * pci_release_region - Release a PCI bar
3792 * @pdev: PCI device whose resources were previously reserved by
3793 * pci_request_region()
3794 * @bar: BAR to release
Linus Torvalds1da177e2005-04-16 15:20:36 -07003795 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003796 * Releases the PCI I/O and memory resources previously reserved by a
3797 * successful call to pci_request_region(). Call this function only
3798 * after all use of the PCI regions has ceased.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003799 */
3800void pci_release_region(struct pci_dev *pdev, int bar)
3801{
Tejun Heo9ac78492007-01-20 16:00:26 +09003802 struct pci_devres *dr;
3803
Linus Torvalds1da177e2005-04-16 15:20:36 -07003804 if (pci_resource_len(pdev, bar) == 0)
3805 return;
3806 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO)
3807 release_region(pci_resource_start(pdev, bar),
3808 pci_resource_len(pdev, bar));
3809 else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM)
3810 release_mem_region(pci_resource_start(pdev, bar),
3811 pci_resource_len(pdev, bar));
Tejun Heo9ac78492007-01-20 16:00:26 +09003812
3813 dr = find_pci_dr(pdev);
3814 if (dr)
3815 dr->region_mask &= ~(1 << bar);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003816}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003817EXPORT_SYMBOL(pci_release_region);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003818
3819/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003820 * __pci_request_region - Reserved PCI I/O and memory resource
3821 * @pdev: PCI device whose resources are to be reserved
3822 * @bar: BAR to be reserved
3823 * @res_name: Name to be associated with resource.
3824 * @exclusive: whether the region access is exclusive or not
Linus Torvalds1da177e2005-04-16 15:20:36 -07003825 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003826 * Mark the PCI region associated with PCI device @pdev BAR @bar as
3827 * being reserved by owner @res_name. Do not access any
3828 * address inside the PCI regions unless this call returns
3829 * successfully.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003830 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003831 * If @exclusive is set, then the region is marked so that userspace
3832 * is explicitly not allowed to map the resource via /dev/mem or
3833 * sysfs MMIO access.
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003834 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003835 * Returns 0 on success, or %EBUSY on error. A warning
3836 * message is also printed on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003837 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003838static int __pci_request_region(struct pci_dev *pdev, int bar,
3839 const char *res_name, int exclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003840{
Tejun Heo9ac78492007-01-20 16:00:26 +09003841 struct pci_devres *dr;
3842
Linus Torvalds1da177e2005-04-16 15:20:36 -07003843 if (pci_resource_len(pdev, bar) == 0)
3844 return 0;
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003845
Linus Torvalds1da177e2005-04-16 15:20:36 -07003846 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO) {
3847 if (!request_region(pci_resource_start(pdev, bar),
3848 pci_resource_len(pdev, bar), res_name))
3849 goto err_out;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003850 } else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM) {
Arjan van de Vene8de1482008-10-22 19:55:31 -07003851 if (!__request_mem_region(pci_resource_start(pdev, bar),
3852 pci_resource_len(pdev, bar), res_name,
3853 exclusive))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003854 goto err_out;
3855 }
Tejun Heo9ac78492007-01-20 16:00:26 +09003856
3857 dr = find_pci_dr(pdev);
3858 if (dr)
3859 dr->region_mask |= 1 << bar;
3860
Linus Torvalds1da177e2005-04-16 15:20:36 -07003861 return 0;
3862
3863err_out:
Frederick Lawler7506dc72018-01-18 12:55:24 -06003864 pci_warn(pdev, "BAR %d: can't reserve %pR\n", bar,
Benjamin Herrenschmidt096e6f62008-10-20 15:07:37 +11003865 &pdev->resource[bar]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003866 return -EBUSY;
3867}
3868
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003869/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003870 * pci_request_region - Reserve PCI I/O and memory resource
3871 * @pdev: PCI device whose resources are to be reserved
3872 * @bar: BAR to be reserved
3873 * @res_name: Name to be associated with resource
Arjan van de Vene8de1482008-10-22 19:55:31 -07003874 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003875 * Mark the PCI region associated with PCI device @pdev BAR @bar as
3876 * being reserved by owner @res_name. Do not access any
3877 * address inside the PCI regions unless this call returns
3878 * successfully.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003879 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003880 * Returns 0 on success, or %EBUSY on error. A warning
3881 * message is also printed on failure.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003882 */
3883int pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
3884{
3885 return __pci_request_region(pdev, bar, res_name, 0);
3886}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003887EXPORT_SYMBOL(pci_request_region);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003888
3889/**
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003890 * pci_release_selected_regions - Release selected PCI I/O and memory resources
3891 * @pdev: PCI device whose resources were previously reserved
3892 * @bars: Bitmask of BARs to be released
3893 *
3894 * Release selected PCI I/O and memory resources previously reserved.
3895 * Call this function only after all use of the PCI regions has ceased.
3896 */
3897void pci_release_selected_regions(struct pci_dev *pdev, int bars)
3898{
3899 int i;
3900
Denis Efremovc9c13ba2019-09-28 02:43:08 +03003901 for (i = 0; i < PCI_STD_NUM_BARS; i++)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003902 if (bars & (1 << i))
3903 pci_release_region(pdev, i);
3904}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003905EXPORT_SYMBOL(pci_release_selected_regions);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003906
Bjorn Helgaas9738abe2013-04-12 11:20:03 -06003907static int __pci_request_selected_regions(struct pci_dev *pdev, int bars,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003908 const char *res_name, int excl)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003909{
3910 int i;
3911
Denis Efremovc9c13ba2019-09-28 02:43:08 +03003912 for (i = 0; i < PCI_STD_NUM_BARS; i++)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003913 if (bars & (1 << i))
Arjan van de Vene8de1482008-10-22 19:55:31 -07003914 if (__pci_request_region(pdev, i, res_name, excl))
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003915 goto err_out;
3916 return 0;
3917
3918err_out:
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003919 while (--i >= 0)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003920 if (bars & (1 << i))
3921 pci_release_region(pdev, i);
3922
3923 return -EBUSY;
3924}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003925
Arjan van de Vene8de1482008-10-22 19:55:31 -07003926
3927/**
3928 * pci_request_selected_regions - Reserve selected PCI I/O and memory resources
3929 * @pdev: PCI device whose resources are to be reserved
3930 * @bars: Bitmask of BARs to be requested
3931 * @res_name: Name to be associated with resource
3932 */
3933int pci_request_selected_regions(struct pci_dev *pdev, int bars,
3934 const char *res_name)
3935{
3936 return __pci_request_selected_regions(pdev, bars, res_name, 0);
3937}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003938EXPORT_SYMBOL(pci_request_selected_regions);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003939
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003940int pci_request_selected_regions_exclusive(struct pci_dev *pdev, int bars,
3941 const char *res_name)
Arjan van de Vene8de1482008-10-22 19:55:31 -07003942{
3943 return __pci_request_selected_regions(pdev, bars, res_name,
3944 IORESOURCE_EXCLUSIVE);
3945}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003946EXPORT_SYMBOL(pci_request_selected_regions_exclusive);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003947
Linus Torvalds1da177e2005-04-16 15:20:36 -07003948/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003949 * pci_release_regions - Release reserved PCI I/O and memory resources
3950 * @pdev: PCI device whose resources were previously reserved by
3951 * pci_request_regions()
Linus Torvalds1da177e2005-04-16 15:20:36 -07003952 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003953 * Releases all PCI I/O and memory resources previously reserved by a
3954 * successful call to pci_request_regions(). Call this function only
3955 * after all use of the PCI regions has ceased.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003956 */
3957
3958void pci_release_regions(struct pci_dev *pdev)
3959{
Denis Efremovc9c13ba2019-09-28 02:43:08 +03003960 pci_release_selected_regions(pdev, (1 << PCI_STD_NUM_BARS) - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003961}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003962EXPORT_SYMBOL(pci_release_regions);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003963
3964/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003965 * pci_request_regions - Reserve PCI I/O and memory resources
3966 * @pdev: PCI device whose resources are to be reserved
3967 * @res_name: Name to be associated with resource.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003968 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003969 * Mark all PCI regions associated with PCI device @pdev as
3970 * being reserved by owner @res_name. Do not access any
3971 * address inside the PCI regions unless this call returns
3972 * successfully.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003973 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003974 * Returns 0 on success, or %EBUSY on error. A warning
3975 * message is also printed on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003976 */
Jeff Garzik3c990e92006-03-04 21:52:42 -05003977int pci_request_regions(struct pci_dev *pdev, const char *res_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003978{
Denis Efremovc9c13ba2019-09-28 02:43:08 +03003979 return pci_request_selected_regions(pdev,
3980 ((1 << PCI_STD_NUM_BARS) - 1), res_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003981}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003982EXPORT_SYMBOL(pci_request_regions);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003983
3984/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003985 * pci_request_regions_exclusive - Reserve PCI I/O and memory resources
3986 * @pdev: PCI device whose resources are to be reserved
3987 * @res_name: Name to be associated with resource.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003988 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003989 * Mark all PCI regions associated with PCI device @pdev as being reserved
3990 * by owner @res_name. Do not access any address inside the PCI regions
3991 * unless this call returns successfully.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003992 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003993 * pci_request_regions_exclusive() will mark the region so that /dev/mem
3994 * and the sysfs MMIO access will not be allowed.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003995 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06003996 * Returns 0 on success, or %EBUSY on error. A warning message is also
3997 * printed on failure.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003998 */
3999int pci_request_regions_exclusive(struct pci_dev *pdev, const char *res_name)
4000{
4001 return pci_request_selected_regions_exclusive(pdev,
Denis Efremovc9c13ba2019-09-28 02:43:08 +03004002 ((1 << PCI_STD_NUM_BARS) - 1), res_name);
Arjan van de Vene8de1482008-10-22 19:55:31 -07004003}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004004EXPORT_SYMBOL(pci_request_regions_exclusive);
Arjan van de Vene8de1482008-10-22 19:55:31 -07004005
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004006/*
4007 * Record the PCI IO range (expressed as CPU physical address + size).
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004008 * Return a negative value if an error has occurred, zero otherwise
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004009 */
Gabriele Paolonifcfaab32018-03-15 02:15:52 +08004010int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
4011 resource_size_t size)
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004012{
Zhichang Yuan57453922018-03-15 02:15:53 +08004013 int ret = 0;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004014#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08004015 struct logic_pio_hwaddr *range;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004016
Zhichang Yuan57453922018-03-15 02:15:53 +08004017 if (!size || addr + size < addr)
4018 return -EINVAL;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004019
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004020 range = kzalloc(sizeof(*range), GFP_ATOMIC);
Zhichang Yuan57453922018-03-15 02:15:53 +08004021 if (!range)
4022 return -ENOMEM;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004023
Zhichang Yuan57453922018-03-15 02:15:53 +08004024 range->fwnode = fwnode;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004025 range->size = size;
Zhichang Yuan57453922018-03-15 02:15:53 +08004026 range->hw_start = addr;
4027 range->flags = LOGIC_PIO_CPU_MMIO;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004028
Zhichang Yuan57453922018-03-15 02:15:53 +08004029 ret = logic_pio_register_range(range);
4030 if (ret)
4031 kfree(range);
Geert Uytterhoevenf6bda642021-02-02 11:03:32 +01004032
4033 /* Ignore duplicates due to deferred probing */
4034 if (ret == -EEXIST)
4035 ret = 0;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004036#endif
4037
Zhichang Yuan57453922018-03-15 02:15:53 +08004038 return ret;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004039}
4040
4041phys_addr_t pci_pio_to_address(unsigned long pio)
4042{
4043 phys_addr_t address = (phys_addr_t)OF_BAD_ADDR;
4044
4045#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08004046 if (pio >= MMIO_UPPER_LIMIT)
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004047 return address;
4048
Zhichang Yuan57453922018-03-15 02:15:53 +08004049 address = logic_pio_to_hwaddr(pio);
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004050#endif
4051
4052 return address;
4053}
4054
4055unsigned long __weak pci_address_to_pio(phys_addr_t address)
4056{
4057#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08004058 return logic_pio_trans_cpuaddr(address);
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05004059#else
4060 if (address > IO_SPACE_LIMIT)
4061 return (unsigned long)-1;
4062
4063 return (unsigned long) address;
4064#endif
4065}
4066
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004067/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004068 * pci_remap_iospace - Remap the memory mapped I/O space
4069 * @res: Resource describing the I/O space
4070 * @phys_addr: physical address of range to be mapped
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004071 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004072 * Remap the memory mapped I/O space described by the @res and the CPU
4073 * physical address @phys_addr into virtual address space. Only
4074 * architectures that have memory mapped IO functions defined (and the
4075 * PCI_IOBASE value defined) should call this function.
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004076 */
Lorenzo Pieralisi7b309ae2017-04-19 17:48:50 +01004077int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr)
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004078{
4079#if defined(PCI_IOBASE) && defined(CONFIG_MMU)
4080 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
4081
4082 if (!(res->flags & IORESOURCE_IO))
4083 return -EINVAL;
4084
4085 if (res->end > IO_SPACE_LIMIT)
4086 return -EINVAL;
4087
4088 return ioremap_page_range(vaddr, vaddr + resource_size(res), phys_addr,
4089 pgprot_device(PAGE_KERNEL));
4090#else
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004091 /*
4092 * This architecture does not have memory mapped I/O space,
4093 * so this function should never be called
4094 */
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004095 WARN_ONCE(1, "This architecture does not support memory mapped I/O\n");
4096 return -ENODEV;
4097#endif
4098}
Brian Norrisf90b0872017-03-09 18:46:16 -08004099EXPORT_SYMBOL(pci_remap_iospace);
Liviu Dudau8b921ac2014-09-29 15:29:30 +01004100
Sinan Kaya4d3f1382016-06-10 21:55:11 +02004101/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004102 * pci_unmap_iospace - Unmap the memory mapped I/O space
4103 * @res: resource to be unmapped
Sinan Kaya4d3f1382016-06-10 21:55:11 +02004104 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004105 * Unmap the CPU virtual address @res from virtual address space. Only
4106 * architectures that have memory mapped IO functions defined (and the
4107 * PCI_IOBASE value defined) should call this function.
Sinan Kaya4d3f1382016-06-10 21:55:11 +02004108 */
4109void pci_unmap_iospace(struct resource *res)
4110{
4111#if defined(PCI_IOBASE) && defined(CONFIG_MMU)
4112 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
4113
4114 unmap_kernel_range(vaddr, resource_size(res));
4115#endif
4116}
Brian Norrisf90b0872017-03-09 18:46:16 -08004117EXPORT_SYMBOL(pci_unmap_iospace);
Sinan Kaya4d3f1382016-06-10 21:55:11 +02004118
Sergei Shtylyova5fb9fb2018-07-18 15:40:26 -05004119static void devm_pci_unmap_iospace(struct device *dev, void *ptr)
4120{
4121 struct resource **res = ptr;
4122
4123 pci_unmap_iospace(*res);
4124}
4125
4126/**
4127 * devm_pci_remap_iospace - Managed pci_remap_iospace()
4128 * @dev: Generic device to remap IO address for
4129 * @res: Resource describing the I/O space
4130 * @phys_addr: physical address of range to be mapped
4131 *
4132 * Managed pci_remap_iospace(). Map is automatically unmapped on driver
4133 * detach.
4134 */
4135int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
4136 phys_addr_t phys_addr)
4137{
4138 const struct resource **ptr;
4139 int error;
4140
4141 ptr = devres_alloc(devm_pci_unmap_iospace, sizeof(*ptr), GFP_KERNEL);
4142 if (!ptr)
4143 return -ENOMEM;
4144
4145 error = pci_remap_iospace(res, phys_addr);
4146 if (error) {
4147 devres_free(ptr);
4148 } else {
4149 *ptr = res;
4150 devres_add(dev, ptr);
4151 }
4152
4153 return error;
4154}
4155EXPORT_SYMBOL(devm_pci_remap_iospace);
4156
Lorenzo Pieralisi490cb6d2017-04-19 17:48:55 +01004157/**
4158 * devm_pci_remap_cfgspace - Managed pci_remap_cfgspace()
4159 * @dev: Generic device to remap IO address for
4160 * @offset: Resource address to map
4161 * @size: Size of map
4162 *
4163 * Managed pci_remap_cfgspace(). Map is automatically unmapped on driver
4164 * detach.
4165 */
4166void __iomem *devm_pci_remap_cfgspace(struct device *dev,
4167 resource_size_t offset,
4168 resource_size_t size)
4169{
4170 void __iomem **ptr, *addr;
4171
4172 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
4173 if (!ptr)
4174 return NULL;
4175
4176 addr = pci_remap_cfgspace(offset, size);
4177 if (addr) {
4178 *ptr = addr;
4179 devres_add(dev, ptr);
4180 } else
4181 devres_free(ptr);
4182
4183 return addr;
4184}
4185EXPORT_SYMBOL(devm_pci_remap_cfgspace);
4186
4187/**
4188 * devm_pci_remap_cfg_resource - check, request region and ioremap cfg resource
4189 * @dev: generic device to handle the resource for
4190 * @res: configuration space resource to be handled
4191 *
4192 * Checks that a resource is a valid memory region, requests the memory
4193 * region and ioremaps with pci_remap_cfgspace() API that ensures the
4194 * proper PCI configuration space memory attributes are guaranteed.
4195 *
4196 * All operations are managed and will be undone on driver detach.
4197 *
4198 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
Randy Dunlap505fb742017-10-29 17:07:11 -07004199 * on failure. Usage example::
Lorenzo Pieralisi490cb6d2017-04-19 17:48:55 +01004200 *
4201 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
4202 * base = devm_pci_remap_cfg_resource(&pdev->dev, res);
4203 * if (IS_ERR(base))
4204 * return PTR_ERR(base);
4205 */
4206void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
4207 struct resource *res)
4208{
4209 resource_size_t size;
4210 const char *name;
4211 void __iomem *dest_ptr;
4212
4213 BUG_ON(!dev);
4214
4215 if (!res || resource_type(res) != IORESOURCE_MEM) {
4216 dev_err(dev, "invalid resource\n");
4217 return IOMEM_ERR_PTR(-EINVAL);
4218 }
4219
4220 size = resource_size(res);
Alexander Lobakin0af6e212020-11-19 21:26:33 +00004221
4222 if (res->name)
4223 name = devm_kasprintf(dev, GFP_KERNEL, "%s %s", dev_name(dev),
4224 res->name);
4225 else
4226 name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
4227 if (!name)
4228 return IOMEM_ERR_PTR(-ENOMEM);
Lorenzo Pieralisi490cb6d2017-04-19 17:48:55 +01004229
4230 if (!devm_request_mem_region(dev, res->start, size, name)) {
4231 dev_err(dev, "can't request region for resource %pR\n", res);
4232 return IOMEM_ERR_PTR(-EBUSY);
4233 }
4234
4235 dest_ptr = devm_pci_remap_cfgspace(dev, res->start, size);
4236 if (!dest_ptr) {
4237 dev_err(dev, "ioremap failed for resource %pR\n", res);
4238 devm_release_mem_region(dev, res->start, size);
4239 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
4240 }
4241
4242 return dest_ptr;
4243}
4244EXPORT_SYMBOL(devm_pci_remap_cfg_resource);
4245
Ben Hutchings6a479072008-12-23 03:08:29 +00004246static void __pci_set_master(struct pci_dev *dev, bool enable)
4247{
4248 u16 old_cmd, cmd;
4249
4250 pci_read_config_word(dev, PCI_COMMAND, &old_cmd);
4251 if (enable)
4252 cmd = old_cmd | PCI_COMMAND_MASTER;
4253 else
4254 cmd = old_cmd & ~PCI_COMMAND_MASTER;
4255 if (cmd != old_cmd) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06004256 pci_dbg(dev, "%s bus mastering\n",
Ben Hutchings6a479072008-12-23 03:08:29 +00004257 enable ? "enabling" : "disabling");
4258 pci_write_config_word(dev, PCI_COMMAND, cmd);
4259 }
4260 dev->is_busmaster = enable;
4261}
Arjan van de Vene8de1482008-10-22 19:55:31 -07004262
4263/**
Myron Stowe2b6f2c32012-06-25 21:30:57 -06004264 * pcibios_setup - process "pci=" kernel boot arguments
4265 * @str: string used to pass in "pci=" kernel boot arguments
4266 *
4267 * Process kernel boot arguments. This is the default implementation.
4268 * Architecture specific implementations can override this as necessary.
4269 */
4270char * __weak __init pcibios_setup(char *str)
4271{
4272 return str;
4273}
4274
4275/**
Myron Stowe96c55902011-10-28 15:48:38 -06004276 * pcibios_set_master - enable PCI bus-mastering for device dev
4277 * @dev: the PCI device to enable
4278 *
4279 * Enables PCI bus-mastering for the device. This is the default
4280 * implementation. Architecture specific implementations can override
4281 * this if necessary.
4282 */
4283void __weak pcibios_set_master(struct pci_dev *dev)
4284{
4285 u8 lat;
4286
Myron Stowef6766782011-10-28 15:49:20 -06004287 /* The latency timer doesn't apply to PCIe (either Type 0 or Type 1) */
4288 if (pci_is_pcie(dev))
4289 return;
4290
Myron Stowe96c55902011-10-28 15:48:38 -06004291 pci_read_config_byte(dev, PCI_LATENCY_TIMER, &lat);
4292 if (lat < 16)
4293 lat = (64 <= pcibios_max_latency) ? 64 : pcibios_max_latency;
4294 else if (lat > pcibios_max_latency)
4295 lat = pcibios_max_latency;
4296 else
4297 return;
Bjorn Helgaasa0064822013-09-23 15:25:26 -06004298
Myron Stowe96c55902011-10-28 15:48:38 -06004299 pci_write_config_byte(dev, PCI_LATENCY_TIMER, lat);
4300}
4301
4302/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004303 * pci_set_master - enables bus-mastering for device dev
4304 * @dev: the PCI device to enable
4305 *
4306 * Enables bus-mastering on the device and calls pcibios_set_master()
4307 * to do the needed arch specific settings.
4308 */
Ben Hutchings6a479072008-12-23 03:08:29 +00004309void pci_set_master(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004310{
Ben Hutchings6a479072008-12-23 03:08:29 +00004311 __pci_set_master(dev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004312 pcibios_set_master(dev);
4313}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004314EXPORT_SYMBOL(pci_set_master);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004315
Ben Hutchings6a479072008-12-23 03:08:29 +00004316/**
4317 * pci_clear_master - disables bus-mastering for device dev
4318 * @dev: the PCI device to disable
4319 */
4320void pci_clear_master(struct pci_dev *dev)
4321{
4322 __pci_set_master(dev, false);
4323}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004324EXPORT_SYMBOL(pci_clear_master);
Ben Hutchings6a479072008-12-23 03:08:29 +00004325
Linus Torvalds1da177e2005-04-16 15:20:36 -07004326/**
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004327 * pci_set_cacheline_size - ensure the CACHE_LINE_SIZE register is programmed
4328 * @dev: the PCI device for which MWI is to be enabled
Linus Torvalds1da177e2005-04-16 15:20:36 -07004329 *
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004330 * Helper function for pci_set_mwi.
4331 * Originally copied from drivers/net/acenic.c.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004332 * Copyright 1998-2001 by Jes Sorensen, <jes@trained-monkey.org>.
4333 *
4334 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4335 */
Tejun Heo15ea76d2009-09-22 17:34:48 +09004336int pci_set_cacheline_size(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004337{
4338 u8 cacheline_size;
4339
4340 if (!pci_cache_line_size)
Tejun Heo15ea76d2009-09-22 17:34:48 +09004341 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004342
4343 /* Validate current setting: the PCI_CACHE_LINE_SIZE must be
4344 equal to or multiple of the right value. */
4345 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4346 if (cacheline_size >= pci_cache_line_size &&
4347 (cacheline_size % pci_cache_line_size) == 0)
4348 return 0;
4349
4350 /* Write the correct value. */
4351 pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, pci_cache_line_size);
4352 /* Read it back. */
4353 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4354 if (cacheline_size == pci_cache_line_size)
4355 return 0;
4356
Heiner Kallweit0aec75a2020-12-08 18:57:02 +01004357 pci_dbg(dev, "cache line size of %d is not supported\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -04004358 pci_cache_line_size << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004359
4360 return -EINVAL;
4361}
Tejun Heo15ea76d2009-09-22 17:34:48 +09004362EXPORT_SYMBOL_GPL(pci_set_cacheline_size);
4363
Linus Torvalds1da177e2005-04-16 15:20:36 -07004364/**
4365 * pci_set_mwi - enables memory-write-invalidate PCI transaction
4366 * @dev: the PCI device for which MWI is enabled
4367 *
Randy Dunlap694625c2007-07-09 11:55:54 -07004368 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004369 *
4370 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4371 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004372int pci_set_mwi(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004373{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004374#ifdef PCI_DISABLE_MWI
4375 return 0;
4376#else
Linus Torvalds1da177e2005-04-16 15:20:36 -07004377 int rc;
4378 u16 cmd;
4379
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004380 rc = pci_set_cacheline_size(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004381 if (rc)
4382 return rc;
4383
4384 pci_read_config_word(dev, PCI_COMMAND, &cmd);
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004385 if (!(cmd & PCI_COMMAND_INVALIDATE)) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06004386 pci_dbg(dev, "enabling Mem-Wr-Inval\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004387 cmd |= PCI_COMMAND_INVALIDATE;
4388 pci_write_config_word(dev, PCI_COMMAND, cmd);
4389 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004390 return 0;
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004391#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004392}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004393EXPORT_SYMBOL(pci_set_mwi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004394
4395/**
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01004396 * pcim_set_mwi - a device-managed pci_set_mwi()
4397 * @dev: the PCI device for which MWI is enabled
4398 *
4399 * Managed pci_set_mwi().
4400 *
4401 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4402 */
4403int pcim_set_mwi(struct pci_dev *dev)
4404{
4405 struct pci_devres *dr;
4406
4407 dr = find_pci_dr(dev);
4408 if (!dr)
4409 return -ENOMEM;
4410
4411 dr->mwi = 1;
4412 return pci_set_mwi(dev);
4413}
4414EXPORT_SYMBOL(pcim_set_mwi);
4415
4416/**
Randy Dunlap694625c2007-07-09 11:55:54 -07004417 * pci_try_set_mwi - enables memory-write-invalidate PCI transaction
4418 * @dev: the PCI device for which MWI is enabled
4419 *
4420 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4421 * Callers are not required to check the return value.
4422 *
4423 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4424 */
4425int pci_try_set_mwi(struct pci_dev *dev)
4426{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004427#ifdef PCI_DISABLE_MWI
4428 return 0;
4429#else
4430 return pci_set_mwi(dev);
4431#endif
Randy Dunlap694625c2007-07-09 11:55:54 -07004432}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004433EXPORT_SYMBOL(pci_try_set_mwi);
Randy Dunlap694625c2007-07-09 11:55:54 -07004434
4435/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004436 * pci_clear_mwi - disables Memory-Write-Invalidate for device dev
4437 * @dev: the PCI device to disable
4438 *
4439 * Disables PCI Memory-Write-Invalidate transaction on the device
4440 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004441void pci_clear_mwi(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004442{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004443#ifndef PCI_DISABLE_MWI
Linus Torvalds1da177e2005-04-16 15:20:36 -07004444 u16 cmd;
4445
4446 pci_read_config_word(dev, PCI_COMMAND, &cmd);
4447 if (cmd & PCI_COMMAND_INVALIDATE) {
4448 cmd &= ~PCI_COMMAND_INVALIDATE;
4449 pci_write_config_word(dev, PCI_COMMAND, cmd);
4450 }
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004451#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004452}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004453EXPORT_SYMBOL(pci_clear_mwi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004454
Brett M Russa04ce0f2005-08-15 15:23:41 -04004455/**
4456 * pci_intx - enables/disables PCI INTx for device dev
Randy Dunlap8f7020d2005-10-23 11:57:38 -07004457 * @pdev: the PCI device to operate on
4458 * @enable: boolean: whether to enable or disable PCI INTx
Brett M Russa04ce0f2005-08-15 15:23:41 -04004459 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004460 * Enables/disables PCI INTx for device @pdev
Brett M Russa04ce0f2005-08-15 15:23:41 -04004461 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004462void pci_intx(struct pci_dev *pdev, int enable)
Brett M Russa04ce0f2005-08-15 15:23:41 -04004463{
4464 u16 pci_command, new;
4465
4466 pci_read_config_word(pdev, PCI_COMMAND, &pci_command);
4467
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004468 if (enable)
Brett M Russa04ce0f2005-08-15 15:23:41 -04004469 new = pci_command & ~PCI_COMMAND_INTX_DISABLE;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004470 else
Brett M Russa04ce0f2005-08-15 15:23:41 -04004471 new = pci_command | PCI_COMMAND_INTX_DISABLE;
Brett M Russa04ce0f2005-08-15 15:23:41 -04004472
4473 if (new != pci_command) {
Tejun Heo9ac78492007-01-20 16:00:26 +09004474 struct pci_devres *dr;
4475
Brett M Russ2fd9d742005-09-09 10:02:22 -07004476 pci_write_config_word(pdev, PCI_COMMAND, new);
Tejun Heo9ac78492007-01-20 16:00:26 +09004477
4478 dr = find_pci_dr(pdev);
4479 if (dr && !dr->restore_intx) {
4480 dr->restore_intx = 1;
4481 dr->orig_intx = !enable;
4482 }
Brett M Russa04ce0f2005-08-15 15:23:41 -04004483 }
4484}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004485EXPORT_SYMBOL_GPL(pci_intx);
Brett M Russa04ce0f2005-08-15 15:23:41 -04004486
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004487static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask)
4488{
4489 struct pci_bus *bus = dev->bus;
4490 bool mask_updated = true;
4491 u32 cmd_status_dword;
4492 u16 origcmd, newcmd;
4493 unsigned long flags;
4494 bool irq_pending;
4495
4496 /*
4497 * We do a single dword read to retrieve both command and status.
4498 * Document assumptions that make this possible.
4499 */
4500 BUILD_BUG_ON(PCI_COMMAND % 4);
4501 BUILD_BUG_ON(PCI_COMMAND + 2 != PCI_STATUS);
4502
4503 raw_spin_lock_irqsave(&pci_lock, flags);
4504
4505 bus->ops->read(bus, dev->devfn, PCI_COMMAND, 4, &cmd_status_dword);
4506
4507 irq_pending = (cmd_status_dword >> 16) & PCI_STATUS_INTERRUPT;
4508
4509 /*
4510 * Check interrupt status register to see whether our device
4511 * triggered the interrupt (when masking) or the next IRQ is
4512 * already pending (when unmasking).
4513 */
4514 if (mask != irq_pending) {
4515 mask_updated = false;
4516 goto done;
4517 }
4518
4519 origcmd = cmd_status_dword;
4520 newcmd = origcmd & ~PCI_COMMAND_INTX_DISABLE;
4521 if (mask)
4522 newcmd |= PCI_COMMAND_INTX_DISABLE;
4523 if (newcmd != origcmd)
4524 bus->ops->write(bus, dev->devfn, PCI_COMMAND, 2, newcmd);
4525
4526done:
4527 raw_spin_unlock_irqrestore(&pci_lock, flags);
4528
4529 return mask_updated;
4530}
4531
4532/**
4533 * pci_check_and_mask_intx - mask INTx on pending interrupt
Randy Dunlap6e9292c2012-01-21 11:02:35 -08004534 * @dev: the PCI device to operate on
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004535 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004536 * Check if the device dev has its INTx line asserted, mask it and return
4537 * true in that case. False is returned if no interrupt was pending.
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004538 */
4539bool pci_check_and_mask_intx(struct pci_dev *dev)
4540{
4541 return pci_check_and_set_intx_mask(dev, true);
4542}
4543EXPORT_SYMBOL_GPL(pci_check_and_mask_intx);
4544
4545/**
Bjorn Helgaasebd50b92014-01-14 17:10:39 -07004546 * pci_check_and_unmask_intx - unmask INTx if no interrupt is pending
Randy Dunlap6e9292c2012-01-21 11:02:35 -08004547 * @dev: the PCI device to operate on
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004548 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004549 * Check if the device dev has its INTx line asserted, unmask it if not and
4550 * return true. False is returned and the mask remains active if there was
4551 * still an interrupt pending.
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004552 */
4553bool pci_check_and_unmask_intx(struct pci_dev *dev)
4554{
4555 return pci_check_and_set_intx_mask(dev, false);
4556}
4557EXPORT_SYMBOL_GPL(pci_check_and_unmask_intx);
4558
Casey Leedom3775a202013-08-06 15:48:36 +05304559/**
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004560 * pci_wait_for_pending_transaction - wait for pending transaction
Casey Leedom3775a202013-08-06 15:48:36 +05304561 * @dev: the PCI device to operate on
4562 *
4563 * Return 0 if transaction is pending 1 otherwise.
4564 */
4565int pci_wait_for_pending_transaction(struct pci_dev *dev)
Sheng Yang8dd7f802008-10-21 17:38:25 +08004566{
Alex Williamson157e8762013-12-17 16:43:39 -07004567 if (!pci_is_pcie(dev))
4568 return 1;
Sheng Yang8dd7f802008-10-21 17:38:25 +08004569
Gavin Shand0b4cc42014-05-19 13:06:46 +10004570 return pci_wait_for_pending(dev, pci_pcie_cap(dev) + PCI_EXP_DEVSTA,
4571 PCI_EXP_DEVSTA_TRPND);
Casey Leedom3775a202013-08-06 15:48:36 +05304572}
4573EXPORT_SYMBOL(pci_wait_for_pending_transaction);
Sheng Yang5fe5db02009-02-09 14:53:47 +08004574
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004575/**
4576 * pcie_has_flr - check if a device supports function level resets
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004577 * @dev: device to check
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004578 *
4579 * Returns true if the device advertises support for PCIe function level
4580 * resets.
4581 */
Alex Williamson2d2917f2018-08-09 14:04:14 -06004582bool pcie_has_flr(struct pci_dev *dev)
Casey Leedom3775a202013-08-06 15:48:36 +05304583{
4584 u32 cap;
4585
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004586 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004587 return false;
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004588
Casey Leedom3775a202013-08-06 15:48:36 +05304589 pcie_capability_read_dword(dev, PCI_EXP_DEVCAP, &cap);
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004590 return cap & PCI_EXP_DEVCAP_FLR;
4591}
Alex Williamson2d2917f2018-08-09 14:04:14 -06004592EXPORT_SYMBOL_GPL(pcie_has_flr);
Casey Leedom3775a202013-08-06 15:48:36 +05304593
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004594/**
4595 * pcie_flr - initiate a PCIe function level reset
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06004596 * @dev: device to reset
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004597 *
4598 * Initiate a function level reset on @dev. The caller should ensure the
4599 * device supports FLR before calling this function, e.g. by using the
4600 * pcie_has_flr() helper.
4601 */
Sinan Kaya91295d72018-02-27 14:14:08 -06004602int pcie_flr(struct pci_dev *dev)
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004603{
Casey Leedom3775a202013-08-06 15:48:36 +05304604 if (!pci_wait_for_pending_transaction(dev))
Frederick Lawler7506dc72018-01-18 12:55:24 -06004605 pci_err(dev, "timed out waiting for pending transaction; performing function level reset anyway\n");
Casey Leedom3775a202013-08-06 15:48:36 +05304606
Jiang Liu59875ae2012-07-24 17:20:06 +08004607 pcie_capability_set_word(dev, PCI_EXP_DEVCTL, PCI_EXP_DEVCTL_BCR_FLR);
Sinan Kayaa2758b62018-02-27 14:14:10 -06004608
Felipe Balbid6112f82018-09-07 09:16:51 +03004609 if (dev->imm_ready)
4610 return 0;
4611
Sinan Kayaa2758b62018-02-27 14:14:10 -06004612 /*
4613 * Per PCIe r4.0, sec 6.6.2, a device must complete an FLR within
4614 * 100ms, but may silently discard requests while the FLR is in
4615 * progress. Wait 100ms before trying to access the device.
4616 */
4617 msleep(100);
4618
4619 return pci_dev_wait(dev, "FLR", PCIE_RESET_READY_POLL_MS);
Sheng Yang8dd7f802008-10-21 17:38:25 +08004620}
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004621EXPORT_SYMBOL_GPL(pcie_flr);
Sheng Yangd91cdc72008-11-11 17:17:47 +08004622
Yu Zhao8c1c6992009-06-13 15:52:13 +08004623static int pci_af_flr(struct pci_dev *dev, int probe)
Sheng Yang1ca88792008-11-11 17:17:48 +08004624{
Yu Zhao8c1c6992009-06-13 15:52:13 +08004625 int pos;
Sheng Yang1ca88792008-11-11 17:17:48 +08004626 u8 cap;
4627
Yu Zhao8c1c6992009-06-13 15:52:13 +08004628 pos = pci_find_capability(dev, PCI_CAP_ID_AF);
4629 if (!pos)
Sheng Yang1ca88792008-11-11 17:17:48 +08004630 return -ENOTTY;
Yu Zhao8c1c6992009-06-13 15:52:13 +08004631
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004632 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4633 return -ENOTTY;
4634
Yu Zhao8c1c6992009-06-13 15:52:13 +08004635 pci_read_config_byte(dev, pos + PCI_AF_CAP, &cap);
Sheng Yang1ca88792008-11-11 17:17:48 +08004636 if (!(cap & PCI_AF_CAP_TP) || !(cap & PCI_AF_CAP_FLR))
4637 return -ENOTTY;
4638
4639 if (probe)
4640 return 0;
4641
Alex Williamsond066c942014-06-17 15:40:13 -06004642 /*
4643 * Wait for Transaction Pending bit to clear. A word-aligned test
Bjorn Helgaasf6b6aef2019-05-30 08:05:58 -05004644 * is used, so we use the control offset rather than status and shift
Alex Williamsond066c942014-06-17 15:40:13 -06004645 * the test bit to match.
4646 */
Gavin Shanbb383e22014-11-12 13:41:51 +11004647 if (!pci_wait_for_pending(dev, pos + PCI_AF_CTRL,
Alex Williamsond066c942014-06-17 15:40:13 -06004648 PCI_AF_STATUS_TP << 8))
Frederick Lawler7506dc72018-01-18 12:55:24 -06004649 pci_err(dev, "timed out waiting for pending transaction; performing AF function level reset anyway\n");
Yu Zhao8c1c6992009-06-13 15:52:13 +08004650
Yu Zhao8c1c6992009-06-13 15:52:13 +08004651 pci_write_config_byte(dev, pos + PCI_AF_CTRL, PCI_AF_CTRL_FLR);
Sinan Kayaa2758b62018-02-27 14:14:10 -06004652
Felipe Balbid6112f82018-09-07 09:16:51 +03004653 if (dev->imm_ready)
4654 return 0;
4655
Sinan Kayaa2758b62018-02-27 14:14:10 -06004656 /*
4657 * Per Advanced Capabilities for Conventional PCI ECN, 13 April 2006,
4658 * updated 27 July 2006; a device must complete an FLR within
4659 * 100ms, but may silently discard requests while the FLR is in
4660 * progress. Wait 100ms before trying to access the device.
4661 */
4662 msleep(100);
4663
4664 return pci_dev_wait(dev, "AF_FLR", PCIE_RESET_READY_POLL_MS);
Sheng Yang1ca88792008-11-11 17:17:48 +08004665}
4666
Rafael J. Wysocki83d74e02011-03-05 21:48:44 +01004667/**
4668 * pci_pm_reset - Put device into PCI_D3 and back into PCI_D0.
4669 * @dev: Device to reset.
4670 * @probe: If set, only check if the device can be reset this way.
4671 *
4672 * If @dev supports native PCI PM and its PCI_PM_CTRL_NO_SOFT_RESET flag is
4673 * unset, it will be reinitialized internally when going from PCI_D3hot to
4674 * PCI_D0. If that's the case and the device is not in a low-power state
4675 * already, force it into PCI_D3hot and back to PCI_D0, causing it to be reset.
4676 *
4677 * NOTE: This causes the caller to sleep for twice the device power transition
4678 * cooldown period, which for the D0->D3hot and D3hot->D0 transitions is 10 ms
Krzysztof Wilczyński3789af92020-07-30 21:08:48 +00004679 * by default (i.e. unless the @dev's d3hot_delay field has a different value).
Rafael J. Wysocki83d74e02011-03-05 21:48:44 +01004680 * Moreover, only devices in D0 can be reset by this function.
4681 */
Yu Zhaof85876b2009-06-13 15:52:14 +08004682static int pci_pm_reset(struct pci_dev *dev, int probe)
Sheng Yangd91cdc72008-11-11 17:17:47 +08004683{
Yu Zhaof85876b2009-06-13 15:52:14 +08004684 u16 csr;
Sheng Yangd91cdc72008-11-11 17:17:47 +08004685
Alex Williamson51e53732014-11-21 11:24:08 -07004686 if (!dev->pm_cap || dev->dev_flags & PCI_DEV_FLAGS_NO_PM_RESET)
Yu Zhaof85876b2009-06-13 15:52:14 +08004687 return -ENOTTY;
Sheng Yangd91cdc72008-11-11 17:17:47 +08004688
Yu Zhaof85876b2009-06-13 15:52:14 +08004689 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &csr);
4690 if (csr & PCI_PM_CTRL_NO_SOFT_RESET)
4691 return -ENOTTY;
Sheng Yang1ca88792008-11-11 17:17:48 +08004692
Yu Zhaof85876b2009-06-13 15:52:14 +08004693 if (probe)
4694 return 0;
4695
4696 if (dev->current_state != PCI_D0)
4697 return -EINVAL;
4698
4699 csr &= ~PCI_PM_CTRL_STATE_MASK;
4700 csr |= PCI_D3hot;
4701 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01004702 pci_dev_d3_sleep(dev);
Yu Zhaof85876b2009-06-13 15:52:14 +08004703
4704 csr &= ~PCI_PM_CTRL_STATE_MASK;
4705 csr |= PCI_D0;
4706 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01004707 pci_dev_d3_sleep(dev);
Yu Zhaof85876b2009-06-13 15:52:14 +08004708
Bjorn Helgaas993cc6d2019-10-28 08:27:00 -05004709 return pci_dev_wait(dev, "PM D3hot->D0", PCIE_RESET_READY_POLL_MS);
Yu Zhaof85876b2009-06-13 15:52:14 +08004710}
Mika Westerberg4827d632019-11-12 12:16:16 +03004711
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004712/**
Mika Westerberg4827d632019-11-12 12:16:16 +03004713 * pcie_wait_for_link_delay - Wait until link is active or inactive
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004714 * @pdev: Bridge device
4715 * @active: waiting for active or inactive?
Bjorn Helgaasd08c30d2020-07-17 17:21:28 -05004716 * @delay: Delay to wait after link has become active (in ms)
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004717 *
4718 * Use this to wait till link becomes active or inactive.
4719 */
Mika Westerberg4827d632019-11-12 12:16:16 +03004720static bool pcie_wait_for_link_delay(struct pci_dev *pdev, bool active,
4721 int delay)
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004722{
4723 int timeout = 1000;
4724 bool ret;
4725 u16 lnk_status;
4726
Keith Buschf0157162018-09-20 10:27:17 -06004727 /*
4728 * Some controllers might not implement link active reporting. In this
Bjorn Helgaasf044baa2020-05-15 14:31:16 -05004729 * case, we wait for 1000 ms + any delay requested by the caller.
Keith Buschf0157162018-09-20 10:27:17 -06004730 */
4731 if (!pdev->link_active_reporting) {
Bjorn Helgaasf044baa2020-05-15 14:31:16 -05004732 msleep(timeout + delay);
Keith Buschf0157162018-09-20 10:27:17 -06004733 return true;
4734 }
4735
4736 /*
4737 * PCIe r4.0 sec 6.6.1, a component must enter LTSSM Detect within 20ms,
4738 * after which we should expect an link active if the reset was
4739 * successful. If so, software must wait a minimum 100ms before sending
4740 * configuration requests to devices downstream this port.
4741 *
4742 * If the link fails to activate, either the device was physically
4743 * removed or the link is permanently failed.
4744 */
4745 if (active)
4746 msleep(20);
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004747 for (;;) {
4748 pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnk_status);
4749 ret = !!(lnk_status & PCI_EXP_LNKSTA_DLLLA);
4750 if (ret == active)
Keith Buschf0157162018-09-20 10:27:17 -06004751 break;
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004752 if (timeout <= 0)
4753 break;
4754 msleep(10);
4755 timeout -= 10;
4756 }
Bjorn Helgaasd08c30d2020-07-17 17:21:28 -05004757 if (active && ret)
Mika Westerberg4827d632019-11-12 12:16:16 +03004758 msleep(delay);
Lukas Wunner8a614492020-09-17 16:13:20 -05004759
Keith Buschf0157162018-09-20 10:27:17 -06004760 return ret == active;
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004761}
Yu Zhaof85876b2009-06-13 15:52:14 +08004762
Mika Westerberg4827d632019-11-12 12:16:16 +03004763/**
4764 * pcie_wait_for_link - Wait until link is active or inactive
4765 * @pdev: Bridge device
4766 * @active: waiting for active or inactive?
4767 *
4768 * Use this to wait till link becomes active or inactive.
4769 */
4770bool pcie_wait_for_link(struct pci_dev *pdev, bool active)
4771{
4772 return pcie_wait_for_link_delay(pdev, active, 100);
4773}
4774
Mika Westerbergad9001f2019-11-12 12:16:17 +03004775/*
4776 * Find maximum D3cold delay required by all the devices on the bus. The
4777 * spec says 100 ms, but firmware can lower it and we allow drivers to
4778 * increase it as well.
4779 *
4780 * Called with @pci_bus_sem locked for reading.
4781 */
4782static int pci_bus_max_d3cold_delay(const struct pci_bus *bus)
4783{
4784 const struct pci_dev *pdev;
4785 int min_delay = 100;
4786 int max_delay = 0;
4787
4788 list_for_each_entry(pdev, &bus->devices, bus_list) {
4789 if (pdev->d3cold_delay < min_delay)
4790 min_delay = pdev->d3cold_delay;
4791 if (pdev->d3cold_delay > max_delay)
4792 max_delay = pdev->d3cold_delay;
4793 }
4794
4795 return max(min_delay, max_delay);
4796}
4797
4798/**
4799 * pci_bridge_wait_for_secondary_bus - Wait for secondary bus to be accessible
4800 * @dev: PCI bridge
4801 *
4802 * Handle necessary delays before access to the devices on the secondary
4803 * side of the bridge are permitted after D3cold to D0 transition.
4804 *
4805 * For PCIe this means the delays in PCIe 5.0 section 6.6.1. For
4806 * conventional PCI it means Tpvrh + Trhfa specified in PCI 3.0 section
4807 * 4.3.2.
4808 */
4809void pci_bridge_wait_for_secondary_bus(struct pci_dev *dev)
4810{
4811 struct pci_dev *child;
4812 int delay;
4813
4814 if (pci_dev_is_disconnected(dev))
4815 return;
4816
4817 if (!pci_is_bridge(dev) || !dev->bridge_d3)
4818 return;
4819
4820 down_read(&pci_bus_sem);
4821
4822 /*
4823 * We only deal with devices that are present currently on the bus.
4824 * For any hot-added devices the access delay is handled in pciehp
4825 * board_added(). In case of ACPI hotplug the firmware is expected
4826 * to configure the devices before OS is notified.
4827 */
4828 if (!dev->subordinate || list_empty(&dev->subordinate->devices)) {
4829 up_read(&pci_bus_sem);
4830 return;
4831 }
4832
4833 /* Take d3cold_delay requirements into account */
4834 delay = pci_bus_max_d3cold_delay(dev->subordinate);
4835 if (!delay) {
4836 up_read(&pci_bus_sem);
4837 return;
4838 }
4839
4840 child = list_first_entry(&dev->subordinate->devices, struct pci_dev,
4841 bus_list);
4842 up_read(&pci_bus_sem);
4843
4844 /*
4845 * Conventional PCI and PCI-X we need to wait Tpvrh + Trhfa before
4846 * accessing the device after reset (that is 1000 ms + 100 ms). In
4847 * practice this should not be needed because we don't do power
4848 * management for them (see pci_bridge_d3_possible()).
4849 */
4850 if (!pci_is_pcie(dev)) {
4851 pci_dbg(dev, "waiting %d ms for secondary bus\n", 1000 + delay);
4852 msleep(1000 + delay);
4853 return;
4854 }
4855
4856 /*
4857 * For PCIe downstream and root ports that do not support speeds
4858 * greater than 5 GT/s need to wait minimum 100 ms. For higher
4859 * speeds (gen3) we need to wait first for the data link layer to
4860 * become active.
4861 *
4862 * However, 100 ms is the minimum and the PCIe spec says the
4863 * software must allow at least 1s before it can determine that the
4864 * device that did not respond is a broken device. There is
4865 * evidence that 100 ms is not always enough, for example certain
4866 * Titan Ridge xHCI controller does not always respond to
4867 * configuration requests if we only wait for 100 ms (see
4868 * https://bugzilla.kernel.org/show_bug.cgi?id=203885).
4869 *
4870 * Therefore we wait for 100 ms and check for the device presence.
4871 * If it is still not present give it an additional 100 ms.
4872 */
4873 if (!pcie_downstream_port(dev))
4874 return;
4875
Bjorn Helgaasd08c30d2020-07-17 17:21:28 -05004876 if (pcie_get_speed_cap(dev) <= PCIE_SPEED_5_0GT) {
4877 pci_dbg(dev, "waiting %d ms for downstream link\n", delay);
4878 msleep(delay);
4879 } else {
4880 pci_dbg(dev, "waiting %d ms for downstream link, after activation\n",
4881 delay);
4882 if (!pcie_wait_for_link_delay(dev, true, delay)) {
Mika Westerbergad9001f2019-11-12 12:16:17 +03004883 /* Did not train, no need to wait any further */
Lukas Wunner8a614492020-09-17 16:13:20 -05004884 pci_info(dev, "Data Link Layer Link Active not set in 1000 msec\n");
Mika Westerbergad9001f2019-11-12 12:16:17 +03004885 return;
4886 }
4887 }
4888
4889 if (!pci_device_is_present(child)) {
4890 pci_dbg(child, "waiting additional %d ms to become accessible\n", delay);
4891 msleep(delay);
4892 }
4893}
4894
Gavin Shan9e330022014-06-19 17:22:44 +10004895void pci_reset_secondary_bus(struct pci_dev *dev)
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004896{
4897 u16 ctrl;
Alex Williamson64e86742013-08-08 14:09:24 -06004898
4899 pci_read_config_word(dev, PCI_BRIDGE_CONTROL, &ctrl);
4900 ctrl |= PCI_BRIDGE_CTL_BUS_RESET;
4901 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
Bjorn Helgaasdf62ab52018-03-09 16:36:33 -06004902
Alex Williamsonde0c5482013-08-08 14:10:13 -06004903 /*
4904 * PCI spec v3.0 7.6.4.2 requires minimum Trst of 1ms. Double
Bjorn Helgaasf7625982013-11-14 11:28:18 -07004905 * this to 2ms to ensure that we meet the minimum requirement.
Alex Williamsonde0c5482013-08-08 14:10:13 -06004906 */
4907 msleep(2);
Alex Williamson64e86742013-08-08 14:09:24 -06004908
4909 ctrl &= ~PCI_BRIDGE_CTL_BUS_RESET;
4910 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
Alex Williamsonde0c5482013-08-08 14:10:13 -06004911
4912 /*
4913 * Trhfa for conventional PCI is 2^25 clock cycles.
4914 * Assuming a minimum 33MHz clock this results in a 1s
4915 * delay before we can consider subordinate devices to
4916 * be re-initialized. PCIe has some ways to shorten this,
4917 * but we don't make use of them yet.
4918 */
4919 ssleep(1);
Alex Williamson64e86742013-08-08 14:09:24 -06004920}
Gavin Shand92a2082014-04-24 18:00:24 +10004921
Gavin Shan9e330022014-06-19 17:22:44 +10004922void __weak pcibios_reset_secondary_bus(struct pci_dev *dev)
4923{
4924 pci_reset_secondary_bus(dev);
4925}
4926
Gavin Shand92a2082014-04-24 18:00:24 +10004927/**
Sinan Kaya381634c2018-07-19 18:04:11 -05004928 * pci_bridge_secondary_bus_reset - Reset the secondary bus on a PCI bridge.
Gavin Shand92a2082014-04-24 18:00:24 +10004929 * @dev: Bridge device
4930 *
4931 * Use the bridge control register to assert reset on the secondary bus.
4932 * Devices on the secondary bus are left in power-on state.
4933 */
Sinan Kaya381634c2018-07-19 18:04:11 -05004934int pci_bridge_secondary_bus_reset(struct pci_dev *dev)
Gavin Shand92a2082014-04-24 18:00:24 +10004935{
4936 pcibios_reset_secondary_bus(dev);
Sinan Kaya01fd61c2018-02-27 14:14:11 -06004937
Sinan Kaya6b2f13512018-02-27 14:14:12 -06004938 return pci_dev_wait(dev, "bus reset", PCIE_RESET_READY_POLL_MS);
Gavin Shand92a2082014-04-24 18:00:24 +10004939}
Dennis Dalessandrobfc45602018-08-31 10:34:14 -07004940EXPORT_SYMBOL_GPL(pci_bridge_secondary_bus_reset);
Alex Williamson64e86742013-08-08 14:09:24 -06004941
4942static int pci_parent_bus_reset(struct pci_dev *dev, int probe)
4943{
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004944 struct pci_dev *pdev;
4945
Alex Williamsonf331a852015-01-15 18:16:04 -06004946 if (pci_is_root_bus(dev->bus) || dev->subordinate ||
4947 !dev->bus->self || dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004948 return -ENOTTY;
4949
4950 list_for_each_entry(pdev, &dev->bus->devices, bus_list)
4951 if (pdev != dev)
4952 return -ENOTTY;
4953
4954 if (probe)
4955 return 0;
4956
Sinan Kaya381634c2018-07-19 18:04:11 -05004957 return pci_bridge_secondary_bus_reset(dev->bus->self);
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004958}
4959
Alex Williamson608c3882013-08-08 14:09:43 -06004960static int pci_reset_hotplug_slot(struct hotplug_slot *hotplug, int probe)
4961{
4962 int rc = -ENOTTY;
4963
Lukas Wunner81c4b5b2018-09-08 09:59:01 +02004964 if (!hotplug || !try_module_get(hotplug->owner))
Alex Williamson608c3882013-08-08 14:09:43 -06004965 return rc;
4966
4967 if (hotplug->ops->reset_slot)
4968 rc = hotplug->ops->reset_slot(hotplug, probe);
4969
Lukas Wunner81c4b5b2018-09-08 09:59:01 +02004970 module_put(hotplug->owner);
Alex Williamson608c3882013-08-08 14:09:43 -06004971
4972 return rc;
4973}
4974
4975static int pci_dev_reset_slot_function(struct pci_dev *dev, int probe)
4976{
Lukas Wunner10791142020-07-21 13:24:51 +02004977 if (dev->multifunction || dev->subordinate || !dev->slot ||
Alex Williamsonf331a852015-01-15 18:16:04 -06004978 dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
Alex Williamson608c3882013-08-08 14:09:43 -06004979 return -ENOTTY;
4980
Alex Williamson608c3882013-08-08 14:09:43 -06004981 return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
4982}
4983
Alex Williamson77cb9852013-08-08 14:09:49 -06004984static void pci_dev_lock(struct pci_dev *dev)
4985{
4986 pci_cfg_access_lock(dev);
4987 /* block PM suspend, driver probe, etc. */
4988 device_lock(&dev->dev);
4989}
4990
Alex Williamson61cf16d2013-12-16 15:14:31 -07004991/* Return 1 on successful lock, 0 on contention */
4992static int pci_dev_trylock(struct pci_dev *dev)
4993{
4994 if (pci_cfg_access_trylock(dev)) {
4995 if (device_trylock(&dev->dev))
4996 return 1;
4997 pci_cfg_access_unlock(dev);
4998 }
4999
5000 return 0;
5001}
5002
Alex Williamson77cb9852013-08-08 14:09:49 -06005003static void pci_dev_unlock(struct pci_dev *dev)
5004{
5005 device_unlock(&dev->dev);
5006 pci_cfg_access_unlock(dev);
5007}
5008
Christoph Hellwig775755e2017-06-01 13:10:38 +02005009static void pci_dev_save_and_disable(struct pci_dev *dev)
Keith Busch3ebe7f92014-05-02 10:40:42 -06005010{
5011 const struct pci_error_handlers *err_handler =
5012 dev->driver ? dev->driver->err_handler : NULL;
Keith Busch3ebe7f92014-05-02 10:40:42 -06005013
Christoph Hellwigb014e962017-06-01 13:10:37 +02005014 /*
Christoph Hellwig775755e2017-06-01 13:10:38 +02005015 * dev->driver->err_handler->reset_prepare() is protected against
Christoph Hellwigb014e962017-06-01 13:10:37 +02005016 * races with ->remove() by the device lock, which must be held by
5017 * the caller.
5018 */
Christoph Hellwig775755e2017-06-01 13:10:38 +02005019 if (err_handler && err_handler->reset_prepare)
5020 err_handler->reset_prepare(dev);
Keith Busch3ebe7f92014-05-02 10:40:42 -06005021
Alex Williamsona6cbaad2013-08-08 14:10:02 -06005022 /*
5023 * Wake-up device prior to save. PM registers default to D0 after
5024 * reset and a simple register restore doesn't reliably return
5025 * to a non-D0 state anyway.
5026 */
5027 pci_set_power_state(dev, PCI_D0);
5028
Alex Williamson77cb9852013-08-08 14:09:49 -06005029 pci_save_state(dev);
5030 /*
5031 * Disable the device by clearing the Command register, except for
5032 * INTx-disable which is set. This not only disables MMIO and I/O port
5033 * BARs, but also prevents the device from being Bus Master, preventing
5034 * DMA from the device including MSI/MSI-X interrupts. For PCI 2.3
5035 * compliant devices, INTx-disable prevents legacy interrupts.
5036 */
5037 pci_write_config_word(dev, PCI_COMMAND, PCI_COMMAND_INTX_DISABLE);
5038}
5039
5040static void pci_dev_restore(struct pci_dev *dev)
5041{
Christoph Hellwig775755e2017-06-01 13:10:38 +02005042 const struct pci_error_handlers *err_handler =
5043 dev->driver ? dev->driver->err_handler : NULL;
5044
Alex Williamson77cb9852013-08-08 14:09:49 -06005045 pci_restore_state(dev);
Alex Williamson77cb9852013-08-08 14:09:49 -06005046
Christoph Hellwig775755e2017-06-01 13:10:38 +02005047 /*
5048 * dev->driver->err_handler->reset_done() is protected against
5049 * races with ->remove() by the device lock, which must be held by
5050 * the caller.
5051 */
5052 if (err_handler && err_handler->reset_done)
5053 err_handler->reset_done(dev);
Sheng Yangd91cdc72008-11-11 17:17:47 +08005054}
Keith Busch3ebe7f92014-05-02 10:40:42 -06005055
Sheng Yangd91cdc72008-11-11 17:17:47 +08005056/**
Konrad Rzeszutek Wilk6fbf9e72012-01-12 12:06:46 -05005057 * __pci_reset_function_locked - reset a PCI device function while holding
5058 * the @dev mutex lock.
5059 * @dev: PCI device to reset
5060 *
5061 * Some devices allow an individual function to be reset without affecting
5062 * other functions in the same device. The PCI device must be responsive
5063 * to PCI config space in order to use this function.
5064 *
5065 * The device function is presumed to be unused and the caller is holding
5066 * the device mutex lock when this function is called.
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005067 *
Konrad Rzeszutek Wilk6fbf9e72012-01-12 12:06:46 -05005068 * Resetting the device will make the contents of PCI configuration space
5069 * random, so any caller of this must be prepared to reinitialise the
5070 * device including MSI, bus mastering, BARs, decoding IO and memory spaces,
5071 * etc.
5072 *
5073 * Returns 0 if the device function was successfully reset or negative if the
5074 * device doesn't support resetting a single function.
5075 */
5076int __pci_reset_function_locked(struct pci_dev *dev)
5077{
Christoph Hellwig52354b92017-06-01 13:10:39 +02005078 int rc;
5079
5080 might_sleep();
5081
Bjorn Helgaas832c418a2017-10-25 17:09:24 -05005082 /*
5083 * A reset method returns -ENOTTY if it doesn't support this device
5084 * and we should try the next method.
5085 *
5086 * If it returns 0 (success), we're finished. If it returns any
5087 * other error, we're also finished: this indicates that further
5088 * reset mechanisms might be broken on the device.
5089 */
Christoph Hellwig52354b92017-06-01 13:10:39 +02005090 rc = pci_dev_specific_reset(dev, 0);
5091 if (rc != -ENOTTY)
5092 return rc;
5093 if (pcie_has_flr(dev)) {
Sinan Kaya91295d72018-02-27 14:14:08 -06005094 rc = pcie_flr(dev);
5095 if (rc != -ENOTTY)
5096 return rc;
Christoph Hellwig52354b92017-06-01 13:10:39 +02005097 }
5098 rc = pci_af_flr(dev, 0);
5099 if (rc != -ENOTTY)
5100 return rc;
5101 rc = pci_pm_reset(dev, 0);
5102 if (rc != -ENOTTY)
5103 return rc;
5104 rc = pci_dev_reset_slot_function(dev, 0);
5105 if (rc != -ENOTTY)
5106 return rc;
5107 return pci_parent_bus_reset(dev, 0);
Konrad Rzeszutek Wilk6fbf9e72012-01-12 12:06:46 -05005108}
5109EXPORT_SYMBOL_GPL(__pci_reset_function_locked);
5110
5111/**
Michael S. Tsirkin711d5772009-07-27 23:37:48 +03005112 * pci_probe_reset_function - check whether the device can be safely reset
5113 * @dev: PCI device to reset
5114 *
5115 * Some devices allow an individual function to be reset without affecting
5116 * other functions in the same device. The PCI device must be responsive
5117 * to PCI config space in order to use this function.
5118 *
5119 * Returns 0 if the device function can be reset or negative if the
5120 * device doesn't support resetting a single function.
5121 */
5122int pci_probe_reset_function(struct pci_dev *dev)
5123{
Christoph Hellwig52354b92017-06-01 13:10:39 +02005124 int rc;
5125
5126 might_sleep();
5127
5128 rc = pci_dev_specific_reset(dev, 1);
5129 if (rc != -ENOTTY)
5130 return rc;
5131 if (pcie_has_flr(dev))
5132 return 0;
5133 rc = pci_af_flr(dev, 1);
5134 if (rc != -ENOTTY)
5135 return rc;
5136 rc = pci_pm_reset(dev, 1);
5137 if (rc != -ENOTTY)
5138 return rc;
5139 rc = pci_dev_reset_slot_function(dev, 1);
5140 if (rc != -ENOTTY)
5141 return rc;
5142
5143 return pci_parent_bus_reset(dev, 1);
Michael S. Tsirkin711d5772009-07-27 23:37:48 +03005144}
5145
5146/**
Yu Zhao8c1c6992009-06-13 15:52:13 +08005147 * pci_reset_function - quiesce and reset a PCI device function
5148 * @dev: PCI device to reset
Sheng Yang8dd7f802008-10-21 17:38:25 +08005149 *
5150 * Some devices allow an individual function to be reset without affecting
5151 * other functions in the same device. The PCI device must be responsive
5152 * to PCI config space in order to use this function.
5153 *
5154 * This function does not just reset the PCI portion of a device, but
5155 * clears all the state associated with the device. This function differs
Jan H. Schönherr79e699b2017-09-06 01:21:23 +02005156 * from __pci_reset_function_locked() in that it saves and restores device state
5157 * over the reset and takes the PCI device lock.
Sheng Yang8dd7f802008-10-21 17:38:25 +08005158 *
Yu Zhao8c1c6992009-06-13 15:52:13 +08005159 * Returns 0 if the device function was successfully reset or negative if the
Sheng Yang8dd7f802008-10-21 17:38:25 +08005160 * device doesn't support resetting a single function.
5161 */
5162int pci_reset_function(struct pci_dev *dev)
5163{
Yu Zhao8c1c6992009-06-13 15:52:13 +08005164 int rc;
Sheng Yang8dd7f802008-10-21 17:38:25 +08005165
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06005166 if (!dev->reset_fn)
5167 return -ENOTTY;
Sheng Yang8dd7f802008-10-21 17:38:25 +08005168
Christoph Hellwigb014e962017-06-01 13:10:37 +02005169 pci_dev_lock(dev);
Alex Williamson77cb9852013-08-08 14:09:49 -06005170 pci_dev_save_and_disable(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08005171
Christoph Hellwig52354b92017-06-01 13:10:39 +02005172 rc = __pci_reset_function_locked(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08005173
Alex Williamson77cb9852013-08-08 14:09:49 -06005174 pci_dev_restore(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02005175 pci_dev_unlock(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08005176
Yu Zhao8c1c6992009-06-13 15:52:13 +08005177 return rc;
Sheng Yang8dd7f802008-10-21 17:38:25 +08005178}
5179EXPORT_SYMBOL_GPL(pci_reset_function);
5180
Alex Williamson61cf16d2013-12-16 15:14:31 -07005181/**
Marc Zyngiera477b9c2017-08-01 20:11:02 -05005182 * pci_reset_function_locked - quiesce and reset a PCI device function
5183 * @dev: PCI device to reset
5184 *
5185 * Some devices allow an individual function to be reset without affecting
5186 * other functions in the same device. The PCI device must be responsive
5187 * to PCI config space in order to use this function.
5188 *
5189 * This function does not just reset the PCI portion of a device, but
5190 * clears all the state associated with the device. This function differs
Jan H. Schönherr79e699b2017-09-06 01:21:23 +02005191 * from __pci_reset_function_locked() in that it saves and restores device state
Marc Zyngiera477b9c2017-08-01 20:11:02 -05005192 * over the reset. It also differs from pci_reset_function() in that it
5193 * requires the PCI device lock to be held.
5194 *
5195 * Returns 0 if the device function was successfully reset or negative if the
5196 * device doesn't support resetting a single function.
5197 */
5198int pci_reset_function_locked(struct pci_dev *dev)
5199{
5200 int rc;
5201
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06005202 if (!dev->reset_fn)
5203 return -ENOTTY;
Marc Zyngiera477b9c2017-08-01 20:11:02 -05005204
5205 pci_dev_save_and_disable(dev);
5206
5207 rc = __pci_reset_function_locked(dev);
5208
5209 pci_dev_restore(dev);
5210
5211 return rc;
5212}
5213EXPORT_SYMBOL_GPL(pci_reset_function_locked);
5214
5215/**
Alex Williamson61cf16d2013-12-16 15:14:31 -07005216 * pci_try_reset_function - quiesce and reset a PCI device function
5217 * @dev: PCI device to reset
5218 *
5219 * Same as above, except return -EAGAIN if unable to lock device.
5220 */
5221int pci_try_reset_function(struct pci_dev *dev)
5222{
5223 int rc;
5224
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06005225 if (!dev->reset_fn)
5226 return -ENOTTY;
Alex Williamson61cf16d2013-12-16 15:14:31 -07005227
Christoph Hellwigb014e962017-06-01 13:10:37 +02005228 if (!pci_dev_trylock(dev))
5229 return -EAGAIN;
Alex Williamson61cf16d2013-12-16 15:14:31 -07005230
Christoph Hellwigb014e962017-06-01 13:10:37 +02005231 pci_dev_save_and_disable(dev);
Christoph Hellwig52354b92017-06-01 13:10:39 +02005232 rc = __pci_reset_function_locked(dev);
Sinan Kayacb5e0d02018-02-27 14:14:08 -06005233 pci_dev_restore(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02005234 pci_dev_unlock(dev);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005235
Alex Williamson61cf16d2013-12-16 15:14:31 -07005236 return rc;
5237}
5238EXPORT_SYMBOL_GPL(pci_try_reset_function);
5239
Alex Williamsonf331a852015-01-15 18:16:04 -06005240/* Do any devices on or below this bus prevent a bus reset? */
5241static bool pci_bus_resetable(struct pci_bus *bus)
5242{
5243 struct pci_dev *dev;
5244
David Daney35702772017-09-08 10:10:31 +02005245
5246 if (bus->self && (bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5247 return false;
5248
Alex Williamsonf331a852015-01-15 18:16:04 -06005249 list_for_each_entry(dev, &bus->devices, bus_list) {
5250 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5251 (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
5252 return false;
5253 }
5254
5255 return true;
5256}
5257
Alex Williamson090a3c52013-08-08 14:09:55 -06005258/* Lock devices from the top of the tree down */
5259static void pci_bus_lock(struct pci_bus *bus)
5260{
5261 struct pci_dev *dev;
5262
5263 list_for_each_entry(dev, &bus->devices, bus_list) {
5264 pci_dev_lock(dev);
5265 if (dev->subordinate)
5266 pci_bus_lock(dev->subordinate);
5267 }
5268}
5269
5270/* Unlock devices from the bottom of the tree up */
5271static void pci_bus_unlock(struct pci_bus *bus)
5272{
5273 struct pci_dev *dev;
5274
5275 list_for_each_entry(dev, &bus->devices, bus_list) {
5276 if (dev->subordinate)
5277 pci_bus_unlock(dev->subordinate);
5278 pci_dev_unlock(dev);
5279 }
5280}
5281
Alex Williamson61cf16d2013-12-16 15:14:31 -07005282/* Return 1 on successful lock, 0 on contention */
5283static int pci_bus_trylock(struct pci_bus *bus)
5284{
5285 struct pci_dev *dev;
5286
5287 list_for_each_entry(dev, &bus->devices, bus_list) {
5288 if (!pci_dev_trylock(dev))
5289 goto unlock;
5290 if (dev->subordinate) {
5291 if (!pci_bus_trylock(dev->subordinate)) {
5292 pci_dev_unlock(dev);
5293 goto unlock;
5294 }
5295 }
5296 }
5297 return 1;
5298
5299unlock:
5300 list_for_each_entry_continue_reverse(dev, &bus->devices, bus_list) {
5301 if (dev->subordinate)
5302 pci_bus_unlock(dev->subordinate);
5303 pci_dev_unlock(dev);
5304 }
5305 return 0;
5306}
5307
Alex Williamsonf331a852015-01-15 18:16:04 -06005308/* Do any devices on or below this slot prevent a bus reset? */
5309static bool pci_slot_resetable(struct pci_slot *slot)
5310{
5311 struct pci_dev *dev;
5312
Jan Glauber33ba90a2017-09-08 10:10:33 +02005313 if (slot->bus->self &&
5314 (slot->bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5315 return false;
5316
Alex Williamsonf331a852015-01-15 18:16:04 -06005317 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5318 if (!dev->slot || dev->slot != slot)
5319 continue;
5320 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5321 (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
5322 return false;
5323 }
5324
5325 return true;
5326}
5327
Alex Williamson090a3c52013-08-08 14:09:55 -06005328/* Lock devices from the top of the tree down */
5329static void pci_slot_lock(struct pci_slot *slot)
5330{
5331 struct pci_dev *dev;
5332
5333 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5334 if (!dev->slot || dev->slot != slot)
5335 continue;
5336 pci_dev_lock(dev);
5337 if (dev->subordinate)
5338 pci_bus_lock(dev->subordinate);
5339 }
5340}
5341
5342/* Unlock devices from the bottom of the tree up */
5343static void pci_slot_unlock(struct pci_slot *slot)
5344{
5345 struct pci_dev *dev;
5346
5347 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5348 if (!dev->slot || dev->slot != slot)
5349 continue;
5350 if (dev->subordinate)
5351 pci_bus_unlock(dev->subordinate);
5352 pci_dev_unlock(dev);
5353 }
5354}
5355
Alex Williamson61cf16d2013-12-16 15:14:31 -07005356/* Return 1 on successful lock, 0 on contention */
5357static int pci_slot_trylock(struct pci_slot *slot)
5358{
5359 struct pci_dev *dev;
5360
5361 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5362 if (!dev->slot || dev->slot != slot)
5363 continue;
5364 if (!pci_dev_trylock(dev))
5365 goto unlock;
5366 if (dev->subordinate) {
5367 if (!pci_bus_trylock(dev->subordinate)) {
5368 pci_dev_unlock(dev);
5369 goto unlock;
5370 }
5371 }
5372 }
5373 return 1;
5374
5375unlock:
5376 list_for_each_entry_continue_reverse(dev,
5377 &slot->bus->devices, bus_list) {
5378 if (!dev->slot || dev->slot != slot)
5379 continue;
5380 if (dev->subordinate)
5381 pci_bus_unlock(dev->subordinate);
5382 pci_dev_unlock(dev);
5383 }
5384 return 0;
5385}
5386
Alex Williamsonddefc032019-02-18 12:46:46 -07005387/*
5388 * Save and disable devices from the top of the tree down while holding
5389 * the @dev mutex lock for the entire tree.
5390 */
5391static void pci_bus_save_and_disable_locked(struct pci_bus *bus)
Alex Williamson090a3c52013-08-08 14:09:55 -06005392{
5393 struct pci_dev *dev;
5394
5395 list_for_each_entry(dev, &bus->devices, bus_list) {
5396 pci_dev_save_and_disable(dev);
5397 if (dev->subordinate)
Alex Williamsonddefc032019-02-18 12:46:46 -07005398 pci_bus_save_and_disable_locked(dev->subordinate);
Alex Williamson090a3c52013-08-08 14:09:55 -06005399 }
5400}
5401
5402/*
Alex Williamsonddefc032019-02-18 12:46:46 -07005403 * Restore devices from top of the tree down while holding @dev mutex lock
5404 * for the entire tree. Parent bridges need to be restored before we can
5405 * get to subordinate devices.
Alex Williamson090a3c52013-08-08 14:09:55 -06005406 */
Alex Williamsonddefc032019-02-18 12:46:46 -07005407static void pci_bus_restore_locked(struct pci_bus *bus)
Alex Williamson090a3c52013-08-08 14:09:55 -06005408{
5409 struct pci_dev *dev;
5410
5411 list_for_each_entry(dev, &bus->devices, bus_list) {
5412 pci_dev_restore(dev);
5413 if (dev->subordinate)
Alex Williamsonddefc032019-02-18 12:46:46 -07005414 pci_bus_restore_locked(dev->subordinate);
Alex Williamson090a3c52013-08-08 14:09:55 -06005415 }
5416}
5417
Alex Williamsonddefc032019-02-18 12:46:46 -07005418/*
5419 * Save and disable devices from the top of the tree down while holding
5420 * the @dev mutex lock for the entire tree.
5421 */
5422static void pci_slot_save_and_disable_locked(struct pci_slot *slot)
Alex Williamson090a3c52013-08-08 14:09:55 -06005423{
5424 struct pci_dev *dev;
5425
5426 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5427 if (!dev->slot || dev->slot != slot)
5428 continue;
5429 pci_dev_save_and_disable(dev);
5430 if (dev->subordinate)
Alex Williamsonddefc032019-02-18 12:46:46 -07005431 pci_bus_save_and_disable_locked(dev->subordinate);
Alex Williamson090a3c52013-08-08 14:09:55 -06005432 }
5433}
5434
5435/*
Alex Williamsonddefc032019-02-18 12:46:46 -07005436 * Restore devices from top of the tree down while holding @dev mutex lock
5437 * for the entire tree. Parent bridges need to be restored before we can
5438 * get to subordinate devices.
Alex Williamson090a3c52013-08-08 14:09:55 -06005439 */
Alex Williamsonddefc032019-02-18 12:46:46 -07005440static void pci_slot_restore_locked(struct pci_slot *slot)
Alex Williamson090a3c52013-08-08 14:09:55 -06005441{
5442 struct pci_dev *dev;
5443
5444 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5445 if (!dev->slot || dev->slot != slot)
5446 continue;
5447 pci_dev_restore(dev);
5448 if (dev->subordinate)
Alex Williamsonddefc032019-02-18 12:46:46 -07005449 pci_bus_restore_locked(dev->subordinate);
Alex Williamson090a3c52013-08-08 14:09:55 -06005450 }
5451}
5452
5453static int pci_slot_reset(struct pci_slot *slot, int probe)
5454{
5455 int rc;
5456
Alex Williamsonf331a852015-01-15 18:16:04 -06005457 if (!slot || !pci_slot_resetable(slot))
Alex Williamson090a3c52013-08-08 14:09:55 -06005458 return -ENOTTY;
5459
5460 if (!probe)
5461 pci_slot_lock(slot);
5462
5463 might_sleep();
5464
5465 rc = pci_reset_hotplug_slot(slot->hotplug, probe);
5466
5467 if (!probe)
5468 pci_slot_unlock(slot);
5469
5470 return rc;
5471}
5472
5473/**
Alex Williamson9a3d2b92013-08-14 14:06:05 -06005474 * pci_probe_reset_slot - probe whether a PCI slot can be reset
5475 * @slot: PCI slot to probe
5476 *
5477 * Return 0 if slot can be reset, negative if a slot reset is not supported.
5478 */
5479int pci_probe_reset_slot(struct pci_slot *slot)
5480{
5481 return pci_slot_reset(slot, 1);
5482}
5483EXPORT_SYMBOL_GPL(pci_probe_reset_slot);
5484
5485/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005486 * __pci_reset_slot - Try to reset a PCI slot
Alex Williamson090a3c52013-08-08 14:09:55 -06005487 * @slot: PCI slot to reset
5488 *
5489 * A PCI bus may host multiple slots, each slot may support a reset mechanism
5490 * independent of other slots. For instance, some slots may support slot power
5491 * control. In the case of a 1:1 bus to slot architecture, this function may
5492 * wrap the bus reset to avoid spurious slot related events such as hotplug.
5493 * Generally a slot reset should be attempted before a bus reset. All of the
5494 * function of the slot and any subordinate buses behind the slot are reset
5495 * through this function. PCI config space of all devices in the slot and
5496 * behind the slot is saved before and restored after reset.
5497 *
Alex Williamson61cf16d2013-12-16 15:14:31 -07005498 * Same as above except return -EAGAIN if the slot cannot be locked
5499 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005500static int __pci_reset_slot(struct pci_slot *slot)
Alex Williamson61cf16d2013-12-16 15:14:31 -07005501{
5502 int rc;
5503
5504 rc = pci_slot_reset(slot, 1);
5505 if (rc)
5506 return rc;
5507
Alex Williamson61cf16d2013-12-16 15:14:31 -07005508 if (pci_slot_trylock(slot)) {
Alex Williamsonddefc032019-02-18 12:46:46 -07005509 pci_slot_save_and_disable_locked(slot);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005510 might_sleep();
5511 rc = pci_reset_hotplug_slot(slot->hotplug, 0);
Alex Williamsonddefc032019-02-18 12:46:46 -07005512 pci_slot_restore_locked(slot);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005513 pci_slot_unlock(slot);
5514 } else
5515 rc = -EAGAIN;
5516
Alex Williamson61cf16d2013-12-16 15:14:31 -07005517 return rc;
5518}
Alex Williamson61cf16d2013-12-16 15:14:31 -07005519
Alex Williamson090a3c52013-08-08 14:09:55 -06005520static int pci_bus_reset(struct pci_bus *bus, int probe)
5521{
Sinan Kaya18426232018-07-19 18:04:09 -05005522 int ret;
5523
Alex Williamsonf331a852015-01-15 18:16:04 -06005524 if (!bus->self || !pci_bus_resetable(bus))
Alex Williamson090a3c52013-08-08 14:09:55 -06005525 return -ENOTTY;
5526
5527 if (probe)
5528 return 0;
5529
5530 pci_bus_lock(bus);
5531
5532 might_sleep();
5533
Sinan Kaya381634c2018-07-19 18:04:11 -05005534 ret = pci_bridge_secondary_bus_reset(bus->self);
Alex Williamson090a3c52013-08-08 14:09:55 -06005535
5536 pci_bus_unlock(bus);
5537
Sinan Kaya18426232018-07-19 18:04:09 -05005538 return ret;
Alex Williamson090a3c52013-08-08 14:09:55 -06005539}
5540
5541/**
Keith Buschc4eed622018-09-20 10:27:11 -06005542 * pci_bus_error_reset - reset the bridge's subordinate bus
5543 * @bridge: The parent device that connects to the bus to reset
5544 *
5545 * This function will first try to reset the slots on this bus if the method is
5546 * available. If slot reset fails or is not available, this will fall back to a
5547 * secondary bus reset.
5548 */
5549int pci_bus_error_reset(struct pci_dev *bridge)
5550{
5551 struct pci_bus *bus = bridge->subordinate;
5552 struct pci_slot *slot;
5553
5554 if (!bus)
5555 return -ENOTTY;
5556
5557 mutex_lock(&pci_slot_mutex);
5558 if (list_empty(&bus->slots))
5559 goto bus_reset;
5560
5561 list_for_each_entry(slot, &bus->slots, list)
5562 if (pci_probe_reset_slot(slot))
5563 goto bus_reset;
5564
5565 list_for_each_entry(slot, &bus->slots, list)
5566 if (pci_slot_reset(slot, 0))
5567 goto bus_reset;
5568
5569 mutex_unlock(&pci_slot_mutex);
5570 return 0;
5571bus_reset:
5572 mutex_unlock(&pci_slot_mutex);
5573 return pci_bus_reset(bridge->subordinate, 0);
5574}
5575
5576/**
Alex Williamson9a3d2b92013-08-14 14:06:05 -06005577 * pci_probe_reset_bus - probe whether a PCI bus can be reset
5578 * @bus: PCI bus to probe
5579 *
5580 * Return 0 if bus can be reset, negative if a bus reset is not supported.
5581 */
5582int pci_probe_reset_bus(struct pci_bus *bus)
5583{
5584 return pci_bus_reset(bus, 1);
5585}
5586EXPORT_SYMBOL_GPL(pci_probe_reset_bus);
5587
5588/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005589 * __pci_reset_bus - Try to reset a PCI bus
Alex Williamson61cf16d2013-12-16 15:14:31 -07005590 * @bus: top level PCI bus to reset
5591 *
5592 * Same as above except return -EAGAIN if the bus cannot be locked
5593 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005594static int __pci_reset_bus(struct pci_bus *bus)
Alex Williamson61cf16d2013-12-16 15:14:31 -07005595{
5596 int rc;
5597
5598 rc = pci_bus_reset(bus, 1);
5599 if (rc)
5600 return rc;
5601
Alex Williamson61cf16d2013-12-16 15:14:31 -07005602 if (pci_bus_trylock(bus)) {
Alex Williamsonddefc032019-02-18 12:46:46 -07005603 pci_bus_save_and_disable_locked(bus);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005604 might_sleep();
Sinan Kaya381634c2018-07-19 18:04:11 -05005605 rc = pci_bridge_secondary_bus_reset(bus->self);
Alex Williamsonddefc032019-02-18 12:46:46 -07005606 pci_bus_restore_locked(bus);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005607 pci_bus_unlock(bus);
5608 } else
5609 rc = -EAGAIN;
5610
Alex Williamson61cf16d2013-12-16 15:14:31 -07005611 return rc;
5612}
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005613
5614/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005615 * pci_reset_bus - Try to reset a PCI bus
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005616 * @pdev: top level PCI device to reset via slot/bus
5617 *
5618 * Same as above except return -EAGAIN if the bus cannot be locked
5619 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005620int pci_reset_bus(struct pci_dev *pdev)
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005621{
Dennis Dalessandrod8a52812018-09-05 16:08:03 +00005622 return (!pci_probe_reset_slot(pdev->slot)) ?
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005623 __pci_reset_slot(pdev->slot) : __pci_reset_bus(pdev->bus);
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005624}
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005625EXPORT_SYMBOL_GPL(pci_reset_bus);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005626
5627/**
Peter Orubad556ad42007-05-15 13:59:13 +02005628 * pcix_get_max_mmrbc - get PCI-X maximum designed memory read byte count
5629 * @dev: PCI device to query
5630 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005631 * Returns mmrbc: maximum designed memory read count in bytes or
5632 * appropriate error value.
Peter Orubad556ad42007-05-15 13:59:13 +02005633 */
5634int pcix_get_max_mmrbc(struct pci_dev *dev)
5635{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005636 int cap;
Peter Orubad556ad42007-05-15 13:59:13 +02005637 u32 stat;
5638
5639 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5640 if (!cap)
5641 return -EINVAL;
5642
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005643 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
Peter Orubad556ad42007-05-15 13:59:13 +02005644 return -EINVAL;
5645
Dean Nelson25daeb52010-03-09 22:26:40 -05005646 return 512 << ((stat & PCI_X_STATUS_MAX_READ) >> 21);
Peter Orubad556ad42007-05-15 13:59:13 +02005647}
5648EXPORT_SYMBOL(pcix_get_max_mmrbc);
5649
5650/**
5651 * pcix_get_mmrbc - get PCI-X maximum memory read byte count
5652 * @dev: PCI device to query
5653 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005654 * Returns mmrbc: maximum memory read count in bytes or appropriate error
5655 * value.
Peter Orubad556ad42007-05-15 13:59:13 +02005656 */
5657int pcix_get_mmrbc(struct pci_dev *dev)
5658{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005659 int cap;
Dean Nelsonbdc2bda2010-03-09 22:26:48 -05005660 u16 cmd;
Peter Orubad556ad42007-05-15 13:59:13 +02005661
5662 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5663 if (!cap)
5664 return -EINVAL;
5665
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005666 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5667 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005668
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005669 return 512 << ((cmd & PCI_X_CMD_MAX_READ) >> 2);
Peter Orubad556ad42007-05-15 13:59:13 +02005670}
5671EXPORT_SYMBOL(pcix_get_mmrbc);
5672
5673/**
5674 * pcix_set_mmrbc - set PCI-X maximum memory read byte count
5675 * @dev: PCI device to query
5676 * @mmrbc: maximum memory read count in bytes
5677 * valid values are 512, 1024, 2048, 4096
5678 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005679 * If possible sets maximum memory read byte count, some bridges have errata
Peter Orubad556ad42007-05-15 13:59:13 +02005680 * that prevent this.
5681 */
5682int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc)
5683{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005684 int cap;
Dean Nelsonbdc2bda2010-03-09 22:26:48 -05005685 u32 stat, v, o;
5686 u16 cmd;
Peter Orubad556ad42007-05-15 13:59:13 +02005687
vignesh babu229f5af2007-08-13 18:23:14 +05305688 if (mmrbc < 512 || mmrbc > 4096 || !is_power_of_2(mmrbc))
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005689 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005690
5691 v = ffs(mmrbc) - 10;
5692
5693 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5694 if (!cap)
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005695 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005696
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005697 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
5698 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005699
5700 if (v > (stat & PCI_X_STATUS_MAX_READ) >> 21)
5701 return -E2BIG;
5702
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005703 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5704 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005705
5706 o = (cmd & PCI_X_CMD_MAX_READ) >> 2;
5707 if (o != v) {
Bjorn Helgaas809a3bf2012-06-20 16:41:16 -06005708 if (v > o && (dev->bus->bus_flags & PCI_BUS_FLAGS_NO_MMRBC))
Peter Orubad556ad42007-05-15 13:59:13 +02005709 return -EIO;
5710
5711 cmd &= ~PCI_X_CMD_MAX_READ;
5712 cmd |= v << 2;
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005713 if (pci_write_config_word(dev, cap + PCI_X_CMD, cmd))
5714 return -EIO;
Peter Orubad556ad42007-05-15 13:59:13 +02005715 }
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005716 return 0;
Peter Orubad556ad42007-05-15 13:59:13 +02005717}
5718EXPORT_SYMBOL(pcix_set_mmrbc);
5719
5720/**
5721 * pcie_get_readrq - get PCI Express read request size
5722 * @dev: PCI device to query
5723 *
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005724 * Returns maximum memory read request in bytes or appropriate error value.
Peter Orubad556ad42007-05-15 13:59:13 +02005725 */
5726int pcie_get_readrq(struct pci_dev *dev)
5727{
Peter Orubad556ad42007-05-15 13:59:13 +02005728 u16 ctl;
5729
Jiang Liu59875ae2012-07-24 17:20:06 +08005730 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
Peter Orubad556ad42007-05-15 13:59:13 +02005731
Jiang Liu59875ae2012-07-24 17:20:06 +08005732 return 128 << ((ctl & PCI_EXP_DEVCTL_READRQ) >> 12);
Peter Orubad556ad42007-05-15 13:59:13 +02005733}
5734EXPORT_SYMBOL(pcie_get_readrq);
5735
5736/**
5737 * pcie_set_readrq - set PCI Express maximum memory read request
5738 * @dev: PCI device to query
Randy Dunlap42e61f4a2007-07-23 21:42:11 -07005739 * @rq: maximum memory read count in bytes
Peter Orubad556ad42007-05-15 13:59:13 +02005740 * valid values are 128, 256, 512, 1024, 2048, 4096
5741 *
Jon Masonc9b378c2011-06-28 18:26:25 -05005742 * If possible sets maximum memory read request in bytes
Peter Orubad556ad42007-05-15 13:59:13 +02005743 */
5744int pcie_set_readrq(struct pci_dev *dev, int rq)
5745{
Jiang Liu59875ae2012-07-24 17:20:06 +08005746 u16 v;
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005747 int ret;
Peter Orubad556ad42007-05-15 13:59:13 +02005748
vignesh babu229f5af2007-08-13 18:23:14 +05305749 if (rq < 128 || rq > 4096 || !is_power_of_2(rq))
Jiang Liu59875ae2012-07-24 17:20:06 +08005750 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005751
Benjamin Herrenschmidta1c473a2011-10-14 14:56:15 -05005752 /*
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06005753 * If using the "performance" PCIe config, we clamp the read rq
5754 * size to the max packet size to keep the host bridge from
5755 * generating requests larger than we can cope with.
Benjamin Herrenschmidta1c473a2011-10-14 14:56:15 -05005756 */
5757 if (pcie_bus_config == PCIE_BUS_PERFORMANCE) {
5758 int mps = pcie_get_mps(dev);
5759
Benjamin Herrenschmidta1c473a2011-10-14 14:56:15 -05005760 if (mps < rq)
5761 rq = mps;
5762 }
5763
5764 v = (ffs(rq) - 8) << 12;
Peter Orubad556ad42007-05-15 13:59:13 +02005765
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005766 ret = pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
Jiang Liu59875ae2012-07-24 17:20:06 +08005767 PCI_EXP_DEVCTL_READRQ, v);
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005768
5769 return pcibios_err_to_errno(ret);
Peter Orubad556ad42007-05-15 13:59:13 +02005770}
5771EXPORT_SYMBOL(pcie_set_readrq);
5772
5773/**
Jon Masonb03e7492011-07-20 15:20:54 -05005774 * pcie_get_mps - get PCI Express maximum payload size
5775 * @dev: PCI device to query
5776 *
5777 * Returns maximum payload size in bytes
Jon Masonb03e7492011-07-20 15:20:54 -05005778 */
5779int pcie_get_mps(struct pci_dev *dev)
5780{
Jon Masonb03e7492011-07-20 15:20:54 -05005781 u16 ctl;
5782
Jiang Liu59875ae2012-07-24 17:20:06 +08005783 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
Jon Masonb03e7492011-07-20 15:20:54 -05005784
Jiang Liu59875ae2012-07-24 17:20:06 +08005785 return 128 << ((ctl & PCI_EXP_DEVCTL_PAYLOAD) >> 5);
Jon Masonb03e7492011-07-20 15:20:54 -05005786}
Yijing Wangf1c66c42013-09-24 12:08:06 -06005787EXPORT_SYMBOL(pcie_get_mps);
Jon Masonb03e7492011-07-20 15:20:54 -05005788
5789/**
5790 * pcie_set_mps - set PCI Express maximum payload size
5791 * @dev: PCI device to query
Randy Dunlap47c08f32011-08-20 11:49:43 -07005792 * @mps: maximum payload size in bytes
Jon Masonb03e7492011-07-20 15:20:54 -05005793 * valid values are 128, 256, 512, 1024, 2048, 4096
5794 *
5795 * If possible sets maximum payload size
5796 */
5797int pcie_set_mps(struct pci_dev *dev, int mps)
5798{
Jiang Liu59875ae2012-07-24 17:20:06 +08005799 u16 v;
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005800 int ret;
Jon Masonb03e7492011-07-20 15:20:54 -05005801
5802 if (mps < 128 || mps > 4096 || !is_power_of_2(mps))
Jiang Liu59875ae2012-07-24 17:20:06 +08005803 return -EINVAL;
Jon Masonb03e7492011-07-20 15:20:54 -05005804
5805 v = ffs(mps) - 8;
Bjorn Helgaasf7625982013-11-14 11:28:18 -07005806 if (v > dev->pcie_mpss)
Jiang Liu59875ae2012-07-24 17:20:06 +08005807 return -EINVAL;
Jon Masonb03e7492011-07-20 15:20:54 -05005808 v <<= 5;
5809
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005810 ret = pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
Jiang Liu59875ae2012-07-24 17:20:06 +08005811 PCI_EXP_DEVCTL_PAYLOAD, v);
Bolarinwa Olayemi Saheedd20df832020-06-15 09:32:18 +02005812
5813 return pcibios_err_to_errno(ret);
Jon Masonb03e7492011-07-20 15:20:54 -05005814}
Yijing Wangf1c66c42013-09-24 12:08:06 -06005815EXPORT_SYMBOL(pcie_set_mps);
Jon Masonb03e7492011-07-20 15:20:54 -05005816
5817/**
Tal Gilboa6db79a82018-03-30 08:37:44 -05005818 * pcie_bandwidth_available - determine minimum link settings of a PCIe
5819 * device and its bandwidth limitation
5820 * @dev: PCI device to query
5821 * @limiting_dev: storage for device causing the bandwidth limitation
5822 * @speed: storage for speed of limiting device
5823 * @width: storage for width of limiting device
5824 *
5825 * Walk up the PCI device chain and find the point where the minimum
5826 * bandwidth is available. Return the bandwidth available there and (if
5827 * limiting_dev, speed, and width pointers are supplied) information about
5828 * that point. The bandwidth returned is in Mb/s, i.e., megabits/second of
5829 * raw bandwidth.
5830 */
5831u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
5832 enum pci_bus_speed *speed,
5833 enum pcie_link_width *width)
5834{
5835 u16 lnksta;
5836 enum pci_bus_speed next_speed;
5837 enum pcie_link_width next_width;
5838 u32 bw, next_bw;
5839
5840 if (speed)
5841 *speed = PCI_SPEED_UNKNOWN;
5842 if (width)
5843 *width = PCIE_LNK_WIDTH_UNKNOWN;
5844
5845 bw = 0;
5846
5847 while (dev) {
5848 pcie_capability_read_word(dev, PCI_EXP_LNKSTA, &lnksta);
5849
5850 next_speed = pcie_link_speed[lnksta & PCI_EXP_LNKSTA_CLS];
5851 next_width = (lnksta & PCI_EXP_LNKSTA_NLW) >>
5852 PCI_EXP_LNKSTA_NLW_SHIFT;
5853
5854 next_bw = next_width * PCIE_SPEED2MBS_ENC(next_speed);
5855
5856 /* Check if current device limits the total bandwidth */
5857 if (!bw || next_bw <= bw) {
5858 bw = next_bw;
5859
5860 if (limiting_dev)
5861 *limiting_dev = dev;
5862 if (speed)
5863 *speed = next_speed;
5864 if (width)
5865 *width = next_width;
5866 }
5867
5868 dev = pci_upstream_bridge(dev);
5869 }
5870
5871 return bw;
5872}
5873EXPORT_SYMBOL(pcie_bandwidth_available);
5874
5875/**
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005876 * pcie_get_speed_cap - query for the PCI device's link speed capability
5877 * @dev: PCI device to query
5878 *
5879 * Query the PCI device speed capability. Return the maximum link speed
5880 * supported by the device.
5881 */
5882enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev)
5883{
5884 u32 lnkcap2, lnkcap;
5885
5886 /*
Mikulas Patockaf1f90e22018-11-26 10:37:13 -06005887 * Link Capabilities 2 was added in PCIe r3.0, sec 7.8.18. The
5888 * implementation note there recommends using the Supported Link
5889 * Speeds Vector in Link Capabilities 2 when supported.
5890 *
5891 * Without Link Capabilities 2, i.e., prior to PCIe r3.0, software
5892 * should use the Supported Link Speeds field in Link Capabilities,
5893 * where only 2.5 GT/s and 5.0 GT/s speeds were defined.
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005894 */
5895 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP2, &lnkcap2);
Yicong Yang757bfaa2020-02-17 19:13:03 +08005896
5897 /* PCIe r3.0-compliant */
5898 if (lnkcap2)
5899 return PCIE_LNKCAP2_SLS2SPEED(lnkcap2);
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005900
5901 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
Mikulas Patockaf1f90e22018-11-26 10:37:13 -06005902 if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_5_0GB)
5903 return PCIE_SPEED_5_0GT;
5904 else if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_2_5GB)
5905 return PCIE_SPEED_2_5GT;
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005906
5907 return PCI_SPEED_UNKNOWN;
5908}
Alex Deucher576c7212018-06-25 13:17:41 -05005909EXPORT_SYMBOL(pcie_get_speed_cap);
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005910
5911/**
Tal Gilboac70b65f2018-03-30 08:24:36 -05005912 * pcie_get_width_cap - query for the PCI device's link width capability
5913 * @dev: PCI device to query
5914 *
5915 * Query the PCI device width capability. Return the maximum link width
5916 * supported by the device.
5917 */
5918enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev)
5919{
5920 u32 lnkcap;
5921
5922 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
5923 if (lnkcap)
5924 return (lnkcap & PCI_EXP_LNKCAP_MLW) >> 4;
5925
5926 return PCIE_LNK_WIDTH_UNKNOWN;
5927}
Alex Deucher576c7212018-06-25 13:17:41 -05005928EXPORT_SYMBOL(pcie_get_width_cap);
Tal Gilboac70b65f2018-03-30 08:24:36 -05005929
5930/**
Tal Gilboab852f632018-03-30 08:32:03 -05005931 * pcie_bandwidth_capable - calculate a PCI device's link bandwidth capability
5932 * @dev: PCI device
5933 * @speed: storage for link speed
5934 * @width: storage for link width
5935 *
5936 * Calculate a PCI device's link bandwidth by querying for its link speed
5937 * and width, multiplying them, and applying encoding overhead. The result
5938 * is in Mb/s, i.e., megabits/second of raw bandwidth.
5939 */
5940u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
5941 enum pcie_link_width *width)
5942{
5943 *speed = pcie_get_speed_cap(dev);
5944 *width = pcie_get_width_cap(dev);
5945
5946 if (*speed == PCI_SPEED_UNKNOWN || *width == PCIE_LNK_WIDTH_UNKNOWN)
5947 return 0;
5948
5949 return *width * PCIE_SPEED2MBS_ENC(*speed);
5950}
5951
5952/**
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005953 * __pcie_print_link_status - Report the PCI device's link speed and width
Tal Gilboa9e506a72018-03-30 08:56:47 -05005954 * @dev: PCI device to query
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005955 * @verbose: Print info even when enough bandwidth is available
Tal Gilboa9e506a72018-03-30 08:56:47 -05005956 *
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005957 * If the available bandwidth at the device is less than the device is
5958 * capable of, report the device's maximum possible bandwidth and the
5959 * upstream link that limits its performance. If @verbose, always print
5960 * the available bandwidth, even if the device isn't constrained.
Tal Gilboa9e506a72018-03-30 08:56:47 -05005961 */
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005962void __pcie_print_link_status(struct pci_dev *dev, bool verbose)
Tal Gilboa9e506a72018-03-30 08:56:47 -05005963{
5964 enum pcie_link_width width, width_cap;
5965 enum pci_bus_speed speed, speed_cap;
5966 struct pci_dev *limiting_dev = NULL;
5967 u32 bw_avail, bw_cap;
5968
5969 bw_cap = pcie_bandwidth_capable(dev, &speed_cap, &width_cap);
5970 bw_avail = pcie_bandwidth_available(dev, &limiting_dev, &speed, &width);
5971
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005972 if (bw_avail >= bw_cap && verbose)
Jakub Kicinski0cf22d62018-04-20 12:56:36 -05005973 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth (%s x%d link)\n",
Tal Gilboa9e506a72018-03-30 08:56:47 -05005974 bw_cap / 1000, bw_cap % 1000,
Bjorn Helgaas6348a342020-02-28 15:24:52 -06005975 pci_speed_string(speed_cap), width_cap);
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005976 else if (bw_avail < bw_cap)
Jakub Kicinski0cf22d62018-04-20 12:56:36 -05005977 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth, limited by %s x%d link at %s (capable of %u.%03u Gb/s with %s x%d link)\n",
Tal Gilboa9e506a72018-03-30 08:56:47 -05005978 bw_avail / 1000, bw_avail % 1000,
Bjorn Helgaas6348a342020-02-28 15:24:52 -06005979 pci_speed_string(speed), width,
Tal Gilboa9e506a72018-03-30 08:56:47 -05005980 limiting_dev ? pci_name(limiting_dev) : "<unknown>",
5981 bw_cap / 1000, bw_cap % 1000,
Bjorn Helgaas6348a342020-02-28 15:24:52 -06005982 pci_speed_string(speed_cap), width_cap);
Tal Gilboa9e506a72018-03-30 08:56:47 -05005983}
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005984
5985/**
5986 * pcie_print_link_status - Report the PCI device's link speed and width
5987 * @dev: PCI device to query
5988 *
5989 * Report the available bandwidth at the device.
5990 */
5991void pcie_print_link_status(struct pci_dev *dev)
5992{
5993 __pcie_print_link_status(dev, true);
5994}
Tal Gilboa9e506a72018-03-30 08:56:47 -05005995EXPORT_SYMBOL(pcie_print_link_status);
5996
5997/**
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09005998 * pci_select_bars - Make BAR mask from the type of resource
Randy Dunlapf95d8822007-02-10 14:41:56 -08005999 * @dev: the PCI device for which BAR mask is made
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09006000 * @flags: resource type mask to be selected
6001 *
6002 * This helper routine makes bar mask from the type of resource.
6003 */
6004int pci_select_bars(struct pci_dev *dev, unsigned long flags)
6005{
6006 int i, bars = 0;
6007 for (i = 0; i < PCI_NUM_RESOURCES; i++)
6008 if (pci_resource_flags(dev, i) & flags)
6009 bars |= (1 << i);
6010 return bars;
6011}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06006012EXPORT_SYMBOL(pci_select_bars);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09006013
Mike Travis95a8b6e2010-02-02 14:38:13 -08006014/* Some architectures require additional programming to enable VGA */
6015static arch_set_vga_state_t arch_set_vga_state;
6016
6017void __init pci_register_set_vga_state(arch_set_vga_state_t func)
6018{
6019 arch_set_vga_state = func; /* NULL disables */
6020}
6021
6022static int pci_set_vga_state_arch(struct pci_dev *dev, bool decode,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04006023 unsigned int command_bits, u32 flags)
Mike Travis95a8b6e2010-02-02 14:38:13 -08006024{
6025 if (arch_set_vga_state)
6026 return arch_set_vga_state(dev, decode, command_bits,
Dave Airlie7ad35cf2011-05-25 14:00:49 +10006027 flags);
Mike Travis95a8b6e2010-02-02 14:38:13 -08006028 return 0;
6029}
6030
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006031/**
6032 * pci_set_vga_state - set VGA decode state on device and parents if requested
Randy Dunlap19eea632009-09-17 15:28:22 -07006033 * @dev: the PCI device
6034 * @decode: true = enable decoding, false = disable decoding
6035 * @command_bits: PCI_COMMAND_IO and/or PCI_COMMAND_MEMORY
Randy Dunlap3f37d622011-05-25 19:21:25 -07006036 * @flags: traverse ancestors and change bridges
Dave Airlie3448a192010-06-01 15:32:24 +10006037 * CHANGE_BRIDGE_ONLY / CHANGE_BRIDGE
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006038 */
6039int pci_set_vga_state(struct pci_dev *dev, bool decode,
Dave Airlie3448a192010-06-01 15:32:24 +10006040 unsigned int command_bits, u32 flags)
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006041{
6042 struct pci_bus *bus;
6043 struct pci_dev *bridge;
6044 u16 cmd;
Mike Travis95a8b6e2010-02-02 14:38:13 -08006045 int rc;
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006046
Bjorn Helgaas67ebd812014-04-05 15:14:22 -06006047 WARN_ON((flags & PCI_VGA_STATE_CHANGE_DECODES) && (command_bits & ~(PCI_COMMAND_IO|PCI_COMMAND_MEMORY)));
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006048
Mike Travis95a8b6e2010-02-02 14:38:13 -08006049 /* ARCH specific VGA enables */
Dave Airlie3448a192010-06-01 15:32:24 +10006050 rc = pci_set_vga_state_arch(dev, decode, command_bits, flags);
Mike Travis95a8b6e2010-02-02 14:38:13 -08006051 if (rc)
6052 return rc;
6053
Dave Airlie3448a192010-06-01 15:32:24 +10006054 if (flags & PCI_VGA_STATE_CHANGE_DECODES) {
6055 pci_read_config_word(dev, PCI_COMMAND, &cmd);
Krzysztof Wilczyński0a98bb92020-09-25 22:45:55 +00006056 if (decode)
Dave Airlie3448a192010-06-01 15:32:24 +10006057 cmd |= command_bits;
6058 else
6059 cmd &= ~command_bits;
6060 pci_write_config_word(dev, PCI_COMMAND, cmd);
6061 }
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006062
Dave Airlie3448a192010-06-01 15:32:24 +10006063 if (!(flags & PCI_VGA_STATE_CHANGE_BRIDGE))
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006064 return 0;
6065
6066 bus = dev->bus;
6067 while (bus) {
6068 bridge = bus->self;
6069 if (bridge) {
6070 pci_read_config_word(bridge, PCI_BRIDGE_CONTROL,
6071 &cmd);
Krzysztof Wilczyński0a98bb92020-09-25 22:45:55 +00006072 if (decode)
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10006073 cmd |= PCI_BRIDGE_CTL_VGA;
6074 else
6075 cmd &= ~PCI_BRIDGE_CTL_VGA;
6076 pci_write_config_word(bridge, PCI_BRIDGE_CONTROL,
6077 cmd);
6078 }
6079 bus = bus->parent;
6080 }
6081 return 0;
6082}
6083
Kai-Heng Feng52525b72019-10-18 15:38:47 +08006084#ifdef CONFIG_ACPI
6085bool pci_pr3_present(struct pci_dev *pdev)
6086{
6087 struct acpi_device *adev;
6088
6089 if (acpi_disabled)
6090 return false;
6091
6092 adev = ACPI_COMPANION(&pdev->dev);
6093 if (!adev)
6094 return false;
6095
6096 return adev->power.flags.power_resources &&
6097 acpi_has_method(adev->handle, "_PR3");
6098}
6099EXPORT_SYMBOL_GPL(pci_pr3_present);
6100#endif
6101
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06006102/**
6103 * pci_add_dma_alias - Add a DMA devfn alias for a device
6104 * @dev: the PCI device for which alias is added
James Sewart09298542019-12-10 16:07:30 -06006105 * @devfn_from: alias slot and function
6106 * @nr_devfns: number of subsequent devfns to alias
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06006107 *
Logan Gunthorpef778a0d2018-05-30 14:13:11 -06006108 * This helper encodes an 8-bit devfn as a bit number in dma_alias_mask
6109 * which is used to program permissible bus-devfn source addresses for DMA
6110 * requests in an IOMMU. These aliases factor into IOMMU group creation
6111 * and are useful for devices generating DMA requests beyond or different
6112 * from their logical bus-devfn. Examples include device quirks where the
6113 * device simply uses the wrong devfn, as well as non-transparent bridges
6114 * where the alias may be a proxy for devices in another domain.
6115 *
6116 * IOMMU group creation is performed during device discovery or addition,
6117 * prior to any potential DMA mapping and therefore prior to driver probing
6118 * (especially for userspace assigned devices where IOMMU group definition
6119 * cannot be left as a userspace activity). DMA aliases should therefore
6120 * be configured via quirks, such as the PCI fixup header quirk.
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06006121 */
James Sewart09298542019-12-10 16:07:30 -06006122void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from, unsigned nr_devfns)
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06006123{
James Sewart09298542019-12-10 16:07:30 -06006124 int devfn_to;
6125
6126 nr_devfns = min(nr_devfns, (unsigned) MAX_NR_DEVFNS - devfn_from);
6127 devfn_to = devfn_from + nr_devfns - 1;
6128
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01006129 if (!dev->dma_alias_mask)
James Sewartf8bf2ae2019-12-10 15:51:33 -06006130 dev->dma_alias_mask = bitmap_zalloc(MAX_NR_DEVFNS, GFP_KERNEL);
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01006131 if (!dev->dma_alias_mask) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06006132 pci_warn(dev, "Unable to allocate DMA alias mask\n");
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01006133 return;
6134 }
6135
James Sewart09298542019-12-10 16:07:30 -06006136 bitmap_set(dev->dma_alias_mask, devfn_from, nr_devfns);
6137
6138 if (nr_devfns == 1)
6139 pci_info(dev, "Enabling fixed DMA alias to %02x.%d\n",
6140 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from));
6141 else if (nr_devfns > 1)
6142 pci_info(dev, "Enabling fixed DMA alias for devfn range from %02x.%d to %02x.%d\n",
6143 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from),
6144 PCI_SLOT(devfn_to), PCI_FUNC(devfn_to));
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06006145}
6146
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01006147bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2)
6148{
6149 return (dev1->dma_alias_mask &&
6150 test_bit(dev2->devfn, dev1->dma_alias_mask)) ||
6151 (dev2->dma_alias_mask &&
Jon Derrick2856ba62020-01-21 06:37:47 -07006152 test_bit(dev1->devfn, dev2->dma_alias_mask)) ||
6153 pci_real_dma_dev(dev1) == dev2 ||
6154 pci_real_dma_dev(dev2) == dev1;
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01006155}
6156
Rafael J. Wysocki8496e852013-12-01 02:34:37 +01006157bool pci_device_is_present(struct pci_dev *pdev)
6158{
6159 u32 v;
6160
Keith Buschfe2bd752017-03-29 22:49:17 -05006161 if (pci_dev_is_disconnected(pdev))
6162 return false;
Rafael J. Wysocki8496e852013-12-01 02:34:37 +01006163 return pci_bus_read_dev_vendor_id(pdev->bus, pdev->devfn, &v, 0);
6164}
6165EXPORT_SYMBOL_GPL(pci_device_is_present);
6166
Rafael J. Wysocki08249652015-04-13 16:23:36 +02006167void pci_ignore_hotplug(struct pci_dev *dev)
6168{
6169 struct pci_dev *bridge = dev->bus->self;
6170
6171 dev->ignore_hotplug = 1;
6172 /* Propagate the "ignore hotplug" setting to the parent bridge. */
6173 if (bridge)
6174 bridge->ignore_hotplug = 1;
6175}
6176EXPORT_SYMBOL_GPL(pci_ignore_hotplug);
6177
Jon Derrick2856ba62020-01-21 06:37:47 -07006178/**
6179 * pci_real_dma_dev - Get PCI DMA device for PCI device
6180 * @dev: the PCI device that may have a PCI DMA alias
6181 *
6182 * Permits the platform to provide architecture-specific functionality to
6183 * devices needing to alias DMA to another PCI device on another PCI bus. If
6184 * the PCI device is on the same bus, it is recommended to use
6185 * pci_add_dma_alias(). This is the default implementation. Architecture
6186 * implementations can override this.
6187 */
6188struct pci_dev __weak *pci_real_dma_dev(struct pci_dev *dev)
6189{
6190 return dev;
6191}
6192
Yongji Xie0a701aa2017-04-10 19:58:12 +08006193resource_size_t __weak pcibios_default_alignment(void)
6194{
6195 return 0;
6196}
6197
Denis Efremovb8074aa2019-07-29 13:13:57 +03006198/*
6199 * Arches that don't want to expose struct resource to userland as-is in
6200 * sysfs and /proc can implement their own pci_resource_to_user().
6201 */
6202void __weak pci_resource_to_user(const struct pci_dev *dev, int bar,
6203 const struct resource *rsrc,
6204 resource_size_t *start, resource_size_t *end)
6205{
6206 *start = rsrc->start;
6207 *end = rsrc->end;
6208}
6209
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006210static char *resource_alignment_param;
Thomas Gleixnere9d1e492009-11-06 22:41:23 +00006211static DEFINE_SPINLOCK(resource_alignment_lock);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006212
6213/**
6214 * pci_specified_resource_alignment - get resource alignment specified by user.
6215 * @dev: the PCI device to get
Yongji Xiee3adec72017-04-10 19:58:14 +08006216 * @resize: whether or not to change resources' size when reassigning alignment
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006217 *
6218 * RETURNS: Resource alignment if it is specified.
6219 * Zero if it is not specified.
6220 */
Yongji Xiee3adec72017-04-10 19:58:14 +08006221static resource_size_t pci_specified_resource_alignment(struct pci_dev *dev,
6222 bool *resize)
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006223{
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06006224 int align_order, count;
Yongji Xie0a701aa2017-04-10 19:58:12 +08006225 resource_size_t align = pcibios_default_alignment();
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06006226 const char *p;
6227 int ret;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006228
6229 spin_lock(&resource_alignment_lock);
6230 p = resource_alignment_param;
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006231 if (!p || !*p)
Yongji Xief0b99f72016-09-13 17:00:31 +08006232 goto out;
6233 if (pci_has_flag(PCI_PROBE_ONLY)) {
Yongji Xie0a701aa2017-04-10 19:58:12 +08006234 align = 0;
Yongji Xief0b99f72016-09-13 17:00:31 +08006235 pr_info_once("PCI: Ignoring requested alignments (PCI_PROBE_ONLY)\n");
6236 goto out;
6237 }
6238
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006239 while (*p) {
6240 count = 0;
6241 if (sscanf(p, "%d%n", &align_order, &count) == 1 &&
Bjorn Helgaas6534aac2020-11-05 14:51:36 -06006242 p[count] == '@') {
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006243 p += count + 1;
Bjorn Helgaas6534aac2020-11-05 14:51:36 -06006244 if (align_order > 63) {
6245 pr_err("PCI: Invalid requested alignment (order %d)\n",
6246 align_order);
6247 align_order = PAGE_SHIFT;
6248 }
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006249 } else {
Bjorn Helgaas6534aac2020-11-05 14:51:36 -06006250 align_order = PAGE_SHIFT;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006251 }
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06006252
6253 ret = pci_dev_str_match(dev, p, &p);
6254 if (ret == 1) {
6255 *resize = true;
Colin Ian Kingcc73eb32020-11-14 15:48:04 -06006256 align = 1ULL << align_order;
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06006257 break;
6258 } else if (ret < 0) {
6259 pr_err("PCI: Can't parse resource_alignment parameter: %s\n",
6260 p);
6261 break;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006262 }
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06006263
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006264 if (*p != ';' && *p != ',') {
6265 /* End of param or invalid format */
6266 break;
6267 }
6268 p++;
6269 }
Yongji Xief0b99f72016-09-13 17:00:31 +08006270out:
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006271 spin_unlock(&resource_alignment_lock);
6272 return align;
6273}
6274
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006275static void pci_request_resource_alignment(struct pci_dev *dev, int bar,
Yongji Xiee3adec72017-04-10 19:58:14 +08006276 resource_size_t align, bool resize)
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006277{
6278 struct resource *r = &dev->resource[bar];
6279 resource_size_t size;
6280
6281 if (!(r->flags & IORESOURCE_MEM))
6282 return;
6283
6284 if (r->flags & IORESOURCE_PCI_FIXED) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06006285 pci_info(dev, "BAR%d %pR: ignoring requested alignment %#llx\n",
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006286 bar, r, (unsigned long long)align);
6287 return;
6288 }
6289
6290 size = resource_size(r);
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006291 if (size >= align)
6292 return;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006293
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006294 /*
Yongji Xiee3adec72017-04-10 19:58:14 +08006295 * Increase the alignment of the resource. There are two ways we
6296 * can do this:
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006297 *
Yongji Xiee3adec72017-04-10 19:58:14 +08006298 * 1) Increase the size of the resource. BARs are aligned on their
6299 * size, so when we reallocate space for this resource, we'll
6300 * allocate it with the larger alignment. This also prevents
6301 * assignment of any other BARs inside the alignment region, so
6302 * if we're requesting page alignment, this means no other BARs
6303 * will share the page.
6304 *
6305 * The disadvantage is that this makes the resource larger than
6306 * the hardware BAR, which may break drivers that compute things
6307 * based on the resource size, e.g., to find registers at a
6308 * fixed offset before the end of the BAR.
6309 *
6310 * 2) Retain the resource size, but use IORESOURCE_STARTALIGN and
6311 * set r->start to the desired alignment. By itself this
6312 * doesn't prevent other BARs being put inside the alignment
6313 * region, but if we realign *every* resource of every device in
6314 * the system, none of them will share an alignment region.
6315 *
6316 * When the user has requested alignment for only some devices via
6317 * the "pci=resource_alignment" argument, "resize" is true and we
6318 * use the first method. Otherwise we assume we're aligning all
6319 * devices and we use the second.
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006320 */
Yongji Xiee3adec72017-04-10 19:58:14 +08006321
Frederick Lawler7506dc72018-01-18 12:55:24 -06006322 pci_info(dev, "BAR%d %pR: requesting alignment to %#llx\n",
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006323 bar, r, (unsigned long long)align);
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006324
Yongji Xiee3adec72017-04-10 19:58:14 +08006325 if (resize) {
6326 r->start = 0;
6327 r->end = align - 1;
6328 } else {
6329 r->flags &= ~IORESOURCE_SIZEALIGN;
6330 r->flags |= IORESOURCE_STARTALIGN;
6331 r->start = align;
6332 r->end = r->start + size - 1;
6333 }
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05006334 r->flags |= IORESOURCE_UNSET;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006335}
6336
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006337/*
6338 * This function disables memory decoding and releases memory resources
6339 * of the device specified by kernel's boot parameter 'pci=resource_alignment='.
6340 * It also rounds up size to specified alignment.
6341 * Later on, the kernel will assign page-aligned memory resource back
6342 * to the device.
6343 */
6344void pci_reassigndev_resource_alignment(struct pci_dev *dev)
6345{
6346 int i;
6347 struct resource *r;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006348 resource_size_t align;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006349 u16 command;
Yongji Xiee3adec72017-04-10 19:58:14 +08006350 bool resize = false;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006351
Yongji Xie62d9a782016-09-13 17:00:32 +08006352 /*
6353 * VF BARs are read-only zero according to SR-IOV spec r1.1, sec
6354 * 3.4.1.11. Their resources are allocated from the space
6355 * described by the VF BARx register in the PF's SR-IOV capability.
6356 * We can't influence their alignment here.
6357 */
6358 if (dev->is_virtfn)
6359 return;
6360
Yinghai Lu10c463a2012-03-18 22:46:26 -07006361 /* check if specified PCI is target device to reassign */
Yongji Xiee3adec72017-04-10 19:58:14 +08006362 align = pci_specified_resource_alignment(dev, &resize);
Yinghai Lu10c463a2012-03-18 22:46:26 -07006363 if (!align)
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006364 return;
6365
6366 if (dev->hdr_type == PCI_HEADER_TYPE_NORMAL &&
6367 (dev->class >> 8) == PCI_CLASS_BRIDGE_HOST) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06006368 pci_warn(dev, "Can't reassign resources to host bridge\n");
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006369 return;
6370 }
6371
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006372 pci_read_config_word(dev, PCI_COMMAND, &command);
6373 command &= ~PCI_COMMAND_MEMORY;
6374 pci_write_config_word(dev, PCI_COMMAND, command);
6375
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006376 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
Yongji Xiee3adec72017-04-10 19:58:14 +08006377 pci_request_resource_alignment(dev, i, align, resize);
Yongji Xief0b99f72016-09-13 17:00:31 +08006378
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05006379 /*
6380 * Need to disable bridge's resource window,
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006381 * to enable the kernel to reassign new resource
6382 * window later on.
6383 */
Honghui Zhangb2fb5cc2018-10-16 18:44:43 +08006384 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006385 for (i = PCI_BRIDGE_RESOURCES; i < PCI_NUM_RESOURCES; i++) {
6386 r = &dev->resource[i];
6387 if (!(r->flags & IORESOURCE_MEM))
6388 continue;
Bjorn Helgaasbd064f02014-02-26 11:25:58 -07006389 r->flags |= IORESOURCE_UNSET;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08006390 r->end = resource_size(r) - 1;
6391 r->start = 0;
6392 }
6393 pci_disable_bridge_window(dev);
6394 }
6395}
6396
Greg Kroah-Hartmand61dfaf2018-12-21 08:54:33 +01006397static ssize_t resource_alignment_show(struct bus_type *bus, char *buf)
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006398{
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006399 size_t count = 0;
6400
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006401 spin_lock(&resource_alignment_lock);
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006402 if (resource_alignment_param)
Krzysztof Wilczyńskie7a74992020-08-24 23:39:16 +00006403 count = scnprintf(buf, PAGE_SIZE, "%s", resource_alignment_param);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006404 spin_unlock(&resource_alignment_lock);
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006405
Logan Gunthorpee4990812019-08-22 10:10:13 -06006406 /*
6407 * When set by the command line, resource_alignment_param will not
6408 * have a trailing line feed, which is ugly. So conditionally add
6409 * it here.
6410 */
6411 if (count >= 2 && buf[count - 2] != '\n' && count < PAGE_SIZE - 1) {
6412 buf[count - 1] = '\n';
6413 buf[count++] = 0;
6414 }
6415
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006416 return count;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006417}
6418
Greg Kroah-Hartmand61dfaf2018-12-21 08:54:33 +01006419static ssize_t resource_alignment_store(struct bus_type *bus,
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006420 const char *buf, size_t count)
6421{
Logan Gunthorpe273b1772019-08-22 10:10:12 -06006422 char *param = kstrndup(buf, count, GFP_KERNEL);
6423
6424 if (!param)
6425 return -ENOMEM;
6426
6427 spin_lock(&resource_alignment_lock);
6428 kfree(resource_alignment_param);
6429 resource_alignment_param = param;
6430 spin_unlock(&resource_alignment_lock);
6431 return count;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006432}
6433
Greg Kroah-Hartmand61dfaf2018-12-21 08:54:33 +01006434static BUS_ATTR_RW(resource_alignment);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006435
6436static int __init pci_resource_alignment_sysfs_init(void)
6437{
6438 return bus_create_file(&pci_bus_type,
6439 &bus_attr_resource_alignment);
6440}
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006441late_initcall(pci_resource_alignment_sysfs_init);
6442
Bill Pemberton15856ad2012-11-21 15:35:00 -05006443static void pci_no_domains(void)
Jeff Garzik32a2eea2007-10-11 16:57:27 -04006444{
6445#ifdef CONFIG_PCI_DOMAINS
6446 pci_domains_supported = 0;
6447#endif
6448}
6449
Jan Kiszkaae07b782018-05-15 11:07:00 +02006450#ifdef CONFIG_PCI_DOMAINS_GENERIC
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006451static atomic_t __domain_nr = ATOMIC_INIT(-1);
6452
Jan Kiszkaae07b782018-05-15 11:07:00 +02006453static int pci_get_new_domain_nr(void)
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006454{
6455 return atomic_inc_return(&__domain_nr);
6456}
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006457
Tomasz Nowicki1a4f93f2016-06-10 21:55:15 +02006458static int of_pci_bus_find_domain_nr(struct device *parent)
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006459{
6460 static int use_dt_domains = -1;
Krzysztof =?utf-8?Q?Ha=C5=82asa?=54c6e2d2016-03-01 07:07:18 +01006461 int domain = -1;
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006462
Krzysztof =?utf-8?Q?Ha=C5=82asa?=54c6e2d2016-03-01 07:07:18 +01006463 if (parent)
6464 domain = of_get_pci_domain_nr(parent->of_node);
Bjorn Helgaas74356ad2019-01-09 14:14:42 -06006465
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006466 /*
6467 * Check DT domain and use_dt_domains values.
6468 *
6469 * If DT domain property is valid (domain >= 0) and
6470 * use_dt_domains != 0, the DT assignment is valid since this means
6471 * we have not previously allocated a domain number by using
6472 * pci_get_new_domain_nr(); we should also update use_dt_domains to
6473 * 1, to indicate that we have just assigned a domain number from
6474 * DT.
6475 *
6476 * If DT domain property value is not valid (ie domain < 0), and we
6477 * have not previously assigned a domain number from DT
6478 * (use_dt_domains != 1) we should assign a domain number by
6479 * using the:
6480 *
6481 * pci_get_new_domain_nr()
6482 *
6483 * API and update the use_dt_domains value to keep track of method we
6484 * are using to assign domain numbers (use_dt_domains = 0).
6485 *
6486 * All other combinations imply we have a platform that is trying
6487 * to mix domain numbers obtained from DT and pci_get_new_domain_nr(),
6488 * which is a recipe for domain mishandling and it is prevented by
6489 * invalidating the domain value (domain = -1) and printing a
6490 * corresponding error.
6491 */
6492 if (domain >= 0 && use_dt_domains) {
6493 use_dt_domains = 1;
6494 } else if (domain < 0 && use_dt_domains != 1) {
6495 use_dt_domains = 0;
6496 domain = pci_get_new_domain_nr();
6497 } else {
Shawn Lin9df1c6e2018-03-01 09:26:55 +08006498 if (parent)
6499 pr_err("Node %pOF has ", parent->of_node);
6500 pr_err("Inconsistent \"linux,pci-domain\" property in DT\n");
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006501 domain = -1;
6502 }
6503
Tomasz Nowicki9c7cb892016-06-10 21:55:14 +02006504 return domain;
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006505}
Tomasz Nowicki1a4f93f2016-06-10 21:55:15 +02006506
6507int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent)
6508{
Tomasz Nowicki2ab51dd2016-06-10 15:36:26 -05006509 return acpi_disabled ? of_pci_bus_find_domain_nr(parent) :
6510 acpi_pci_bus_find_domain_nr(bus);
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006511}
6512#endif
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006513
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006514/**
Taku Izumi642c92d2012-10-30 15:26:18 +09006515 * pci_ext_cfg_avail - can we access extended PCI config space?
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006516 *
6517 * Returns 1 if we can access PCI extended config space (offsets
6518 * greater than 0xff). This is the default implementation. Architecture
6519 * implementations can override this.
6520 */
Taku Izumi642c92d2012-10-30 15:26:18 +09006521int __weak pci_ext_cfg_avail(void)
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006522{
6523 return 1;
6524}
6525
Benjamin Herrenschmidt2d1c8612009-12-09 17:52:13 +11006526void __weak pci_fixup_cardbus(struct pci_bus *bus)
6527{
6528}
6529EXPORT_SYMBOL(pci_fixup_cardbus);
6530
Al Viroad04d312008-11-22 17:37:14 +00006531static int __init pci_setup(char *str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006532{
6533 while (str) {
6534 char *k = strchr(str, ',');
6535 if (k)
6536 *k++ = 0;
6537 if (*str && (str = pcibios_setup(str)) && *str) {
Matthew Wilcox309e57d2006-03-05 22:33:34 -07006538 if (!strcmp(str, "nomsi")) {
6539 pci_no_msi();
Gil Kupfercef74402018-05-10 17:56:02 -05006540 } else if (!strncmp(str, "noats", 5)) {
6541 pr_info("PCIe: ATS is disabled\n");
6542 pcie_ats_disabled = true;
Randy Dunlap7f785762007-10-05 13:17:58 -07006543 } else if (!strcmp(str, "noaer")) {
6544 pci_no_aer();
Sinan Kaya11eb0e02018-06-04 22:16:09 -04006545 } else if (!strcmp(str, "earlydump")) {
6546 pci_early_dump = true;
Yinghai Lub55438f2012-02-23 19:23:30 -08006547 } else if (!strncmp(str, "realloc=", 8)) {
6548 pci_realloc_get_opt(str + 8);
Ram Paif483d392011-07-07 11:19:10 -07006549 } else if (!strncmp(str, "realloc", 7)) {
Yinghai Lub55438f2012-02-23 19:23:30 -08006550 pci_realloc_get_opt("on");
Jeff Garzik32a2eea2007-10-11 16:57:27 -04006551 } else if (!strcmp(str, "nodomains")) {
6552 pci_no_domains();
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +01006553 } else if (!strncmp(str, "noari", 5)) {
6554 pcie_ari_disabled = true;
Atsushi Nemoto4516a612007-02-05 16:36:06 -08006555 } else if (!strncmp(str, "cbiosize=", 9)) {
6556 pci_cardbus_io_size = memparse(str + 9, &str);
6557 } else if (!strncmp(str, "cbmemsize=", 10)) {
6558 pci_cardbus_mem_size = memparse(str + 10, &str);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006559 } else if (!strncmp(str, "resource_alignment=", 19)) {
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006560 resource_alignment_param = str + 19;
Andrew Patterson43c16402009-04-22 16:52:09 -06006561 } else if (!strncmp(str, "ecrc=", 5)) {
6562 pcie_ecrc_get_policy(str + 5);
Eric W. Biederman28760482009-09-09 14:09:24 -07006563 } else if (!strncmp(str, "hpiosize=", 9)) {
6564 pci_hotplug_io_size = memparse(str + 9, &str);
Nicholas Johnsond7b8a212019-10-23 12:12:29 +00006565 } else if (!strncmp(str, "hpmmiosize=", 11)) {
6566 pci_hotplug_mmio_size = memparse(str + 11, &str);
6567 } else if (!strncmp(str, "hpmmioprefsize=", 15)) {
6568 pci_hotplug_mmio_pref_size = memparse(str + 15, &str);
Eric W. Biederman28760482009-09-09 14:09:24 -07006569 } else if (!strncmp(str, "hpmemsize=", 10)) {
Nicholas Johnsond7b8a212019-10-23 12:12:29 +00006570 pci_hotplug_mmio_size = memparse(str + 10, &str);
6571 pci_hotplug_mmio_pref_size = pci_hotplug_mmio_size;
Keith Busche16b4662016-07-21 21:40:28 -06006572 } else if (!strncmp(str, "hpbussize=", 10)) {
6573 pci_hotplug_bus_size =
6574 simple_strtoul(str + 10, &str, 0);
6575 if (pci_hotplug_bus_size > 0xff)
6576 pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
Jon Mason5f39e672011-10-03 09:50:20 -05006577 } else if (!strncmp(str, "pcie_bus_tune_off", 17)) {
6578 pcie_bus_config = PCIE_BUS_TUNE_OFF;
Jon Masonb03e7492011-07-20 15:20:54 -05006579 } else if (!strncmp(str, "pcie_bus_safe", 13)) {
6580 pcie_bus_config = PCIE_BUS_SAFE;
6581 } else if (!strncmp(str, "pcie_bus_perf", 13)) {
6582 pcie_bus_config = PCIE_BUS_PERFORMANCE;
Jon Mason5f39e672011-10-03 09:50:20 -05006583 } else if (!strncmp(str, "pcie_bus_peer2peer", 18)) {
6584 pcie_bus_config = PCIE_BUS_PEER2PEER;
Bjorn Helgaas284f5f92012-04-30 15:21:02 -06006585 } else if (!strncmp(str, "pcie_scan_all", 13)) {
6586 pci_add_flags(PCI_SCAN_ALL_PCIE_DEVS);
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06006587 } else if (!strncmp(str, "disable_acs_redir=", 18)) {
Logan Gunthorped5bc73f2019-04-10 15:05:31 -06006588 disable_acs_redir_param = str + 18;
Matthew Wilcox309e57d2006-03-05 22:33:34 -07006589 } else {
Mohan Kumar25da8db2019-04-20 07:03:46 +03006590 pr_err("PCI: Unknown option `%s'\n", str);
Matthew Wilcox309e57d2006-03-05 22:33:34 -07006591 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07006592 }
6593 str = k;
6594 }
Andi Kleen0637a702006-09-26 10:52:41 +02006595 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07006596}
Andi Kleen0637a702006-09-26 10:52:41 +02006597early_param("pci", pci_setup);
Logan Gunthorped5bc73f2019-04-10 15:05:31 -06006598
6599/*
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006600 * 'resource_alignment_param' and 'disable_acs_redir_param' are initialized
6601 * in pci_setup(), above, to point to data in the __initdata section which
6602 * will be freed after the init sequence is complete. We can't allocate memory
6603 * in pci_setup() because some architectures do not have any memory allocation
6604 * service available during an early_param() call. So we allocate memory and
6605 * copy the variable here before the init section is freed.
6606 *
Logan Gunthorped5bc73f2019-04-10 15:05:31 -06006607 */
6608static int __init pci_realloc_setup_params(void)
6609{
Logan Gunthorpe70aaf612019-08-22 10:10:11 -06006610 resource_alignment_param = kstrdup(resource_alignment_param,
6611 GFP_KERNEL);
Logan Gunthorped5bc73f2019-04-10 15:05:31 -06006612 disable_acs_redir_param = kstrdup(disable_acs_redir_param, GFP_KERNEL);
6613
6614 return 0;
6615}
6616pure_initcall(pci_realloc_setup_params);