1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * pci.h 4 * 5 * PCI defines and function prototypes 6 * Copyright 1994, Drew Eckhardt 7 * Copyright 1997--1999 Martin Mares <[email protected]> 8 * 9 * PCI Express ASPM defines and function prototypes 10 * Copyright (c) 2007 Intel Corp. 11 * Zhang Yanmin ([email protected]) 12 * Shaohua Li ([email protected]) 13 * 14 * For more information, please consult the following manuals (look at 15 * http://www.pcisig.com/ for how to get them): 16 * 17 * PCI BIOS Specification 18 * PCI Local Bus Specification 19 * PCI to PCI Bridge Specification 20 * PCI Express Specification 21 * PCI System Design Guide 22 */ 23 #ifndef LINUX_PCI_H 24 #define LINUX_PCI_H 25 26 27 #include <linux/mod_devicetable.h> 28 29 #include <linux/types.h> 30 #include <linux/init.h> 31 #include <linux/ioport.h> 32 #include <linux/list.h> 33 #include <linux/compiler.h> 34 #include <linux/errno.h> 35 #include <linux/kobject.h> 36 #include <linux/atomic.h> 37 #include <linux/device.h> 38 #include <linux/interrupt.h> 39 #include <linux/io.h> 40 #include <linux/resource_ext.h> 41 #include <uapi/linux/pci.h> 42 43 #include <linux/pci_ids.h> 44 45 #define PCI_STATUS_ERROR_BITS (PCI_STATUS_DETECTED_PARITY | \ 46 PCI_STATUS_SIG_SYSTEM_ERROR | \ 47 PCI_STATUS_REC_MASTER_ABORT | \ 48 PCI_STATUS_REC_TARGET_ABORT | \ 49 PCI_STATUS_SIG_TARGET_ABORT | \ 50 PCI_STATUS_PARITY) 51 52 /* 53 * The PCI interface treats multi-function devices as independent 54 * devices. The slot/function address of each device is encoded 55 * in a single byte as follows: 56 * 57 * 7:3 = slot 58 * 2:0 = function 59 * 60 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h. 61 * In the interest of not exposing interfaces to user-space unnecessarily, 62 * the following kernel-only defines are being added here. 63 */ 64 #define PCI_DEVID(bus, devfn) ((((u16)(bus)) << 8) | (devfn)) 65 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */ 66 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff) 67 68 /* pci_slot represents a physical slot */ 69 struct pci_slot { 70 struct pci_bus *bus; /* Bus this slot is on */ 71 struct list_head list; /* Node in list of slots */ 72 struct hotplug_slot *hotplug; /* Hotplug info (move here) */ 73 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */ 74 struct kobject kobj; 75 }; 76 77 static inline const char *pci_slot_name(const struct pci_slot *slot) 78 { 79 return kobject_name(&slot->kobj); 80 } 81 82 /* File state for mmap()s on /proc/bus/pci/X/Y */ 83 enum pci_mmap_state { 84 pci_mmap_io, 85 pci_mmap_mem 86 }; 87 88 /* For PCI devices, the region numbers are assigned this way: */ 89 enum { 90 /* #0-5: standard PCI resources */ 91 PCI_STD_RESOURCES, 92 PCI_STD_RESOURCE_END = PCI_STD_RESOURCES + PCI_STD_NUM_BARS - 1, 93 94 /* #6: expansion ROM resource */ 95 PCI_ROM_RESOURCE, 96 97 /* Device-specific resources */ 98 #ifdef CONFIG_PCI_IOV 99 PCI_IOV_RESOURCES, 100 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1, 101 #endif 102 103 /* PCI-to-PCI (P2P) bridge windows */ 104 #define PCI_BRIDGE_IO_WINDOW (PCI_BRIDGE_RESOURCES + 0) 105 #define PCI_BRIDGE_MEM_WINDOW (PCI_BRIDGE_RESOURCES + 1) 106 #define PCI_BRIDGE_PREF_MEM_WINDOW (PCI_BRIDGE_RESOURCES + 2) 107 108 /* CardBus bridge windows */ 109 #define PCI_CB_BRIDGE_IO_0_WINDOW (PCI_BRIDGE_RESOURCES + 0) 110 #define PCI_CB_BRIDGE_IO_1_WINDOW (PCI_BRIDGE_RESOURCES + 1) 111 #define PCI_CB_BRIDGE_MEM_0_WINDOW (PCI_BRIDGE_RESOURCES + 2) 112 #define PCI_CB_BRIDGE_MEM_1_WINDOW (PCI_BRIDGE_RESOURCES + 3) 113 114 /* Total number of bridge resources for P2P and CardBus */ 115 #define PCI_BRIDGE_RESOURCE_NUM 4 116 117 /* Resources assigned to buses behind the bridge */ 118 PCI_BRIDGE_RESOURCES, 119 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES + 120 PCI_BRIDGE_RESOURCE_NUM - 1, 121 122 /* Total resources associated with a PCI device */ 123 PCI_NUM_RESOURCES, 124 125 /* Preserve this for compatibility */ 126 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES, 127 }; 128 129 /** 130 * enum pci_interrupt_pin - PCI INTx interrupt values 131 * @PCI_INTERRUPT_UNKNOWN: Unknown or unassigned interrupt 132 * @PCI_INTERRUPT_INTA: PCI INTA pin 133 * @PCI_INTERRUPT_INTB: PCI INTB pin 134 * @PCI_INTERRUPT_INTC: PCI INTC pin 135 * @PCI_INTERRUPT_INTD: PCI INTD pin 136 * 137 * Corresponds to values for legacy PCI INTx interrupts, as can be found in the 138 * PCI_INTERRUPT_PIN register. 139 */ 140 enum pci_interrupt_pin { 141 PCI_INTERRUPT_UNKNOWN, 142 PCI_INTERRUPT_INTA, 143 PCI_INTERRUPT_INTB, 144 PCI_INTERRUPT_INTC, 145 PCI_INTERRUPT_INTD, 146 }; 147 148 /* The number of legacy PCI INTx interrupts */ 149 #define PCI_NUM_INTX 4 150 151 /* 152 * pci_power_t values must match the bits in the Capabilities PME_Support 153 * and Control/Status PowerState fields in the Power Management capability. 154 */ 155 typedef int __bitwise pci_power_t; 156 157 #define PCI_D0 ((pci_power_t __force) 0) 158 #define PCI_D1 ((pci_power_t __force) 1) 159 #define PCI_D2 ((pci_power_t __force) 2) 160 #define PCI_D3hot ((pci_power_t __force) 3) 161 #define PCI_D3cold ((pci_power_t __force) 4) 162 #define PCI_UNKNOWN ((pci_power_t __force) 5) 163 #define PCI_POWER_ERROR ((pci_power_t __force) -1) 164 165 /* Remember to update this when the list above changes! */ 166 extern const char *pci_power_names[]; 167 168 static inline const char *pci_power_name(pci_power_t state) 169 { 170 return pci_power_names[1 + (__force int) state]; 171 } 172 173 /** 174 * typedef pci_channel_state_t 175 * 176 * The pci_channel state describes connectivity between the CPU and 177 * the PCI device. If some PCI bus between here and the PCI device 178 * has crashed or locked up, this info is reflected here. 179 */ 180 typedef unsigned int __bitwise pci_channel_state_t; 181 182 enum { 183 /* I/O channel is in normal state */ 184 pci_channel_io_normal = (__force pci_channel_state_t) 1, 185 186 /* I/O to channel is blocked */ 187 pci_channel_io_frozen = (__force pci_channel_state_t) 2, 188 189 /* PCI card is dead */ 190 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3, 191 }; 192 193 typedef unsigned int __bitwise pcie_reset_state_t; 194 195 enum pcie_reset_state { 196 /* Reset is NOT asserted (Use to deassert reset) */ 197 pcie_deassert_reset = (__force pcie_reset_state_t) 1, 198 199 /* Use #PERST to reset PCIe device */ 200 pcie_warm_reset = (__force pcie_reset_state_t) 2, 201 202 /* Use PCIe Hot Reset to reset device */ 203 pcie_hot_reset = (__force pcie_reset_state_t) 3 204 }; 205 206 typedef unsigned short __bitwise pci_dev_flags_t; 207 enum pci_dev_flags { 208 /* INTX_DISABLE in PCI_COMMAND register disables MSI too */ 209 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0), 210 /* Device configuration is irrevocably lost if disabled into D3 */ 211 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1), 212 /* Provide indication device is assigned by a Virtual Machine Manager */ 213 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2), 214 /* Flag for quirk use to store if quirk-specific ACS is enabled */ 215 PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3), 216 /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */ 217 PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5), 218 /* Do not use bus resets for device */ 219 PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6), 220 /* Do not use PM reset even if device advertises NoSoftRst- */ 221 PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7), 222 /* Get VPD from function 0 VPD */ 223 PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8), 224 /* A non-root bridge where translation occurs, stop alias search here */ 225 PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9), 226 /* Do not use FLR even if device advertises PCI_AF_CAP */ 227 PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10), 228 /* Don't use Relaxed Ordering for TLPs directed at this device */ 229 PCI_DEV_FLAGS_NO_RELAXED_ORDERING = (__force pci_dev_flags_t) (1 << 11), 230 }; 231 232 enum pci_irq_reroute_variant { 233 INTEL_IRQ_REROUTE_VARIANT = 1, 234 MAX_IRQ_REROUTE_VARIANTS = 3 235 }; 236 237 typedef unsigned short __bitwise pci_bus_flags_t; 238 enum pci_bus_flags { 239 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1, 240 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2, 241 PCI_BUS_FLAGS_NO_AERSID = (__force pci_bus_flags_t) 4, 242 PCI_BUS_FLAGS_NO_EXTCFG = (__force pci_bus_flags_t) 8, 243 }; 244 245 /* Values from Link Status register, PCIe r3.1, sec 7.8.8 */ 246 enum pcie_link_width { 247 PCIE_LNK_WIDTH_RESRV = 0x00, 248 PCIE_LNK_X1 = 0x01, 249 PCIE_LNK_X2 = 0x02, 250 PCIE_LNK_X4 = 0x04, 251 PCIE_LNK_X8 = 0x08, 252 PCIE_LNK_X12 = 0x0c, 253 PCIE_LNK_X16 = 0x10, 254 PCIE_LNK_X32 = 0x20, 255 PCIE_LNK_WIDTH_UNKNOWN = 0xff, 256 }; 257 258 /* See matching string table in pci_speed_string() */ 259 enum pci_bus_speed { 260 PCI_SPEED_33MHz = 0x00, 261 PCI_SPEED_66MHz = 0x01, 262 PCI_SPEED_66MHz_PCIX = 0x02, 263 PCI_SPEED_100MHz_PCIX = 0x03, 264 PCI_SPEED_133MHz_PCIX = 0x04, 265 PCI_SPEED_66MHz_PCIX_ECC = 0x05, 266 PCI_SPEED_100MHz_PCIX_ECC = 0x06, 267 PCI_SPEED_133MHz_PCIX_ECC = 0x07, 268 PCI_SPEED_66MHz_PCIX_266 = 0x09, 269 PCI_SPEED_100MHz_PCIX_266 = 0x0a, 270 PCI_SPEED_133MHz_PCIX_266 = 0x0b, 271 AGP_UNKNOWN = 0x0c, 272 AGP_1X = 0x0d, 273 AGP_2X = 0x0e, 274 AGP_4X = 0x0f, 275 AGP_8X = 0x10, 276 PCI_SPEED_66MHz_PCIX_533 = 0x11, 277 PCI_SPEED_100MHz_PCIX_533 = 0x12, 278 PCI_SPEED_133MHz_PCIX_533 = 0x13, 279 PCIE_SPEED_2_5GT = 0x14, 280 PCIE_SPEED_5_0GT = 0x15, 281 PCIE_SPEED_8_0GT = 0x16, 282 PCIE_SPEED_16_0GT = 0x17, 283 PCIE_SPEED_32_0GT = 0x18, 284 PCIE_SPEED_64_0GT = 0x19, 285 PCI_SPEED_UNKNOWN = 0xff, 286 }; 287 288 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev); 289 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev); 290 291 struct pci_cap_saved_data { 292 u16 cap_nr; 293 bool cap_extended; 294 unsigned int size; 295 u32 data[]; 296 }; 297 298 struct pci_cap_saved_state { 299 struct hlist_node next; 300 struct pci_cap_saved_data cap; 301 }; 302 303 struct irq_affinity; 304 struct pcie_link_state; 305 struct pci_vpd; 306 struct pci_sriov; 307 struct pci_p2pdma; 308 struct rcec_ea; 309 310 /* The pci_dev structure describes PCI devices */ 311 struct pci_dev { 312 struct list_head bus_list; /* Node in per-bus list */ 313 struct pci_bus *bus; /* Bus this device is on */ 314 struct pci_bus *subordinate; /* Bus this device bridges to */ 315 316 void *sysdata; /* Hook for sys-specific extension */ 317 struct proc_dir_entry *procent; /* Device entry in /proc/bus/pci */ 318 struct pci_slot *slot; /* Physical slot this device is in */ 319 320 unsigned int devfn; /* Encoded device & function index */ 321 unsigned short vendor; 322 unsigned short device; 323 unsigned short subsystem_vendor; 324 unsigned short subsystem_device; 325 unsigned int class; /* 3 bytes: (base,sub,prog-if) */ 326 u8 revision; /* PCI revision, low byte of class word */ 327 u8 hdr_type; /* PCI header type (`multi' flag masked out) */ 328 #ifdef CONFIG_PCIEAER 329 u16 aer_cap; /* AER capability offset */ 330 struct aer_stats *aer_stats; /* AER stats for this device */ 331 #endif 332 #ifdef CONFIG_PCIEPORTBUS 333 struct rcec_ea *rcec_ea; /* RCEC cached endpoint association */ 334 struct pci_dev *rcec; /* Associated RCEC device */ 335 #endif 336 u8 pcie_cap; /* PCIe capability offset */ 337 u8 msi_cap; /* MSI capability offset */ 338 u8 msix_cap; /* MSI-X capability offset */ 339 u8 pcie_mpss:3; /* PCIe Max Payload Size Supported */ 340 u8 rom_base_reg; /* Config register controlling ROM */ 341 u8 pin; /* Interrupt pin this device uses */ 342 u16 pcie_flags_reg; /* Cached PCIe Capabilities Register */ 343 unsigned long *dma_alias_mask;/* Mask of enabled devfn aliases */ 344 345 struct pci_driver *driver; /* Driver bound to this device */ 346 u64 dma_mask; /* Mask of the bits of bus address this 347 device implements. Normally this is 348 0xffffffff. You only need to change 349 this if your device has broken DMA 350 or supports 64-bit transfers. */ 351 352 struct device_dma_parameters dma_parms; 353 354 pci_power_t current_state; /* Current operating state. In ACPI, 355 this is D0-D3, D0 being fully 356 functional, and D3 being off. */ 357 unsigned int imm_ready:1; /* Supports Immediate Readiness */ 358 u8 pm_cap; /* PM capability offset */ 359 unsigned int pme_support:5; /* Bitmask of states from which PME# 360 can be generated */ 361 unsigned int pme_poll:1; /* Poll device's PME status bit */ 362 unsigned int d1_support:1; /* Low power state D1 is supported */ 363 unsigned int d2_support:1; /* Low power state D2 is supported */ 364 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */ 365 unsigned int no_d3cold:1; /* D3cold is forbidden */ 366 unsigned int bridge_d3:1; /* Allow D3 for bridge */ 367 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */ 368 unsigned int mmio_always_on:1; /* Disallow turning off io/mem 369 decoding during BAR sizing */ 370 unsigned int wakeup_prepared:1; 371 unsigned int runtime_d3cold:1; /* Whether go through runtime 372 D3cold, not set for devices 373 powered on/off by the 374 corresponding bridge */ 375 unsigned int skip_bus_pm:1; /* Internal: Skip bus-level PM */ 376 unsigned int ignore_hotplug:1; /* Ignore hotplug events */ 377 unsigned int hotplug_user_indicators:1; /* SlotCtl indicators 378 controlled exclusively by 379 user sysfs */ 380 unsigned int clear_retrain_link:1; /* Need to clear Retrain Link 381 bit manually */ 382 unsigned int d3hot_delay; /* D3hot->D0 transition time in ms */ 383 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */ 384 385 #ifdef CONFIG_PCIEASPM 386 struct pcie_link_state *link_state; /* ASPM link state */ 387 unsigned int ltr_path:1; /* Latency Tolerance Reporting 388 supported from root to here */ 389 u16 l1ss; /* L1SS Capability pointer */ 390 #endif 391 unsigned int eetlp_prefix_path:1; /* End-to-End TLP Prefix */ 392 393 pci_channel_state_t error_state; /* Current connectivity state */ 394 struct device dev; /* Generic device interface */ 395 396 int cfg_size; /* Size of config space */ 397 398 /* 399 * Instead of touching interrupt line and base address registers 400 * directly, use the values stored here. They might be different! 401 */ 402 unsigned int irq; 403 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */ 404 405 bool match_driver; /* Skip attaching driver */ 406 407 unsigned int transparent:1; /* Subtractive decode bridge */ 408 unsigned int io_window:1; /* Bridge has I/O window */ 409 unsigned int pref_window:1; /* Bridge has pref mem window */ 410 unsigned int pref_64_window:1; /* Pref mem window is 64-bit */ 411 unsigned int multifunction:1; /* Multi-function device */ 412 413 unsigned int is_busmaster:1; /* Is busmaster */ 414 unsigned int no_msi:1; /* May not use MSI */ 415 unsigned int no_64bit_msi:1; /* May only use 32-bit MSIs */ 416 unsigned int block_cfg_access:1; /* Config space access blocked */ 417 unsigned int broken_parity_status:1; /* Generates false positive parity */ 418 unsigned int irq_reroute_variant:2; /* Needs IRQ rerouting variant */ 419 unsigned int msi_enabled:1; 420 unsigned int msix_enabled:1; 421 unsigned int ari_enabled:1; /* ARI forwarding */ 422 unsigned int ats_enabled:1; /* Address Translation Svc */ 423 unsigned int pasid_enabled:1; /* Process Address Space ID */ 424 unsigned int pri_enabled:1; /* Page Request Interface */ 425 unsigned int is_managed:1; 426 unsigned int needs_freset:1; /* Requires fundamental reset */ 427 unsigned int state_saved:1; 428 unsigned int is_physfn:1; 429 unsigned int is_virtfn:1; 430 unsigned int reset_fn:1; 431 unsigned int is_hotplug_bridge:1; 432 unsigned int shpc_managed:1; /* SHPC owned by shpchp */ 433 unsigned int is_thunderbolt:1; /* Thunderbolt controller */ 434 /* 435 * Devices marked being untrusted are the ones that can potentially 436 * execute DMA attacks and similar. They are typically connected 437 * through external ports such as Thunderbolt but not limited to 438 * that. When an IOMMU is enabled they should be getting full 439 * mappings to make sure they cannot access arbitrary memory. 440 */ 441 unsigned int untrusted:1; 442 /* 443 * Info from the platform, e.g., ACPI or device tree, may mark a 444 * device as "external-facing". An external-facing device is 445 * itself internal but devices downstream from it are external. 446 */ 447 unsigned int external_facing:1; 448 unsigned int broken_intx_masking:1; /* INTx masking can't be used */ 449 unsigned int io_window_1k:1; /* Intel bridge 1K I/O windows */ 450 unsigned int irq_managed:1; 451 unsigned int non_compliant_bars:1; /* Broken BARs; ignore them */ 452 unsigned int is_probed:1; /* Device probing in progress */ 453 unsigned int link_active_reporting:1;/* Device capable of reporting link active */ 454 unsigned int no_vf_scan:1; /* Don't scan for VFs after IOV enablement */ 455 unsigned int no_command_memory:1; /* No PCI_COMMAND_MEMORY */ 456 pci_dev_flags_t dev_flags; 457 atomic_t enable_cnt; /* pci_enable_device has been called */ 458 459 u32 saved_config_space[16]; /* Config space saved at suspend time */ 460 struct hlist_head saved_cap_space; 461 int rom_attr_enabled; /* Display of ROM attribute enabled? */ 462 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */ 463 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */ 464 465 #ifdef CONFIG_HOTPLUG_PCI_PCIE 466 unsigned int broken_cmd_compl:1; /* No compl for some cmds */ 467 #endif 468 #ifdef CONFIG_PCIE_PTM 469 unsigned int ptm_root:1; 470 unsigned int ptm_enabled:1; 471 u8 ptm_granularity; 472 #endif 473 #ifdef CONFIG_PCI_MSI 474 const struct attribute_group **msi_irq_groups; 475 #endif 476 struct pci_vpd *vpd; 477 #ifdef CONFIG_PCIE_DPC 478 u16 dpc_cap; 479 unsigned int dpc_rp_extensions:1; 480 u8 dpc_rp_log_size; 481 #endif 482 #ifdef CONFIG_PCI_ATS 483 union { 484 struct pci_sriov *sriov; /* PF: SR-IOV info */ 485 struct pci_dev *physfn; /* VF: related PF */ 486 }; 487 u16 ats_cap; /* ATS Capability offset */ 488 u8 ats_stu; /* ATS Smallest Translation Unit */ 489 #endif 490 #ifdef CONFIG_PCI_PRI 491 u16 pri_cap; /* PRI Capability offset */ 492 u32 pri_reqs_alloc; /* Number of PRI requests allocated */ 493 unsigned int pasid_required:1; /* PRG Response PASID Required */ 494 #endif 495 #ifdef CONFIG_PCI_PASID 496 u16 pasid_cap; /* PASID Capability offset */ 497 u16 pasid_features; 498 #endif 499 #ifdef CONFIG_PCI_P2PDMA 500 struct pci_p2pdma __rcu *p2pdma; 501 #endif 502 u16 acs_cap; /* ACS Capability offset */ 503 phys_addr_t rom; /* Physical address if not from BAR */ 504 size_t romlen; /* Length if not from BAR */ 505 char *driver_override; /* Driver name to force a match */ 506 507 unsigned long priv_flags; /* Private flags for the PCI driver */ 508 }; 509 510 static inline struct pci_dev *pci_physfn(struct pci_dev *dev) 511 { 512 #ifdef CONFIG_PCI_IOV 513 if (dev->is_virtfn) 514 dev = dev->physfn; 515 #endif 516 return dev; 517 } 518 519 struct pci_dev *pci_alloc_dev(struct pci_bus *bus); 520 521 #define to_pci_dev(n) container_of(n, struct pci_dev, dev) 522 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL) 523 524 static inline int pci_channel_offline(struct pci_dev *pdev) 525 { 526 return (pdev->error_state != pci_channel_io_normal); 527 } 528 529 struct pci_host_bridge { 530 struct device dev; 531 struct pci_bus *bus; /* Root bus */ 532 struct pci_ops *ops; 533 struct pci_ops *child_ops; 534 void *sysdata; 535 int busnr; 536 struct list_head windows; /* resource_entry */ 537 struct list_head dma_ranges; /* dma ranges resource list */ 538 u8 (*swizzle_irq)(struct pci_dev *, u8 *); /* Platform IRQ swizzler */ 539 int (*map_irq)(const struct pci_dev *, u8, u8); 540 void (*release_fn)(struct pci_host_bridge *); 541 void *release_data; 542 unsigned int ignore_reset_delay:1; /* For entire hierarchy */ 543 unsigned int no_ext_tags:1; /* No Extended Tags */ 544 unsigned int native_aer:1; /* OS may use PCIe AER */ 545 unsigned int native_pcie_hotplug:1; /* OS may use PCIe hotplug */ 546 unsigned int native_shpc_hotplug:1; /* OS may use SHPC hotplug */ 547 unsigned int native_pme:1; /* OS may use PCIe PME */ 548 unsigned int native_ltr:1; /* OS may use PCIe LTR */ 549 unsigned int native_dpc:1; /* OS may use PCIe DPC */ 550 unsigned int preserve_config:1; /* Preserve FW resource setup */ 551 unsigned int size_windows:1; /* Enable root bus sizing */ 552 unsigned int msi_domain:1; /* Bridge wants MSI domain */ 553 554 /* Resource alignment requirements */ 555 resource_size_t (*align_resource)(struct pci_dev *dev, 556 const struct resource *res, 557 resource_size_t start, 558 resource_size_t size, 559 resource_size_t align); 560 unsigned long private[] ____cacheline_aligned; 561 }; 562 563 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev) 564 565 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge) 566 { 567 return (void *)bridge->private; 568 } 569 570 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv) 571 { 572 return container_of(priv, struct pci_host_bridge, private); 573 } 574 575 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv); 576 struct pci_host_bridge *devm_pci_alloc_host_bridge(struct device *dev, 577 size_t priv); 578 void pci_free_host_bridge(struct pci_host_bridge *bridge); 579 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus); 580 581 void pci_set_host_bridge_release(struct pci_host_bridge *bridge, 582 void (*release_fn)(struct pci_host_bridge *), 583 void *release_data); 584 585 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge); 586 587 /* 588 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond 589 * to P2P or CardBus bridge windows) go in a table. Additional ones (for 590 * buses below host bridges or subtractive decode bridges) go in the list. 591 * Use pci_bus_for_each_resource() to iterate through all the resources. 592 */ 593 594 /* 595 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly 596 * and there's no way to program the bridge with the details of the window. 597 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive- 598 * decode bit set, because they are explicit and can be programmed with _SRS. 599 */ 600 #define PCI_SUBTRACTIVE_DECODE 0x1 601 602 struct pci_bus_resource { 603 struct list_head list; 604 struct resource *res; 605 unsigned int flags; 606 }; 607 608 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */ 609 610 struct pci_bus { 611 struct list_head node; /* Node in list of buses */ 612 struct pci_bus *parent; /* Parent bus this bridge is on */ 613 struct list_head children; /* List of child buses */ 614 struct list_head devices; /* List of devices on this bus */ 615 struct pci_dev *self; /* Bridge device as seen by parent */ 616 struct list_head slots; /* List of slots on this bus; 617 protected by pci_slot_mutex */ 618 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM]; 619 struct list_head resources; /* Address space routed to this bus */ 620 struct resource busn_res; /* Bus numbers routed to this bus */ 621 622 struct pci_ops *ops; /* Configuration access functions */ 623 void *sysdata; /* Hook for sys-specific extension */ 624 struct proc_dir_entry *procdir; /* Directory entry in /proc/bus/pci */ 625 626 unsigned char number; /* Bus number */ 627 unsigned char primary; /* Number of primary bridge */ 628 unsigned char max_bus_speed; /* enum pci_bus_speed */ 629 unsigned char cur_bus_speed; /* enum pci_bus_speed */ 630 #ifdef CONFIG_PCI_DOMAINS_GENERIC 631 int domain_nr; 632 #endif 633 634 char name[48]; 635 636 unsigned short bridge_ctl; /* Manage NO_ISA/FBB/et al behaviors */ 637 pci_bus_flags_t bus_flags; /* Inherited by child buses */ 638 struct device *bridge; 639 struct device dev; 640 struct bin_attribute *legacy_io; /* Legacy I/O for this bus */ 641 struct bin_attribute *legacy_mem; /* Legacy mem */ 642 unsigned int is_added:1; 643 }; 644 645 #define to_pci_bus(n) container_of(n, struct pci_bus, dev) 646 647 static inline u16 pci_dev_id(struct pci_dev *dev) 648 { 649 return PCI_DEVID(dev->bus->number, dev->devfn); 650 } 651 652 /* 653 * Returns true if the PCI bus is root (behind host-PCI bridge), 654 * false otherwise 655 * 656 * Some code assumes that "bus->self == NULL" means that bus is a root bus. 657 * This is incorrect because "virtual" buses added for SR-IOV (via 658 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses. 659 */ 660 static inline bool pci_is_root_bus(struct pci_bus *pbus) 661 { 662 return !(pbus->parent); 663 } 664 665 /** 666 * pci_is_bridge - check if the PCI device is a bridge 667 * @dev: PCI device 668 * 669 * Return true if the PCI device is bridge whether it has subordinate 670 * or not. 671 */ 672 static inline bool pci_is_bridge(struct pci_dev *dev) 673 { 674 return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE || 675 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS; 676 } 677 678 #define for_each_pci_bridge(dev, bus) \ 679 list_for_each_entry(dev, &bus->devices, bus_list) \ 680 if (!pci_is_bridge(dev)) {} else 681 682 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev) 683 { 684 dev = pci_physfn(dev); 685 if (pci_is_root_bus(dev->bus)) 686 return NULL; 687 688 return dev->bus->self; 689 } 690 691 #ifdef CONFIG_PCI_MSI 692 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) 693 { 694 return pci_dev->msi_enabled || pci_dev->msix_enabled; 695 } 696 #else 697 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; } 698 #endif 699 700 /* Error values that may be returned by PCI functions */ 701 #define PCIBIOS_SUCCESSFUL 0x00 702 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81 703 #define PCIBIOS_BAD_VENDOR_ID 0x83 704 #define PCIBIOS_DEVICE_NOT_FOUND 0x86 705 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87 706 #define PCIBIOS_SET_FAILED 0x88 707 #define PCIBIOS_BUFFER_TOO_SMALL 0x89 708 709 /* Translate above to generic errno for passing back through non-PCI code */ 710 static inline int pcibios_err_to_errno(int err) 711 { 712 if (err <= PCIBIOS_SUCCESSFUL) 713 return err; /* Assume already errno */ 714 715 switch (err) { 716 case PCIBIOS_FUNC_NOT_SUPPORTED: 717 return -ENOENT; 718 case PCIBIOS_BAD_VENDOR_ID: 719 return -ENOTTY; 720 case PCIBIOS_DEVICE_NOT_FOUND: 721 return -ENODEV; 722 case PCIBIOS_BAD_REGISTER_NUMBER: 723 return -EFAULT; 724 case PCIBIOS_SET_FAILED: 725 return -EIO; 726 case PCIBIOS_BUFFER_TOO_SMALL: 727 return -ENOSPC; 728 } 729 730 return -ERANGE; 731 } 732 733 /* Low-level architecture-dependent routines */ 734 735 struct pci_ops { 736 int (*add_bus)(struct pci_bus *bus); 737 void (*remove_bus)(struct pci_bus *bus); 738 void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where); 739 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val); 740 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val); 741 }; 742 743 /* 744 * ACPI needs to be able to access PCI config space before we've done a 745 * PCI bus scan and created pci_bus structures. 746 */ 747 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn, 748 int reg, int len, u32 *val); 749 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn, 750 int reg, int len, u32 val); 751 752 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT 753 typedef u64 pci_bus_addr_t; 754 #else 755 typedef u32 pci_bus_addr_t; 756 #endif 757 758 struct pci_bus_region { 759 pci_bus_addr_t start; 760 pci_bus_addr_t end; 761 }; 762 763 struct pci_dynids { 764 spinlock_t lock; /* Protects list, index */ 765 struct list_head list; /* For IDs added at runtime */ 766 }; 767 768 769 /* 770 * PCI Error Recovery System (PCI-ERS). If a PCI device driver provides 771 * a set of callbacks in struct pci_error_handlers, that device driver 772 * will be notified of PCI bus errors, and will be driven to recovery 773 * when an error occurs. 774 */ 775 776 typedef unsigned int __bitwise pci_ers_result_t; 777 778 enum pci_ers_result { 779 /* No result/none/not supported in device driver */ 780 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1, 781 782 /* Device driver can recover without slot reset */ 783 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2, 784 785 /* Device driver wants slot to be reset */ 786 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3, 787 788 /* Device has completely failed, is unrecoverable */ 789 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4, 790 791 /* Device driver is fully recovered and operational */ 792 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5, 793 794 /* No AER capabilities registered for the driver */ 795 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6, 796 }; 797 798 /* PCI bus error event callbacks */ 799 struct pci_error_handlers { 800 /* PCI bus error detected on this device */ 801 pci_ers_result_t (*error_detected)(struct pci_dev *dev, 802 pci_channel_state_t error); 803 804 /* MMIO has been re-enabled, but not DMA */ 805 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev); 806 807 /* PCI slot has been reset */ 808 pci_ers_result_t (*slot_reset)(struct pci_dev *dev); 809 810 /* PCI function reset prepare or completed */ 811 void (*reset_prepare)(struct pci_dev *dev); 812 void (*reset_done)(struct pci_dev *dev); 813 814 /* Device driver may resume normal operations */ 815 void (*resume)(struct pci_dev *dev); 816 }; 817 818 819 struct module; 820 821 /** 822 * struct pci_driver - PCI driver structure 823 * @node: List of driver structures. 824 * @name: Driver name. 825 * @id_table: Pointer to table of device IDs the driver is 826 * interested in. Most drivers should export this 827 * table using MODULE_DEVICE_TABLE(pci,...). 828 * @probe: This probing function gets called (during execution 829 * of pci_register_driver() for already existing 830 * devices or later if a new device gets inserted) for 831 * all PCI devices which match the ID table and are not 832 * "owned" by the other drivers yet. This function gets 833 * passed a "struct pci_dev \*" for each device whose 834 * entry in the ID table matches the device. The probe 835 * function returns zero when the driver chooses to 836 * take "ownership" of the device or an error code 837 * (negative number) otherwise. 838 * The probe function always gets called from process 839 * context, so it can sleep. 840 * @remove: The remove() function gets called whenever a device 841 * being handled by this driver is removed (either during 842 * deregistration of the driver or when it's manually 843 * pulled out of a hot-pluggable slot). 844 * The remove function always gets called from process 845 * context, so it can sleep. 846 * @suspend: Put device into low power state. 847 * @resume: Wake device from low power state. 848 * (Please see Documentation/power/pci.rst for descriptions 849 * of PCI Power Management and the related functions.) 850 * @shutdown: Hook into reboot_notifier_list (kernel/sys.c). 851 * Intended to stop any idling DMA operations. 852 * Useful for enabling wake-on-lan (NIC) or changing 853 * the power state of a device before reboot. 854 * e.g. drivers/net/e100.c. 855 * @sriov_configure: Optional driver callback to allow configuration of 856 * number of VFs to enable via sysfs "sriov_numvfs" file. 857 * @sriov_set_msix_vec_count: PF Driver callback to change number of MSI-X 858 * vectors on a VF. Triggered via sysfs "sriov_vf_msix_count". 859 * This will change MSI-X Table Size in the VF Message Control 860 * registers. 861 * @sriov_get_vf_total_msix: PF driver callback to get the total number of 862 * MSI-X vectors available for distribution to the VFs. 863 * @err_handler: See Documentation/PCI/pci-error-recovery.rst 864 * @groups: Sysfs attribute groups. 865 * @dev_groups: Attributes attached to the device that will be 866 * created once it is bound to the driver. 867 * @driver: Driver model structure. 868 * @dynids: List of dynamically added device IDs. 869 */ 870 struct pci_driver { 871 struct list_head node; 872 const char *name; 873 const struct pci_device_id *id_table; /* Must be non-NULL for probe to be called */ 874 int (*probe)(struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */ 875 void (*remove)(struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */ 876 int (*suspend)(struct pci_dev *dev, pm_message_t state); /* Device suspended */ 877 int (*resume)(struct pci_dev *dev); /* Device woken up */ 878 void (*shutdown)(struct pci_dev *dev); 879 int (*sriov_configure)(struct pci_dev *dev, int num_vfs); /* On PF */ 880 int (*sriov_set_msix_vec_count)(struct pci_dev *vf, int msix_vec_count); /* On PF */ 881 u32 (*sriov_get_vf_total_msix)(struct pci_dev *pf); 882 const struct pci_error_handlers *err_handler; 883 const struct attribute_group **groups; 884 const struct attribute_group **dev_groups; 885 struct device_driver driver; 886 struct pci_dynids dynids; 887 }; 888 889 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver) 890 891 /** 892 * PCI_DEVICE - macro used to describe a specific PCI device 893 * @vend: the 16 bit PCI Vendor ID 894 * @dev: the 16 bit PCI Device ID 895 * 896 * This macro is used to create a struct pci_device_id that matches a 897 * specific device. The subvendor and subdevice fields will be set to 898 * PCI_ANY_ID. 899 */ 900 #define PCI_DEVICE(vend,dev) \ 901 .vendor = (vend), .device = (dev), \ 902 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 903 904 /** 905 * PCI_DEVICE_SUB - macro used to describe a specific PCI device with subsystem 906 * @vend: the 16 bit PCI Vendor ID 907 * @dev: the 16 bit PCI Device ID 908 * @subvend: the 16 bit PCI Subvendor ID 909 * @subdev: the 16 bit PCI Subdevice ID 910 * 911 * This macro is used to create a struct pci_device_id that matches a 912 * specific device with subsystem information. 913 */ 914 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \ 915 .vendor = (vend), .device = (dev), \ 916 .subvendor = (subvend), .subdevice = (subdev) 917 918 /** 919 * PCI_DEVICE_CLASS - macro used to describe a specific PCI device class 920 * @dev_class: the class, subclass, prog-if triple for this device 921 * @dev_class_mask: the class mask for this device 922 * 923 * This macro is used to create a struct pci_device_id that matches a 924 * specific PCI class. The vendor, device, subvendor, and subdevice 925 * fields will be set to PCI_ANY_ID. 926 */ 927 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \ 928 .class = (dev_class), .class_mask = (dev_class_mask), \ 929 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \ 930 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID 931 932 /** 933 * PCI_VDEVICE - macro used to describe a specific PCI device in short form 934 * @vend: the vendor name 935 * @dev: the 16 bit PCI Device ID 936 * 937 * This macro is used to create a struct pci_device_id that matches a 938 * specific PCI device. The subvendor, and subdevice fields will be set 939 * to PCI_ANY_ID. The macro allows the next field to follow as the device 940 * private data. 941 */ 942 #define PCI_VDEVICE(vend, dev) \ 943 .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \ 944 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0 945 946 /** 947 * PCI_DEVICE_DATA - macro used to describe a specific PCI device in very short form 948 * @vend: the vendor name (without PCI_VENDOR_ID_ prefix) 949 * @dev: the device name (without PCI_DEVICE_ID_<vend>_ prefix) 950 * @data: the driver data to be filled 951 * 952 * This macro is used to create a struct pci_device_id that matches a 953 * specific PCI device. The subvendor, and subdevice fields will be set 954 * to PCI_ANY_ID. 955 */ 956 #define PCI_DEVICE_DATA(vend, dev, data) \ 957 .vendor = PCI_VENDOR_ID_##vend, .device = PCI_DEVICE_ID_##vend##_##dev, \ 958 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0, \ 959 .driver_data = (kernel_ulong_t)(data) 960 961 enum { 962 PCI_REASSIGN_ALL_RSRC = 0x00000001, /* Ignore firmware setup */ 963 PCI_REASSIGN_ALL_BUS = 0x00000002, /* Reassign all bus numbers */ 964 PCI_PROBE_ONLY = 0x00000004, /* Use existing setup */ 965 PCI_CAN_SKIP_ISA_ALIGN = 0x00000008, /* Don't do ISA alignment */ 966 PCI_ENABLE_PROC_DOMAINS = 0x00000010, /* Enable domains in /proc */ 967 PCI_COMPAT_DOMAIN_0 = 0x00000020, /* ... except domain 0 */ 968 PCI_SCAN_ALL_PCIE_DEVS = 0x00000040, /* Scan all, not just dev 0 */ 969 }; 970 971 #define PCI_IRQ_LEGACY (1 << 0) /* Allow legacy interrupts */ 972 #define PCI_IRQ_MSI (1 << 1) /* Allow MSI interrupts */ 973 #define PCI_IRQ_MSIX (1 << 2) /* Allow MSI-X interrupts */ 974 #define PCI_IRQ_AFFINITY (1 << 3) /* Auto-assign affinity */ 975 976 /* These external functions are only available when PCI support is enabled */ 977 #ifdef CONFIG_PCI 978 979 extern unsigned int pci_flags; 980 981 static inline void pci_set_flags(int flags) { pci_flags = flags; } 982 static inline void pci_add_flags(int flags) { pci_flags |= flags; } 983 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; } 984 static inline int pci_has_flag(int flag) { return pci_flags & flag; } 985 986 void pcie_bus_configure_settings(struct pci_bus *bus); 987 988 enum pcie_bus_config_types { 989 PCIE_BUS_TUNE_OFF, /* Don't touch MPS at all */ 990 PCIE_BUS_DEFAULT, /* Ensure MPS matches upstream bridge */ 991 PCIE_BUS_SAFE, /* Use largest MPS boot-time devices support */ 992 PCIE_BUS_PERFORMANCE, /* Use MPS and MRRS for best performance */ 993 PCIE_BUS_PEER2PEER, /* Set MPS = 128 for all devices */ 994 }; 995 996 extern enum pcie_bus_config_types pcie_bus_config; 997 998 extern struct bus_type pci_bus_type; 999 1000 /* Do NOT directly access these two variables, unless you are arch-specific PCI 1001 * code, or PCI core code. */ 1002 extern struct list_head pci_root_buses; /* List of all known PCI buses */ 1003 /* Some device drivers need know if PCI is initiated */ 1004 int no_pci_devices(void); 1005 1006 void pcibios_resource_survey_bus(struct pci_bus *bus); 1007 void pcibios_bus_add_device(struct pci_dev *pdev); 1008 void pcibios_add_bus(struct pci_bus *bus); 1009 void pcibios_remove_bus(struct pci_bus *bus); 1010 void pcibios_fixup_bus(struct pci_bus *); 1011 int __must_check pcibios_enable_device(struct pci_dev *, int mask); 1012 /* Architecture-specific versions may override this (weak) */ 1013 char *pcibios_setup(char *str); 1014 1015 /* Used only when drivers/pci/setup.c is used */ 1016 resource_size_t pcibios_align_resource(void *, const struct resource *, 1017 resource_size_t, 1018 resource_size_t); 1019 1020 /* Weak but can be overridden by arch */ 1021 void pci_fixup_cardbus(struct pci_bus *); 1022 1023 /* Generic PCI functions used internally */ 1024 1025 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region, 1026 struct resource *res); 1027 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res, 1028 struct pci_bus_region *region); 1029 void pcibios_scan_specific_bus(int busn); 1030 struct pci_bus *pci_find_bus(int domain, int busnr); 1031 void pci_bus_add_devices(const struct pci_bus *bus); 1032 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata); 1033 struct pci_bus *pci_create_root_bus(struct device *parent, int bus, 1034 struct pci_ops *ops, void *sysdata, 1035 struct list_head *resources); 1036 int pci_host_probe(struct pci_host_bridge *bridge); 1037 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax); 1038 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax); 1039 void pci_bus_release_busn_res(struct pci_bus *b); 1040 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus, 1041 struct pci_ops *ops, void *sysdata, 1042 struct list_head *resources); 1043 int pci_scan_root_bus_bridge(struct pci_host_bridge *bridge); 1044 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev, 1045 int busnr); 1046 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr, 1047 const char *name, 1048 struct hotplug_slot *hotplug); 1049 void pci_destroy_slot(struct pci_slot *slot); 1050 #ifdef CONFIG_SYSFS 1051 void pci_dev_assign_slot(struct pci_dev *dev); 1052 #else 1053 static inline void pci_dev_assign_slot(struct pci_dev *dev) { } 1054 #endif 1055 int pci_scan_slot(struct pci_bus *bus, int devfn); 1056 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn); 1057 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus); 1058 unsigned int pci_scan_child_bus(struct pci_bus *bus); 1059 void pci_bus_add_device(struct pci_dev *dev); 1060 void pci_read_bridge_bases(struct pci_bus *child); 1061 struct resource *pci_find_parent_resource(const struct pci_dev *dev, 1062 struct resource *res); 1063 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin); 1064 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge); 1065 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp); 1066 struct pci_dev *pci_dev_get(struct pci_dev *dev); 1067 void pci_dev_put(struct pci_dev *dev); 1068 void pci_remove_bus(struct pci_bus *b); 1069 void pci_stop_and_remove_bus_device(struct pci_dev *dev); 1070 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev); 1071 void pci_stop_root_bus(struct pci_bus *bus); 1072 void pci_remove_root_bus(struct pci_bus *bus); 1073 void pci_setup_cardbus(struct pci_bus *bus); 1074 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type); 1075 void pci_sort_breadthfirst(void); 1076 #define dev_is_pci(d) ((d)->bus == &pci_bus_type) 1077 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false)) 1078 1079 /* Generic PCI functions exported to card drivers */ 1080 1081 u8 pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap); 1082 u8 pci_find_capability(struct pci_dev *dev, int cap); 1083 u8 pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap); 1084 u8 pci_find_ht_capability(struct pci_dev *dev, int ht_cap); 1085 u8 pci_find_next_ht_capability(struct pci_dev *dev, u8 pos, int ht_cap); 1086 u16 pci_find_ext_capability(struct pci_dev *dev, int cap); 1087 u16 pci_find_next_ext_capability(struct pci_dev *dev, u16 pos, int cap); 1088 struct pci_bus *pci_find_next_bus(const struct pci_bus *from); 1089 u16 pci_find_vsec_capability(struct pci_dev *dev, u16 vendor, int cap); 1090 1091 u64 pci_get_dsn(struct pci_dev *dev); 1092 1093 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device, 1094 struct pci_dev *from); 1095 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device, 1096 unsigned int ss_vendor, unsigned int ss_device, 1097 struct pci_dev *from); 1098 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn); 1099 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus, 1100 unsigned int devfn); 1101 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from); 1102 int pci_dev_present(const struct pci_device_id *ids); 1103 1104 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn, 1105 int where, u8 *val); 1106 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn, 1107 int where, u16 *val); 1108 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn, 1109 int where, u32 *val); 1110 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn, 1111 int where, u8 val); 1112 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn, 1113 int where, u16 val); 1114 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn, 1115 int where, u32 val); 1116 1117 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn, 1118 int where, int size, u32 *val); 1119 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn, 1120 int where, int size, u32 val); 1121 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn, 1122 int where, int size, u32 *val); 1123 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn, 1124 int where, int size, u32 val); 1125 1126 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops); 1127 1128 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val); 1129 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val); 1130 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val); 1131 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val); 1132 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val); 1133 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val); 1134 1135 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val); 1136 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val); 1137 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val); 1138 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val); 1139 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos, 1140 u16 clear, u16 set); 1141 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos, 1142 u32 clear, u32 set); 1143 1144 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos, 1145 u16 set) 1146 { 1147 return pcie_capability_clear_and_set_word(dev, pos, 0, set); 1148 } 1149 1150 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos, 1151 u32 set) 1152 { 1153 return pcie_capability_clear_and_set_dword(dev, pos, 0, set); 1154 } 1155 1156 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos, 1157 u16 clear) 1158 { 1159 return pcie_capability_clear_and_set_word(dev, pos, clear, 0); 1160 } 1161 1162 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos, 1163 u32 clear) 1164 { 1165 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0); 1166 } 1167 1168 /* User-space driven config access */ 1169 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val); 1170 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val); 1171 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val); 1172 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val); 1173 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val); 1174 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val); 1175 1176 int __must_check pci_enable_device(struct pci_dev *dev); 1177 int __must_check pci_enable_device_io(struct pci_dev *dev); 1178 int __must_check pci_enable_device_mem(struct pci_dev *dev); 1179 int __must_check pci_reenable_device(struct pci_dev *); 1180 int __must_check pcim_enable_device(struct pci_dev *pdev); 1181 void pcim_pin_device(struct pci_dev *pdev); 1182 1183 static inline bool pci_intx_mask_supported(struct pci_dev *pdev) 1184 { 1185 /* 1186 * INTx masking is supported if PCI_COMMAND_INTX_DISABLE is 1187 * writable and no quirk has marked the feature broken. 1188 */ 1189 return !pdev->broken_intx_masking; 1190 } 1191 1192 static inline int pci_is_enabled(struct pci_dev *pdev) 1193 { 1194 return (atomic_read(&pdev->enable_cnt) > 0); 1195 } 1196 1197 static inline int pci_is_managed(struct pci_dev *pdev) 1198 { 1199 return pdev->is_managed; 1200 } 1201 1202 void pci_disable_device(struct pci_dev *dev); 1203 1204 extern unsigned int pcibios_max_latency; 1205 void pci_set_master(struct pci_dev *dev); 1206 void pci_clear_master(struct pci_dev *dev); 1207 1208 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state); 1209 int pci_set_cacheline_size(struct pci_dev *dev); 1210 int __must_check pci_set_mwi(struct pci_dev *dev); 1211 int __must_check pcim_set_mwi(struct pci_dev *dev); 1212 int pci_try_set_mwi(struct pci_dev *dev); 1213 void pci_clear_mwi(struct pci_dev *dev); 1214 void pci_disable_parity(struct pci_dev *dev); 1215 void pci_intx(struct pci_dev *dev, int enable); 1216 bool pci_check_and_mask_intx(struct pci_dev *dev); 1217 bool pci_check_and_unmask_intx(struct pci_dev *dev); 1218 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask); 1219 int pci_wait_for_pending_transaction(struct pci_dev *dev); 1220 int pcix_get_max_mmrbc(struct pci_dev *dev); 1221 int pcix_get_mmrbc(struct pci_dev *dev); 1222 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc); 1223 int pcie_get_readrq(struct pci_dev *dev); 1224 int pcie_set_readrq(struct pci_dev *dev, int rq); 1225 int pcie_get_mps(struct pci_dev *dev); 1226 int pcie_set_mps(struct pci_dev *dev, int mps); 1227 u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev, 1228 enum pci_bus_speed *speed, 1229 enum pcie_link_width *width); 1230 void pcie_print_link_status(struct pci_dev *dev); 1231 bool pcie_has_flr(struct pci_dev *dev); 1232 int pcie_flr(struct pci_dev *dev); 1233 int __pci_reset_function_locked(struct pci_dev *dev); 1234 int pci_reset_function(struct pci_dev *dev); 1235 int pci_reset_function_locked(struct pci_dev *dev); 1236 int pci_try_reset_function(struct pci_dev *dev); 1237 int pci_probe_reset_slot(struct pci_slot *slot); 1238 int pci_probe_reset_bus(struct pci_bus *bus); 1239 int pci_reset_bus(struct pci_dev *dev); 1240 void pci_reset_secondary_bus(struct pci_dev *dev); 1241 void pcibios_reset_secondary_bus(struct pci_dev *dev); 1242 void pci_update_resource(struct pci_dev *dev, int resno); 1243 int __must_check pci_assign_resource(struct pci_dev *dev, int i); 1244 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align); 1245 void pci_release_resource(struct pci_dev *dev, int resno); 1246 static inline int pci_rebar_bytes_to_size(u64 bytes) 1247 { 1248 bytes = roundup_pow_of_two(bytes); 1249 1250 /* Return BAR size as defined in the resizable BAR specification */ 1251 return max(ilog2(bytes), 20) - 20; 1252 } 1253 1254 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar); 1255 int __must_check pci_resize_resource(struct pci_dev *dev, int i, int size); 1256 int pci_select_bars(struct pci_dev *dev, unsigned long flags); 1257 bool pci_device_is_present(struct pci_dev *pdev); 1258 void pci_ignore_hotplug(struct pci_dev *dev); 1259 struct pci_dev *pci_real_dma_dev(struct pci_dev *dev); 1260 int pci_status_get_and_clear_errors(struct pci_dev *pdev); 1261 1262 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr, 1263 irq_handler_t handler, irq_handler_t thread_fn, void *dev_id, 1264 const char *fmt, ...); 1265 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id); 1266 1267 /* ROM control related routines */ 1268 int pci_enable_rom(struct pci_dev *pdev); 1269 void pci_disable_rom(struct pci_dev *pdev); 1270 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size); 1271 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom); 1272 1273 /* Power management related routines */ 1274 int pci_save_state(struct pci_dev *dev); 1275 void pci_restore_state(struct pci_dev *dev); 1276 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev); 1277 int pci_load_saved_state(struct pci_dev *dev, 1278 struct pci_saved_state *state); 1279 int pci_load_and_free_saved_state(struct pci_dev *dev, 1280 struct pci_saved_state **state); 1281 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap); 1282 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev, 1283 u16 cap); 1284 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size); 1285 int pci_add_ext_cap_save_buffer(struct pci_dev *dev, 1286 u16 cap, unsigned int size); 1287 int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state); 1288 int pci_set_power_state(struct pci_dev *dev, pci_power_t state); 1289 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state); 1290 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state); 1291 void pci_pme_active(struct pci_dev *dev, bool enable); 1292 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable); 1293 int pci_wake_from_d3(struct pci_dev *dev, bool enable); 1294 int pci_prepare_to_sleep(struct pci_dev *dev); 1295 int pci_back_from_sleep(struct pci_dev *dev); 1296 bool pci_dev_run_wake(struct pci_dev *dev); 1297 void pci_d3cold_enable(struct pci_dev *dev); 1298 void pci_d3cold_disable(struct pci_dev *dev); 1299 bool pcie_relaxed_ordering_enabled(struct pci_dev *dev); 1300 void pci_resume_bus(struct pci_bus *bus); 1301 void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state); 1302 1303 /* For use by arch with custom probe code */ 1304 void set_pcie_port_type(struct pci_dev *pdev); 1305 void set_pcie_hotplug_bridge(struct pci_dev *pdev); 1306 1307 /* Functions for PCI Hotplug drivers to use */ 1308 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge); 1309 unsigned int pci_rescan_bus(struct pci_bus *bus); 1310 void pci_lock_rescan_remove(void); 1311 void pci_unlock_rescan_remove(void); 1312 1313 /* Vital Product Data routines */ 1314 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf); 1315 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf); 1316 1317 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */ 1318 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx); 1319 void pci_bus_assign_resources(const struct pci_bus *bus); 1320 void pci_bus_claim_resources(struct pci_bus *bus); 1321 void pci_bus_size_bridges(struct pci_bus *bus); 1322 int pci_claim_resource(struct pci_dev *, int); 1323 int pci_claim_bridge_resource(struct pci_dev *bridge, int i); 1324 void pci_assign_unassigned_resources(void); 1325 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge); 1326 void pci_assign_unassigned_bus_resources(struct pci_bus *bus); 1327 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus); 1328 int pci_reassign_bridge_resources(struct pci_dev *bridge, unsigned long type); 1329 void pdev_enable_device(struct pci_dev *); 1330 int pci_enable_resources(struct pci_dev *, int mask); 1331 void pci_assign_irq(struct pci_dev *dev); 1332 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res); 1333 #define HAVE_PCI_REQ_REGIONS 2 1334 int __must_check pci_request_regions(struct pci_dev *, const char *); 1335 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *); 1336 void pci_release_regions(struct pci_dev *); 1337 int __must_check pci_request_region(struct pci_dev *, int, const char *); 1338 void pci_release_region(struct pci_dev *, int); 1339 int pci_request_selected_regions(struct pci_dev *, int, const char *); 1340 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *); 1341 void pci_release_selected_regions(struct pci_dev *, int); 1342 1343 /* drivers/pci/bus.c */ 1344 void pci_add_resource(struct list_head *resources, struct resource *res); 1345 void pci_add_resource_offset(struct list_head *resources, struct resource *res, 1346 resource_size_t offset); 1347 void pci_free_resource_list(struct list_head *resources); 1348 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, 1349 unsigned int flags); 1350 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n); 1351 void pci_bus_remove_resources(struct pci_bus *bus); 1352 int devm_request_pci_bus_resources(struct device *dev, 1353 struct list_head *resources); 1354 1355 /* Temporary until new and working PCI SBR API in place */ 1356 int pci_bridge_secondary_bus_reset(struct pci_dev *dev); 1357 1358 #define pci_bus_for_each_resource(bus, res, i) \ 1359 for (i = 0; \ 1360 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \ 1361 i++) 1362 1363 int __must_check pci_bus_alloc_resource(struct pci_bus *bus, 1364 struct resource *res, resource_size_t size, 1365 resource_size_t align, resource_size_t min, 1366 unsigned long type_mask, 1367 resource_size_t (*alignf)(void *, 1368 const struct resource *, 1369 resource_size_t, 1370 resource_size_t), 1371 void *alignf_data); 1372 1373 1374 int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr, 1375 resource_size_t size); 1376 unsigned long pci_address_to_pio(phys_addr_t addr); 1377 phys_addr_t pci_pio_to_address(unsigned long pio); 1378 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr); 1379 int devm_pci_remap_iospace(struct device *dev, const struct resource *res, 1380 phys_addr_t phys_addr); 1381 void pci_unmap_iospace(struct resource *res); 1382 void __iomem *devm_pci_remap_cfgspace(struct device *dev, 1383 resource_size_t offset, 1384 resource_size_t size); 1385 void __iomem *devm_pci_remap_cfg_resource(struct device *dev, 1386 struct resource *res); 1387 1388 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar) 1389 { 1390 struct pci_bus_region region; 1391 1392 pcibios_resource_to_bus(pdev->bus, ®ion, &pdev->resource[bar]); 1393 return region.start; 1394 } 1395 1396 /* Proper probing supporting hot-pluggable devices */ 1397 int __must_check __pci_register_driver(struct pci_driver *, struct module *, 1398 const char *mod_name); 1399 1400 /* pci_register_driver() must be a macro so KBUILD_MODNAME can be expanded */ 1401 #define pci_register_driver(driver) \ 1402 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME) 1403 1404 void pci_unregister_driver(struct pci_driver *dev); 1405 1406 /** 1407 * module_pci_driver() - Helper macro for registering a PCI driver 1408 * @__pci_driver: pci_driver struct 1409 * 1410 * Helper macro for PCI drivers which do not do anything special in module 1411 * init/exit. This eliminates a lot of boilerplate. Each module may only 1412 * use this macro once, and calling it replaces module_init() and module_exit() 1413 */ 1414 #define module_pci_driver(__pci_driver) \ 1415 module_driver(__pci_driver, pci_register_driver, pci_unregister_driver) 1416 1417 /** 1418 * builtin_pci_driver() - Helper macro for registering a PCI driver 1419 * @__pci_driver: pci_driver struct 1420 * 1421 * Helper macro for PCI drivers which do not do anything special in their 1422 * init code. This eliminates a lot of boilerplate. Each driver may only 1423 * use this macro once, and calling it replaces device_initcall(...) 1424 */ 1425 #define builtin_pci_driver(__pci_driver) \ 1426 builtin_driver(__pci_driver, pci_register_driver) 1427 1428 struct pci_driver *pci_dev_driver(const struct pci_dev *dev); 1429 int pci_add_dynid(struct pci_driver *drv, 1430 unsigned int vendor, unsigned int device, 1431 unsigned int subvendor, unsigned int subdevice, 1432 unsigned int class, unsigned int class_mask, 1433 unsigned long driver_data); 1434 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, 1435 struct pci_dev *dev); 1436 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max, 1437 int pass); 1438 1439 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *), 1440 void *userdata); 1441 int pci_cfg_space_size(struct pci_dev *dev); 1442 unsigned char pci_bus_max_busnr(struct pci_bus *bus); 1443 void pci_setup_bridge(struct pci_bus *bus); 1444 resource_size_t pcibios_window_alignment(struct pci_bus *bus, 1445 unsigned long type); 1446 1447 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0) 1448 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1) 1449 1450 int pci_set_vga_state(struct pci_dev *pdev, bool decode, 1451 unsigned int command_bits, u32 flags); 1452 1453 /* 1454 * Virtual interrupts allow for more interrupts to be allocated 1455 * than the device has interrupts for. These are not programmed 1456 * into the device's MSI-X table and must be handled by some 1457 * other driver means. 1458 */ 1459 #define PCI_IRQ_VIRTUAL (1 << 4) 1460 1461 #define PCI_IRQ_ALL_TYPES \ 1462 (PCI_IRQ_LEGACY | PCI_IRQ_MSI | PCI_IRQ_MSIX) 1463 1464 /* kmem_cache style wrapper around pci_alloc_consistent() */ 1465 1466 #include <linux/dmapool.h> 1467 1468 #define pci_pool dma_pool 1469 #define pci_pool_create(name, pdev, size, align, allocation) \ 1470 dma_pool_create(name, &pdev->dev, size, align, allocation) 1471 #define pci_pool_destroy(pool) dma_pool_destroy(pool) 1472 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle) 1473 #define pci_pool_zalloc(pool, flags, handle) \ 1474 dma_pool_zalloc(pool, flags, handle) 1475 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr) 1476 1477 struct msix_entry { 1478 u32 vector; /* Kernel uses to write allocated vector */ 1479 u16 entry; /* Driver uses to specify entry, OS writes */ 1480 }; 1481 1482 #ifdef CONFIG_PCI_MSI 1483 int pci_msi_vec_count(struct pci_dev *dev); 1484 void pci_disable_msi(struct pci_dev *dev); 1485 int pci_msix_vec_count(struct pci_dev *dev); 1486 void pci_disable_msix(struct pci_dev *dev); 1487 void pci_restore_msi_state(struct pci_dev *dev); 1488 int pci_msi_enabled(void); 1489 int pci_enable_msi(struct pci_dev *dev); 1490 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries, 1491 int minvec, int maxvec); 1492 static inline int pci_enable_msix_exact(struct pci_dev *dev, 1493 struct msix_entry *entries, int nvec) 1494 { 1495 int rc = pci_enable_msix_range(dev, entries, nvec, nvec); 1496 if (rc < 0) 1497 return rc; 1498 return 0; 1499 } 1500 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs, 1501 unsigned int max_vecs, unsigned int flags, 1502 struct irq_affinity *affd); 1503 1504 void pci_free_irq_vectors(struct pci_dev *dev); 1505 int pci_irq_vector(struct pci_dev *dev, unsigned int nr); 1506 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec); 1507 1508 #else 1509 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; } 1510 static inline void pci_disable_msi(struct pci_dev *dev) { } 1511 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; } 1512 static inline void pci_disable_msix(struct pci_dev *dev) { } 1513 static inline void pci_restore_msi_state(struct pci_dev *dev) { } 1514 static inline int pci_msi_enabled(void) { return 0; } 1515 static inline int pci_enable_msi(struct pci_dev *dev) 1516 { return -ENOSYS; } 1517 static inline int pci_enable_msix_range(struct pci_dev *dev, 1518 struct msix_entry *entries, int minvec, int maxvec) 1519 { return -ENOSYS; } 1520 static inline int pci_enable_msix_exact(struct pci_dev *dev, 1521 struct msix_entry *entries, int nvec) 1522 { return -ENOSYS; } 1523 1524 static inline int 1525 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs, 1526 unsigned int max_vecs, unsigned int flags, 1527 struct irq_affinity *aff_desc) 1528 { 1529 if ((flags & PCI_IRQ_LEGACY) && min_vecs == 1 && dev->irq) 1530 return 1; 1531 return -ENOSPC; 1532 } 1533 1534 static inline void pci_free_irq_vectors(struct pci_dev *dev) 1535 { 1536 } 1537 1538 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr) 1539 { 1540 if (WARN_ON_ONCE(nr > 0)) 1541 return -EINVAL; 1542 return dev->irq; 1543 } 1544 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, 1545 int vec) 1546 { 1547 return cpu_possible_mask; 1548 } 1549 #endif 1550 1551 /** 1552 * pci_irqd_intx_xlate() - Translate PCI INTx value to an IRQ domain hwirq 1553 * @d: the INTx IRQ domain 1554 * @node: the DT node for the device whose interrupt we're translating 1555 * @intspec: the interrupt specifier data from the DT 1556 * @intsize: the number of entries in @intspec 1557 * @out_hwirq: pointer at which to write the hwirq number 1558 * @out_type: pointer at which to write the interrupt type 1559 * 1560 * Translate a PCI INTx interrupt number from device tree in the range 1-4, as 1561 * stored in the standard PCI_INTERRUPT_PIN register, to a value in the range 1562 * 0-3 suitable for use in a 4 entry IRQ domain. That is, subtract one from the 1563 * INTx value to obtain the hwirq number. 1564 * 1565 * Returns 0 on success, or -EINVAL if the interrupt specifier is out of range. 1566 */ 1567 static inline int pci_irqd_intx_xlate(struct irq_domain *d, 1568 struct device_node *node, 1569 const u32 *intspec, 1570 unsigned int intsize, 1571 unsigned long *out_hwirq, 1572 unsigned int *out_type) 1573 { 1574 const u32 intx = intspec[0]; 1575 1576 if (intx < PCI_INTERRUPT_INTA || intx > PCI_INTERRUPT_INTD) 1577 return -EINVAL; 1578 1579 *out_hwirq = intx - PCI_INTERRUPT_INTA; 1580 return 0; 1581 } 1582 1583 #ifdef CONFIG_PCIEPORTBUS 1584 extern bool pcie_ports_disabled; 1585 extern bool pcie_ports_native; 1586 #else 1587 #define pcie_ports_disabled true 1588 #define pcie_ports_native false 1589 #endif 1590 1591 #define PCIE_LINK_STATE_L0S BIT(0) 1592 #define PCIE_LINK_STATE_L1 BIT(1) 1593 #define PCIE_LINK_STATE_CLKPM BIT(2) 1594 #define PCIE_LINK_STATE_L1_1 BIT(3) 1595 #define PCIE_LINK_STATE_L1_2 BIT(4) 1596 #define PCIE_LINK_STATE_L1_1_PCIPM BIT(5) 1597 #define PCIE_LINK_STATE_L1_2_PCIPM BIT(6) 1598 1599 #ifdef CONFIG_PCIEASPM 1600 int pci_disable_link_state(struct pci_dev *pdev, int state); 1601 int pci_disable_link_state_locked(struct pci_dev *pdev, int state); 1602 void pcie_no_aspm(void); 1603 bool pcie_aspm_support_enabled(void); 1604 bool pcie_aspm_enabled(struct pci_dev *pdev); 1605 #else 1606 static inline int pci_disable_link_state(struct pci_dev *pdev, int state) 1607 { return 0; } 1608 static inline int pci_disable_link_state_locked(struct pci_dev *pdev, int state) 1609 { return 0; } 1610 static inline void pcie_no_aspm(void) { } 1611 static inline bool pcie_aspm_support_enabled(void) { return false; } 1612 static inline bool pcie_aspm_enabled(struct pci_dev *pdev) { return false; } 1613 #endif 1614 1615 #ifdef CONFIG_PCIEAER 1616 bool pci_aer_available(void); 1617 #else 1618 static inline bool pci_aer_available(void) { return false; } 1619 #endif 1620 1621 bool pci_ats_disabled(void); 1622 1623 void pci_cfg_access_lock(struct pci_dev *dev); 1624 bool pci_cfg_access_trylock(struct pci_dev *dev); 1625 void pci_cfg_access_unlock(struct pci_dev *dev); 1626 1627 int pci_dev_trylock(struct pci_dev *dev); 1628 void pci_dev_unlock(struct pci_dev *dev); 1629 1630 /* 1631 * PCI domain support. Sometimes called PCI segment (eg by ACPI), 1632 * a PCI domain is defined to be a set of PCI buses which share 1633 * configuration space. 1634 */ 1635 #ifdef CONFIG_PCI_DOMAINS 1636 extern int pci_domains_supported; 1637 #else 1638 enum { pci_domains_supported = 0 }; 1639 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; } 1640 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; } 1641 #endif /* CONFIG_PCI_DOMAINS */ 1642 1643 /* 1644 * Generic implementation for PCI domain support. If your 1645 * architecture does not need custom management of PCI 1646 * domains then this implementation will be used 1647 */ 1648 #ifdef CONFIG_PCI_DOMAINS_GENERIC 1649 static inline int pci_domain_nr(struct pci_bus *bus) 1650 { 1651 return bus->domain_nr; 1652 } 1653 #ifdef CONFIG_ACPI 1654 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus); 1655 #else 1656 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus) 1657 { return 0; } 1658 #endif 1659 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent); 1660 #endif 1661 1662 /* Some architectures require additional setup to direct VGA traffic */ 1663 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode, 1664 unsigned int command_bits, u32 flags); 1665 void pci_register_set_vga_state(arch_set_vga_state_t func); 1666 1667 static inline int 1668 pci_request_io_regions(struct pci_dev *pdev, const char *name) 1669 { 1670 return pci_request_selected_regions(pdev, 1671 pci_select_bars(pdev, IORESOURCE_IO), name); 1672 } 1673 1674 static inline void 1675 pci_release_io_regions(struct pci_dev *pdev) 1676 { 1677 return pci_release_selected_regions(pdev, 1678 pci_select_bars(pdev, IORESOURCE_IO)); 1679 } 1680 1681 static inline int 1682 pci_request_mem_regions(struct pci_dev *pdev, const char *name) 1683 { 1684 return pci_request_selected_regions(pdev, 1685 pci_select_bars(pdev, IORESOURCE_MEM), name); 1686 } 1687 1688 static inline void 1689 pci_release_mem_regions(struct pci_dev *pdev) 1690 { 1691 return pci_release_selected_regions(pdev, 1692 pci_select_bars(pdev, IORESOURCE_MEM)); 1693 } 1694 1695 #else /* CONFIG_PCI is not enabled */ 1696 1697 static inline void pci_set_flags(int flags) { } 1698 static inline void pci_add_flags(int flags) { } 1699 static inline void pci_clear_flags(int flags) { } 1700 static inline int pci_has_flag(int flag) { return 0; } 1701 1702 /* 1703 * If the system does not have PCI, clearly these return errors. Define 1704 * these as simple inline functions to avoid hair in drivers. 1705 */ 1706 #define _PCI_NOP(o, s, t) \ 1707 static inline int pci_##o##_config_##s(struct pci_dev *dev, \ 1708 int where, t val) \ 1709 { return PCIBIOS_FUNC_NOT_SUPPORTED; } 1710 1711 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \ 1712 _PCI_NOP(o, word, u16 x) \ 1713 _PCI_NOP(o, dword, u32 x) 1714 _PCI_NOP_ALL(read, *) 1715 _PCI_NOP_ALL(write,) 1716 1717 static inline struct pci_dev *pci_get_device(unsigned int vendor, 1718 unsigned int device, 1719 struct pci_dev *from) 1720 { return NULL; } 1721 1722 static inline struct pci_dev *pci_get_subsys(unsigned int vendor, 1723 unsigned int device, 1724 unsigned int ss_vendor, 1725 unsigned int ss_device, 1726 struct pci_dev *from) 1727 { return NULL; } 1728 1729 static inline struct pci_dev *pci_get_class(unsigned int class, 1730 struct pci_dev *from) 1731 { return NULL; } 1732 1733 #define pci_dev_present(ids) (0) 1734 #define no_pci_devices() (1) 1735 #define pci_dev_put(dev) do { } while (0) 1736 1737 static inline void pci_set_master(struct pci_dev *dev) { } 1738 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; } 1739 static inline void pci_disable_device(struct pci_dev *dev) { } 1740 static inline int pcim_enable_device(struct pci_dev *pdev) { return -EIO; } 1741 static inline int pci_assign_resource(struct pci_dev *dev, int i) 1742 { return -EBUSY; } 1743 static inline int __pci_register_driver(struct pci_driver *drv, 1744 struct module *owner) 1745 { return 0; } 1746 static inline int pci_register_driver(struct pci_driver *drv) 1747 { return 0; } 1748 static inline void pci_unregister_driver(struct pci_driver *drv) { } 1749 static inline u8 pci_find_capability(struct pci_dev *dev, int cap) 1750 { return 0; } 1751 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post, 1752 int cap) 1753 { return 0; } 1754 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap) 1755 { return 0; } 1756 1757 static inline u64 pci_get_dsn(struct pci_dev *dev) 1758 { return 0; } 1759 1760 /* Power management related routines */ 1761 static inline int pci_save_state(struct pci_dev *dev) { return 0; } 1762 static inline void pci_restore_state(struct pci_dev *dev) { } 1763 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state) 1764 { return 0; } 1765 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable) 1766 { return 0; } 1767 static inline pci_power_t pci_choose_state(struct pci_dev *dev, 1768 pm_message_t state) 1769 { return PCI_D0; } 1770 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state, 1771 int enable) 1772 { return 0; } 1773 1774 static inline struct resource *pci_find_resource(struct pci_dev *dev, 1775 struct resource *res) 1776 { return NULL; } 1777 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name) 1778 { return -EIO; } 1779 static inline void pci_release_regions(struct pci_dev *dev) { } 1780 1781 static inline int pci_register_io_range(struct fwnode_handle *fwnode, 1782 phys_addr_t addr, resource_size_t size) 1783 { return -EINVAL; } 1784 1785 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; } 1786 1787 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from) 1788 { return NULL; } 1789 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus, 1790 unsigned int devfn) 1791 { return NULL; } 1792 static inline struct pci_dev *pci_get_domain_bus_and_slot(int domain, 1793 unsigned int bus, unsigned int devfn) 1794 { return NULL; } 1795 1796 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; } 1797 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; } 1798 1799 #define dev_is_pci(d) (false) 1800 #define dev_is_pf(d) (false) 1801 static inline bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags) 1802 { return false; } 1803 static inline int pci_irqd_intx_xlate(struct irq_domain *d, 1804 struct device_node *node, 1805 const u32 *intspec, 1806 unsigned int intsize, 1807 unsigned long *out_hwirq, 1808 unsigned int *out_type) 1809 { return -EINVAL; } 1810 1811 static inline const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, 1812 struct pci_dev *dev) 1813 { return NULL; } 1814 static inline bool pci_ats_disabled(void) { return true; } 1815 1816 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr) 1817 { 1818 return -EINVAL; 1819 } 1820 1821 static inline int 1822 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs, 1823 unsigned int max_vecs, unsigned int flags, 1824 struct irq_affinity *aff_desc) 1825 { 1826 return -ENOSPC; 1827 } 1828 #endif /* CONFIG_PCI */ 1829 1830 static inline int 1831 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs, 1832 unsigned int max_vecs, unsigned int flags) 1833 { 1834 return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs, flags, 1835 NULL); 1836 } 1837 1838 /* Include architecture-dependent settings and functions */ 1839 1840 #include <asm/pci.h> 1841 1842 /* These two functions provide almost identical functionality. Depending 1843 * on the architecture, one will be implemented as a wrapper around the 1844 * other (in drivers/pci/mmap.c). 1845 * 1846 * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff 1847 * is expected to be an offset within that region. 1848 * 1849 * pci_mmap_page_range() is the legacy architecture-specific interface, 1850 * which accepts a "user visible" resource address converted by 1851 * pci_resource_to_user(), as used in the legacy mmap() interface in 1852 * /proc/bus/pci/. 1853 */ 1854 int pci_mmap_resource_range(struct pci_dev *dev, int bar, 1855 struct vm_area_struct *vma, 1856 enum pci_mmap_state mmap_state, int write_combine); 1857 int pci_mmap_page_range(struct pci_dev *pdev, int bar, 1858 struct vm_area_struct *vma, 1859 enum pci_mmap_state mmap_state, int write_combine); 1860 1861 #ifndef arch_can_pci_mmap_wc 1862 #define arch_can_pci_mmap_wc() 0 1863 #endif 1864 1865 #ifndef arch_can_pci_mmap_io 1866 #define arch_can_pci_mmap_io() 0 1867 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL) 1868 #else 1869 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma); 1870 #endif 1871 1872 #ifndef pci_root_bus_fwnode 1873 #define pci_root_bus_fwnode(bus) NULL 1874 #endif 1875 1876 /* 1877 * These helpers provide future and backwards compatibility 1878 * for accessing popular PCI BAR info 1879 */ 1880 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start) 1881 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end) 1882 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags) 1883 #define pci_resource_len(dev,bar) \ 1884 ((pci_resource_start((dev), (bar)) == 0 && \ 1885 pci_resource_end((dev), (bar)) == \ 1886 pci_resource_start((dev), (bar))) ? 0 : \ 1887 \ 1888 (pci_resource_end((dev), (bar)) - \ 1889 pci_resource_start((dev), (bar)) + 1)) 1890 1891 /* 1892 * Similar to the helpers above, these manipulate per-pci_dev 1893 * driver-specific data. They are really just a wrapper around 1894 * the generic device structure functions of these calls. 1895 */ 1896 static inline void *pci_get_drvdata(struct pci_dev *pdev) 1897 { 1898 return dev_get_drvdata(&pdev->dev); 1899 } 1900 1901 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data) 1902 { 1903 dev_set_drvdata(&pdev->dev, data); 1904 } 1905 1906 static inline const char *pci_name(const struct pci_dev *pdev) 1907 { 1908 return dev_name(&pdev->dev); 1909 } 1910 1911 void pci_resource_to_user(const struct pci_dev *dev, int bar, 1912 const struct resource *rsrc, 1913 resource_size_t *start, resource_size_t *end); 1914 1915 /* 1916 * The world is not perfect and supplies us with broken PCI devices. 1917 * For at least a part of these bugs we need a work-around, so both 1918 * generic (drivers/pci/quirks.c) and per-architecture code can define 1919 * fixup hooks to be called for particular buggy devices. 1920 */ 1921 1922 struct pci_fixup { 1923 u16 vendor; /* Or PCI_ANY_ID */ 1924 u16 device; /* Or PCI_ANY_ID */ 1925 u32 class; /* Or PCI_ANY_ID */ 1926 unsigned int class_shift; /* should be 0, 8, 16 */ 1927 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS 1928 int hook_offset; 1929 #else 1930 void (*hook)(struct pci_dev *dev); 1931 #endif 1932 }; 1933 1934 enum pci_fixup_pass { 1935 pci_fixup_early, /* Before probing BARs */ 1936 pci_fixup_header, /* After reading configuration header */ 1937 pci_fixup_final, /* Final phase of device fixups */ 1938 pci_fixup_enable, /* pci_enable_device() time */ 1939 pci_fixup_resume, /* pci_device_resume() */ 1940 pci_fixup_suspend, /* pci_device_suspend() */ 1941 pci_fixup_resume_early, /* pci_device_resume_early() */ 1942 pci_fixup_suspend_late, /* pci_device_suspend_late() */ 1943 }; 1944 1945 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS 1946 #define ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1947 class_shift, hook) \ 1948 __ADDRESSABLE(hook) \ 1949 asm(".section " #sec ", \"a\" \n" \ 1950 ".balign 16 \n" \ 1951 ".short " #vendor ", " #device " \n" \ 1952 ".long " #class ", " #class_shift " \n" \ 1953 ".long " #hook " - . \n" \ 1954 ".previous \n"); 1955 1956 /* 1957 * Clang's LTO may rename static functions in C, but has no way to 1958 * handle such renamings when referenced from inline asm. To work 1959 * around this, create global C stubs for these cases. 1960 */ 1961 #ifdef CONFIG_LTO_CLANG 1962 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1963 class_shift, hook, stub) \ 1964 void __cficanonical stub(struct pci_dev *dev); \ 1965 void __cficanonical stub(struct pci_dev *dev) \ 1966 { \ 1967 hook(dev); \ 1968 } \ 1969 ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1970 class_shift, stub) 1971 #else 1972 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1973 class_shift, hook, stub) \ 1974 ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1975 class_shift, hook) 1976 #endif 1977 1978 #define DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1979 class_shift, hook) \ 1980 __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \ 1981 class_shift, hook, __UNIQUE_ID(hook)) 1982 #else 1983 /* Anonymous variables would be nice... */ 1984 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \ 1985 class_shift, hook) \ 1986 static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used \ 1987 __attribute__((__section__(#section), aligned((sizeof(void *))))) \ 1988 = { vendor, device, class, class_shift, hook }; 1989 #endif 1990 1991 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \ 1992 class_shift, hook) \ 1993 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \ 1994 hook, vendor, device, class, class_shift, hook) 1995 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \ 1996 class_shift, hook) \ 1997 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \ 1998 hook, vendor, device, class, class_shift, hook) 1999 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \ 2000 class_shift, hook) \ 2001 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \ 2002 hook, vendor, device, class, class_shift, hook) 2003 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \ 2004 class_shift, hook) \ 2005 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \ 2006 hook, vendor, device, class, class_shift, hook) 2007 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \ 2008 class_shift, hook) \ 2009 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \ 2010 resume##hook, vendor, device, class, class_shift, hook) 2011 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \ 2012 class_shift, hook) \ 2013 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \ 2014 resume_early##hook, vendor, device, class, class_shift, hook) 2015 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \ 2016 class_shift, hook) \ 2017 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \ 2018 suspend##hook, vendor, device, class, class_shift, hook) 2019 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class, \ 2020 class_shift, hook) \ 2021 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \ 2022 suspend_late##hook, vendor, device, class, class_shift, hook) 2023 2024 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \ 2025 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \ 2026 hook, vendor, device, PCI_ANY_ID, 0, hook) 2027 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \ 2028 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \ 2029 hook, vendor, device, PCI_ANY_ID, 0, hook) 2030 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \ 2031 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \ 2032 hook, vendor, device, PCI_ANY_ID, 0, hook) 2033 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \ 2034 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \ 2035 hook, vendor, device, PCI_ANY_ID, 0, hook) 2036 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \ 2037 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \ 2038 resume##hook, vendor, device, PCI_ANY_ID, 0, hook) 2039 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \ 2040 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \ 2041 resume_early##hook, vendor, device, PCI_ANY_ID, 0, hook) 2042 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \ 2043 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \ 2044 suspend##hook, vendor, device, PCI_ANY_ID, 0, hook) 2045 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook) \ 2046 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \ 2047 suspend_late##hook, vendor, device, PCI_ANY_ID, 0, hook) 2048 2049 #ifdef CONFIG_PCI_QUIRKS 2050 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev); 2051 #else 2052 static inline void pci_fixup_device(enum pci_fixup_pass pass, 2053 struct pci_dev *dev) { } 2054 #endif 2055 2056 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen); 2057 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr); 2058 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev); 2059 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name); 2060 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask, 2061 const char *name); 2062 void pcim_iounmap_regions(struct pci_dev *pdev, int mask); 2063 2064 extern int pci_pci_problems; 2065 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */ 2066 #define PCIPCI_TRITON 2 2067 #define PCIPCI_NATOMA 4 2068 #define PCIPCI_VIAETBF 8 2069 #define PCIPCI_VSFX 16 2070 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */ 2071 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */ 2072 2073 extern unsigned long pci_cardbus_io_size; 2074 extern unsigned long pci_cardbus_mem_size; 2075 extern u8 pci_dfl_cache_line_size; 2076 extern u8 pci_cache_line_size; 2077 2078 /* Architecture-specific versions may override these (weak) */ 2079 void pcibios_disable_device(struct pci_dev *dev); 2080 void pcibios_set_master(struct pci_dev *dev); 2081 int pcibios_set_pcie_reset_state(struct pci_dev *dev, 2082 enum pcie_reset_state state); 2083 int pcibios_add_device(struct pci_dev *dev); 2084 void pcibios_release_device(struct pci_dev *dev); 2085 #ifdef CONFIG_PCI 2086 void pcibios_penalize_isa_irq(int irq, int active); 2087 #else 2088 static inline void pcibios_penalize_isa_irq(int irq, int active) {} 2089 #endif 2090 int pcibios_alloc_irq(struct pci_dev *dev); 2091 void pcibios_free_irq(struct pci_dev *dev); 2092 resource_size_t pcibios_default_alignment(void); 2093 2094 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG) 2095 void __init pci_mmcfg_early_init(void); 2096 void __init pci_mmcfg_late_init(void); 2097 #else 2098 static inline void pci_mmcfg_early_init(void) { } 2099 static inline void pci_mmcfg_late_init(void) { } 2100 #endif 2101 2102 int pci_ext_cfg_avail(void); 2103 2104 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar); 2105 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar); 2106 2107 #ifdef CONFIG_PCI_IOV 2108 int pci_iov_virtfn_bus(struct pci_dev *dev, int id); 2109 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id); 2110 2111 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn); 2112 void pci_disable_sriov(struct pci_dev *dev); 2113 2114 int pci_iov_sysfs_link(struct pci_dev *dev, struct pci_dev *virtfn, int id); 2115 int pci_iov_add_virtfn(struct pci_dev *dev, int id); 2116 void pci_iov_remove_virtfn(struct pci_dev *dev, int id); 2117 int pci_num_vf(struct pci_dev *dev); 2118 int pci_vfs_assigned(struct pci_dev *dev); 2119 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs); 2120 int pci_sriov_get_totalvfs(struct pci_dev *dev); 2121 int pci_sriov_configure_simple(struct pci_dev *dev, int nr_virtfn); 2122 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno); 2123 void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe); 2124 2125 /* Arch may override these (weak) */ 2126 int pcibios_sriov_enable(struct pci_dev *pdev, u16 num_vfs); 2127 int pcibios_sriov_disable(struct pci_dev *pdev); 2128 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno); 2129 #else 2130 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id) 2131 { 2132 return -ENOSYS; 2133 } 2134 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id) 2135 { 2136 return -ENOSYS; 2137 } 2138 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn) 2139 { return -ENODEV; } 2140 2141 static inline int pci_iov_sysfs_link(struct pci_dev *dev, 2142 struct pci_dev *virtfn, int id) 2143 { 2144 return -ENODEV; 2145 } 2146 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id) 2147 { 2148 return -ENOSYS; 2149 } 2150 static inline void pci_iov_remove_virtfn(struct pci_dev *dev, 2151 int id) { } 2152 static inline void pci_disable_sriov(struct pci_dev *dev) { } 2153 static inline int pci_num_vf(struct pci_dev *dev) { return 0; } 2154 static inline int pci_vfs_assigned(struct pci_dev *dev) 2155 { return 0; } 2156 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs) 2157 { return 0; } 2158 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev) 2159 { return 0; } 2160 #define pci_sriov_configure_simple NULL 2161 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno) 2162 { return 0; } 2163 static inline void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe) { } 2164 #endif 2165 2166 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE) 2167 void pci_hp_create_module_link(struct pci_slot *pci_slot); 2168 void pci_hp_remove_module_link(struct pci_slot *pci_slot); 2169 #endif 2170 2171 /** 2172 * pci_pcie_cap - get the saved PCIe capability offset 2173 * @dev: PCI device 2174 * 2175 * PCIe capability offset is calculated at PCI device initialization 2176 * time and saved in the data structure. This function returns saved 2177 * PCIe capability offset. Using this instead of pci_find_capability() 2178 * reduces unnecessary search in the PCI configuration space. If you 2179 * need to calculate PCIe capability offset from raw device for some 2180 * reasons, please use pci_find_capability() instead. 2181 */ 2182 static inline int pci_pcie_cap(struct pci_dev *dev) 2183 { 2184 return dev->pcie_cap; 2185 } 2186 2187 /** 2188 * pci_is_pcie - check if the PCI device is PCI Express capable 2189 * @dev: PCI device 2190 * 2191 * Returns: true if the PCI device is PCI Express capable, false otherwise. 2192 */ 2193 static inline bool pci_is_pcie(struct pci_dev *dev) 2194 { 2195 return pci_pcie_cap(dev); 2196 } 2197 2198 /** 2199 * pcie_caps_reg - get the PCIe Capabilities Register 2200 * @dev: PCI device 2201 */ 2202 static inline u16 pcie_caps_reg(const struct pci_dev *dev) 2203 { 2204 return dev->pcie_flags_reg; 2205 } 2206 2207 /** 2208 * pci_pcie_type - get the PCIe device/port type 2209 * @dev: PCI device 2210 */ 2211 static inline int pci_pcie_type(const struct pci_dev *dev) 2212 { 2213 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4; 2214 } 2215 2216 /** 2217 * pcie_find_root_port - Get the PCIe root port device 2218 * @dev: PCI device 2219 * 2220 * Traverse up the parent chain and return the PCIe Root Port PCI Device 2221 * for a given PCI/PCIe Device. 2222 */ 2223 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev) 2224 { 2225 while (dev) { 2226 if (pci_is_pcie(dev) && 2227 pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT) 2228 return dev; 2229 dev = pci_upstream_bridge(dev); 2230 } 2231 2232 return NULL; 2233 } 2234 2235 void pci_request_acs(void); 2236 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags); 2237 bool pci_acs_path_enabled(struct pci_dev *start, 2238 struct pci_dev *end, u16 acs_flags); 2239 int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask); 2240 2241 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */ 2242 #define PCI_VPD_LRDT_ID(x) ((x) | PCI_VPD_LRDT) 2243 2244 /* Large Resource Data Type Tag Item Names */ 2245 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */ 2246 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */ 2247 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */ 2248 2249 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING) 2250 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA) 2251 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA) 2252 2253 /* Small Resource Data Type Tag Item Names */ 2254 #define PCI_VPD_STIN_END 0x0f /* End */ 2255 2256 #define PCI_VPD_SRDT_END (PCI_VPD_STIN_END << 3) 2257 2258 #define PCI_VPD_SRDT_TIN_MASK 0x78 2259 #define PCI_VPD_SRDT_LEN_MASK 0x07 2260 #define PCI_VPD_LRDT_TIN_MASK 0x7f 2261 2262 #define PCI_VPD_LRDT_TAG_SIZE 3 2263 #define PCI_VPD_SRDT_TAG_SIZE 1 2264 2265 #define PCI_VPD_INFO_FLD_HDR_SIZE 3 2266 2267 #define PCI_VPD_RO_KEYWORD_PARTNO "PN" 2268 #define PCI_VPD_RO_KEYWORD_SERIALNO "SN" 2269 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN" 2270 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0" 2271 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV" 2272 2273 /** 2274 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length 2275 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag 2276 * 2277 * Returns the extracted Large Resource Data Type length. 2278 */ 2279 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt) 2280 { 2281 return (u16)lrdt[1] + ((u16)lrdt[2] << 8); 2282 } 2283 2284 /** 2285 * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item 2286 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag 2287 * 2288 * Returns the extracted Large Resource Data Type Tag item. 2289 */ 2290 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt) 2291 { 2292 return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK); 2293 } 2294 2295 /** 2296 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length 2297 * @srdt: Pointer to the beginning of the Small Resource Data Type tag 2298 * 2299 * Returns the extracted Small Resource Data Type length. 2300 */ 2301 static inline u8 pci_vpd_srdt_size(const u8 *srdt) 2302 { 2303 return (*srdt) & PCI_VPD_SRDT_LEN_MASK; 2304 } 2305 2306 /** 2307 * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item 2308 * @srdt: Pointer to the beginning of the Small Resource Data Type tag 2309 * 2310 * Returns the extracted Small Resource Data Type Tag Item. 2311 */ 2312 static inline u8 pci_vpd_srdt_tag(const u8 *srdt) 2313 { 2314 return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3; 2315 } 2316 2317 /** 2318 * pci_vpd_info_field_size - Extracts the information field length 2319 * @info_field: Pointer to the beginning of an information field header 2320 * 2321 * Returns the extracted information field length. 2322 */ 2323 static inline u8 pci_vpd_info_field_size(const u8 *info_field) 2324 { 2325 return info_field[2]; 2326 } 2327 2328 /** 2329 * pci_vpd_find_tag - Locates the Resource Data Type tag provided 2330 * @buf: Pointer to buffered vpd data 2331 * @len: The length of the vpd buffer 2332 * @rdt: The Resource Data Type to search for 2333 * 2334 * Returns the index where the Resource Data Type was found or 2335 * -ENOENT otherwise. 2336 */ 2337 int pci_vpd_find_tag(const u8 *buf, unsigned int len, u8 rdt); 2338 2339 /** 2340 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD 2341 * @buf: Pointer to buffered vpd data 2342 * @off: The offset into the buffer at which to begin the search 2343 * @len: The length of the buffer area, relative to off, in which to search 2344 * @kw: The keyword to search for 2345 * 2346 * Returns the index where the information field keyword was found or 2347 * -ENOENT otherwise. 2348 */ 2349 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off, 2350 unsigned int len, const char *kw); 2351 2352 /* PCI <-> OF binding helpers */ 2353 #ifdef CONFIG_OF 2354 struct device_node; 2355 struct irq_domain; 2356 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus); 2357 bool pci_host_of_has_msi_map(struct device *dev); 2358 2359 /* Arch may override this (weak) */ 2360 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus); 2361 2362 #else /* CONFIG_OF */ 2363 static inline struct irq_domain * 2364 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; } 2365 static inline bool pci_host_of_has_msi_map(struct device *dev) { return false; } 2366 #endif /* CONFIG_OF */ 2367 2368 static inline struct device_node * 2369 pci_device_to_OF_node(const struct pci_dev *pdev) 2370 { 2371 return pdev ? pdev->dev.of_node : NULL; 2372 } 2373 2374 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus) 2375 { 2376 return bus ? bus->dev.of_node : NULL; 2377 } 2378 2379 #ifdef CONFIG_ACPI 2380 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus); 2381 2382 void 2383 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *)); 2384 bool pci_pr3_present(struct pci_dev *pdev); 2385 #else 2386 static inline struct irq_domain * 2387 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; } 2388 static inline bool pci_pr3_present(struct pci_dev *pdev) { return false; } 2389 #endif 2390 2391 #ifdef CONFIG_EEH 2392 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev) 2393 { 2394 return pdev->dev.archdata.edev; 2395 } 2396 #endif 2397 2398 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from, unsigned nr_devfns); 2399 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2); 2400 int pci_for_each_dma_alias(struct pci_dev *pdev, 2401 int (*fn)(struct pci_dev *pdev, 2402 u16 alias, void *data), void *data); 2403 2404 /* Helper functions for operation of device flag */ 2405 static inline void pci_set_dev_assigned(struct pci_dev *pdev) 2406 { 2407 pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED; 2408 } 2409 static inline void pci_clear_dev_assigned(struct pci_dev *pdev) 2410 { 2411 pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED; 2412 } 2413 static inline bool pci_is_dev_assigned(struct pci_dev *pdev) 2414 { 2415 return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED; 2416 } 2417 2418 /** 2419 * pci_ari_enabled - query ARI forwarding status 2420 * @bus: the PCI bus 2421 * 2422 * Returns true if ARI forwarding is enabled. 2423 */ 2424 static inline bool pci_ari_enabled(struct pci_bus *bus) 2425 { 2426 return bus->self && bus->self->ari_enabled; 2427 } 2428 2429 /** 2430 * pci_is_thunderbolt_attached - whether device is on a Thunderbolt daisy chain 2431 * @pdev: PCI device to check 2432 * 2433 * Walk upwards from @pdev and check for each encountered bridge if it's part 2434 * of a Thunderbolt controller. Reaching the host bridge means @pdev is not 2435 * Thunderbolt-attached. (But rather soldered to the mainboard usually.) 2436 */ 2437 static inline bool pci_is_thunderbolt_attached(struct pci_dev *pdev) 2438 { 2439 struct pci_dev *parent = pdev; 2440 2441 if (pdev->is_thunderbolt) 2442 return true; 2443 2444 while ((parent = pci_upstream_bridge(parent))) 2445 if (parent->is_thunderbolt) 2446 return true; 2447 2448 return false; 2449 } 2450 2451 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH) 2452 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type); 2453 #endif 2454 2455 /* Provide the legacy pci_dma_* API */ 2456 #include <linux/pci-dma-compat.h> 2457 2458 #define pci_printk(level, pdev, fmt, arg...) \ 2459 dev_printk(level, &(pdev)->dev, fmt, ##arg) 2460 2461 #define pci_emerg(pdev, fmt, arg...) dev_emerg(&(pdev)->dev, fmt, ##arg) 2462 #define pci_alert(pdev, fmt, arg...) dev_alert(&(pdev)->dev, fmt, ##arg) 2463 #define pci_crit(pdev, fmt, arg...) dev_crit(&(pdev)->dev, fmt, ##arg) 2464 #define pci_err(pdev, fmt, arg...) dev_err(&(pdev)->dev, fmt, ##arg) 2465 #define pci_warn(pdev, fmt, arg...) dev_warn(&(pdev)->dev, fmt, ##arg) 2466 #define pci_notice(pdev, fmt, arg...) dev_notice(&(pdev)->dev, fmt, ##arg) 2467 #define pci_info(pdev, fmt, arg...) dev_info(&(pdev)->dev, fmt, ##arg) 2468 #define pci_dbg(pdev, fmt, arg...) dev_dbg(&(pdev)->dev, fmt, ##arg) 2469 2470 #define pci_notice_ratelimited(pdev, fmt, arg...) \ 2471 dev_notice_ratelimited(&(pdev)->dev, fmt, ##arg) 2472 2473 #define pci_info_ratelimited(pdev, fmt, arg...) \ 2474 dev_info_ratelimited(&(pdev)->dev, fmt, ##arg) 2475 2476 #define pci_WARN(pdev, condition, fmt, arg...) \ 2477 WARN(condition, "%s %s: " fmt, \ 2478 dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg) 2479 2480 #define pci_WARN_ONCE(pdev, condition, fmt, arg...) \ 2481 WARN_ONCE(condition, "%s %s: " fmt, \ 2482 dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg) 2483 2484 #endif /* LINUX_PCI_H */ 2485