blob: 45833a5bca612f9473f34ac59d14fcae23d01f2d [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);
14extern void pci_cleanup_rom(struct pci_dev *dev);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070015#ifdef HAVE_PCI_MMAP
16extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
17 struct vm_area_struct *vma);
18#endif
Kumar Galace5ccde2007-07-16 23:27:10 -050019
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020020/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080021 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020022 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080023 * @is_manageable: returns 'true' if given device is power manageable by the
24 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020025 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080026 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020027 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080028 * @choose_state: returns PCI power state of given device preferred by the
29 * platform; to be used during system-wide transitions from a
30 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020031 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080032 * @can_wakeup: returns 'true' if given device is capable of waking up the
33 * system from a sleeping state
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020034 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080035 * @sleep_wake: enables/disables the system wake up capability of given device
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020036 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020037 * If given platform is generally capable of power managing PCI devices, all of
38 * these callbacks are mandatory.
39 */
40struct pci_platform_pm_ops {
41 bool (*is_manageable)(struct pci_dev *dev);
42 int (*set_state)(struct pci_dev *dev, pci_power_t state);
43 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020044 bool (*can_wakeup)(struct pci_dev *dev);
45 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020046};
47
48extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
Rafael J. Wysocki734104292009-01-07 13:07:15 +010049extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
Rafael J. Wysockifa58d302009-01-07 13:03:42 +010050extern void pci_disable_enabled_device(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020051extern void pci_pm_init(struct pci_dev *dev);
Jesse Barneseb9c39d2008-12-17 12:10:05 -080052extern void platform_pci_wakeup_init(struct pci_dev *dev);
Rafael J. Wysocki63f48982008-12-07 22:02:58 +010053extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010054extern int pci_restore_standard_config(struct pci_dev *dev);
55
56static inline bool pci_is_bridge(struct pci_dev *pci_dev)
57{
58 return !!(pci_dev->subordinate);
59}
David Shaohua Li0f644742005-03-19 00:15:48 -050060
Brian Kinge04b0ea2005-09-27 01:21:55 -070061extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
62extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
63extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
64extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
65extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
66extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
67
Ben Hutchings94e61082008-03-05 16:52:39 +000068struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080069 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
70 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000071 void (*release)(struct pci_dev *dev);
72};
73
74struct pci_vpd {
Benjamin Li99cb233d2008-07-02 10:59:04 -070075 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -080076 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +000077 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
78};
79
80extern int pci_vpd_pci22_init(struct pci_dev *dev);
81static inline void pci_vpd_release(struct pci_dev *dev)
82{
83 if (dev->vpd)
84 dev->vpd->ops->release(dev);
85}
86
Linus Torvalds1da177e2005-04-16 15:20:36 -070087/* PCI /proc functions */
88#ifdef CONFIG_PROC_FS
89extern int pci_proc_attach_device(struct pci_dev *dev);
90extern int pci_proc_detach_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091extern int pci_proc_detach_bus(struct pci_bus *bus);
92#else
93static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
94static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -070095static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
96#endif
97
98/* Functions for PCI Hotplug drivers to use */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000101#ifdef HAVE_PCI_LEGACY
102extern void pci_create_legacy_files(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103extern void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000104#else
105static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
106static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
107#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800110extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700112extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100113
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700114#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700115void pci_no_msi(void);
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000116extern void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700117#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700118static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000119static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700120#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100121
Randy Dunlap7f785762007-10-05 13:17:58 -0700122#ifdef CONFIG_PCIEAER
123void pci_no_aer(void);
124#else
125static inline void pci_no_aer(void) { }
126#endif
127
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700128static inline int pci_no_d1d2(struct pci_dev *dev)
129{
130 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700131
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700132 if (dev->bus->self)
133 parent_dstates = dev->bus->self->no_d1d2;
134 return (dev->no_d1d2 || parent_dstates);
135
136}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137extern int pcie_mch_quirk;
138extern struct device_attribute pci_dev_attrs[];
Greg Kroah-Hartmanfd7d1ce2007-05-22 22:47:54 -0400139extern struct device_attribute dev_attr_cpuaffinity;
Mike Travis93ff68a2008-09-06 05:46:42 -0700140extern struct device_attribute dev_attr_cpulistaffinity;
Alex Chiang705b1aa2009-03-20 14:56:31 -0600141#ifdef CONFIG_HOTPLUG
142extern struct bus_attribute pci_bus_attrs[];
143#else
144#define pci_bus_attrs NULL
145#endif
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148/**
149 * pci_match_one_device - Tell if a PCI device structure has a matching
150 * PCI device id structure
151 * @id: single PCI device id structure to match
152 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800153 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 * Returns the matching pci_device_id structure or %NULL if there is no match.
155 */
156static inline const struct pci_device_id *
157pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
158{
159 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
160 (id->device == PCI_ANY_ID || id->device == dev->device) &&
161 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
162 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
163 !((id->class ^ dev->class) & id->class_mask))
164 return id;
165 return NULL;
166}
167
Keshavamurthy, Anil S994a65e2007-10-21 16:41:46 -0700168struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
Alex Chiangf46753c2008-06-10 15:28:50 -0600169
170/* PCI slot sysfs helper code */
171#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
172
173extern struct kset *pci_slots_kset;
174
175struct pci_slot_attribute {
176 struct attribute attr;
177 ssize_t (*show)(struct pci_slot *, char *);
178 ssize_t (*store)(struct pci_slot *, const char *, size_t);
179};
180#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
181
Yu Zhao0b400c72008-11-22 02:40:40 +0800182enum pci_bar_type {
183 pci_bar_unknown, /* Standard PCI BAR probe */
184 pci_bar_io, /* An io port BAR */
185 pci_bar_mem32, /* A 32-bit memory BAR */
186 pci_bar_mem64, /* A 64-bit memory BAR */
187};
188
Yu Zhao480b93b2009-03-20 11:25:14 +0800189extern int pci_setup_device(struct pci_dev *dev);
Yu Zhao0b400c72008-11-22 02:40:40 +0800190extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
191 struct resource *res, unsigned int reg);
Yu Zhao613e7ed2008-11-22 02:41:27 +0800192extern int pci_resource_bar(struct pci_dev *dev, int resno,
193 enum pci_bar_type *type);
Yu Zhao876e5012008-11-22 02:42:35 +0800194extern int pci_bus_add_child(struct pci_bus *bus);
Yu Zhao58c3a722008-10-14 14:02:53 +0800195extern void pci_enable_ari(struct pci_dev *dev);
196/**
197 * pci_ari_enabled - query ARI forwarding status
Yu Zhao6a49d8122008-11-22 02:38:21 +0800198 * @bus: the PCI bus
Yu Zhao58c3a722008-10-14 14:02:53 +0800199 *
200 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
201 */
Yu Zhao6a49d8122008-11-22 02:38:21 +0800202static inline int pci_ari_enabled(struct pci_bus *bus)
Yu Zhao58c3a722008-10-14 14:02:53 +0800203{
Yu Zhao6a49d8122008-11-22 02:38:21 +0800204 return bus->self && bus->self->ari_enabled;
Yu Zhao58c3a722008-10-14 14:02:53 +0800205}
206
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900207#ifdef CONFIG_PCI_QUIRKS
208extern int pci_is_reassigndev(struct pci_dev *dev);
209resource_size_t pci_specified_resource_alignment(struct pci_dev *dev);
210extern void pci_disable_bridge_window(struct pci_dev *dev);
211#endif
212
Yu Zhaod1b054d2009-03-20 11:25:11 +0800213/* Single Root I/O Virtualization */
214struct pci_sriov {
215 int pos; /* capability position */
216 int nres; /* number of resources */
217 u32 cap; /* SR-IOV Capabilities */
218 u16 ctrl; /* SR-IOV Control */
219 u16 total; /* total VFs associated with the PF */
Yu Zhaodd7cc442009-03-20 11:25:15 +0800220 u16 initial; /* initial VFs associated with the PF */
221 u16 nr_virtfn; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800222 u16 offset; /* first VF Routing ID offset */
223 u16 stride; /* following VF stride */
224 u32 pgsz; /* page size for BAR alignment */
225 u8 link; /* Function Dependency Link */
226 struct pci_dev *dev; /* lowest numbered PF */
227 struct pci_dev *self; /* this PF */
228 struct mutex lock; /* lock for VF bus */
Yu Zhao74bb1bc2009-03-20 11:25:16 +0800229 struct work_struct mtask; /* VF Migration task */
230 u8 __iomem *mstate; /* VF Migration State Array */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800231};
232
233#ifdef CONFIG_PCI_IOV
234extern int pci_iov_init(struct pci_dev *dev);
235extern void pci_iov_release(struct pci_dev *dev);
236extern int pci_iov_resource_bar(struct pci_dev *dev, int resno,
237 enum pci_bar_type *type);
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800238extern void pci_restore_iov_state(struct pci_dev *dev);
Yu Zhaoa28724b2009-03-20 11:25:13 +0800239extern int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhaod1b054d2009-03-20 11:25:11 +0800240#else
241static inline int pci_iov_init(struct pci_dev *dev)
242{
243 return -ENODEV;
244}
245static inline void pci_iov_release(struct pci_dev *dev)
246
247{
248}
249static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
250 enum pci_bar_type *type)
251{
252 return 0;
253}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800254static inline void pci_restore_iov_state(struct pci_dev *dev)
255{
256}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800257static inline int pci_iov_bus_range(struct pci_bus *bus)
258{
259 return 0;
260}
Yu Zhaod1b054d2009-03-20 11:25:11 +0800261#endif /* CONFIG_PCI_IOV */
262
Zhao, Yu557848c2008-10-13 19:18:07 +0800263#endif /* DRIVERS_PCI_H */