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