9a41a63999678bc32eaf3af0efaaaacde4b23256
[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 int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
75 void pci_pme_restore(struct pci_dev *dev);
76 bool pci_dev_keep_suspended(struct pci_dev *dev);
77 void pci_dev_complete_resume(struct pci_dev *pci_dev);
78 void pci_config_pm_runtime_get(struct pci_dev *dev);
79 void pci_config_pm_runtime_put(struct pci_dev *dev);
80 void pci_pm_init(struct pci_dev *dev);
81 void pci_ea_init(struct pci_dev *dev);
82 void pci_allocate_cap_save_buffers(struct pci_dev *dev);
83 void pci_free_cap_save_buffers(struct pci_dev *dev);
84 bool pci_bridge_d3_possible(struct pci_dev *dev);
85 void pci_bridge_d3_update(struct pci_dev *dev);
86
87 static inline void pci_wakeup_event(struct pci_dev *dev)
88 {
89         /* Wait 100 ms before the system can be put into a sleep state. */
90         pm_wakeup_event(&dev->dev, 100);
91 }
92
93 static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
94 {
95         return !!(pci_dev->subordinate);
96 }
97
98 static inline bool pci_power_manageable(struct pci_dev *pci_dev)
99 {
100         /*
101          * Currently we allow normal PCI devices and PCI bridges transition
102          * into D3 if their bridge_d3 is set.
103          */
104         return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
105 }
106
107 int pci_vpd_init(struct pci_dev *dev);
108 void pci_vpd_release(struct pci_dev *dev);
109 void pcie_vpd_create_sysfs_dev_files(struct pci_dev *dev);
110 void pcie_vpd_remove_sysfs_dev_files(struct pci_dev *dev);
111
112 /* PCI /proc functions */
113 #ifdef CONFIG_PROC_FS
114 int pci_proc_attach_device(struct pci_dev *dev);
115 int pci_proc_detach_device(struct pci_dev *dev);
116 int pci_proc_detach_bus(struct pci_bus *bus);
117 #else
118 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
119 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
120 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
121 #endif
122
123 /* Functions for PCI Hotplug drivers to use */
124 int pci_hp_add_bridge(struct pci_dev *dev);
125
126 #ifdef HAVE_PCI_LEGACY
127 void pci_create_legacy_files(struct pci_bus *bus);
128 void pci_remove_legacy_files(struct pci_bus *bus);
129 #else
130 static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
131 static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
132 #endif
133
134 /* Lock for read/write access to pci device and bus lists */
135 extern struct rw_semaphore pci_bus_sem;
136
137 extern raw_spinlock_t pci_lock;
138
139 extern unsigned int pci_pm_d3_delay;
140
141 #ifdef CONFIG_PCI_MSI
142 void pci_no_msi(void);
143 #else
144 static inline void pci_no_msi(void) { }
145 #endif
146
147 static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
148 {
149         u16 control;
150
151         pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
152         control &= ~PCI_MSI_FLAGS_ENABLE;
153         if (enable)
154                 control |= PCI_MSI_FLAGS_ENABLE;
155         pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
156 }
157
158 static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
159 {
160         u16 ctrl;
161
162         pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
163         ctrl &= ~clear;
164         ctrl |= set;
165         pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
166 }
167
168 void pci_realloc_get_opt(char *);
169
170 static inline int pci_no_d1d2(struct pci_dev *dev)
171 {
172         unsigned int parent_dstates = 0;
173
174         if (dev->bus->self)
175                 parent_dstates = dev->bus->self->no_d1d2;
176         return (dev->no_d1d2 || parent_dstates);
177
178 }
179 extern const struct attribute_group *pci_dev_groups[];
180 extern const struct attribute_group *pcibus_groups[];
181 extern const struct device_type pci_dev_type;
182 extern const struct attribute_group *pci_bus_groups[];
183
184
185 /**
186  * pci_match_one_device - Tell if a PCI device structure has a matching
187  *                        PCI device id structure
188  * @id: single PCI device id structure to match
189  * @dev: the PCI device structure to match against
190  *
191  * Returns the matching pci_device_id structure or %NULL if there is no match.
192  */
193 static inline const struct pci_device_id *
194 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
195 {
196         if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
197             (id->device == PCI_ANY_ID || id->device == dev->device) &&
198             (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
199             (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
200             !((id->class ^ dev->class) & id->class_mask))
201                 return id;
202         return NULL;
203 }
204
205 /* PCI slot sysfs helper code */
206 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
207
208 extern struct kset *pci_slots_kset;
209
210 struct pci_slot_attribute {
211         struct attribute attr;
212         ssize_t (*show)(struct pci_slot *, char *);
213         ssize_t (*store)(struct pci_slot *, const char *, size_t);
214 };
215 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
216
217 enum pci_bar_type {
218         pci_bar_unknown,        /* Standard PCI BAR probe */
219         pci_bar_io,             /* An I/O port BAR */
220         pci_bar_mem32,          /* A 32-bit memory BAR */
221         pci_bar_mem64,          /* A 64-bit memory BAR */
222 };
223
224 int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
225 bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
226                                 int crs_timeout);
227 int pci_setup_device(struct pci_dev *dev);
228 int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
229                     struct resource *res, unsigned int reg);
230 void pci_configure_ari(struct pci_dev *dev);
231 void __pci_bus_size_bridges(struct pci_bus *bus,
232                         struct list_head *realloc_head);
233 void __pci_bus_assign_resources(const struct pci_bus *bus,
234                                 struct list_head *realloc_head,
235                                 struct list_head *fail_head);
236 bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
237
238 void pci_reassigndev_resource_alignment(struct pci_dev *dev);
239 void pci_disable_bridge_window(struct pci_dev *dev);
240
241 /* Single Root I/O Virtualization */
242 struct pci_sriov {
243         int             pos;            /* Capability position */
244         int             nres;           /* Number of resources */
245         u32             cap;            /* SR-IOV Capabilities */
246         u16             ctrl;           /* SR-IOV Control */
247         u16             total_VFs;      /* Total VFs associated with the PF */
248         u16             initial_VFs;    /* Initial VFs associated with the PF */
249         u16             num_VFs;        /* Number of VFs available */
250         u16             offset;         /* First VF Routing ID offset */
251         u16             stride;         /* Following VF stride */
252         u16             vf_device;      /* VF device ID */
253         u32             pgsz;           /* Page size for BAR alignment */
254         u8              link;           /* Function Dependency Link */
255         u8              max_VF_buses;   /* Max buses consumed by VFs */
256         u16             driver_max_VFs; /* Max num VFs driver supports */
257         struct pci_dev  *dev;           /* Lowest numbered PF */
258         struct pci_dev  *self;          /* This PF */
259         resource_size_t barsz[PCI_SRIOV_NUM_BARS];      /* VF BAR size */
260         bool            drivers_autoprobe; /* Auto probing of VFs by driver */
261 };
262
263 /* pci_dev priv_flags */
264 #define PCI_DEV_DISCONNECTED 0
265
266 static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
267 {
268         set_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
269         return 0;
270 }
271
272 static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
273 {
274         return test_bit(PCI_DEV_DISCONNECTED, &dev->priv_flags);
275 }
276
277 #ifdef CONFIG_PCI_ATS
278 void pci_restore_ats_state(struct pci_dev *dev);
279 #else
280 static inline void pci_restore_ats_state(struct pci_dev *dev)
281 {
282 }
283 #endif /* CONFIG_PCI_ATS */
284
285 #ifdef CONFIG_PCI_IOV
286 int pci_iov_init(struct pci_dev *dev);
287 void pci_iov_release(struct pci_dev *dev);
288 void pci_iov_update_resource(struct pci_dev *dev, int resno);
289 resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
290 void pci_restore_iov_state(struct pci_dev *dev);
291 int pci_iov_bus_range(struct pci_bus *bus);
292
293 #else
294 static inline int pci_iov_init(struct pci_dev *dev)
295 {
296         return -ENODEV;
297 }
298 static inline void pci_iov_release(struct pci_dev *dev)
299
300 {
301 }
302 static inline void pci_restore_iov_state(struct pci_dev *dev)
303 {
304 }
305 static inline int pci_iov_bus_range(struct pci_bus *bus)
306 {
307         return 0;
308 }
309
310 #endif /* CONFIG_PCI_IOV */
311
312 unsigned long pci_cardbus_resource_alignment(struct resource *);
313
314 static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
315                                                      struct resource *res)
316 {
317 #ifdef CONFIG_PCI_IOV
318         int resno = res - dev->resource;
319
320         if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
321                 return pci_sriov_resource_alignment(dev, resno);
322 #endif
323         if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
324                 return pci_cardbus_resource_alignment(res);
325         return resource_alignment(res);
326 }
327
328 void pci_enable_acs(struct pci_dev *dev);
329
330 #ifdef CONFIG_PCIEASPM
331 void pcie_aspm_init_link_state(struct pci_dev *pdev);
332 void pcie_aspm_exit_link_state(struct pci_dev *pdev);
333 void pcie_aspm_pm_state_change(struct pci_dev *pdev);
334 void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
335 #else
336 static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
337 static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
338 static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
339 static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
340 #endif
341
342 #ifdef CONFIG_PCIEASPM_DEBUG
343 void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev);
344 void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev);
345 #else
346 static inline void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev) { }
347 static inline void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev) { }
348 #endif
349
350 #ifdef CONFIG_PCIE_PTM
351 void pci_ptm_init(struct pci_dev *dev);
352 #else
353 static inline void pci_ptm_init(struct pci_dev *dev) { }
354 #endif
355
356 struct pci_dev_reset_methods {
357         u16 vendor;
358         u16 device;
359         int (*reset)(struct pci_dev *dev, int probe);
360 };
361
362 #ifdef CONFIG_PCI_QUIRKS
363 int pci_dev_specific_reset(struct pci_dev *dev, int probe);
364 #else
365 static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
366 {
367         return -ENOTTY;
368 }
369 #endif
370
371 #if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
372 int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
373                           struct resource *res);
374 #endif
375
376 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
377 int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
378 int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
379 static inline u64 pci_rebar_size_to_bytes(int size)
380 {
381         return 1ULL << (size + 20);
382 }
383
384 #endif /* DRIVERS_PCI_H */