b95b0a077d3113d2db3444017a36dd5273d99ecf
[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  * If given platform is generally capable of power managing PCI devices, all of
39  * these callbacks are mandatory.
40  */
41 struct pci_platform_pm_ops {
42         bool (*is_manageable)(struct pci_dev *dev);
43         int (*set_state)(struct pci_dev *dev, pci_power_t state);
44         pci_power_t (*choose_state)(struct pci_dev *dev);
45         bool (*can_wakeup)(struct pci_dev *dev);
46         int (*sleep_wake)(struct pci_dev *dev, bool enable);
47 };
48
49 extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
50 extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
51 extern void pci_disable_enabled_device(struct pci_dev *dev);
52 extern bool pci_check_pme_status(struct pci_dev *dev);
53 extern void pci_pm_init(struct pci_dev *dev);
54 extern void platform_pci_wakeup_init(struct pci_dev *dev);
55 extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
56
57 static inline bool pci_is_bridge(struct pci_dev *pci_dev)
58 {
59         return !!(pci_dev->subordinate);
60 }
61
62 extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
63 extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
64 extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
65 extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
66 extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
67 extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
68
69 struct pci_vpd_ops {
70         ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
71         ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
72         void (*release)(struct pci_dev *dev);
73 };
74
75 struct pci_vpd {
76         unsigned int len;
77         const struct pci_vpd_ops *ops;
78         struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
79 };
80
81 extern int pci_vpd_pci22_init(struct pci_dev *dev);
82 static inline void pci_vpd_release(struct pci_dev *dev)
83 {
84         if (dev->vpd)
85                 dev->vpd->ops->release(dev);
86 }
87
88 /* PCI /proc functions */
89 #ifdef CONFIG_PROC_FS
90 extern int pci_proc_attach_device(struct pci_dev *dev);
91 extern int pci_proc_detach_device(struct pci_dev *dev);
92 extern int pci_proc_detach_bus(struct pci_bus *bus);
93 #else
94 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
95 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
96 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
97 #endif
98
99 /* Functions for PCI Hotplug drivers to use */
100 extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
101
102 #ifdef HAVE_PCI_LEGACY
103 extern void pci_create_legacy_files(struct pci_bus *bus);
104 extern void pci_remove_legacy_files(struct pci_bus *bus);
105 #else
106 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
107 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
108 #endif
109
110 /* Lock for read/write access to pci device and bus lists */
111 extern struct rw_semaphore pci_bus_sem;
112
113 extern unsigned int pci_pm_d3_delay;
114
115 #ifdef CONFIG_PCI_MSI
116 void pci_no_msi(void);
117 extern void pci_msi_init_pci_dev(struct pci_dev *dev);
118 #else
119 static inline void pci_no_msi(void) { }
120 static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
121 #endif
122
123 #ifdef CONFIG_PCIEAER
124 void pci_no_aer(void);
125 #else
126 static inline void pci_no_aer(void) { }
127 #endif
128
129 static inline int pci_no_d1d2(struct pci_dev *dev)
130 {
131         unsigned int parent_dstates = 0;
132
133         if (dev->bus->self)
134                 parent_dstates = dev->bus->self->no_d1d2;
135         return (dev->no_d1d2 || parent_dstates);
136
137 }
138 extern struct device_attribute pci_dev_attrs[];
139 extern struct device_attribute dev_attr_cpuaffinity;
140 extern struct device_attribute dev_attr_cpulistaffinity;
141 #ifdef CONFIG_HOTPLUG
142 extern struct bus_attribute pci_bus_attrs[];
143 #else
144 #define pci_bus_attrs   NULL
145 #endif
146
147
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
153  *
154  * Returns the matching pci_device_id structure or %NULL if there is no match.
155  */
156 static inline const struct pci_device_id *
157 pci_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
168 struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
169
170 /* PCI slot sysfs helper code */
171 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
172
173 extern struct kset *pci_slots_kset;
174
175 struct 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
182 enum 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
189 extern int pci_setup_device(struct pci_dev *dev);
190 extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
191                                 struct resource *res, unsigned int reg);
192 extern int pci_resource_bar(struct pci_dev *dev, int resno,
193                             enum pci_bar_type *type);
194 extern int pci_bus_add_child(struct pci_bus *bus);
195 extern void pci_enable_ari(struct pci_dev *dev);
196 /**
197  * pci_ari_enabled - query ARI forwarding status
198  * @bus: the PCI bus
199  *
200  * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
201  */
202 static inline int pci_ari_enabled(struct pci_bus *bus)
203 {
204         return bus->self && bus->self->ari_enabled;
205 }
206
207 #ifdef CONFIG_PCI_QUIRKS
208 extern int pci_is_reassigndev(struct pci_dev *dev);
209 resource_size_t pci_specified_resource_alignment(struct pci_dev *dev);
210 extern void pci_disable_bridge_window(struct pci_dev *dev);
211 #endif
212
213 /* Single Root I/O Virtualization */
214 struct 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 */
220         u16 initial;            /* initial VFs associated with the PF */
221         u16 nr_virtfn;          /* number of VFs available */
222         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 */
229         struct work_struct mtask; /* VF Migration task */
230         u8 __iomem *mstate;     /* VF Migration State Array */
231 };
232
233 /* Address Translation Service */
234 struct pci_ats {
235         int pos;        /* capability position */
236         int stu;        /* Smallest Translation Unit */
237         int qdep;       /* Invalidate Queue Depth */
238         int ref_cnt;    /* Physical Function reference count */
239         int is_enabled:1;       /* Enable bit is set */
240 };
241
242 #ifdef CONFIG_PCI_IOV
243 extern int pci_iov_init(struct pci_dev *dev);
244 extern void pci_iov_release(struct pci_dev *dev);
245 extern int pci_iov_resource_bar(struct pci_dev *dev, int resno,
246                                 enum pci_bar_type *type);
247 extern int pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
248 extern void pci_restore_iov_state(struct pci_dev *dev);
249 extern int pci_iov_bus_range(struct pci_bus *bus);
250
251 extern int pci_enable_ats(struct pci_dev *dev, int ps);
252 extern void pci_disable_ats(struct pci_dev *dev);
253 extern int pci_ats_queue_depth(struct pci_dev *dev);
254 /**
255  * pci_ats_enabled - query the ATS status
256  * @dev: the PCI device
257  *
258  * Returns 1 if ATS capability is enabled, or 0 if not.
259  */
260 static inline int pci_ats_enabled(struct pci_dev *dev)
261 {
262         return dev->ats && dev->ats->is_enabled;
263 }
264 #else
265 static inline int pci_iov_init(struct pci_dev *dev)
266 {
267         return -ENODEV;
268 }
269 static inline void pci_iov_release(struct pci_dev *dev)
270
271 {
272 }
273 static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
274                                        enum pci_bar_type *type)
275 {
276         return 0;
277 }
278 static inline void pci_restore_iov_state(struct pci_dev *dev)
279 {
280 }
281 static inline int pci_iov_bus_range(struct pci_bus *bus)
282 {
283         return 0;
284 }
285
286 static inline int pci_enable_ats(struct pci_dev *dev, int ps)
287 {
288         return -ENODEV;
289 }
290 static inline void pci_disable_ats(struct pci_dev *dev)
291 {
292 }
293 static inline int pci_ats_queue_depth(struct pci_dev *dev)
294 {
295         return -ENODEV;
296 }
297 static inline int pci_ats_enabled(struct pci_dev *dev)
298 {
299         return 0;
300 }
301 #endif /* CONFIG_PCI_IOV */
302
303 static inline int pci_resource_alignment(struct pci_dev *dev,
304                                          struct resource *res)
305 {
306 #ifdef CONFIG_PCI_IOV
307         int resno = res - dev->resource;
308
309         if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
310                 return pci_sriov_resource_alignment(dev, resno);
311 #endif
312         return resource_alignment(res);
313 }
314
315 extern void pci_enable_acs(struct pci_dev *dev);
316
317 struct pci_dev_reset_methods {
318         u16 vendor;
319         u16 device;
320         int (*reset)(struct pci_dev *dev, int probe);
321 };
322
323 #ifdef CONFIG_PCI_QUIRKS
324 extern int pci_dev_specific_reset(struct pci_dev *dev, int probe);
325 #else
326 static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
327 {
328         return -ENOTTY;
329 }
330 #endif
331
332 #endif /* DRIVERS_PCI_H */