blob: 0601890db22de96131af2d67fd872651ab608133 [file] [log] [blame]
Zhao, Yu557848c2008-10-13 19:18:07 +08001#ifndef DRIVERS_PCI_H
2#define DRIVERS_PCI_H
3
4#define PCI_CFG_SPACE_SIZE 256
5#define PCI_CFG_SPACE_EXP_SIZE 4096
6
Jacob Keller343e51a2013-07-31 06:53:16 +00007extern const unsigned char pcie_link_speed[];
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);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060068void pci_config_pm_runtime_get(struct pci_dev *dev);
69void pci_config_pm_runtime_put(struct pci_dev *dev);
70void pci_pm_init(struct pci_dev *dev);
71void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -080072void pci_free_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010073
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +010074static inline void pci_wakeup_event(struct pci_dev *dev)
75{
76 /* Wait 100 ms before the system can be put into a sleep state. */
77 pm_wakeup_event(&dev->dev, 100);
78}
79
Yijing Wang326c1cd2014-05-04 12:23:36 +080080static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010081{
82 return !!(pci_dev->subordinate);
83}
David Shaohua Li0f644742005-03-19 00:15:48 -050084
Ben Hutchings94e61082008-03-05 16:52:39 +000085struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080086 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
87 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000088 void (*release)(struct pci_dev *dev);
89};
90
91struct pci_vpd {
Benjamin Li99cb233d2008-07-02 10:59:04 -070092 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -080093 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +000094 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
95};
96
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060097int pci_vpd_pci22_init(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +000098static inline void pci_vpd_release(struct pci_dev *dev)
99{
100 if (dev->vpd)
101 dev->vpd->ops->release(dev);
102}
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104/* PCI /proc functions */
105#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600106int pci_proc_attach_device(struct pci_dev *dev);
107int pci_proc_detach_device(struct pci_dev *dev);
108int pci_proc_detach_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#else
110static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
111static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
113#endif
114
115/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600116int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000118#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600119void pci_create_legacy_files(struct pci_bus *bus);
120void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000121#else
122static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
123static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
124#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800127extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100129extern raw_spinlock_t pci_lock;
130
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700131extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100132
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700133#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700134void pci_no_msi(void);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600135void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700136#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700137static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000138static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700139#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100140
Yinghai Lub55438f2012-02-23 19:23:30 -0800141void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700142
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700143static inline int pci_no_d1d2(struct pci_dev *dev)
144{
145 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700146
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700147 if (dev->bus->self)
148 parent_dstates = dev->bus->self->no_d1d2;
149 return (dev->no_d1d2 || parent_dstates);
150
151}
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -0700152extern const struct attribute_group *pci_dev_groups[];
Greg Kroah-Hartman56039e62013-07-24 15:05:17 -0700153extern const struct attribute_group *pcibus_groups[];
Yinghai Lu4e15c462012-11-05 15:20:34 -0500154extern struct device_type pci_dev_type;
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -0600155extern const struct attribute_group *pci_bus_groups[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158/**
159 * pci_match_one_device - Tell if a PCI device structure has a matching
160 * PCI device id structure
161 * @id: single PCI device id structure to match
162 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800163 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 * Returns the matching pci_device_id structure or %NULL if there is no match.
165 */
166static inline const struct pci_device_id *
167pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
168{
169 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
170 (id->device == PCI_ANY_ID || id->device == dev->device) &&
171 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
172 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
173 !((id->class ^ dev->class) & id->class_mask))
174 return id;
175 return NULL;
176}
177
Alex Chiangf46753c2008-06-10 15:28:50 -0600178/* PCI slot sysfs helper code */
179#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
180
181extern struct kset *pci_slots_kset;
182
183struct pci_slot_attribute {
184 struct attribute attr;
185 ssize_t (*show)(struct pci_slot *, char *);
186 ssize_t (*store)(struct pci_slot *, const char *, size_t);
187};
188#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
189
Yu Zhao0b400c72008-11-22 02:40:40 +0800190enum pci_bar_type {
191 pci_bar_unknown, /* Standard PCI BAR probe */
192 pci_bar_io, /* An io port BAR */
193 pci_bar_mem32, /* A 32-bit memory BAR */
194 pci_bar_mem64, /* A 64-bit memory BAR */
195};
196
Yinghai Luefdc87d2012-01-27 10:55:10 -0800197bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
198 int crs_timeout);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600199int pci_setup_device(struct pci_dev *dev);
200int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
201 struct resource *res, unsigned int reg);
202int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
203void pci_configure_ari(struct pci_dev *dev);
Bjorn Helgaas10874f52014-04-14 16:11:40 -0600204void __pci_bus_size_bridges(struct pci_bus *bus,
Jiang Liud66ecb72013-06-23 01:01:35 +0200205 struct list_head *realloc_head);
Bjorn Helgaas10874f52014-04-14 16:11:40 -0600206void __pci_bus_assign_resources(const struct pci_bus *bus,
207 struct list_head *realloc_head,
208 struct list_head *fail_head);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700209
Yu Zhao58c3a722008-10-14 14:02:53 +0800210/**
211 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800212 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800213 *
214 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
215 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800216static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800217{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800218 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800219}
220
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800221void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600222void pci_disable_bridge_window(struct pci_dev *dev);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900223
Yu Zhaod1b054d2009-03-20 11:25:11 +0800224/* Single Root I/O Virtualization */
225struct pci_sriov {
226 int pos; /* capability position */
227 int nres; /* number of resources */
228 u32 cap; /* SR-IOV Capabilities */
229 u16 ctrl; /* SR-IOV Control */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700230 u16 total_VFs; /* total VFs associated with the PF */
231 u16 initial_VFs; /* initial VFs associated with the PF */
232 u16 num_VFs; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800233 u16 offset; /* first VF Routing ID offset */
234 u16 stride; /* following VF stride */
235 u32 pgsz; /* page size for BAR alignment */
236 u8 link; /* Function Dependency Link */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700237 u16 driver_max_VFs; /* max num VFs driver supports */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800238 struct pci_dev *dev; /* lowest numbered PF */
239 struct pci_dev *self; /* this PF */
240 struct mutex lock; /* lock for VF bus */
241};
242
Hao, Xudong1900ca12011-12-17 21:24:40 +0800243#ifdef CONFIG_PCI_ATS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600244void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800245#else
246static inline void pci_restore_ats_state(struct pci_dev *dev)
247{
248}
249#endif /* CONFIG_PCI_ATS */
250
Yu Zhaod1b054d2009-03-20 11:25:11 +0800251#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600252int pci_iov_init(struct pci_dev *dev);
253void pci_iov_release(struct pci_dev *dev);
254int pci_iov_resource_bar(struct pci_dev *dev, int resno,
255 enum pci_bar_type *type);
256resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
257void pci_restore_iov_state(struct pci_dev *dev);
258int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhao302b4212009-05-18 13:51:32 +0800259
Yu Zhaod1b054d2009-03-20 11:25:11 +0800260#else
261static inline int pci_iov_init(struct pci_dev *dev)
262{
263 return -ENODEV;
264}
265static inline void pci_iov_release(struct pci_dev *dev)
266
267{
268}
269static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
270 enum pci_bar_type *type)
271{
272 return 0;
273}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800274static inline void pci_restore_iov_state(struct pci_dev *dev)
275{
276}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800277static inline int pci_iov_bus_range(struct pci_bus *bus)
278{
279 return 0;
280}
Yu Zhao302b4212009-05-18 13:51:32 +0800281
Yu Zhaod1b054d2009-03-20 11:25:11 +0800282#endif /* CONFIG_PCI_IOV */
283
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600284unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700285
Cam Macdonell0e522472010-09-07 17:25:20 -0700286static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600287 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700288{
289#ifdef CONFIG_PCI_IOV
290 int resno = res - dev->resource;
291
292 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
293 return pci_sriov_resource_alignment(dev, resno);
294#endif
Ram Pai0a2daa12011-07-25 13:08:41 -0700295 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
296 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700297 return resource_alignment(res);
298}
299
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600300void pci_enable_acs(struct pci_dev *dev);
Allen Kayae21ee62009-10-07 10:27:17 -0700301
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800302struct pci_dev_reset_methods {
303 u16 vendor;
304 u16 device;
305 int (*reset)(struct pci_dev *dev, int probe);
306};
307
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100308#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600309int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100310#else
311static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
312{
313 return -ENOTTY;
314}
315#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800316
Zhao, Yu557848c2008-10-13 19:18:07 +0800317#endif /* DRIVERS_PCI_H */