blob: 4df38df224f4d3e61f53a5519ad55d9b2053a567 [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
Jacob Keller343e51a2013-07-31 06:53:16 +00009extern const unsigned char pcie_link_speed[];
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011/* Functions internal to the PCI core code */
12
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060013int pci_create_sysfs_dev_files(struct pci_dev *pdev);
14void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053015#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050016static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050017{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050018static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050019{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050020#else
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060021void pci_create_firmware_label_files(struct pci_dev *pdev);
22void pci_remove_firmware_label_files(struct pci_dev *pdev);
Narendra K911e1c92010-07-26 05:56:50 -050023#endif
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060024void pci_cleanup_rom(struct pci_dev *dev);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070025#ifdef HAVE_PCI_MMAP
Martin Wilck3b519e42010-11-10 11:03:21 +010026enum pci_mmap_api {
27 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
28 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
29};
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060030int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
31 enum pci_mmap_api mmap_api);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070032#endif
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030033int pci_probe_reset_function(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050034
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020035/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080036 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020037 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080038 * @is_manageable: returns 'true' if given device is power manageable by the
39 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020040 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080041 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020042 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080043 * @choose_state: returns PCI power state of given device preferred by the
44 * platform; to be used during system-wide transitions from a
45 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020046 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080047 * @sleep_wake: enables/disables the system wake up capability of given device
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020048 *
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010049 * @run_wake: enables/disables the platform to generate run-time wake-up events
50 * for given device (the device's wake-up capability has to be
51 * enabled by @sleep_wake for this feature to work)
52 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020053 * If given platform is generally capable of power managing PCI devices, all of
54 * these callbacks are mandatory.
55 */
56struct pci_platform_pm_ops {
57 bool (*is_manageable)(struct pci_dev *dev);
58 int (*set_state)(struct pci_dev *dev, pci_power_t state);
59 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020060 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010061 int (*run_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020062};
63
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060064int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
65void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
66void pci_power_up(struct pci_dev *dev);
67void pci_disable_enabled_device(struct pci_dev *dev);
68int pci_finish_runtime_suspend(struct pci_dev *dev);
69int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060070void pci_config_pm_runtime_get(struct pci_dev *dev);
71void pci_config_pm_runtime_put(struct pci_dev *dev);
72void pci_pm_init(struct pci_dev *dev);
73void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -080074void pci_free_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010075
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +010076static inline void pci_wakeup_event(struct pci_dev *dev)
77{
78 /* Wait 100 ms before the system can be put into a sleep state. */
79 pm_wakeup_event(&dev->dev, 100);
80}
81
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010082static inline bool pci_is_bridge(struct pci_dev *pci_dev)
83{
84 return !!(pci_dev->subordinate);
85}
David Shaohua Li0f644742005-03-19 00:15:48 -050086
Ben Hutchings94e61082008-03-05 16:52:39 +000087struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080088 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
89 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000090 void (*release)(struct pci_dev *dev);
91};
92
93struct pci_vpd {
Benjamin Li99cb233d2008-07-02 10:59:04 -070094 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -080095 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +000096 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
97};
98
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060099int pci_vpd_pci22_init(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +0000100static inline void pci_vpd_release(struct pci_dev *dev)
101{
102 if (dev->vpd)
103 dev->vpd->ops->release(dev);
104}
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106/* PCI /proc functions */
107#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600108int pci_proc_attach_device(struct pci_dev *dev);
109int pci_proc_detach_device(struct pci_dev *dev);
110int pci_proc_detach_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#else
112static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
113static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
115#endif
116
117/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600118int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000120#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600121void pci_create_legacy_files(struct pci_bus *bus);
122void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000123#else
124static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
125static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
126#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800129extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100131extern raw_spinlock_t pci_lock;
132
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700133extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100134
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700135#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700136void pci_no_msi(void);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600137void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700138#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700139static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000140static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700141#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100142
Yinghai Lub55438f2012-02-23 19:23:30 -0800143void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700144
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700145static inline int pci_no_d1d2(struct pci_dev *dev)
146{
147 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700148
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700149 if (dev->bus->self)
150 parent_dstates = dev->bus->self->no_d1d2;
151 return (dev->no_d1d2 || parent_dstates);
152
153}
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -0700154extern const struct attribute_group *pci_dev_groups[];
Greg Kroah-Hartman56039e62013-07-24 15:05:17 -0700155extern const struct attribute_group *pcibus_groups[];
Yinghai Lu4e15c462012-11-05 15:20:34 -0500156extern struct device_type pci_dev_type;
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -0600157extern const struct attribute_group *pci_bus_groups[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160/**
161 * pci_match_one_device - Tell if a PCI device structure has a matching
162 * PCI device id structure
163 * @id: single PCI device id structure to match
164 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800165 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 * Returns the matching pci_device_id structure or %NULL if there is no match.
167 */
168static inline const struct pci_device_id *
169pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
170{
171 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
172 (id->device == PCI_ANY_ID || id->device == dev->device) &&
173 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
174 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
175 !((id->class ^ dev->class) & id->class_mask))
176 return id;
177 return NULL;
178}
179
Alex Chiangf46753c2008-06-10 15:28:50 -0600180/* PCI slot sysfs helper code */
181#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
182
183extern struct kset *pci_slots_kset;
184
185struct pci_slot_attribute {
186 struct attribute attr;
187 ssize_t (*show)(struct pci_slot *, char *);
188 ssize_t (*store)(struct pci_slot *, const char *, size_t);
189};
190#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
191
Yu Zhao0b400c72008-11-22 02:40:40 +0800192enum pci_bar_type {
193 pci_bar_unknown, /* Standard PCI BAR probe */
194 pci_bar_io, /* An io port BAR */
195 pci_bar_mem32, /* A 32-bit memory BAR */
196 pci_bar_mem64, /* A 64-bit memory BAR */
197};
198
Yinghai Luefdc87d2012-01-27 10:55:10 -0800199bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
200 int crs_timeout);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600201int pci_setup_device(struct pci_dev *dev);
202int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
203 struct resource *res, unsigned int reg);
204int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
205void pci_configure_ari(struct pci_dev *dev);
Jiang Liud66ecb72013-06-23 01:01:35 +0200206void __ref __pci_bus_size_bridges(struct pci_bus *bus,
207 struct list_head *realloc_head);
208void __ref __pci_bus_assign_resources(const struct pci_bus *bus,
209 struct list_head *realloc_head,
210 struct list_head *fail_head);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700211
Yu Zhao58c3a722008-10-14 14:02:53 +0800212/**
213 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800214 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800215 *
216 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
217 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800218static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800219{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800220 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800221}
222
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800223void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600224void pci_disable_bridge_window(struct pci_dev *dev);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900225
Yu Zhaod1b054d2009-03-20 11:25:11 +0800226/* Single Root I/O Virtualization */
227struct pci_sriov {
228 int pos; /* capability position */
229 int nres; /* number of resources */
230 u32 cap; /* SR-IOV Capabilities */
231 u16 ctrl; /* SR-IOV Control */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700232 u16 total_VFs; /* total VFs associated with the PF */
233 u16 initial_VFs; /* initial VFs associated with the PF */
234 u16 num_VFs; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800235 u16 offset; /* first VF Routing ID offset */
236 u16 stride; /* following VF stride */
237 u32 pgsz; /* page size for BAR alignment */
238 u8 link; /* Function Dependency Link */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700239 u16 driver_max_VFs; /* max num VFs driver supports */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800240 struct pci_dev *dev; /* lowest numbered PF */
241 struct pci_dev *self; /* this PF */
242 struct mutex lock; /* lock for VF bus */
Yu Zhao74bb1bc2009-03-20 11:25:16 +0800243 struct work_struct mtask; /* VF Migration task */
244 u8 __iomem *mstate; /* VF Migration State Array */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800245};
246
Hao, Xudong1900ca12011-12-17 21:24:40 +0800247#ifdef CONFIG_PCI_ATS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600248void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800249#else
250static inline void pci_restore_ats_state(struct pci_dev *dev)
251{
252}
253#endif /* CONFIG_PCI_ATS */
254
Yu Zhaod1b054d2009-03-20 11:25:11 +0800255#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600256int pci_iov_init(struct pci_dev *dev);
257void pci_iov_release(struct pci_dev *dev);
258int pci_iov_resource_bar(struct pci_dev *dev, int resno,
259 enum pci_bar_type *type);
260resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
261void pci_restore_iov_state(struct pci_dev *dev);
262int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhao302b4212009-05-18 13:51:32 +0800263
Yu Zhaod1b054d2009-03-20 11:25:11 +0800264#else
265static inline int pci_iov_init(struct pci_dev *dev)
266{
267 return -ENODEV;
268}
269static inline void pci_iov_release(struct pci_dev *dev)
270
271{
272}
273static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
274 enum pci_bar_type *type)
275{
276 return 0;
277}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800278static inline void pci_restore_iov_state(struct pci_dev *dev)
279{
280}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800281static inline int pci_iov_bus_range(struct pci_bus *bus)
282{
283 return 0;
284}
Yu Zhao302b4212009-05-18 13:51:32 +0800285
Yu Zhaod1b054d2009-03-20 11:25:11 +0800286#endif /* CONFIG_PCI_IOV */
287
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600288unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700289
Cam Macdonell0e522472010-09-07 17:25:20 -0700290static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600291 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700292{
293#ifdef CONFIG_PCI_IOV
294 int resno = res - dev->resource;
295
296 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
297 return pci_sriov_resource_alignment(dev, resno);
298#endif
Ram Pai0a2daa12011-07-25 13:08:41 -0700299 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
300 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700301 return resource_alignment(res);
302}
303
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600304void pci_enable_acs(struct pci_dev *dev);
Allen Kayae21ee62009-10-07 10:27:17 -0700305
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800306struct pci_dev_reset_methods {
307 u16 vendor;
308 u16 device;
309 int (*reset)(struct pci_dev *dev, int probe);
310};
311
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100312#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600313int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100314#else
315static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
316{
317 return -ENOTTY;
318}
319#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800320
Zhao, Yu557848c2008-10-13 19:18:07 +0800321#endif /* DRIVERS_PCI_H */