blob: 68678ed76b0da93114280ae2ec878457159f63c5 [file] [log] [blame]
Zhao, Yu557848c2008-10-13 19:18:07 +08001#ifndef DRIVERS_PCI_H
2#define DRIVERS_PCI_H
3
Yu Zhao74bb1bc2009-03-20 11:25:16 +08004#include <linux/workqueue.h>
5
Zhao, Yu557848c2008-10-13 19:18:07 +08006#define PCI_CFG_SPACE_SIZE 256
7#define PCI_CFG_SPACE_EXP_SIZE 4096
8
Linus Torvalds1da177e2005-04-16 15:20:36 -07009/* Functions internal to the PCI core code */
10
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060011int pci_create_sysfs_dev_files(struct pci_dev *pdev);
12void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053013#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050014static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050015{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050016static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050017{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050018#else
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060019void pci_create_firmware_label_files(struct pci_dev *pdev);
20void pci_remove_firmware_label_files(struct pci_dev *pdev);
Narendra K911e1c92010-07-26 05:56:50 -050021#endif
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060022void pci_cleanup_rom(struct pci_dev *dev);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070023#ifdef HAVE_PCI_MMAP
Martin Wilck3b519e42010-11-10 11:03:21 +010024enum pci_mmap_api {
25 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
26 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
27};
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060028int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
29 enum pci_mmap_api mmap_api);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070030#endif
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030031int pci_probe_reset_function(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050032
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020033/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080034 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020035 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080036 * @is_manageable: returns 'true' if given device is power manageable by the
37 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020038 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080039 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020040 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080041 * @choose_state: returns PCI power state of given device preferred by the
42 * platform; to be used during system-wide transitions from a
43 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020044 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080045 * @sleep_wake: enables/disables the system wake up capability of given device
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020046 *
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010047 * @run_wake: enables/disables the platform to generate run-time wake-up events
48 * for given device (the device's wake-up capability has to be
49 * enabled by @sleep_wake for this feature to work)
50 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020051 * If given platform is generally capable of power managing PCI devices, all of
52 * these callbacks are mandatory.
53 */
54struct pci_platform_pm_ops {
55 bool (*is_manageable)(struct pci_dev *dev);
56 int (*set_state)(struct pci_dev *dev, pci_power_t state);
57 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020058 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010059 int (*run_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020060};
61
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060062int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
63void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
64void pci_power_up(struct pci_dev *dev);
65void pci_disable_enabled_device(struct pci_dev *dev);
66int pci_finish_runtime_suspend(struct pci_dev *dev);
67int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
68void pci_wakeup_bus(struct pci_bus *bus);
69void pci_config_pm_runtime_get(struct pci_dev *dev);
70void pci_config_pm_runtime_put(struct pci_dev *dev);
71void pci_pm_init(struct pci_dev *dev);
72void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -080073void pci_free_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010074
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +010075static inline void pci_wakeup_event(struct pci_dev *dev)
76{
77 /* Wait 100 ms before the system can be put into a sleep state. */
78 pm_wakeup_event(&dev->dev, 100);
79}
80
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010081static inline bool pci_is_bridge(struct pci_dev *pci_dev)
82{
83 return !!(pci_dev->subordinate);
84}
David Shaohua Li0f644742005-03-19 00:15:48 -050085
Ben Hutchings94e61082008-03-05 16:52:39 +000086struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080087 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
88 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000089 void (*release)(struct pci_dev *dev);
90};
91
92struct pci_vpd {
Benjamin Li99cb233d2008-07-02 10:59:04 -070093 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -080094 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +000095 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
96};
97
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060098int pci_vpd_pci22_init(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +000099static inline void pci_vpd_release(struct pci_dev *dev)
100{
101 if (dev->vpd)
102 dev->vpd->ops->release(dev);
103}
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105/* PCI /proc functions */
106#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600107int pci_proc_attach_device(struct pci_dev *dev);
108int pci_proc_detach_device(struct pci_dev *dev);
109int pci_proc_detach_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#else
111static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
112static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
114#endif
115
116/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600117int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000119#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600120void pci_create_legacy_files(struct pci_bus *bus);
121void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000122#else
123static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
124static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
125#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800128extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100130extern raw_spinlock_t pci_lock;
131
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700132extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100133
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700134#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700135void pci_no_msi(void);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600136void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700137#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700138static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000139static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700140#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100141
Yinghai Lub55438f2012-02-23 19:23:30 -0800142void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700143
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700144static inline int pci_no_d1d2(struct pci_dev *dev)
145{
146 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700147
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700148 if (dev->bus->self)
149 parent_dstates = dev->bus->self->no_d1d2;
150 return (dev->no_d1d2 || parent_dstates);
151
152}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153extern struct device_attribute pci_dev_attrs[];
Yinghai Lub9d320f2011-05-12 17:11:39 -0700154extern struct device_attribute pcibus_dev_attrs[];
Yinghai Lu4e15c462012-11-05 15:20:34 -0500155extern struct device_type pci_dev_type;
Alex Chiang705b1aa2009-03-20 14:56:31 -0600156extern struct bus_attribute pci_bus_attrs[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159/**
160 * pci_match_one_device - Tell if a PCI device structure has a matching
161 * PCI device id structure
162 * @id: single PCI device id structure to match
163 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800164 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 * Returns the matching pci_device_id structure or %NULL if there is no match.
166 */
167static inline const struct pci_device_id *
168pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
169{
170 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
171 (id->device == PCI_ANY_ID || id->device == dev->device) &&
172 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
173 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
174 !((id->class ^ dev->class) & id->class_mask))
175 return id;
176 return NULL;
177}
178
Alex Chiangf46753c2008-06-10 15:28:50 -0600179/* PCI slot sysfs helper code */
180#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
181
182extern struct kset *pci_slots_kset;
183
184struct pci_slot_attribute {
185 struct attribute attr;
186 ssize_t (*show)(struct pci_slot *, char *);
187 ssize_t (*store)(struct pci_slot *, const char *, size_t);
188};
189#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
190
Yu Zhao0b400c72008-11-22 02:40:40 +0800191enum pci_bar_type {
192 pci_bar_unknown, /* Standard PCI BAR probe */
193 pci_bar_io, /* An io port BAR */
194 pci_bar_mem32, /* A 32-bit memory BAR */
195 pci_bar_mem64, /* A 64-bit memory BAR */
196};
197
Yinghai Luefdc87d2012-01-27 10:55:10 -0800198bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
199 int crs_timeout);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600200int pci_setup_device(struct pci_dev *dev);
201int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
202 struct resource *res, unsigned int reg);
203int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
204void pci_configure_ari(struct pci_dev *dev);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700205
Yu Zhao58c3a722008-10-14 14:02:53 +0800206/**
207 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800208 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800209 *
210 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
211 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800212static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800213{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800214 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800215}
216
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800217void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600218void pci_disable_bridge_window(struct pci_dev *dev);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900219
Yu Zhaod1b054d2009-03-20 11:25:11 +0800220/* Single Root I/O Virtualization */
221struct pci_sriov {
222 int pos; /* capability position */
223 int nres; /* number of resources */
224 u32 cap; /* SR-IOV Capabilities */
225 u16 ctrl; /* SR-IOV Control */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700226 u16 total_VFs; /* total VFs associated with the PF */
227 u16 initial_VFs; /* initial VFs associated with the PF */
228 u16 num_VFs; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800229 u16 offset; /* first VF Routing ID offset */
230 u16 stride; /* following VF stride */
231 u32 pgsz; /* page size for BAR alignment */
232 u8 link; /* Function Dependency Link */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700233 u16 driver_max_VFs; /* max num VFs driver supports */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800234 struct pci_dev *dev; /* lowest numbered PF */
235 struct pci_dev *self; /* this PF */
236 struct mutex lock; /* lock for VF bus */
Yu Zhao74bb1bc2009-03-20 11:25:16 +0800237 struct work_struct mtask; /* VF Migration task */
238 u8 __iomem *mstate; /* VF Migration State Array */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800239};
240
Hao, Xudong1900ca12011-12-17 21:24:40 +0800241#ifdef CONFIG_PCI_ATS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600242void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800243#else
244static inline void pci_restore_ats_state(struct pci_dev *dev)
245{
246}
247#endif /* CONFIG_PCI_ATS */
248
Yu Zhaod1b054d2009-03-20 11:25:11 +0800249#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600250int pci_iov_init(struct pci_dev *dev);
251void pci_iov_release(struct pci_dev *dev);
252int pci_iov_resource_bar(struct pci_dev *dev, int resno,
253 enum pci_bar_type *type);
254resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
255void pci_restore_iov_state(struct pci_dev *dev);
256int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhao302b4212009-05-18 13:51:32 +0800257
Yu Zhaod1b054d2009-03-20 11:25:11 +0800258#else
259static inline int pci_iov_init(struct pci_dev *dev)
260{
261 return -ENODEV;
262}
263static inline void pci_iov_release(struct pci_dev *dev)
264
265{
266}
267static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
268 enum pci_bar_type *type)
269{
270 return 0;
271}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800272static inline void pci_restore_iov_state(struct pci_dev *dev)
273{
274}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800275static inline int pci_iov_bus_range(struct pci_bus *bus)
276{
277 return 0;
278}
Yu Zhao302b4212009-05-18 13:51:32 +0800279
Yu Zhaod1b054d2009-03-20 11:25:11 +0800280#endif /* CONFIG_PCI_IOV */
281
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600282unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700283
Cam Macdonell0e522472010-09-07 17:25:20 -0700284static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600285 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700286{
287#ifdef CONFIG_PCI_IOV
288 int resno = res - dev->resource;
289
290 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
291 return pci_sriov_resource_alignment(dev, resno);
292#endif
Ram Pai0a2daa12011-07-25 13:08:41 -0700293 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
294 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700295 return resource_alignment(res);
296}
297
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600298void pci_enable_acs(struct pci_dev *dev);
Allen Kayae21ee62009-10-07 10:27:17 -0700299
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800300struct pci_dev_reset_methods {
301 u16 vendor;
302 u16 device;
303 int (*reset)(struct pci_dev *dev, int probe);
304};
305
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100306#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600307int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100308#else
309static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
310{
311 return -ENOTTY;
312}
313#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800314
Zhao, Yu557848c2008-10-13 19:18:07 +0800315#endif /* DRIVERS_PCI_H */