blob: 6beb11b617a92973f7a32cc47a7343a759218d6e [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 K911e1c92010-07-26 05:56:50 -050014#ifndef CONFIG_DMI
15static 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
25extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
26 struct vm_area_struct *vma);
27#endif
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030028int pci_probe_reset_function(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050029
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020030/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080031 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020032 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080033 * @is_manageable: returns 'true' if given device is power manageable by the
34 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020035 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080036 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020037 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080038 * @choose_state: returns PCI power state of given device preferred by the
39 * platform; to be used during system-wide transitions from a
40 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020041 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080042 * @can_wakeup: returns 'true' if given device is capable of waking up the
43 * system from a sleeping state
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +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 bool (*can_wakeup)(struct pci_dev *dev);
59 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010060 int (*run_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020061};
62
63extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
Rafael J. Wysocki734104292009-01-07 13:07:15 +010064extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
Rafael J. Wysockifa58d302009-01-07 13:03:42 +010065extern void pci_disable_enabled_device(struct pci_dev *dev);
Rafael J. Wysocki58ff4632010-02-17 23:36:58 +010066extern bool pci_check_pme_status(struct pci_dev *dev);
Rafael J. Wysocki6cbf8212010-02-17 23:44:58 +010067extern int pci_finish_runtime_suspend(struct pci_dev *dev);
Rafael J. Wysockic125e962010-07-05 22:43:53 +020068extern void pci_wakeup_event(struct pci_dev *dev);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010069extern int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
70extern void pci_pme_wakeup_bus(struct pci_bus *bus);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020071extern void pci_pm_init(struct pci_dev *dev);
Jesse Barneseb9c39d2008-12-17 12:10:05 -080072extern void platform_pci_wakeup_init(struct pci_dev *dev);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +010073extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010074
75static inline bool pci_is_bridge(struct pci_dev *pci_dev)
76{
77 return !!(pci_dev->subordinate);
78}
David Shaohua Li0f644742005-03-19 00:15:48 -050079
Brian Kinge04b0ea2005-09-27 01:21:55 -070080extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
81extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
82extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
83extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
84extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
85extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
86
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
99extern int pci_vpd_pci22_init(struct pci_dev *dev);
100static 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
108extern int pci_proc_attach_device(struct pci_dev *dev);
109extern int pci_proc_detach_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110extern int pci_proc_detach_bus(struct pci_bus *bus);
111#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000120#ifdef HAVE_PCI_LEGACY
121extern void pci_create_legacy_files(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122extern void 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
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);
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000135extern void 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
Randy Dunlap7f785762007-10-05 13:17:58 -0700141#ifdef CONFIG_PCIEAER
142void pci_no_aer(void);
Rafael J. Wysockif1a7bfa2010-08-21 01:50:52 +0200143bool pci_aer_available(void);
Randy Dunlap7f785762007-10-05 13:17:58 -0700144#else
145static inline void pci_no_aer(void) { }
Rafael J. Wysockif1a7bfa2010-08-21 01:50:52 +0200146static inline bool pci_aer_available(void) { return false; }
Randy Dunlap7f785762007-10-05 13:17:58 -0700147#endif
148
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700149static inline int pci_no_d1d2(struct pci_dev *dev)
150{
151 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700152
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700153 if (dev->bus->self)
154 parent_dstates = dev->bus->self->no_d1d2;
155 return (dev->no_d1d2 || parent_dstates);
156
157}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158extern struct device_attribute pci_dev_attrs[];
Greg Kroah-Hartmanfd7d1ce2007-05-22 22:47:54 -0400159extern struct device_attribute dev_attr_cpuaffinity;
Mike Travis93ff68a2008-09-06 05:46:42 -0700160extern struct device_attribute dev_attr_cpulistaffinity;
Alex Chiang705b1aa2009-03-20 14:56:31 -0600161#ifdef CONFIG_HOTPLUG
162extern struct bus_attribute pci_bus_attrs[];
163#else
164#define pci_bus_attrs NULL
165#endif
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168/**
169 * pci_match_one_device - Tell if a PCI device structure has a matching
170 * PCI device id structure
171 * @id: single PCI device id structure to match
172 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800173 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 * Returns the matching pci_device_id structure or %NULL if there is no match.
175 */
176static inline const struct pci_device_id *
177pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
178{
179 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
180 (id->device == PCI_ANY_ID || id->device == dev->device) &&
181 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
182 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
183 !((id->class ^ dev->class) & id->class_mask))
184 return id;
185 return NULL;
186}
187
Keshavamurthy, Anil S994a65e2007-10-21 16:41:46 -0700188struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
Alex Chiangf46753c2008-06-10 15:28:50 -0600189
190/* PCI slot sysfs helper code */
191#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
192
193extern struct kset *pci_slots_kset;
194
195struct pci_slot_attribute {
196 struct attribute attr;
197 ssize_t (*show)(struct pci_slot *, char *);
198 ssize_t (*store)(struct pci_slot *, const char *, size_t);
199};
200#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
201
Yu Zhao0b400c72008-11-22 02:40:40 +0800202enum pci_bar_type {
203 pci_bar_unknown, /* Standard PCI BAR probe */
204 pci_bar_io, /* An io port BAR */
205 pci_bar_mem32, /* A 32-bit memory BAR */
206 pci_bar_mem64, /* A 64-bit memory BAR */
207};
208
Yu Zhao480b93b2009-03-20 11:25:14 +0800209extern int pci_setup_device(struct pci_dev *dev);
Yu Zhao0b400c72008-11-22 02:40:40 +0800210extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
211 struct resource *res, unsigned int reg);
Yu Zhao613e7ed2008-11-22 02:41:27 +0800212extern int pci_resource_bar(struct pci_dev *dev, int resno,
213 enum pci_bar_type *type);
Yu Zhao876e5012008-11-22 02:42:35 +0800214extern int pci_bus_add_child(struct pci_bus *bus);
Yu Zhao58c3a722008-10-14 14:02:53 +0800215extern void pci_enable_ari(struct pci_dev *dev);
216/**
217 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800218 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800219 *
220 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
221 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800222static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800223{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800224 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800225}
226
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900227#ifdef CONFIG_PCI_QUIRKS
228extern int pci_is_reassigndev(struct pci_dev *dev);
229resource_size_t pci_specified_resource_alignment(struct pci_dev *dev);
230extern void pci_disable_bridge_window(struct pci_dev *dev);
231#endif
232
Yu Zhaod1b054d2009-03-20 11:25:11 +0800233/* Single Root I/O Virtualization */
234struct pci_sriov {
235 int pos; /* capability position */
236 int nres; /* number of resources */
237 u32 cap; /* SR-IOV Capabilities */
238 u16 ctrl; /* SR-IOV Control */
239 u16 total; /* total VFs associated with the PF */
Yu Zhaodd7cc442009-03-20 11:25:15 +0800240 u16 initial; /* initial VFs associated with the PF */
241 u16 nr_virtfn; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800242 u16 offset; /* first VF Routing ID offset */
243 u16 stride; /* following VF stride */
244 u32 pgsz; /* page size for BAR alignment */
245 u8 link; /* Function Dependency Link */
246 struct pci_dev *dev; /* lowest numbered PF */
247 struct pci_dev *self; /* this PF */
248 struct mutex lock; /* lock for VF bus */
Yu Zhao74bb1bc2009-03-20 11:25:16 +0800249 struct work_struct mtask; /* VF Migration task */
250 u8 __iomem *mstate; /* VF Migration State Array */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800251};
252
Yu Zhao302b4212009-05-18 13:51:32 +0800253/* Address Translation Service */
254struct pci_ats {
255 int pos; /* capability position */
256 int stu; /* Smallest Translation Unit */
257 int qdep; /* Invalidate Queue Depth */
Yu Zhaoe277d2f2009-05-18 13:51:33 +0800258 int ref_cnt; /* Physical Function reference count */
Bill Pemberton8356dda2010-04-30 09:34:28 -0400259 unsigned int is_enabled:1; /* Enable bit is set */
Yu Zhao302b4212009-05-18 13:51:32 +0800260};
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
272extern int pci_enable_ats(struct pci_dev *dev, int ps);
273extern void pci_disable_ats(struct pci_dev *dev);
274extern int pci_ats_queue_depth(struct pci_dev *dev);
275/**
276 * pci_ats_enabled - query the ATS status
277 * @dev: the PCI device
278 *
279 * Returns 1 if ATS capability is enabled, or 0 if not.
280 */
281static inline int pci_ats_enabled(struct pci_dev *dev)
282{
Yu Zhaoe277d2f2009-05-18 13:51:33 +0800283 return dev->ats && dev->ats->is_enabled;
Yu Zhao302b4212009-05-18 13:51:32 +0800284}
Yu Zhaod1b054d2009-03-20 11:25:11 +0800285#else
286static inline int pci_iov_init(struct pci_dev *dev)
287{
288 return -ENODEV;
289}
290static inline void pci_iov_release(struct pci_dev *dev)
291
292{
293}
294static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
295 enum pci_bar_type *type)
296{
297 return 0;
298}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800299static inline void pci_restore_iov_state(struct pci_dev *dev)
300{
301}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800302static inline int pci_iov_bus_range(struct pci_bus *bus)
303{
304 return 0;
305}
Yu Zhao302b4212009-05-18 13:51:32 +0800306
307static inline int pci_enable_ats(struct pci_dev *dev, int ps)
308{
309 return -ENODEV;
310}
311static inline void pci_disable_ats(struct pci_dev *dev)
312{
313}
314static inline int pci_ats_queue_depth(struct pci_dev *dev)
315{
316 return -ENODEV;
317}
318static inline int pci_ats_enabled(struct pci_dev *dev)
319{
320 return 0;
321}
Yu Zhaod1b054d2009-03-20 11:25:11 +0800322#endif /* CONFIG_PCI_IOV */
323
Cam Macdonell0e522472010-09-07 17:25:20 -0700324static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Chris Wright6faf17f2009-08-28 13:00:06 -0700325 struct resource *res)
326{
327#ifdef CONFIG_PCI_IOV
328 int resno = res - dev->resource;
329
330 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
331 return pci_sriov_resource_alignment(dev, resno);
332#endif
333 return resource_alignment(res);
334}
335
Allen Kayae21ee62009-10-07 10:27:17 -0700336extern void pci_enable_acs(struct pci_dev *dev);
337
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800338struct pci_dev_reset_methods {
339 u16 vendor;
340 u16 device;
341 int (*reset)(struct pci_dev *dev, int probe);
342};
343
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100344#ifdef CONFIG_PCI_QUIRKS
Rafael J. Wysocki5b889bf2009-12-31 19:06:35 +0100345extern int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100346#else
347static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
348{
349 return -ENOTTY;
350}
351#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800352
Zhao, Yu557848c2008-10-13 19:18:07 +0800353#endif /* DRIVERS_PCI_H */