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