blob: e4943479b234d1f4ff6fc5121a28dbb322fa2ba6 [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
Kay Sievers7eff2e72007-08-14 15:15:12 +020011extern int pci_uevent(struct device *dev, struct kobj_uevent_env *env);
Linus Torvalds1da177e2005-04-16 15:20:36 -070012extern int pci_create_sysfs_dev_files(struct pci_dev *pdev);
13extern void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053014#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050015static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050016{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050017static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050018{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050019#else
20extern void pci_create_firmware_label_files(struct pci_dev *pdev);
21extern void pci_remove_firmware_label_files(struct pci_dev *pdev);
22#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070023extern void pci_cleanup_rom(struct pci_dev *dev);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070024#ifdef HAVE_PCI_MMAP
Martin Wilck3b519e42010-11-10 11:03:21 +010025enum pci_mmap_api {
26 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
27 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
28};
Jesse Barnes9eff02e2008-10-24 10:32:33 -070029extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
Martin Wilck3b519e42010-11-10 11:03:21 +010030 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 * @can_wakeup: returns 'true' if given device is capable of waking up the
48 * system from a sleeping state
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020049 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080050 * @sleep_wake: enables/disables the system wake up capability of given device
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020051 *
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010052 * @run_wake: enables/disables the platform to generate run-time wake-up events
53 * for given device (the device's wake-up capability has to be
54 * enabled by @sleep_wake for this feature to work)
55 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020056 * If given platform is generally capable of power managing PCI devices, all of
57 * these callbacks are mandatory.
58 */
59struct pci_platform_pm_ops {
60 bool (*is_manageable)(struct pci_dev *dev);
61 int (*set_state)(struct pci_dev *dev, pci_power_t state);
62 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020063 bool (*can_wakeup)(struct pci_dev *dev);
64 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010065 int (*run_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020066};
67
68extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
Rafael J. Wysocki73410422009-01-07 13:07:15 +010069extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
Rafael J. Wysockifa58d302009-01-07 13:03:42 +010070extern void pci_disable_enabled_device(struct pci_dev *dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +010071extern int pci_finish_runtime_suspend(struct pci_dev *dev);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010072extern int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020073extern void pci_pm_init(struct pci_dev *dev);
Jesse Barneseb9c39d2008-12-17 12:10:05 -080074extern void platform_pci_wakeup_init(struct pci_dev *dev);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +010075extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -080076void pci_free_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010077
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +010078static inline void pci_wakeup_event(struct pci_dev *dev)
79{
80 /* Wait 100 ms before the system can be put into a sleep state. */
81 pm_wakeup_event(&dev->dev, 100);
82}
83
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010084static inline bool pci_is_bridge(struct pci_dev *pci_dev)
85{
86 return !!(pci_dev->subordinate);
87}
David Shaohua Li0f644742005-03-19 00:15:48 -050088
Brian Kinge04b0ea2005-09-27 01:21:55 -070089extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
90extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
91extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
92extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
93extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
94extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
95
Ben Hutchings94e61082008-03-05 16:52:39 +000096struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080097 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
98 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000099 void (*release)(struct pci_dev *dev);
100};
101
102struct pci_vpd {
Benjamin Li99cb2332008-07-02 10:59:04 -0700103 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -0800104 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +0000105 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
106};
107
108extern int pci_vpd_pci22_init(struct pci_dev *dev);
109static inline void pci_vpd_release(struct pci_dev *dev)
110{
111 if (dev->vpd)
112 dev->vpd->ops->release(dev);
113}
114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115/* PCI /proc functions */
116#ifdef CONFIG_PROC_FS
117extern int pci_proc_attach_device(struct pci_dev *dev);
118extern int pci_proc_detach_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119extern int pci_proc_detach_bus(struct pci_bus *bus);
120#else
121static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
122static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
124#endif
125
126/* Functions for PCI Hotplug drivers to use */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000129#ifdef HAVE_PCI_LEGACY
130extern void pci_create_legacy_files(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131extern void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000132#else
133static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
134static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
135#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800138extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100140extern raw_spinlock_t pci_lock;
141
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700142extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100143
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700144#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700145void pci_no_msi(void);
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000146extern void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700147#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700148static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000149static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700150#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100151
Yinghai Lub55438f2012-02-23 19:23:30 -0800152void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700153
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700154static inline int pci_no_d1d2(struct pci_dev *dev)
155{
156 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700157
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700158 if (dev->bus->self)
159 parent_dstates = dev->bus->self->no_d1d2;
160 return (dev->no_d1d2 || parent_dstates);
161
162}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163extern struct device_attribute pci_dev_attrs[];
Yinghai Lub9d320f2011-05-12 17:11:39 -0700164extern struct device_attribute pcibus_dev_attrs[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600165#ifdef CONFIG_HOTPLUG
166extern struct bus_attribute pci_bus_attrs[];
167#else
168#define pci_bus_attrs NULL
169#endif
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172/**
173 * pci_match_one_device - Tell if a PCI device structure has a matching
174 * PCI device id structure
175 * @id: single PCI device id structure to match
176 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800177 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * Returns the matching pci_device_id structure or %NULL if there is no match.
179 */
180static inline const struct pci_device_id *
181pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
182{
183 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
184 (id->device == PCI_ANY_ID || id->device == dev->device) &&
185 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
186 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
187 !((id->class ^ dev->class) & id->class_mask))
188 return id;
189 return NULL;
190}
191
Alex Chiangf46753c2008-06-10 15:28:50 -0600192/* PCI slot sysfs helper code */
193#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
194
195extern struct kset *pci_slots_kset;
196
197struct pci_slot_attribute {
198 struct attribute attr;
199 ssize_t (*show)(struct pci_slot *, char *);
200 ssize_t (*store)(struct pci_slot *, const char *, size_t);
201};
202#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
203
Yu Zhao0b400c72008-11-22 02:40:40 +0800204enum pci_bar_type {
205 pci_bar_unknown, /* Standard PCI BAR probe */
206 pci_bar_io, /* An io port BAR */
207 pci_bar_mem32, /* A 32-bit memory BAR */
208 pci_bar_mem64, /* A 64-bit memory BAR */
209};
210
Yinghai Luefdc87d2012-01-27 10:55:10 -0800211bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
212 int crs_timeout);
Yu Zhao480b93b2009-03-20 11:25:14 +0800213extern int pci_setup_device(struct pci_dev *dev);
Yu Zhao0b400c72008-11-22 02:40:40 +0800214extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
215 struct resource *res, unsigned int reg);
Yu Zhao613e7ed2008-11-22 02:41:27 +0800216extern int pci_resource_bar(struct pci_dev *dev, int resno,
217 enum pci_bar_type *type);
Yu Zhao876e5012008-11-22 02:42:35 +0800218extern int pci_bus_add_child(struct pci_bus *bus);
Yu Zhao58c3a722008-10-14 14:02:53 +0800219extern void pci_enable_ari(struct pci_dev *dev);
220/**
221 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800222 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800223 *
224 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
225 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800226static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800227{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800228 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800229}
230
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800231void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Yuji Shimada32a9a682009-03-16 17:13:39 +0900232extern void pci_disable_bridge_window(struct pci_dev *dev);
Yuji Shimada32a9a682009-03-16 17:13:39 +0900233
Yu Zhaod1b054d2009-03-20 11:25:11 +0800234/* Single Root I/O Virtualization */
235struct pci_sriov {
236 int pos; /* capability position */
237 int nres; /* number of resources */
238 u32 cap; /* SR-IOV Capabilities */
239 u16 ctrl; /* SR-IOV Control */
240 u16 total; /* total VFs associated with the PF */
Yu Zhaodd7cc442009-03-20 11:25:15 +0800241 u16 initial; /* initial VFs associated with the PF */
242 u16 nr_virtfn; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800243 u16 offset; /* first VF Routing ID offset */
244 u16 stride; /* following VF stride */
245 u32 pgsz; /* page size for BAR alignment */
246 u8 link; /* Function Dependency Link */
247 struct pci_dev *dev; /* lowest numbered PF */
248 struct pci_dev *self; /* this PF */
249 struct mutex lock; /* lock for VF bus */
Yu Zhao74bb1bc2009-03-20 11:25:16 +0800250 struct work_struct mtask; /* VF Migration task */
251 u8 __iomem *mstate; /* VF Migration State Array */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800252};
253
Hao, Xudong1900ca12011-12-17 21:24:40 +0800254#ifdef CONFIG_PCI_ATS
255extern void pci_restore_ats_state(struct pci_dev *dev);
256#else
257static inline void pci_restore_ats_state(struct pci_dev *dev)
258{
259}
260#endif /* CONFIG_PCI_ATS */
261
Yu Zhaod1b054d2009-03-20 11:25:11 +0800262#ifdef CONFIG_PCI_IOV
263extern int pci_iov_init(struct pci_dev *dev);
264extern void pci_iov_release(struct pci_dev *dev);
265extern int pci_iov_resource_bar(struct pci_dev *dev, int resno,
266 enum pci_bar_type *type);
Cam Macdonell0e522472010-09-07 17:25:20 -0700267extern resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev,
268 int resno);
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800269extern void pci_restore_iov_state(struct pci_dev *dev);
Yu Zhaoa28724b2009-03-20 11:25:13 +0800270extern int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhao302b4212009-05-18 13:51:32 +0800271
Yu Zhaod1b054d2009-03-20 11:25:11 +0800272#else
273static inline int pci_iov_init(struct pci_dev *dev)
274{
275 return -ENODEV;
276}
277static inline void pci_iov_release(struct pci_dev *dev)
278
279{
280}
281static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
282 enum pci_bar_type *type)
283{
284 return 0;
285}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800286static inline void pci_restore_iov_state(struct pci_dev *dev)
287{
288}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800289static inline int pci_iov_bus_range(struct pci_bus *bus)
290{
291 return 0;
292}
Yu Zhao302b4212009-05-18 13:51:32 +0800293
Yu Zhaod1b054d2009-03-20 11:25:11 +0800294#endif /* CONFIG_PCI_IOV */
295
Ram Pai0a2daa12011-07-25 13:08:41 -0700296extern unsigned long pci_cardbus_resource_alignment(struct resource *);
297
Cam Macdonell0e522472010-09-07 17:25:20 -0700298static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Chris Wright6faf17f2009-08-28 13:00:06 -0700299 struct resource *res)
300{
301#ifdef CONFIG_PCI_IOV
302 int resno = res - dev->resource;
303
304 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
305 return pci_sriov_resource_alignment(dev, resno);
306#endif
Ram Pai0a2daa12011-07-25 13:08:41 -0700307 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
308 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700309 return resource_alignment(res);
310}
311
Allen Kayae21ee62009-10-07 10:27:17 -0700312extern void pci_enable_acs(struct pci_dev *dev);
313
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800314struct pci_dev_reset_methods {
315 u16 vendor;
316 u16 device;
317 int (*reset)(struct pci_dev *dev, int probe);
318};
319
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100320#ifdef CONFIG_PCI_QUIRKS
Rafael J. Wysocki5b889bf2009-12-31 19:06:35 +0100321extern int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100322#else
323static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
324{
325 return -ENOTTY;
326}
327#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800328
Zhao, Yu557848c2008-10-13 19:18:07 +0800329#endif /* DRIVERS_PCI_H */