PCI / ACPI / PM: Platform support for PCI PME wake-up
[linux-2.6.git] / drivers / pci / pci.h
1 #ifndef DRIVERS_PCI_H
2 #define DRIVERS_PCI_H
3
4 #include <linux/workqueue.h>
5
6 #define PCI_CFG_SPACE_SIZE      256
7 #define PCI_CFG_SPACE_EXP_SIZE  4096
8
9 /* Functions internal to the PCI core code */
10
11 extern int pci_uevent(struct device *dev, struct kobj_uevent_env *env);
12 extern int pci_create_sysfs_dev_files(struct pci_dev *pdev);
13 extern void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
14 extern void pci_cleanup_rom(struct pci_dev *dev);
15 #ifdef HAVE_PCI_MMAP
16 extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
17                          struct vm_area_struct *vma);
18 #endif
19 int pci_probe_reset_function(struct pci_dev *dev);
20
21 /**
22  * struct pci_platform_pm_ops - Firmware PM callbacks
23  *
24  * @is_manageable: returns 'true' if given device is power manageable by the
25  *                 platform firmware
26  *
27  * @set_state: invokes the platform firmware to set the device's power state
28  *
29  * @choose_state: returns PCI power state of given device preferred by the
30  *                platform; to be used during system-wide transitions from a
31  *                sleeping state to the working state and vice versa
32  *
33  * @can_wakeup: returns 'true' if given device is capable of waking up the
34  *              system from a sleeping state
35  *
36  * @sleep_wake: enables/disables the system wake up capability of given device
37  *
38  * @run_wake: enables/disables the platform to generate run-time wake-up events
39  *              for given device (the device's wake-up capability has to be
40  *              enabled by @sleep_wake for this feature to work)
41  *
42  * If given platform is generally capable of power managing PCI devices, all of
43  * these callbacks are mandatory.
44  */
45 struct pci_platform_pm_ops {
46         bool (*is_manageable)(struct pci_dev *dev);
47         int (*set_state)(struct pci_dev *dev, pci_power_t state);
48         pci_power_t (*choose_state)(struct pci_dev *dev);
49         bool (*can_wakeup)(struct pci_dev *dev);
50         int (*sleep_wake)(struct pci_dev *dev, bool enable);
51         int (*run_wake)(struct pci_dev *dev, bool enable);
52 };
53
54 extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
55 extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
56 extern void pci_disable_enabled_device(struct pci_dev *dev);
57 extern bool pci_check_pme_status(struct pci_dev *dev);
58 extern int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
59 extern void pci_pme_wakeup_bus(struct pci_bus *bus);
60 extern void pci_pm_init(struct pci_dev *dev);
61 extern void platform_pci_wakeup_init(struct pci_dev *dev);
62 extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
63
64 static inline bool pci_is_bridge(struct pci_dev *pci_dev)
65 {
66         return !!(pci_dev->subordinate);
67 }
68
69 extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
70 extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
71 extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
72 extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
73 extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
74 extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
75
76 struct pci_vpd_ops {
77         ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
78         ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
79         void (*release)(struct pci_dev *dev);
80 };
81
82 struct pci_vpd {
83         unsigned int len;
84         const struct pci_vpd_ops *ops;
85         struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
86 };
87
88 extern int pci_vpd_pci22_init(struct pci_dev *dev);
89 static inline void pci_vpd_release(struct pci_dev *dev)
90 {
91         if (dev->vpd)
92                 dev->vpd->ops->release(dev);
93 }
94
95 /* PCI /proc functions */
96 #ifdef CONFIG_PROC_FS
97 extern int pci_proc_attach_device(struct pci_dev *dev);
98 extern int pci_proc_detach_device(struct pci_dev *dev);
99 extern int pci_proc_detach_bus(struct pci_bus *bus);
100 #else
101 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
102 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
103 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
104 #endif
105
106 /* Functions for PCI Hotplug drivers to use */
107 extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
108
109 #ifdef HAVE_PCI_LEGACY
110 extern void pci_create_legacy_files(struct pci_bus *bus);
111 extern void pci_remove_legacy_files(struct pci_bus *bus);
112 #else
113 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
114 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
115 #endif
116
117 /* Lock for read/write access to pci device and bus lists */
118 extern struct rw_semaphore pci_bus_sem;
119
120 extern unsigned int pci_pm_d3_delay;
121
122 #ifdef CONFIG_PCI_MSI
123 void pci_no_msi(void);
124 extern void pci_msi_init_pci_dev(struct pci_dev *dev);
125 #else
126 static inline void pci_no_msi(void) { }
127 static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
128 #endif
129
130 #ifdef CONFIG_PCIEAER
131 void pci_no_aer(void);
132 #else
133 static inline void pci_no_aer(void) { }
134 #endif
135
136 static inline int pci_no_d1d2(struct pci_dev *dev)
137 {
138         unsigned int parent_dstates = 0;
139
140         if (dev->bus->self)
141                 parent_dstates = dev->bus->self->no_d1d2;
142         return (dev->no_d1d2 || parent_dstates);
143
144 }
145 extern struct device_attribute pci_dev_attrs[];
146 extern struct device_attribute dev_attr_cpuaffinity;
147 extern struct device_attribute dev_attr_cpulistaffinity;
148 #ifdef CONFIG_HOTPLUG
149 extern struct bus_attribute pci_bus_attrs[];
150 #else
151 #define pci_bus_attrs   NULL
152 #endif
153
154
155 /**
156  * pci_match_one_device - Tell if a PCI device structure has a matching
157  *                        PCI device id structure
158  * @id: single PCI device id structure to match
159  * @dev: the PCI device structure to match against
160  *
161  * Returns the matching pci_device_id structure or %NULL if there is no match.
162  */
163 static inline const struct pci_device_id *
164 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
165 {
166         if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
167             (id->device == PCI_ANY_ID || id->device == dev->device) &&
168             (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
169             (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
170             !((id->class ^ dev->class) & id->class_mask))
171                 return id;
172         return NULL;
173 }
174
175 struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
176
177 /* PCI slot sysfs helper code */
178 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
179
180 extern struct kset *pci_slots_kset;
181
182 struct pci_slot_attribute {
183         struct attribute attr;
184         ssize_t (*show)(struct pci_slot *, char *);
185         ssize_t (*store)(struct pci_slot *, const char *, size_t);
186 };
187 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
188
189 enum pci_bar_type {
190         pci_bar_unknown,        /* Standard PCI BAR probe */
191         pci_bar_io,             /* An io port BAR */
192         pci_bar_mem32,          /* A 32-bit memory BAR */
193         pci_bar_mem64,          /* A 64-bit memory BAR */
194 };
195
196 extern int pci_setup_device(struct pci_dev *dev);
197 extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
198                                 struct resource *res, unsigned int reg);
199 extern int pci_resource_bar(struct pci_dev *dev, int resno,
200                             enum pci_bar_type *type);
201 extern int pci_bus_add_child(struct pci_bus *bus);
202 extern void pci_enable_ari(struct pci_dev *dev);
203 /**
204  * pci_ari_enabled - query ARI forwarding status
205  * @bus: the PCI bus
206  *
207  * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
208  */
209 static inline int pci_ari_enabled(struct pci_bus *bus)
210 {
211         return bus->self && bus->self->ari_enabled;
212 }
213
214 #ifdef CONFIG_PCI_QUIRKS
215 extern int pci_is_reassigndev(struct pci_dev *dev);
216 resource_size_t pci_specified_resource_alignment(struct pci_dev *dev);
217 extern void pci_disable_bridge_window(struct pci_dev *dev);
218 #endif
219
220 /* Single Root I/O Virtualization */
221 struct pci_sriov {
222         int pos;                /* capability position */
223         int nres;               /* number of resources */
224         u32 cap;                /* SR-IOV Capabilities */
225         u16 ctrl;               /* SR-IOV Control */
226         u16 total;              /* total VFs associated with the PF */
227         u16 initial;            /* initial VFs associated with the PF */
228         u16 nr_virtfn;          /* number of VFs available */
229         u16 offset;             /* first VF Routing ID offset */
230         u16 stride;             /* following VF stride */
231         u32 pgsz;               /* page size for BAR alignment */
232         u8 link;                /* Function Dependency Link */
233         struct pci_dev *dev;    /* lowest numbered PF */
234         struct pci_dev *self;   /* this PF */
235         struct mutex lock;      /* lock for VF bus */
236         struct work_struct mtask; /* VF Migration task */
237         u8 __iomem *mstate;     /* VF Migration State Array */
238 };
239
240 /* Address Translation Service */
241 struct pci_ats {
242         int pos;        /* capability position */
243         int stu;        /* Smallest Translation Unit */
244         int qdep;       /* Invalidate Queue Depth */
245         int ref_cnt;    /* Physical Function reference count */
246         int is_enabled:1;       /* Enable bit is set */
247 };
248
249 #ifdef CONFIG_PCI_IOV
250 extern int pci_iov_init(struct pci_dev *dev);
251 extern void pci_iov_release(struct pci_dev *dev);
252 extern int pci_iov_resource_bar(struct pci_dev *dev, int resno,
253                                 enum pci_bar_type *type);
254 extern int pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
255 extern void pci_restore_iov_state(struct pci_dev *dev);
256 extern int pci_iov_bus_range(struct pci_bus *bus);
257
258 extern int pci_enable_ats(struct pci_dev *dev, int ps);
259 extern void pci_disable_ats(struct pci_dev *dev);
260 extern int pci_ats_queue_depth(struct pci_dev *dev);
261 /**
262  * pci_ats_enabled - query the ATS status
263  * @dev: the PCI device
264  *
265  * Returns 1 if ATS capability is enabled, or 0 if not.
266  */
267 static inline int pci_ats_enabled(struct pci_dev *dev)
268 {
269         return dev->ats && dev->ats->is_enabled;
270 }
271 #else
272 static inline int pci_iov_init(struct pci_dev *dev)
273 {
274         return -ENODEV;
275 }
276 static inline void pci_iov_release(struct pci_dev *dev)
277
278 {
279 }
280 static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
281                                        enum pci_bar_type *type)
282 {
283         return 0;
284 }
285 static inline void pci_restore_iov_state(struct pci_dev *dev)
286 {
287 }
288 static inline int pci_iov_bus_range(struct pci_bus *bus)
289 {
290         return 0;
291 }
292
293 static inline int pci_enable_ats(struct pci_dev *dev, int ps)
294 {
295         return -ENODEV;
296 }
297 static inline void pci_disable_ats(struct pci_dev *dev)
298 {
299 }
300 static inline int pci_ats_queue_depth(struct pci_dev *dev)
301 {
302         return -ENODEV;
303 }
304 static inline int pci_ats_enabled(struct pci_dev *dev)
305 {
306         return 0;
307 }
308 #endif /* CONFIG_PCI_IOV */
309
310 static inline int pci_resource_alignment(struct pci_dev *dev,
311                                          struct resource *res)
312 {
313 #ifdef CONFIG_PCI_IOV
314         int resno = res - dev->resource;
315
316         if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
317                 return pci_sriov_resource_alignment(dev, resno);
318 #endif
319         return resource_alignment(res);
320 }
321
322 extern void pci_enable_acs(struct pci_dev *dev);
323
324 struct pci_dev_reset_methods {
325         u16 vendor;
326         u16 device;
327         int (*reset)(struct pci_dev *dev, int probe);
328 };
329
330 #ifdef CONFIG_PCI_QUIRKS
331 extern int pci_dev_specific_reset(struct pci_dev *dev, int probe);
332 #else
333 static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
334 {
335         return -ENOTTY;
336 }
337 #endif
338
339 #endif /* DRIVERS_PCI_H */