xref: /linux/drivers/pci/pci.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
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 extern const unsigned char pcix_bus_speed[];
10 extern const unsigned char pcie_link_speed[];
11 
12 /* Functions internal to the PCI core code */
13 
14 int pci_create_sysfs_dev_files(struct pci_dev *pdev);
15 void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
16 #if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
17 static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
18 { return; }
19 static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
20 { return; }
21 #else
22 void pci_create_firmware_label_files(struct pci_dev *pdev);
23 void pci_remove_firmware_label_files(struct pci_dev *pdev);
24 #endif
25 void pci_cleanup_rom(struct pci_dev *dev);
26 #ifdef HAVE_PCI_MMAP
27 enum pci_mmap_api {
28 	PCI_MMAP_SYSFS,	/* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
29 	PCI_MMAP_PROCFS	/* mmap on /proc/bus/pci/<BDF> */
30 };
31 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
32 		  enum pci_mmap_api mmap_api);
33 #endif
34 int pci_probe_reset_function(struct pci_dev *dev);
35 
36 /**
37  * struct pci_platform_pm_ops - Firmware PM callbacks
38  *
39  * @is_manageable: returns 'true' if given device is power manageable by the
40  *                 platform firmware
41  *
42  * @set_state: invokes the platform firmware to set the device's power state
43  *
44  * @choose_state: returns PCI power state of given device preferred by the
45  *                platform; to be used during system-wide transitions from a
46  *                sleeping state to the working state and vice versa
47  *
48  * @sleep_wake: enables/disables the system wake up capability of given device
49  *
50  * @run_wake: enables/disables the platform to generate run-time wake-up events
51  *		for given device (the device's wake-up capability has to be
52  *		enabled by @sleep_wake for this feature to work)
53  *
54  * If given platform is generally capable of power managing PCI devices, all of
55  * these callbacks are mandatory.
56  */
57 struct pci_platform_pm_ops {
58 	bool (*is_manageable)(struct pci_dev *dev);
59 	int (*set_state)(struct pci_dev *dev, pci_power_t state);
60 	pci_power_t (*choose_state)(struct pci_dev *dev);
61 	int (*sleep_wake)(struct pci_dev *dev, bool enable);
62 	int (*run_wake)(struct pci_dev *dev, bool enable);
63 };
64 
65 int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
66 void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
67 void pci_power_up(struct pci_dev *dev);
68 void pci_disable_enabled_device(struct pci_dev *dev);
69 int pci_finish_runtime_suspend(struct pci_dev *dev);
70 int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
71 void pci_wakeup_bus(struct pci_bus *bus);
72 void pci_config_pm_runtime_get(struct pci_dev *dev);
73 void pci_config_pm_runtime_put(struct pci_dev *dev);
74 void pci_pm_init(struct pci_dev *dev);
75 void pci_allocate_cap_save_buffers(struct pci_dev *dev);
76 void pci_free_cap_save_buffers(struct pci_dev *dev);
77 
78 static inline void pci_wakeup_event(struct pci_dev *dev)
79 {
80 	/* Wait 100 ms before the system can be put into a sleep state. */
81 	pm_wakeup_event(&dev->dev, 100);
82 }
83 
84 static inline bool pci_is_bridge(struct pci_dev *pci_dev)
85 {
86 	return !!(pci_dev->subordinate);
87 }
88 
89 struct pci_vpd_ops {
90 	ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
91 	ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
92 	void (*release)(struct pci_dev *dev);
93 };
94 
95 struct pci_vpd {
96 	unsigned int len;
97 	const struct pci_vpd_ops *ops;
98 	struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
99 };
100 
101 int pci_vpd_pci22_init(struct pci_dev *dev);
102 static inline void pci_vpd_release(struct pci_dev *dev)
103 {
104 	if (dev->vpd)
105 		dev->vpd->ops->release(dev);
106 }
107 
108 /* PCI /proc functions */
109 #ifdef CONFIG_PROC_FS
110 int pci_proc_attach_device(struct pci_dev *dev);
111 int pci_proc_detach_device(struct pci_dev *dev);
112 int pci_proc_detach_bus(struct pci_bus *bus);
113 #else
114 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
115 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
116 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
117 #endif
118 
119 /* Functions for PCI Hotplug drivers to use */
120 int pci_hp_add_bridge(struct pci_dev *dev);
121 
122 #ifdef HAVE_PCI_LEGACY
123 void pci_create_legacy_files(struct pci_bus *bus);
124 void pci_remove_legacy_files(struct pci_bus *bus);
125 #else
126 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
127 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
128 #endif
129 
130 /* Lock for read/write access to pci device and bus lists */
131 extern struct rw_semaphore pci_bus_sem;
132 
133 extern raw_spinlock_t pci_lock;
134 
135 extern unsigned int pci_pm_d3_delay;
136 
137 #ifdef CONFIG_PCI_MSI
138 void pci_no_msi(void);
139 void pci_msi_init_pci_dev(struct pci_dev *dev);
140 #else
141 static inline void pci_no_msi(void) { }
142 static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
143 #endif
144 
145 void pci_realloc_get_opt(char *);
146 
147 static inline int pci_no_d1d2(struct pci_dev *dev)
148 {
149 	unsigned int parent_dstates = 0;
150 
151 	if (dev->bus->self)
152 		parent_dstates = dev->bus->self->no_d1d2;
153 	return (dev->no_d1d2 || parent_dstates);
154 
155 }
156 extern const struct attribute_group *pci_dev_groups[];
157 extern const struct attribute_group *pcibus_groups[];
158 extern struct device_type pci_dev_type;
159 extern const struct attribute_group *pci_bus_groups[];
160 
161 
162 /**
163  * pci_match_one_device - Tell if a PCI device structure has a matching
164  *                        PCI device id structure
165  * @id: single PCI device id structure to match
166  * @dev: the PCI device structure to match against
167  *
168  * Returns the matching pci_device_id structure or %NULL if there is no match.
169  */
170 static inline const struct pci_device_id *
171 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
172 {
173 	if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
174 	    (id->device == PCI_ANY_ID || id->device == dev->device) &&
175 	    (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
176 	    (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
177 	    !((id->class ^ dev->class) & id->class_mask))
178 		return id;
179 	return NULL;
180 }
181 
182 /* PCI slot sysfs helper code */
183 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
184 
185 extern struct kset *pci_slots_kset;
186 
187 struct pci_slot_attribute {
188 	struct attribute attr;
189 	ssize_t (*show)(struct pci_slot *, char *);
190 	ssize_t (*store)(struct pci_slot *, const char *, size_t);
191 };
192 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
193 
194 enum pci_bar_type {
195 	pci_bar_unknown,	/* Standard PCI BAR probe */
196 	pci_bar_io,		/* An io port BAR */
197 	pci_bar_mem32,		/* A 32-bit memory BAR */
198 	pci_bar_mem64,		/* A 64-bit memory BAR */
199 };
200 
201 bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
202 				int crs_timeout);
203 int pci_setup_device(struct pci_dev *dev);
204 int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
205 		    struct resource *res, unsigned int reg);
206 int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
207 void pci_configure_ari(struct pci_dev *dev);
208 void __ref __pci_bus_size_bridges(struct pci_bus *bus,
209 			struct list_head *realloc_head);
210 void __ref __pci_bus_assign_resources(const struct pci_bus *bus,
211 				      struct list_head *realloc_head,
212 				      struct list_head *fail_head);
213 
214 /**
215  * pci_ari_enabled - query ARI forwarding status
216  * @bus: the PCI bus
217  *
218  * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
219  */
220 static inline int pci_ari_enabled(struct pci_bus *bus)
221 {
222 	return bus->self && bus->self->ari_enabled;
223 }
224 
225 void pci_reassigndev_resource_alignment(struct pci_dev *dev);
226 void pci_disable_bridge_window(struct pci_dev *dev);
227 
228 /* Single Root I/O Virtualization */
229 struct pci_sriov {
230 	int pos;		/* capability position */
231 	int nres;		/* number of resources */
232 	u32 cap;		/* SR-IOV Capabilities */
233 	u16 ctrl;		/* SR-IOV Control */
234 	u16 total_VFs;		/* total VFs associated with the PF */
235 	u16 initial_VFs;	/* initial VFs associated with the PF */
236 	u16 num_VFs;		/* number of VFs available */
237 	u16 offset;		/* first VF Routing ID offset */
238 	u16 stride;		/* following VF stride */
239 	u32 pgsz;		/* page size for BAR alignment */
240 	u8 link;		/* Function Dependency Link */
241 	u16 driver_max_VFs;	/* max num VFs driver supports */
242 	struct pci_dev *dev;	/* lowest numbered PF */
243 	struct pci_dev *self;	/* this PF */
244 	struct mutex lock;	/* lock for VF bus */
245 	struct work_struct mtask; /* VF Migration task */
246 	u8 __iomem *mstate;	/* VF Migration State Array */
247 };
248 
249 #ifdef CONFIG_PCI_ATS
250 void pci_restore_ats_state(struct pci_dev *dev);
251 #else
252 static inline void pci_restore_ats_state(struct pci_dev *dev)
253 {
254 }
255 #endif /* CONFIG_PCI_ATS */
256 
257 #ifdef CONFIG_PCI_IOV
258 int pci_iov_init(struct pci_dev *dev);
259 void pci_iov_release(struct pci_dev *dev);
260 int pci_iov_resource_bar(struct pci_dev *dev, int resno,
261 			 enum pci_bar_type *type);
262 resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
263 void pci_restore_iov_state(struct pci_dev *dev);
264 int pci_iov_bus_range(struct pci_bus *bus);
265 
266 #else
267 static inline int pci_iov_init(struct pci_dev *dev)
268 {
269 	return -ENODEV;
270 }
271 static inline void pci_iov_release(struct pci_dev *dev)
272 
273 {
274 }
275 static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
276 				       enum pci_bar_type *type)
277 {
278 	return 0;
279 }
280 static inline void pci_restore_iov_state(struct pci_dev *dev)
281 {
282 }
283 static inline int pci_iov_bus_range(struct pci_bus *bus)
284 {
285 	return 0;
286 }
287 
288 #endif /* CONFIG_PCI_IOV */
289 
290 unsigned long pci_cardbus_resource_alignment(struct resource *);
291 
292 static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
293 						     struct resource *res)
294 {
295 #ifdef CONFIG_PCI_IOV
296 	int resno = res - dev->resource;
297 
298 	if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
299 		return pci_sriov_resource_alignment(dev, resno);
300 #endif
301 	if (dev->class >> 8  == PCI_CLASS_BRIDGE_CARDBUS)
302 		return pci_cardbus_resource_alignment(res);
303 	return resource_alignment(res);
304 }
305 
306 void pci_enable_acs(struct pci_dev *dev);
307 
308 struct pci_dev_reset_methods {
309 	u16 vendor;
310 	u16 device;
311 	int (*reset)(struct pci_dev *dev, int probe);
312 };
313 
314 #ifdef CONFIG_PCI_QUIRKS
315 int pci_dev_specific_reset(struct pci_dev *dev, int probe);
316 #else
317 static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
318 {
319 	return -ENOTTY;
320 }
321 #endif
322 
323 #endif /* DRIVERS_PCI_H */
324