1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/module.h>
4 #include <linux/slab.h>
5 #include <linux/ioport.h>
6 #include <linux/wait.h>
11 * This interrupt-safe spinlock protects all accesses to PCI
12 * configuration space.
15 DEFINE_RAW_SPINLOCK(pci_lock);
18 * Wrappers for all PCI configuration access functions. They just check
19 * alignment, do locking and call the low-level functions pointed to
23 #define PCI_byte_BAD 0
24 #define PCI_word_BAD (pos & 1)
25 #define PCI_dword_BAD (pos & 3)
27 #ifdef CONFIG_PCI_LOCKLESS_CONFIG
28 # define pci_lock_config(f) do { (void)(f); } while (0)
29 # define pci_unlock_config(f) do { (void)(f); } while (0)
31 # define pci_lock_config(f) raw_spin_lock_irqsave(&pci_lock, f)
32 # define pci_unlock_config(f) raw_spin_unlock_irqrestore(&pci_lock, f)
35 #define PCI_OP_READ(size, type, len) \
36 int noinline pci_bus_read_config_##size \
37 (struct pci_bus *bus, unsigned int devfn, int pos, type *value) \
40 unsigned long flags; \
42 if (PCI_##size##_BAD) return PCIBIOS_BAD_REGISTER_NUMBER; \
43 pci_lock_config(flags); \
44 res = bus->ops->read(bus, devfn, pos, len, &data); \
46 PCI_SET_ERROR_RESPONSE(value); \
48 *value = (type)data; \
49 pci_unlock_config(flags); \
53 #define PCI_OP_WRITE(size, type, len) \
54 int noinline pci_bus_write_config_##size \
55 (struct pci_bus *bus, unsigned int devfn, int pos, type value) \
58 unsigned long flags; \
59 if (PCI_##size##_BAD) return PCIBIOS_BAD_REGISTER_NUMBER; \
60 pci_lock_config(flags); \
61 res = bus->ops->write(bus, devfn, pos, len, value); \
62 pci_unlock_config(flags); \
66 PCI_OP_READ(byte, u8, 1)
67 PCI_OP_READ(word, u16, 2)
68 PCI_OP_READ(dword, u32, 4)
69 PCI_OP_WRITE(byte, u8, 1)
70 PCI_OP_WRITE(word, u16, 2)
71 PCI_OP_WRITE(dword, u32, 4)
73 EXPORT_SYMBOL(pci_bus_read_config_byte);
74 EXPORT_SYMBOL(pci_bus_read_config_word);
75 EXPORT_SYMBOL(pci_bus_read_config_dword);
76 EXPORT_SYMBOL(pci_bus_write_config_byte);
77 EXPORT_SYMBOL(pci_bus_write_config_word);
78 EXPORT_SYMBOL(pci_bus_write_config_dword);
80 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
81 int where, int size, u32 *val)
85 addr = bus->ops->map_bus(bus, devfn, where);
87 return PCIBIOS_DEVICE_NOT_FOUND;
96 return PCIBIOS_SUCCESSFUL;
98 EXPORT_SYMBOL_GPL(pci_generic_config_read);
100 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
101 int where, int size, u32 val)
105 addr = bus->ops->map_bus(bus, devfn, where);
107 return PCIBIOS_DEVICE_NOT_FOUND;
116 return PCIBIOS_SUCCESSFUL;
118 EXPORT_SYMBOL_GPL(pci_generic_config_write);
120 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
121 int where, int size, u32 *val)
125 addr = bus->ops->map_bus(bus, devfn, where & ~0x3);
127 return PCIBIOS_DEVICE_NOT_FOUND;
132 *val = (*val >> (8 * (where & 3))) & ((1 << (size * 8)) - 1);
134 return PCIBIOS_SUCCESSFUL;
136 EXPORT_SYMBOL_GPL(pci_generic_config_read32);
138 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
139 int where, int size, u32 val)
144 addr = bus->ops->map_bus(bus, devfn, where & ~0x3);
146 return PCIBIOS_DEVICE_NOT_FOUND;
150 return PCIBIOS_SUCCESSFUL;
154 * In general, hardware that supports only 32-bit writes on PCI is
155 * not spec-compliant. For example, software may perform a 16-bit
156 * write. If the hardware only supports 32-bit accesses, we must
157 * do a 32-bit read, merge in the 16 bits we intend to write,
158 * followed by a 32-bit write. If the 16 bits we *don't* intend to
159 * write happen to have any RW1C (write-one-to-clear) bits set, we
160 * just inadvertently cleared something we shouldn't have.
162 if (!bus->unsafe_warn) {
163 dev_warn(&bus->dev, "%d-byte config write to %04x:%02x:%02x.%d offset %#x may corrupt adjacent RW1C bits\n",
164 size, pci_domain_nr(bus), bus->number,
165 PCI_SLOT(devfn), PCI_FUNC(devfn), where);
166 bus->unsafe_warn = 1;
169 mask = ~(((1 << (size * 8)) - 1) << ((where & 0x3) * 8));
170 tmp = readl(addr) & mask;
171 tmp |= val << ((where & 0x3) * 8);
174 return PCIBIOS_SUCCESSFUL;
176 EXPORT_SYMBOL_GPL(pci_generic_config_write32);
179 * pci_bus_set_ops - Set raw operations of pci bus
180 * @bus: pci bus struct
181 * @ops: new raw operations
183 * Return previous raw operations
185 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops)
187 struct pci_ops *old_ops;
190 raw_spin_lock_irqsave(&pci_lock, flags);
193 raw_spin_unlock_irqrestore(&pci_lock, flags);
196 EXPORT_SYMBOL(pci_bus_set_ops);
199 * The following routines are to prevent the user from accessing PCI config
200 * space when it's unsafe to do so. Some devices require this during BIST and
201 * we're required to prevent it during D-state transitions.
203 * We have a bit per device to indicate it's blocked and a global wait queue
204 * for callers to sleep on until devices are unblocked.
206 static DECLARE_WAIT_QUEUE_HEAD(pci_cfg_wait);
208 static noinline void pci_wait_cfg(struct pci_dev *dev)
209 __must_hold(&pci_lock)
212 raw_spin_unlock_irq(&pci_lock);
213 wait_event(pci_cfg_wait, !dev->block_cfg_access);
214 raw_spin_lock_irq(&pci_lock);
215 } while (dev->block_cfg_access);
218 /* Returns 0 on success, negative values indicate error. */
219 #define PCI_USER_READ_CONFIG(size, type) \
220 int pci_user_read_config_##size \
221 (struct pci_dev *dev, int pos, type *val) \
223 int ret = PCIBIOS_SUCCESSFUL; \
225 if (PCI_##size##_BAD) \
227 raw_spin_lock_irq(&pci_lock); \
228 if (unlikely(dev->block_cfg_access)) \
230 ret = dev->bus->ops->read(dev->bus, dev->devfn, \
231 pos, sizeof(type), &data); \
232 raw_spin_unlock_irq(&pci_lock); \
234 PCI_SET_ERROR_RESPONSE(val); \
237 return pcibios_err_to_errno(ret); \
239 EXPORT_SYMBOL_GPL(pci_user_read_config_##size);
241 /* Returns 0 on success, negative values indicate error. */
242 #define PCI_USER_WRITE_CONFIG(size, type) \
243 int pci_user_write_config_##size \
244 (struct pci_dev *dev, int pos, type val) \
246 int ret = PCIBIOS_SUCCESSFUL; \
247 if (PCI_##size##_BAD) \
249 raw_spin_lock_irq(&pci_lock); \
250 if (unlikely(dev->block_cfg_access)) \
252 ret = dev->bus->ops->write(dev->bus, dev->devfn, \
253 pos, sizeof(type), val); \
254 raw_spin_unlock_irq(&pci_lock); \
255 return pcibios_err_to_errno(ret); \
257 EXPORT_SYMBOL_GPL(pci_user_write_config_##size);
259 PCI_USER_READ_CONFIG(byte, u8)
260 PCI_USER_READ_CONFIG(word, u16)
261 PCI_USER_READ_CONFIG(dword, u32)
262 PCI_USER_WRITE_CONFIG(byte, u8)
263 PCI_USER_WRITE_CONFIG(word, u16)
264 PCI_USER_WRITE_CONFIG(dword, u32)
267 * pci_cfg_access_lock - Lock PCI config reads/writes
268 * @dev: pci device struct
270 * When access is locked, any userspace reads or writes to config
271 * space and concurrent lock requests will sleep until access is
272 * allowed via pci_cfg_access_unlock() again.
274 void pci_cfg_access_lock(struct pci_dev *dev)
278 raw_spin_lock_irq(&pci_lock);
279 if (dev->block_cfg_access)
281 dev->block_cfg_access = 1;
282 raw_spin_unlock_irq(&pci_lock);
284 EXPORT_SYMBOL_GPL(pci_cfg_access_lock);
287 * pci_cfg_access_trylock - try to lock PCI config reads/writes
288 * @dev: pci device struct
290 * Same as pci_cfg_access_lock, but will return 0 if access is
291 * already locked, 1 otherwise. This function can be used from
294 bool pci_cfg_access_trylock(struct pci_dev *dev)
299 raw_spin_lock_irqsave(&pci_lock, flags);
300 if (dev->block_cfg_access)
303 dev->block_cfg_access = 1;
304 raw_spin_unlock_irqrestore(&pci_lock, flags);
308 EXPORT_SYMBOL_GPL(pci_cfg_access_trylock);
311 * pci_cfg_access_unlock - Unlock PCI config reads/writes
312 * @dev: pci device struct
314 * This function allows PCI config accesses to resume.
316 void pci_cfg_access_unlock(struct pci_dev *dev)
320 raw_spin_lock_irqsave(&pci_lock, flags);
323 * This indicates a problem in the caller, but we don't need
324 * to kill them, unlike a double-block above.
326 WARN_ON(!dev->block_cfg_access);
328 dev->block_cfg_access = 0;
329 raw_spin_unlock_irqrestore(&pci_lock, flags);
331 wake_up_all(&pci_cfg_wait);
333 EXPORT_SYMBOL_GPL(pci_cfg_access_unlock);
335 static inline int pcie_cap_version(const struct pci_dev *dev)
337 return pcie_caps_reg(dev) & PCI_EXP_FLAGS_VERS;
340 bool pcie_cap_has_lnkctl(const struct pci_dev *dev)
342 int type = pci_pcie_type(dev);
344 return type == PCI_EXP_TYPE_ENDPOINT ||
345 type == PCI_EXP_TYPE_LEG_END ||
346 type == PCI_EXP_TYPE_ROOT_PORT ||
347 type == PCI_EXP_TYPE_UPSTREAM ||
348 type == PCI_EXP_TYPE_DOWNSTREAM ||
349 type == PCI_EXP_TYPE_PCI_BRIDGE ||
350 type == PCI_EXP_TYPE_PCIE_BRIDGE;
353 bool pcie_cap_has_lnkctl2(const struct pci_dev *dev)
355 return pcie_cap_has_lnkctl(dev) && pcie_cap_version(dev) > 1;
358 static inline bool pcie_cap_has_sltctl(const struct pci_dev *dev)
360 return pcie_downstream_port(dev) &&
361 pcie_caps_reg(dev) & PCI_EXP_FLAGS_SLOT;
364 bool pcie_cap_has_rtctl(const struct pci_dev *dev)
366 int type = pci_pcie_type(dev);
368 return type == PCI_EXP_TYPE_ROOT_PORT ||
369 type == PCI_EXP_TYPE_RC_EC;
372 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos)
374 if (!pci_is_pcie(dev))
387 return pcie_cap_has_lnkctl(dev);
391 return pcie_cap_has_sltctl(dev);
395 return pcie_cap_has_rtctl(dev);
396 case PCI_EXP_DEVCAP2:
397 case PCI_EXP_DEVCTL2:
398 return pcie_cap_version(dev) > 1;
399 case PCI_EXP_LNKCAP2:
400 case PCI_EXP_LNKCTL2:
401 case PCI_EXP_LNKSTA2:
402 return pcie_cap_has_lnkctl2(dev);
409 * Note that these accessor functions are only for the "PCI Express
410 * Capability" (see PCIe spec r3.0, sec 7.8). They do not apply to the
411 * other "PCI Express Extended Capabilities" (AER, VC, ACS, MFVC, etc.)
413 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val)
419 return PCIBIOS_BAD_REGISTER_NUMBER;
421 if (pcie_capability_reg_implemented(dev, pos)) {
422 ret = pci_read_config_word(dev, pci_pcie_cap(dev) + pos, val);
424 * Reset *val to 0 if pci_read_config_word() fails; it may
425 * have been written as 0xFFFF (PCI_ERROR_RESPONSE) if the
426 * config read failed on PCI.
434 * For Functions that do not implement the Slot Capabilities,
435 * Slot Status, and Slot Control registers, these spaces must
436 * be hardwired to 0b, with the exception of the Presence Detect
437 * State bit in the Slot Status register of Downstream Ports,
438 * which must be hardwired to 1b. (PCIe Base Spec 3.0, sec 7.8)
440 if (pci_is_pcie(dev) && pcie_downstream_port(dev) &&
441 pos == PCI_EXP_SLTSTA)
442 *val = PCI_EXP_SLTSTA_PDS;
446 EXPORT_SYMBOL(pcie_capability_read_word);
448 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val)
454 return PCIBIOS_BAD_REGISTER_NUMBER;
456 if (pcie_capability_reg_implemented(dev, pos)) {
457 ret = pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, val);
459 * Reset *val to 0 if pci_read_config_dword() fails; it may
460 * have been written as 0xFFFFFFFF (PCI_ERROR_RESPONSE) if
461 * the config read failed on PCI.
468 if (pci_is_pcie(dev) && pcie_downstream_port(dev) &&
469 pos == PCI_EXP_SLTSTA)
470 *val = PCI_EXP_SLTSTA_PDS;
474 EXPORT_SYMBOL(pcie_capability_read_dword);
476 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val)
479 return PCIBIOS_BAD_REGISTER_NUMBER;
481 if (!pcie_capability_reg_implemented(dev, pos))
484 return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val);
486 EXPORT_SYMBOL(pcie_capability_write_word);
488 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val)
491 return PCIBIOS_BAD_REGISTER_NUMBER;
493 if (!pcie_capability_reg_implemented(dev, pos))
496 return pci_write_config_dword(dev, pci_pcie_cap(dev) + pos, val);
498 EXPORT_SYMBOL(pcie_capability_write_dword);
500 int pcie_capability_clear_and_set_word_unlocked(struct pci_dev *dev, int pos,
506 ret = pcie_capability_read_word(dev, pos, &val);
512 return pcie_capability_write_word(dev, pos, val);
514 EXPORT_SYMBOL(pcie_capability_clear_and_set_word_unlocked);
516 int pcie_capability_clear_and_set_word_locked(struct pci_dev *dev, int pos,
522 spin_lock_irqsave(&dev->pcie_cap_lock, flags);
523 ret = pcie_capability_clear_and_set_word_unlocked(dev, pos, clear, set);
524 spin_unlock_irqrestore(&dev->pcie_cap_lock, flags);
528 EXPORT_SYMBOL(pcie_capability_clear_and_set_word_locked);
530 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
536 ret = pcie_capability_read_dword(dev, pos, &val);
542 return pcie_capability_write_dword(dev, pos, val);
544 EXPORT_SYMBOL(pcie_capability_clear_and_set_dword);
546 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
548 if (pci_dev_is_disconnected(dev)) {
549 PCI_SET_ERROR_RESPONSE(val);
550 return PCIBIOS_DEVICE_NOT_FOUND;
552 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
554 EXPORT_SYMBOL(pci_read_config_byte);
556 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
558 if (pci_dev_is_disconnected(dev)) {
559 PCI_SET_ERROR_RESPONSE(val);
560 return PCIBIOS_DEVICE_NOT_FOUND;
562 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
564 EXPORT_SYMBOL(pci_read_config_word);
566 int pci_read_config_dword(const struct pci_dev *dev, int where,
569 if (pci_dev_is_disconnected(dev)) {
570 PCI_SET_ERROR_RESPONSE(val);
571 return PCIBIOS_DEVICE_NOT_FOUND;
573 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
575 EXPORT_SYMBOL(pci_read_config_dword);
577 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
579 if (pci_dev_is_disconnected(dev))
580 return PCIBIOS_DEVICE_NOT_FOUND;
581 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
583 EXPORT_SYMBOL(pci_write_config_byte);
585 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
587 if (pci_dev_is_disconnected(dev))
588 return PCIBIOS_DEVICE_NOT_FOUND;
589 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
591 EXPORT_SYMBOL(pci_write_config_word);
593 int pci_write_config_dword(const struct pci_dev *dev, int where,
596 if (pci_dev_is_disconnected(dev))
597 return PCIBIOS_DEVICE_NOT_FOUND;
598 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
600 EXPORT_SYMBOL(pci_write_config_dword);
602 void pci_clear_and_set_config_dword(const struct pci_dev *dev, int pos,
607 pci_read_config_dword(dev, pos, &val);
610 pci_write_config_dword(dev, pos, val);
612 EXPORT_SYMBOL(pci_clear_and_set_config_dword);