PCI: fix struct pci_platform_pm_ops kernel-doc
[linux-2.6/mini2440.git] / drivers / pci / pci.h
blob07c0aa5275e6edf33ab1914761d6acb3113f1741
1 #ifndef DRIVERS_PCI_H
2 #define DRIVERS_PCI_H
4 #define PCI_CFG_SPACE_SIZE 256
5 #define PCI_CFG_SPACE_EXP_SIZE 4096
7 /* Functions internal to the PCI core code */
9 extern int pci_uevent(struct device *dev, struct kobj_uevent_env *env);
10 extern int pci_create_sysfs_dev_files(struct pci_dev *pdev);
11 extern void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
12 extern void pci_cleanup_rom(struct pci_dev *dev);
13 #ifdef HAVE_PCI_MMAP
14 extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
15 struct vm_area_struct *vma);
16 #endif
18 /**
19 * struct pci_platform_pm_ops - Firmware PM callbacks
21 * @is_manageable: returns 'true' if given device is power manageable by the
22 * platform firmware
24 * @set_state: invokes the platform firmware to set the device's power state
26 * @choose_state: returns PCI power state of given device preferred by the
27 * platform; to be used during system-wide transitions from a
28 * sleeping state to the working state and vice versa
30 * @can_wakeup: returns 'true' if given device is capable of waking up the
31 * system from a sleeping state
33 * @sleep_wake: enables/disables the system wake up capability of given device
35 * If given platform is generally capable of power managing PCI devices, all of
36 * these callbacks are mandatory.
38 struct pci_platform_pm_ops {
39 bool (*is_manageable)(struct pci_dev *dev);
40 int (*set_state)(struct pci_dev *dev, pci_power_t state);
41 pci_power_t (*choose_state)(struct pci_dev *dev);
42 bool (*can_wakeup)(struct pci_dev *dev);
43 int (*sleep_wake)(struct pci_dev *dev, bool enable);
46 extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
47 extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
48 extern void pci_disable_enabled_device(struct pci_dev *dev);
49 extern void pci_pm_init(struct pci_dev *dev);
50 extern void platform_pci_wakeup_init(struct pci_dev *dev);
51 extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
52 extern int pci_restore_standard_config(struct pci_dev *dev);
54 static inline bool pci_is_bridge(struct pci_dev *pci_dev)
56 return !!(pci_dev->subordinate);
59 extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
60 extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
61 extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
62 extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
63 extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
64 extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
66 struct pci_vpd_ops {
67 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
68 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
69 void (*release)(struct pci_dev *dev);
72 struct pci_vpd {
73 unsigned int len;
74 const struct pci_vpd_ops *ops;
75 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
78 extern int pci_vpd_pci22_init(struct pci_dev *dev);
79 static inline void pci_vpd_release(struct pci_dev *dev)
81 if (dev->vpd)
82 dev->vpd->ops->release(dev);
85 /* PCI /proc functions */
86 #ifdef CONFIG_PROC_FS
87 extern int pci_proc_attach_device(struct pci_dev *dev);
88 extern int pci_proc_detach_device(struct pci_dev *dev);
89 extern int pci_proc_detach_bus(struct pci_bus *bus);
90 #else
91 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
92 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
93 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
94 #endif
96 /* Functions for PCI Hotplug drivers to use */
97 extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
99 #ifdef HAVE_PCI_LEGACY
100 extern void pci_create_legacy_files(struct pci_bus *bus);
101 extern void pci_remove_legacy_files(struct pci_bus *bus);
102 #else
103 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
104 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
105 #endif
107 /* Lock for read/write access to pci device and bus lists */
108 extern struct rw_semaphore pci_bus_sem;
110 extern unsigned int pci_pm_d3_delay;
112 #ifdef CONFIG_PCI_MSI
113 void pci_no_msi(void);
114 extern void pci_msi_init_pci_dev(struct pci_dev *dev);
115 #else
116 static inline void pci_no_msi(void) { }
117 static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
118 #endif
120 #ifdef CONFIG_PCIEAER
121 void pci_no_aer(void);
122 #else
123 static inline void pci_no_aer(void) { }
124 #endif
126 static inline int pci_no_d1d2(struct pci_dev *dev)
128 unsigned int parent_dstates = 0;
130 if (dev->bus->self)
131 parent_dstates = dev->bus->self->no_d1d2;
132 return (dev->no_d1d2 || parent_dstates);
135 extern int pcie_mch_quirk;
136 extern struct device_attribute pci_dev_attrs[];
137 extern struct device_attribute dev_attr_cpuaffinity;
138 extern struct device_attribute dev_attr_cpulistaffinity;
141 * pci_match_one_device - Tell if a PCI device structure has a matching
142 * PCI device id structure
143 * @id: single PCI device id structure to match
144 * @dev: the PCI device structure to match against
146 * Returns the matching pci_device_id structure or %NULL if there is no match.
148 static inline const struct pci_device_id *
149 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
151 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
152 (id->device == PCI_ANY_ID || id->device == dev->device) &&
153 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
154 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
155 !((id->class ^ dev->class) & id->class_mask))
156 return id;
157 return NULL;
160 struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
162 /* PCI slot sysfs helper code */
163 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
165 extern struct kset *pci_slots_kset;
167 struct pci_slot_attribute {
168 struct attribute attr;
169 ssize_t (*show)(struct pci_slot *, char *);
170 ssize_t (*store)(struct pci_slot *, const char *, size_t);
172 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
174 enum pci_bar_type {
175 pci_bar_unknown, /* Standard PCI BAR probe */
176 pci_bar_io, /* An io port BAR */
177 pci_bar_mem32, /* A 32-bit memory BAR */
178 pci_bar_mem64, /* A 64-bit memory BAR */
181 extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
182 struct resource *res, unsigned int reg);
183 extern int pci_resource_bar(struct pci_dev *dev, int resno,
184 enum pci_bar_type *type);
185 extern int pci_bus_add_child(struct pci_bus *bus);
186 extern void pci_enable_ari(struct pci_dev *dev);
188 * pci_ari_enabled - query ARI forwarding status
189 * @bus: the PCI bus
191 * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
193 static inline int pci_ari_enabled(struct pci_bus *bus)
195 return bus->self && bus->self->ari_enabled;
198 #endif /* DRIVERS_PCI_H */