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) \
39 unsigned long flags; \
43 if (PCI_##size##_BAD) \
44 return PCIBIOS_BAD_REGISTER_NUMBER; \
46 pci_lock_config(flags); \
47 res = bus->ops->read(bus, devfn, pos, len, &data); \
49 PCI_SET_ERROR_RESPONSE(value); \
51 *value = (type)data; \
52 pci_unlock_config(flags); \
57 #define PCI_OP_WRITE(size, type, len) \
58 int noinline pci_bus_write_config_##size \
59 (struct pci_bus *bus, unsigned int devfn, int pos, type value) \
61 unsigned long flags; \
64 if (PCI_##size##_BAD) \
65 return PCIBIOS_BAD_REGISTER_NUMBER; \
67 pci_lock_config(flags); \
68 res = bus->ops->write(bus, devfn, pos, len, value); \
69 pci_unlock_config(flags); \
74 PCI_OP_READ(byte
, u8
, 1)
75 PCI_OP_READ(word
, u16
, 2)
76 PCI_OP_READ(dword
, u32
, 4)
77 PCI_OP_WRITE(byte
, u8
, 1)
78 PCI_OP_WRITE(word
, u16
, 2)
79 PCI_OP_WRITE(dword
, u32
, 4)
81 EXPORT_SYMBOL(pci_bus_read_config_byte
);
82 EXPORT_SYMBOL(pci_bus_read_config_word
);
83 EXPORT_SYMBOL(pci_bus_read_config_dword
);
84 EXPORT_SYMBOL(pci_bus_write_config_byte
);
85 EXPORT_SYMBOL(pci_bus_write_config_word
);
86 EXPORT_SYMBOL(pci_bus_write_config_dword
);
88 int pci_generic_config_read(struct pci_bus
*bus
, unsigned int devfn
,
89 int where
, int size
, u32
*val
)
93 addr
= bus
->ops
->map_bus(bus
, devfn
, where
);
95 return PCIBIOS_DEVICE_NOT_FOUND
;
104 return PCIBIOS_SUCCESSFUL
;
106 EXPORT_SYMBOL_GPL(pci_generic_config_read
);
108 int pci_generic_config_write(struct pci_bus
*bus
, unsigned int devfn
,
109 int where
, int size
, u32 val
)
113 addr
= bus
->ops
->map_bus(bus
, devfn
, where
);
115 return PCIBIOS_DEVICE_NOT_FOUND
;
124 return PCIBIOS_SUCCESSFUL
;
126 EXPORT_SYMBOL_GPL(pci_generic_config_write
);
128 int pci_generic_config_read32(struct pci_bus
*bus
, unsigned int devfn
,
129 int where
, int size
, u32
*val
)
133 addr
= bus
->ops
->map_bus(bus
, devfn
, where
& ~0x3);
135 return PCIBIOS_DEVICE_NOT_FOUND
;
140 *val
= (*val
>> (8 * (where
& 3))) & ((1 << (size
* 8)) - 1);
142 return PCIBIOS_SUCCESSFUL
;
144 EXPORT_SYMBOL_GPL(pci_generic_config_read32
);
146 int pci_generic_config_write32(struct pci_bus
*bus
, unsigned int devfn
,
147 int where
, int size
, u32 val
)
152 addr
= bus
->ops
->map_bus(bus
, devfn
, where
& ~0x3);
154 return PCIBIOS_DEVICE_NOT_FOUND
;
158 return PCIBIOS_SUCCESSFUL
;
162 * In general, hardware that supports only 32-bit writes on PCI is
163 * not spec-compliant. For example, software may perform a 16-bit
164 * write. If the hardware only supports 32-bit accesses, we must
165 * do a 32-bit read, merge in the 16 bits we intend to write,
166 * followed by a 32-bit write. If the 16 bits we *don't* intend to
167 * write happen to have any RW1C (write-one-to-clear) bits set, we
168 * just inadvertently cleared something we shouldn't have.
170 if (!bus
->unsafe_warn
) {
171 dev_warn(&bus
->dev
, "%d-byte config write to %04x:%02x:%02x.%d offset %#x may corrupt adjacent RW1C bits\n",
172 size
, pci_domain_nr(bus
), bus
->number
,
173 PCI_SLOT(devfn
), PCI_FUNC(devfn
), where
);
174 bus
->unsafe_warn
= 1;
177 mask
= ~(((1 << (size
* 8)) - 1) << ((where
& 0x3) * 8));
178 tmp
= readl(addr
) & mask
;
179 tmp
|= val
<< ((where
& 0x3) * 8);
182 return PCIBIOS_SUCCESSFUL
;
184 EXPORT_SYMBOL_GPL(pci_generic_config_write32
);
187 * pci_bus_set_ops - Set raw operations of pci bus
188 * @bus: pci bus struct
189 * @ops: new raw operations
191 * Return previous raw operations
193 struct pci_ops
*pci_bus_set_ops(struct pci_bus
*bus
, struct pci_ops
*ops
)
195 struct pci_ops
*old_ops
;
198 raw_spin_lock_irqsave(&pci_lock
, flags
);
201 raw_spin_unlock_irqrestore(&pci_lock
, flags
);
204 EXPORT_SYMBOL(pci_bus_set_ops
);
207 * The following routines are to prevent the user from accessing PCI config
208 * space when it's unsafe to do so. Some devices require this during BIST and
209 * we're required to prevent it during D-state transitions.
211 * We have a bit per device to indicate it's blocked and a global wait queue
212 * for callers to sleep on until devices are unblocked.
214 static DECLARE_WAIT_QUEUE_HEAD(pci_cfg_wait
);
216 static noinline
void pci_wait_cfg(struct pci_dev
*dev
)
217 __must_hold(&pci_lock
)
220 raw_spin_unlock_irq(&pci_lock
);
221 wait_event(pci_cfg_wait
, !dev
->block_cfg_access
);
222 raw_spin_lock_irq(&pci_lock
);
223 } while (dev
->block_cfg_access
);
226 /* Returns 0 on success, negative values indicate error. */
227 #define PCI_USER_READ_CONFIG(size, type) \
228 int pci_user_read_config_##size \
229 (struct pci_dev *dev, int pos, type *val) \
234 if (PCI_##size##_BAD) \
237 raw_spin_lock_irq(&pci_lock); \
238 if (unlikely(dev->block_cfg_access)) \
240 ret = dev->bus->ops->read(dev->bus, dev->devfn, \
241 pos, sizeof(type), &data); \
242 raw_spin_unlock_irq(&pci_lock); \
244 PCI_SET_ERROR_RESPONSE(val); \
248 return pcibios_err_to_errno(ret); \
250 EXPORT_SYMBOL_GPL(pci_user_read_config_##size);
252 /* Returns 0 on success, negative values indicate error. */
253 #define PCI_USER_WRITE_CONFIG(size, type) \
254 int pci_user_write_config_##size \
255 (struct pci_dev *dev, int pos, type val) \
259 if (PCI_##size##_BAD) \
262 raw_spin_lock_irq(&pci_lock); \
263 if (unlikely(dev->block_cfg_access)) \
265 ret = dev->bus->ops->write(dev->bus, dev->devfn, \
266 pos, sizeof(type), val); \
267 raw_spin_unlock_irq(&pci_lock); \
269 return pcibios_err_to_errno(ret); \
271 EXPORT_SYMBOL_GPL(pci_user_write_config_##size);
273 PCI_USER_READ_CONFIG(byte
, u8
)
274 PCI_USER_READ_CONFIG(word
, u16
)
275 PCI_USER_READ_CONFIG(dword
, u32
)
276 PCI_USER_WRITE_CONFIG(byte
, u8
)
277 PCI_USER_WRITE_CONFIG(word
, u16
)
278 PCI_USER_WRITE_CONFIG(dword
, u32
)
281 * pci_cfg_access_lock - Lock PCI config reads/writes
282 * @dev: pci device struct
284 * When access is locked, any userspace reads or writes to config
285 * space and concurrent lock requests will sleep until access is
286 * allowed via pci_cfg_access_unlock() again.
288 void pci_cfg_access_lock(struct pci_dev
*dev
)
292 raw_spin_lock_irq(&pci_lock
);
293 if (dev
->block_cfg_access
)
295 dev
->block_cfg_access
= 1;
296 raw_spin_unlock_irq(&pci_lock
);
298 EXPORT_SYMBOL_GPL(pci_cfg_access_lock
);
301 * pci_cfg_access_trylock - try to lock PCI config reads/writes
302 * @dev: pci device struct
304 * Same as pci_cfg_access_lock, but will return 0 if access is
305 * already locked, 1 otherwise. This function can be used from
308 bool pci_cfg_access_trylock(struct pci_dev
*dev
)
313 raw_spin_lock_irqsave(&pci_lock
, flags
);
314 if (dev
->block_cfg_access
)
317 dev
->block_cfg_access
= 1;
318 raw_spin_unlock_irqrestore(&pci_lock
, flags
);
322 EXPORT_SYMBOL_GPL(pci_cfg_access_trylock
);
325 * pci_cfg_access_unlock - Unlock PCI config reads/writes
326 * @dev: pci device struct
328 * This function allows PCI config accesses to resume.
330 void pci_cfg_access_unlock(struct pci_dev
*dev
)
334 raw_spin_lock_irqsave(&pci_lock
, flags
);
337 * This indicates a problem in the caller, but we don't need
338 * to kill them, unlike a double-block above.
340 WARN_ON(!dev
->block_cfg_access
);
342 dev
->block_cfg_access
= 0;
343 raw_spin_unlock_irqrestore(&pci_lock
, flags
);
345 wake_up_all(&pci_cfg_wait
);
347 EXPORT_SYMBOL_GPL(pci_cfg_access_unlock
);
349 static inline int pcie_cap_version(const struct pci_dev
*dev
)
351 return pcie_caps_reg(dev
) & PCI_EXP_FLAGS_VERS
;
354 bool pcie_cap_has_lnkctl(const struct pci_dev
*dev
)
356 int type
= pci_pcie_type(dev
);
358 return type
== PCI_EXP_TYPE_ENDPOINT
||
359 type
== PCI_EXP_TYPE_LEG_END
||
360 type
== PCI_EXP_TYPE_ROOT_PORT
||
361 type
== PCI_EXP_TYPE_UPSTREAM
||
362 type
== PCI_EXP_TYPE_DOWNSTREAM
||
363 type
== PCI_EXP_TYPE_PCI_BRIDGE
||
364 type
== PCI_EXP_TYPE_PCIE_BRIDGE
;
367 bool pcie_cap_has_lnkctl2(const struct pci_dev
*dev
)
369 return pcie_cap_has_lnkctl(dev
) && pcie_cap_version(dev
) > 1;
372 static inline bool pcie_cap_has_sltctl(const struct pci_dev
*dev
)
374 return pcie_downstream_port(dev
) &&
375 pcie_caps_reg(dev
) & PCI_EXP_FLAGS_SLOT
;
378 bool pcie_cap_has_rtctl(const struct pci_dev
*dev
)
380 int type
= pci_pcie_type(dev
);
382 return type
== PCI_EXP_TYPE_ROOT_PORT
||
383 type
== PCI_EXP_TYPE_RC_EC
;
386 static bool pcie_capability_reg_implemented(struct pci_dev
*dev
, int pos
)
388 if (!pci_is_pcie(dev
))
401 return pcie_cap_has_lnkctl(dev
);
405 return pcie_cap_has_sltctl(dev
);
409 return pcie_cap_has_rtctl(dev
);
410 case PCI_EXP_DEVCAP2
:
411 case PCI_EXP_DEVCTL2
:
412 return pcie_cap_version(dev
) > 1;
413 case PCI_EXP_LNKCAP2
:
414 case PCI_EXP_LNKCTL2
:
415 case PCI_EXP_LNKSTA2
:
416 return pcie_cap_has_lnkctl2(dev
);
423 * Note that these accessor functions are only for the "PCI Express
424 * Capability" (see PCIe spec r3.0, sec 7.8). They do not apply to the
425 * other "PCI Express Extended Capabilities" (AER, VC, ACS, MFVC, etc.)
427 int pcie_capability_read_word(struct pci_dev
*dev
, int pos
, u16
*val
)
433 return PCIBIOS_BAD_REGISTER_NUMBER
;
435 if (pcie_capability_reg_implemented(dev
, pos
)) {
436 ret
= pci_read_config_word(dev
, pci_pcie_cap(dev
) + pos
, val
);
438 * Reset *val to 0 if pci_read_config_word() fails; it may
439 * have been written as 0xFFFF (PCI_ERROR_RESPONSE) if the
440 * config read failed on PCI.
448 * For Functions that do not implement the Slot Capabilities,
449 * Slot Status, and Slot Control registers, these spaces must
450 * be hardwired to 0b, with the exception of the Presence Detect
451 * State bit in the Slot Status register of Downstream Ports,
452 * which must be hardwired to 1b. (PCIe Base Spec 3.0, sec 7.8)
454 if (pci_is_pcie(dev
) && pcie_downstream_port(dev
) &&
455 pos
== PCI_EXP_SLTSTA
)
456 *val
= PCI_EXP_SLTSTA_PDS
;
460 EXPORT_SYMBOL(pcie_capability_read_word
);
462 int pcie_capability_read_dword(struct pci_dev
*dev
, int pos
, u32
*val
)
468 return PCIBIOS_BAD_REGISTER_NUMBER
;
470 if (pcie_capability_reg_implemented(dev
, pos
)) {
471 ret
= pci_read_config_dword(dev
, pci_pcie_cap(dev
) + pos
, val
);
473 * Reset *val to 0 if pci_read_config_dword() fails; it may
474 * have been written as 0xFFFFFFFF (PCI_ERROR_RESPONSE) if
475 * the config read failed on PCI.
482 if (pci_is_pcie(dev
) && pcie_downstream_port(dev
) &&
483 pos
== PCI_EXP_SLTSTA
)
484 *val
= PCI_EXP_SLTSTA_PDS
;
488 EXPORT_SYMBOL(pcie_capability_read_dword
);
490 int pcie_capability_write_word(struct pci_dev
*dev
, int pos
, u16 val
)
493 return PCIBIOS_BAD_REGISTER_NUMBER
;
495 if (!pcie_capability_reg_implemented(dev
, pos
))
498 return pci_write_config_word(dev
, pci_pcie_cap(dev
) + pos
, val
);
500 EXPORT_SYMBOL(pcie_capability_write_word
);
502 int pcie_capability_write_dword(struct pci_dev
*dev
, int pos
, u32 val
)
505 return PCIBIOS_BAD_REGISTER_NUMBER
;
507 if (!pcie_capability_reg_implemented(dev
, pos
))
510 return pci_write_config_dword(dev
, pci_pcie_cap(dev
) + pos
, val
);
512 EXPORT_SYMBOL(pcie_capability_write_dword
);
514 int pcie_capability_clear_and_set_word_unlocked(struct pci_dev
*dev
, int pos
,
520 ret
= pcie_capability_read_word(dev
, pos
, &val
);
526 return pcie_capability_write_word(dev
, pos
, val
);
528 EXPORT_SYMBOL(pcie_capability_clear_and_set_word_unlocked
);
530 int pcie_capability_clear_and_set_word_locked(struct pci_dev
*dev
, int pos
,
536 spin_lock_irqsave(&dev
->pcie_cap_lock
, flags
);
537 ret
= pcie_capability_clear_and_set_word_unlocked(dev
, pos
, clear
, set
);
538 spin_unlock_irqrestore(&dev
->pcie_cap_lock
, flags
);
542 EXPORT_SYMBOL(pcie_capability_clear_and_set_word_locked
);
544 int pcie_capability_clear_and_set_dword(struct pci_dev
*dev
, int pos
,
550 ret
= pcie_capability_read_dword(dev
, pos
, &val
);
556 return pcie_capability_write_dword(dev
, pos
, val
);
558 EXPORT_SYMBOL(pcie_capability_clear_and_set_dword
);
560 int pci_read_config_byte(const struct pci_dev
*dev
, int where
, u8
*val
)
562 if (pci_dev_is_disconnected(dev
)) {
563 PCI_SET_ERROR_RESPONSE(val
);
564 return PCIBIOS_DEVICE_NOT_FOUND
;
566 return pci_bus_read_config_byte(dev
->bus
, dev
->devfn
, where
, val
);
568 EXPORT_SYMBOL(pci_read_config_byte
);
570 int pci_read_config_word(const struct pci_dev
*dev
, int where
, u16
*val
)
572 if (pci_dev_is_disconnected(dev
)) {
573 PCI_SET_ERROR_RESPONSE(val
);
574 return PCIBIOS_DEVICE_NOT_FOUND
;
576 return pci_bus_read_config_word(dev
->bus
, dev
->devfn
, where
, val
);
578 EXPORT_SYMBOL(pci_read_config_word
);
580 int pci_read_config_dword(const struct pci_dev
*dev
, int where
,
583 if (pci_dev_is_disconnected(dev
)) {
584 PCI_SET_ERROR_RESPONSE(val
);
585 return PCIBIOS_DEVICE_NOT_FOUND
;
587 return pci_bus_read_config_dword(dev
->bus
, dev
->devfn
, where
, val
);
589 EXPORT_SYMBOL(pci_read_config_dword
);
591 int pci_write_config_byte(const struct pci_dev
*dev
, int where
, u8 val
)
593 if (pci_dev_is_disconnected(dev
))
594 return PCIBIOS_DEVICE_NOT_FOUND
;
595 return pci_bus_write_config_byte(dev
->bus
, dev
->devfn
, where
, val
);
597 EXPORT_SYMBOL(pci_write_config_byte
);
599 int pci_write_config_word(const struct pci_dev
*dev
, int where
, u16 val
)
601 if (pci_dev_is_disconnected(dev
))
602 return PCIBIOS_DEVICE_NOT_FOUND
;
603 return pci_bus_write_config_word(dev
->bus
, dev
->devfn
, where
, val
);
605 EXPORT_SYMBOL(pci_write_config_word
);
607 int pci_write_config_dword(const struct pci_dev
*dev
, int where
,
610 if (pci_dev_is_disconnected(dev
))
611 return PCIBIOS_DEVICE_NOT_FOUND
;
612 return pci_bus_write_config_dword(dev
->bus
, dev
->devfn
, where
, val
);
614 EXPORT_SYMBOL(pci_write_config_dword
);
616 void pci_clear_and_set_config_dword(const struct pci_dev
*dev
, int pos
,
621 pci_read_config_dword(dev
, pos
, &val
);
624 pci_write_config_dword(dev
, pos
, val
);
626 EXPORT_SYMBOL(pci_clear_and_set_config_dword
);