blob: 4a1b1f76dc92257aa4ccc448dc1d27f1f10eed4f [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>
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -070016#include <linux/of.h>
17#include <linux/of_pci.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>
CQ Tang4ebeb1e2017-05-30 09:25:49 -070032#include <linux/pci-ats.h>
Yuji Shimada32a9a6822009-03-16 17:13:39 +090033#include <asm/setup.h>
Ben Dooks2a2aca32016-06-17 16:05:13 +010034#include <asm/dma.h>
Taku Izumib07461a2015-09-17 10:09:37 -050035#include <linux/aer.h>
Greg KHbc56b9e2005-04-08 14:53:31 +090036#include "pci.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Keith Buschc4eed622018-09-20 10:27:11 -060038DEFINE_MUTEX(pci_slot_mutex);
39
Alan Stern00240c32009-04-27 13:33:16 -040040const char *pci_power_names[] = {
41 "error", "D0", "D1", "D2", "D3hot", "D3cold", "unknown",
42};
43EXPORT_SYMBOL_GPL(pci_power_names);
44
Rafael J. Wysocki93177a72010-01-02 22:57:24 +010045int isa_dma_bridge_buggy;
46EXPORT_SYMBOL(isa_dma_bridge_buggy);
47
48int pci_pci_problems;
49EXPORT_SYMBOL(pci_pci_problems);
50
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010051unsigned int pci_pm_d3_delay;
52
Matthew Garrettdf17e622010-10-04 14:22:29 -040053static void pci_pme_list_scan(struct work_struct *work);
54
55static LIST_HEAD(pci_pme_list);
56static DEFINE_MUTEX(pci_pme_list_mutex);
57static DECLARE_DELAYED_WORK(pci_pme_work, pci_pme_list_scan);
58
59struct pci_pme_device {
60 struct list_head list;
61 struct pci_dev *dev;
62};
63
64#define PME_TIMEOUT 1000 /* How long between PME checks */
65
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010066static void pci_dev_d3_sleep(struct pci_dev *dev)
67{
68 unsigned int delay = dev->d3_delay;
69
70 if (delay < pci_pm_d3_delay)
71 delay = pci_pm_d3_delay;
72
Adrian Hunter50b2b542017-03-14 15:21:58 +020073 if (delay)
74 msleep(delay);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +010075}
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Jeff Garzik32a2eea2007-10-11 16:57:27 -040077#ifdef CONFIG_PCI_DOMAINS
78int pci_domains_supported = 1;
79#endif
80
Atsushi Nemoto4516a612007-02-05 16:36:06 -080081#define DEFAULT_CARDBUS_IO_SIZE (256)
82#define DEFAULT_CARDBUS_MEM_SIZE (64*1024*1024)
83/* pci=cbmemsize=nnM,cbiosize=nn can override this */
84unsigned long pci_cardbus_io_size = DEFAULT_CARDBUS_IO_SIZE;
85unsigned long pci_cardbus_mem_size = DEFAULT_CARDBUS_MEM_SIZE;
86
Eric W. Biederman28760482009-09-09 14:09:24 -070087#define DEFAULT_HOTPLUG_IO_SIZE (256)
88#define DEFAULT_HOTPLUG_MEM_SIZE (2*1024*1024)
89/* pci=hpmemsize=nnM,hpiosize=nn can override this */
90unsigned long pci_hotplug_io_size = DEFAULT_HOTPLUG_IO_SIZE;
91unsigned long pci_hotplug_mem_size = DEFAULT_HOTPLUG_MEM_SIZE;
92
Keith Busche16b4662016-07-21 21:40:28 -060093#define DEFAULT_HOTPLUG_BUS_SIZE 1
94unsigned long pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
95
Keith Busch27d868b2015-08-24 08:48:16 -050096enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_DEFAULT;
Jon Masonb03e7492011-07-20 15:20:54 -050097
Jesse Barnesac1aa472009-10-26 13:20:44 -070098/*
99 * The default CLS is used if arch didn't set CLS explicitly and not
100 * all pci devices agree on the same value. Arch can override either
101 * the dfl or actual value as it sees fit. Don't forget this is
102 * measured in 32-bit words, not bytes.
103 */
Bill Pemberton15856ad2012-11-21 15:35:00 -0500104u8 pci_dfl_cache_line_size = L1_CACHE_BYTES >> 2;
Jesse Barnesac1aa472009-10-26 13:20:44 -0700105u8 pci_cache_line_size;
106
Myron Stowe96c55902011-10-28 15:48:38 -0600107/*
108 * If we set up a device for bus mastering, we need to check the latency
109 * timer as certain BIOSes forget to set it properly.
110 */
111unsigned int pcibios_max_latency = 255;
112
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +0100113/* If set, the PCIe ARI capability will not be used. */
114static bool pcie_ari_disabled;
115
Gil Kupfercef74402018-05-10 17:56:02 -0500116/* If set, the PCIe ATS capability will not be used. */
117static bool pcie_ats_disabled;
118
Sinan Kaya11eb0e02018-06-04 22:16:09 -0400119/* If set, the PCI config space of each device is printed during boot. */
120bool pci_early_dump;
121
Gil Kupfercef74402018-05-10 17:56:02 -0500122bool pci_ats_disabled(void)
123{
124 return pcie_ats_disabled;
125}
126
Mika Westerberg9d26d3a2016-06-02 11:17:12 +0300127/* Disable bridge_d3 for all PCIe ports */
128static bool pci_bridge_d3_disable;
129/* Force bridge_d3 for all PCIe ports */
130static bool pci_bridge_d3_force;
131
132static int __init pcie_port_pm_setup(char *str)
133{
134 if (!strcmp(str, "off"))
135 pci_bridge_d3_disable = true;
136 else if (!strcmp(str, "force"))
137 pci_bridge_d3_force = true;
138 return 1;
139}
140__setup("pcie_port_pm=", pcie_port_pm_setup);
141
Sinan Kayaa2758b62018-02-27 14:14:10 -0600142/* Time to wait after a reset for device to become responsive */
143#define PCIE_RESET_READY_POLL_MS 60000
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145/**
146 * pci_bus_max_busnr - returns maximum PCI bus number of given bus' children
147 * @bus: pointer to PCI bus structure to search
148 *
149 * Given a PCI bus, returns the highest PCI bus number present in the set
150 * including the given PCI bus and its list of child PCI buses.
151 */
Ryan Desfosses07656d83082014-04-11 01:01:53 -0400152unsigned char pci_bus_max_busnr(struct pci_bus *bus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153{
Yijing Wang94e6a9b2014-02-13 21:14:03 +0800154 struct pci_bus *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 unsigned char max, n;
156
Yinghai Lub918c622012-05-17 18:51:11 -0700157 max = bus->busn_res.end;
Yijing Wang94e6a9b2014-02-13 21:14:03 +0800158 list_for_each_entry(tmp, &bus->children, node) {
159 n = pci_bus_max_busnr(tmp);
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400160 if (n > max)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 max = n;
162 }
163 return max;
164}
Kristen Accardib82db5c2006-01-17 16:56:56 -0800165EXPORT_SYMBOL_GPL(pci_bus_max_busnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Andrew Morton1684f5d2008-12-01 14:30:30 -0800167#ifdef CONFIG_HAS_IOMEM
168void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar)
169{
Bjorn Helgaas1f7bf3bf2015-03-12 12:30:11 -0500170 struct resource *res = &pdev->resource[bar];
171
Andrew Morton1684f5d2008-12-01 14:30:30 -0800172 /*
173 * Make sure the BAR is actually a memory resource, not an IO resource
174 */
Bjorn Helgaas646c0282015-03-12 12:30:15 -0500175 if (res->flags & IORESOURCE_UNSET || !(res->flags & IORESOURCE_MEM)) {
Frederick Lawler7506dc72018-01-18 12:55:24 -0600176 pci_warn(pdev, "can't ioremap BAR %d: %pR\n", bar, res);
Andrew Morton1684f5d2008-12-01 14:30:30 -0800177 return NULL;
178 }
Bjorn Helgaas1f7bf3bf2015-03-12 12:30:11 -0500179 return ioremap_nocache(res->start, resource_size(res));
Andrew Morton1684f5d2008-12-01 14:30:30 -0800180}
181EXPORT_SYMBOL_GPL(pci_ioremap_bar);
Luis R. Rodriguezc43996f2015-08-24 12:13:23 -0700182
183void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar)
184{
185 /*
186 * Make sure the BAR is actually a memory resource, not an IO resource
187 */
188 if (!(pci_resource_flags(pdev, bar) & IORESOURCE_MEM)) {
189 WARN_ON(1);
190 return NULL;
191 }
192 return ioremap_wc(pci_resource_start(pdev, bar),
193 pci_resource_len(pdev, bar));
194}
195EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
Andrew Morton1684f5d2008-12-01 14:30:30 -0800196#endif
197
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600198/**
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600199 * pci_dev_str_match_path - test if a path string matches a device
200 * @dev: the PCI device to test
201 * @p: string to match the device against
202 * @endptr: pointer to the string after the match
203 *
204 * Test if a string (typically from a kernel parameter) formatted as a
205 * path of device/function addresses matches a PCI device. The string must
206 * be of the form:
207 *
208 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
209 *
210 * A path for a device can be obtained using 'lspci -t'. Using a path
211 * is more robust against bus renumbering than using only a single bus,
212 * device and function address.
213 *
214 * Returns 1 if the string matches the device, 0 if it does not and
215 * a negative error code if it fails to parse the string.
216 */
217static int pci_dev_str_match_path(struct pci_dev *dev, const char *path,
218 const char **endptr)
219{
220 int ret;
221 int seg, bus, slot, func;
222 char *wpath, *p;
223 char end;
224
225 *endptr = strchrnul(path, ';');
226
227 wpath = kmemdup_nul(path, *endptr - path, GFP_KERNEL);
228 if (!wpath)
229 return -ENOMEM;
230
231 while (1) {
232 p = strrchr(wpath, '/');
233 if (!p)
234 break;
235 ret = sscanf(p, "/%x.%x%c", &slot, &func, &end);
236 if (ret != 2) {
237 ret = -EINVAL;
238 goto free_and_exit;
239 }
240
241 if (dev->devfn != PCI_DEVFN(slot, func)) {
242 ret = 0;
243 goto free_and_exit;
244 }
245
246 /*
247 * Note: we don't need to get a reference to the upstream
248 * bridge because we hold a reference to the top level
249 * device which should hold a reference to the bridge,
250 * and so on.
251 */
252 dev = pci_upstream_bridge(dev);
253 if (!dev) {
254 ret = 0;
255 goto free_and_exit;
256 }
257
258 *p = 0;
259 }
260
261 ret = sscanf(wpath, "%x:%x:%x.%x%c", &seg, &bus, &slot,
262 &func, &end);
263 if (ret != 4) {
264 seg = 0;
265 ret = sscanf(wpath, "%x:%x.%x%c", &bus, &slot, &func, &end);
266 if (ret != 3) {
267 ret = -EINVAL;
268 goto free_and_exit;
269 }
270 }
271
272 ret = (seg == pci_domain_nr(dev->bus) &&
273 bus == dev->bus->number &&
274 dev->devfn == PCI_DEVFN(slot, func));
275
276free_and_exit:
277 kfree(wpath);
278 return ret;
279}
280
281/**
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600282 * pci_dev_str_match - test if a string matches a device
283 * @dev: the PCI device to test
284 * @p: string to match the device against
285 * @endptr: pointer to the string after the match
286 *
287 * Test if a string (typically from a kernel parameter) matches a specified
288 * PCI device. The string may be of one of the following formats:
289 *
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600290 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600291 * pci:<vendor>:<device>[:<subvendor>:<subdevice>]
292 *
293 * The first format specifies a PCI bus/device/function address which
294 * may change if new hardware is inserted, if motherboard firmware changes,
295 * or due to changes caused in kernel parameters. If the domain is
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600296 * left unspecified, it is taken to be 0. In order to be robust against
297 * bus renumbering issues, a path of PCI device/function numbers may be used
298 * to address the specific device. The path for a device can be determined
299 * through the use of 'lspci -t'.
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600300 *
301 * The second format matches devices using IDs in the configuration
302 * space which may match multiple devices in the system. A value of 0
303 * for any field will match all devices. (Note: this differs from
304 * in-kernel code that uses PCI_ANY_ID which is ~0; this is for
305 * legacy reasons and convenience so users don't have to specify
306 * FFFFFFFFs on the command line.)
307 *
308 * Returns 1 if the string matches the device, 0 if it does not and
309 * a negative error code if the string cannot be parsed.
310 */
311static int pci_dev_str_match(struct pci_dev *dev, const char *p,
312 const char **endptr)
313{
314 int ret;
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600315 int count;
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600316 unsigned short vendor, device, subsystem_vendor, subsystem_device;
317
318 if (strncmp(p, "pci:", 4) == 0) {
319 /* PCI vendor/device (subvendor/subdevice) IDs are specified */
320 p += 4;
321 ret = sscanf(p, "%hx:%hx:%hx:%hx%n", &vendor, &device,
322 &subsystem_vendor, &subsystem_device, &count);
323 if (ret != 4) {
324 ret = sscanf(p, "%hx:%hx%n", &vendor, &device, &count);
325 if (ret != 2)
326 return -EINVAL;
327
328 subsystem_vendor = 0;
329 subsystem_device = 0;
330 }
331
332 p += count;
333
334 if ((!vendor || vendor == dev->vendor) &&
335 (!device || device == dev->device) &&
336 (!subsystem_vendor ||
337 subsystem_vendor == dev->subsystem_vendor) &&
338 (!subsystem_device ||
339 subsystem_device == dev->subsystem_device))
340 goto found;
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600341 } else {
Logan Gunthorpe45db3372018-07-30 10:18:38 -0600342 /*
343 * PCI Bus, Device, Function IDs are specified
344 * (optionally, may include a path of devfns following it)
345 */
346 ret = pci_dev_str_match_path(dev, p, &p);
347 if (ret < 0)
348 return ret;
349 else if (ret)
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -0600350 goto found;
351 }
352
353 *endptr = p;
354 return 0;
355
356found:
357 *endptr = p;
358 return 1;
359}
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100360
361static int __pci_find_next_cap_ttl(struct pci_bus *bus, unsigned int devfn,
362 u8 pos, int cap, int *ttl)
Roland Dreier24a4e372005-10-28 17:35:34 -0700363{
364 u8 id;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700365 u16 ent;
366
367 pci_bus_read_config_byte(bus, devfn, pos, &pos);
Roland Dreier24a4e372005-10-28 17:35:34 -0700368
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100369 while ((*ttl)--) {
Roland Dreier24a4e372005-10-28 17:35:34 -0700370 if (pos < 0x40)
371 break;
372 pos &= ~3;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700373 pci_bus_read_config_word(bus, devfn, pos, &ent);
374
375 id = ent & 0xff;
Roland Dreier24a4e372005-10-28 17:35:34 -0700376 if (id == 0xff)
377 break;
378 if (id == cap)
379 return pos;
Sean O. Stalley55db3202015-04-02 14:10:19 -0700380 pos = (ent >> 8);
Roland Dreier24a4e372005-10-28 17:35:34 -0700381 }
382 return 0;
383}
384
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100385static int __pci_find_next_cap(struct pci_bus *bus, unsigned int devfn,
386 u8 pos, int cap)
387{
388 int ttl = PCI_FIND_CAP_TTL;
389
390 return __pci_find_next_cap_ttl(bus, devfn, pos, cap, &ttl);
391}
392
Roland Dreier24a4e372005-10-28 17:35:34 -0700393int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap)
394{
395 return __pci_find_next_cap(dev->bus, dev->devfn,
396 pos + PCI_CAP_LIST_NEXT, cap);
397}
398EXPORT_SYMBOL_GPL(pci_find_next_capability);
399
Michael Ellermand3bac112006-11-22 18:26:16 +1100400static int __pci_bus_find_cap_start(struct pci_bus *bus,
401 unsigned int devfn, u8 hdr_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402{
403 u16 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 pci_bus_read_config_word(bus, devfn, PCI_STATUS, &status);
406 if (!(status & PCI_STATUS_CAP_LIST))
407 return 0;
408
409 switch (hdr_type) {
410 case PCI_HEADER_TYPE_NORMAL:
411 case PCI_HEADER_TYPE_BRIDGE:
Michael Ellermand3bac112006-11-22 18:26:16 +1100412 return PCI_CAPABILITY_LIST;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 case PCI_HEADER_TYPE_CARDBUS:
Michael Ellermand3bac112006-11-22 18:26:16 +1100414 return PCI_CB_CAPABILITY_LIST;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 }
Michael Ellermand3bac112006-11-22 18:26:16 +1100416
417 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418}
419
420/**
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700421 * pci_find_capability - query for devices' capabilities
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 * @dev: PCI device to query
423 * @cap: capability code
424 *
425 * Tell if a device supports a given PCI capability.
426 * Returns the address of the requested capability structure within the
427 * device's PCI configuration space or 0 in case the device does not
428 * support it. Possible values for @cap:
429 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700430 * %PCI_CAP_ID_PM Power Management
431 * %PCI_CAP_ID_AGP Accelerated Graphics Port
432 * %PCI_CAP_ID_VPD Vital Product Data
433 * %PCI_CAP_ID_SLOTID Slot Identification
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 * %PCI_CAP_ID_MSI Message Signalled Interrupts
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700435 * %PCI_CAP_ID_CHSWP CompactPCI HotSwap
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 * %PCI_CAP_ID_PCIX PCI-X
437 * %PCI_CAP_ID_EXP PCI Express
438 */
439int pci_find_capability(struct pci_dev *dev, int cap)
440{
Michael Ellermand3bac112006-11-22 18:26:16 +1100441 int pos;
442
443 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
444 if (pos)
445 pos = __pci_find_next_cap(dev->bus, dev->devfn, pos, cap);
446
447 return pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600449EXPORT_SYMBOL(pci_find_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451/**
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700452 * pci_bus_find_capability - query for devices' capabilities
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 * @bus: the PCI bus to query
454 * @devfn: PCI device to query
455 * @cap: capability code
456 *
457 * Like pci_find_capability() but works for pci devices that do not have a
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700458 * pci_dev structure set up yet.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 *
460 * Returns the address of the requested capability structure within the
461 * device's PCI configuration space or 0 in case the device does not
462 * support it.
463 */
464int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap)
465{
Michael Ellermand3bac112006-11-22 18:26:16 +1100466 int pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 u8 hdr_type;
468
469 pci_bus_read_config_byte(bus, devfn, PCI_HEADER_TYPE, &hdr_type);
470
Michael Ellermand3bac112006-11-22 18:26:16 +1100471 pos = __pci_bus_find_cap_start(bus, devfn, hdr_type & 0x7f);
472 if (pos)
473 pos = __pci_find_next_cap(bus, devfn, pos, cap);
474
475 return pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600477EXPORT_SYMBOL(pci_bus_find_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479/**
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600480 * pci_find_next_ext_capability - Find an extended capability
481 * @dev: PCI device to query
482 * @start: address at which to start looking (0 to start at beginning of list)
483 * @cap: capability code
484 *
485 * Returns the address of the next matching extended capability structure
486 * within the device's PCI configuration space or 0 if the device does
487 * not support it. Some capabilities can occur several times, e.g., the
488 * vendor-specific capability, and this provides a way to find them all.
489 */
490int pci_find_next_ext_capability(struct pci_dev *dev, int start, int cap)
491{
492 u32 header;
493 int ttl;
494 int pos = PCI_CFG_SPACE_SIZE;
495
496 /* minimum 8 bytes per capability */
497 ttl = (PCI_CFG_SPACE_EXP_SIZE - PCI_CFG_SPACE_SIZE) / 8;
498
499 if (dev->cfg_size <= PCI_CFG_SPACE_SIZE)
500 return 0;
501
502 if (start)
503 pos = start;
504
505 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
506 return 0;
507
508 /*
509 * If we have no capabilities, this is indicated by cap ID,
510 * cap version and next pointer all being 0.
511 */
512 if (header == 0)
513 return 0;
514
515 while (ttl-- > 0) {
516 if (PCI_EXT_CAP_ID(header) == cap && pos != start)
517 return pos;
518
519 pos = PCI_EXT_CAP_NEXT(header);
520 if (pos < PCI_CFG_SPACE_SIZE)
521 break;
522
523 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
524 break;
525 }
526
527 return 0;
528}
529EXPORT_SYMBOL_GPL(pci_find_next_ext_capability);
530
531/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 * pci_find_ext_capability - Find an extended capability
533 * @dev: PCI device to query
534 * @cap: capability code
535 *
536 * Returns the address of the requested extended capability structure
537 * within the device's PCI configuration space or 0 if the device does
538 * not support it. Possible values for @cap:
539 *
540 * %PCI_EXT_CAP_ID_ERR Advanced Error Reporting
541 * %PCI_EXT_CAP_ID_VC Virtual Channel
542 * %PCI_EXT_CAP_ID_DSN Device Serial Number
543 * %PCI_EXT_CAP_ID_PWR Power Budgeting
544 */
545int pci_find_ext_capability(struct pci_dev *dev, int cap)
546{
Bjorn Helgaas44a9a362012-07-13 14:24:59 -0600547 return pci_find_next_ext_capability(dev, 0, cap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548}
Brice Goglin3a720d72006-05-23 06:10:01 -0400549EXPORT_SYMBOL_GPL(pci_find_ext_capability);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100551static int __pci_find_next_ht_cap(struct pci_dev *dev, int pos, int ht_cap)
552{
553 int rc, ttl = PCI_FIND_CAP_TTL;
554 u8 cap, mask;
555
556 if (ht_cap == HT_CAPTYPE_SLAVE || ht_cap == HT_CAPTYPE_HOST)
557 mask = HT_3BIT_CAP_MASK;
558 else
559 mask = HT_5BIT_CAP_MASK;
560
561 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn, pos,
562 PCI_CAP_ID_HT, &ttl);
563 while (pos) {
564 rc = pci_read_config_byte(dev, pos + 3, &cap);
565 if (rc != PCIBIOS_SUCCESSFUL)
566 return 0;
567
568 if ((cap & mask) == ht_cap)
569 return pos;
570
Brice Goglin47a4d5b2007-01-10 23:15:29 -0800571 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn,
572 pos + PCI_CAP_LIST_NEXT,
Michael Ellerman687d5fe2006-11-22 18:26:18 +1100573 PCI_CAP_ID_HT, &ttl);
574 }
575
576 return 0;
577}
578/**
579 * pci_find_next_ht_capability - query a device's Hypertransport capabilities
580 * @dev: PCI device to query
581 * @pos: Position from which to continue searching
582 * @ht_cap: Hypertransport capability code
583 *
584 * To be used in conjunction with pci_find_ht_capability() to search for
585 * all capabilities matching @ht_cap. @pos should always be a value returned
586 * from pci_find_ht_capability().
587 *
588 * NB. To be 100% safe against broken PCI devices, the caller should take
589 * steps to avoid an infinite loop.
590 */
591int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap)
592{
593 return __pci_find_next_ht_cap(dev, pos + PCI_CAP_LIST_NEXT, ht_cap);
594}
595EXPORT_SYMBOL_GPL(pci_find_next_ht_capability);
596
597/**
598 * pci_find_ht_capability - query a device's Hypertransport capabilities
599 * @dev: PCI device to query
600 * @ht_cap: Hypertransport capability code
601 *
602 * Tell if a device supports a given Hypertransport capability.
603 * Returns an address within the device's PCI configuration space
604 * or 0 in case the device does not support the request capability.
605 * The address points to the PCI capability, of type PCI_CAP_ID_HT,
606 * which has a Hypertransport capability matching @ht_cap.
607 */
608int pci_find_ht_capability(struct pci_dev *dev, int ht_cap)
609{
610 int pos;
611
612 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
613 if (pos)
614 pos = __pci_find_next_ht_cap(dev, pos, ht_cap);
615
616 return pos;
617}
618EXPORT_SYMBOL_GPL(pci_find_ht_capability);
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/**
621 * pci_find_parent_resource - return resource region of parent bus of given region
622 * @dev: PCI device structure contains resources to be searched
623 * @res: child resource record for which parent is sought
624 *
625 * For given resource region of given device, return the resource
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700626 * region of parent bus the given region is contained in.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400628struct resource *pci_find_parent_resource(const struct pci_dev *dev,
629 struct resource *res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
631 const struct pci_bus *bus = dev->bus;
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700632 struct resource *r;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Bjorn Helgaas89a74ec2010-02-23 10:24:31 -0700635 pci_bus_for_each_resource(bus, r, i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 if (!r)
637 continue;
Ard Biesheuvel31342332017-04-11 17:33:12 +0100638 if (resource_contains(r, res)) {
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700639
640 /*
641 * If the window is prefetchable but the BAR is
642 * not, the allocator made a mistake.
643 */
644 if (r->flags & IORESOURCE_PREFETCH &&
645 !(res->flags & IORESOURCE_PREFETCH))
646 return NULL;
647
648 /*
649 * If we're below a transparent bridge, there may
650 * be both a positively-decoded aperture and a
651 * subtractively-decoded region that contain the BAR.
652 * We want the positively-decoded one, so this depends
653 * on pci_bus_for_each_resource() giving us those
654 * first.
655 */
656 return r;
657 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
Bjorn Helgaasf44116a2014-02-26 11:25:58 -0700659 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -0600661EXPORT_SYMBOL(pci_find_parent_resource);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
663/**
Mika Westerbergafd29f92016-09-15 11:07:03 +0300664 * pci_find_resource - Return matching PCI device resource
665 * @dev: PCI device to query
666 * @res: Resource to look for
667 *
668 * Goes over standard PCI resources (BARs) and checks if the given resource
669 * is partially or fully contained in any of them. In that case the
670 * matching resource is returned, %NULL otherwise.
671 */
672struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res)
673{
674 int i;
675
676 for (i = 0; i < PCI_ROM_RESOURCE; i++) {
677 struct resource *r = &dev->resource[i];
678
679 if (r->start && resource_contains(r, res))
680 return r;
681 }
682
683 return NULL;
684}
685EXPORT_SYMBOL(pci_find_resource);
686
687/**
Hariprasad Shenaic56d4452015-10-18 19:55:04 +0530688 * pci_find_pcie_root_port - return PCIe Root Port
689 * @dev: PCI device to query
690 *
691 * Traverse up the parent chain and return the PCIe Root Port PCI Device
692 * for a given PCI Device.
693 */
694struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev)
695{
Thierry Redingb6f6d562017-08-17 13:06:14 +0200696 struct pci_dev *bridge, *highest_pcie_bridge = dev;
Hariprasad Shenaic56d4452015-10-18 19:55:04 +0530697
698 bridge = pci_upstream_bridge(dev);
699 while (bridge && pci_is_pcie(bridge)) {
700 highest_pcie_bridge = bridge;
701 bridge = pci_upstream_bridge(bridge);
702 }
703
Thierry Redingb6f6d562017-08-17 13:06:14 +0200704 if (pci_pcie_type(highest_pcie_bridge) != PCI_EXP_TYPE_ROOT_PORT)
705 return NULL;
Hariprasad Shenaic56d4452015-10-18 19:55:04 +0530706
Thierry Redingb6f6d562017-08-17 13:06:14 +0200707 return highest_pcie_bridge;
Hariprasad Shenaic56d4452015-10-18 19:55:04 +0530708}
709EXPORT_SYMBOL(pci_find_pcie_root_port);
710
711/**
Alex Williamson157e8762013-12-17 16:43:39 -0700712 * pci_wait_for_pending - wait for @mask bit(s) to clear in status word @pos
713 * @dev: the PCI device to operate on
714 * @pos: config space offset of status word
715 * @mask: mask of bit(s) to care about in status word
716 *
717 * Return 1 when mask bit(s) in status word clear, 0 otherwise.
718 */
719int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask)
720{
721 int i;
722
723 /* Wait for Transaction Pending bit clean */
724 for (i = 0; i < 4; i++) {
725 u16 status;
726 if (i)
727 msleep((1 << (i - 1)) * 100);
728
729 pci_read_config_word(dev, pos, &status);
730 if (!(status & mask))
731 return 1;
732 }
733
734 return 0;
735}
736
737/**
Wei Yang70675e02015-07-29 16:52:58 +0800738 * pci_restore_bars - restore a device's BAR values (e.g. after wake-up)
John W. Linville064b53db2005-07-27 10:19:44 -0400739 * @dev: PCI device to have its BARs restored
740 *
741 * Restore the BAR values for a given device, so as to make it
742 * accessible by its driver.
743 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400744static void pci_restore_bars(struct pci_dev *dev)
John W. Linville064b53db2005-07-27 10:19:44 -0400745{
Yu Zhaobc5f5a82008-11-22 02:40:00 +0800746 int i;
John W. Linville064b53db2005-07-27 10:19:44 -0400747
Yu Zhaobc5f5a82008-11-22 02:40:00 +0800748 for (i = 0; i < PCI_BRIDGE_RESOURCES; i++)
Yu Zhao14add802008-11-22 02:38:52 +0800749 pci_update_resource(dev, i);
John W. Linville064b53db2005-07-27 10:19:44 -0400750}
751
Julia Lawall299f2ff2015-12-06 17:33:45 +0100752static const struct pci_platform_pm_ops *pci_platform_pm;
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200753
Julia Lawall299f2ff2015-12-06 17:33:45 +0100754int pci_set_platform_pm(const struct pci_platform_pm_ops *ops)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200755{
Lukas Wunnercc7cc022016-09-18 05:39:20 +0200756 if (!ops->is_manageable || !ops->set_state || !ops->get_state ||
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200757 !ops->choose_state || !ops->set_wakeup || !ops->need_resume)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200758 return -EINVAL;
759 pci_platform_pm = ops;
760 return 0;
761}
762
763static inline bool platform_pci_power_manageable(struct pci_dev *dev)
764{
765 return pci_platform_pm ? pci_platform_pm->is_manageable(dev) : false;
766}
767
768static inline int platform_pci_set_power_state(struct pci_dev *dev,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400769 pci_power_t t)
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200770{
771 return pci_platform_pm ? pci_platform_pm->set_state(dev, t) : -ENOSYS;
772}
773
Lukas Wunnercc7cc022016-09-18 05:39:20 +0200774static inline pci_power_t platform_pci_get_power_state(struct pci_dev *dev)
775{
776 return pci_platform_pm ? pci_platform_pm->get_state(dev) : PCI_UNKNOWN;
777}
778
Rafael J. Wysocki961d9122008-07-07 03:32:02 +0200779static inline pci_power_t platform_pci_choose_state(struct pci_dev *dev)
780{
781 return pci_platform_pm ?
782 pci_platform_pm->choose_state(dev) : PCI_POWER_ERROR;
783}
Randy Dunlap8f7020d2005-10-23 11:57:38 -0700784
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200785static inline int platform_pci_set_wakeup(struct pci_dev *dev, bool enable)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +0200786{
787 return pci_platform_pm ?
Rafael J. Wysocki08476842017-06-24 01:57:35 +0200788 pci_platform_pm->set_wakeup(dev, enable) : -ENODEV;
Rafael J. Wysockib67ea762010-02-17 23:44:09 +0100789}
790
Rafael J. Wysockibac2a902015-01-21 02:17:42 +0100791static inline bool platform_pci_need_resume(struct pci_dev *dev)
792{
793 return pci_platform_pm ? pci_platform_pm->need_resume(dev) : false;
794}
795
John W. Linville064b53db2005-07-27 10:19:44 -0400796/**
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200797 * pci_raw_set_power_state - Use PCI PM registers to set the power state of
798 * given PCI device
799 * @dev: PCI device to handle.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200800 * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 *
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200802 * RETURN VALUE:
803 * -EINVAL if the requested state is invalid.
804 * -EIO if device does not support PCI PM or its PM capabilities register has a
805 * wrong version, or device doesn't support the requested state.
806 * 0 if device already is in the requested state.
807 * 0 if device's power state has been successfully changed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 */
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +0100809static int pci_raw_set_power_state(struct pci_dev *dev, pci_power_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200811 u16 pmcsr;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200812 bool need_restore = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Rafael J. Wysocki4a865902009-03-16 22:40:36 +0100814 /* Check if we're already there */
815 if (dev->current_state == state)
816 return 0;
817
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200818 if (!dev->pm_cap)
Andrew Lunncca03de2007-07-09 11:55:58 -0700819 return -EIO;
820
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200821 if (state < PCI_D0 || state > PCI_D3hot)
822 return -EINVAL;
823
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 /* Validate current state:
Bjorn Helgaasf7625982013-11-14 11:28:18 -0700825 * Can enter D0 from any state, but if we can only go deeper
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 * to sleep if we're already in a low power state
827 */
Rafael J. Wysocki4a865902009-03-16 22:40:36 +0100828 if (state != PCI_D0 && dev->current_state <= PCI_D3cold
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200829 && dev->current_state > state) {
Frederick Lawler7506dc72018-01-18 12:55:24 -0600830 pci_err(dev, "invalid power transition (from state %d to %d)\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -0400831 dev->current_state, state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 return -EINVAL;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 /* check if this device supports the desired state */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200836 if ((state == PCI_D1 && !dev->d1_support)
837 || (state == PCI_D2 && !dev->d2_support))
Daniel Ritz3fe9d192005-08-17 15:32:19 -0700838 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200840 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
John W. Linville064b53db2005-07-27 10:19:44 -0400841
John W. Linville32a36582005-09-14 09:52:42 -0400842 /* If we're (effectively) in D3, force entire word to 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 * This doesn't affect PME_Status, disables PME_En, and
844 * sets PowerState to 0.
845 */
John W. Linville32a36582005-09-14 09:52:42 -0400846 switch (dev->current_state) {
John W. Linvilled3535fb2005-09-28 17:50:51 -0400847 case PCI_D0:
848 case PCI_D1:
849 case PCI_D2:
850 pmcsr &= ~PCI_PM_CTRL_STATE_MASK;
851 pmcsr |= state;
852 break;
Rafael J. Wysockif62795f2009-05-18 22:51:12 +0200853 case PCI_D3hot:
854 case PCI_D3cold:
John W. Linville32a36582005-09-14 09:52:42 -0400855 case PCI_UNKNOWN: /* Boot-up */
856 if ((pmcsr & PCI_PM_CTRL_STATE_MASK) == PCI_D3hot
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +0100857 && !(pmcsr & PCI_PM_CTRL_NO_SOFT_RESET))
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200858 need_restore = true;
John W. Linville32a36582005-09-14 09:52:42 -0400859 /* Fall-through: force to D0 */
John W. Linville32a36582005-09-14 09:52:42 -0400860 default:
John W. Linvilled3535fb2005-09-28 17:50:51 -0400861 pmcsr = 0;
John W. Linville32a36582005-09-14 09:52:42 -0400862 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 }
864
865 /* enter specified state */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200866 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
868 /* Mandatory power management transition delays */
869 /* see PCI PM 1.1 5.6.1 table 18 */
870 if (state == PCI_D3hot || dev->current_state == PCI_D3hot)
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +0100871 pci_dev_d3_sleep(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 else if (state == PCI_D2 || dev->current_state == PCI_D2)
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +0100873 udelay(PCI_PM_D2_DELAY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Rafael J. Wysockie13cdbd2009-10-05 00:48:40 +0200875 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
876 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
877 if (dev->current_state != state && printk_ratelimit())
Frederick Lawler7506dc72018-01-18 12:55:24 -0600878 pci_info(dev, "Refused to change power state, currently in D%d\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -0400879 dev->current_state);
John W. Linville064b53db2005-07-27 10:19:44 -0400880
Huang Ying448bd852012-06-23 10:23:51 +0800881 /*
882 * According to section 5.4.1 of the "PCI BUS POWER MANAGEMENT
John W. Linville064b53db2005-07-27 10:19:44 -0400883 * INTERFACE SPECIFICATION, REV. 1.2", a device transitioning
884 * from D3hot to D0 _may_ perform an internal reset, thereby
885 * going to "D0 Uninitialized" rather than "D0 Initialized".
886 * For example, at least some versions of the 3c905B and the
887 * 3c556B exhibit this behaviour.
888 *
889 * At least some laptop BIOSen (e.g. the Thinkpad T21) leave
890 * devices in a D3hot state at boot. Consequently, we need to
891 * restore at least the BARs so that the device will be
892 * accessible to its driver.
893 */
894 if (need_restore)
895 pci_restore_bars(dev);
896
Rafael J. Wysockif00a20e2009-03-16 22:40:08 +0100897 if (dev->bus->self)
Shaohua Li7d715a62008-02-25 09:46:41 +0800898 pcie_aspm_pm_state_change(dev->bus->self);
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 return 0;
901}
902
903/**
Lukas Wunnera6a64022016-09-18 05:39:20 +0200904 * pci_update_current_state - Read power state of given device and cache it
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200905 * @dev: PCI device to handle.
Rafael J. Wysockif06fc0b2008-12-27 16:30:52 +0100906 * @state: State to cache in case the device doesn't have the PM capability
Lukas Wunnera6a64022016-09-18 05:39:20 +0200907 *
908 * The power state is read from the PMCSR register, which however is
909 * inaccessible in D3cold. The platform firmware is therefore queried first
910 * to detect accessibility of the register. In case the platform firmware
911 * reports an incorrect state or the device isn't power manageable by the
912 * platform at all, we try to detect D3cold by testing accessibility of the
913 * vendor ID in config space.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200914 */
Rafael J. Wysocki734104292009-01-07 13:07:15 +0100915void pci_update_current_state(struct pci_dev *dev, pci_power_t state)
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200916{
Lukas Wunnera6a64022016-09-18 05:39:20 +0200917 if (platform_pci_get_power_state(dev) == PCI_D3cold ||
918 !pci_device_is_present(dev)) {
919 dev->current_state = PCI_D3cold;
920 } else if (dev->pm_cap) {
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200921 u16 pmcsr;
922
Rafael J. Wysocki337001b2008-07-07 03:36:24 +0200923 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200924 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
Rafael J. Wysockif06fc0b2008-12-27 16:30:52 +0100925 } else {
926 dev->current_state = state;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +0200927 }
928}
929
930/**
Rafael J. Wysockidb288c92012-07-05 15:20:00 -0600931 * pci_power_up - Put the given device into D0 forcibly
932 * @dev: PCI device to power up
933 */
934void pci_power_up(struct pci_dev *dev)
935{
936 if (platform_pci_power_manageable(dev))
937 platform_pci_set_power_state(dev, PCI_D0);
938
939 pci_raw_set_power_state(dev, PCI_D0);
940 pci_update_current_state(dev, PCI_D0);
941}
942
943/**
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +0100944 * pci_platform_power_transition - Use platform to change device power state
945 * @dev: PCI device to handle.
946 * @state: State to put the device into.
947 */
948static int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state)
949{
950 int error;
951
952 if (platform_pci_power_manageable(dev)) {
953 error = platform_pci_set_power_state(dev, state);
954 if (!error)
955 pci_update_current_state(dev, state);
Rafael J. Wysocki769ba722013-04-12 13:58:17 +0000956 } else
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +0100957 error = -ENODEV;
Rafael J. Wysocki769ba722013-04-12 13:58:17 +0000958
959 if (error && !dev->pm_cap) /* Fall back to PCI_D0 */
960 dev->current_state = PCI_D0;
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +0100961
962 return error;
963}
964
965/**
Stephen Hemminger0b950f02014-01-10 17:14:48 -0700966 * pci_wakeup - Wake up a PCI device
967 * @pci_dev: Device to handle.
968 * @ign: ignored parameter
969 */
970static int pci_wakeup(struct pci_dev *pci_dev, void *ign)
971{
972 pci_wakeup_event(pci_dev);
973 pm_request_resume(&pci_dev->dev);
974 return 0;
975}
976
977/**
978 * pci_wakeup_bus - Walk given bus and wake up devices on it
979 * @bus: Top bus of the subtree to walk.
980 */
Lukas Wunner2a4d2c42018-03-03 10:53:24 +0100981void pci_wakeup_bus(struct pci_bus *bus)
Stephen Hemminger0b950f02014-01-10 17:14:48 -0700982{
983 if (bus)
984 pci_walk_bus(bus, pci_wakeup, NULL);
985}
986
987/**
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +0100988 * __pci_start_power_transition - Start power transition of a PCI device
989 * @dev: PCI device to handle.
990 * @state: State to put the device into.
991 */
992static void __pci_start_power_transition(struct pci_dev *dev, pci_power_t state)
993{
Huang Ying448bd852012-06-23 10:23:51 +0800994 if (state == PCI_D0) {
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +0100995 pci_platform_power_transition(dev, PCI_D0);
Huang Ying448bd852012-06-23 10:23:51 +0800996 /*
997 * Mandatory power management transition delays, see
998 * PCI Express Base Specification Revision 2.0 Section
999 * 6.6.1: Conventional Reset. Do not delay for
1000 * devices powered on/off by corresponding bridge,
1001 * because have already delayed for the bridge.
1002 */
1003 if (dev->runtime_d3cold) {
Adrian Hunter50b2b542017-03-14 15:21:58 +02001004 if (dev->d3cold_delay)
1005 msleep(dev->d3cold_delay);
Huang Ying448bd852012-06-23 10:23:51 +08001006 /*
1007 * When powering on a bridge from D3cold, the
1008 * whole hierarchy may be powered on into
1009 * D0uninitialized state, resume them to give
1010 * them a chance to suspend again
1011 */
1012 pci_wakeup_bus(dev->subordinate);
1013 }
1014 }
1015}
1016
1017/**
1018 * __pci_dev_set_current_state - Set current state of a PCI device
1019 * @dev: Device to handle
1020 * @data: pointer to state to be set
1021 */
1022static int __pci_dev_set_current_state(struct pci_dev *dev, void *data)
1023{
1024 pci_power_t state = *(pci_power_t *)data;
1025
1026 dev->current_state = state;
1027 return 0;
1028}
1029
1030/**
Lukas Wunner2a4d2c42018-03-03 10:53:24 +01001031 * pci_bus_set_current_state - Walk given bus and set current state of devices
Huang Ying448bd852012-06-23 10:23:51 +08001032 * @bus: Top bus of the subtree to walk.
1033 * @state: state to be set
1034 */
Lukas Wunner2a4d2c42018-03-03 10:53:24 +01001035void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state)
Huang Ying448bd852012-06-23 10:23:51 +08001036{
1037 if (bus)
1038 pci_walk_bus(bus, __pci_dev_set_current_state, &state);
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001039}
1040
1041/**
1042 * __pci_complete_power_transition - Complete power transition of a PCI device
1043 * @dev: PCI device to handle.
1044 * @state: State to put the device into.
1045 *
1046 * This function should not be called directly by device drivers.
1047 */
1048int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state)
1049{
Huang Ying448bd852012-06-23 10:23:51 +08001050 int ret;
1051
Rafael J. Wysockidb288c92012-07-05 15:20:00 -06001052 if (state <= PCI_D0)
Huang Ying448bd852012-06-23 10:23:51 +08001053 return -EINVAL;
1054 ret = pci_platform_power_transition(dev, state);
1055 /* Power off the bridge may power off the whole hierarchy */
1056 if (!ret && state == PCI_D3cold)
Lukas Wunner2a4d2c42018-03-03 10:53:24 +01001057 pci_bus_set_current_state(dev->subordinate, PCI_D3cold);
Huang Ying448bd852012-06-23 10:23:51 +08001058 return ret;
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001059}
1060EXPORT_SYMBOL_GPL(__pci_complete_power_transition);
1061
1062/**
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001063 * pci_set_power_state - Set the power state of a PCI device
1064 * @dev: PCI device to handle.
1065 * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
1066 *
Nick Andrew877d0312009-01-26 11:06:57 +01001067 * Transition a device to a new power state, using the platform firmware and/or
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001068 * the device's PCI PM registers.
1069 *
1070 * RETURN VALUE:
1071 * -EINVAL if the requested state is invalid.
1072 * -EIO if device does not support PCI PM or its PM capabilities register has a
1073 * wrong version, or device doesn't support the requested state.
Piotr Gregorab4b8a42017-08-02 20:42:18 +01001074 * 0 if the transition is to D1 or D2 but D1 and D2 are not supported.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001075 * 0 if device already is in the requested state.
Piotr Gregorab4b8a42017-08-02 20:42:18 +01001076 * 0 if the transition is to D3 but D3 is not supported.
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001077 * 0 if device's power state has been successfully changed.
1078 */
1079int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1080{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001081 int error;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001082
1083 /* bound the state we're entering */
Huang Ying448bd852012-06-23 10:23:51 +08001084 if (state > PCI_D3cold)
1085 state = PCI_D3cold;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001086 else if (state < PCI_D0)
1087 state = PCI_D0;
1088 else if ((state == PCI_D1 || state == PCI_D2) && pci_no_d1d2(dev))
1089 /*
1090 * If the device or the parent bridge do not support PCI PM,
1091 * ignore the request if we're doing anything other than putting
1092 * it into D0 (which would only happen on boot).
1093 */
1094 return 0;
1095
Rafael J. Wysockidb288c92012-07-05 15:20:00 -06001096 /* Check if we're already there */
1097 if (dev->current_state == state)
1098 return 0;
1099
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001100 __pci_start_power_transition(dev, state);
1101
Alan Cox979b1792008-07-24 17:18:38 +01001102 /* This device is quirked not to be put into D3, so
1103 don't put it in D3 */
Huang Ying448bd852012-06-23 10:23:51 +08001104 if (state >= PCI_D3hot && (dev->dev_flags & PCI_DEV_FLAGS_NO_D3))
Alan Cox979b1792008-07-24 17:18:38 +01001105 return 0;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001106
Huang Ying448bd852012-06-23 10:23:51 +08001107 /*
1108 * To put device in D3cold, we put device into D3hot in native
1109 * way, then put device into D3cold with platform ops
1110 */
1111 error = pci_raw_set_power_state(dev, state > PCI_D3hot ?
1112 PCI_D3hot : state);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001113
Rafael J. Wysocki0e5dd462009-03-26 22:51:40 +01001114 if (!__pci_complete_power_transition(dev, state))
1115 error = 0;
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001116
1117 return error;
1118}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001119EXPORT_SYMBOL(pci_set_power_state);
Rafael J. Wysocki44e4e662008-07-07 03:32:52 +02001120
1121/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 * pci_choose_state - Choose the power state of a PCI device
1123 * @dev: PCI device to be suspended
1124 * @state: target sleep state for the whole system. This is the value
1125 * that is passed to suspend() function.
1126 *
1127 * Returns PCI power state suitable for given device and given system
1128 * message.
1129 */
1130
1131pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state)
1132{
Shaohua Liab826ca2007-07-20 10:03:22 +08001133 pci_power_t ret;
David Shaohua Li0f644742005-03-19 00:15:48 -05001134
Yijing Wang728cdb72013-06-18 16:22:14 +08001135 if (!dev->pm_cap)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 return PCI_D0;
1137
Rafael J. Wysocki961d9122008-07-07 03:32:02 +02001138 ret = platform_pci_choose_state(dev);
1139 if (ret != PCI_POWER_ERROR)
1140 return ret;
Pavel Machekca078ba2005-09-03 15:56:57 -07001141
1142 switch (state.event) {
1143 case PM_EVENT_ON:
1144 return PCI_D0;
1145 case PM_EVENT_FREEZE:
David Brownellb887d2e2006-08-14 23:11:05 -07001146 case PM_EVENT_PRETHAW:
1147 /* REVISIT both freeze and pre-thaw "should" use D0 */
Pavel Machekca078ba2005-09-03 15:56:57 -07001148 case PM_EVENT_SUSPEND:
Rafael J. Wysocki3a2d5b72008-02-23 19:13:25 +01001149 case PM_EVENT_HIBERNATE:
Pavel Machekca078ba2005-09-03 15:56:57 -07001150 return PCI_D3hot;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 default:
Frederick Lawler7506dc72018-01-18 12:55:24 -06001152 pci_info(dev, "unrecognized suspend event %d\n",
Bjorn Helgaas80ccba12008-06-13 10:52:11 -06001153 state.event);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 BUG();
1155 }
1156 return PCI_D0;
1157}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158EXPORT_SYMBOL(pci_choose_state);
1159
Yu Zhao89858512009-02-16 02:55:47 +08001160#define PCI_EXP_SAVE_REGS 7
1161
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001162static struct pci_cap_saved_state *_pci_find_saved_cap(struct pci_dev *pci_dev,
1163 u16 cap, bool extended)
Yinghai Lu34a48762012-02-11 00:18:41 -08001164{
1165 struct pci_cap_saved_state *tmp;
Yinghai Lu34a48762012-02-11 00:18:41 -08001166
Sasha Levinb67bfe02013-02-27 17:06:00 -08001167 hlist_for_each_entry(tmp, &pci_dev->saved_cap_space, next) {
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001168 if (tmp->cap.cap_extended == extended && tmp->cap.cap_nr == cap)
Yinghai Lu34a48762012-02-11 00:18:41 -08001169 return tmp;
1170 }
1171 return NULL;
1172}
1173
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001174struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap)
1175{
1176 return _pci_find_saved_cap(dev, cap, false);
1177}
1178
1179struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev, u16 cap)
1180{
1181 return _pci_find_saved_cap(dev, cap, true);
1182}
1183
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001184static int pci_save_pcie_state(struct pci_dev *dev)
1185{
Jiang Liu59875ae2012-07-24 17:20:06 +08001186 int i = 0;
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001187 struct pci_cap_saved_state *save_state;
1188 u16 *cap;
1189
Jiang Liu59875ae2012-07-24 17:20:06 +08001190 if (!pci_is_pcie(dev))
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001191 return 0;
1192
Eric W. Biederman9f355752007-03-08 13:06:13 -07001193 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001194 if (!save_state) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001195 pci_err(dev, "buffer not found in %s\n", __func__);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001196 return -ENOMEM;
1197 }
Jiang Liu59875ae2012-07-24 17:20:06 +08001198
Alex Williamson24a4742f2011-05-10 10:02:11 -06001199 cap = (u16 *)&save_state->cap.data[0];
Jiang Liu59875ae2012-07-24 17:20:06 +08001200 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &cap[i++]);
1201 pcie_capability_read_word(dev, PCI_EXP_LNKCTL, &cap[i++]);
1202 pcie_capability_read_word(dev, PCI_EXP_SLTCTL, &cap[i++]);
1203 pcie_capability_read_word(dev, PCI_EXP_RTCTL, &cap[i++]);
1204 pcie_capability_read_word(dev, PCI_EXP_DEVCTL2, &cap[i++]);
1205 pcie_capability_read_word(dev, PCI_EXP_LNKCTL2, &cap[i++]);
1206 pcie_capability_read_word(dev, PCI_EXP_SLTCTL2, &cap[i++]);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001207
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001208 return 0;
1209}
1210
1211static void pci_restore_pcie_state(struct pci_dev *dev)
1212{
Jiang Liu59875ae2012-07-24 17:20:06 +08001213 int i = 0;
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001214 struct pci_cap_saved_state *save_state;
1215 u16 *cap;
1216
1217 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
Jiang Liu59875ae2012-07-24 17:20:06 +08001218 if (!save_state)
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001219 return;
Jiang Liu59875ae2012-07-24 17:20:06 +08001220
Alex Williamson24a4742f2011-05-10 10:02:11 -06001221 cap = (u16 *)&save_state->cap.data[0];
Jiang Liu59875ae2012-07-24 17:20:06 +08001222 pcie_capability_write_word(dev, PCI_EXP_DEVCTL, cap[i++]);
1223 pcie_capability_write_word(dev, PCI_EXP_LNKCTL, cap[i++]);
1224 pcie_capability_write_word(dev, PCI_EXP_SLTCTL, cap[i++]);
1225 pcie_capability_write_word(dev, PCI_EXP_RTCTL, cap[i++]);
1226 pcie_capability_write_word(dev, PCI_EXP_DEVCTL2, cap[i++]);
1227 pcie_capability_write_word(dev, PCI_EXP_LNKCTL2, cap[i++]);
1228 pcie_capability_write_word(dev, PCI_EXP_SLTCTL2, cap[i++]);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001229}
1230
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001231
1232static int pci_save_pcix_state(struct pci_dev *dev)
1233{
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01001234 int pos;
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001235 struct pci_cap_saved_state *save_state;
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001236
1237 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
Wei Yang0a1a9b42015-06-30 09:16:44 +08001238 if (!pos)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001239 return 0;
1240
Shaohua Lif34303d2007-12-18 09:56:47 +08001241 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001242 if (!save_state) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001243 pci_err(dev, "buffer not found in %s\n", __func__);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001244 return -ENOMEM;
1245 }
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001246
Alex Williamson24a4742f2011-05-10 10:02:11 -06001247 pci_read_config_word(dev, pos + PCI_X_CMD,
1248 (u16 *)save_state->cap.data);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01001249
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001250 return 0;
1251}
1252
1253static void pci_restore_pcix_state(struct pci_dev *dev)
1254{
1255 int i = 0, pos;
1256 struct pci_cap_saved_state *save_state;
1257 u16 *cap;
1258
1259 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1260 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
Wei Yang0a1a9b42015-06-30 09:16:44 +08001261 if (!save_state || !pos)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001262 return;
Alex Williamson24a4742f2011-05-10 10:02:11 -06001263 cap = (u16 *)&save_state->cap.data[0];
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001264
1265 pci_write_config_word(dev, pos + PCI_X_CMD, cap[i++]);
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001266}
1267
1268
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269/**
1270 * pci_save_state - save the PCI configuration space of a device before suspending
1271 * @dev: - PCI device that we're dealing with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001273int pci_save_state(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274{
1275 int i;
1276 /* XXX: 100% dword access ok here? */
1277 for (i = 0; i < 16; i++)
Kleber Sacilotto de Souza9e0b5b22009-11-25 00:55:51 -02001278 pci_read_config_dword(dev, i * 4, &dev->saved_config_space[i]);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +01001279 dev->state_saved = true;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001280
1281 i = pci_save_pcie_state(dev);
1282 if (i != 0)
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001283 return i;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001284
1285 i = pci_save_pcix_state(dev);
1286 if (i != 0)
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001287 return i;
Quentin Lambert79e50e72014-09-07 20:03:32 +02001288
Keith Busch4f802172018-09-20 10:27:08 -06001289 pci_save_dpc_state(dev);
Quentin Lambert754834b2014-11-06 17:45:55 +01001290 return pci_save_vc_state(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001292EXPORT_SYMBOL(pci_save_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001294static void pci_restore_config_dword(struct pci_dev *pdev, int offset,
1295 u32 saved_val, int retry)
1296{
1297 u32 val;
1298
1299 pci_read_config_dword(pdev, offset, &val);
1300 if (val == saved_val)
1301 return;
1302
1303 for (;;) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06001304 pci_dbg(pdev, "restoring config space at offset %#x (was %#x, writing %#x)\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -04001305 offset, val, saved_val);
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001306 pci_write_config_dword(pdev, offset, saved_val);
1307 if (retry-- <= 0)
1308 return;
1309
1310 pci_read_config_dword(pdev, offset, &val);
1311 if (val == saved_val)
1312 return;
1313
1314 mdelay(1);
1315 }
1316}
1317
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001318static void pci_restore_config_space_range(struct pci_dev *pdev,
1319 int start, int end, int retry)
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001320{
1321 int index;
1322
1323 for (index = end; index >= start; index--)
1324 pci_restore_config_dword(pdev, 4 * index,
1325 pdev->saved_config_space[index],
1326 retry);
1327}
1328
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001329static void pci_restore_config_space(struct pci_dev *pdev)
1330{
1331 if (pdev->hdr_type == PCI_HEADER_TYPE_NORMAL) {
1332 pci_restore_config_space_range(pdev, 10, 15, 0);
1333 /* Restore BARs before the command register. */
1334 pci_restore_config_space_range(pdev, 4, 9, 10);
1335 pci_restore_config_space_range(pdev, 0, 3, 0);
1336 } else {
1337 pci_restore_config_space_range(pdev, 0, 15, 0);
1338 }
1339}
1340
Christian Königd3252ac2018-06-29 19:54:55 -05001341static void pci_restore_rebar_state(struct pci_dev *pdev)
1342{
1343 unsigned int pos, nbars, i;
1344 u32 ctrl;
1345
1346 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
1347 if (!pos)
1348 return;
1349
1350 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1351 nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
1352 PCI_REBAR_CTRL_NBAR_SHIFT;
1353
1354 for (i = 0; i < nbars; i++, pos += 8) {
1355 struct resource *res;
1356 int bar_idx, size;
1357
1358 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1359 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
1360 res = pdev->resource + bar_idx;
1361 size = order_base_2((resource_size(res) >> 20) | 1) - 1;
1362 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
Christian Königb1277a22018-06-29 19:55:03 -05001363 ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
Christian Königd3252ac2018-06-29 19:54:55 -05001364 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
1365 }
1366}
1367
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001368/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 * pci_restore_state - Restore the saved state of a PCI device
1370 * @dev: - PCI device that we're dealing with
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 */
Jon Mason1d3c16a2010-11-30 17:43:26 -06001372void pci_restore_state(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373{
Alek Duc82f63e2009-08-08 08:46:19 +08001374 if (!dev->state_saved)
Jon Mason1d3c16a2010-11-30 17:43:26 -06001375 return;
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +02001376
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001377 /* PCI Express register must be restored first */
1378 pci_restore_pcie_state(dev);
CQ Tang4ebeb1e2017-05-30 09:25:49 -07001379 pci_restore_pasid_state(dev);
1380 pci_restore_pri_state(dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +08001381 pci_restore_ats_state(dev);
Alex Williamson425c1b22013-12-17 16:43:51 -07001382 pci_restore_vc_state(dev);
Christian Königd3252ac2018-06-29 19:54:55 -05001383 pci_restore_rebar_state(dev);
Keith Busch4f802172018-09-20 10:27:08 -06001384 pci_restore_dpc_state(dev);
Michael S. Tsirkinb56a5a22006-08-21 16:22:22 +03001385
Taku Izumib07461a2015-09-17 10:09:37 -05001386 pci_cleanup_aer_error_status_regs(dev);
1387
Rafael J. Wysockia6cb9ee2012-04-16 23:07:50 +02001388 pci_restore_config_space(dev);
Rafael J. Wysockiebfc5b82012-04-15 21:40:40 +02001389
Stephen Hemmingercc692a52006-11-08 16:17:15 -08001390 pci_restore_pcix_state(dev);
Shaohua Li41017f02006-02-08 17:11:38 +08001391 pci_restore_msi_state(dev);
Alexander Duyckccbc1752015-07-07 12:24:35 -07001392
1393 /* Restore ACS and IOV configuration state */
1394 pci_enable_acs(dev);
Yu Zhao8c5cdb62009-03-20 11:25:12 +08001395 pci_restore_iov_state(dev);
Michael Ellerman8fed4b62007-01-25 19:34:08 +11001396
Rafael J. Wysocki4b77b0a2009-09-09 23:49:59 +02001397 dev->state_saved = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001399EXPORT_SYMBOL(pci_restore_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001401struct pci_saved_state {
1402 u32 config_space[16];
1403 struct pci_cap_saved_data cap[0];
1404};
1405
1406/**
1407 * pci_store_saved_state - Allocate and return an opaque struct containing
1408 * the device saved state.
1409 * @dev: PCI device that we're dealing with
1410 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07001411 * Return NULL if no state or error.
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001412 */
1413struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev)
1414{
1415 struct pci_saved_state *state;
1416 struct pci_cap_saved_state *tmp;
1417 struct pci_cap_saved_data *cap;
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001418 size_t size;
1419
1420 if (!dev->state_saved)
1421 return NULL;
1422
1423 size = sizeof(*state) + sizeof(struct pci_cap_saved_data);
1424
Sasha Levinb67bfe02013-02-27 17:06:00 -08001425 hlist_for_each_entry(tmp, &dev->saved_cap_space, next)
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001426 size += sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1427
1428 state = kzalloc(size, GFP_KERNEL);
1429 if (!state)
1430 return NULL;
1431
1432 memcpy(state->config_space, dev->saved_config_space,
1433 sizeof(state->config_space));
1434
1435 cap = state->cap;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001436 hlist_for_each_entry(tmp, &dev->saved_cap_space, next) {
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001437 size_t len = sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1438 memcpy(cap, &tmp->cap, len);
1439 cap = (struct pci_cap_saved_data *)((u8 *)cap + len);
1440 }
1441 /* Empty cap_save terminates list */
1442
1443 return state;
1444}
1445EXPORT_SYMBOL_GPL(pci_store_saved_state);
1446
1447/**
1448 * pci_load_saved_state - Reload the provided save state into struct pci_dev.
1449 * @dev: PCI device that we're dealing with
1450 * @state: Saved state returned from pci_store_saved_state()
1451 */
Konrad Rzeszutek Wilk98d9b272014-12-03 16:40:31 -05001452int pci_load_saved_state(struct pci_dev *dev,
1453 struct pci_saved_state *state)
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001454{
1455 struct pci_cap_saved_data *cap;
1456
1457 dev->state_saved = false;
1458
1459 if (!state)
1460 return 0;
1461
1462 memcpy(dev->saved_config_space, state->config_space,
1463 sizeof(state->config_space));
1464
1465 cap = state->cap;
1466 while (cap->size) {
1467 struct pci_cap_saved_state *tmp;
1468
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07001469 tmp = _pci_find_saved_cap(dev, cap->cap_nr, cap->cap_extended);
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001470 if (!tmp || tmp->cap.size != cap->size)
1471 return -EINVAL;
1472
1473 memcpy(tmp->cap.data, cap->data, tmp->cap.size);
1474 cap = (struct pci_cap_saved_data *)((u8 *)cap +
1475 sizeof(struct pci_cap_saved_data) + cap->size);
1476 }
1477
1478 dev->state_saved = true;
1479 return 0;
1480}
Konrad Rzeszutek Wilk98d9b272014-12-03 16:40:31 -05001481EXPORT_SYMBOL_GPL(pci_load_saved_state);
Alex Williamsonffbdd3f2011-05-10 10:02:27 -06001482
1483/**
1484 * pci_load_and_free_saved_state - Reload the save state pointed to by state,
1485 * and free the memory allocated for it.
1486 * @dev: PCI device that we're dealing with
1487 * @state: Pointer to saved state returned from pci_store_saved_state()
1488 */
1489int pci_load_and_free_saved_state(struct pci_dev *dev,
1490 struct pci_saved_state **state)
1491{
1492 int ret = pci_load_saved_state(dev, *state);
1493 kfree(*state);
1494 *state = NULL;
1495 return ret;
1496}
1497EXPORT_SYMBOL_GPL(pci_load_and_free_saved_state);
1498
Bjorn Helgaas8a9d5602014-02-26 11:26:00 -07001499int __weak pcibios_enable_device(struct pci_dev *dev, int bars)
1500{
1501 return pci_enable_resources(dev, bars);
1502}
1503
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001504static int do_pci_enable_device(struct pci_dev *dev, int bars)
1505{
1506 int err;
Vidya Sagar1f6ae472014-07-16 15:33:42 +05301507 struct pci_dev *bridge;
Bjorn Helgaas1e2571a2014-01-29 16:13:51 -07001508 u16 cmd;
1509 u8 pin;
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001510
1511 err = pci_set_power_state(dev, PCI_D0);
1512 if (err < 0 && err != -EIO)
1513 return err;
Vidya Sagar1f6ae472014-07-16 15:33:42 +05301514
1515 bridge = pci_upstream_bridge(dev);
1516 if (bridge)
1517 pcie_aspm_powersave_config_link(bridge);
1518
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001519 err = pcibios_enable_device(dev, bars);
1520 if (err < 0)
1521 return err;
1522 pci_fixup_device(pci_fixup_enable, dev);
1523
Bjorn Helgaas866d5412014-03-07 16:06:05 -07001524 if (dev->msi_enabled || dev->msix_enabled)
1525 return 0;
1526
Bjorn Helgaas1e2571a2014-01-29 16:13:51 -07001527 pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
1528 if (pin) {
1529 pci_read_config_word(dev, PCI_COMMAND, &cmd);
1530 if (cmd & PCI_COMMAND_INTX_DISABLE)
1531 pci_write_config_word(dev, PCI_COMMAND,
1532 cmd & ~PCI_COMMAND_INTX_DISABLE);
1533 }
1534
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001535 return 0;
1536}
1537
1538/**
Tejun Heo0b62e132007-07-27 14:43:35 +09001539 * pci_reenable_device - Resume abandoned device
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001540 * @dev: PCI device to be resumed
1541 *
1542 * Note this function is a backend of pci_default_resume and is not supposed
1543 * to be called by normal code, write proper resume handler and use it instead.
1544 */
Tejun Heo0b62e132007-07-27 14:43:35 +09001545int pci_reenable_device(struct pci_dev *dev)
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001546{
Yuji Shimada296ccb02009-04-03 16:41:46 +09001547 if (pci_is_enabled(dev))
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001548 return do_pci_enable_device(dev, (1 << PCI_NUM_RESOURCES) - 1);
1549 return 0;
1550}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001551EXPORT_SYMBOL(pci_reenable_device);
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001552
Yinghai Lu928bea92013-07-22 14:37:17 -07001553static void pci_enable_bridge(struct pci_dev *dev)
1554{
Bjorn Helgaas79272132013-11-06 10:00:51 -07001555 struct pci_dev *bridge;
Yinghai Lu928bea92013-07-22 14:37:17 -07001556 int retval;
1557
Bjorn Helgaas79272132013-11-06 10:00:51 -07001558 bridge = pci_upstream_bridge(dev);
1559 if (bridge)
1560 pci_enable_bridge(bridge);
Yinghai Lu928bea92013-07-22 14:37:17 -07001561
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001562 if (pci_is_enabled(dev)) {
Bjorn Helgaasfbeeb822013-11-05 13:34:51 -07001563 if (!dev->is_busmaster)
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001564 pci_set_master(dev);
Bjorn Helgaas0f50a492017-09-15 01:33:51 -05001565 return;
Yinghai Lucf3e1fe2013-11-05 13:34:38 -07001566 }
1567
Yinghai Lu928bea92013-07-22 14:37:17 -07001568 retval = pci_enable_device(dev);
1569 if (retval)
Frederick Lawler7506dc72018-01-18 12:55:24 -06001570 pci_err(dev, "Error enabling bridge (%d), continuing\n",
Yinghai Lu928bea92013-07-22 14:37:17 -07001571 retval);
1572 pci_set_master(dev);
1573}
1574
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001575static int pci_enable_device_flags(struct pci_dev *dev, unsigned long flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576{
Bjorn Helgaas79272132013-11-06 10:00:51 -07001577 struct pci_dev *bridge;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 int err;
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001579 int i, bars = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Jesse Barnes97c145f2010-11-05 15:16:36 -04001581 /*
1582 * Power state could be unknown at this point, either due to a fresh
1583 * boot or a device removal call. So get the current power state
1584 * so that things like MSI message writing will behave as expected
1585 * (e.g. if the device really is in D0 at enable time).
1586 */
1587 if (dev->pm_cap) {
1588 u16 pmcsr;
1589 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1590 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
1591 }
1592
Bjorn Helgaascc7ba392013-02-11 16:47:01 -07001593 if (atomic_inc_return(&dev->enable_cnt) > 1)
Hidetoshi Seto9fb625c2006-12-18 10:28:43 +09001594 return 0; /* already enabled */
1595
Bjorn Helgaas79272132013-11-06 10:00:51 -07001596 bridge = pci_upstream_bridge(dev);
Bjorn Helgaas0f50a492017-09-15 01:33:51 -05001597 if (bridge)
Bjorn Helgaas79272132013-11-06 10:00:51 -07001598 pci_enable_bridge(bridge);
Yinghai Lu928bea92013-07-22 14:37:17 -07001599
Yinghai Lu497f16f2011-12-17 18:33:37 -08001600 /* only skip sriov related */
1601 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1602 if (dev->resource[i].flags & flags)
1603 bars |= (1 << i);
1604 for (i = PCI_BRIDGE_RESOURCES; i < DEVICE_COUNT_RESOURCE; i++)
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001605 if (dev->resource[i].flags & flags)
1606 bars |= (1 << i);
1607
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001608 err = do_pci_enable_device(dev, bars);
Greg Kroah-Hartman95a62962005-07-28 11:37:33 -07001609 if (err < 0)
Hidetoshi Seto38cc1302006-12-18 10:30:00 +09001610 atomic_dec(&dev->enable_cnt);
Hidetoshi Seto9fb625c2006-12-18 10:28:43 +09001611 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612}
1613
1614/**
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001615 * pci_enable_device_io - Initialize a device for use with IO space
1616 * @dev: PCI device to be initialized
1617 *
1618 * Initialize device before it's used by a driver. Ask low-level code
1619 * to enable I/O resources. Wake up the device if it was suspended.
1620 * Beware, this function can fail.
1621 */
1622int pci_enable_device_io(struct pci_dev *dev)
1623{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001624 return pci_enable_device_flags(dev, IORESOURCE_IO);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001625}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001626EXPORT_SYMBOL(pci_enable_device_io);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001627
1628/**
1629 * pci_enable_device_mem - Initialize a device for use with Memory space
1630 * @dev: PCI device to be initialized
1631 *
1632 * Initialize device before it's used by a driver. Ask low-level code
1633 * to enable Memory resources. Wake up the device if it was suspended.
1634 * Beware, this function can fail.
1635 */
1636int pci_enable_device_mem(struct pci_dev *dev)
1637{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001638 return pci_enable_device_flags(dev, IORESOURCE_MEM);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001639}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001640EXPORT_SYMBOL(pci_enable_device_mem);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +11001641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642/**
1643 * pci_enable_device - Initialize device before it's used by a driver.
1644 * @dev: PCI device to be initialized
1645 *
1646 * Initialize device before it's used by a driver. Ask low-level code
1647 * to enable I/O and memory. Wake up the device if it was suspended.
1648 * Beware, this function can fail.
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001649 *
1650 * Note we don't actually enable the device many times if we call
1651 * this function repeatedly (we just increment the count).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 */
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001653int pci_enable_device(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654{
Bjorn Helgaasb4b4fbb2013-01-04 12:12:55 -07001655 return pci_enable_device_flags(dev, IORESOURCE_MEM | IORESOURCE_IO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001657EXPORT_SYMBOL(pci_enable_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Tejun Heo9ac78492007-01-20 16:00:26 +09001659/*
1660 * Managed PCI resources. This manages device on/off, intx/msi/msix
1661 * on/off and BAR regions. pci_dev itself records msi/msix status, so
1662 * there's no need to track it separately. pci_devres is initialized
1663 * when a device is enabled using managed PCI device enable interface.
1664 */
1665struct pci_devres {
Tejun Heo7f375f32007-02-25 04:36:01 -08001666 unsigned int enabled:1;
1667 unsigned int pinned:1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001668 unsigned int orig_intx:1;
1669 unsigned int restore_intx:1;
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01001670 unsigned int mwi:1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001671 u32 region_mask;
1672};
1673
1674static void pcim_release(struct device *gendev, void *res)
1675{
Geliang Tangf3d2f1652016-01-08 12:05:39 -06001676 struct pci_dev *dev = to_pci_dev(gendev);
Tejun Heo9ac78492007-01-20 16:00:26 +09001677 struct pci_devres *this = res;
1678 int i;
1679
1680 if (dev->msi_enabled)
1681 pci_disable_msi(dev);
1682 if (dev->msix_enabled)
1683 pci_disable_msix(dev);
1684
1685 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++)
1686 if (this->region_mask & (1 << i))
1687 pci_release_region(dev, i);
1688
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01001689 if (this->mwi)
1690 pci_clear_mwi(dev);
1691
Tejun Heo9ac78492007-01-20 16:00:26 +09001692 if (this->restore_intx)
1693 pci_intx(dev, this->orig_intx);
1694
Tejun Heo7f375f32007-02-25 04:36:01 -08001695 if (this->enabled && !this->pinned)
Tejun Heo9ac78492007-01-20 16:00:26 +09001696 pci_disable_device(dev);
1697}
1698
Ryan Desfosses07656d83082014-04-11 01:01:53 -04001699static struct pci_devres *get_pci_dr(struct pci_dev *pdev)
Tejun Heo9ac78492007-01-20 16:00:26 +09001700{
1701 struct pci_devres *dr, *new_dr;
1702
1703 dr = devres_find(&pdev->dev, pcim_release, NULL, NULL);
1704 if (dr)
1705 return dr;
1706
1707 new_dr = devres_alloc(pcim_release, sizeof(*new_dr), GFP_KERNEL);
1708 if (!new_dr)
1709 return NULL;
1710 return devres_get(&pdev->dev, new_dr, NULL, NULL);
1711}
1712
Ryan Desfosses07656d83082014-04-11 01:01:53 -04001713static struct pci_devres *find_pci_dr(struct pci_dev *pdev)
Tejun Heo9ac78492007-01-20 16:00:26 +09001714{
1715 if (pci_is_managed(pdev))
1716 return devres_find(&pdev->dev, pcim_release, NULL, NULL);
1717 return NULL;
1718}
1719
1720/**
1721 * pcim_enable_device - Managed pci_enable_device()
1722 * @pdev: PCI device to be initialized
1723 *
1724 * Managed pci_enable_device().
1725 */
1726int pcim_enable_device(struct pci_dev *pdev)
1727{
1728 struct pci_devres *dr;
1729 int rc;
1730
1731 dr = get_pci_dr(pdev);
1732 if (unlikely(!dr))
1733 return -ENOMEM;
Tejun Heob95d58e2008-01-30 18:20:04 +09001734 if (dr->enabled)
1735 return 0;
Tejun Heo9ac78492007-01-20 16:00:26 +09001736
1737 rc = pci_enable_device(pdev);
1738 if (!rc) {
1739 pdev->is_managed = 1;
Tejun Heo7f375f32007-02-25 04:36:01 -08001740 dr->enabled = 1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001741 }
1742 return rc;
1743}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001744EXPORT_SYMBOL(pcim_enable_device);
Tejun Heo9ac78492007-01-20 16:00:26 +09001745
1746/**
1747 * pcim_pin_device - Pin managed PCI device
1748 * @pdev: PCI device to pin
1749 *
1750 * Pin managed PCI device @pdev. Pinned device won't be disabled on
1751 * driver detach. @pdev must have been enabled with
1752 * pcim_enable_device().
1753 */
1754void pcim_pin_device(struct pci_dev *pdev)
1755{
1756 struct pci_devres *dr;
1757
1758 dr = find_pci_dr(pdev);
Tejun Heo7f375f32007-02-25 04:36:01 -08001759 WARN_ON(!dr || !dr->enabled);
Tejun Heo9ac78492007-01-20 16:00:26 +09001760 if (dr)
Tejun Heo7f375f32007-02-25 04:36:01 -08001761 dr->pinned = 1;
Tejun Heo9ac78492007-01-20 16:00:26 +09001762}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001763EXPORT_SYMBOL(pcim_pin_device);
Tejun Heo9ac78492007-01-20 16:00:26 +09001764
Matthew Garretteca0d4672012-12-05 14:33:27 -07001765/*
1766 * pcibios_add_device - provide arch specific hooks when adding device dev
1767 * @dev: the PCI device being added
1768 *
1769 * Permits the platform to provide architecture specific functionality when
1770 * devices are added. This is the default implementation. Architecture
1771 * implementations can override this.
1772 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001773int __weak pcibios_add_device(struct pci_dev *dev)
Matthew Garretteca0d4672012-12-05 14:33:27 -07001774{
1775 return 0;
1776}
1777
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778/**
Sebastian Ott6ae32c52013-06-04 19:18:14 +02001779 * pcibios_release_device - provide arch specific hooks when releasing device dev
1780 * @dev: the PCI device being released
1781 *
1782 * Permits the platform to provide architecture specific functionality when
1783 * devices are released. This is the default implementation. Architecture
1784 * implementations can override this.
1785 */
1786void __weak pcibios_release_device(struct pci_dev *dev) {}
1787
1788/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 * pcibios_disable_device - disable arch specific PCI resources for device dev
1790 * @dev: the PCI device to disable
1791 *
1792 * Disables architecture specific PCI resources for the device. This
1793 * is the default implementation. Architecture implementations can
1794 * override this.
1795 */
Bogicevic Sasaff3ce482015-12-27 13:21:11 -08001796void __weak pcibios_disable_device(struct pci_dev *dev) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Hanjun Guoa43ae582014-05-06 11:29:52 +08001798/**
1799 * pcibios_penalize_isa_irq - penalize an ISA IRQ
1800 * @irq: ISA IRQ to penalize
1801 * @active: IRQ active or not
1802 *
1803 * Permits the platform to provide architecture-specific functionality when
1804 * penalizing ISA IRQs. This is the default implementation. Architecture
1805 * implementations can override this.
1806 */
1807void __weak pcibios_penalize_isa_irq(int irq, int active) {}
1808
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01001809static void do_pci_disable_device(struct pci_dev *dev)
1810{
1811 u16 pci_command;
1812
1813 pci_read_config_word(dev, PCI_COMMAND, &pci_command);
1814 if (pci_command & PCI_COMMAND_MASTER) {
1815 pci_command &= ~PCI_COMMAND_MASTER;
1816 pci_write_config_word(dev, PCI_COMMAND, pci_command);
1817 }
1818
1819 pcibios_disable_device(dev);
1820}
1821
1822/**
1823 * pci_disable_enabled_device - Disable device without updating enable_cnt
1824 * @dev: PCI device to disable
1825 *
1826 * NOTE: This function is a backend of PCI power management routines and is
1827 * not supposed to be called drivers.
1828 */
1829void pci_disable_enabled_device(struct pci_dev *dev)
1830{
Yuji Shimada296ccb02009-04-03 16:41:46 +09001831 if (pci_is_enabled(dev))
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01001832 do_pci_disable_device(dev);
1833}
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835/**
1836 * pci_disable_device - Disable PCI device after use
1837 * @dev: PCI device to be disabled
1838 *
1839 * Signal to the system that the PCI device is not in use by the system
1840 * anymore. This only involves disabling PCI bus-mastering, if active.
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001841 *
1842 * Note we don't actually disable the device until all callers of
Roman Fietzeee6583f2010-05-18 14:45:47 +02001843 * pci_enable_device() have called pci_disable_device().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04001845void pci_disable_device(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846{
Tejun Heo9ac78492007-01-20 16:00:26 +09001847 struct pci_devres *dr;
Shaohua Li99dc8042006-05-26 10:58:27 +08001848
Tejun Heo9ac78492007-01-20 16:00:26 +09001849 dr = find_pci_dr(dev);
1850 if (dr)
Tejun Heo7f375f32007-02-25 04:36:01 -08001851 dr->enabled = 0;
Tejun Heo9ac78492007-01-20 16:00:26 +09001852
Konstantin Khlebnikovfd6dcea2013-02-04 15:56:01 +04001853 dev_WARN_ONCE(&dev->dev, atomic_read(&dev->enable_cnt) <= 0,
1854 "disabling already-disabled device");
1855
Bjorn Helgaascc7ba392013-02-11 16:47:01 -07001856 if (atomic_dec_return(&dev->enable_cnt) != 0)
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -08001857 return;
1858
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01001859 do_pci_disable_device(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860
Rafael J. Wysockifa58d302009-01-07 13:03:42 +01001861 dev->is_busmaster = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001863EXPORT_SYMBOL(pci_disable_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864
1865/**
Brian Kingf7bdd122007-04-06 16:39:36 -05001866 * pcibios_set_pcie_reset_state - set reset state for device dev
Stefan Assmann45e829e2009-12-03 06:49:24 -05001867 * @dev: the PCIe device reset
Brian Kingf7bdd122007-04-06 16:39:36 -05001868 * @state: Reset state to enter into
1869 *
1870 *
Stefan Assmann45e829e2009-12-03 06:49:24 -05001871 * Sets the PCIe reset state for the device. This is the default
Brian Kingf7bdd122007-04-06 16:39:36 -05001872 * implementation. Architecture implementations can override this.
1873 */
Bjorn Helgaasd6d88c82012-06-19 06:54:49 -06001874int __weak pcibios_set_pcie_reset_state(struct pci_dev *dev,
1875 enum pcie_reset_state state)
Brian Kingf7bdd122007-04-06 16:39:36 -05001876{
1877 return -EINVAL;
1878}
1879
1880/**
1881 * pci_set_pcie_reset_state - set reset state for device dev
Stefan Assmann45e829e2009-12-03 06:49:24 -05001882 * @dev: the PCIe device reset
Brian Kingf7bdd122007-04-06 16:39:36 -05001883 * @state: Reset state to enter into
1884 *
1885 *
1886 * Sets the PCI reset state for the device.
1887 */
1888int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state)
1889{
1890 return pcibios_set_pcie_reset_state(dev, state);
1891}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001892EXPORT_SYMBOL_GPL(pci_set_pcie_reset_state);
Brian Kingf7bdd122007-04-06 16:39:36 -05001893
1894/**
Bjorn Helgaasdcb04532018-03-09 11:06:53 -06001895 * pcie_clear_root_pme_status - Clear root port PME interrupt status.
1896 * @dev: PCIe root port or event collector.
1897 */
1898void pcie_clear_root_pme_status(struct pci_dev *dev)
1899{
1900 pcie_capability_set_dword(dev, PCI_EXP_RTSTA, PCI_EXP_RTSTA_PME);
1901}
1902
1903/**
Rafael J. Wysocki58ff4632010-02-17 23:36:58 +01001904 * pci_check_pme_status - Check if given device has generated PME.
1905 * @dev: Device to check.
1906 *
1907 * Check the PME status of the device and if set, clear it and clear PME enable
1908 * (if set). Return 'true' if PME status and PME enable were both set or
1909 * 'false' otherwise.
1910 */
1911bool pci_check_pme_status(struct pci_dev *dev)
1912{
1913 int pmcsr_pos;
1914 u16 pmcsr;
1915 bool ret = false;
1916
1917 if (!dev->pm_cap)
1918 return false;
1919
1920 pmcsr_pos = dev->pm_cap + PCI_PM_CTRL;
1921 pci_read_config_word(dev, pmcsr_pos, &pmcsr);
1922 if (!(pmcsr & PCI_PM_CTRL_PME_STATUS))
1923 return false;
1924
1925 /* Clear PME status. */
1926 pmcsr |= PCI_PM_CTRL_PME_STATUS;
1927 if (pmcsr & PCI_PM_CTRL_PME_ENABLE) {
1928 /* Disable PME to avoid interrupt flood. */
1929 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
1930 ret = true;
1931 }
1932
1933 pci_write_config_word(dev, pmcsr_pos, pmcsr);
1934
1935 return ret;
1936}
1937
1938/**
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01001939 * pci_pme_wakeup - Wake up a PCI device if its PME Status bit is set.
1940 * @dev: Device to handle.
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02001941 * @pme_poll_reset: Whether or not to reset the device's pme_poll flag.
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01001942 *
1943 * Check if @dev has generated PME and queue a resume request for it in that
1944 * case.
1945 */
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02001946static int pci_pme_wakeup(struct pci_dev *dev, void *pme_poll_reset)
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01001947{
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02001948 if (pme_poll_reset && dev->pme_poll)
1949 dev->pme_poll = false;
1950
Rafael J. Wysockic125e962010-07-05 22:43:53 +02001951 if (pci_check_pme_status(dev)) {
Rafael J. Wysockic125e962010-07-05 22:43:53 +02001952 pci_wakeup_event(dev);
Rafael J. Wysocki0f953bf2010-12-29 13:22:08 +01001953 pm_request_resume(&dev->dev);
Rafael J. Wysockic125e962010-07-05 22:43:53 +02001954 }
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01001955 return 0;
1956}
1957
1958/**
1959 * pci_pme_wakeup_bus - Walk given bus and wake up devices on it, if necessary.
1960 * @bus: Top bus of the subtree to walk.
1961 */
1962void pci_pme_wakeup_bus(struct pci_bus *bus)
1963{
1964 if (bus)
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02001965 pci_walk_bus(bus, pci_pme_wakeup, (void *)true);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01001966}
1967
Huang Ying448bd852012-06-23 10:23:51 +08001968
1969/**
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001970 * pci_pme_capable - check the capability of PCI device to generate PME#
1971 * @dev: PCI device to handle.
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001972 * @state: PCI state from which device will issue PME#.
1973 */
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02001974bool pci_pme_capable(struct pci_dev *dev, pci_power_t state)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001975{
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001976 if (!dev->pm_cap)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001977 return false;
1978
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02001979 return !!(dev->pme_support & (1 << state));
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001980}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06001981EXPORT_SYMBOL(pci_pme_capable);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02001982
Matthew Garrettdf17e622010-10-04 14:22:29 -04001983static void pci_pme_list_scan(struct work_struct *work)
1984{
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02001985 struct pci_pme_device *pme_dev, *n;
Matthew Garrettdf17e622010-10-04 14:22:29 -04001986
1987 mutex_lock(&pci_pme_list_mutex);
Bjorn Helgaasce300002014-01-24 09:51:06 -07001988 list_for_each_entry_safe(pme_dev, n, &pci_pme_list, list) {
1989 if (pme_dev->dev->pme_poll) {
1990 struct pci_dev *bridge;
Zheng Yan71a83bd2012-06-23 10:23:49 +08001991
Bjorn Helgaasce300002014-01-24 09:51:06 -07001992 bridge = pme_dev->dev->bus->self;
1993 /*
1994 * If bridge is in low power state, the
1995 * configuration space of subordinate devices
1996 * may be not accessible
1997 */
1998 if (bridge && bridge->current_state != PCI_D0)
1999 continue;
2000 pci_pme_wakeup(pme_dev->dev, NULL);
2001 } else {
2002 list_del(&pme_dev->list);
2003 kfree(pme_dev);
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002004 }
Matthew Garrettdf17e622010-10-04 14:22:29 -04002005 }
Bjorn Helgaasce300002014-01-24 09:51:06 -07002006 if (!list_empty(&pci_pme_list))
Lukas Wunnerea003532017-04-18 20:44:30 +02002007 queue_delayed_work(system_freezable_wq, &pci_pme_work,
2008 msecs_to_jiffies(PME_TIMEOUT));
Matthew Garrettdf17e622010-10-04 14:22:29 -04002009 mutex_unlock(&pci_pme_list_mutex);
2010}
2011
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002012static void __pci_pme_active(struct pci_dev *dev, bool enable)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002013{
2014 u16 pmcsr;
2015
Rafael J. Wysockiffaddbe2013-04-10 10:32:51 +00002016 if (!dev->pme_support)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002017 return;
2018
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002019 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002020 /* Clear PME_Status by writing 1 to it and enable PME# */
2021 pmcsr |= PCI_PM_CTRL_PME_STATUS | PCI_PM_CTRL_PME_ENABLE;
2022 if (!enable)
2023 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2024
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002025 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002026}
2027
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002028/**
2029 * pci_pme_restore - Restore PME configuration after config space restore.
2030 * @dev: PCI device to update.
2031 */
2032void pci_pme_restore(struct pci_dev *dev)
Rafael J. Wysockidc15e712017-06-12 22:53:36 +02002033{
2034 u16 pmcsr;
2035
2036 if (!dev->pme_support)
2037 return;
2038
2039 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2040 if (dev->wakeup_prepared) {
2041 pmcsr |= PCI_PM_CTRL_PME_ENABLE;
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002042 pmcsr &= ~PCI_PM_CTRL_PME_STATUS;
Rafael J. Wysockidc15e712017-06-12 22:53:36 +02002043 } else {
2044 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2045 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2046 }
2047 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2048}
2049
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002050/**
2051 * pci_pme_active - enable or disable PCI device's PME# function
2052 * @dev: PCI device to handle.
2053 * @enable: 'true' to enable PME# generation; 'false' to disable it.
2054 *
2055 * The caller must verify that the device is capable of generating PME# before
2056 * calling this function with @enable equal to 'true'.
2057 */
2058void pci_pme_active(struct pci_dev *dev, bool enable)
2059{
2060 __pci_pme_active(dev, enable);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002061
Huang Ying6e965e02012-10-26 13:07:51 +08002062 /*
2063 * PCI (as opposed to PCIe) PME requires that the device have
2064 * its PME# line hooked up correctly. Not all hardware vendors
2065 * do this, so the PME never gets delivered and the device
2066 * remains asleep. The easiest way around this is to
2067 * periodically walk the list of suspended devices and check
2068 * whether any have their PME flag set. The assumption is that
2069 * we'll wake up often enough anyway that this won't be a huge
2070 * hit, and the power savings from the devices will still be a
2071 * win.
2072 *
2073 * Although PCIe uses in-band PME message instead of PME# line
2074 * to report PME, PME does not work for some PCIe devices in
2075 * reality. For example, there are devices that set their PME
2076 * status bits, but don't really bother to send a PME message;
2077 * there are PCI Express Root Ports that don't bother to
2078 * trigger interrupts when they receive PME messages from the
2079 * devices below. So PME poll is used for PCIe devices too.
2080 */
Matthew Garrettdf17e622010-10-04 14:22:29 -04002081
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002082 if (dev->pme_poll) {
Matthew Garrettdf17e622010-10-04 14:22:29 -04002083 struct pci_pme_device *pme_dev;
2084 if (enable) {
2085 pme_dev = kmalloc(sizeof(struct pci_pme_device),
2086 GFP_KERNEL);
Bjorn Helgaas0394cb12013-10-16 12:32:53 -06002087 if (!pme_dev) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002088 pci_warn(dev, "can't enable PME#\n");
Bjorn Helgaas0394cb12013-10-16 12:32:53 -06002089 return;
2090 }
Matthew Garrettdf17e622010-10-04 14:22:29 -04002091 pme_dev->dev = dev;
2092 mutex_lock(&pci_pme_list_mutex);
2093 list_add(&pme_dev->list, &pci_pme_list);
2094 if (list_is_singular(&pci_pme_list))
Lukas Wunnerea003532017-04-18 20:44:30 +02002095 queue_delayed_work(system_freezable_wq,
2096 &pci_pme_work,
2097 msecs_to_jiffies(PME_TIMEOUT));
Matthew Garrettdf17e622010-10-04 14:22:29 -04002098 mutex_unlock(&pci_pme_list_mutex);
2099 } else {
2100 mutex_lock(&pci_pme_list_mutex);
2101 list_for_each_entry(pme_dev, &pci_pme_list, list) {
2102 if (pme_dev->dev == dev) {
2103 list_del(&pme_dev->list);
2104 kfree(pme_dev);
2105 break;
2106 }
2107 }
2108 mutex_unlock(&pci_pme_list_mutex);
2109 }
2110 }
2111
Frederick Lawler7506dc72018-01-18 12:55:24 -06002112 pci_dbg(dev, "PME# %s\n", enable ? "enabled" : "disabled");
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002113}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002114EXPORT_SYMBOL(pci_pme_active);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002115
2116/**
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002117 * __pci_enable_wake - enable PCI device as wakeup event source
David Brownell075c1772007-04-26 00:12:06 -07002118 * @dev: PCI device affected
2119 * @state: PCI state from which device will issue wakeup events
2120 * @enable: True to enable event generation; false to disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 *
David Brownell075c1772007-04-26 00:12:06 -07002122 * This enables the device as a wakeup event source, or disables it.
2123 * When such events involves platform-specific hooks, those hooks are
2124 * called automatically by this routine.
2125 *
2126 * Devices with legacy power management (no standard PCI PM capabilities)
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002127 * always require such platform hooks.
David Brownell075c1772007-04-26 00:12:06 -07002128 *
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002129 * RETURN VALUE:
2130 * 0 is returned on success
2131 * -EINVAL is returned if device is not supposed to wake up the system
2132 * Error code depending on the platform is returned if both the platform and
2133 * the native mechanism fail to enable the generation of wake-up events
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 */
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002135static int __pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136{
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002137 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002139 /*
Mika Westerbergac86e8e2018-09-27 16:53:53 -05002140 * Bridges that are not power-manageable directly only signal
2141 * wakeup on behalf of subordinate devices which is set up
2142 * elsewhere, so skip them. However, bridges that are
2143 * power-manageable may signal wakeup for themselves (for example,
2144 * on a hotplug event) and they need to be covered here.
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002145 */
Mika Westerbergac86e8e2018-09-27 16:53:53 -05002146 if (!pci_power_manageable(dev))
Rafael J. Wysockibaecc472017-07-21 14:38:08 +02002147 return 0;
2148
Rafael J. Wysocki0ce3fca2017-07-12 03:05:39 +02002149 /* Don't do the same thing twice in a row for one device. */
2150 if (!!enable == !!dev->wakeup_prepared)
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002151 return 0;
2152
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002153 /*
2154 * According to "PCI System Architecture" 4th ed. by Tom Shanley & Don
2155 * Anderson we should be doing PME# wake enable followed by ACPI wake
2156 * enable. To disable wake-up we call the platform first, for symmetry.
David Brownell075c1772007-04-26 00:12:06 -07002157 */
2158
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002159 if (enable) {
2160 int error;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002161
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002162 if (pci_pme_capable(dev, state))
2163 pci_pme_active(dev, true);
2164 else
2165 ret = 1;
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002166 error = platform_pci_set_wakeup(dev, true);
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002167 if (ret)
2168 ret = error;
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002169 if (!ret)
2170 dev->wakeup_prepared = true;
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002171 } else {
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002172 platform_pci_set_wakeup(dev, false);
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002173 pci_pme_active(dev, false);
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002174 dev->wakeup_prepared = false;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002175 }
2176
Rafael J. Wysocki5bcc2fb2009-09-08 23:12:59 +02002177 return ret;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002178}
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002179
2180/**
2181 * pci_enable_wake - change wakeup settings for a PCI device
2182 * @pci_dev: Target device
2183 * @state: PCI state from which device will issue wakeup events
2184 * @enable: Whether or not to enable event generation
2185 *
2186 * If @enable is set, check device_may_wakeup() for the device before calling
2187 * __pci_enable_wake() for it.
2188 */
2189int pci_enable_wake(struct pci_dev *pci_dev, pci_power_t state, bool enable)
2190{
2191 if (enable && !device_may_wakeup(&pci_dev->dev))
2192 return -EINVAL;
2193
2194 return __pci_enable_wake(pci_dev, state, enable);
2195}
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002196EXPORT_SYMBOL(pci_enable_wake);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002197
2198/**
Rafael J. Wysocki0235c4f2008-08-18 21:38:00 +02002199 * pci_wake_from_d3 - enable/disable device to wake up from D3_hot or D3_cold
2200 * @dev: PCI device to prepare
2201 * @enable: True to enable wake-up event generation; false to disable
2202 *
2203 * Many drivers want the device to wake up the system from D3_hot or D3_cold
2204 * and this function allows them to set that up cleanly - pci_enable_wake()
2205 * should not be called twice in a row to enable wake-up due to PCI PM vs ACPI
2206 * ordering constraints.
2207 *
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002208 * This function only returns error code if the device is not allowed to wake
2209 * up the system from sleep or it is not capable of generating PME# from both
2210 * 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 +02002211 */
2212int pci_wake_from_d3(struct pci_dev *dev, bool enable)
2213{
2214 return pci_pme_capable(dev, PCI_D3cold) ?
2215 pci_enable_wake(dev, PCI_D3cold, enable) :
2216 pci_enable_wake(dev, PCI_D3hot, enable);
2217}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002218EXPORT_SYMBOL(pci_wake_from_d3);
Rafael J. Wysocki0235c4f2008-08-18 21:38:00 +02002219
2220/**
Jesse Barnes37139072008-07-28 11:49:26 -07002221 * pci_target_state - find an appropriate low power state for a given PCI dev
2222 * @dev: PCI device
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002223 * @wakeup: Whether or not wakeup functionality will be enabled for the device.
Jesse Barnes37139072008-07-28 11:49:26 -07002224 *
2225 * Use underlying platform code to find a supported low power state for @dev.
2226 * If the platform can't manage @dev, return the deepest state from which it
2227 * can generate wake events, based on any available PME info.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002228 */
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002229static pci_power_t pci_target_state(struct pci_dev *dev, bool wakeup)
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002230{
2231 pci_power_t target_state = PCI_D3hot;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002232
2233 if (platform_pci_power_manageable(dev)) {
2234 /*
Rafael J. Wysocki60ee031a2018-05-21 13:11:12 +02002235 * Call the platform to find the target state for the device.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002236 */
2237 pci_power_t state = platform_pci_choose_state(dev);
2238
2239 switch (state) {
2240 case PCI_POWER_ERROR:
2241 case PCI_UNKNOWN:
2242 break;
2243 case PCI_D1:
2244 case PCI_D2:
2245 if (pci_no_d1d2(dev))
2246 break;
Gustavo A. R. Silvad6488ac2018-07-05 09:56:00 -05002247 /* else: fall through */
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002248 default:
2249 target_state = state;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002250 }
Lukas Wunner4132a572016-09-18 05:39:20 +02002251
2252 return target_state;
2253 }
2254
2255 if (!dev->pm_cap)
Rafael J. Wysockid2abdf62009-06-14 21:25:02 +02002256 target_state = PCI_D0;
Lukas Wunner4132a572016-09-18 05:39:20 +02002257
2258 /*
2259 * If the device is in D3cold even though it's not power-manageable by
2260 * the platform, it may have been powered down by non-standard means.
2261 * Best to let it slumber.
2262 */
2263 if (dev->current_state == PCI_D3cold)
2264 target_state = PCI_D3cold;
2265
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002266 if (wakeup) {
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002267 /*
2268 * Find the deepest state from which the device can generate
Rafael J. Wysocki60ee031a2018-05-21 13:11:12 +02002269 * PME#.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002270 */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002271 if (dev->pme_support) {
2272 while (target_state
2273 && !(dev->pme_support & (1 << target_state)))
2274 target_state--;
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002275 }
2276 }
2277
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002278 return target_state;
2279}
2280
2281/**
2282 * pci_prepare_to_sleep - prepare PCI device for system-wide transition into a sleep state
2283 * @dev: Device to handle.
2284 *
2285 * Choose the power state appropriate for the device depending on whether
2286 * it can wake up the system and/or is power manageable by the platform
2287 * (PCI_D3hot is the default) and put the device into that state.
2288 */
2289int pci_prepare_to_sleep(struct pci_dev *dev)
2290{
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002291 bool wakeup = device_may_wakeup(&dev->dev);
2292 pci_power_t target_state = pci_target_state(dev, wakeup);
Rafael J. Wysockie5899e12008-07-19 14:39:24 +02002293 int error;
2294
2295 if (target_state == PCI_POWER_ERROR)
2296 return -EIO;
2297
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002298 pci_enable_wake(dev, target_state, wakeup);
Rafael J. Wysockic157dfa2008-07-13 22:45:06 +02002299
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002300 error = pci_set_power_state(dev, target_state);
2301
2302 if (error)
2303 pci_enable_wake(dev, target_state, false);
2304
2305 return error;
2306}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002307EXPORT_SYMBOL(pci_prepare_to_sleep);
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002308
2309/**
Randy Dunlap443bd1c2008-07-21 09:27:18 -07002310 * pci_back_from_sleep - turn PCI device on during system-wide transition into working state
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002311 * @dev: Device to handle.
2312 *
Thomas Weber88393162010-03-16 11:47:56 +01002313 * Disable device's system wake-up capability and put it into D0.
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002314 */
2315int pci_back_from_sleep(struct pci_dev *dev)
2316{
2317 pci_enable_wake(dev, PCI_D0, false);
2318 return pci_set_power_state(dev, PCI_D0);
2319}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06002320EXPORT_SYMBOL(pci_back_from_sleep);
Rafael J. Wysocki404cc2d2008-07-07 03:35:26 +02002321
2322/**
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002323 * pci_finish_runtime_suspend - Carry out PCI-specific part of runtime suspend.
2324 * @dev: PCI device being suspended.
2325 *
2326 * Prepare @dev to generate wake-up events at run time and put it into a low
2327 * power state.
2328 */
2329int pci_finish_runtime_suspend(struct pci_dev *dev)
2330{
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002331 pci_power_t target_state;
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002332 int error;
2333
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002334 target_state = pci_target_state(dev, device_can_wakeup(&dev->dev));
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002335 if (target_state == PCI_POWER_ERROR)
2336 return -EIO;
2337
Huang Ying448bd852012-06-23 10:23:51 +08002338 dev->runtime_d3cold = target_state == PCI_D3cold;
2339
Rafael J. Wysockicfcadfa2018-05-09 00:18:32 +02002340 __pci_enable_wake(dev, target_state, pci_dev_run_wake(dev));
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002341
2342 error = pci_set_power_state(dev, target_state);
2343
Huang Ying448bd852012-06-23 10:23:51 +08002344 if (error) {
Rafael J. Wysocki08476842017-06-24 01:57:35 +02002345 pci_enable_wake(dev, target_state, false);
Huang Ying448bd852012-06-23 10:23:51 +08002346 dev->runtime_d3cold = false;
2347 }
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +01002348
2349 return error;
2350}
2351
2352/**
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002353 * pci_dev_run_wake - Check if device can generate run-time wake-up events.
2354 * @dev: Device to check.
2355 *
Bjorn Helgaasf7625982013-11-14 11:28:18 -07002356 * Return true if the device itself is capable of generating wake-up events
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002357 * (through the platform or using the native PCIe PME) or if the device supports
2358 * PME and one of its upstream bridges can generate wake-up events.
2359 */
2360bool pci_dev_run_wake(struct pci_dev *dev)
2361{
2362 struct pci_bus *bus = dev->bus;
2363
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002364 if (!dev->pme_support)
2365 return false;
2366
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002367 /* PME-capable in principle, but not from the target power state */
Kai Heng Feng8feaec32018-05-07 14:11:20 +08002368 if (!pci_pme_capable(dev, pci_target_state(dev, true)))
Alan Stern6496ebd2016-10-21 16:45:38 -04002369 return false;
2370
Kai Heng Feng8feaec32018-05-07 14:11:20 +08002371 if (device_can_wakeup(&dev->dev))
2372 return true;
2373
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002374 while (bus->parent) {
2375 struct pci_dev *bridge = bus->self;
2376
Rafael J. Wysockide3ef1e2017-06-24 01:58:53 +02002377 if (device_can_wakeup(&bridge->dev))
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002378 return true;
2379
2380 bus = bus->parent;
2381 }
2382
2383 /* We have reached the root bus. */
2384 if (bus->bridge)
Rafael J. Wysockide3ef1e2017-06-24 01:58:53 +02002385 return device_can_wakeup(bus->bridge);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002386
2387 return false;
2388}
2389EXPORT_SYMBOL_GPL(pci_dev_run_wake);
2390
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002391/**
2392 * pci_dev_keep_suspended - Check if the device can stay in the suspended state.
2393 * @pci_dev: Device to check.
2394 *
2395 * Return 'true' if the device is runtime-suspended, it doesn't have to be
2396 * reconfigured due to wakeup settings difference between system and runtime
2397 * suspend and the current power state of it is suitable for the upcoming
2398 * (system) transition.
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002399 *
2400 * If the device is not configured for system wakeup, disable PME for it before
2401 * returning 'true' to prevent it from waking up the system unnecessarily.
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002402 */
2403bool pci_dev_keep_suspended(struct pci_dev *pci_dev)
2404{
2405 struct device *dev = &pci_dev->dev;
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002406 bool wakeup = device_may_wakeup(dev);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002407
2408 if (!pm_runtime_suspended(dev)
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002409 || pci_target_state(pci_dev, wakeup) != pci_dev->current_state
Rafael J. Wysockic2eac4d2017-10-25 14:16:46 +02002410 || platform_pci_need_resume(pci_dev))
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002411 return false;
2412
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002413 /*
2414 * At this point the device is good to go unless it's been configured
2415 * to generate PME at the runtime suspend time, but it is not supposed
2416 * to wake up the system. In that case, simply disable PME for it
2417 * (it will have to be re-enabled on exit from system resume).
2418 *
2419 * If the device's power state is D3cold and the platform check above
2420 * hasn't triggered, the device's configuration is suitable and we don't
2421 * need to manipulate it at all.
2422 */
2423 spin_lock_irq(&dev->power.lock);
2424
2425 if (pm_runtime_suspended(dev) && pci_dev->current_state < PCI_D3cold &&
Rafael J. Wysocki666ff6f2017-06-23 14:58:11 +02002426 !wakeup)
Rafael J. Wysocki2cef5482015-09-30 01:10:24 +02002427 __pci_pme_active(pci_dev, false);
2428
2429 spin_unlock_irq(&dev->power.lock);
2430 return true;
2431}
2432
2433/**
2434 * pci_dev_complete_resume - Finalize resume from system sleep for a device.
2435 * @pci_dev: Device to handle.
2436 *
2437 * If the device is runtime suspended and wakeup-capable, enable PME for it as
2438 * it might have been disabled during the prepare phase of system suspend if
2439 * the device was not configured for system wakeup.
2440 */
2441void pci_dev_complete_resume(struct pci_dev *pci_dev)
2442{
2443 struct device *dev = &pci_dev->dev;
2444
2445 if (!pci_dev_run_wake(pci_dev))
2446 return;
2447
2448 spin_lock_irq(&dev->power.lock);
2449
2450 if (pm_runtime_suspended(dev) && pci_dev->current_state < PCI_D3cold)
2451 __pci_pme_active(pci_dev, true);
2452
2453 spin_unlock_irq(&dev->power.lock);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +01002454}
2455
Huang Yingb3c32c42012-10-25 09:36:03 +08002456void pci_config_pm_runtime_get(struct pci_dev *pdev)
2457{
2458 struct device *dev = &pdev->dev;
2459 struct device *parent = dev->parent;
2460
2461 if (parent)
2462 pm_runtime_get_sync(parent);
2463 pm_runtime_get_noresume(dev);
2464 /*
2465 * pdev->current_state is set to PCI_D3cold during suspending,
2466 * so wait until suspending completes
2467 */
2468 pm_runtime_barrier(dev);
2469 /*
2470 * Only need to resume devices in D3cold, because config
2471 * registers are still accessible for devices suspended but
2472 * not in D3cold.
2473 */
2474 if (pdev->current_state == PCI_D3cold)
2475 pm_runtime_resume(dev);
2476}
2477
2478void pci_config_pm_runtime_put(struct pci_dev *pdev)
2479{
2480 struct device *dev = &pdev->dev;
2481 struct device *parent = dev->parent;
2482
2483 pm_runtime_put(dev);
2484 if (parent)
2485 pm_runtime_put_sync(parent);
2486}
2487
Rafael J. Wysockib67ea762010-02-17 23:44:09 +01002488/**
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002489 * pci_bridge_d3_possible - Is it possible to put the bridge into D3
2490 * @bridge: Bridge to check
2491 *
2492 * This function checks if it is possible to move the bridge to D3.
Lukas Wunner47a8e232018-07-19 17:28:00 -05002493 * Currently we only allow D3 for recent enough PCIe ports and Thunderbolt.
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002494 */
Lukas Wunnerc6a63302016-10-28 10:52:06 +02002495bool pci_bridge_d3_possible(struct pci_dev *bridge)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002496{
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002497 if (!pci_is_pcie(bridge))
2498 return false;
2499
2500 switch (pci_pcie_type(bridge)) {
2501 case PCI_EXP_TYPE_ROOT_PORT:
2502 case PCI_EXP_TYPE_UPSTREAM:
2503 case PCI_EXP_TYPE_DOWNSTREAM:
2504 if (pci_bridge_d3_disable)
2505 return false;
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002506
2507 /*
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002508 * Hotplug ports handled by firmware in System Management Mode
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002509 * may not be put into D3 by the OS (Thunderbolt on non-Macs).
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002510 */
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002511 if (bridge->is_hotplug_bridge && !pciehp_is_native(bridge))
Lukas Wunner97a90ae2016-10-28 10:52:06 +02002512 return false;
2513
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002514 if (pci_bridge_d3_force)
2515 return true;
2516
Lukas Wunner47a8e232018-07-19 17:28:00 -05002517 /* Even the oldest 2010 Thunderbolt controller supports D3. */
2518 if (bridge->is_thunderbolt)
2519 return true;
2520
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002521 /*
Lukas Wunnereb3b5bf2018-07-19 17:27:59 -05002522 * Hotplug ports handled natively by the OS were not validated
2523 * by vendors for runtime D3 at least until 2018 because there
2524 * was no OS support.
2525 */
2526 if (bridge->is_hotplug_bridge)
2527 return false;
2528
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002529 /*
2530 * It should be safe to put PCIe ports from 2015 or newer
2531 * to D3.
2532 */
Andy Shevchenkoac950902018-02-22 14:59:23 +02002533 if (dmi_get_bios_year() >= 2015)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002534 return true;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002535 break;
2536 }
2537
2538 return false;
2539}
2540
2541static int pci_dev_check_d3cold(struct pci_dev *dev, void *data)
2542{
2543 bool *d3cold_ok = data;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002544
Lukas Wunner718a0602016-10-28 10:52:06 +02002545 if (/* The device needs to be allowed to go D3cold ... */
2546 dev->no_d3cold || !dev->d3cold_allowed ||
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002547
Lukas Wunner718a0602016-10-28 10:52:06 +02002548 /* ... and if it is wakeup capable to do so from D3cold. */
2549 (device_may_wakeup(&dev->dev) &&
2550 !pci_pme_capable(dev, PCI_D3cold)) ||
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002551
Lukas Wunner718a0602016-10-28 10:52:06 +02002552 /* If it is a bridge it must be allowed to go to D3. */
Bjorn Helgaasd98e0922017-02-03 08:53:51 -06002553 !pci_power_manageable(dev))
Lukas Wunner718a0602016-10-28 10:52:06 +02002554
2555 *d3cold_ok = false;
2556
2557 return !*d3cold_ok;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002558}
2559
2560/*
2561 * pci_bridge_d3_update - Update bridge D3 capabilities
2562 * @dev: PCI device which is changed
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002563 *
2564 * Update upstream bridge PM capabilities accordingly depending on if the
2565 * device PM configuration was changed or the device is being removed. The
2566 * change is also propagated upstream.
2567 */
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002568void pci_bridge_d3_update(struct pci_dev *dev)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002569{
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002570 bool remove = !device_is_registered(&dev->dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002571 struct pci_dev *bridge;
2572 bool d3cold_ok = true;
2573
2574 bridge = pci_upstream_bridge(dev);
2575 if (!bridge || !pci_bridge_d3_possible(bridge))
2576 return;
2577
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002578 /*
Lukas Wunnere8559b712016-10-28 10:52:06 +02002579 * If D3 is currently allowed for the bridge, removing one of its
2580 * children won't change that.
2581 */
2582 if (remove && bridge->bridge_d3)
2583 return;
2584
2585 /*
2586 * If D3 is currently allowed for the bridge and a child is added or
2587 * changed, disallowance of D3 can only be caused by that child, so
2588 * we only need to check that single device, not any of its siblings.
2589 *
2590 * If D3 is currently not allowed for the bridge, checking the device
2591 * first may allow us to skip checking its siblings.
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002592 */
2593 if (!remove)
2594 pci_dev_check_d3cold(dev, &d3cold_ok);
2595
Lukas Wunnere8559b712016-10-28 10:52:06 +02002596 /*
2597 * If D3 is currently not allowed for the bridge, this may be caused
2598 * either by the device being changed/removed or any of its siblings,
2599 * so we need to go through all children to find out if one of them
2600 * continues to block D3.
2601 */
2602 if (d3cold_ok && !bridge->bridge_d3)
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002603 pci_walk_bus(bridge->subordinate, pci_dev_check_d3cold,
2604 &d3cold_ok);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002605
2606 if (bridge->bridge_d3 != d3cold_ok) {
2607 bridge->bridge_d3 = d3cold_ok;
2608 /* Propagate change to upstream bridges */
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002609 pci_bridge_d3_update(bridge);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002610 }
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002611}
2612
2613/**
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002614 * pci_d3cold_enable - Enable D3cold for device
2615 * @dev: PCI device to handle
2616 *
2617 * This function can be used in drivers to enable D3cold from the device
2618 * they handle. It also updates upstream PCI bridge PM capabilities
2619 * accordingly.
2620 */
2621void pci_d3cold_enable(struct pci_dev *dev)
2622{
2623 if (dev->no_d3cold) {
2624 dev->no_d3cold = false;
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002625 pci_bridge_d3_update(dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002626 }
2627}
2628EXPORT_SYMBOL_GPL(pci_d3cold_enable);
2629
2630/**
2631 * pci_d3cold_disable - Disable D3cold for device
2632 * @dev: PCI device to handle
2633 *
2634 * This function can be used in drivers to disable D3cold from the device
2635 * they handle. It also updates upstream PCI bridge PM capabilities
2636 * accordingly.
2637 */
2638void pci_d3cold_disable(struct pci_dev *dev)
2639{
2640 if (!dev->no_d3cold) {
2641 dev->no_d3cold = true;
Lukas Wunner1ed276a2016-10-28 10:52:06 +02002642 pci_bridge_d3_update(dev);
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002643 }
2644}
2645EXPORT_SYMBOL_GPL(pci_d3cold_disable);
2646
2647/**
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002648 * pci_pm_init - Initialize PM functions of given PCI device
2649 * @dev: PCI device to handle.
2650 */
2651void pci_pm_init(struct pci_dev *dev)
2652{
2653 int pm;
2654 u16 pmc;
David Brownell075c1772007-04-26 00:12:06 -07002655
Rafael J. Wysockibb910a72010-02-27 21:37:37 +01002656 pm_runtime_forbid(&dev->dev);
Huang Ying967577b2012-11-20 16:08:22 +08002657 pm_runtime_set_active(&dev->dev);
2658 pm_runtime_enable(&dev->dev);
Rafael J. Wysockia1e4d722010-02-08 19:16:33 +01002659 device_enable_async_suspend(&dev->dev);
Rafael J. Wysockie80bb092009-09-08 23:14:49 +02002660 dev->wakeup_prepared = false;
Rafael J. Wysockibb910a72010-02-27 21:37:37 +01002661
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002662 dev->pm_cap = 0;
Rafael J. Wysockiffaddbe2013-04-10 10:32:51 +00002663 dev->pme_support = 0;
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002664
Linus Torvalds1da177e2005-04-16 15:20:36 -07002665 /* find PCI PM capability in list */
2666 pm = pci_find_capability(dev, PCI_CAP_ID_PM);
David Brownell075c1772007-04-26 00:12:06 -07002667 if (!pm)
Linus Torvalds50246dd2009-01-16 08:14:51 -08002668 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 /* Check device's ability to generate PME# */
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002670 pci_read_config_word(dev, pm + PCI_PM_PMC, &pmc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002672 if ((pmc & PCI_PM_CAP_VER_MASK) > 3) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002673 pci_err(dev, "unsupported PM cap regs version (%u)\n",
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002674 pmc & PCI_PM_CAP_VER_MASK);
Linus Torvalds50246dd2009-01-16 08:14:51 -08002675 return;
David Brownell075c1772007-04-26 00:12:06 -07002676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002678 dev->pm_cap = pm;
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01002679 dev->d3_delay = PCI_PM_D3_WAIT;
Huang Ying448bd852012-06-23 10:23:51 +08002680 dev->d3cold_delay = PCI_PM_D3COLD_WAIT;
Mika Westerberg9d26d3a2016-06-02 11:17:12 +03002681 dev->bridge_d3 = pci_bridge_d3_possible(dev);
Huang Ying4f9c1392012-08-08 09:07:38 +08002682 dev->d3cold_allowed = true;
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002683
2684 dev->d1_support = false;
2685 dev->d2_support = false;
2686 if (!pci_no_d1d2(dev)) {
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06002687 if (pmc & PCI_PM_CAP_D1)
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002688 dev->d1_support = true;
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06002689 if (pmc & PCI_PM_CAP_D2)
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002690 dev->d2_support = true;
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06002691
2692 if (dev->d1_support || dev->d2_support)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002693 pci_printk(KERN_DEBUG, dev, "supports%s%s\n",
Jesse Barnesec84f122008-09-23 11:43:34 -07002694 dev->d1_support ? " D1" : "",
2695 dev->d2_support ? " D2" : "");
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002696 }
2697
2698 pmc &= PCI_PM_CAP_PME_MASK;
2699 if (pmc) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002700 pci_printk(KERN_DEBUG, dev, "PME# supported from%s%s%s%s%s\n",
Bjorn Helgaasc9ed77e2008-08-22 09:37:02 -06002701 (pmc & PCI_PM_CAP_PME_D0) ? " D0" : "",
2702 (pmc & PCI_PM_CAP_PME_D1) ? " D1" : "",
2703 (pmc & PCI_PM_CAP_PME_D2) ? " D2" : "",
2704 (pmc & PCI_PM_CAP_PME_D3) ? " D3hot" : "",
2705 (pmc & PCI_PM_CAP_PME_D3cold) ? " D3cold" : "");
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002706 dev->pme_support = pmc >> PCI_PM_CAP_PME_SHIFT;
Rafael J. Wysocki379021d2011-10-03 23:16:33 +02002707 dev->pme_poll = true;
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002708 /*
2709 * Make device's PM flags reflect the wake-up capability, but
2710 * let the user space enable it to wake up the system as needed.
2711 */
2712 device_set_wakeup_capable(&dev->dev, true);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002713 /* Disable the PME# generation functionality */
Rafael J. Wysocki337001b2008-07-07 03:36:24 +02002714 pci_pme_active(dev, false);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +02002715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716}
2717
Sean O. Stalley938174e2015-10-29 17:35:39 -05002718static unsigned long pci_ea_flags(struct pci_dev *dev, u8 prop)
2719{
Alex Williamson92efb1b2016-05-16 15:12:02 -05002720 unsigned long flags = IORESOURCE_PCI_FIXED | IORESOURCE_PCI_EA_BEI;
Sean O. Stalley938174e2015-10-29 17:35:39 -05002721
2722 switch (prop) {
2723 case PCI_EA_P_MEM:
2724 case PCI_EA_P_VF_MEM:
2725 flags |= IORESOURCE_MEM;
2726 break;
2727 case PCI_EA_P_MEM_PREFETCH:
2728 case PCI_EA_P_VF_MEM_PREFETCH:
2729 flags |= IORESOURCE_MEM | IORESOURCE_PREFETCH;
2730 break;
2731 case PCI_EA_P_IO:
2732 flags |= IORESOURCE_IO;
2733 break;
2734 default:
2735 return 0;
2736 }
2737
2738 return flags;
2739}
2740
2741static struct resource *pci_ea_get_resource(struct pci_dev *dev, u8 bei,
2742 u8 prop)
2743{
2744 if (bei <= PCI_EA_BEI_BAR5 && prop <= PCI_EA_P_IO)
2745 return &dev->resource[bei];
David Daney11183992015-10-29 17:35:40 -05002746#ifdef CONFIG_PCI_IOV
2747 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5 &&
2748 (prop == PCI_EA_P_VF_MEM || prop == PCI_EA_P_VF_MEM_PREFETCH))
2749 return &dev->resource[PCI_IOV_RESOURCES +
2750 bei - PCI_EA_BEI_VF_BAR0];
2751#endif
Sean O. Stalley938174e2015-10-29 17:35:39 -05002752 else if (bei == PCI_EA_BEI_ROM)
2753 return &dev->resource[PCI_ROM_RESOURCE];
2754 else
2755 return NULL;
2756}
2757
2758/* Read an Enhanced Allocation (EA) entry */
2759static int pci_ea_read(struct pci_dev *dev, int offset)
2760{
2761 struct resource *res;
2762 int ent_size, ent_offset = offset;
2763 resource_size_t start, end;
2764 unsigned long flags;
Bjorn Helgaas26635112015-10-29 17:35:40 -05002765 u32 dw0, bei, base, max_offset;
Sean O. Stalley938174e2015-10-29 17:35:39 -05002766 u8 prop;
2767 bool support_64 = (sizeof(resource_size_t) >= 8);
2768
2769 pci_read_config_dword(dev, ent_offset, &dw0);
2770 ent_offset += 4;
2771
2772 /* Entry size field indicates DWORDs after 1st */
2773 ent_size = ((dw0 & PCI_EA_ES) + 1) << 2;
2774
2775 if (!(dw0 & PCI_EA_ENABLE)) /* Entry not enabled */
2776 goto out;
2777
Bjorn Helgaas26635112015-10-29 17:35:40 -05002778 bei = (dw0 & PCI_EA_BEI) >> 4;
2779 prop = (dw0 & PCI_EA_PP) >> 8;
2780
Sean O. Stalley938174e2015-10-29 17:35:39 -05002781 /*
2782 * If the Property is in the reserved range, try the Secondary
2783 * Property instead.
2784 */
2785 if (prop > PCI_EA_P_BRIDGE_IO && prop < PCI_EA_P_MEM_RESERVED)
Bjorn Helgaas26635112015-10-29 17:35:40 -05002786 prop = (dw0 & PCI_EA_SP) >> 16;
Sean O. Stalley938174e2015-10-29 17:35:39 -05002787 if (prop > PCI_EA_P_BRIDGE_IO)
2788 goto out;
2789
Bjorn Helgaas26635112015-10-29 17:35:40 -05002790 res = pci_ea_get_resource(dev, bei, prop);
Sean O. Stalley938174e2015-10-29 17:35:39 -05002791 if (!res) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002792 pci_err(dev, "Unsupported EA entry BEI: %u\n", bei);
Sean O. Stalley938174e2015-10-29 17:35:39 -05002793 goto out;
2794 }
2795
2796 flags = pci_ea_flags(dev, prop);
2797 if (!flags) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002798 pci_err(dev, "Unsupported EA properties: %#x\n", prop);
Sean O. Stalley938174e2015-10-29 17:35:39 -05002799 goto out;
2800 }
2801
2802 /* Read Base */
2803 pci_read_config_dword(dev, ent_offset, &base);
2804 start = (base & PCI_EA_FIELD_MASK);
2805 ent_offset += 4;
2806
2807 /* Read MaxOffset */
2808 pci_read_config_dword(dev, ent_offset, &max_offset);
2809 ent_offset += 4;
2810
2811 /* Read Base MSBs (if 64-bit entry) */
2812 if (base & PCI_EA_IS_64) {
2813 u32 base_upper;
2814
2815 pci_read_config_dword(dev, ent_offset, &base_upper);
2816 ent_offset += 4;
2817
2818 flags |= IORESOURCE_MEM_64;
2819
2820 /* entry starts above 32-bit boundary, can't use */
2821 if (!support_64 && base_upper)
2822 goto out;
2823
2824 if (support_64)
2825 start |= ((u64)base_upper << 32);
2826 }
2827
2828 end = start + (max_offset | 0x03);
2829
2830 /* Read MaxOffset MSBs (if 64-bit entry) */
2831 if (max_offset & PCI_EA_IS_64) {
2832 u32 max_offset_upper;
2833
2834 pci_read_config_dword(dev, ent_offset, &max_offset_upper);
2835 ent_offset += 4;
2836
2837 flags |= IORESOURCE_MEM_64;
2838
2839 /* entry too big, can't use */
2840 if (!support_64 && max_offset_upper)
2841 goto out;
2842
2843 if (support_64)
2844 end += ((u64)max_offset_upper << 32);
2845 }
2846
2847 if (end < start) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002848 pci_err(dev, "EA Entry crosses address boundary\n");
Sean O. Stalley938174e2015-10-29 17:35:39 -05002849 goto out;
2850 }
2851
2852 if (ent_size != ent_offset - offset) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06002853 pci_err(dev, "EA Entry Size (%d) does not match length read (%d)\n",
Sean O. Stalley938174e2015-10-29 17:35:39 -05002854 ent_size, ent_offset - offset);
2855 goto out;
2856 }
2857
2858 res->name = pci_name(dev);
2859 res->start = start;
2860 res->end = end;
2861 res->flags = flags;
Bjorn Helgaas597becb2015-10-29 17:35:40 -05002862
2863 if (bei <= PCI_EA_BEI_BAR5)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002864 pci_printk(KERN_DEBUG, dev, "BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05002865 bei, res, prop);
2866 else if (bei == PCI_EA_BEI_ROM)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002867 pci_printk(KERN_DEBUG, dev, "ROM: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05002868 res, prop);
2869 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002870 pci_printk(KERN_DEBUG, dev, "VF BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05002871 bei - PCI_EA_BEI_VF_BAR0, res, prop);
2872 else
Frederick Lawler7506dc72018-01-18 12:55:24 -06002873 pci_printk(KERN_DEBUG, dev, "BEI %d res: %pR (from Enhanced Allocation, properties %#02x)\n",
Bjorn Helgaas597becb2015-10-29 17:35:40 -05002874 bei, res, prop);
2875
Sean O. Stalley938174e2015-10-29 17:35:39 -05002876out:
2877 return offset + ent_size;
2878}
2879
Colin Ian Kingdcbb4082016-04-05 12:12:45 -05002880/* Enhanced Allocation Initialization */
Sean O. Stalley938174e2015-10-29 17:35:39 -05002881void pci_ea_init(struct pci_dev *dev)
2882{
2883 int ea;
2884 u8 num_ent;
2885 int offset;
2886 int i;
2887
2888 /* find PCI EA capability in list */
2889 ea = pci_find_capability(dev, PCI_CAP_ID_EA);
2890 if (!ea)
2891 return;
2892
2893 /* determine the number of entries */
2894 pci_bus_read_config_byte(dev->bus, dev->devfn, ea + PCI_EA_NUM_ENT,
2895 &num_ent);
2896 num_ent &= PCI_EA_NUM_ENT_MASK;
2897
2898 offset = ea + PCI_EA_FIRST_ENT;
2899
2900 /* Skip DWORD 2 for type 1 functions */
2901 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE)
2902 offset += 4;
2903
2904 /* parse each EA entry */
2905 for (i = 0; i < num_ent; ++i)
2906 offset = pci_ea_read(dev, offset);
2907}
2908
Yinghai Lu34a48762012-02-11 00:18:41 -08002909static void pci_add_saved_cap(struct pci_dev *pci_dev,
2910 struct pci_cap_saved_state *new_cap)
2911{
2912 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
2913}
2914
Jesse Barneseb9c39d2008-12-17 12:10:05 -08002915/**
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002916 * _pci_add_cap_save_buffer - allocate buffer for saving given
2917 * capability registers
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002918 * @dev: the PCI device
2919 * @cap: the capability to allocate the buffer for
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002920 * @extended: Standard or Extended capability ID
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002921 * @size: requested size of the buffer
2922 */
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002923static int _pci_add_cap_save_buffer(struct pci_dev *dev, u16 cap,
2924 bool extended, unsigned int size)
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002925{
2926 int pos;
2927 struct pci_cap_saved_state *save_state;
2928
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002929 if (extended)
2930 pos = pci_find_ext_capability(dev, cap);
2931 else
2932 pos = pci_find_capability(dev, cap);
2933
Wei Yang0a1a9b42015-06-30 09:16:44 +08002934 if (!pos)
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002935 return 0;
2936
2937 save_state = kzalloc(sizeof(*save_state) + size, GFP_KERNEL);
2938 if (!save_state)
2939 return -ENOMEM;
2940
Alex Williamson24a4742f2011-05-10 10:02:11 -06002941 save_state->cap.cap_nr = cap;
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002942 save_state->cap.cap_extended = extended;
Alex Williamson24a4742f2011-05-10 10:02:11 -06002943 save_state->cap.size = size;
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002944 pci_add_saved_cap(dev, save_state);
2945
2946 return 0;
2947}
2948
Alex Williamsonfd0f7f72013-12-17 16:43:45 -07002949int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size)
2950{
2951 return _pci_add_cap_save_buffer(dev, cap, false, size);
2952}
2953
2954int pci_add_ext_cap_save_buffer(struct pci_dev *dev, u16 cap, unsigned int size)
2955{
2956 return _pci_add_cap_save_buffer(dev, cap, true, size);
2957}
2958
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002959/**
2960 * pci_allocate_cap_save_buffers - allocate buffers for saving capabilities
2961 * @dev: the PCI device
2962 */
2963void pci_allocate_cap_save_buffers(struct pci_dev *dev)
2964{
2965 int error;
2966
Yu Zhao89858512009-02-16 02:55:47 +08002967 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_EXP,
2968 PCI_EXP_SAVE_REGS * sizeof(u16));
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002969 if (error)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002970 pci_err(dev, "unable to preallocate PCI Express save buffer\n");
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002971
2972 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_PCIX, sizeof(u16));
2973 if (error)
Frederick Lawler7506dc72018-01-18 12:55:24 -06002974 pci_err(dev, "unable to preallocate PCI-X save buffer\n");
Alex Williamson425c1b22013-12-17 16:43:51 -07002975
2976 pci_allocate_vc_save_buffers(dev);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002977}
2978
Yinghai Luf7968412012-02-11 00:18:30 -08002979void pci_free_cap_save_buffers(struct pci_dev *dev)
2980{
2981 struct pci_cap_saved_state *tmp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08002982 struct hlist_node *n;
Yinghai Luf7968412012-02-11 00:18:30 -08002983
Sasha Levinb67bfe02013-02-27 17:06:00 -08002984 hlist_for_each_entry_safe(tmp, n, &dev->saved_cap_space, next)
Yinghai Luf7968412012-02-11 00:18:30 -08002985 kfree(tmp);
2986}
2987
Rafael J. Wysocki63f48982008-12-07 22:02:58 +01002988/**
Yijing Wang31ab2472013-01-15 11:12:17 +08002989 * pci_configure_ari - enable or disable ARI forwarding
Yu Zhao58c3a722008-10-14 14:02:53 +08002990 * @dev: the PCI device
Yijing Wangb0cc6022013-01-15 11:12:16 +08002991 *
2992 * If @dev and its upstream bridge both support ARI, enable ARI in the
2993 * bridge. Otherwise, disable ARI in the bridge.
Yu Zhao58c3a722008-10-14 14:02:53 +08002994 */
Yijing Wang31ab2472013-01-15 11:12:17 +08002995void pci_configure_ari(struct pci_dev *dev)
Yu Zhao58c3a722008-10-14 14:02:53 +08002996{
Yu Zhao58c3a722008-10-14 14:02:53 +08002997 u32 cap;
Zhao, Yu81135872008-10-23 13:15:39 +08002998 struct pci_dev *bridge;
Yu Zhao58c3a722008-10-14 14:02:53 +08002999
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +01003000 if (pcie_ari_disabled || !pci_is_pcie(dev) || dev->devfn)
Yu Zhao58c3a722008-10-14 14:02:53 +08003001 return;
3002
Zhao, Yu81135872008-10-23 13:15:39 +08003003 bridge = dev->bus->self;
Myron Stowecb97ae32012-06-01 15:16:31 -06003004 if (!bridge)
Zhao, Yu81135872008-10-23 13:15:39 +08003005 return;
3006
Jiang Liu59875ae2012-07-24 17:20:06 +08003007 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
Yu Zhao58c3a722008-10-14 14:02:53 +08003008 if (!(cap & PCI_EXP_DEVCAP2_ARI))
3009 return;
3010
Yijing Wangb0cc6022013-01-15 11:12:16 +08003011 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ARI)) {
3012 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
3013 PCI_EXP_DEVCTL2_ARI);
3014 bridge->ari_enabled = 1;
3015 } else {
3016 pcie_capability_clear_word(bridge, PCI_EXP_DEVCTL2,
3017 PCI_EXP_DEVCTL2_ARI);
3018 bridge->ari_enabled = 0;
3019 }
Yu Zhao58c3a722008-10-14 14:02:53 +08003020}
3021
Chris Wright5d990b62009-12-04 12:15:21 -08003022static int pci_acs_enable;
3023
3024/**
3025 * pci_request_acs - ask for ACS to be enabled if supported
3026 */
3027void pci_request_acs(void)
3028{
3029 pci_acs_enable = 1;
3030}
3031
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06003032static const char *disable_acs_redir_param;
3033
3034/**
3035 * pci_disable_acs_redir - disable ACS redirect capabilities
3036 * @dev: the PCI device
3037 *
3038 * For only devices specified in the disable_acs_redir parameter.
3039 */
3040static void pci_disable_acs_redir(struct pci_dev *dev)
3041{
3042 int ret = 0;
3043 const char *p;
3044 int pos;
3045 u16 ctrl;
3046
3047 if (!disable_acs_redir_param)
3048 return;
3049
3050 p = disable_acs_redir_param;
3051 while (*p) {
3052 ret = pci_dev_str_match(dev, p, &p);
3053 if (ret < 0) {
3054 pr_info_once("PCI: Can't parse disable_acs_redir parameter: %s\n",
3055 disable_acs_redir_param);
3056
3057 break;
3058 } else if (ret == 1) {
3059 /* Found a match */
3060 break;
3061 }
3062
3063 if (*p != ';' && *p != ',') {
3064 /* End of param or invalid format */
3065 break;
3066 }
3067 p++;
3068 }
3069
3070 if (ret != 1)
3071 return;
3072
Logan Gunthorpe73c47dde2018-08-09 16:51:43 -05003073 if (!pci_dev_specific_disable_acs_redir(dev))
3074 return;
3075
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06003076 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3077 if (!pos) {
3078 pci_warn(dev, "cannot disable ACS redirect for this hardware as it does not have ACS capabilities\n");
3079 return;
3080 }
3081
3082 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
3083
3084 /* P2P Request & Completion Redirect */
3085 ctrl &= ~(PCI_ACS_RR | PCI_ACS_CR | PCI_ACS_EC);
3086
3087 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
3088
3089 pci_info(dev, "disabled ACS redirect\n");
3090}
3091
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003092/**
Alex Williamson2c744242014-02-03 14:27:33 -07003093 * pci_std_enable_acs - enable ACS on devices using standard ACS capabilites
Allen Kayae21ee62009-10-07 10:27:17 -07003094 * @dev: the PCI device
3095 */
Alex Williamsonc1d61c92016-03-31 16:34:32 -06003096static void pci_std_enable_acs(struct pci_dev *dev)
Allen Kayae21ee62009-10-07 10:27:17 -07003097{
3098 int pos;
3099 u16 cap;
3100 u16 ctrl;
3101
Allen Kayae21ee62009-10-07 10:27:17 -07003102 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3103 if (!pos)
Alex Williamsonc1d61c92016-03-31 16:34:32 -06003104 return;
Allen Kayae21ee62009-10-07 10:27:17 -07003105
3106 pci_read_config_word(dev, pos + PCI_ACS_CAP, &cap);
3107 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
3108
3109 /* Source Validation */
3110 ctrl |= (cap & PCI_ACS_SV);
3111
3112 /* P2P Request Redirect */
3113 ctrl |= (cap & PCI_ACS_RR);
3114
3115 /* P2P Completion Redirect */
3116 ctrl |= (cap & PCI_ACS_CR);
3117
3118 /* Upstream Forwarding */
3119 ctrl |= (cap & PCI_ACS_UF);
3120
3121 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
Alex Williamson2c744242014-02-03 14:27:33 -07003122}
3123
3124/**
3125 * pci_enable_acs - enable ACS if hardware support it
3126 * @dev: the PCI device
3127 */
3128void pci_enable_acs(struct pci_dev *dev)
3129{
3130 if (!pci_acs_enable)
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06003131 goto disable_acs_redir;
Alex Williamson2c744242014-02-03 14:27:33 -07003132
Alex Williamsonc1d61c92016-03-31 16:34:32 -06003133 if (!pci_dev_specific_enable_acs(dev))
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06003134 goto disable_acs_redir;
Alex Williamson2c744242014-02-03 14:27:33 -07003135
Alex Williamsonc1d61c92016-03-31 16:34:32 -06003136 pci_std_enable_acs(dev);
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06003137
3138disable_acs_redir:
3139 /*
3140 * Note: pci_disable_acs_redir() must be called even if ACS was not
3141 * enabled by the kernel because it may have been enabled by
3142 * platform firmware. So if we are told to disable it, we should
3143 * always disable it after setting the kernel's default
3144 * preferences.
3145 */
3146 pci_disable_acs_redir(dev);
Allen Kayae21ee62009-10-07 10:27:17 -07003147}
3148
Alex Williamson0a671192013-06-27 16:39:48 -06003149static bool pci_acs_flags_enabled(struct pci_dev *pdev, u16 acs_flags)
3150{
3151 int pos;
Alex Williamson83db7e02013-06-27 16:39:54 -06003152 u16 cap, ctrl;
Alex Williamson0a671192013-06-27 16:39:48 -06003153
3154 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_ACS);
3155 if (!pos)
3156 return false;
3157
Alex Williamson83db7e02013-06-27 16:39:54 -06003158 /*
3159 * Except for egress control, capabilities are either required
3160 * or only required if controllable. Features missing from the
3161 * capability field can therefore be assumed as hard-wired enabled.
3162 */
3163 pci_read_config_word(pdev, pos + PCI_ACS_CAP, &cap);
3164 acs_flags &= (cap | PCI_ACS_EC);
3165
Alex Williamson0a671192013-06-27 16:39:48 -06003166 pci_read_config_word(pdev, pos + PCI_ACS_CTRL, &ctrl);
3167 return (ctrl & acs_flags) == acs_flags;
3168}
3169
Allen Kayae21ee62009-10-07 10:27:17 -07003170/**
Alex Williamsonad805752012-06-11 05:27:07 +00003171 * pci_acs_enabled - test ACS against required flags for a given device
3172 * @pdev: device to test
3173 * @acs_flags: required PCI ACS flags
3174 *
3175 * Return true if the device supports the provided flags. Automatically
3176 * filters out flags that are not implemented on multifunction devices.
Alex Williamson0a671192013-06-27 16:39:48 -06003177 *
3178 * Note that this interface checks the effective ACS capabilities of the
3179 * device rather than the actual capabilities. For instance, most single
3180 * function endpoints are not required to support ACS because they have no
3181 * opportunity for peer-to-peer access. We therefore return 'true'
3182 * regardless of whether the device exposes an ACS capability. This makes
3183 * it much easier for callers of this function to ignore the actual type
3184 * or topology of the device when testing ACS support.
Alex Williamsonad805752012-06-11 05:27:07 +00003185 */
3186bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
3187{
Alex Williamson0a671192013-06-27 16:39:48 -06003188 int ret;
Alex Williamsonad805752012-06-11 05:27:07 +00003189
3190 ret = pci_dev_specific_acs_enabled(pdev, acs_flags);
3191 if (ret >= 0)
3192 return ret > 0;
3193
Alex Williamson0a671192013-06-27 16:39:48 -06003194 /*
3195 * Conventional PCI and PCI-X devices never support ACS, either
3196 * effectively or actually. The shared bus topology implies that
3197 * any device on the bus can receive or snoop DMA.
3198 */
Alex Williamsonad805752012-06-11 05:27:07 +00003199 if (!pci_is_pcie(pdev))
3200 return false;
3201
Alex Williamson0a671192013-06-27 16:39:48 -06003202 switch (pci_pcie_type(pdev)) {
3203 /*
3204 * PCI/X-to-PCIe bridges are not specifically mentioned by the spec,
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003205 * but since their primary interface is PCI/X, we conservatively
Alex Williamson0a671192013-06-27 16:39:48 -06003206 * handle them as we would a non-PCIe device.
3207 */
3208 case PCI_EXP_TYPE_PCIE_BRIDGE:
3209 /*
3210 * PCIe 3.0, 6.12.1 excludes ACS on these devices. "ACS is never
3211 * applicable... must never implement an ACS Extended Capability...".
3212 * This seems arbitrary, but we take a conservative interpretation
3213 * of this statement.
3214 */
3215 case PCI_EXP_TYPE_PCI_BRIDGE:
3216 case PCI_EXP_TYPE_RC_EC:
3217 return false;
3218 /*
3219 * PCIe 3.0, 6.12.1.1 specifies that downstream and root ports should
3220 * implement ACS in order to indicate their peer-to-peer capabilities,
3221 * regardless of whether they are single- or multi-function devices.
3222 */
3223 case PCI_EXP_TYPE_DOWNSTREAM:
3224 case PCI_EXP_TYPE_ROOT_PORT:
3225 return pci_acs_flags_enabled(pdev, acs_flags);
3226 /*
3227 * PCIe 3.0, 6.12.1.2 specifies ACS capabilities that should be
3228 * implemented by the remaining PCIe types to indicate peer-to-peer
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003229 * capabilities, but only when they are part of a multifunction
Alex Williamson0a671192013-06-27 16:39:48 -06003230 * device. The footnote for section 6.12 indicates the specific
3231 * PCIe types included here.
3232 */
3233 case PCI_EXP_TYPE_ENDPOINT:
3234 case PCI_EXP_TYPE_UPSTREAM:
3235 case PCI_EXP_TYPE_LEG_END:
3236 case PCI_EXP_TYPE_RC_END:
3237 if (!pdev->multifunction)
3238 break;
3239
Alex Williamson0a671192013-06-27 16:39:48 -06003240 return pci_acs_flags_enabled(pdev, acs_flags);
Alex Williamsonad805752012-06-11 05:27:07 +00003241 }
3242
Alex Williamson0a671192013-06-27 16:39:48 -06003243 /*
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003244 * PCIe 3.0, 6.12.1.3 specifies no ACS capabilities are applicable
Alex Williamson0a671192013-06-27 16:39:48 -06003245 * to single function devices with the exception of downstream ports.
3246 */
Alex Williamsonad805752012-06-11 05:27:07 +00003247 return true;
3248}
3249
3250/**
3251 * pci_acs_path_enable - test ACS flags from start to end in a hierarchy
3252 * @start: starting downstream device
3253 * @end: ending upstream device or NULL to search to the root bus
3254 * @acs_flags: required flags
3255 *
3256 * Walk up a device tree from start to end testing PCI ACS support. If
3257 * any step along the way does not support the required flags, return false.
3258 */
3259bool pci_acs_path_enabled(struct pci_dev *start,
3260 struct pci_dev *end, u16 acs_flags)
3261{
3262 struct pci_dev *pdev, *parent = start;
3263
3264 do {
3265 pdev = parent;
3266
3267 if (!pci_acs_enabled(pdev, acs_flags))
3268 return false;
3269
3270 if (pci_is_root_bus(pdev->bus))
3271 return (end == NULL);
3272
3273 parent = pdev->bus->self;
3274 } while (pdev != end);
3275
3276 return true;
3277}
3278
3279/**
Christian König276b7382017-10-24 14:40:20 -05003280 * pci_rebar_find_pos - find position of resize ctrl reg for BAR
3281 * @pdev: PCI device
3282 * @bar: BAR to find
3283 *
3284 * Helper to find the position of the ctrl register for a BAR.
3285 * Returns -ENOTSUPP if resizable BARs are not supported at all.
3286 * Returns -ENOENT if no ctrl register for the BAR could be found.
3287 */
3288static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
3289{
3290 unsigned int pos, nbars, i;
3291 u32 ctrl;
3292
3293 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
3294 if (!pos)
3295 return -ENOTSUPP;
3296
3297 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3298 nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
3299 PCI_REBAR_CTRL_NBAR_SHIFT;
3300
3301 for (i = 0; i < nbars; i++, pos += 8) {
3302 int bar_idx;
3303
3304 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3305 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
3306 if (bar_idx == bar)
3307 return pos;
3308 }
3309
3310 return -ENOENT;
3311}
3312
3313/**
3314 * pci_rebar_get_possible_sizes - get possible sizes for BAR
3315 * @pdev: PCI device
3316 * @bar: BAR to query
3317 *
3318 * Get the possible sizes of a resizable BAR as bitmask defined in the spec
3319 * (bit 0=1MB, bit 19=512GB). Returns 0 if BAR isn't resizable.
3320 */
3321u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
3322{
3323 int pos;
3324 u32 cap;
3325
3326 pos = pci_rebar_find_pos(pdev, bar);
3327 if (pos < 0)
3328 return 0;
3329
3330 pci_read_config_dword(pdev, pos + PCI_REBAR_CAP, &cap);
3331 return (cap & PCI_REBAR_CAP_SIZES) >> 4;
3332}
3333
3334/**
3335 * pci_rebar_get_current_size - get the current size of a BAR
3336 * @pdev: PCI device
3337 * @bar: BAR to set size to
3338 *
3339 * Read the size of a BAR from the resizable BAR config.
3340 * Returns size if found or negative error code.
3341 */
3342int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
3343{
3344 int pos;
3345 u32 ctrl;
3346
3347 pos = pci_rebar_find_pos(pdev, bar);
3348 if (pos < 0)
3349 return pos;
3350
3351 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
Christian Königb1277a22018-06-29 19:55:03 -05003352 return (ctrl & PCI_REBAR_CTRL_BAR_SIZE) >> PCI_REBAR_CTRL_BAR_SHIFT;
Christian König276b7382017-10-24 14:40:20 -05003353}
3354
3355/**
3356 * pci_rebar_set_size - set a new size for a BAR
3357 * @pdev: PCI device
3358 * @bar: BAR to set size to
3359 * @size: new size as defined in the spec (0=1MB, 19=512GB)
3360 *
3361 * Set the new size of a BAR as defined in the spec.
3362 * Returns zero if resizing was successful, error code otherwise.
3363 */
3364int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size)
3365{
3366 int pos;
3367 u32 ctrl;
3368
3369 pos = pci_rebar_find_pos(pdev, bar);
3370 if (pos < 0)
3371 return pos;
3372
3373 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3374 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
Christian Königb1277a22018-06-29 19:55:03 -05003375 ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
Christian König276b7382017-10-24 14:40:20 -05003376 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
3377 return 0;
3378}
3379
3380/**
Jay Cornwall430a2362018-01-04 19:44:59 -05003381 * pci_enable_atomic_ops_to_root - enable AtomicOp requests to root port
3382 * @dev: the PCI device
3383 * @cap_mask: mask of desired AtomicOp sizes, including one or more of:
3384 * PCI_EXP_DEVCAP2_ATOMIC_COMP32
3385 * PCI_EXP_DEVCAP2_ATOMIC_COMP64
3386 * PCI_EXP_DEVCAP2_ATOMIC_COMP128
3387 *
3388 * Return 0 if all upstream bridges support AtomicOp routing, egress
3389 * blocking is disabled on all upstream ports, and the root port supports
3390 * the requested completion capabilities (32-bit, 64-bit and/or 128-bit
3391 * AtomicOp completion), or negative otherwise.
3392 */
3393int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask)
3394{
3395 struct pci_bus *bus = dev->bus;
3396 struct pci_dev *bridge;
3397 u32 cap, ctl2;
3398
3399 if (!pci_is_pcie(dev))
3400 return -EINVAL;
3401
3402 /*
3403 * Per PCIe r4.0, sec 6.15, endpoints and root ports may be
3404 * AtomicOp requesters. For now, we only support endpoints as
3405 * requesters and root ports as completers. No endpoints as
3406 * completers, and no peer-to-peer.
3407 */
3408
3409 switch (pci_pcie_type(dev)) {
3410 case PCI_EXP_TYPE_ENDPOINT:
3411 case PCI_EXP_TYPE_LEG_END:
3412 case PCI_EXP_TYPE_RC_END:
3413 break;
3414 default:
3415 return -EINVAL;
3416 }
3417
3418 while (bus->parent) {
3419 bridge = bus->self;
3420
3421 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3422
3423 switch (pci_pcie_type(bridge)) {
3424 /* Ensure switch ports support AtomicOp routing */
3425 case PCI_EXP_TYPE_UPSTREAM:
3426 case PCI_EXP_TYPE_DOWNSTREAM:
3427 if (!(cap & PCI_EXP_DEVCAP2_ATOMIC_ROUTE))
3428 return -EINVAL;
3429 break;
3430
3431 /* Ensure root port supports all the sizes we care about */
3432 case PCI_EXP_TYPE_ROOT_PORT:
3433 if ((cap & cap_mask) != cap_mask)
3434 return -EINVAL;
3435 break;
3436 }
3437
3438 /* Ensure upstream ports don't block AtomicOps on egress */
3439 if (!bridge->has_secondary_link) {
3440 pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2,
3441 &ctl2);
3442 if (ctl2 & PCI_EXP_DEVCTL2_ATOMIC_EGRESS_BLOCK)
3443 return -EINVAL;
3444 }
3445
3446 bus = bus->parent;
3447 }
3448
3449 pcie_capability_set_word(dev, PCI_EXP_DEVCTL2,
3450 PCI_EXP_DEVCTL2_ATOMIC_REQ);
3451 return 0;
3452}
3453EXPORT_SYMBOL(pci_enable_atomic_ops_to_root);
3454
3455/**
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003456 * pci_swizzle_interrupt_pin - swizzle INTx for device behind bridge
3457 * @dev: the PCI device
Wang Sheng-Huibb5c2de2013-05-28 11:17:41 +08003458 * @pin: the INTx pin (1=INTA, 2=INTB, 3=INTC, 4=INTD)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003459 *
3460 * Perform INTx swizzling for a device behind one level of bridge. This is
3461 * required by section 9.1 of the PCI-to-PCI bridge specification for devices
Matthew Wilcox46b952a2009-07-01 14:24:30 -07003462 * behind bridges on add-in cards. For devices with ARI enabled, the slot
3463 * number is always 0 (see the Implementation Note in section 2.2.8.1 of
3464 * the PCI Express Base Specification, Revision 2.1)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003465 */
John Crispin3df425f2012-04-12 17:33:07 +02003466u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin)
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003467{
Matthew Wilcox46b952a2009-07-01 14:24:30 -07003468 int slot;
3469
3470 if (pci_ari_enabled(dev->bus))
3471 slot = 0;
3472 else
3473 slot = PCI_SLOT(dev->devfn);
3474
3475 return (((pin - 1) + slot) % 4) + 1;
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003476}
3477
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003478int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479{
3480 u8 pin;
3481
Kristen Accardi514d2072005-11-02 16:24:39 -08003482 pin = dev->pin;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483 if (!pin)
3484 return -1;
Bjorn Helgaas878f2e52008-12-09 16:11:46 -07003485
Kenji Kaneshige8784fd42009-05-26 16:07:33 +09003486 while (!pci_is_root_bus(dev->bus)) {
Bjorn Helgaas57c2cf72008-12-11 11:24:23 -07003487 pin = pci_swizzle_interrupt_pin(dev, pin);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003488 dev = dev->bus->self;
3489 }
3490 *bridge = dev;
3491 return pin;
3492}
3493
3494/**
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003495 * pci_common_swizzle - swizzle INTx all the way to root bridge
3496 * @dev: the PCI device
3497 * @pinp: pointer to the INTx pin value (1=INTA, 2=INTB, 3=INTD, 4=INTD)
3498 *
3499 * Perform INTx swizzling for a device. This traverses through all PCI-to-PCI
3500 * bridges all the way up to a PCI root bus.
3501 */
3502u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp)
3503{
3504 u8 pin = *pinp;
3505
Kenji Kaneshige1eb39482009-05-26 16:08:36 +09003506 while (!pci_is_root_bus(dev->bus)) {
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003507 pin = pci_swizzle_interrupt_pin(dev, pin);
3508 dev = dev->bus->self;
3509 }
3510 *pinp = pin;
3511 return PCI_SLOT(dev->devfn);
3512}
Ray Juie6b29de2015-04-08 11:21:33 -07003513EXPORT_SYMBOL_GPL(pci_common_swizzle);
Bjorn Helgaas68feac82008-12-16 21:36:55 -07003514
3515/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516 * pci_release_region - Release a PCI bar
3517 * @pdev: PCI device whose resources were previously reserved by pci_request_region
3518 * @bar: BAR to release
3519 *
3520 * Releases the PCI I/O and memory resources previously reserved by a
3521 * successful call to pci_request_region. Call this function only
3522 * after all use of the PCI regions has ceased.
3523 */
3524void pci_release_region(struct pci_dev *pdev, int bar)
3525{
Tejun Heo9ac78492007-01-20 16:00:26 +09003526 struct pci_devres *dr;
3527
Linus Torvalds1da177e2005-04-16 15:20:36 -07003528 if (pci_resource_len(pdev, bar) == 0)
3529 return;
3530 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO)
3531 release_region(pci_resource_start(pdev, bar),
3532 pci_resource_len(pdev, bar));
3533 else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM)
3534 release_mem_region(pci_resource_start(pdev, bar),
3535 pci_resource_len(pdev, bar));
Tejun Heo9ac78492007-01-20 16:00:26 +09003536
3537 dr = find_pci_dr(pdev);
3538 if (dr)
3539 dr->region_mask &= ~(1 << bar);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003541EXPORT_SYMBOL(pci_release_region);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542
3543/**
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003544 * __pci_request_region - Reserved PCI I/O and memory resource
Linus Torvalds1da177e2005-04-16 15:20:36 -07003545 * @pdev: PCI device whose resources are to be reserved
3546 * @bar: BAR to be reserved
3547 * @res_name: Name to be associated with resource.
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003548 * @exclusive: whether the region access is exclusive or not
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 *
3550 * Mark the PCI region associated with PCI device @pdev BR @bar as
3551 * being reserved by owner @res_name. Do not access any
3552 * address inside the PCI regions unless this call returns
3553 * successfully.
3554 *
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003555 * If @exclusive is set, then the region is marked so that userspace
3556 * is explicitly not allowed to map the resource via /dev/mem or
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003557 * sysfs MMIO access.
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003558 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003559 * Returns 0 on success, or %EBUSY on error. A warning
3560 * message is also printed on failure.
3561 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003562static int __pci_request_region(struct pci_dev *pdev, int bar,
3563 const char *res_name, int exclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003564{
Tejun Heo9ac78492007-01-20 16:00:26 +09003565 struct pci_devres *dr;
3566
Linus Torvalds1da177e2005-04-16 15:20:36 -07003567 if (pci_resource_len(pdev, bar) == 0)
3568 return 0;
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003569
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO) {
3571 if (!request_region(pci_resource_start(pdev, bar),
3572 pci_resource_len(pdev, bar), res_name))
3573 goto err_out;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003574 } else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM) {
Arjan van de Vene8de1482008-10-22 19:55:31 -07003575 if (!__request_mem_region(pci_resource_start(pdev, bar),
3576 pci_resource_len(pdev, bar), res_name,
3577 exclusive))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578 goto err_out;
3579 }
Tejun Heo9ac78492007-01-20 16:00:26 +09003580
3581 dr = find_pci_dr(pdev);
3582 if (dr)
3583 dr->region_mask |= 1 << bar;
3584
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585 return 0;
3586
3587err_out:
Frederick Lawler7506dc72018-01-18 12:55:24 -06003588 pci_warn(pdev, "BAR %d: can't reserve %pR\n", bar,
Benjamin Herrenschmidt096e6f62008-10-20 15:07:37 +11003589 &pdev->resource[bar]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 return -EBUSY;
3591}
3592
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003593/**
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003594 * pci_request_region - Reserve PCI I/O and memory resource
Arjan van de Vene8de1482008-10-22 19:55:31 -07003595 * @pdev: PCI device whose resources are to be reserved
3596 * @bar: BAR to be reserved
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003597 * @res_name: Name to be associated with resource
Arjan van de Vene8de1482008-10-22 19:55:31 -07003598 *
Randy Dunlapf5ddcac2009-01-09 17:03:20 -08003599 * Mark the PCI region associated with PCI device @pdev BAR @bar as
Arjan van de Vene8de1482008-10-22 19:55:31 -07003600 * being reserved by owner @res_name. Do not access any
3601 * address inside the PCI regions unless this call returns
3602 * successfully.
3603 *
3604 * Returns 0 on success, or %EBUSY on error. A warning
3605 * message is also printed on failure.
3606 */
3607int pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
3608{
3609 return __pci_request_region(pdev, bar, res_name, 0);
3610}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003611EXPORT_SYMBOL(pci_request_region);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003612
3613/**
3614 * pci_request_region_exclusive - Reserved PCI I/O and memory resource
3615 * @pdev: PCI device whose resources are to be reserved
3616 * @bar: BAR to be reserved
3617 * @res_name: Name to be associated with resource.
3618 *
3619 * Mark the PCI region associated with PCI device @pdev BR @bar as
3620 * being reserved by owner @res_name. Do not access any
3621 * address inside the PCI regions unless this call returns
3622 * successfully.
3623 *
3624 * Returns 0 on success, or %EBUSY on error. A warning
3625 * message is also printed on failure.
3626 *
3627 * The key difference that _exclusive makes it that userspace is
3628 * explicitly not allowed to map the resource via /dev/mem or
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003629 * sysfs.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003630 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003631int pci_request_region_exclusive(struct pci_dev *pdev, int bar,
3632 const char *res_name)
Arjan van de Vene8de1482008-10-22 19:55:31 -07003633{
3634 return __pci_request_region(pdev, bar, res_name, IORESOURCE_EXCLUSIVE);
3635}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003636EXPORT_SYMBOL(pci_request_region_exclusive);
3637
Arjan van de Vene8de1482008-10-22 19:55:31 -07003638/**
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003639 * pci_release_selected_regions - Release selected PCI I/O and memory resources
3640 * @pdev: PCI device whose resources were previously reserved
3641 * @bars: Bitmask of BARs to be released
3642 *
3643 * Release selected PCI I/O and memory resources previously reserved.
3644 * Call this function only after all use of the PCI regions has ceased.
3645 */
3646void pci_release_selected_regions(struct pci_dev *pdev, int bars)
3647{
3648 int i;
3649
3650 for (i = 0; i < 6; i++)
3651 if (bars & (1 << i))
3652 pci_release_region(pdev, i);
3653}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003654EXPORT_SYMBOL(pci_release_selected_regions);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003655
Bjorn Helgaas9738abe2013-04-12 11:20:03 -06003656static int __pci_request_selected_regions(struct pci_dev *pdev, int bars,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003657 const char *res_name, int excl)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003658{
3659 int i;
3660
3661 for (i = 0; i < 6; i++)
3662 if (bars & (1 << i))
Arjan van de Vene8de1482008-10-22 19:55:31 -07003663 if (__pci_request_region(pdev, i, res_name, excl))
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003664 goto err_out;
3665 return 0;
3666
3667err_out:
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003668 while (--i >= 0)
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003669 if (bars & (1 << i))
3670 pci_release_region(pdev, i);
3671
3672 return -EBUSY;
3673}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003674
Arjan van de Vene8de1482008-10-22 19:55:31 -07003675
3676/**
3677 * pci_request_selected_regions - Reserve selected PCI I/O and memory resources
3678 * @pdev: PCI device whose resources are to be reserved
3679 * @bars: Bitmask of BARs to be requested
3680 * @res_name: Name to be associated with resource
3681 */
3682int pci_request_selected_regions(struct pci_dev *pdev, int bars,
3683 const char *res_name)
3684{
3685 return __pci_request_selected_regions(pdev, bars, res_name, 0);
3686}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003687EXPORT_SYMBOL(pci_request_selected_regions);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003688
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04003689int pci_request_selected_regions_exclusive(struct pci_dev *pdev, int bars,
3690 const char *res_name)
Arjan van de Vene8de1482008-10-22 19:55:31 -07003691{
3692 return __pci_request_selected_regions(pdev, bars, res_name,
3693 IORESOURCE_EXCLUSIVE);
3694}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003695EXPORT_SYMBOL(pci_request_selected_regions_exclusive);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003696
Linus Torvalds1da177e2005-04-16 15:20:36 -07003697/**
3698 * pci_release_regions - Release reserved PCI I/O and memory resources
3699 * @pdev: PCI device whose resources were previously reserved by pci_request_regions
3700 *
3701 * Releases all PCI I/O and memory resources previously reserved by a
3702 * successful call to pci_request_regions. Call this function only
3703 * after all use of the PCI regions has ceased.
3704 */
3705
3706void pci_release_regions(struct pci_dev *pdev)
3707{
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003708 pci_release_selected_regions(pdev, (1 << 6) - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003709}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003710EXPORT_SYMBOL(pci_release_regions);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003711
3712/**
3713 * pci_request_regions - Reserved PCI I/O and memory resources
3714 * @pdev: PCI device whose resources are to be reserved
3715 * @res_name: Name to be associated with resource.
3716 *
3717 * Mark all PCI regions associated with PCI device @pdev as
3718 * being reserved by owner @res_name. Do not access any
3719 * address inside the PCI regions unless this call returns
3720 * successfully.
3721 *
3722 * Returns 0 on success, or %EBUSY on error. A warning
3723 * message is also printed on failure.
3724 */
Jeff Garzik3c990e92006-03-04 21:52:42 -05003725int pci_request_regions(struct pci_dev *pdev, const char *res_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003726{
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09003727 return pci_request_selected_regions(pdev, ((1 << 6) - 1), res_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003728}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003729EXPORT_SYMBOL(pci_request_regions);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003730
3731/**
Arjan van de Vene8de1482008-10-22 19:55:31 -07003732 * pci_request_regions_exclusive - Reserved PCI I/O and memory resources
3733 * @pdev: PCI device whose resources are to be reserved
3734 * @res_name: Name to be associated with resource.
3735 *
3736 * Mark all PCI regions associated with PCI device @pdev as
3737 * being reserved by owner @res_name. Do not access any
3738 * address inside the PCI regions unless this call returns
3739 * successfully.
3740 *
3741 * pci_request_regions_exclusive() will mark the region so that
Bjorn Helgaasf7625982013-11-14 11:28:18 -07003742 * /dev/mem and the sysfs MMIO access will not be allowed.
Arjan van de Vene8de1482008-10-22 19:55:31 -07003743 *
3744 * Returns 0 on success, or %EBUSY on error. A warning
3745 * message is also printed on failure.
3746 */
3747int pci_request_regions_exclusive(struct pci_dev *pdev, const char *res_name)
3748{
3749 return pci_request_selected_regions_exclusive(pdev,
3750 ((1 << 6) - 1), res_name);
3751}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06003752EXPORT_SYMBOL(pci_request_regions_exclusive);
Arjan van de Vene8de1482008-10-22 19:55:31 -07003753
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003754/*
3755 * Record the PCI IO range (expressed as CPU physical address + size).
3756 * Return a negative value if an error has occured, zero otherwise
3757 */
Gabriele Paolonifcfaab32018-03-15 02:15:52 +08003758int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
3759 resource_size_t size)
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003760{
Zhichang Yuan57453922018-03-15 02:15:53 +08003761 int ret = 0;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003762#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08003763 struct logic_pio_hwaddr *range;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003764
Zhichang Yuan57453922018-03-15 02:15:53 +08003765 if (!size || addr + size < addr)
3766 return -EINVAL;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003767
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003768 range = kzalloc(sizeof(*range), GFP_ATOMIC);
Zhichang Yuan57453922018-03-15 02:15:53 +08003769 if (!range)
3770 return -ENOMEM;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003771
Zhichang Yuan57453922018-03-15 02:15:53 +08003772 range->fwnode = fwnode;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003773 range->size = size;
Zhichang Yuan57453922018-03-15 02:15:53 +08003774 range->hw_start = addr;
3775 range->flags = LOGIC_PIO_CPU_MMIO;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003776
Zhichang Yuan57453922018-03-15 02:15:53 +08003777 ret = logic_pio_register_range(range);
3778 if (ret)
3779 kfree(range);
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003780#endif
3781
Zhichang Yuan57453922018-03-15 02:15:53 +08003782 return ret;
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003783}
3784
3785phys_addr_t pci_pio_to_address(unsigned long pio)
3786{
3787 phys_addr_t address = (phys_addr_t)OF_BAD_ADDR;
3788
3789#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08003790 if (pio >= MMIO_UPPER_LIMIT)
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003791 return address;
3792
Zhichang Yuan57453922018-03-15 02:15:53 +08003793 address = logic_pio_to_hwaddr(pio);
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003794#endif
3795
3796 return address;
3797}
3798
3799unsigned long __weak pci_address_to_pio(phys_addr_t address)
3800{
3801#ifdef PCI_IOBASE
Zhichang Yuan57453922018-03-15 02:15:53 +08003802 return logic_pio_trans_cpuaddr(address);
Tomasz Nowickic5076cf2016-05-11 17:34:51 -05003803#else
3804 if (address > IO_SPACE_LIMIT)
3805 return (unsigned long)-1;
3806
3807 return (unsigned long) address;
3808#endif
3809}
3810
Liviu Dudau8b921ac2014-09-29 15:29:30 +01003811/**
3812 * pci_remap_iospace - Remap the memory mapped I/O space
3813 * @res: Resource describing the I/O space
3814 * @phys_addr: physical address of range to be mapped
3815 *
3816 * Remap the memory mapped I/O space described by the @res
3817 * and the CPU physical address @phys_addr into virtual address space.
3818 * Only architectures that have memory mapped IO functions defined
3819 * (and the PCI_IOBASE value defined) should call this function.
3820 */
Lorenzo Pieralisi7b309ae2017-04-19 17:48:50 +01003821int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr)
Liviu Dudau8b921ac2014-09-29 15:29:30 +01003822{
3823#if defined(PCI_IOBASE) && defined(CONFIG_MMU)
3824 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
3825
3826 if (!(res->flags & IORESOURCE_IO))
3827 return -EINVAL;
3828
3829 if (res->end > IO_SPACE_LIMIT)
3830 return -EINVAL;
3831
3832 return ioremap_page_range(vaddr, vaddr + resource_size(res), phys_addr,
3833 pgprot_device(PAGE_KERNEL));
3834#else
3835 /* this architecture does not have memory mapped I/O space,
3836 so this function should never be called */
3837 WARN_ONCE(1, "This architecture does not support memory mapped I/O\n");
3838 return -ENODEV;
3839#endif
3840}
Brian Norrisf90b0872017-03-09 18:46:16 -08003841EXPORT_SYMBOL(pci_remap_iospace);
Liviu Dudau8b921ac2014-09-29 15:29:30 +01003842
Sinan Kaya4d3f1382016-06-10 21:55:11 +02003843/**
3844 * pci_unmap_iospace - Unmap the memory mapped I/O space
3845 * @res: resource to be unmapped
3846 *
3847 * Unmap the CPU virtual address @res from virtual address space.
3848 * Only architectures that have memory mapped IO functions defined
3849 * (and the PCI_IOBASE value defined) should call this function.
3850 */
3851void pci_unmap_iospace(struct resource *res)
3852{
3853#if defined(PCI_IOBASE) && defined(CONFIG_MMU)
3854 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
3855
3856 unmap_kernel_range(vaddr, resource_size(res));
3857#endif
3858}
Brian Norrisf90b0872017-03-09 18:46:16 -08003859EXPORT_SYMBOL(pci_unmap_iospace);
Sinan Kaya4d3f1382016-06-10 21:55:11 +02003860
Sergei Shtylyova5fb9fb2018-07-18 15:40:26 -05003861static void devm_pci_unmap_iospace(struct device *dev, void *ptr)
3862{
3863 struct resource **res = ptr;
3864
3865 pci_unmap_iospace(*res);
3866}
3867
3868/**
3869 * devm_pci_remap_iospace - Managed pci_remap_iospace()
3870 * @dev: Generic device to remap IO address for
3871 * @res: Resource describing the I/O space
3872 * @phys_addr: physical address of range to be mapped
3873 *
3874 * Managed pci_remap_iospace(). Map is automatically unmapped on driver
3875 * detach.
3876 */
3877int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
3878 phys_addr_t phys_addr)
3879{
3880 const struct resource **ptr;
3881 int error;
3882
3883 ptr = devres_alloc(devm_pci_unmap_iospace, sizeof(*ptr), GFP_KERNEL);
3884 if (!ptr)
3885 return -ENOMEM;
3886
3887 error = pci_remap_iospace(res, phys_addr);
3888 if (error) {
3889 devres_free(ptr);
3890 } else {
3891 *ptr = res;
3892 devres_add(dev, ptr);
3893 }
3894
3895 return error;
3896}
3897EXPORT_SYMBOL(devm_pci_remap_iospace);
3898
Lorenzo Pieralisi490cb6d2017-04-19 17:48:55 +01003899/**
3900 * devm_pci_remap_cfgspace - Managed pci_remap_cfgspace()
3901 * @dev: Generic device to remap IO address for
3902 * @offset: Resource address to map
3903 * @size: Size of map
3904 *
3905 * Managed pci_remap_cfgspace(). Map is automatically unmapped on driver
3906 * detach.
3907 */
3908void __iomem *devm_pci_remap_cfgspace(struct device *dev,
3909 resource_size_t offset,
3910 resource_size_t size)
3911{
3912 void __iomem **ptr, *addr;
3913
3914 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
3915 if (!ptr)
3916 return NULL;
3917
3918 addr = pci_remap_cfgspace(offset, size);
3919 if (addr) {
3920 *ptr = addr;
3921 devres_add(dev, ptr);
3922 } else
3923 devres_free(ptr);
3924
3925 return addr;
3926}
3927EXPORT_SYMBOL(devm_pci_remap_cfgspace);
3928
3929/**
3930 * devm_pci_remap_cfg_resource - check, request region and ioremap cfg resource
3931 * @dev: generic device to handle the resource for
3932 * @res: configuration space resource to be handled
3933 *
3934 * Checks that a resource is a valid memory region, requests the memory
3935 * region and ioremaps with pci_remap_cfgspace() API that ensures the
3936 * proper PCI configuration space memory attributes are guaranteed.
3937 *
3938 * All operations are managed and will be undone on driver detach.
3939 *
3940 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
Randy Dunlap505fb742017-10-29 17:07:11 -07003941 * on failure. Usage example::
Lorenzo Pieralisi490cb6d2017-04-19 17:48:55 +01003942 *
3943 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
3944 * base = devm_pci_remap_cfg_resource(&pdev->dev, res);
3945 * if (IS_ERR(base))
3946 * return PTR_ERR(base);
3947 */
3948void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
3949 struct resource *res)
3950{
3951 resource_size_t size;
3952 const char *name;
3953 void __iomem *dest_ptr;
3954
3955 BUG_ON(!dev);
3956
3957 if (!res || resource_type(res) != IORESOURCE_MEM) {
3958 dev_err(dev, "invalid resource\n");
3959 return IOMEM_ERR_PTR(-EINVAL);
3960 }
3961
3962 size = resource_size(res);
3963 name = res->name ?: dev_name(dev);
3964
3965 if (!devm_request_mem_region(dev, res->start, size, name)) {
3966 dev_err(dev, "can't request region for resource %pR\n", res);
3967 return IOMEM_ERR_PTR(-EBUSY);
3968 }
3969
3970 dest_ptr = devm_pci_remap_cfgspace(dev, res->start, size);
3971 if (!dest_ptr) {
3972 dev_err(dev, "ioremap failed for resource %pR\n", res);
3973 devm_release_mem_region(dev, res->start, size);
3974 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
3975 }
3976
3977 return dest_ptr;
3978}
3979EXPORT_SYMBOL(devm_pci_remap_cfg_resource);
3980
Ben Hutchings6a479072008-12-23 03:08:29 +00003981static void __pci_set_master(struct pci_dev *dev, bool enable)
3982{
3983 u16 old_cmd, cmd;
3984
3985 pci_read_config_word(dev, PCI_COMMAND, &old_cmd);
3986 if (enable)
3987 cmd = old_cmd | PCI_COMMAND_MASTER;
3988 else
3989 cmd = old_cmd & ~PCI_COMMAND_MASTER;
3990 if (cmd != old_cmd) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06003991 pci_dbg(dev, "%s bus mastering\n",
Ben Hutchings6a479072008-12-23 03:08:29 +00003992 enable ? "enabling" : "disabling");
3993 pci_write_config_word(dev, PCI_COMMAND, cmd);
3994 }
3995 dev->is_busmaster = enable;
3996}
Arjan van de Vene8de1482008-10-22 19:55:31 -07003997
3998/**
Myron Stowe2b6f2c32012-06-25 21:30:57 -06003999 * pcibios_setup - process "pci=" kernel boot arguments
4000 * @str: string used to pass in "pci=" kernel boot arguments
4001 *
4002 * Process kernel boot arguments. This is the default implementation.
4003 * Architecture specific implementations can override this as necessary.
4004 */
4005char * __weak __init pcibios_setup(char *str)
4006{
4007 return str;
4008}
4009
4010/**
Myron Stowe96c55902011-10-28 15:48:38 -06004011 * pcibios_set_master - enable PCI bus-mastering for device dev
4012 * @dev: the PCI device to enable
4013 *
4014 * Enables PCI bus-mastering for the device. This is the default
4015 * implementation. Architecture specific implementations can override
4016 * this if necessary.
4017 */
4018void __weak pcibios_set_master(struct pci_dev *dev)
4019{
4020 u8 lat;
4021
Myron Stowef6766782011-10-28 15:49:20 -06004022 /* The latency timer doesn't apply to PCIe (either Type 0 or Type 1) */
4023 if (pci_is_pcie(dev))
4024 return;
4025
Myron Stowe96c55902011-10-28 15:48:38 -06004026 pci_read_config_byte(dev, PCI_LATENCY_TIMER, &lat);
4027 if (lat < 16)
4028 lat = (64 <= pcibios_max_latency) ? 64 : pcibios_max_latency;
4029 else if (lat > pcibios_max_latency)
4030 lat = pcibios_max_latency;
4031 else
4032 return;
Bjorn Helgaasa0064822013-09-23 15:25:26 -06004033
Myron Stowe96c55902011-10-28 15:48:38 -06004034 pci_write_config_byte(dev, PCI_LATENCY_TIMER, lat);
4035}
4036
4037/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004038 * pci_set_master - enables bus-mastering for device dev
4039 * @dev: the PCI device to enable
4040 *
4041 * Enables bus-mastering on the device and calls pcibios_set_master()
4042 * to do the needed arch specific settings.
4043 */
Ben Hutchings6a479072008-12-23 03:08:29 +00004044void pci_set_master(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004045{
Ben Hutchings6a479072008-12-23 03:08:29 +00004046 __pci_set_master(dev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004047 pcibios_set_master(dev);
4048}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004049EXPORT_SYMBOL(pci_set_master);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004050
Ben Hutchings6a479072008-12-23 03:08:29 +00004051/**
4052 * pci_clear_master - disables bus-mastering for device dev
4053 * @dev: the PCI device to disable
4054 */
4055void pci_clear_master(struct pci_dev *dev)
4056{
4057 __pci_set_master(dev, false);
4058}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004059EXPORT_SYMBOL(pci_clear_master);
Ben Hutchings6a479072008-12-23 03:08:29 +00004060
Linus Torvalds1da177e2005-04-16 15:20:36 -07004061/**
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004062 * pci_set_cacheline_size - ensure the CACHE_LINE_SIZE register is programmed
4063 * @dev: the PCI device for which MWI is to be enabled
Linus Torvalds1da177e2005-04-16 15:20:36 -07004064 *
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004065 * Helper function for pci_set_mwi.
4066 * Originally copied from drivers/net/acenic.c.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004067 * Copyright 1998-2001 by Jes Sorensen, <jes@trained-monkey.org>.
4068 *
4069 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4070 */
Tejun Heo15ea76d2009-09-22 17:34:48 +09004071int pci_set_cacheline_size(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004072{
4073 u8 cacheline_size;
4074
4075 if (!pci_cache_line_size)
Tejun Heo15ea76d2009-09-22 17:34:48 +09004076 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004077
4078 /* Validate current setting: the PCI_CACHE_LINE_SIZE must be
4079 equal to or multiple of the right value. */
4080 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4081 if (cacheline_size >= pci_cache_line_size &&
4082 (cacheline_size % pci_cache_line_size) == 0)
4083 return 0;
4084
4085 /* Write the correct value. */
4086 pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, pci_cache_line_size);
4087 /* Read it back. */
4088 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4089 if (cacheline_size == pci_cache_line_size)
4090 return 0;
4091
Frederick Lawler7506dc72018-01-18 12:55:24 -06004092 pci_printk(KERN_DEBUG, dev, "cache line size of %d is not supported\n",
Ryan Desfosses227f0642014-04-18 20:13:50 -04004093 pci_cache_line_size << 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004094
4095 return -EINVAL;
4096}
Tejun Heo15ea76d2009-09-22 17:34:48 +09004097EXPORT_SYMBOL_GPL(pci_set_cacheline_size);
4098
Linus Torvalds1da177e2005-04-16 15:20:36 -07004099/**
4100 * pci_set_mwi - enables memory-write-invalidate PCI transaction
4101 * @dev: the PCI device for which MWI is enabled
4102 *
Randy Dunlap694625c2007-07-09 11:55:54 -07004103 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004104 *
4105 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4106 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004107int pci_set_mwi(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004108{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004109#ifdef PCI_DISABLE_MWI
4110 return 0;
4111#else
Linus Torvalds1da177e2005-04-16 15:20:36 -07004112 int rc;
4113 u16 cmd;
4114
Matthew Wilcoxedb2d972006-10-10 08:01:21 -06004115 rc = pci_set_cacheline_size(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004116 if (rc)
4117 return rc;
4118
4119 pci_read_config_word(dev, PCI_COMMAND, &cmd);
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004120 if (!(cmd & PCI_COMMAND_INVALIDATE)) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06004121 pci_dbg(dev, "enabling Mem-Wr-Inval\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004122 cmd |= PCI_COMMAND_INVALIDATE;
4123 pci_write_config_word(dev, PCI_COMMAND, cmd);
4124 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004125 return 0;
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004126#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004127}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004128EXPORT_SYMBOL(pci_set_mwi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004129
4130/**
Heiner Kallweitfc0f9f42017-12-12 07:40:56 +01004131 * pcim_set_mwi - a device-managed pci_set_mwi()
4132 * @dev: the PCI device for which MWI is enabled
4133 *
4134 * Managed pci_set_mwi().
4135 *
4136 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4137 */
4138int pcim_set_mwi(struct pci_dev *dev)
4139{
4140 struct pci_devres *dr;
4141
4142 dr = find_pci_dr(dev);
4143 if (!dr)
4144 return -ENOMEM;
4145
4146 dr->mwi = 1;
4147 return pci_set_mwi(dev);
4148}
4149EXPORT_SYMBOL(pcim_set_mwi);
4150
4151/**
Randy Dunlap694625c2007-07-09 11:55:54 -07004152 * pci_try_set_mwi - enables memory-write-invalidate PCI transaction
4153 * @dev: the PCI device for which MWI is enabled
4154 *
4155 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4156 * Callers are not required to check the return value.
4157 *
4158 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4159 */
4160int pci_try_set_mwi(struct pci_dev *dev)
4161{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004162#ifdef PCI_DISABLE_MWI
4163 return 0;
4164#else
4165 return pci_set_mwi(dev);
4166#endif
Randy Dunlap694625c2007-07-09 11:55:54 -07004167}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004168EXPORT_SYMBOL(pci_try_set_mwi);
Randy Dunlap694625c2007-07-09 11:55:54 -07004169
4170/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07004171 * pci_clear_mwi - disables Memory-Write-Invalidate for device dev
4172 * @dev: the PCI device to disable
4173 *
4174 * Disables PCI Memory-Write-Invalidate transaction on the device
4175 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004176void pci_clear_mwi(struct pci_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004177{
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004178#ifndef PCI_DISABLE_MWI
Linus Torvalds1da177e2005-04-16 15:20:36 -07004179 u16 cmd;
4180
4181 pci_read_config_word(dev, PCI_COMMAND, &cmd);
4182 if (cmd & PCI_COMMAND_INVALIDATE) {
4183 cmd &= ~PCI_COMMAND_INVALIDATE;
4184 pci_write_config_word(dev, PCI_COMMAND, cmd);
4185 }
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004186#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07004187}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004188EXPORT_SYMBOL(pci_clear_mwi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004189
Brett M Russa04ce0f2005-08-15 15:23:41 -04004190/**
4191 * pci_intx - enables/disables PCI INTx for device dev
Randy Dunlap8f7020d2005-10-23 11:57:38 -07004192 * @pdev: the PCI device to operate on
4193 * @enable: boolean: whether to enable or disable PCI INTx
Brett M Russa04ce0f2005-08-15 15:23:41 -04004194 *
4195 * Enables/disables PCI INTx for device dev
4196 */
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004197void pci_intx(struct pci_dev *pdev, int enable)
Brett M Russa04ce0f2005-08-15 15:23:41 -04004198{
4199 u16 pci_command, new;
4200
4201 pci_read_config_word(pdev, PCI_COMMAND, &pci_command);
4202
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004203 if (enable)
Brett M Russa04ce0f2005-08-15 15:23:41 -04004204 new = pci_command & ~PCI_COMMAND_INTX_DISABLE;
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04004205 else
Brett M Russa04ce0f2005-08-15 15:23:41 -04004206 new = pci_command | PCI_COMMAND_INTX_DISABLE;
Brett M Russa04ce0f2005-08-15 15:23:41 -04004207
4208 if (new != pci_command) {
Tejun Heo9ac78492007-01-20 16:00:26 +09004209 struct pci_devres *dr;
4210
Brett M Russ2fd9d742005-09-09 10:02:22 -07004211 pci_write_config_word(pdev, PCI_COMMAND, new);
Tejun Heo9ac78492007-01-20 16:00:26 +09004212
4213 dr = find_pci_dr(pdev);
4214 if (dr && !dr->restore_intx) {
4215 dr->restore_intx = 1;
4216 dr->orig_intx = !enable;
4217 }
Brett M Russa04ce0f2005-08-15 15:23:41 -04004218 }
4219}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06004220EXPORT_SYMBOL_GPL(pci_intx);
Brett M Russa04ce0f2005-08-15 15:23:41 -04004221
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004222static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask)
4223{
4224 struct pci_bus *bus = dev->bus;
4225 bool mask_updated = true;
4226 u32 cmd_status_dword;
4227 u16 origcmd, newcmd;
4228 unsigned long flags;
4229 bool irq_pending;
4230
4231 /*
4232 * We do a single dword read to retrieve both command and status.
4233 * Document assumptions that make this possible.
4234 */
4235 BUILD_BUG_ON(PCI_COMMAND % 4);
4236 BUILD_BUG_ON(PCI_COMMAND + 2 != PCI_STATUS);
4237
4238 raw_spin_lock_irqsave(&pci_lock, flags);
4239
4240 bus->ops->read(bus, dev->devfn, PCI_COMMAND, 4, &cmd_status_dword);
4241
4242 irq_pending = (cmd_status_dword >> 16) & PCI_STATUS_INTERRUPT;
4243
4244 /*
4245 * Check interrupt status register to see whether our device
4246 * triggered the interrupt (when masking) or the next IRQ is
4247 * already pending (when unmasking).
4248 */
4249 if (mask != irq_pending) {
4250 mask_updated = false;
4251 goto done;
4252 }
4253
4254 origcmd = cmd_status_dword;
4255 newcmd = origcmd & ~PCI_COMMAND_INTX_DISABLE;
4256 if (mask)
4257 newcmd |= PCI_COMMAND_INTX_DISABLE;
4258 if (newcmd != origcmd)
4259 bus->ops->write(bus, dev->devfn, PCI_COMMAND, 2, newcmd);
4260
4261done:
4262 raw_spin_unlock_irqrestore(&pci_lock, flags);
4263
4264 return mask_updated;
4265}
4266
4267/**
4268 * pci_check_and_mask_intx - mask INTx on pending interrupt
Randy Dunlap6e9292c2012-01-21 11:02:35 -08004269 * @dev: the PCI device to operate on
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004270 *
4271 * Check if the device dev has its INTx line asserted, mask it and
Piotr Gregor99b3c582017-05-26 22:02:25 +01004272 * return true in that case. False is returned if no interrupt was
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004273 * pending.
4274 */
4275bool pci_check_and_mask_intx(struct pci_dev *dev)
4276{
4277 return pci_check_and_set_intx_mask(dev, true);
4278}
4279EXPORT_SYMBOL_GPL(pci_check_and_mask_intx);
4280
4281/**
Bjorn Helgaasebd50b92014-01-14 17:10:39 -07004282 * pci_check_and_unmask_intx - unmask INTx if no interrupt is pending
Randy Dunlap6e9292c2012-01-21 11:02:35 -08004283 * @dev: the PCI device to operate on
Jan Kiszkaa2e27782011-11-04 09:46:00 +01004284 *
4285 * Check if the device dev has its INTx line asserted, unmask it if not
4286 * and return true. False is returned and the mask remains active if
4287 * there was still an interrupt pending.
4288 */
4289bool pci_check_and_unmask_intx(struct pci_dev *dev)
4290{
4291 return pci_check_and_set_intx_mask(dev, false);
4292}
4293EXPORT_SYMBOL_GPL(pci_check_and_unmask_intx);
4294
Casey Leedom3775a202013-08-06 15:48:36 +05304295/**
4296 * pci_wait_for_pending_transaction - waits for pending transaction
4297 * @dev: the PCI device to operate on
4298 *
4299 * Return 0 if transaction is pending 1 otherwise.
4300 */
4301int pci_wait_for_pending_transaction(struct pci_dev *dev)
Sheng Yang8dd7f802008-10-21 17:38:25 +08004302{
Alex Williamson157e8762013-12-17 16:43:39 -07004303 if (!pci_is_pcie(dev))
4304 return 1;
Sheng Yang8dd7f802008-10-21 17:38:25 +08004305
Gavin Shand0b4cc42014-05-19 13:06:46 +10004306 return pci_wait_for_pending(dev, pci_pcie_cap(dev) + PCI_EXP_DEVSTA,
4307 PCI_EXP_DEVSTA_TRPND);
Casey Leedom3775a202013-08-06 15:48:36 +05304308}
4309EXPORT_SYMBOL(pci_wait_for_pending_transaction);
Sheng Yang5fe5db02009-02-09 14:53:47 +08004310
Sinan Kayaa2758b62018-02-27 14:14:10 -06004311static int pci_dev_wait(struct pci_dev *dev, char *reset_type, int timeout)
Alex Williamson5adecf82016-02-22 13:05:48 -07004312{
Sinan Kayaa2758b62018-02-27 14:14:10 -06004313 int delay = 1;
Alex Williamson5adecf82016-02-22 13:05:48 -07004314 u32 id;
4315
Sinan Kaya821cdad2017-08-29 14:45:45 -05004316 /*
Sinan Kayaa2758b62018-02-27 14:14:10 -06004317 * After reset, the device should not silently discard config
Sinan Kaya821cdad2017-08-29 14:45:45 -05004318 * requests, but it may still indicate that it needs more time by
4319 * responding to them with CRS completions. The Root Port will
4320 * generally synthesize ~0 data to complete the read (except when
4321 * CRS SV is enabled and the read was for the Vendor ID; in that
4322 * case it synthesizes 0x0001 data).
4323 *
4324 * Wait for the device to return a non-CRS completion. Read the
4325 * Command register instead of Vendor ID so we don't have to
4326 * contend with the CRS SV value.
4327 */
4328 pci_read_config_dword(dev, PCI_COMMAND, &id);
4329 while (id == ~0) {
4330 if (delay > timeout) {
Sinan Kayaa2758b62018-02-27 14:14:10 -06004331 pci_warn(dev, "not ready %dms after %s; giving up\n",
4332 delay - 1, reset_type);
Sinan Kaya91295d72018-02-27 14:14:08 -06004333 return -ENOTTY;
Sinan Kaya821cdad2017-08-29 14:45:45 -05004334 }
4335
4336 if (delay > 1000)
Sinan Kayaa2758b62018-02-27 14:14:10 -06004337 pci_info(dev, "not ready %dms after %s; waiting\n",
4338 delay - 1, reset_type);
Sinan Kaya821cdad2017-08-29 14:45:45 -05004339
4340 msleep(delay);
4341 delay *= 2;
4342 pci_read_config_dword(dev, PCI_COMMAND, &id);
4343 }
4344
4345 if (delay > 1000)
Sinan Kayaa2758b62018-02-27 14:14:10 -06004346 pci_info(dev, "ready %dms after %s\n", delay - 1,
4347 reset_type);
Sinan Kaya91295d72018-02-27 14:14:08 -06004348
4349 return 0;
Alex Williamson5adecf82016-02-22 13:05:48 -07004350}
4351
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004352/**
4353 * pcie_has_flr - check if a device supports function level resets
4354 * @dev: device to check
4355 *
4356 * Returns true if the device advertises support for PCIe function level
4357 * resets.
4358 */
Alex Williamson2d2917f2018-08-09 14:04:14 -06004359bool pcie_has_flr(struct pci_dev *dev)
Casey Leedom3775a202013-08-06 15:48:36 +05304360{
4361 u32 cap;
4362
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004363 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004364 return false;
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004365
Casey Leedom3775a202013-08-06 15:48:36 +05304366 pcie_capability_read_dword(dev, PCI_EXP_DEVCAP, &cap);
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004367 return cap & PCI_EXP_DEVCAP_FLR;
4368}
Alex Williamson2d2917f2018-08-09 14:04:14 -06004369EXPORT_SYMBOL_GPL(pcie_has_flr);
Casey Leedom3775a202013-08-06 15:48:36 +05304370
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004371/**
4372 * pcie_flr - initiate a PCIe function level reset
4373 * @dev: device to reset
4374 *
4375 * Initiate a function level reset on @dev. The caller should ensure the
4376 * device supports FLR before calling this function, e.g. by using the
4377 * pcie_has_flr() helper.
4378 */
Sinan Kaya91295d72018-02-27 14:14:08 -06004379int pcie_flr(struct pci_dev *dev)
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004380{
Casey Leedom3775a202013-08-06 15:48:36 +05304381 if (!pci_wait_for_pending_transaction(dev))
Frederick Lawler7506dc72018-01-18 12:55:24 -06004382 pci_err(dev, "timed out waiting for pending transaction; performing function level reset anyway\n");
Casey Leedom3775a202013-08-06 15:48:36 +05304383
Jiang Liu59875ae2012-07-24 17:20:06 +08004384 pcie_capability_set_word(dev, PCI_EXP_DEVCTL, PCI_EXP_DEVCTL_BCR_FLR);
Sinan Kayaa2758b62018-02-27 14:14:10 -06004385
4386 /*
4387 * Per PCIe r4.0, sec 6.6.2, a device must complete an FLR within
4388 * 100ms, but may silently discard requests while the FLR is in
4389 * progress. Wait 100ms before trying to access the device.
4390 */
4391 msleep(100);
4392
4393 return pci_dev_wait(dev, "FLR", PCIE_RESET_READY_POLL_MS);
Sheng Yang8dd7f802008-10-21 17:38:25 +08004394}
Christoph Hellwiga60a2b72017-04-14 21:11:25 +02004395EXPORT_SYMBOL_GPL(pcie_flr);
Sheng Yangd91cdc72008-11-11 17:17:47 +08004396
Yu Zhao8c1c6992009-06-13 15:52:13 +08004397static int pci_af_flr(struct pci_dev *dev, int probe)
Sheng Yang1ca88792008-11-11 17:17:48 +08004398{
Yu Zhao8c1c6992009-06-13 15:52:13 +08004399 int pos;
Sheng Yang1ca88792008-11-11 17:17:48 +08004400 u8 cap;
4401
Yu Zhao8c1c6992009-06-13 15:52:13 +08004402 pos = pci_find_capability(dev, PCI_CAP_ID_AF);
4403 if (!pos)
Sheng Yang1ca88792008-11-11 17:17:48 +08004404 return -ENOTTY;
Yu Zhao8c1c6992009-06-13 15:52:13 +08004405
Sasha Neftinf65fd1a2017-04-03 16:02:50 -05004406 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4407 return -ENOTTY;
4408
Yu Zhao8c1c6992009-06-13 15:52:13 +08004409 pci_read_config_byte(dev, pos + PCI_AF_CAP, &cap);
Sheng Yang1ca88792008-11-11 17:17:48 +08004410 if (!(cap & PCI_AF_CAP_TP) || !(cap & PCI_AF_CAP_FLR))
4411 return -ENOTTY;
4412
4413 if (probe)
4414 return 0;
4415
Alex Williamsond066c942014-06-17 15:40:13 -06004416 /*
4417 * Wait for Transaction Pending bit to clear. A word-aligned test
4418 * is used, so we use the conrol offset rather than status and shift
4419 * the test bit to match.
4420 */
Gavin Shanbb383e22014-11-12 13:41:51 +11004421 if (!pci_wait_for_pending(dev, pos + PCI_AF_CTRL,
Alex Williamsond066c942014-06-17 15:40:13 -06004422 PCI_AF_STATUS_TP << 8))
Frederick Lawler7506dc72018-01-18 12:55:24 -06004423 pci_err(dev, "timed out waiting for pending transaction; performing AF function level reset anyway\n");
Yu Zhao8c1c6992009-06-13 15:52:13 +08004424
Yu Zhao8c1c6992009-06-13 15:52:13 +08004425 pci_write_config_byte(dev, pos + PCI_AF_CTRL, PCI_AF_CTRL_FLR);
Sinan Kayaa2758b62018-02-27 14:14:10 -06004426
4427 /*
4428 * Per Advanced Capabilities for Conventional PCI ECN, 13 April 2006,
4429 * updated 27 July 2006; a device must complete an FLR within
4430 * 100ms, but may silently discard requests while the FLR is in
4431 * progress. Wait 100ms before trying to access the device.
4432 */
4433 msleep(100);
4434
4435 return pci_dev_wait(dev, "AF_FLR", PCIE_RESET_READY_POLL_MS);
Sheng Yang1ca88792008-11-11 17:17:48 +08004436}
4437
Rafael J. Wysocki83d74e02011-03-05 21:48:44 +01004438/**
4439 * pci_pm_reset - Put device into PCI_D3 and back into PCI_D0.
4440 * @dev: Device to reset.
4441 * @probe: If set, only check if the device can be reset this way.
4442 *
4443 * If @dev supports native PCI PM and its PCI_PM_CTRL_NO_SOFT_RESET flag is
4444 * unset, it will be reinitialized internally when going from PCI_D3hot to
4445 * PCI_D0. If that's the case and the device is not in a low-power state
4446 * already, force it into PCI_D3hot and back to PCI_D0, causing it to be reset.
4447 *
4448 * NOTE: This causes the caller to sleep for twice the device power transition
4449 * cooldown period, which for the D0->D3hot and D3hot->D0 transitions is 10 ms
Bjorn Helgaasf7625982013-11-14 11:28:18 -07004450 * by default (i.e. unless the @dev's d3_delay field has a different value).
Rafael J. Wysocki83d74e02011-03-05 21:48:44 +01004451 * Moreover, only devices in D0 can be reset by this function.
4452 */
Yu Zhaof85876b2009-06-13 15:52:14 +08004453static int pci_pm_reset(struct pci_dev *dev, int probe)
Sheng Yangd91cdc72008-11-11 17:17:47 +08004454{
Yu Zhaof85876b2009-06-13 15:52:14 +08004455 u16 csr;
Sheng Yangd91cdc72008-11-11 17:17:47 +08004456
Alex Williamson51e53732014-11-21 11:24:08 -07004457 if (!dev->pm_cap || dev->dev_flags & PCI_DEV_FLAGS_NO_PM_RESET)
Yu Zhaof85876b2009-06-13 15:52:14 +08004458 return -ENOTTY;
Sheng Yangd91cdc72008-11-11 17:17:47 +08004459
Yu Zhaof85876b2009-06-13 15:52:14 +08004460 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &csr);
4461 if (csr & PCI_PM_CTRL_NO_SOFT_RESET)
4462 return -ENOTTY;
Sheng Yang1ca88792008-11-11 17:17:48 +08004463
Yu Zhaof85876b2009-06-13 15:52:14 +08004464 if (probe)
4465 return 0;
4466
4467 if (dev->current_state != PCI_D0)
4468 return -EINVAL;
4469
4470 csr &= ~PCI_PM_CTRL_STATE_MASK;
4471 csr |= PCI_D3hot;
4472 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01004473 pci_dev_d3_sleep(dev);
Yu Zhaof85876b2009-06-13 15:52:14 +08004474
4475 csr &= ~PCI_PM_CTRL_STATE_MASK;
4476 csr |= PCI_D0;
4477 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
Rafael J. Wysocki1ae861e2009-12-31 12:15:54 +01004478 pci_dev_d3_sleep(dev);
Yu Zhaof85876b2009-06-13 15:52:14 +08004479
Sinan Kayaabbcf0e2018-02-27 14:14:10 -06004480 return pci_dev_wait(dev, "PM D3->D0", PCIE_RESET_READY_POLL_MS);
Yu Zhaof85876b2009-06-13 15:52:14 +08004481}
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004482/**
4483 * pcie_wait_for_link - Wait until link is active or inactive
4484 * @pdev: Bridge device
4485 * @active: waiting for active or inactive?
4486 *
4487 * Use this to wait till link becomes active or inactive.
4488 */
4489bool pcie_wait_for_link(struct pci_dev *pdev, bool active)
4490{
4491 int timeout = 1000;
4492 bool ret;
4493 u16 lnk_status;
4494
Keith Buschf0157162018-09-20 10:27:17 -06004495 /*
4496 * Some controllers might not implement link active reporting. In this
4497 * case, we wait for 1000 + 100 ms.
4498 */
4499 if (!pdev->link_active_reporting) {
4500 msleep(1100);
4501 return true;
4502 }
4503
4504 /*
4505 * PCIe r4.0 sec 6.6.1, a component must enter LTSSM Detect within 20ms,
4506 * after which we should expect an link active if the reset was
4507 * successful. If so, software must wait a minimum 100ms before sending
4508 * configuration requests to devices downstream this port.
4509 *
4510 * If the link fails to activate, either the device was physically
4511 * removed or the link is permanently failed.
4512 */
4513 if (active)
4514 msleep(20);
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004515 for (;;) {
4516 pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnk_status);
4517 ret = !!(lnk_status & PCI_EXP_LNKSTA_DLLLA);
4518 if (ret == active)
Keith Buschf0157162018-09-20 10:27:17 -06004519 break;
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004520 if (timeout <= 0)
4521 break;
4522 msleep(10);
4523 timeout -= 10;
4524 }
Keith Buschf0157162018-09-20 10:27:17 -06004525 if (active && ret)
4526 msleep(100);
4527 else if (ret != active)
4528 pci_info(pdev, "Data Link Layer Link Active not %s in 1000 msec\n",
4529 active ? "set" : "cleared");
4530 return ret == active;
Oza Pawandeep9f5a70f12018-05-17 16:44:11 -05004531}
Yu Zhaof85876b2009-06-13 15:52:14 +08004532
Gavin Shan9e330022014-06-19 17:22:44 +10004533void pci_reset_secondary_bus(struct pci_dev *dev)
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004534{
4535 u16 ctrl;
Alex Williamson64e86742013-08-08 14:09:24 -06004536
4537 pci_read_config_word(dev, PCI_BRIDGE_CONTROL, &ctrl);
4538 ctrl |= PCI_BRIDGE_CTL_BUS_RESET;
4539 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
Bjorn Helgaasdf62ab52018-03-09 16:36:33 -06004540
Alex Williamsonde0c5482013-08-08 14:10:13 -06004541 /*
4542 * PCI spec v3.0 7.6.4.2 requires minimum Trst of 1ms. Double
Bjorn Helgaasf7625982013-11-14 11:28:18 -07004543 * this to 2ms to ensure that we meet the minimum requirement.
Alex Williamsonde0c5482013-08-08 14:10:13 -06004544 */
4545 msleep(2);
Alex Williamson64e86742013-08-08 14:09:24 -06004546
4547 ctrl &= ~PCI_BRIDGE_CTL_BUS_RESET;
4548 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
Alex Williamsonde0c5482013-08-08 14:10:13 -06004549
4550 /*
4551 * Trhfa for conventional PCI is 2^25 clock cycles.
4552 * Assuming a minimum 33MHz clock this results in a 1s
4553 * delay before we can consider subordinate devices to
4554 * be re-initialized. PCIe has some ways to shorten this,
4555 * but we don't make use of them yet.
4556 */
4557 ssleep(1);
Alex Williamson64e86742013-08-08 14:09:24 -06004558}
Gavin Shand92a2082014-04-24 18:00:24 +10004559
Gavin Shan9e330022014-06-19 17:22:44 +10004560void __weak pcibios_reset_secondary_bus(struct pci_dev *dev)
4561{
4562 pci_reset_secondary_bus(dev);
4563}
4564
Gavin Shand92a2082014-04-24 18:00:24 +10004565/**
Sinan Kaya381634c2018-07-19 18:04:11 -05004566 * pci_bridge_secondary_bus_reset - Reset the secondary bus on a PCI bridge.
Gavin Shand92a2082014-04-24 18:00:24 +10004567 * @dev: Bridge device
4568 *
4569 * Use the bridge control register to assert reset on the secondary bus.
4570 * Devices on the secondary bus are left in power-on state.
4571 */
Sinan Kaya381634c2018-07-19 18:04:11 -05004572int pci_bridge_secondary_bus_reset(struct pci_dev *dev)
Gavin Shand92a2082014-04-24 18:00:24 +10004573{
4574 pcibios_reset_secondary_bus(dev);
Sinan Kaya01fd61c2018-02-27 14:14:11 -06004575
Sinan Kaya6b2f13512018-02-27 14:14:12 -06004576 return pci_dev_wait(dev, "bus reset", PCIE_RESET_READY_POLL_MS);
Gavin Shand92a2082014-04-24 18:00:24 +10004577}
Dennis Dalessandrobfc45602018-08-31 10:34:14 -07004578EXPORT_SYMBOL_GPL(pci_bridge_secondary_bus_reset);
Alex Williamson64e86742013-08-08 14:09:24 -06004579
4580static int pci_parent_bus_reset(struct pci_dev *dev, int probe)
4581{
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004582 struct pci_dev *pdev;
4583
Alex Williamsonf331a852015-01-15 18:16:04 -06004584 if (pci_is_root_bus(dev->bus) || dev->subordinate ||
4585 !dev->bus->self || dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004586 return -ENOTTY;
4587
4588 list_for_each_entry(pdev, &dev->bus->devices, bus_list)
4589 if (pdev != dev)
4590 return -ENOTTY;
4591
4592 if (probe)
4593 return 0;
4594
Sinan Kaya381634c2018-07-19 18:04:11 -05004595 return pci_bridge_secondary_bus_reset(dev->bus->self);
Yu Zhaoc12ff1d2009-06-13 15:52:15 +08004596}
4597
Alex Williamson608c3882013-08-08 14:09:43 -06004598static int pci_reset_hotplug_slot(struct hotplug_slot *hotplug, int probe)
4599{
4600 int rc = -ENOTTY;
4601
Lukas Wunner81c4b5b2018-09-08 09:59:01 +02004602 if (!hotplug || !try_module_get(hotplug->owner))
Alex Williamson608c3882013-08-08 14:09:43 -06004603 return rc;
4604
4605 if (hotplug->ops->reset_slot)
4606 rc = hotplug->ops->reset_slot(hotplug, probe);
4607
Lukas Wunner81c4b5b2018-09-08 09:59:01 +02004608 module_put(hotplug->owner);
Alex Williamson608c3882013-08-08 14:09:43 -06004609
4610 return rc;
4611}
4612
4613static int pci_dev_reset_slot_function(struct pci_dev *dev, int probe)
4614{
4615 struct pci_dev *pdev;
4616
Alex Williamsonf331a852015-01-15 18:16:04 -06004617 if (dev->subordinate || !dev->slot ||
4618 dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
Alex Williamson608c3882013-08-08 14:09:43 -06004619 return -ENOTTY;
4620
4621 list_for_each_entry(pdev, &dev->bus->devices, bus_list)
4622 if (pdev != dev && pdev->slot == dev->slot)
4623 return -ENOTTY;
4624
4625 return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
4626}
4627
Alex Williamson77cb9852013-08-08 14:09:49 -06004628static void pci_dev_lock(struct pci_dev *dev)
4629{
4630 pci_cfg_access_lock(dev);
4631 /* block PM suspend, driver probe, etc. */
4632 device_lock(&dev->dev);
4633}
4634
Alex Williamson61cf16d2013-12-16 15:14:31 -07004635/* Return 1 on successful lock, 0 on contention */
4636static int pci_dev_trylock(struct pci_dev *dev)
4637{
4638 if (pci_cfg_access_trylock(dev)) {
4639 if (device_trylock(&dev->dev))
4640 return 1;
4641 pci_cfg_access_unlock(dev);
4642 }
4643
4644 return 0;
4645}
4646
Alex Williamson77cb9852013-08-08 14:09:49 -06004647static void pci_dev_unlock(struct pci_dev *dev)
4648{
4649 device_unlock(&dev->dev);
4650 pci_cfg_access_unlock(dev);
4651}
4652
Christoph Hellwig775755e2017-06-01 13:10:38 +02004653static void pci_dev_save_and_disable(struct pci_dev *dev)
Keith Busch3ebe7f92014-05-02 10:40:42 -06004654{
4655 const struct pci_error_handlers *err_handler =
4656 dev->driver ? dev->driver->err_handler : NULL;
Keith Busch3ebe7f92014-05-02 10:40:42 -06004657
Christoph Hellwigb014e962017-06-01 13:10:37 +02004658 /*
Christoph Hellwig775755e2017-06-01 13:10:38 +02004659 * dev->driver->err_handler->reset_prepare() is protected against
Christoph Hellwigb014e962017-06-01 13:10:37 +02004660 * races with ->remove() by the device lock, which must be held by
4661 * the caller.
4662 */
Christoph Hellwig775755e2017-06-01 13:10:38 +02004663 if (err_handler && err_handler->reset_prepare)
4664 err_handler->reset_prepare(dev);
Keith Busch3ebe7f92014-05-02 10:40:42 -06004665
Alex Williamsona6cbaad2013-08-08 14:10:02 -06004666 /*
4667 * Wake-up device prior to save. PM registers default to D0 after
4668 * reset and a simple register restore doesn't reliably return
4669 * to a non-D0 state anyway.
4670 */
4671 pci_set_power_state(dev, PCI_D0);
4672
Alex Williamson77cb9852013-08-08 14:09:49 -06004673 pci_save_state(dev);
4674 /*
4675 * Disable the device by clearing the Command register, except for
4676 * INTx-disable which is set. This not only disables MMIO and I/O port
4677 * BARs, but also prevents the device from being Bus Master, preventing
4678 * DMA from the device including MSI/MSI-X interrupts. For PCI 2.3
4679 * compliant devices, INTx-disable prevents legacy interrupts.
4680 */
4681 pci_write_config_word(dev, PCI_COMMAND, PCI_COMMAND_INTX_DISABLE);
4682}
4683
4684static void pci_dev_restore(struct pci_dev *dev)
4685{
Christoph Hellwig775755e2017-06-01 13:10:38 +02004686 const struct pci_error_handlers *err_handler =
4687 dev->driver ? dev->driver->err_handler : NULL;
4688
Alex Williamson77cb9852013-08-08 14:09:49 -06004689 pci_restore_state(dev);
Alex Williamson77cb9852013-08-08 14:09:49 -06004690
Christoph Hellwig775755e2017-06-01 13:10:38 +02004691 /*
4692 * dev->driver->err_handler->reset_done() is protected against
4693 * races with ->remove() by the device lock, which must be held by
4694 * the caller.
4695 */
4696 if (err_handler && err_handler->reset_done)
4697 err_handler->reset_done(dev);
Sheng Yangd91cdc72008-11-11 17:17:47 +08004698}
Keith Busch3ebe7f92014-05-02 10:40:42 -06004699
Sheng Yangd91cdc72008-11-11 17:17:47 +08004700/**
Konrad Rzeszutek Wilk6fbf9e72012-01-12 12:06:46 -05004701 * __pci_reset_function_locked - reset a PCI device function while holding
4702 * the @dev mutex lock.
4703 * @dev: PCI device to reset
4704 *
4705 * Some devices allow an individual function to be reset without affecting
4706 * other functions in the same device. The PCI device must be responsive
4707 * to PCI config space in order to use this function.
4708 *
4709 * The device function is presumed to be unused and the caller is holding
4710 * the device mutex lock when this function is called.
4711 * Resetting the device will make the contents of PCI configuration space
4712 * random, so any caller of this must be prepared to reinitialise the
4713 * device including MSI, bus mastering, BARs, decoding IO and memory spaces,
4714 * etc.
4715 *
4716 * Returns 0 if the device function was successfully reset or negative if the
4717 * device doesn't support resetting a single function.
4718 */
4719int __pci_reset_function_locked(struct pci_dev *dev)
4720{
Christoph Hellwig52354b92017-06-01 13:10:39 +02004721 int rc;
4722
4723 might_sleep();
4724
Bjorn Helgaas832c418a2017-10-25 17:09:24 -05004725 /*
4726 * A reset method returns -ENOTTY if it doesn't support this device
4727 * and we should try the next method.
4728 *
4729 * If it returns 0 (success), we're finished. If it returns any
4730 * other error, we're also finished: this indicates that further
4731 * reset mechanisms might be broken on the device.
4732 */
Christoph Hellwig52354b92017-06-01 13:10:39 +02004733 rc = pci_dev_specific_reset(dev, 0);
4734 if (rc != -ENOTTY)
4735 return rc;
4736 if (pcie_has_flr(dev)) {
Sinan Kaya91295d72018-02-27 14:14:08 -06004737 rc = pcie_flr(dev);
4738 if (rc != -ENOTTY)
4739 return rc;
Christoph Hellwig52354b92017-06-01 13:10:39 +02004740 }
4741 rc = pci_af_flr(dev, 0);
4742 if (rc != -ENOTTY)
4743 return rc;
4744 rc = pci_pm_reset(dev, 0);
4745 if (rc != -ENOTTY)
4746 return rc;
4747 rc = pci_dev_reset_slot_function(dev, 0);
4748 if (rc != -ENOTTY)
4749 return rc;
4750 return pci_parent_bus_reset(dev, 0);
Konrad Rzeszutek Wilk6fbf9e72012-01-12 12:06:46 -05004751}
4752EXPORT_SYMBOL_GPL(__pci_reset_function_locked);
4753
4754/**
Michael S. Tsirkin711d5772009-07-27 23:37:48 +03004755 * pci_probe_reset_function - check whether the device can be safely reset
4756 * @dev: PCI device to reset
4757 *
4758 * Some devices allow an individual function to be reset without affecting
4759 * other functions in the same device. The PCI device must be responsive
4760 * to PCI config space in order to use this function.
4761 *
4762 * Returns 0 if the device function can be reset or negative if the
4763 * device doesn't support resetting a single function.
4764 */
4765int pci_probe_reset_function(struct pci_dev *dev)
4766{
Christoph Hellwig52354b92017-06-01 13:10:39 +02004767 int rc;
4768
4769 might_sleep();
4770
4771 rc = pci_dev_specific_reset(dev, 1);
4772 if (rc != -ENOTTY)
4773 return rc;
4774 if (pcie_has_flr(dev))
4775 return 0;
4776 rc = pci_af_flr(dev, 1);
4777 if (rc != -ENOTTY)
4778 return rc;
4779 rc = pci_pm_reset(dev, 1);
4780 if (rc != -ENOTTY)
4781 return rc;
4782 rc = pci_dev_reset_slot_function(dev, 1);
4783 if (rc != -ENOTTY)
4784 return rc;
4785
4786 return pci_parent_bus_reset(dev, 1);
Michael S. Tsirkin711d5772009-07-27 23:37:48 +03004787}
4788
4789/**
Yu Zhao8c1c6992009-06-13 15:52:13 +08004790 * pci_reset_function - quiesce and reset a PCI device function
4791 * @dev: PCI device to reset
Sheng Yang8dd7f802008-10-21 17:38:25 +08004792 *
4793 * Some devices allow an individual function to be reset without affecting
4794 * other functions in the same device. The PCI device must be responsive
4795 * to PCI config space in order to use this function.
4796 *
4797 * This function does not just reset the PCI portion of a device, but
4798 * clears all the state associated with the device. This function differs
Jan H. Schönherr79e699b2017-09-06 01:21:23 +02004799 * from __pci_reset_function_locked() in that it saves and restores device state
4800 * over the reset and takes the PCI device lock.
Sheng Yang8dd7f802008-10-21 17:38:25 +08004801 *
Yu Zhao8c1c6992009-06-13 15:52:13 +08004802 * Returns 0 if the device function was successfully reset or negative if the
Sheng Yang8dd7f802008-10-21 17:38:25 +08004803 * device doesn't support resetting a single function.
4804 */
4805int pci_reset_function(struct pci_dev *dev)
4806{
Yu Zhao8c1c6992009-06-13 15:52:13 +08004807 int rc;
Sheng Yang8dd7f802008-10-21 17:38:25 +08004808
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06004809 if (!dev->reset_fn)
4810 return -ENOTTY;
Sheng Yang8dd7f802008-10-21 17:38:25 +08004811
Christoph Hellwigb014e962017-06-01 13:10:37 +02004812 pci_dev_lock(dev);
Alex Williamson77cb9852013-08-08 14:09:49 -06004813 pci_dev_save_and_disable(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08004814
Christoph Hellwig52354b92017-06-01 13:10:39 +02004815 rc = __pci_reset_function_locked(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08004816
Alex Williamson77cb9852013-08-08 14:09:49 -06004817 pci_dev_restore(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02004818 pci_dev_unlock(dev);
Sheng Yang8dd7f802008-10-21 17:38:25 +08004819
Yu Zhao8c1c6992009-06-13 15:52:13 +08004820 return rc;
Sheng Yang8dd7f802008-10-21 17:38:25 +08004821}
4822EXPORT_SYMBOL_GPL(pci_reset_function);
4823
Alex Williamson61cf16d2013-12-16 15:14:31 -07004824/**
Marc Zyngiera477b9c2017-08-01 20:11:02 -05004825 * pci_reset_function_locked - quiesce and reset a PCI device function
4826 * @dev: PCI device to reset
4827 *
4828 * Some devices allow an individual function to be reset without affecting
4829 * other functions in the same device. The PCI device must be responsive
4830 * to PCI config space in order to use this function.
4831 *
4832 * This function does not just reset the PCI portion of a device, but
4833 * clears all the state associated with the device. This function differs
Jan H. Schönherr79e699b2017-09-06 01:21:23 +02004834 * from __pci_reset_function_locked() in that it saves and restores device state
Marc Zyngiera477b9c2017-08-01 20:11:02 -05004835 * over the reset. It also differs from pci_reset_function() in that it
4836 * requires the PCI device lock to be held.
4837 *
4838 * Returns 0 if the device function was successfully reset or negative if the
4839 * device doesn't support resetting a single function.
4840 */
4841int pci_reset_function_locked(struct pci_dev *dev)
4842{
4843 int rc;
4844
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06004845 if (!dev->reset_fn)
4846 return -ENOTTY;
Marc Zyngiera477b9c2017-08-01 20:11:02 -05004847
4848 pci_dev_save_and_disable(dev);
4849
4850 rc = __pci_reset_function_locked(dev);
4851
4852 pci_dev_restore(dev);
4853
4854 return rc;
4855}
4856EXPORT_SYMBOL_GPL(pci_reset_function_locked);
4857
4858/**
Alex Williamson61cf16d2013-12-16 15:14:31 -07004859 * pci_try_reset_function - quiesce and reset a PCI device function
4860 * @dev: PCI device to reset
4861 *
4862 * Same as above, except return -EAGAIN if unable to lock device.
4863 */
4864int pci_try_reset_function(struct pci_dev *dev)
4865{
4866 int rc;
4867
Bjorn Helgaas204f4af2018-02-16 15:22:39 -06004868 if (!dev->reset_fn)
4869 return -ENOTTY;
Alex Williamson61cf16d2013-12-16 15:14:31 -07004870
Christoph Hellwigb014e962017-06-01 13:10:37 +02004871 if (!pci_dev_trylock(dev))
4872 return -EAGAIN;
Alex Williamson61cf16d2013-12-16 15:14:31 -07004873
Christoph Hellwigb014e962017-06-01 13:10:37 +02004874 pci_dev_save_and_disable(dev);
Christoph Hellwig52354b92017-06-01 13:10:39 +02004875 rc = __pci_reset_function_locked(dev);
Sinan Kayacb5e0d02018-02-27 14:14:08 -06004876 pci_dev_restore(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02004877 pci_dev_unlock(dev);
Alex Williamson61cf16d2013-12-16 15:14:31 -07004878
Alex Williamson61cf16d2013-12-16 15:14:31 -07004879 return rc;
4880}
4881EXPORT_SYMBOL_GPL(pci_try_reset_function);
4882
Alex Williamsonf331a852015-01-15 18:16:04 -06004883/* Do any devices on or below this bus prevent a bus reset? */
4884static bool pci_bus_resetable(struct pci_bus *bus)
4885{
4886 struct pci_dev *dev;
4887
David Daney35702772017-09-08 10:10:31 +02004888
4889 if (bus->self && (bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
4890 return false;
4891
Alex Williamsonf331a852015-01-15 18:16:04 -06004892 list_for_each_entry(dev, &bus->devices, bus_list) {
4893 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
4894 (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
4895 return false;
4896 }
4897
4898 return true;
4899}
4900
Alex Williamson090a3c52013-08-08 14:09:55 -06004901/* Lock devices from the top of the tree down */
4902static void pci_bus_lock(struct pci_bus *bus)
4903{
4904 struct pci_dev *dev;
4905
4906 list_for_each_entry(dev, &bus->devices, bus_list) {
4907 pci_dev_lock(dev);
4908 if (dev->subordinate)
4909 pci_bus_lock(dev->subordinate);
4910 }
4911}
4912
4913/* Unlock devices from the bottom of the tree up */
4914static void pci_bus_unlock(struct pci_bus *bus)
4915{
4916 struct pci_dev *dev;
4917
4918 list_for_each_entry(dev, &bus->devices, bus_list) {
4919 if (dev->subordinate)
4920 pci_bus_unlock(dev->subordinate);
4921 pci_dev_unlock(dev);
4922 }
4923}
4924
Alex Williamson61cf16d2013-12-16 15:14:31 -07004925/* Return 1 on successful lock, 0 on contention */
4926static int pci_bus_trylock(struct pci_bus *bus)
4927{
4928 struct pci_dev *dev;
4929
4930 list_for_each_entry(dev, &bus->devices, bus_list) {
4931 if (!pci_dev_trylock(dev))
4932 goto unlock;
4933 if (dev->subordinate) {
4934 if (!pci_bus_trylock(dev->subordinate)) {
4935 pci_dev_unlock(dev);
4936 goto unlock;
4937 }
4938 }
4939 }
4940 return 1;
4941
4942unlock:
4943 list_for_each_entry_continue_reverse(dev, &bus->devices, bus_list) {
4944 if (dev->subordinate)
4945 pci_bus_unlock(dev->subordinate);
4946 pci_dev_unlock(dev);
4947 }
4948 return 0;
4949}
4950
Alex Williamsonf331a852015-01-15 18:16:04 -06004951/* Do any devices on or below this slot prevent a bus reset? */
4952static bool pci_slot_resetable(struct pci_slot *slot)
4953{
4954 struct pci_dev *dev;
4955
Jan Glauber33ba90a2017-09-08 10:10:33 +02004956 if (slot->bus->self &&
4957 (slot->bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
4958 return false;
4959
Alex Williamsonf331a852015-01-15 18:16:04 -06004960 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
4961 if (!dev->slot || dev->slot != slot)
4962 continue;
4963 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
4964 (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
4965 return false;
4966 }
4967
4968 return true;
4969}
4970
Alex Williamson090a3c52013-08-08 14:09:55 -06004971/* Lock devices from the top of the tree down */
4972static void pci_slot_lock(struct pci_slot *slot)
4973{
4974 struct pci_dev *dev;
4975
4976 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
4977 if (!dev->slot || dev->slot != slot)
4978 continue;
4979 pci_dev_lock(dev);
4980 if (dev->subordinate)
4981 pci_bus_lock(dev->subordinate);
4982 }
4983}
4984
4985/* Unlock devices from the bottom of the tree up */
4986static void pci_slot_unlock(struct pci_slot *slot)
4987{
4988 struct pci_dev *dev;
4989
4990 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
4991 if (!dev->slot || dev->slot != slot)
4992 continue;
4993 if (dev->subordinate)
4994 pci_bus_unlock(dev->subordinate);
4995 pci_dev_unlock(dev);
4996 }
4997}
4998
Alex Williamson61cf16d2013-12-16 15:14:31 -07004999/* Return 1 on successful lock, 0 on contention */
5000static int pci_slot_trylock(struct pci_slot *slot)
5001{
5002 struct pci_dev *dev;
5003
5004 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5005 if (!dev->slot || dev->slot != slot)
5006 continue;
5007 if (!pci_dev_trylock(dev))
5008 goto unlock;
5009 if (dev->subordinate) {
5010 if (!pci_bus_trylock(dev->subordinate)) {
5011 pci_dev_unlock(dev);
5012 goto unlock;
5013 }
5014 }
5015 }
5016 return 1;
5017
5018unlock:
5019 list_for_each_entry_continue_reverse(dev,
5020 &slot->bus->devices, bus_list) {
5021 if (!dev->slot || dev->slot != slot)
5022 continue;
5023 if (dev->subordinate)
5024 pci_bus_unlock(dev->subordinate);
5025 pci_dev_unlock(dev);
5026 }
5027 return 0;
5028}
5029
Alex Williamson090a3c52013-08-08 14:09:55 -06005030/* Save and disable devices from the top of the tree down */
5031static void pci_bus_save_and_disable(struct pci_bus *bus)
5032{
5033 struct pci_dev *dev;
5034
5035 list_for_each_entry(dev, &bus->devices, bus_list) {
Christoph Hellwigb014e962017-06-01 13:10:37 +02005036 pci_dev_lock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005037 pci_dev_save_and_disable(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02005038 pci_dev_unlock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005039 if (dev->subordinate)
5040 pci_bus_save_and_disable(dev->subordinate);
5041 }
5042}
5043
5044/*
5045 * Restore devices from top of the tree down - parent bridges need to be
5046 * restored before we can get to subordinate devices.
5047 */
5048static void pci_bus_restore(struct pci_bus *bus)
5049{
5050 struct pci_dev *dev;
5051
5052 list_for_each_entry(dev, &bus->devices, bus_list) {
Christoph Hellwigb014e962017-06-01 13:10:37 +02005053 pci_dev_lock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005054 pci_dev_restore(dev);
Christoph Hellwigb014e962017-06-01 13:10:37 +02005055 pci_dev_unlock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005056 if (dev->subordinate)
5057 pci_bus_restore(dev->subordinate);
5058 }
5059}
5060
5061/* Save and disable devices from the top of the tree down */
5062static void pci_slot_save_and_disable(struct pci_slot *slot)
5063{
5064 struct pci_dev *dev;
5065
5066 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5067 if (!dev->slot || dev->slot != slot)
5068 continue;
5069 pci_dev_save_and_disable(dev);
5070 if (dev->subordinate)
5071 pci_bus_save_and_disable(dev->subordinate);
5072 }
5073}
5074
5075/*
5076 * Restore devices from top of the tree down - parent bridges need to be
5077 * restored before we can get to subordinate devices.
5078 */
5079static void pci_slot_restore(struct pci_slot *slot)
5080{
5081 struct pci_dev *dev;
5082
5083 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5084 if (!dev->slot || dev->slot != slot)
5085 continue;
Sinan Kayacb5e0d02018-02-27 14:14:08 -06005086 pci_dev_lock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005087 pci_dev_restore(dev);
Sinan Kayacb5e0d02018-02-27 14:14:08 -06005088 pci_dev_unlock(dev);
Alex Williamson090a3c52013-08-08 14:09:55 -06005089 if (dev->subordinate)
5090 pci_bus_restore(dev->subordinate);
5091 }
5092}
5093
5094static int pci_slot_reset(struct pci_slot *slot, int probe)
5095{
5096 int rc;
5097
Alex Williamsonf331a852015-01-15 18:16:04 -06005098 if (!slot || !pci_slot_resetable(slot))
Alex Williamson090a3c52013-08-08 14:09:55 -06005099 return -ENOTTY;
5100
5101 if (!probe)
5102 pci_slot_lock(slot);
5103
5104 might_sleep();
5105
5106 rc = pci_reset_hotplug_slot(slot->hotplug, probe);
5107
5108 if (!probe)
5109 pci_slot_unlock(slot);
5110
5111 return rc;
5112}
5113
5114/**
Alex Williamson9a3d2b92013-08-14 14:06:05 -06005115 * pci_probe_reset_slot - probe whether a PCI slot can be reset
5116 * @slot: PCI slot to probe
5117 *
5118 * Return 0 if slot can be reset, negative if a slot reset is not supported.
5119 */
5120int pci_probe_reset_slot(struct pci_slot *slot)
5121{
5122 return pci_slot_reset(slot, 1);
5123}
5124EXPORT_SYMBOL_GPL(pci_probe_reset_slot);
5125
5126/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005127 * __pci_reset_slot - Try to reset a PCI slot
Alex Williamson090a3c52013-08-08 14:09:55 -06005128 * @slot: PCI slot to reset
5129 *
5130 * A PCI bus may host multiple slots, each slot may support a reset mechanism
5131 * independent of other slots. For instance, some slots may support slot power
5132 * control. In the case of a 1:1 bus to slot architecture, this function may
5133 * wrap the bus reset to avoid spurious slot related events such as hotplug.
5134 * Generally a slot reset should be attempted before a bus reset. All of the
5135 * function of the slot and any subordinate buses behind the slot are reset
5136 * through this function. PCI config space of all devices in the slot and
5137 * behind the slot is saved before and restored after reset.
5138 *
Alex Williamson61cf16d2013-12-16 15:14:31 -07005139 * Same as above except return -EAGAIN if the slot cannot be locked
5140 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005141static int __pci_reset_slot(struct pci_slot *slot)
Alex Williamson61cf16d2013-12-16 15:14:31 -07005142{
5143 int rc;
5144
5145 rc = pci_slot_reset(slot, 1);
5146 if (rc)
5147 return rc;
5148
5149 pci_slot_save_and_disable(slot);
5150
5151 if (pci_slot_trylock(slot)) {
5152 might_sleep();
5153 rc = pci_reset_hotplug_slot(slot->hotplug, 0);
5154 pci_slot_unlock(slot);
5155 } else
5156 rc = -EAGAIN;
5157
5158 pci_slot_restore(slot);
5159
5160 return rc;
5161}
Alex Williamson61cf16d2013-12-16 15:14:31 -07005162
Alex Williamson090a3c52013-08-08 14:09:55 -06005163static int pci_bus_reset(struct pci_bus *bus, int probe)
5164{
Sinan Kaya18426232018-07-19 18:04:09 -05005165 int ret;
5166
Alex Williamsonf331a852015-01-15 18:16:04 -06005167 if (!bus->self || !pci_bus_resetable(bus))
Alex Williamson090a3c52013-08-08 14:09:55 -06005168 return -ENOTTY;
5169
5170 if (probe)
5171 return 0;
5172
5173 pci_bus_lock(bus);
5174
5175 might_sleep();
5176
Sinan Kaya381634c2018-07-19 18:04:11 -05005177 ret = pci_bridge_secondary_bus_reset(bus->self);
Alex Williamson090a3c52013-08-08 14:09:55 -06005178
5179 pci_bus_unlock(bus);
5180
Sinan Kaya18426232018-07-19 18:04:09 -05005181 return ret;
Alex Williamson090a3c52013-08-08 14:09:55 -06005182}
5183
5184/**
Keith Buschc4eed622018-09-20 10:27:11 -06005185 * pci_bus_error_reset - reset the bridge's subordinate bus
5186 * @bridge: The parent device that connects to the bus to reset
5187 *
5188 * This function will first try to reset the slots on this bus if the method is
5189 * available. If slot reset fails or is not available, this will fall back to a
5190 * secondary bus reset.
5191 */
5192int pci_bus_error_reset(struct pci_dev *bridge)
5193{
5194 struct pci_bus *bus = bridge->subordinate;
5195 struct pci_slot *slot;
5196
5197 if (!bus)
5198 return -ENOTTY;
5199
5200 mutex_lock(&pci_slot_mutex);
5201 if (list_empty(&bus->slots))
5202 goto bus_reset;
5203
5204 list_for_each_entry(slot, &bus->slots, list)
5205 if (pci_probe_reset_slot(slot))
5206 goto bus_reset;
5207
5208 list_for_each_entry(slot, &bus->slots, list)
5209 if (pci_slot_reset(slot, 0))
5210 goto bus_reset;
5211
5212 mutex_unlock(&pci_slot_mutex);
5213 return 0;
5214bus_reset:
5215 mutex_unlock(&pci_slot_mutex);
5216 return pci_bus_reset(bridge->subordinate, 0);
5217}
5218
5219/**
Alex Williamson9a3d2b92013-08-14 14:06:05 -06005220 * pci_probe_reset_bus - probe whether a PCI bus can be reset
5221 * @bus: PCI bus to probe
5222 *
5223 * Return 0 if bus can be reset, negative if a bus reset is not supported.
5224 */
5225int pci_probe_reset_bus(struct pci_bus *bus)
5226{
5227 return pci_bus_reset(bus, 1);
5228}
5229EXPORT_SYMBOL_GPL(pci_probe_reset_bus);
5230
5231/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005232 * __pci_reset_bus - Try to reset a PCI bus
Alex Williamson61cf16d2013-12-16 15:14:31 -07005233 * @bus: top level PCI bus to reset
5234 *
5235 * Same as above except return -EAGAIN if the bus cannot be locked
5236 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005237static int __pci_reset_bus(struct pci_bus *bus)
Alex Williamson61cf16d2013-12-16 15:14:31 -07005238{
5239 int rc;
5240
5241 rc = pci_bus_reset(bus, 1);
5242 if (rc)
5243 return rc;
5244
5245 pci_bus_save_and_disable(bus);
5246
5247 if (pci_bus_trylock(bus)) {
5248 might_sleep();
Sinan Kaya381634c2018-07-19 18:04:11 -05005249 rc = pci_bridge_secondary_bus_reset(bus->self);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005250 pci_bus_unlock(bus);
5251 } else
5252 rc = -EAGAIN;
5253
5254 pci_bus_restore(bus);
5255
5256 return rc;
5257}
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005258
5259/**
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005260 * pci_reset_bus - Try to reset a PCI bus
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005261 * @pdev: top level PCI device to reset via slot/bus
5262 *
5263 * Same as above except return -EAGAIN if the bus cannot be locked
5264 */
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005265int pci_reset_bus(struct pci_dev *pdev)
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005266{
Dennis Dalessandrod8a52812018-09-05 16:08:03 +00005267 return (!pci_probe_reset_slot(pdev->slot)) ?
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005268 __pci_reset_slot(pdev->slot) : __pci_reset_bus(pdev->bus);
Sinan Kaya811c5cb2018-07-19 18:04:12 -05005269}
Sinan Kayac6a44ba2018-07-19 18:04:15 -05005270EXPORT_SYMBOL_GPL(pci_reset_bus);
Alex Williamson61cf16d2013-12-16 15:14:31 -07005271
5272/**
Peter Orubad556ad42007-05-15 13:59:13 +02005273 * pcix_get_max_mmrbc - get PCI-X maximum designed memory read byte count
5274 * @dev: PCI device to query
5275 *
5276 * Returns mmrbc: maximum designed memory read count in bytes
5277 * or appropriate error value.
5278 */
5279int pcix_get_max_mmrbc(struct pci_dev *dev)
5280{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005281 int cap;
Peter Orubad556ad42007-05-15 13:59:13 +02005282 u32 stat;
5283
5284 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5285 if (!cap)
5286 return -EINVAL;
5287
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005288 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
Peter Orubad556ad42007-05-15 13:59:13 +02005289 return -EINVAL;
5290
Dean Nelson25daeb52010-03-09 22:26:40 -05005291 return 512 << ((stat & PCI_X_STATUS_MAX_READ) >> 21);
Peter Orubad556ad42007-05-15 13:59:13 +02005292}
5293EXPORT_SYMBOL(pcix_get_max_mmrbc);
5294
5295/**
5296 * pcix_get_mmrbc - get PCI-X maximum memory read byte count
5297 * @dev: PCI device to query
5298 *
5299 * Returns mmrbc: maximum memory read count in bytes
5300 * or appropriate error value.
5301 */
5302int pcix_get_mmrbc(struct pci_dev *dev)
5303{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005304 int cap;
Dean Nelsonbdc2bda2010-03-09 22:26:48 -05005305 u16 cmd;
Peter Orubad556ad42007-05-15 13:59:13 +02005306
5307 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5308 if (!cap)
5309 return -EINVAL;
5310
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005311 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5312 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005313
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005314 return 512 << ((cmd & PCI_X_CMD_MAX_READ) >> 2);
Peter Orubad556ad42007-05-15 13:59:13 +02005315}
5316EXPORT_SYMBOL(pcix_get_mmrbc);
5317
5318/**
5319 * pcix_set_mmrbc - set PCI-X maximum memory read byte count
5320 * @dev: PCI device to query
5321 * @mmrbc: maximum memory read count in bytes
5322 * valid values are 512, 1024, 2048, 4096
5323 *
5324 * If possible sets maximum memory read byte count, some bridges have erratas
5325 * that prevent this.
5326 */
5327int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc)
5328{
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005329 int cap;
Dean Nelsonbdc2bda2010-03-09 22:26:48 -05005330 u32 stat, v, o;
5331 u16 cmd;
Peter Orubad556ad42007-05-15 13:59:13 +02005332
vignesh babu229f5af2007-08-13 18:23:14 +05305333 if (mmrbc < 512 || mmrbc > 4096 || !is_power_of_2(mmrbc))
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005334 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005335
5336 v = ffs(mmrbc) - 10;
5337
5338 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5339 if (!cap)
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005340 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005341
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005342 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
5343 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005344
5345 if (v > (stat & PCI_X_STATUS_MAX_READ) >> 21)
5346 return -E2BIG;
5347
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005348 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5349 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005350
5351 o = (cmd & PCI_X_CMD_MAX_READ) >> 2;
5352 if (o != v) {
Bjorn Helgaas809a3bf2012-06-20 16:41:16 -06005353 if (v > o && (dev->bus->bus_flags & PCI_BUS_FLAGS_NO_MMRBC))
Peter Orubad556ad42007-05-15 13:59:13 +02005354 return -EIO;
5355
5356 cmd &= ~PCI_X_CMD_MAX_READ;
5357 cmd |= v << 2;
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005358 if (pci_write_config_word(dev, cap + PCI_X_CMD, cmd))
5359 return -EIO;
Peter Orubad556ad42007-05-15 13:59:13 +02005360 }
Dean Nelson7c9e2b12010-03-09 22:26:55 -05005361 return 0;
Peter Orubad556ad42007-05-15 13:59:13 +02005362}
5363EXPORT_SYMBOL(pcix_set_mmrbc);
5364
5365/**
5366 * pcie_get_readrq - get PCI Express read request size
5367 * @dev: PCI device to query
5368 *
5369 * Returns maximum memory read request in bytes
5370 * or appropriate error value.
5371 */
5372int pcie_get_readrq(struct pci_dev *dev)
5373{
Peter Orubad556ad42007-05-15 13:59:13 +02005374 u16 ctl;
5375
Jiang Liu59875ae2012-07-24 17:20:06 +08005376 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
Peter Orubad556ad42007-05-15 13:59:13 +02005377
Jiang Liu59875ae2012-07-24 17:20:06 +08005378 return 128 << ((ctl & PCI_EXP_DEVCTL_READRQ) >> 12);
Peter Orubad556ad42007-05-15 13:59:13 +02005379}
5380EXPORT_SYMBOL(pcie_get_readrq);
5381
5382/**
5383 * pcie_set_readrq - set PCI Express maximum memory read request
5384 * @dev: PCI device to query
Randy Dunlap42e61f4a2007-07-23 21:42:11 -07005385 * @rq: maximum memory read count in bytes
Peter Orubad556ad42007-05-15 13:59:13 +02005386 * valid values are 128, 256, 512, 1024, 2048, 4096
5387 *
Jon Masonc9b378c2011-06-28 18:26:25 -05005388 * If possible sets maximum memory read request in bytes
Peter Orubad556ad42007-05-15 13:59:13 +02005389 */
5390int pcie_set_readrq(struct pci_dev *dev, int rq)
5391{
Jiang Liu59875ae2012-07-24 17:20:06 +08005392 u16 v;
Peter Orubad556ad42007-05-15 13:59:13 +02005393
vignesh babu229f5af2007-08-13 18:23:14 +05305394 if (rq < 128 || rq > 4096 || !is_power_of_2(rq))
Jiang Liu59875ae2012-07-24 17:20:06 +08005395 return -EINVAL;
Peter Orubad556ad42007-05-15 13:59:13 +02005396
Benjamin Herrenschmidta1c473a2011-10-14 14:56:15 -05005397 /*
5398 * If using the "performance" PCIe config, we clamp the
5399 * read rq size to the max packet size to prevent the
5400 * host bridge generating requests larger than we can
5401 * cope with
5402 */
5403 if (pcie_bus_config == PCIE_BUS_PERFORMANCE) {
5404 int mps = pcie_get_mps(dev);
5405
Benjamin Herrenschmidta1c473a2011-10-14 14:56:15 -05005406 if (mps < rq)
5407 rq = mps;
5408 }
5409
5410 v = (ffs(rq) - 8) << 12;
Peter Orubad556ad42007-05-15 13:59:13 +02005411
Jiang Liu59875ae2012-07-24 17:20:06 +08005412 return pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
5413 PCI_EXP_DEVCTL_READRQ, v);
Peter Orubad556ad42007-05-15 13:59:13 +02005414}
5415EXPORT_SYMBOL(pcie_set_readrq);
5416
5417/**
Jon Masonb03e7492011-07-20 15:20:54 -05005418 * pcie_get_mps - get PCI Express maximum payload size
5419 * @dev: PCI device to query
5420 *
5421 * Returns maximum payload size in bytes
Jon Masonb03e7492011-07-20 15:20:54 -05005422 */
5423int pcie_get_mps(struct pci_dev *dev)
5424{
Jon Masonb03e7492011-07-20 15:20:54 -05005425 u16 ctl;
5426
Jiang Liu59875ae2012-07-24 17:20:06 +08005427 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
Jon Masonb03e7492011-07-20 15:20:54 -05005428
Jiang Liu59875ae2012-07-24 17:20:06 +08005429 return 128 << ((ctl & PCI_EXP_DEVCTL_PAYLOAD) >> 5);
Jon Masonb03e7492011-07-20 15:20:54 -05005430}
Yijing Wangf1c66c42013-09-24 12:08:06 -06005431EXPORT_SYMBOL(pcie_get_mps);
Jon Masonb03e7492011-07-20 15:20:54 -05005432
5433/**
5434 * pcie_set_mps - set PCI Express maximum payload size
5435 * @dev: PCI device to query
Randy Dunlap47c08f32011-08-20 11:49:43 -07005436 * @mps: maximum payload size in bytes
Jon Masonb03e7492011-07-20 15:20:54 -05005437 * valid values are 128, 256, 512, 1024, 2048, 4096
5438 *
5439 * If possible sets maximum payload size
5440 */
5441int pcie_set_mps(struct pci_dev *dev, int mps)
5442{
Jiang Liu59875ae2012-07-24 17:20:06 +08005443 u16 v;
Jon Masonb03e7492011-07-20 15:20:54 -05005444
5445 if (mps < 128 || mps > 4096 || !is_power_of_2(mps))
Jiang Liu59875ae2012-07-24 17:20:06 +08005446 return -EINVAL;
Jon Masonb03e7492011-07-20 15:20:54 -05005447
5448 v = ffs(mps) - 8;
Bjorn Helgaasf7625982013-11-14 11:28:18 -07005449 if (v > dev->pcie_mpss)
Jiang Liu59875ae2012-07-24 17:20:06 +08005450 return -EINVAL;
Jon Masonb03e7492011-07-20 15:20:54 -05005451 v <<= 5;
5452
Jiang Liu59875ae2012-07-24 17:20:06 +08005453 return pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
5454 PCI_EXP_DEVCTL_PAYLOAD, v);
Jon Masonb03e7492011-07-20 15:20:54 -05005455}
Yijing Wangf1c66c42013-09-24 12:08:06 -06005456EXPORT_SYMBOL(pcie_set_mps);
Jon Masonb03e7492011-07-20 15:20:54 -05005457
5458/**
Tal Gilboa6db79a82018-03-30 08:37:44 -05005459 * pcie_bandwidth_available - determine minimum link settings of a PCIe
5460 * device and its bandwidth limitation
5461 * @dev: PCI device to query
5462 * @limiting_dev: storage for device causing the bandwidth limitation
5463 * @speed: storage for speed of limiting device
5464 * @width: storage for width of limiting device
5465 *
5466 * Walk up the PCI device chain and find the point where the minimum
5467 * bandwidth is available. Return the bandwidth available there and (if
5468 * limiting_dev, speed, and width pointers are supplied) information about
5469 * that point. The bandwidth returned is in Mb/s, i.e., megabits/second of
5470 * raw bandwidth.
5471 */
5472u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
5473 enum pci_bus_speed *speed,
5474 enum pcie_link_width *width)
5475{
5476 u16 lnksta;
5477 enum pci_bus_speed next_speed;
5478 enum pcie_link_width next_width;
5479 u32 bw, next_bw;
5480
5481 if (speed)
5482 *speed = PCI_SPEED_UNKNOWN;
5483 if (width)
5484 *width = PCIE_LNK_WIDTH_UNKNOWN;
5485
5486 bw = 0;
5487
5488 while (dev) {
5489 pcie_capability_read_word(dev, PCI_EXP_LNKSTA, &lnksta);
5490
5491 next_speed = pcie_link_speed[lnksta & PCI_EXP_LNKSTA_CLS];
5492 next_width = (lnksta & PCI_EXP_LNKSTA_NLW) >>
5493 PCI_EXP_LNKSTA_NLW_SHIFT;
5494
5495 next_bw = next_width * PCIE_SPEED2MBS_ENC(next_speed);
5496
5497 /* Check if current device limits the total bandwidth */
5498 if (!bw || next_bw <= bw) {
5499 bw = next_bw;
5500
5501 if (limiting_dev)
5502 *limiting_dev = dev;
5503 if (speed)
5504 *speed = next_speed;
5505 if (width)
5506 *width = next_width;
5507 }
5508
5509 dev = pci_upstream_bridge(dev);
5510 }
5511
5512 return bw;
5513}
5514EXPORT_SYMBOL(pcie_bandwidth_available);
5515
5516/**
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005517 * pcie_get_speed_cap - query for the PCI device's link speed capability
5518 * @dev: PCI device to query
5519 *
5520 * Query the PCI device speed capability. Return the maximum link speed
5521 * supported by the device.
5522 */
5523enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev)
5524{
5525 u32 lnkcap2, lnkcap;
5526
5527 /*
5528 * PCIe r4.0 sec 7.5.3.18 recommends using the Supported Link
5529 * Speeds Vector in Link Capabilities 2 when supported, falling
5530 * back to Max Link Speed in Link Capabilities otherwise.
5531 */
5532 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP2, &lnkcap2);
5533 if (lnkcap2) { /* PCIe r3.0-compliant */
5534 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_16_0GB)
5535 return PCIE_SPEED_16_0GT;
5536 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB)
5537 return PCIE_SPEED_8_0GT;
5538 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB)
5539 return PCIE_SPEED_5_0GT;
5540 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB)
5541 return PCIE_SPEED_2_5GT;
5542 return PCI_SPEED_UNKNOWN;
5543 }
5544
5545 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
5546 if (lnkcap) {
5547 if (lnkcap & PCI_EXP_LNKCAP_SLS_16_0GB)
5548 return PCIE_SPEED_16_0GT;
5549 else if (lnkcap & PCI_EXP_LNKCAP_SLS_8_0GB)
5550 return PCIE_SPEED_8_0GT;
5551 else if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB)
5552 return PCIE_SPEED_5_0GT;
5553 else if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB)
5554 return PCIE_SPEED_2_5GT;
5555 }
5556
5557 return PCI_SPEED_UNKNOWN;
5558}
Alex Deucher576c7212018-06-25 13:17:41 -05005559EXPORT_SYMBOL(pcie_get_speed_cap);
Tal Gilboa6cf57be2018-03-30 07:44:05 -05005560
5561/**
Tal Gilboac70b65f2018-03-30 08:24:36 -05005562 * pcie_get_width_cap - query for the PCI device's link width capability
5563 * @dev: PCI device to query
5564 *
5565 * Query the PCI device width capability. Return the maximum link width
5566 * supported by the device.
5567 */
5568enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev)
5569{
5570 u32 lnkcap;
5571
5572 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
5573 if (lnkcap)
5574 return (lnkcap & PCI_EXP_LNKCAP_MLW) >> 4;
5575
5576 return PCIE_LNK_WIDTH_UNKNOWN;
5577}
Alex Deucher576c7212018-06-25 13:17:41 -05005578EXPORT_SYMBOL(pcie_get_width_cap);
Tal Gilboac70b65f2018-03-30 08:24:36 -05005579
5580/**
Tal Gilboab852f632018-03-30 08:32:03 -05005581 * pcie_bandwidth_capable - calculate a PCI device's link bandwidth capability
5582 * @dev: PCI device
5583 * @speed: storage for link speed
5584 * @width: storage for link width
5585 *
5586 * Calculate a PCI device's link bandwidth by querying for its link speed
5587 * and width, multiplying them, and applying encoding overhead. The result
5588 * is in Mb/s, i.e., megabits/second of raw bandwidth.
5589 */
5590u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
5591 enum pcie_link_width *width)
5592{
5593 *speed = pcie_get_speed_cap(dev);
5594 *width = pcie_get_width_cap(dev);
5595
5596 if (*speed == PCI_SPEED_UNKNOWN || *width == PCIE_LNK_WIDTH_UNKNOWN)
5597 return 0;
5598
5599 return *width * PCIE_SPEED2MBS_ENC(*speed);
5600}
5601
5602/**
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005603 * __pcie_print_link_status - Report the PCI device's link speed and width
Tal Gilboa9e506a72018-03-30 08:56:47 -05005604 * @dev: PCI device to query
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005605 * @verbose: Print info even when enough bandwidth is available
Tal Gilboa9e506a72018-03-30 08:56:47 -05005606 *
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005607 * If the available bandwidth at the device is less than the device is
5608 * capable of, report the device's maximum possible bandwidth and the
5609 * upstream link that limits its performance. If @verbose, always print
5610 * the available bandwidth, even if the device isn't constrained.
Tal Gilboa9e506a72018-03-30 08:56:47 -05005611 */
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005612void __pcie_print_link_status(struct pci_dev *dev, bool verbose)
Tal Gilboa9e506a72018-03-30 08:56:47 -05005613{
5614 enum pcie_link_width width, width_cap;
5615 enum pci_bus_speed speed, speed_cap;
5616 struct pci_dev *limiting_dev = NULL;
5617 u32 bw_avail, bw_cap;
5618
5619 bw_cap = pcie_bandwidth_capable(dev, &speed_cap, &width_cap);
5620 bw_avail = pcie_bandwidth_available(dev, &limiting_dev, &speed, &width);
5621
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005622 if (bw_avail >= bw_cap && verbose)
Jakub Kicinski0cf22d62018-04-20 12:56:36 -05005623 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth (%s x%d link)\n",
Tal Gilboa9e506a72018-03-30 08:56:47 -05005624 bw_cap / 1000, bw_cap % 1000,
5625 PCIE_SPEED2STR(speed_cap), width_cap);
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005626 else if (bw_avail < bw_cap)
Jakub Kicinski0cf22d62018-04-20 12:56:36 -05005627 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 -05005628 bw_avail / 1000, bw_avail % 1000,
5629 PCIE_SPEED2STR(speed), width,
5630 limiting_dev ? pci_name(limiting_dev) : "<unknown>",
5631 bw_cap / 1000, bw_cap % 1000,
5632 PCIE_SPEED2STR(speed_cap), width_cap);
5633}
Alexandru Gagniuc2d1ce5e2018-08-06 18:25:35 -05005634
5635/**
5636 * pcie_print_link_status - Report the PCI device's link speed and width
5637 * @dev: PCI device to query
5638 *
5639 * Report the available bandwidth at the device.
5640 */
5641void pcie_print_link_status(struct pci_dev *dev)
5642{
5643 __pcie_print_link_status(dev, true);
5644}
Tal Gilboa9e506a72018-03-30 08:56:47 -05005645EXPORT_SYMBOL(pcie_print_link_status);
5646
5647/**
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09005648 * pci_select_bars - Make BAR mask from the type of resource
Randy Dunlapf95d8822007-02-10 14:41:56 -08005649 * @dev: the PCI device for which BAR mask is made
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09005650 * @flags: resource type mask to be selected
5651 *
5652 * This helper routine makes bar mask from the type of resource.
5653 */
5654int pci_select_bars(struct pci_dev *dev, unsigned long flags)
5655{
5656 int i, bars = 0;
5657 for (i = 0; i < PCI_NUM_RESOURCES; i++)
5658 if (pci_resource_flags(dev, i) & flags)
5659 bars |= (1 << i);
5660 return bars;
5661}
Ryan Desfossesb7fe9432014-04-25 14:32:25 -06005662EXPORT_SYMBOL(pci_select_bars);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +09005663
Mike Travis95a8b6e2010-02-02 14:38:13 -08005664/* Some architectures require additional programming to enable VGA */
5665static arch_set_vga_state_t arch_set_vga_state;
5666
5667void __init pci_register_set_vga_state(arch_set_vga_state_t func)
5668{
5669 arch_set_vga_state = func; /* NULL disables */
5670}
5671
5672static int pci_set_vga_state_arch(struct pci_dev *dev, bool decode,
Ryan Desfosses3c78bc62014-04-18 20:13:49 -04005673 unsigned int command_bits, u32 flags)
Mike Travis95a8b6e2010-02-02 14:38:13 -08005674{
5675 if (arch_set_vga_state)
5676 return arch_set_vga_state(dev, decode, command_bits,
Dave Airlie7ad35cf2011-05-25 14:00:49 +10005677 flags);
Mike Travis95a8b6e2010-02-02 14:38:13 -08005678 return 0;
5679}
5680
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005681/**
5682 * pci_set_vga_state - set VGA decode state on device and parents if requested
Randy Dunlap19eea632009-09-17 15:28:22 -07005683 * @dev: the PCI device
5684 * @decode: true = enable decoding, false = disable decoding
5685 * @command_bits: PCI_COMMAND_IO and/or PCI_COMMAND_MEMORY
Randy Dunlap3f37d622011-05-25 19:21:25 -07005686 * @flags: traverse ancestors and change bridges
Dave Airlie3448a192010-06-01 15:32:24 +10005687 * CHANGE_BRIDGE_ONLY / CHANGE_BRIDGE
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005688 */
5689int pci_set_vga_state(struct pci_dev *dev, bool decode,
Dave Airlie3448a192010-06-01 15:32:24 +10005690 unsigned int command_bits, u32 flags)
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005691{
5692 struct pci_bus *bus;
5693 struct pci_dev *bridge;
5694 u16 cmd;
Mike Travis95a8b6e2010-02-02 14:38:13 -08005695 int rc;
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005696
Bjorn Helgaas67ebd812014-04-05 15:14:22 -06005697 WARN_ON((flags & PCI_VGA_STATE_CHANGE_DECODES) && (command_bits & ~(PCI_COMMAND_IO|PCI_COMMAND_MEMORY)));
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005698
Mike Travis95a8b6e2010-02-02 14:38:13 -08005699 /* ARCH specific VGA enables */
Dave Airlie3448a192010-06-01 15:32:24 +10005700 rc = pci_set_vga_state_arch(dev, decode, command_bits, flags);
Mike Travis95a8b6e2010-02-02 14:38:13 -08005701 if (rc)
5702 return rc;
5703
Dave Airlie3448a192010-06-01 15:32:24 +10005704 if (flags & PCI_VGA_STATE_CHANGE_DECODES) {
5705 pci_read_config_word(dev, PCI_COMMAND, &cmd);
5706 if (decode == true)
5707 cmd |= command_bits;
5708 else
5709 cmd &= ~command_bits;
5710 pci_write_config_word(dev, PCI_COMMAND, cmd);
5711 }
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005712
Dave Airlie3448a192010-06-01 15:32:24 +10005713 if (!(flags & PCI_VGA_STATE_CHANGE_BRIDGE))
Benjamin Herrenschmidtdeb2d2e2009-08-11 15:52:06 +10005714 return 0;
5715
5716 bus = dev->bus;
5717 while (bus) {
5718 bridge = bus->self;
5719 if (bridge) {
5720 pci_read_config_word(bridge, PCI_BRIDGE_CONTROL,
5721 &cmd);
5722 if (decode == true)
5723 cmd |= PCI_BRIDGE_CTL_VGA;
5724 else
5725 cmd &= ~PCI_BRIDGE_CTL_VGA;
5726 pci_write_config_word(bridge, PCI_BRIDGE_CONTROL,
5727 cmd);
5728 }
5729 bus = bus->parent;
5730 }
5731 return 0;
5732}
5733
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06005734/**
5735 * pci_add_dma_alias - Add a DMA devfn alias for a device
5736 * @dev: the PCI device for which alias is added
5737 * @devfn: alias slot and function
5738 *
Logan Gunthorpef778a0d2018-05-30 14:13:11 -06005739 * This helper encodes an 8-bit devfn as a bit number in dma_alias_mask
5740 * which is used to program permissible bus-devfn source addresses for DMA
5741 * requests in an IOMMU. These aliases factor into IOMMU group creation
5742 * and are useful for devices generating DMA requests beyond or different
5743 * from their logical bus-devfn. Examples include device quirks where the
5744 * device simply uses the wrong devfn, as well as non-transparent bridges
5745 * where the alias may be a proxy for devices in another domain.
5746 *
5747 * IOMMU group creation is performed during device discovery or addition,
5748 * prior to any potential DMA mapping and therefore prior to driver probing
5749 * (especially for userspace assigned devices where IOMMU group definition
5750 * cannot be left as a userspace activity). DMA aliases should therefore
5751 * be configured via quirks, such as the PCI fixup header quirk.
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06005752 */
5753void pci_add_dma_alias(struct pci_dev *dev, u8 devfn)
5754{
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01005755 if (!dev->dma_alias_mask)
5756 dev->dma_alias_mask = kcalloc(BITS_TO_LONGS(U8_MAX),
5757 sizeof(long), GFP_KERNEL);
5758 if (!dev->dma_alias_mask) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06005759 pci_warn(dev, "Unable to allocate DMA alias mask\n");
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01005760 return;
5761 }
5762
5763 set_bit(devfn, dev->dma_alias_mask);
Frederick Lawler7506dc72018-01-18 12:55:24 -06005764 pci_info(dev, "Enabling fixed DMA alias to %02x.%d\n",
Bjorn Helgaas48c83082016-02-24 13:43:54 -06005765 PCI_SLOT(devfn), PCI_FUNC(devfn));
Bjorn Helgaasf0af9592016-02-24 13:43:45 -06005766}
5767
Jacek Lawrynowicz338c3142016-03-03 15:38:02 +01005768bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2)
5769{
5770 return (dev1->dma_alias_mask &&
5771 test_bit(dev2->devfn, dev1->dma_alias_mask)) ||
5772 (dev2->dma_alias_mask &&
5773 test_bit(dev1->devfn, dev2->dma_alias_mask));
5774}
5775
Rafael J. Wysocki8496e852013-12-01 02:34:37 +01005776bool pci_device_is_present(struct pci_dev *pdev)
5777{
5778 u32 v;
5779
Keith Buschfe2bd752017-03-29 22:49:17 -05005780 if (pci_dev_is_disconnected(pdev))
5781 return false;
Rafael J. Wysocki8496e852013-12-01 02:34:37 +01005782 return pci_bus_read_dev_vendor_id(pdev->bus, pdev->devfn, &v, 0);
5783}
5784EXPORT_SYMBOL_GPL(pci_device_is_present);
5785
Rafael J. Wysocki08249652015-04-13 16:23:36 +02005786void pci_ignore_hotplug(struct pci_dev *dev)
5787{
5788 struct pci_dev *bridge = dev->bus->self;
5789
5790 dev->ignore_hotplug = 1;
5791 /* Propagate the "ignore hotplug" setting to the parent bridge. */
5792 if (bridge)
5793 bridge->ignore_hotplug = 1;
5794}
5795EXPORT_SYMBOL_GPL(pci_ignore_hotplug);
5796
Yongji Xie0a701aa2017-04-10 19:58:12 +08005797resource_size_t __weak pcibios_default_alignment(void)
5798{
5799 return 0;
5800}
5801
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005802#define RESOURCE_ALIGNMENT_PARAM_SIZE COMMAND_LINE_SIZE
5803static char resource_alignment_param[RESOURCE_ALIGNMENT_PARAM_SIZE] = {0};
Thomas Gleixnere9d1e492009-11-06 22:41:23 +00005804static DEFINE_SPINLOCK(resource_alignment_lock);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005805
5806/**
5807 * pci_specified_resource_alignment - get resource alignment specified by user.
5808 * @dev: the PCI device to get
Yongji Xiee3adec72017-04-10 19:58:14 +08005809 * @resize: whether or not to change resources' size when reassigning alignment
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005810 *
5811 * RETURNS: Resource alignment if it is specified.
5812 * Zero if it is not specified.
5813 */
Yongji Xiee3adec72017-04-10 19:58:14 +08005814static resource_size_t pci_specified_resource_alignment(struct pci_dev *dev,
5815 bool *resize)
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005816{
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06005817 int align_order, count;
Yongji Xie0a701aa2017-04-10 19:58:12 +08005818 resource_size_t align = pcibios_default_alignment();
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06005819 const char *p;
5820 int ret;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005821
5822 spin_lock(&resource_alignment_lock);
5823 p = resource_alignment_param;
Yongji Xie0a701aa2017-04-10 19:58:12 +08005824 if (!*p && !align)
Yongji Xief0b99f72016-09-13 17:00:31 +08005825 goto out;
5826 if (pci_has_flag(PCI_PROBE_ONLY)) {
Yongji Xie0a701aa2017-04-10 19:58:12 +08005827 align = 0;
Yongji Xief0b99f72016-09-13 17:00:31 +08005828 pr_info_once("PCI: Ignoring requested alignments (PCI_PROBE_ONLY)\n");
5829 goto out;
5830 }
5831
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005832 while (*p) {
5833 count = 0;
5834 if (sscanf(p, "%d%n", &align_order, &count) == 1 &&
5835 p[count] == '@') {
5836 p += count + 1;
5837 } else {
5838 align_order = -1;
5839 }
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06005840
5841 ret = pci_dev_str_match(dev, p, &p);
5842 if (ret == 1) {
5843 *resize = true;
5844 if (align_order == -1)
5845 align = PAGE_SIZE;
5846 else
5847 align = 1 << align_order;
5848 break;
5849 } else if (ret < 0) {
5850 pr_err("PCI: Can't parse resource_alignment parameter: %s\n",
5851 p);
5852 break;
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005853 }
Logan Gunthorpe07d8d7e2018-07-30 10:18:37 -06005854
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005855 if (*p != ';' && *p != ',') {
5856 /* End of param or invalid format */
5857 break;
5858 }
5859 p++;
5860 }
Yongji Xief0b99f72016-09-13 17:00:31 +08005861out:
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005862 spin_unlock(&resource_alignment_lock);
5863 return align;
5864}
5865
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005866static void pci_request_resource_alignment(struct pci_dev *dev, int bar,
Yongji Xiee3adec72017-04-10 19:58:14 +08005867 resource_size_t align, bool resize)
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005868{
5869 struct resource *r = &dev->resource[bar];
5870 resource_size_t size;
5871
5872 if (!(r->flags & IORESOURCE_MEM))
5873 return;
5874
5875 if (r->flags & IORESOURCE_PCI_FIXED) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06005876 pci_info(dev, "BAR%d %pR: ignoring requested alignment %#llx\n",
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005877 bar, r, (unsigned long long)align);
5878 return;
5879 }
5880
5881 size = resource_size(r);
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005882 if (size >= align)
5883 return;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005884
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005885 /*
Yongji Xiee3adec72017-04-10 19:58:14 +08005886 * Increase the alignment of the resource. There are two ways we
5887 * can do this:
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005888 *
Yongji Xiee3adec72017-04-10 19:58:14 +08005889 * 1) Increase the size of the resource. BARs are aligned on their
5890 * size, so when we reallocate space for this resource, we'll
5891 * allocate it with the larger alignment. This also prevents
5892 * assignment of any other BARs inside the alignment region, so
5893 * if we're requesting page alignment, this means no other BARs
5894 * will share the page.
5895 *
5896 * The disadvantage is that this makes the resource larger than
5897 * the hardware BAR, which may break drivers that compute things
5898 * based on the resource size, e.g., to find registers at a
5899 * fixed offset before the end of the BAR.
5900 *
5901 * 2) Retain the resource size, but use IORESOURCE_STARTALIGN and
5902 * set r->start to the desired alignment. By itself this
5903 * doesn't prevent other BARs being put inside the alignment
5904 * region, but if we realign *every* resource of every device in
5905 * the system, none of them will share an alignment region.
5906 *
5907 * When the user has requested alignment for only some devices via
5908 * the "pci=resource_alignment" argument, "resize" is true and we
5909 * use the first method. Otherwise we assume we're aligning all
5910 * devices and we use the second.
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005911 */
Yongji Xiee3adec72017-04-10 19:58:14 +08005912
Frederick Lawler7506dc72018-01-18 12:55:24 -06005913 pci_info(dev, "BAR%d %pR: requesting alignment to %#llx\n",
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005914 bar, r, (unsigned long long)align);
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005915
Yongji Xiee3adec72017-04-10 19:58:14 +08005916 if (resize) {
5917 r->start = 0;
5918 r->end = align - 1;
5919 } else {
5920 r->flags &= ~IORESOURCE_SIZEALIGN;
5921 r->flags |= IORESOURCE_STARTALIGN;
5922 r->start = align;
5923 r->end = r->start + size - 1;
5924 }
Bjorn Helgaas0dde1c02017-04-17 15:20:58 -05005925 r->flags |= IORESOURCE_UNSET;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005926}
5927
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005928/*
5929 * This function disables memory decoding and releases memory resources
5930 * of the device specified by kernel's boot parameter 'pci=resource_alignment='.
5931 * It also rounds up size to specified alignment.
5932 * Later on, the kernel will assign page-aligned memory resource back
5933 * to the device.
5934 */
5935void pci_reassigndev_resource_alignment(struct pci_dev *dev)
5936{
5937 int i;
5938 struct resource *r;
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005939 resource_size_t align;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005940 u16 command;
Yongji Xiee3adec72017-04-10 19:58:14 +08005941 bool resize = false;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005942
Yongji Xie62d9a782016-09-13 17:00:32 +08005943 /*
5944 * VF BARs are read-only zero according to SR-IOV spec r1.1, sec
5945 * 3.4.1.11. Their resources are allocated from the space
5946 * described by the VF BARx register in the PF's SR-IOV capability.
5947 * We can't influence their alignment here.
5948 */
5949 if (dev->is_virtfn)
5950 return;
5951
Yinghai Lu10c463a2012-03-18 22:46:26 -07005952 /* check if specified PCI is target device to reassign */
Yongji Xiee3adec72017-04-10 19:58:14 +08005953 align = pci_specified_resource_alignment(dev, &resize);
Yinghai Lu10c463a2012-03-18 22:46:26 -07005954 if (!align)
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005955 return;
5956
5957 if (dev->hdr_type == PCI_HEADER_TYPE_NORMAL &&
5958 (dev->class >> 8) == PCI_CLASS_BRIDGE_HOST) {
Frederick Lawler7506dc72018-01-18 12:55:24 -06005959 pci_warn(dev, "Can't reassign resources to host bridge\n");
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005960 return;
5961 }
5962
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005963 pci_read_config_word(dev, PCI_COMMAND, &command);
5964 command &= ~PCI_COMMAND_MEMORY;
5965 pci_write_config_word(dev, PCI_COMMAND, command);
5966
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005967 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
Yongji Xiee3adec72017-04-10 19:58:14 +08005968 pci_request_resource_alignment(dev, i, align, resize);
Yongji Xief0b99f72016-09-13 17:00:31 +08005969
Bjorn Helgaas81a5e702017-04-14 14:12:06 -05005970 /*
5971 * Need to disable bridge's resource window,
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005972 * to enable the kernel to reassign new resource
5973 * window later on.
5974 */
5975 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE &&
5976 (dev->class >> 8) == PCI_CLASS_BRIDGE_PCI) {
5977 for (i = PCI_BRIDGE_RESOURCES; i < PCI_NUM_RESOURCES; i++) {
5978 r = &dev->resource[i];
5979 if (!(r->flags & IORESOURCE_MEM))
5980 continue;
Bjorn Helgaasbd064f02014-02-26 11:25:58 -07005981 r->flags |= IORESOURCE_UNSET;
Yinghai Lu2069ecf2012-02-15 21:40:31 -08005982 r->end = resource_size(r) - 1;
5983 r->start = 0;
5984 }
5985 pci_disable_bridge_window(dev);
5986 }
5987}
5988
Bjorn Helgaas9738abe2013-04-12 11:20:03 -06005989static ssize_t pci_set_resource_alignment_param(const char *buf, size_t count)
Yuji Shimada32a9a6822009-03-16 17:13:39 +09005990{
5991 if (count > RESOURCE_ALIGNMENT_PARAM_SIZE - 1)
5992 count = RESOURCE_ALIGNMENT_PARAM_SIZE - 1;
5993 spin_lock(&resource_alignment_lock);
5994 strncpy(resource_alignment_param, buf, count);
5995 resource_alignment_param[count] = '\0';
5996 spin_unlock(&resource_alignment_lock);
5997 return count;
5998}
5999
Bjorn Helgaas9738abe2013-04-12 11:20:03 -06006000static ssize_t pci_get_resource_alignment_param(char *buf, size_t size)
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006001{
6002 size_t count;
6003 spin_lock(&resource_alignment_lock);
6004 count = snprintf(buf, size, "%s", resource_alignment_param);
6005 spin_unlock(&resource_alignment_lock);
6006 return count;
6007}
6008
6009static ssize_t pci_resource_alignment_show(struct bus_type *bus, char *buf)
6010{
6011 return pci_get_resource_alignment_param(buf, PAGE_SIZE);
6012}
6013
6014static ssize_t pci_resource_alignment_store(struct bus_type *bus,
6015 const char *buf, size_t count)
6016{
6017 return pci_set_resource_alignment_param(buf, count);
6018}
6019
Ben Dooks21751a92016-06-09 11:42:13 +01006020static BUS_ATTR(resource_alignment, 0644, pci_resource_alignment_show,
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006021 pci_resource_alignment_store);
6022
6023static int __init pci_resource_alignment_sysfs_init(void)
6024{
6025 return bus_create_file(&pci_bus_type,
6026 &bus_attr_resource_alignment);
6027}
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006028late_initcall(pci_resource_alignment_sysfs_init);
6029
Bill Pemberton15856ad2012-11-21 15:35:00 -05006030static void pci_no_domains(void)
Jeff Garzik32a2eea2007-10-11 16:57:27 -04006031{
6032#ifdef CONFIG_PCI_DOMAINS
6033 pci_domains_supported = 0;
6034#endif
6035}
6036
Jan Kiszkaae07b782018-05-15 11:07:00 +02006037#ifdef CONFIG_PCI_DOMAINS_GENERIC
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006038static atomic_t __domain_nr = ATOMIC_INIT(-1);
6039
Jan Kiszkaae07b782018-05-15 11:07:00 +02006040static int pci_get_new_domain_nr(void)
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006041{
6042 return atomic_inc_return(&__domain_nr);
6043}
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006044
Tomasz Nowicki1a4f93f2016-06-10 21:55:15 +02006045static int of_pci_bus_find_domain_nr(struct device *parent)
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006046{
6047 static int use_dt_domains = -1;
Krzysztof =?utf-8?Q?Ha=C5=82asa?=54c6e2d2016-03-01 07:07:18 +01006048 int domain = -1;
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006049
Krzysztof =?utf-8?Q?Ha=C5=82asa?=54c6e2d2016-03-01 07:07:18 +01006050 if (parent)
6051 domain = of_get_pci_domain_nr(parent->of_node);
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006052 /*
6053 * Check DT domain and use_dt_domains values.
6054 *
6055 * If DT domain property is valid (domain >= 0) and
6056 * use_dt_domains != 0, the DT assignment is valid since this means
6057 * we have not previously allocated a domain number by using
6058 * pci_get_new_domain_nr(); we should also update use_dt_domains to
6059 * 1, to indicate that we have just assigned a domain number from
6060 * DT.
6061 *
6062 * If DT domain property value is not valid (ie domain < 0), and we
6063 * have not previously assigned a domain number from DT
6064 * (use_dt_domains != 1) we should assign a domain number by
6065 * using the:
6066 *
6067 * pci_get_new_domain_nr()
6068 *
6069 * API and update the use_dt_domains value to keep track of method we
6070 * are using to assign domain numbers (use_dt_domains = 0).
6071 *
6072 * All other combinations imply we have a platform that is trying
6073 * to mix domain numbers obtained from DT and pci_get_new_domain_nr(),
6074 * which is a recipe for domain mishandling and it is prevented by
6075 * invalidating the domain value (domain = -1) and printing a
6076 * corresponding error.
6077 */
6078 if (domain >= 0 && use_dt_domains) {
6079 use_dt_domains = 1;
6080 } else if (domain < 0 && use_dt_domains != 1) {
6081 use_dt_domains = 0;
6082 domain = pci_get_new_domain_nr();
6083 } else {
Shawn Lin9df1c6e2018-03-01 09:26:55 +08006084 if (parent)
6085 pr_err("Node %pOF has ", parent->of_node);
6086 pr_err("Inconsistent \"linux,pci-domain\" property in DT\n");
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006087 domain = -1;
6088 }
6089
Tomasz Nowicki9c7cb892016-06-10 21:55:14 +02006090 return domain;
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006091}
Tomasz Nowicki1a4f93f2016-06-10 21:55:15 +02006092
6093int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent)
6094{
Tomasz Nowicki2ab51dd2016-06-10 15:36:26 -05006095 return acpi_disabled ? of_pci_bus_find_domain_nr(parent) :
6096 acpi_pci_bus_find_domain_nr(bus);
Lorenzo Pieralisi7c674702014-12-27 18:19:12 -07006097}
6098#endif
Liviu Dudau41e5c0f2014-09-29 15:29:27 +01006099
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006100/**
Taku Izumi642c92d2012-10-30 15:26:18 +09006101 * pci_ext_cfg_avail - can we access extended PCI config space?
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006102 *
6103 * Returns 1 if we can access PCI extended config space (offsets
6104 * greater than 0xff). This is the default implementation. Architecture
6105 * implementations can override this.
6106 */
Taku Izumi642c92d2012-10-30 15:26:18 +09006107int __weak pci_ext_cfg_avail(void)
Andrew Patterson0ef5f8f2008-11-10 15:30:50 -07006108{
6109 return 1;
6110}
6111
Benjamin Herrenschmidt2d1c8612009-12-09 17:52:13 +11006112void __weak pci_fixup_cardbus(struct pci_bus *bus)
6113{
6114}
6115EXPORT_SYMBOL(pci_fixup_cardbus);
6116
Al Viroad04d312008-11-22 17:37:14 +00006117static int __init pci_setup(char *str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07006118{
6119 while (str) {
6120 char *k = strchr(str, ',');
6121 if (k)
6122 *k++ = 0;
6123 if (*str && (str = pcibios_setup(str)) && *str) {
Matthew Wilcox309e57d2006-03-05 22:33:34 -07006124 if (!strcmp(str, "nomsi")) {
6125 pci_no_msi();
Gil Kupfercef74402018-05-10 17:56:02 -05006126 } else if (!strncmp(str, "noats", 5)) {
6127 pr_info("PCIe: ATS is disabled\n");
6128 pcie_ats_disabled = true;
Randy Dunlap7f785762007-10-05 13:17:58 -07006129 } else if (!strcmp(str, "noaer")) {
6130 pci_no_aer();
Sinan Kaya11eb0e02018-06-04 22:16:09 -04006131 } else if (!strcmp(str, "earlydump")) {
6132 pci_early_dump = true;
Yinghai Lub55438f2012-02-23 19:23:30 -08006133 } else if (!strncmp(str, "realloc=", 8)) {
6134 pci_realloc_get_opt(str + 8);
Ram Paif483d392011-07-07 11:19:10 -07006135 } else if (!strncmp(str, "realloc", 7)) {
Yinghai Lub55438f2012-02-23 19:23:30 -08006136 pci_realloc_get_opt("on");
Jeff Garzik32a2eea2007-10-11 16:57:27 -04006137 } else if (!strcmp(str, "nodomains")) {
6138 pci_no_domains();
Rafael J. Wysocki6748dcc2012-03-01 00:06:33 +01006139 } else if (!strncmp(str, "noari", 5)) {
6140 pcie_ari_disabled = true;
Atsushi Nemoto4516a612007-02-05 16:36:06 -08006141 } else if (!strncmp(str, "cbiosize=", 9)) {
6142 pci_cardbus_io_size = memparse(str + 9, &str);
6143 } else if (!strncmp(str, "cbmemsize=", 10)) {
6144 pci_cardbus_mem_size = memparse(str + 10, &str);
Yuji Shimada32a9a6822009-03-16 17:13:39 +09006145 } else if (!strncmp(str, "resource_alignment=", 19)) {
6146 pci_set_resource_alignment_param(str + 19,
6147 strlen(str + 19));
Andrew Patterson43c16402009-04-22 16:52:09 -06006148 } else if (!strncmp(str, "ecrc=", 5)) {
6149 pcie_ecrc_get_policy(str + 5);
Eric W. Biederman28760482009-09-09 14:09:24 -07006150 } else if (!strncmp(str, "hpiosize=", 9)) {
6151 pci_hotplug_io_size = memparse(str + 9, &str);
6152 } else if (!strncmp(str, "hpmemsize=", 10)) {
6153 pci_hotplug_mem_size = memparse(str + 10, &str);
Keith Busche16b4662016-07-21 21:40:28 -06006154 } else if (!strncmp(str, "hpbussize=", 10)) {
6155 pci_hotplug_bus_size =
6156 simple_strtoul(str + 10, &str, 0);
6157 if (pci_hotplug_bus_size > 0xff)
6158 pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
Jon Mason5f39e672011-10-03 09:50:20 -05006159 } else if (!strncmp(str, "pcie_bus_tune_off", 17)) {
6160 pcie_bus_config = PCIE_BUS_TUNE_OFF;
Jon Masonb03e7492011-07-20 15:20:54 -05006161 } else if (!strncmp(str, "pcie_bus_safe", 13)) {
6162 pcie_bus_config = PCIE_BUS_SAFE;
6163 } else if (!strncmp(str, "pcie_bus_perf", 13)) {
6164 pcie_bus_config = PCIE_BUS_PERFORMANCE;
Jon Mason5f39e672011-10-03 09:50:20 -05006165 } else if (!strncmp(str, "pcie_bus_peer2peer", 18)) {
6166 pcie_bus_config = PCIE_BUS_PEER2PEER;
Bjorn Helgaas284f5f92012-04-30 15:21:02 -06006167 } else if (!strncmp(str, "pcie_scan_all", 13)) {
6168 pci_add_flags(PCI_SCAN_ALL_PCIE_DEVS);
Logan Gunthorpeaaca43f2018-07-30 10:18:40 -06006169 } else if (!strncmp(str, "disable_acs_redir=", 18)) {
6170 disable_acs_redir_param = str + 18;
Matthew Wilcox309e57d2006-03-05 22:33:34 -07006171 } else {
6172 printk(KERN_ERR "PCI: Unknown option `%s'\n",
6173 str);
6174 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07006175 }
6176 str = k;
6177 }
Andi Kleen0637a702006-09-26 10:52:41 +02006178 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07006179}
Andi Kleen0637a702006-09-26 10:52:41 +02006180early_param("pci", pci_setup);