813ca2c895d8db82d9c1aa69ba2dcc5ecec4fffc
[muen/linux.git] / drivers / pci / pci.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef DRIVERS_PCI_H
3 #define DRIVERS_PCI_H
4
5 #define PCI_FIND_CAP_TTL        48
6
7 #define PCI_VSEC_ID_INTEL_TBT   0x1234  /* Thunderbolt */
8
9 extern const unsigned char pcie_link_speed[];
10
11 bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
12
13 /* Functions internal to the PCI core code */
14
15 int pci_create_sysfs_dev_files(struct pci_dev *pdev);
16 void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
17 #if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
18 static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
19 { return; }
20 static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
21 { return; }
22 #else
23 void pci_create_firmware_label_files(struct pci_dev *pdev);
24 void pci_remove_firmware_label_files(struct pci_dev *pdev);
25 #endif
26 void pci_cleanup_rom(struct pci_dev *dev);
27
28 enum pci_mmap_api {
29         PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
30         PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
31 };
32 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
33                   enum pci_mmap_api mmap_api);
34
35 int pci_probe_reset_function(struct pci_dev *dev);
36
37 /**
38  * struct pci_platform_pm_ops - Firmware PM callbacks
39  *
40  * @is_manageable: returns 'true' if given device is power manageable by the
41  *                 platform firmware
42  *
43  * @set_state: invokes the platform firmware to set the device's power state
44  *
45  * @get_state: queries the platform firmware for a device's current power state
46  *
47  * @choose_state: returns PCI power state of given device preferred by the
48  *                platform; to be used during system-wide transitions from a
49  *                sleeping state to the working state and vice versa
50  *
51  * @set_wakeup: enables/disables wakeup capability for the device
52  *
53  * @need_resume: returns 'true' if the given device (which is currently
54  *               suspended) needs to be resumed to be configured for system
55  *               wakeup.
56  *
57  * If given platform is generally capable of power managing PCI devices, all of
58  * these callbacks are mandatory.
59  */
60 struct pci_platform_pm_ops {
61         bool (*is_manageable)(struct pci_dev *dev);
62         int (*set_state)(struct pci_dev *dev, pci_power_t state);
63         pci_power_t (*get_state)(struct pci_dev *dev);
64         pci_power_t (*choose_state)(struct pci_dev *dev);
65         int (*set_wakeup)(struct pci_dev *dev, bool enable);
66         bool (*need_resume)(struct pci_dev *dev);
67 };
68
69 int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
70 void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
71 void pci_power_up(struct pci_dev *dev);
72 void pci_disable_enabled_device(struct pci_dev *dev);
73 int pci_finish_runtime_suspend(struct pci_dev *dev);
74 void pcie_clear_root_pme_status(struct pci_dev *dev);
75 int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
76 void pci_pme_restore(struct pci_dev *dev);
77 bool pci_dev_keep_suspended(struct pci_dev *dev);
78 void pci_dev_complete_resume(struct pci_dev *pci_dev);
79 void pci_config_pm_runtime_get(struct pci_dev *dev);
80 void pci_config_pm_runtime_put(struct pci_dev *dev);
81 void pci_pm_init(struct pci_dev *dev);
82 void pci_ea_init(struct pci_dev *dev);
83 void pci_allocate_cap_save_buffers(struct pci_dev *dev);
84 void pci_free_cap_save_buffers(struct pci_dev *dev);
85 bool pci_bridge_d3_possible(struct pci_dev *dev);
86 void pci_bridge_d3_update(struct pci_dev *dev);
87
88 static inline void pci_wakeup_event(struct pci_dev *dev)
89 {
90         /* Wait 100 ms before the system can be put into a sleep state. */
91         pm_wakeup_event(&dev->dev, 100);
92 }
93
94 static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
95 {
96         return !!(pci_dev->subordinate);
97 }
98
99 static inline bool pci_power_manageable(struct pci_dev *pci_dev)
100 {
101         /*
102          * Currently we allow normal PCI devices and PCI bridges transition
103          * into D3 if their bridge_d3 is set.
104          */
105         return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
106 }
107
108 struct pci_vpd_ops {
109         ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
110         ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
111         int (*set_size)(struct pci_dev *dev, size_t len);
112 };
113
114 struct pci_vpd {
115         const struct pci_vpd_ops *ops;
116         struct bin_attribute *attr;     /* Descriptor for sysfs VPD entry */
117         struct mutex    lock;
118         unsigned int    len;
119         u16             flag;
120         u8              cap;
121         u8              busy:1;
122         u8              valid:1;
123 };
124
125 int pci_vpd_init(struct pci_dev *dev);
126 void pci_vpd_release(struct pci_dev *dev);
127
128 /* PCI /proc functions */
129 #ifdef CONFIG_PROC_FS
130 int pci_proc_attach_device(struct pci_dev *dev);
131 int pci_proc_detach_device(struct pci_dev *dev);
132 int pci_proc_detach_bus(struct pci_bus *bus);
133 #else
134 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
135 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
136 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
137 #endif
138
139 /* Functions for PCI Hotplug drivers to use */
140 int pci_hp_add_bridge(struct pci_dev *dev);
141
142 #ifdef HAVE_PCI_LEGACY
143 void pci_create_legacy_files(struct pci_bus *bus);
144 void pci_remove_legacy_files(struct pci_bus *bus);
145 #else
146 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
147 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
148 #endif
149
150 /* Lock for read/write access to pci device and bus lists */
151 extern struct rw_semaphore pci_bus_sem;
152
153 extern raw_spinlock_t pci_lock;
154
155 extern unsigned int pci_pm_d3_delay;
156
157 #ifdef CONFIG_PCI_MSI
158 void pci_no_msi(void);
159 #else
160 static inline void pci_no_msi(void) { }
161 #endif
162
163 static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
164 {
165         u16 control;
166
167         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
168         control &= ~PCI_MSI_FLAGS_ENABLE;
169         if (enable)
170                 control |= PCI_MSI_FLAGS_ENABLE;
171         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
172 }
173
174 static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
175 {
176         u16 ctrl;
177
178         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
179         ctrl &= ~clear;
180         ctrl |= set;
181         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
182 }
183
184 void pci_realloc_get_opt(char *);
185
186 static inline int pci_no_d1d2(struct pci_dev *dev)
187 {
188         unsigned int parent_dstates = 0;
189
190         if (dev->bus->self)
191                 parent_dstates = dev->bus->self->no_d1d2;
192         return (dev->no_d1d2 || parent_dstates);
193
194 }
195 extern const struct attribute_group *pci_dev_groups[];
196 extern const struct attribute_group *pcibus_groups[];
197 extern const struct device_type pci_dev_type;
198 extern const struct attribute_group *pci_bus_groups[];
199
200
201 /**
202  * pci_match_one_device - Tell if a PCI device structure has a matching
203  *                        PCI device id structure
204  * @id: single PCI device id structure to match
205  * @dev: the PCI device structure to match against
206  *
207  * Returns the matching pci_device_id structure or %NULL if there is no match.
208  */
209 static inline const struct pci_device_id *
210 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
211 {
212         if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
213             (id->device == PCI_ANY_ID || id->device == dev->device) &&
214             (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
215             (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
216             !((id->class ^ dev->class) & id->class_mask))
217                 return id;
218         return NULL;
219 }
220
221 /* PCI slot sysfs helper code */
222 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
223
224 extern struct kset *pci_slots_kset;
225
226 struct pci_slot_attribute {
227         struct attribute attr;
228         ssize_t (*show)(struct pci_slot *, char *);
229         ssize_t (*store)(struct pci_slot *, const char *, size_t);
230 };
231 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
232
233 enum pci_bar_type {
234         pci_bar_unknown,        /* Standard PCI BAR probe */
235         pci_bar_io,             /* An I/O port BAR */
236         pci_bar_mem32,          /* A 32-bit memory BAR */
237         pci_bar_mem64,          /* A 64-bit memory BAR */
238 };
239
240 int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
241 bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
242                                 int crs_timeout);
243 int pci_setup_device(struct pci_dev *dev);
244 int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
245                     struct resource *res, unsigned int reg);
246 void pci_configure_ari(struct pci_dev *dev);
247 void __pci_bus_size_bridges(struct pci_bus *bus,
248                         struct list_head *realloc_head);
249 void __pci_bus_assign_resources(const struct pci_bus *bus,
250                                 struct list_head *realloc_head,
251                                 struct list_head *fail_head);
252 bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
253
254 void pci_reassigndev_resource_alignment(struct pci_dev *dev);
255 void pci_disable_bridge_window(struct pci_dev *dev);
256
257 /* Single Root I/O Virtualization */
258 struct pci_sriov {
259         int             pos;            /* Capability position */
260         int             nres;           /* Number of resources */
261         u32             cap;            /* SR-IOV Capabilities */
262         u16             ctrl;           /* SR-IOV Control */
263         u16             total_VFs;      /* Total VFs associated with the PF */
264         u16             initial_VFs;    /* Initial VFs associated with the PF */
265         u16             num_VFs;        /* Number of VFs available */
266         u16             offset;         /* First VF Routing ID offset */
267         u16             stride;         /* Following VF stride */
268         u16             vf_device;      /* VF device ID */
269         u32             pgsz;           /* Page size for BAR alignment */
270         u8              link;           /* Function Dependency Link */
271         u8              max_VF_buses;   /* Max buses consumed by VFs */
272         u16             driver_max_VFs; /* Max num VFs driver supports */
273         struct pci_dev  *dev;           /* Lowest numbered PF */
274         struct pci_dev  *self;          /* This PF */
275         resource_size_t barsz[PCI_SRIOV_NUM_BARS];      /* VF BAR size */
276         bool            drivers_autoprobe; /* Auto probing of VFs by driver */
277 };
278
279 /* pci_dev priv_flags */
280 #define PCI_DEV_DISCONNECTED 0
281
282 static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
283 {
284         set_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
285         return 0;
286 }
287
288 static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
289 {
290         return test_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
291 }
292
293 #ifdef CONFIG_PCI_ATS
294 void pci_restore_ats_state(struct pci_dev *dev);
295 #else
296 static inline void pci_restore_ats_state(struct pci_dev *dev)
297 {
298 }
299 #endif /* CONFIG_PCI_ATS */
300
301 #ifdef CONFIG_PCI_IOV
302 int pci_iov_init(struct pci_dev *dev);
303 void pci_iov_release(struct pci_dev *dev);
304 void pci_iov_update_resource(struct pci_dev *dev, int resno);
305 resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
306 void pci_restore_iov_state(struct pci_dev *dev);
307 int pci_iov_bus_range(struct pci_bus *bus);
308
309 #else
310 static inline int pci_iov_init(struct pci_dev *dev)
311 {
312         return -ENODEV;
313 }
314 static inline void pci_iov_release(struct pci_dev *dev)
315
316 {
317 }
318 static inline void pci_restore_iov_state(struct pci_dev *dev)
319 {
320 }
321 static inline int pci_iov_bus_range(struct pci_bus *bus)
322 {
323         return 0;
324 }
325
326 #endif /* CONFIG_PCI_IOV */
327
328 unsigned long pci_cardbus_resource_alignment(struct resource *);
329
330 static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
331                                                      struct resource *res)
332 {
333 #ifdef CONFIG_PCI_IOV
334         int resno = res - dev->resource;
335
336         if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
337                 return pci_sriov_resource_alignment(dev, resno);
338 #endif
339         if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
340                 return pci_cardbus_resource_alignment(res);
341         return resource_alignment(res);
342 }
343
344 void pci_enable_acs(struct pci_dev *dev);
345
346 #ifdef CONFIG_PCIEASPM
347 void pcie_aspm_init_link_state(struct pci_dev *pdev);
348 void pcie_aspm_exit_link_state(struct pci_dev *pdev);
349 void pcie_aspm_pm_state_change(struct pci_dev *pdev);
350 void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
351 #else
352 static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
353 static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
354 static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
355 static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
356 #endif
357
358 #ifdef CONFIG_PCIEASPM_DEBUG
359 void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev);
360 void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev);
361 #else
362 static inline void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev) { }
363 static inline void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev) { }
364 #endif
365
366 #ifdef CONFIG_PCIE_PTM
367 void pci_ptm_init(struct pci_dev *dev);
368 #else
369 static inline void pci_ptm_init(struct pci_dev *dev) { }
370 #endif
371
372 struct pci_dev_reset_methods {
373         u16 vendor;
374         u16 device;
375         int (*reset)(struct pci_dev *dev, int probe);
376 };
377
378 #ifdef CONFIG_PCI_QUIRKS
379 int pci_dev_specific_reset(struct pci_dev *dev, int probe);
380 #else
381 static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
382 {
383         return -ENOTTY;
384 }
385 #endif
386
387 #if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
388 int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
389                           struct resource *res);
390 #endif
391
392 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
393 int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
394 int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
395 static inline u64 pci_rebar_size_to_bytes(int size)
396 {
397         return 1ULL << (size + 20);
398 }
399
400 #endif /* DRIVERS_PCI_H */