drivers/pci/access.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/pci.h>
   3 #include <linux/module.h>
   4 #include <linux/slab.h>
   5 #include <linux/ioport.h>
   6 #include <linux/wait.h>
   7
   8 #include "pci.h"
   9
  10 /*
  11  * This interrupt-safe spinlock protects all accesses to PCI
  12  * configuration space.
  13  */
  14
  15 DEFINE_RAW_SPINLOCK(pci_lock);
  16
  17 /*
  18  * Wrappers for all PCI configuration access functions.  They just check
  19  * alignment, do locking and call the low-level functions pointed to
  20  * by pci_dev->ops.
  21  */
  22
  23 #define PCI_byte_BAD 0
  24 #define PCI_word_BAD (pos & 1)
  25 #define PCI_dword_BAD (pos & 3)
  26
  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)
  30 #else
  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)
  33 #endif
  34
  35 #define PCI_OP_READ(size, type, len) \
  36 int pci_bus_read_config_##size \
  37         (struct pci_bus *bus, unsigned int devfn, int pos, type *value) \
  38 {                                                                       \
  39         int res;                                                        \
  40         unsigned long flags;                                            \
  41         u32 data = 0;                                                   \
  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);              \
  45         *value = (type)data;                                            \
  46         pci_unlock_config(flags);                                       \
  47         return res;                                                     \
  48 }
  49
  50 #define PCI_OP_WRITE(size, type, len) \
  51 int pci_bus_write_config_##size \
  52         (struct pci_bus *bus, unsigned int devfn, int pos, type value)  \
  53 {                                                                       \
  54         int res;                                                        \
  55         unsigned long flags;                                            \
  56         if (PCI_##size##_BAD) return PCIBIOS_BAD_REGISTER_NUMBER;       \
  57         pci_lock_config(flags);                                         \
  58         res = bus->ops->write(bus, devfn, pos, len, value);             \
  59         pci_unlock_config(flags);                                       \
  60         return res;                                                     \
  61 }
  62
  63 PCI_OP_READ(byte, u8, 1)
  64 PCI_OP_READ(word, u16, 2)
  65 PCI_OP_READ(dword, u32, 4)
  66 PCI_OP_WRITE(byte, u8, 1)
  67 PCI_OP_WRITE(word, u16, 2)
  68 PCI_OP_WRITE(dword, u32, 4)
  69
  70 EXPORT_SYMBOL(pci_bus_read_config_byte);
  71 EXPORT_SYMBOL(pci_bus_read_config_word);
  72 EXPORT_SYMBOL(pci_bus_read_config_dword);
  73 EXPORT_SYMBOL(pci_bus_write_config_byte);
  74 EXPORT_SYMBOL(pci_bus_write_config_word);
  75 EXPORT_SYMBOL(pci_bus_write_config_dword);
  76
  77 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
  78                             int where, int size, u32 *val)
  79 {
  80         void __iomem *addr;
  81
  82         addr = bus->ops->map_bus(bus, devfn, where);
  83         if (!addr) {
  84                 *val = ~0;
  85                 return PCIBIOS_DEVICE_NOT_FOUND;
  86         }
  87
  88         if (size == 1)
  89                 *val = readb(addr);
  90         else if (size == 2)
  91                 *val = readw(addr);
  92         else
  93                 *val = readl(addr);
  94
  95         return PCIBIOS_SUCCESSFUL;
  96 }
  97 EXPORT_SYMBOL_GPL(pci_generic_config_read);
  98
  99 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
 100                              int where, int size, u32 val)
 101 {
 102         void __iomem *addr;
 103
 104         addr = bus->ops->map_bus(bus, devfn, where);
 105         if (!addr)
 106                 return PCIBIOS_DEVICE_NOT_FOUND;
 107
 108         if (size == 1)
 109                 writeb(val, addr);
 110         else if (size == 2)
 111                 writew(val, addr);
 112         else
 113                 writel(val, addr);
 114
 115         return PCIBIOS_SUCCESSFUL;
 116 }
 117 EXPORT_SYMBOL_GPL(pci_generic_config_write);
 118
 119 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
 120                               int where, int size, u32 *val)
 121 {
 122         void __iomem *addr;
 123
 124         addr = bus->ops->map_bus(bus, devfn, where & ~0x3);
 125         if (!addr) {
 126                 *val = ~0;
 127                 return PCIBIOS_DEVICE_NOT_FOUND;
 128         }
 129
 130         *val = readl(addr);
 131
 132         if (size <= 2)
 133                 *val = (*val >> (8 * (where & 3))) & ((1 << (size * 8)) - 1);
 134
 135         return PCIBIOS_SUCCESSFUL;
 136 }
 137 EXPORT_SYMBOL_GPL(pci_generic_config_read32);
 138
 139 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
 140                                int where, int size, u32 val)
 141 {
 142         void __iomem *addr;
 143         u32 mask, tmp;
 144
 145         addr = bus->ops->map_bus(bus, devfn, where & ~0x3);
 146         if (!addr)
 147                 return PCIBIOS_DEVICE_NOT_FOUND;
 148
 149         if (size == 4) {
 150                 writel(val, addr);
 151                 return PCIBIOS_SUCCESSFUL;
 152         }
 153
 154         /*
 155          * In general, hardware that supports only 32-bit writes on PCI is
 156          * not spec-compliant.  For example, software may perform a 16-bit
 157          * write.  If the hardware only supports 32-bit accesses, we must
 158          * do a 32-bit read, merge in the 16 bits we intend to write,
 159          * followed by a 32-bit write.  If the 16 bits we *don't* intend to
 160          * write happen to have any RW1C (write-one-to-clear) bits set, we
 161          * just inadvertently cleared something we shouldn't have.
 162          */
 163         dev_warn_ratelimited(&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
 167         mask = ~(((1 << (size * 8)) - 1) << ((where & 0x3) * 8));
 168         tmp = readl(addr) & mask;
 169         tmp |= val << ((where & 0x3) * 8);
 170         writel(tmp, addr);
 171
 172         return PCIBIOS_SUCCESSFUL;
 173 }
 174 EXPORT_SYMBOL_GPL(pci_generic_config_write32);
 175
 176 /**
 177  * pci_bus_set_ops - Set raw operations of pci bus
 178  * @bus:        pci bus struct
 179  * @ops:        new raw operations
 180  *
 181  * Return previous raw operations
 182  */
 183 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops)
 184 {
 185         struct pci_ops *old_ops;
 186         unsigned long flags;
 187
 188         raw_spin_lock_irqsave(&pci_lock, flags);
 189         old_ops = bus->ops;
 190         bus->ops = ops;
 191         raw_spin_unlock_irqrestore(&pci_lock, flags);
 192         return old_ops;
 193 }
 194 EXPORT_SYMBOL(pci_bus_set_ops);
 195
 196 /*
 197  * The following routines are to prevent the user from accessing PCI config
 198  * space when it's unsafe to do so.  Some devices require this during BIST and
 199  * we're required to prevent it during D-state transitions.
 200  *
 201  * We have a bit per device to indicate it's blocked and a global wait queue
 202  * for callers to sleep on until devices are unblocked.
 203  */
 204 static DECLARE_WAIT_QUEUE_HEAD(pci_cfg_wait);
 205
 206 static noinline void pci_wait_cfg(struct pci_dev *dev)
 207         __must_hold(&pci_lock)
 208 {
 209         do {
 210                 raw_spin_unlock_irq(&pci_lock);
 211                 wait_event(pci_cfg_wait, !dev->block_cfg_access);
 212                 raw_spin_lock_irq(&pci_lock);
 213         } while (dev->block_cfg_access);
 214 }
 215
 216 /* Returns 0 on success, negative values indicate error. */
 217 #define PCI_USER_READ_CONFIG(size, type)                                        \
 218 int pci_user_read_config_##size                                         \
 219         (struct pci_dev *dev, int pos, type *val)                       \
 220 {                                                                       \
 221         int ret = PCIBIOS_SUCCESSFUL;                                   \
 222         u32 data = -1;                                                  \
 223         if (PCI_##size##_BAD)                                           \
 224                 return -EINVAL;                                         \
 225         raw_spin_lock_irq(&pci_lock);                           \
 226         if (unlikely(dev->block_cfg_access))                            \
 227                 pci_wait_cfg(dev);                                      \
 228         ret = dev->bus->ops->read(dev->bus, dev->devfn,                 \
 229                                         pos, sizeof(type), &data);      \
 230         raw_spin_unlock_irq(&pci_lock);                         \
 231         *val = (type)data;                                              \
 232         return pcibios_err_to_errno(ret);                               \
 233 }                                                                       \
 234 EXPORT_SYMBOL_GPL(pci_user_read_config_##size);
 235
 236 /* Returns 0 on success, negative values indicate error. */
 237 #define PCI_USER_WRITE_CONFIG(size, type)                               \
 238 int pci_user_write_config_##size                                        \
 239         (struct pci_dev *dev, int pos, type val)                        \
 240 {                                                                       \
 241         int ret = PCIBIOS_SUCCESSFUL;                                   \
 242         if (PCI_##size##_BAD)                                           \
 243                 return -EINVAL;                                         \
 244         raw_spin_lock_irq(&pci_lock);                           \
 245         if (unlikely(dev->block_cfg_access))                            \
 246                 pci_wait_cfg(dev);                                      \
 247         ret = dev->bus->ops->write(dev->bus, dev->devfn,                \
 248                                         pos, sizeof(type), val);        \
 249         raw_spin_unlock_irq(&pci_lock);                         \
 250         return pcibios_err_to_errno(ret);                               \
 251 }                                                                       \
 252 EXPORT_SYMBOL_GPL(pci_user_write_config_##size);
 253
 254 PCI_USER_READ_CONFIG(byte, u8)
 255 PCI_USER_READ_CONFIG(word, u16)
 256 PCI_USER_READ_CONFIG(dword, u32)
 257 PCI_USER_WRITE_CONFIG(byte, u8)
 258 PCI_USER_WRITE_CONFIG(word, u16)
 259 PCI_USER_WRITE_CONFIG(dword, u32)
 260
 261 /**
 262  * pci_cfg_access_lock - Lock PCI config reads/writes
 263  * @dev:        pci device struct
 264  *
 265  * When access is locked, any userspace reads or writes to config
 266  * space and concurrent lock requests will sleep until access is
 267  * allowed via pci_cfg_access_unlock() again.
 268  */
 269 void pci_cfg_access_lock(struct pci_dev *dev)
 270 {
 271         might_sleep();
 272
 273         raw_spin_lock_irq(&pci_lock);
 274         if (dev->block_cfg_access)
 275                 pci_wait_cfg(dev);
 276         dev->block_cfg_access = 1;
 277         raw_spin_unlock_irq(&pci_lock);
 278 }
 279 EXPORT_SYMBOL_GPL(pci_cfg_access_lock);
 280
 281 /**
 282  * pci_cfg_access_trylock - try to lock PCI config reads/writes
 283  * @dev:        pci device struct
 284  *
 285  * Same as pci_cfg_access_lock, but will return 0 if access is
 286  * already locked, 1 otherwise. This function can be used from
 287  * atomic contexts.
 288  */
 289 bool pci_cfg_access_trylock(struct pci_dev *dev)
 290 {
 291         unsigned long flags;
 292         bool locked = true;
 293
 294         raw_spin_lock_irqsave(&pci_lock, flags);
 295         if (dev->block_cfg_access)
 296                 locked = false;
 297         else
 298                 dev->block_cfg_access = 1;
 299         raw_spin_unlock_irqrestore(&pci_lock, flags);
 300
 301         return locked;
 302 }
 303 EXPORT_SYMBOL_GPL(pci_cfg_access_trylock);
 304
 305 /**
 306  * pci_cfg_access_unlock - Unlock PCI config reads/writes
 307  * @dev:        pci device struct
 308  *
 309  * This function allows PCI config accesses to resume.
 310  */
 311 void pci_cfg_access_unlock(struct pci_dev *dev)
 312 {
 313         unsigned long flags;
 314
 315         raw_spin_lock_irqsave(&pci_lock, flags);
 316
 317         /*
 318          * This indicates a problem in the caller, but we don't need
 319          * to kill them, unlike a double-block above.
 320          */
 321         WARN_ON(!dev->block_cfg_access);
 322
 323         dev->block_cfg_access = 0;
 324         raw_spin_unlock_irqrestore(&pci_lock, flags);
 325
 326         wake_up_all(&pci_cfg_wait);
 327 }
 328 EXPORT_SYMBOL_GPL(pci_cfg_access_unlock);
 329
 330 static inline int pcie_cap_version(const struct pci_dev *dev)
 331 {
 332         return pcie_caps_reg(dev) & PCI_EXP_FLAGS_VERS;
 333 }
 334
 335 static bool pcie_downstream_port(const struct pci_dev *dev)
 336 {
 337         int type = pci_pcie_type(dev);
 338
 339         return type == PCI_EXP_TYPE_ROOT_PORT ||
 340                type == PCI_EXP_TYPE_DOWNSTREAM ||
 341                type == PCI_EXP_TYPE_PCIE_BRIDGE;
 342 }
 343
 344 bool pcie_cap_has_lnkctl(const struct pci_dev *dev)
 345 {
 346         int type = pci_pcie_type(dev);
 347
 348         return type == PCI_EXP_TYPE_ENDPOINT ||
 349                type == PCI_EXP_TYPE_LEG_END ||
 350                type == PCI_EXP_TYPE_ROOT_PORT ||
 351                type == PCI_EXP_TYPE_UPSTREAM ||
 352                type == PCI_EXP_TYPE_DOWNSTREAM ||
 353                type == PCI_EXP_TYPE_PCI_BRIDGE ||
 354                type == PCI_EXP_TYPE_PCIE_BRIDGE;
 355 }
 356
 357 static inline bool pcie_cap_has_sltctl(const struct pci_dev *dev)
 358 {
 359         return pcie_downstream_port(dev) &&
 360                pcie_caps_reg(dev) & PCI_EXP_FLAGS_SLOT;
 361 }
 362
 363 static inline bool pcie_cap_has_rtctl(const struct pci_dev *dev)
 364 {
 365         int type = pci_pcie_type(dev);
 366
 367         return type == PCI_EXP_TYPE_ROOT_PORT ||
 368                type == PCI_EXP_TYPE_RC_EC;
 369 }
 370
 371 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos)
 372 {
 373         if (!pci_is_pcie(dev))
 374                 return false;
 375
 376         switch (pos) {
 377         case PCI_EXP_FLAGS:
 378                 return true;
 379         case PCI_EXP_DEVCAP:
 380         case PCI_EXP_DEVCTL:
 381         case PCI_EXP_DEVSTA:
 382                 return true;
 383         case PCI_EXP_LNKCAP:
 384         case PCI_EXP_LNKCTL:
 385         case PCI_EXP_LNKSTA:
 386                 return pcie_cap_has_lnkctl(dev);
 387         case PCI_EXP_SLTCAP:
 388         case PCI_EXP_SLTCTL:
 389         case PCI_EXP_SLTSTA:
 390                 return pcie_cap_has_sltctl(dev);
 391         case PCI_EXP_RTCTL:
 392         case PCI_EXP_RTCAP:
 393         case PCI_EXP_RTSTA:
 394                 return pcie_cap_has_rtctl(dev);
 395         case PCI_EXP_DEVCAP2:
 396         case PCI_EXP_DEVCTL2:
 397         case PCI_EXP_LNKCAP2:
 398         case PCI_EXP_LNKCTL2:
 399         case PCI_EXP_LNKSTA2:
 400                 return pcie_cap_version(dev) > 1;
 401         default:
 402                 return false;
 403         }
 404 }
 405
 406 /*
 407  * Note that these accessor functions are only for the "PCI Express
 408  * Capability" (see PCIe spec r3.0, sec 7.8).  They do not apply to the
 409  * other "PCI Express Extended Capabilities" (AER, VC, ACS, MFVC, etc.)
 410  */
 411 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val)
 412 {
 413         int ret;
 414
 415         *val = 0;
 416         if (pos & 1)
 417                 return -EINVAL;
 418
 419         if (pcie_capability_reg_implemented(dev, pos)) {
 420                 ret = pci_read_config_word(dev, pci_pcie_cap(dev) + pos, val);
 421                 /*
 422                  * Reset *val to 0 if pci_read_config_word() fails, it may
 423                  * have been written as 0xFFFF if hardware error happens
 424                  * during pci_read_config_word().
 425                  */
 426                 if (ret)
 427                         *val = 0;
 428                 return ret;
 429         }
 430
 431         /*
 432          * For Functions that do not implement the Slot Capabilities,
 433          * Slot Status, and Slot Control registers, these spaces must
 434          * be hardwired to 0b, with the exception of the Presence Detect
 435          * State bit in the Slot Status register of Downstream Ports,
 436          * which must be hardwired to 1b.  (PCIe Base Spec 3.0, sec 7.8)
 437          */
 438         if (pci_is_pcie(dev) && pcie_downstream_port(dev) &&
 439             pos == PCI_EXP_SLTSTA)
 440                 *val = PCI_EXP_SLTSTA_PDS;
 441
 442         return 0;
 443 }
 444 EXPORT_SYMBOL(pcie_capability_read_word);
 445
 446 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val)
 447 {
 448         int ret;
 449
 450         *val = 0;
 451         if (pos & 3)
 452                 return -EINVAL;
 453
 454         if (pcie_capability_reg_implemented(dev, pos)) {
 455                 ret = pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, val);
 456                 /*
 457                  * Reset *val to 0 if pci_read_config_dword() fails, it may
 458                  * have been written as 0xFFFFFFFF if hardware error happens
 459                  * during pci_read_config_dword().
 460                  */
 461                 if (ret)
 462                         *val = 0;
 463                 return ret;
 464         }
 465
 466         if (pci_is_pcie(dev) && pcie_downstream_port(dev) &&
 467             pos == PCI_EXP_SLTSTA)
 468                 *val = PCI_EXP_SLTSTA_PDS;
 469
 470         return 0;
 471 }
 472 EXPORT_SYMBOL(pcie_capability_read_dword);
 473
 474 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val)
 475 {
 476         if (pos & 1)
 477                 return -EINVAL;
 478
 479         if (!pcie_capability_reg_implemented(dev, pos))
 480                 return 0;
 481
 482         return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val);
 483 }
 484 EXPORT_SYMBOL(pcie_capability_write_word);
 485
 486 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val)
 487 {
 488         if (pos & 3)
 489                 return -EINVAL;
 490
 491         if (!pcie_capability_reg_implemented(dev, pos))
 492                 return 0;
 493
 494         return pci_write_config_dword(dev, pci_pcie_cap(dev) + pos, val);
 495 }
 496 EXPORT_SYMBOL(pcie_capability_write_dword);
 497
 498 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
 499                                        u16 clear, u16 set)
 500 {
 501         int ret;
 502         u16 val;
 503
 504         ret = pcie_capability_read_word(dev, pos, &val);
 505         if (!ret) {
 506                 val &= ~clear;
 507                 val |= set;
 508                 ret = pcie_capability_write_word(dev, pos, val);
 509         }
 510
 511         return ret;
 512 }
 513 EXPORT_SYMBOL(pcie_capability_clear_and_set_word);
 514
 515 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
 516                                         u32 clear, u32 set)
 517 {
 518         int ret;
 519         u32 val;
 520
 521         ret = pcie_capability_read_dword(dev, pos, &val);
 522         if (!ret) {
 523                 val &= ~clear;
 524                 val |= set;
 525                 ret = pcie_capability_write_dword(dev, pos, val);
 526         }
 527
 528         return ret;
 529 }
 530 EXPORT_SYMBOL(pcie_capability_clear_and_set_dword);
 531
 532 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
 533 {
 534         if (pci_dev_is_disconnected(dev)) {
 535                 *val = ~0;
 536                 return PCIBIOS_DEVICE_NOT_FOUND;
 537         }
 538         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
 539 }
 540 EXPORT_SYMBOL(pci_read_config_byte);
 541
 542 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
 543 {
 544         if (pci_dev_is_disconnected(dev)) {
 545                 *val = ~0;
 546                 return PCIBIOS_DEVICE_NOT_FOUND;
 547         }
 548         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
 549 }
 550 EXPORT_SYMBOL(pci_read_config_word);
 551
 552 int pci_read_config_dword(const struct pci_dev *dev, int where,
 553                                         u32 *val)
 554 {
 555         if (pci_dev_is_disconnected(dev)) {
 556                 *val = ~0;
 557                 return PCIBIOS_DEVICE_NOT_FOUND;
 558         }
 559         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
 560 }
 561 EXPORT_SYMBOL(pci_read_config_dword);
 562
 563 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
 564 {
 565         if (pci_dev_is_disconnected(dev))
 566                 return PCIBIOS_DEVICE_NOT_FOUND;
 567         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
 568 }
 569 EXPORT_SYMBOL(pci_write_config_byte);
 570
 571 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
 572 {
 573         if (pci_dev_is_disconnected(dev))
 574                 return PCIBIOS_DEVICE_NOT_FOUND;
 575         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
 576 }
 577 EXPORT_SYMBOL(pci_write_config_word);
 578
 579 int pci_write_config_dword(const struct pci_dev *dev, int where,
 580                                          u32 val)
 581 {
 582         if (pci_dev_is_disconnected(dev))
 583                 return PCIBIOS_DEVICE_NOT_FOUND;
 584         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
 585 }
 586 EXPORT_SYMBOL(pci_write_config_dword);