drivers/pci/pci.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef DRIVERS_PCI_H
   3 #define DRIVERS_PCI_H
   4
   5 #include <linux/pci.h>
   6
   7 /* Number of possible devfns: 0.0 to 1f.7 inclusive */
   8 #define MAX_NR_DEVFNS 256
   9
  10 #define PCI_FIND_CAP_TTL        48
  11
  12 #define PCI_VSEC_ID_INTEL_TBT   0x1234  /* Thunderbolt */
  13
  14 #define PCIE_LINK_RETRAIN_TIMEOUT_MS    1000
  15
  16 /* Power stable to PERST# inactive from PCIe card Electromechanical Spec */
  17 #define PCIE_T_PVPERL_MS                100
  18
  19 /*
  20  * PCIe r6.0, sec 5.3.3.2.1 <PME Synchronization>
  21  * Recommends 1ms to 10ms timeout to check L2 ready.
  22  */
  23 #define PCIE_PME_TO_L2_TIMEOUT_US       10000
  24
  25 extern const unsigned char pcie_link_speed[];
  26 extern bool pci_early_dump;
  27
  28 bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
  29 bool pcie_cap_has_lnkctl2(const struct pci_dev *dev);
  30 bool pcie_cap_has_rtctl(const struct pci_dev *dev);
  31
  32 /* Functions internal to the PCI core code */
  33
  34 #ifdef CONFIG_DMI
  35 extern const struct attribute_group pci_dev_smbios_attr_group;
  36 #endif
  37
  38 enum pci_mmap_api {
  39         PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
  40         PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
  41 };
  42 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
  43                   enum pci_mmap_api mmap_api);
  44
  45 bool pci_reset_supported(struct pci_dev *dev);
  46 void pci_init_reset_methods(struct pci_dev *dev);
  47 int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
  48 int pci_bus_error_reset(struct pci_dev *dev);
  49
  50 struct pci_cap_saved_data {
  51         u16             cap_nr;
  52         bool            cap_extended;
  53         unsigned int    size;
  54         u32             data[];
  55 };
  56
  57 struct pci_cap_saved_state {
  58         struct hlist_node               next;
  59         struct pci_cap_saved_data       cap;
  60 };
  61
  62 void pci_allocate_cap_save_buffers(struct pci_dev *dev);
  63 void pci_free_cap_save_buffers(struct pci_dev *dev);
  64 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
  65 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
  66                                 u16 cap, unsigned int size);
  67 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
  68 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
  69                                                    u16 cap);
  70
  71 #define PCI_PM_D2_DELAY         200     /* usec; see PCIe r4.0, sec 5.9.1 */
  72 #define PCI_PM_D3HOT_WAIT       10      /* msec */
  73 #define PCI_PM_D3COLD_WAIT      100     /* msec */
  74
  75 void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
  76 void pci_refresh_power_state(struct pci_dev *dev);
  77 int pci_power_up(struct pci_dev *dev);
  78 void pci_disable_enabled_device(struct pci_dev *dev);
  79 int pci_finish_runtime_suspend(struct pci_dev *dev);
  80 void pcie_clear_device_status(struct pci_dev *dev);
  81 void pcie_clear_root_pme_status(struct pci_dev *dev);
  82 bool pci_check_pme_status(struct pci_dev *dev);
  83 void pci_pme_wakeup_bus(struct pci_bus *bus);
  84 int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
  85 void pci_pme_restore(struct pci_dev *dev);
  86 bool pci_dev_need_resume(struct pci_dev *dev);
  87 void pci_dev_adjust_pme(struct pci_dev *dev);
  88 void pci_dev_complete_resume(struct pci_dev *pci_dev);
  89 void pci_config_pm_runtime_get(struct pci_dev *dev);
  90 void pci_config_pm_runtime_put(struct pci_dev *dev);
  91 void pci_pm_init(struct pci_dev *dev);
  92 void pci_ea_init(struct pci_dev *dev);
  93 void pci_msi_init(struct pci_dev *dev);
  94 void pci_msix_init(struct pci_dev *dev);
  95 bool pci_bridge_d3_possible(struct pci_dev *dev);
  96 void pci_bridge_d3_update(struct pci_dev *dev);
  97 void pci_bridge_reconfigure_ltr(struct pci_dev *dev);
  98 int pci_bridge_wait_for_secondary_bus(struct pci_dev *dev, char *reset_type);
  99
 100 static inline void pci_wakeup_event(struct pci_dev *dev)
 101 {
 102         /* Wait 100 ms before the system can be put into a sleep state. */
 103         pm_wakeup_event(&dev->dev, 100);
 104 }
 105
 106 static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
 107 {
 108         return !!(pci_dev->subordinate);
 109 }
 110
 111 static inline bool pci_power_manageable(struct pci_dev *pci_dev)
 112 {
 113         /*
 114          * Currently we allow normal PCI devices and PCI bridges transition
 115          * into D3 if their bridge_d3 is set.
 116          */
 117         return !pci_has_subordinate(pci_dev) || pci_dev->bridge_d3;
 118 }
 119
 120 static inline bool pcie_downstream_port(const struct pci_dev *dev)
 121 {
 122         int type = pci_pcie_type(dev);
 123
 124         return type == PCI_EXP_TYPE_ROOT_PORT ||
 125                type == PCI_EXP_TYPE_DOWNSTREAM ||
 126                type == PCI_EXP_TYPE_PCIE_BRIDGE;
 127 }
 128
 129 void pci_vpd_init(struct pci_dev *dev);
 130 void pci_vpd_release(struct pci_dev *dev);
 131 extern const struct attribute_group pci_dev_vpd_attr_group;
 132
 133 /* PCI Virtual Channel */
 134 int pci_save_vc_state(struct pci_dev *dev);
 135 void pci_restore_vc_state(struct pci_dev *dev);
 136 void pci_allocate_vc_save_buffers(struct pci_dev *dev);
 137
 138 /* PCI /proc functions */
 139 #ifdef CONFIG_PROC_FS
 140 int pci_proc_attach_device(struct pci_dev *dev);
 141 int pci_proc_detach_device(struct pci_dev *dev);
 142 int pci_proc_detach_bus(struct pci_bus *bus);
 143 #else
 144 static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
 145 static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
 146 static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
 147 #endif
 148
 149 /* Functions for PCI Hotplug drivers to use */
 150 int pci_hp_add_bridge(struct pci_dev *dev);
 151
 152 #if defined(CONFIG_SYSFS) && defined(HAVE_PCI_LEGACY)
 153 void pci_create_legacy_files(struct pci_bus *bus);
 154 void pci_remove_legacy_files(struct pci_bus *bus);
 155 #else
 156 static inline void pci_create_legacy_files(struct pci_bus *bus) { }
 157 static inline void pci_remove_legacy_files(struct pci_bus *bus) { }
 158 #endif
 159
 160 /* Lock for read/write access to pci device and bus lists */
 161 extern struct rw_semaphore pci_bus_sem;
 162 extern struct mutex pci_slot_mutex;
 163
 164 extern raw_spinlock_t pci_lock;
 165
 166 extern unsigned int pci_pm_d3hot_delay;
 167
 168 #ifdef CONFIG_PCI_MSI
 169 void pci_no_msi(void);
 170 #else
 171 static inline void pci_no_msi(void) { }
 172 #endif
 173
 174 void pci_realloc_get_opt(char *);
 175
 176 static inline int pci_no_d1d2(struct pci_dev *dev)
 177 {
 178         unsigned int parent_dstates = 0;
 179
 180         if (dev->bus->self)
 181                 parent_dstates = dev->bus->self->no_d1d2;
 182         return (dev->no_d1d2 || parent_dstates);
 183
 184 }
 185
 186 #ifdef CONFIG_SYSFS
 187 int pci_create_sysfs_dev_files(struct pci_dev *pdev);
 188 void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
 189 extern const struct attribute_group *pci_dev_groups[];
 190 extern const struct attribute_group *pci_dev_attr_groups[];
 191 extern const struct attribute_group *pcibus_groups[];
 192 extern const struct attribute_group *pci_bus_groups[];
 193 #else
 194 static inline int pci_create_sysfs_dev_files(struct pci_dev *pdev) { return 0; }
 195 static inline void pci_remove_sysfs_dev_files(struct pci_dev *pdev) { }
 196 #define pci_dev_groups NULL
 197 #define pci_dev_attr_groups NULL
 198 #define pcibus_groups NULL
 199 #define pci_bus_groups NULL
 200 #endif
 201
 202 extern unsigned long pci_hotplug_io_size;
 203 extern unsigned long pci_hotplug_mmio_size;
 204 extern unsigned long pci_hotplug_mmio_pref_size;
 205 extern unsigned long pci_hotplug_bus_size;
 206
 207 /**
 208  * pci_match_one_device - Tell if a PCI device structure has a matching
 209  *                        PCI device id structure
 210  * @id: single PCI device id structure to match
 211  * @dev: the PCI device structure to match against
 212  *
 213  * Returns the matching pci_device_id structure or %NULL if there is no match.
 214  */
 215 static inline const struct pci_device_id *
 216 pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
 217 {
 218         if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
 219             (id->device == PCI_ANY_ID || id->device == dev->device) &&
 220             (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
 221             (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
 222             !((id->class ^ dev->class) & id->class_mask))
 223                 return id;
 224         return NULL;
 225 }
 226
 227 /* PCI slot sysfs helper code */
 228 #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
 229
 230 extern struct kset *pci_slots_kset;
 231
 232 struct pci_slot_attribute {
 233         struct attribute attr;
 234         ssize_t (*show)(struct pci_slot *, char *);
 235         ssize_t (*store)(struct pci_slot *, const char *, size_t);
 236 };
 237 #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
 238
 239 enum pci_bar_type {
 240         pci_bar_unknown,        /* Standard PCI BAR probe */
 241         pci_bar_io,             /* An I/O port BAR */
 242         pci_bar_mem32,          /* A 32-bit memory BAR */
 243         pci_bar_mem64,          /* A 64-bit memory BAR */
 244 };
 245
 246 struct device *pci_get_host_bridge_device(struct pci_dev *dev);
 247 void pci_put_host_bridge_device(struct device *dev);
 248
 249 int pci_configure_extended_tags(struct pci_dev *dev, void *ign);
 250 bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
 251                                 int crs_timeout);
 252 bool pci_bus_generic_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
 253                                         int crs_timeout);
 254 int pci_idt_bus_quirk(struct pci_bus *bus, int devfn, u32 *pl, int crs_timeout);
 255
 256 int pci_setup_device(struct pci_dev *dev);
 257 int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
 258                     struct resource *res, unsigned int reg);
 259 void pci_configure_ari(struct pci_dev *dev);
 260 void __pci_bus_size_bridges(struct pci_bus *bus,
 261                         struct list_head *realloc_head);
 262 void __pci_bus_assign_resources(const struct pci_bus *bus,
 263                                 struct list_head *realloc_head,
 264                                 struct list_head *fail_head);
 265 bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
 266
 267 const char *pci_resource_name(struct pci_dev *dev, unsigned int i);
 268
 269 void pci_reassigndev_resource_alignment(struct pci_dev *dev);
 270 void pci_disable_bridge_window(struct pci_dev *dev);
 271 struct pci_bus *pci_bus_get(struct pci_bus *bus);
 272 void pci_bus_put(struct pci_bus *bus);
 273
 274 /* PCIe link information from Link Capabilities 2 */
 275 #define PCIE_LNKCAP2_SLS2SPEED(lnkcap2) \
 276         ((lnkcap2) & PCI_EXP_LNKCAP2_SLS_64_0GB ? PCIE_SPEED_64_0GT : \
 277          (lnkcap2) & PCI_EXP_LNKCAP2_SLS_32_0GB ? PCIE_SPEED_32_0GT : \
 278          (lnkcap2) & PCI_EXP_LNKCAP2_SLS_16_0GB ? PCIE_SPEED_16_0GT : \
 279          (lnkcap2) & PCI_EXP_LNKCAP2_SLS_8_0GB ? PCIE_SPEED_8_0GT : \
 280          (lnkcap2) & PCI_EXP_LNKCAP2_SLS_5_0GB ? PCIE_SPEED_5_0GT : \
 281          (lnkcap2) & PCI_EXP_LNKCAP2_SLS_2_5GB ? PCIE_SPEED_2_5GT : \
 282          PCI_SPEED_UNKNOWN)
 283
 284 /* PCIe speed to Mb/s reduced by encoding overhead */
 285 #define PCIE_SPEED2MBS_ENC(speed) \
 286         ((speed) == PCIE_SPEED_64_0GT ? 64000*1/1 : \
 287          (speed) == PCIE_SPEED_32_0GT ? 32000*128/130 : \
 288          (speed) == PCIE_SPEED_16_0GT ? 16000*128/130 : \
 289          (speed) == PCIE_SPEED_8_0GT  ?  8000*128/130 : \
 290          (speed) == PCIE_SPEED_5_0GT  ?  5000*8/10 : \
 291          (speed) == PCIE_SPEED_2_5GT  ?  2500*8/10 : \
 292          0)
 293
 294 const char *pci_speed_string(enum pci_bus_speed speed);
 295 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
 296 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
 297 u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
 298                            enum pcie_link_width *width);
 299 void __pcie_print_link_status(struct pci_dev *dev, bool verbose);
 300 void pcie_report_downtraining(struct pci_dev *dev);
 301 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
 302
 303 /* Single Root I/O Virtualization */
 304 struct pci_sriov {
 305         int             pos;            /* Capability position */
 306         int             nres;           /* Number of resources */
 307         u32             cap;            /* SR-IOV Capabilities */
 308         u16             ctrl;           /* SR-IOV Control */
 309         u16             total_VFs;      /* Total VFs associated with the PF */
 310         u16             initial_VFs;    /* Initial VFs associated with the PF */
 311         u16             num_VFs;        /* Number of VFs available */
 312         u16             offset;         /* First VF Routing ID offset */
 313         u16             stride;         /* Following VF stride */
 314         u16             vf_device;      /* VF device ID */
 315         u32             pgsz;           /* Page size for BAR alignment */
 316         u8              link;           /* Function Dependency Link */
 317         u8              max_VF_buses;   /* Max buses consumed by VFs */
 318         u16             driver_max_VFs; /* Max num VFs driver supports */
 319         struct pci_dev  *dev;           /* Lowest numbered PF */
 320         struct pci_dev  *self;          /* This PF */
 321         u32             class;          /* VF device */
 322         u8              hdr_type;       /* VF header type */
 323         u16             subsystem_vendor; /* VF subsystem vendor */
 324         u16             subsystem_device; /* VF subsystem device */
 325         resource_size_t barsz[PCI_SRIOV_NUM_BARS];      /* VF BAR size */
 326         bool            drivers_autoprobe; /* Auto probing of VFs by driver */
 327 };
 328
 329 #ifdef CONFIG_PCI_DOE
 330 void pci_doe_init(struct pci_dev *pdev);
 331 void pci_doe_destroy(struct pci_dev *pdev);
 332 void pci_doe_disconnected(struct pci_dev *pdev);
 333 #else
 334 static inline void pci_doe_init(struct pci_dev *pdev) { }
 335 static inline void pci_doe_destroy(struct pci_dev *pdev) { }
 336 static inline void pci_doe_disconnected(struct pci_dev *pdev) { }
 337 #endif
 338
 339 /**
 340  * pci_dev_set_io_state - Set the new error state if possible.
 341  *
 342  * @dev: PCI device to set new error_state
 343  * @new: the state we want dev to be in
 344  *
 345  * If the device is experiencing perm_failure, it has to remain in that state.
 346  * Any other transition is allowed.
 347  *
 348  * Returns true if state has been changed to the requested state.
 349  */
 350 static inline bool pci_dev_set_io_state(struct pci_dev *dev,
 351                                         pci_channel_state_t new)
 352 {
 353         pci_channel_state_t old;
 354
 355         switch (new) {
 356         case pci_channel_io_perm_failure:
 357                 xchg(&dev->error_state, pci_channel_io_perm_failure);
 358                 return true;
 359         case pci_channel_io_frozen:
 360                 old = cmpxchg(&dev->error_state, pci_channel_io_normal,
 361                               pci_channel_io_frozen);
 362                 return old != pci_channel_io_perm_failure;
 363         case pci_channel_io_normal:
 364                 old = cmpxchg(&dev->error_state, pci_channel_io_frozen,
 365                               pci_channel_io_normal);
 366                 return old != pci_channel_io_perm_failure;
 367         default:
 368                 return false;
 369         }
 370 }
 371
 372 static inline int pci_dev_set_disconnected(struct pci_dev *dev, void *unused)
 373 {
 374         pci_dev_set_io_state(dev, pci_channel_io_perm_failure);
 375         pci_doe_disconnected(dev);
 376
 377         return 0;
 378 }
 379
 380 static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
 381 {
 382         return dev->error_state == pci_channel_io_perm_failure;
 383 }
 384
 385 /* pci_dev priv_flags */
 386 #define PCI_DEV_ADDED 0
 387 #define PCI_DPC_RECOVERED 1
 388 #define PCI_DPC_RECOVERING 2
 389
 390 static inline void pci_dev_assign_added(struct pci_dev *dev, bool added)
 391 {
 392         assign_bit(PCI_DEV_ADDED, &dev->priv_flags, added);
 393 }
 394
 395 static inline bool pci_dev_is_added(const struct pci_dev *dev)
 396 {
 397         return test_bit(PCI_DEV_ADDED, &dev->priv_flags);
 398 }
 399
 400 #ifdef CONFIG_PCIEAER
 401 #include <linux/aer.h>
 402
 403 #define AER_MAX_MULTI_ERR_DEVICES       5       /* Not likely to have more */
 404
 405 struct aer_err_info {
 406         struct pci_dev *dev[AER_MAX_MULTI_ERR_DEVICES];
 407         int error_dev_num;
 408
 409         unsigned int id:16;
 410
 411         unsigned int severity:2;        /* 0:NONFATAL | 1:FATAL | 2:COR */
 412         unsigned int __pad1:5;
 413         unsigned int multi_error_valid:1;
 414
 415         unsigned int first_error:5;
 416         unsigned int __pad2:2;
 417         unsigned int tlp_header_valid:1;
 418
 419         unsigned int status;            /* COR/UNCOR Error Status */
 420         unsigned int mask;              /* COR/UNCOR Error Mask */
 421         struct aer_header_log_regs tlp; /* TLP Header */
 422 };
 423
 424 int aer_get_device_error_info(struct pci_dev *dev, struct aer_err_info *info);
 425 void aer_print_error(struct pci_dev *dev, struct aer_err_info *info);
 426 #endif  /* CONFIG_PCIEAER */
 427
 428 #ifdef CONFIG_PCIEPORTBUS
 429 /* Cached RCEC Endpoint Association */
 430 struct rcec_ea {
 431         u8              nextbusn;
 432         u8              lastbusn;
 433         u32             bitmap;
 434 };
 435 #endif
 436
 437 #ifdef CONFIG_PCIE_DPC
 438 void pci_save_dpc_state(struct pci_dev *dev);
 439 void pci_restore_dpc_state(struct pci_dev *dev);
 440 void pci_dpc_init(struct pci_dev *pdev);
 441 void dpc_process_error(struct pci_dev *pdev);
 442 pci_ers_result_t dpc_reset_link(struct pci_dev *pdev);
 443 bool pci_dpc_recovered(struct pci_dev *pdev);
 444 #else
 445 static inline void pci_save_dpc_state(struct pci_dev *dev) { }
 446 static inline void pci_restore_dpc_state(struct pci_dev *dev) { }
 447 static inline void pci_dpc_init(struct pci_dev *pdev) { }
 448 static inline bool pci_dpc_recovered(struct pci_dev *pdev) { return false; }
 449 #endif
 450
 451 #ifdef CONFIG_PCIEPORTBUS
 452 void pci_rcec_init(struct pci_dev *dev);
 453 void pci_rcec_exit(struct pci_dev *dev);
 454 void pcie_link_rcec(struct pci_dev *rcec);
 455 void pcie_walk_rcec(struct pci_dev *rcec,
 456                     int (*cb)(struct pci_dev *, void *),
 457                     void *userdata);
 458 #else
 459 static inline void pci_rcec_init(struct pci_dev *dev) { }
 460 static inline void pci_rcec_exit(struct pci_dev *dev) { }
 461 static inline void pcie_link_rcec(struct pci_dev *rcec) { }
 462 static inline void pcie_walk_rcec(struct pci_dev *rcec,
 463                                   int (*cb)(struct pci_dev *, void *),
 464                                   void *userdata) { }
 465 #endif
 466
 467 #ifdef CONFIG_PCI_ATS
 468 /* Address Translation Service */
 469 void pci_ats_init(struct pci_dev *dev);
 470 void pci_restore_ats_state(struct pci_dev *dev);
 471 #else
 472 static inline void pci_ats_init(struct pci_dev *d) { }
 473 static inline void pci_restore_ats_state(struct pci_dev *dev) { }
 474 #endif /* CONFIG_PCI_ATS */
 475
 476 #ifdef CONFIG_PCI_PRI
 477 void pci_pri_init(struct pci_dev *dev);
 478 void pci_restore_pri_state(struct pci_dev *pdev);
 479 #else
 480 static inline void pci_pri_init(struct pci_dev *dev) { }
 481 static inline void pci_restore_pri_state(struct pci_dev *pdev) { }
 482 #endif
 483
 484 #ifdef CONFIG_PCI_PASID
 485 void pci_pasid_init(struct pci_dev *dev);
 486 void pci_restore_pasid_state(struct pci_dev *pdev);
 487 #else
 488 static inline void pci_pasid_init(struct pci_dev *dev) { }
 489 static inline void pci_restore_pasid_state(struct pci_dev *pdev) { }
 490 #endif
 491
 492 #ifdef CONFIG_PCI_IOV
 493 int pci_iov_init(struct pci_dev *dev);
 494 void pci_iov_release(struct pci_dev *dev);
 495 void pci_iov_remove(struct pci_dev *dev);
 496 void pci_iov_update_resource(struct pci_dev *dev, int resno);
 497 resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
 498 void pci_restore_iov_state(struct pci_dev *dev);
 499 int pci_iov_bus_range(struct pci_bus *bus);
 500 extern const struct attribute_group sriov_pf_dev_attr_group;
 501 extern const struct attribute_group sriov_vf_dev_attr_group;
 502 #else
 503 static inline int pci_iov_init(struct pci_dev *dev)
 504 {
 505         return -ENODEV;
 506 }
 507 static inline void pci_iov_release(struct pci_dev *dev) { }
 508 static inline void pci_iov_remove(struct pci_dev *dev) { }
 509 static inline void pci_restore_iov_state(struct pci_dev *dev) { }
 510 static inline int pci_iov_bus_range(struct pci_bus *bus)
 511 {
 512         return 0;
 513 }
 514
 515 #endif /* CONFIG_PCI_IOV */
 516
 517 #ifdef CONFIG_PCIE_PTM
 518 void pci_ptm_init(struct pci_dev *dev);
 519 void pci_save_ptm_state(struct pci_dev *dev);
 520 void pci_restore_ptm_state(struct pci_dev *dev);
 521 void pci_suspend_ptm(struct pci_dev *dev);
 522 void pci_resume_ptm(struct pci_dev *dev);
 523 #else
 524 static inline void pci_ptm_init(struct pci_dev *dev) { }
 525 static inline void pci_save_ptm_state(struct pci_dev *dev) { }
 526 static inline void pci_restore_ptm_state(struct pci_dev *dev) { }
 527 static inline void pci_suspend_ptm(struct pci_dev *dev) { }
 528 static inline void pci_resume_ptm(struct pci_dev *dev) { }
 529 #endif
 530
 531 unsigned long pci_cardbus_resource_alignment(struct resource *);
 532
 533 static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
 534                                                      struct resource *res)
 535 {
 536 #ifdef CONFIG_PCI_IOV
 537         int resno = res - dev->resource;
 538
 539         if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
 540                 return pci_sriov_resource_alignment(dev, resno);
 541 #endif
 542         if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
 543                 return pci_cardbus_resource_alignment(res);
 544         return resource_alignment(res);
 545 }
 546
 547 void pci_acs_init(struct pci_dev *dev);
 548 #ifdef CONFIG_PCI_QUIRKS
 549 int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
 550 int pci_dev_specific_enable_acs(struct pci_dev *dev);
 551 int pci_dev_specific_disable_acs_redir(struct pci_dev *dev);
 552 bool pcie_failed_link_retrain(struct pci_dev *dev);
 553 #else
 554 static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
 555                                                u16 acs_flags)
 556 {
 557         return -ENOTTY;
 558 }
 559 static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
 560 {
 561         return -ENOTTY;
 562 }
 563 static inline int pci_dev_specific_disable_acs_redir(struct pci_dev *dev)
 564 {
 565         return -ENOTTY;
 566 }
 567 static inline bool pcie_failed_link_retrain(struct pci_dev *dev)
 568 {
 569         return false;
 570 }
 571 #endif
 572
 573 /* PCI error reporting and recovery */
 574 pci_ers_result_t pcie_do_recovery(struct pci_dev *dev,
 575                 pci_channel_state_t state,
 576                 pci_ers_result_t (*reset_subordinates)(struct pci_dev *pdev));
 577
 578 bool pcie_wait_for_link(struct pci_dev *pdev, bool active);
 579 int pcie_retrain_link(struct pci_dev *pdev, bool use_lt);
 580 #ifdef CONFIG_PCIEASPM
 581 void pcie_aspm_init_link_state(struct pci_dev *pdev);
 582 void pcie_aspm_exit_link_state(struct pci_dev *pdev);
 583 void pcie_aspm_pm_state_change(struct pci_dev *pdev);
 584 void pcie_aspm_powersave_config_link(struct pci_dev *pdev);
 585 #else
 586 static inline void pcie_aspm_init_link_state(struct pci_dev *pdev) { }
 587 static inline void pcie_aspm_exit_link_state(struct pci_dev *pdev) { }
 588 static inline void pcie_aspm_pm_state_change(struct pci_dev *pdev) { }
 589 static inline void pcie_aspm_powersave_config_link(struct pci_dev *pdev) { }
 590 #endif
 591
 592 #ifdef CONFIG_PCIE_ECRC
 593 void pcie_set_ecrc_checking(struct pci_dev *dev);
 594 void pcie_ecrc_get_policy(char *str);
 595 #else
 596 static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
 597 static inline void pcie_ecrc_get_policy(char *str) { }
 598 #endif
 599
 600 struct pci_dev_reset_methods {
 601         u16 vendor;
 602         u16 device;
 603         int (*reset)(struct pci_dev *dev, bool probe);
 604 };
 605
 606 struct pci_reset_fn_method {
 607         int (*reset_fn)(struct pci_dev *pdev, bool probe);
 608         char *name;
 609 };
 610
 611 #ifdef CONFIG_PCI_QUIRKS
 612 int pci_dev_specific_reset(struct pci_dev *dev, bool probe);
 613 #else
 614 static inline int pci_dev_specific_reset(struct pci_dev *dev, bool probe)
 615 {
 616         return -ENOTTY;
 617 }
 618 #endif
 619
 620 #if defined(CONFIG_PCI_QUIRKS) && defined(CONFIG_ARM64)
 621 int acpi_get_rc_resources(struct device *dev, const char *hid, u16 segment,
 622                           struct resource *res);
 623 #else
 624 static inline int acpi_get_rc_resources(struct device *dev, const char *hid,
 625                                         u16 segment, struct resource *res)
 626 {
 627         return -ENODEV;
 628 }
 629 #endif
 630
 631 int pci_rebar_get_current_size(struct pci_dev *pdev, int bar);
 632 int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size);
 633 static inline u64 pci_rebar_size_to_bytes(int size)
 634 {
 635         return 1ULL << (size + 20);
 636 }
 637
 638 struct device_node;
 639
 640 #ifdef CONFIG_OF
 641 int of_pci_parse_bus_range(struct device_node *node, struct resource *res);
 642 int of_get_pci_domain_nr(struct device_node *node);
 643 int of_pci_get_max_link_speed(struct device_node *node);
 644 u32 of_pci_get_slot_power_limit(struct device_node *node,
 645                                 u8 *slot_power_limit_value,
 646                                 u8 *slot_power_limit_scale);
 647 int pci_set_of_node(struct pci_dev *dev);
 648 void pci_release_of_node(struct pci_dev *dev);
 649 void pci_set_bus_of_node(struct pci_bus *bus);
 650 void pci_release_bus_of_node(struct pci_bus *bus);
 651
 652 int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge);
 653
 654 #else
 655 static inline int
 656 of_pci_parse_bus_range(struct device_node *node, struct resource *res)
 657 {
 658         return -EINVAL;
 659 }
 660
 661 static inline int
 662 of_get_pci_domain_nr(struct device_node *node)
 663 {
 664         return -1;
 665 }
 666
 667 static inline int
 668 of_pci_get_max_link_speed(struct device_node *node)
 669 {
 670         return -EINVAL;
 671 }
 672
 673 static inline u32
 674 of_pci_get_slot_power_limit(struct device_node *node,
 675                             u8 *slot_power_limit_value,
 676                             u8 *slot_power_limit_scale)
 677 {
 678         if (slot_power_limit_value)
 679                 *slot_power_limit_value = 0;
 680         if (slot_power_limit_scale)
 681                 *slot_power_limit_scale = 0;
 682         return 0;
 683 }
 684
 685 static inline int pci_set_of_node(struct pci_dev *dev) { return 0; }
 686 static inline void pci_release_of_node(struct pci_dev *dev) { }
 687 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
 688 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
 689
 690 static inline int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge)
 691 {
 692         return 0;
 693 }
 694
 695 #endif /* CONFIG_OF */
 696
 697 struct of_changeset;
 698
 699 #ifdef CONFIG_PCI_DYNAMIC_OF_NODES
 700 void of_pci_make_dev_node(struct pci_dev *pdev);
 701 void of_pci_remove_node(struct pci_dev *pdev);
 702 int of_pci_add_properties(struct pci_dev *pdev, struct of_changeset *ocs,
 703                           struct device_node *np);
 704 #else
 705 static inline void of_pci_make_dev_node(struct pci_dev *pdev) { }
 706 static inline void of_pci_remove_node(struct pci_dev *pdev) { }
 707 #endif
 708
 709 #ifdef CONFIG_PCIEAER
 710 void pci_no_aer(void);
 711 void pci_aer_init(struct pci_dev *dev);
 712 void pci_aer_exit(struct pci_dev *dev);
 713 extern const struct attribute_group aer_stats_attr_group;
 714 void pci_aer_clear_fatal_status(struct pci_dev *dev);
 715 int pci_aer_clear_status(struct pci_dev *dev);
 716 int pci_aer_raw_clear_status(struct pci_dev *dev);
 717 void pci_save_aer_state(struct pci_dev *dev);
 718 void pci_restore_aer_state(struct pci_dev *dev);
 719 #else
 720 static inline void pci_no_aer(void) { }
 721 static inline void pci_aer_init(struct pci_dev *d) { }
 722 static inline void pci_aer_exit(struct pci_dev *d) { }
 723 static inline void pci_aer_clear_fatal_status(struct pci_dev *dev) { }
 724 static inline int pci_aer_clear_status(struct pci_dev *dev) { return -EINVAL; }
 725 static inline int pci_aer_raw_clear_status(struct pci_dev *dev) { return -EINVAL; }
 726 static inline void pci_save_aer_state(struct pci_dev *dev) { }
 727 static inline void pci_restore_aer_state(struct pci_dev *dev) { }
 728 #endif
 729
 730 #ifdef CONFIG_ACPI
 731 int pci_acpi_program_hp_params(struct pci_dev *dev);
 732 extern const struct attribute_group pci_dev_acpi_attr_group;
 733 void pci_set_acpi_fwnode(struct pci_dev *dev);
 734 int pci_dev_acpi_reset(struct pci_dev *dev, bool probe);
 735 bool acpi_pci_power_manageable(struct pci_dev *dev);
 736 bool acpi_pci_bridge_d3(struct pci_dev *dev);
 737 int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state);
 738 pci_power_t acpi_pci_get_power_state(struct pci_dev *dev);
 739 void acpi_pci_refresh_power_state(struct pci_dev *dev);
 740 int acpi_pci_wakeup(struct pci_dev *dev, bool enable);
 741 bool acpi_pci_need_resume(struct pci_dev *dev);
 742 pci_power_t acpi_pci_choose_state(struct pci_dev *pdev);
 743 #else
 744 static inline int pci_dev_acpi_reset(struct pci_dev *dev, bool probe)
 745 {
 746         return -ENOTTY;
 747 }
 748 static inline void pci_set_acpi_fwnode(struct pci_dev *dev) { }
 749 static inline int pci_acpi_program_hp_params(struct pci_dev *dev)
 750 {
 751         return -ENODEV;
 752 }
 753 static inline bool acpi_pci_power_manageable(struct pci_dev *dev)
 754 {
 755         return false;
 756 }
 757 static inline bool acpi_pci_bridge_d3(struct pci_dev *dev)
 758 {
 759         return false;
 760 }
 761 static inline int acpi_pci_set_power_state(struct pci_dev *dev, pci_power_t state)
 762 {
 763         return -ENODEV;
 764 }
 765 static inline pci_power_t acpi_pci_get_power_state(struct pci_dev *dev)
 766 {
 767         return PCI_UNKNOWN;
 768 }
 769 static inline void acpi_pci_refresh_power_state(struct pci_dev *dev) { }
 770 static inline int acpi_pci_wakeup(struct pci_dev *dev, bool enable)
 771 {
 772         return -ENODEV;
 773 }
 774 static inline bool acpi_pci_need_resume(struct pci_dev *dev)
 775 {
 776         return false;
 777 }
 778 static inline pci_power_t acpi_pci_choose_state(struct pci_dev *pdev)
 779 {
 780         return PCI_POWER_ERROR;
 781 }
 782 #endif
 783
 784 #ifdef CONFIG_PCIEASPM
 785 extern const struct attribute_group aspm_ctrl_attr_group;
 786 #endif
 787
 788 extern const struct attribute_group pci_dev_reset_method_attr_group;
 789
 790 #ifdef CONFIG_X86_INTEL_MID
 791 bool pci_use_mid_pm(void);
 792 int mid_pci_set_power_state(struct pci_dev *pdev, pci_power_t state);
 793 pci_power_t mid_pci_get_power_state(struct pci_dev *pdev);
 794 #else
 795 static inline bool pci_use_mid_pm(void)
 796 {
 797         return false;
 798 }
 799 static inline int mid_pci_set_power_state(struct pci_dev *pdev, pci_power_t state)
 800 {
 801         return -ENODEV;
 802 }
 803 static inline pci_power_t mid_pci_get_power_state(struct pci_dev *pdev)
 804 {
 805         return PCI_UNKNOWN;
 806 }
 807 #endif
 808
 809 /*
 810  * Config Address for PCI Configuration Mechanism #1
 811  *
 812  * See PCI Local Bus Specification, Revision 3.0,
 813  * Section 3.2.2.3.2, Figure 3-2, p. 50.
 814  */
 815
 816 #define PCI_CONF1_BUS_SHIFT     16 /* Bus number */
 817 #define PCI_CONF1_DEV_SHIFT     11 /* Device number */
 818 #define PCI_CONF1_FUNC_SHIFT    8  /* Function number */
 819
 820 #define PCI_CONF1_BUS_MASK      0xff
 821 #define PCI_CONF1_DEV_MASK      0x1f
 822 #define PCI_CONF1_FUNC_MASK     0x7
 823 #define PCI_CONF1_REG_MASK      0xfc /* Limit aligned offset to a maximum of 256B */
 824
 825 #define PCI_CONF1_ENABLE        BIT(31)
 826 #define PCI_CONF1_BUS(x)        (((x) & PCI_CONF1_BUS_MASK) << PCI_CONF1_BUS_SHIFT)
 827 #define PCI_CONF1_DEV(x)        (((x) & PCI_CONF1_DEV_MASK) << PCI_CONF1_DEV_SHIFT)
 828 #define PCI_CONF1_FUNC(x)       (((x) & PCI_CONF1_FUNC_MASK) << PCI_CONF1_FUNC_SHIFT)
 829 #define PCI_CONF1_REG(x)        ((x) & PCI_CONF1_REG_MASK)
 830
 831 #define PCI_CONF1_ADDRESS(bus, dev, func, reg) \
 832         (PCI_CONF1_ENABLE | \
 833          PCI_CONF1_BUS(bus) | \
 834          PCI_CONF1_DEV(dev) | \
 835          PCI_CONF1_FUNC(func) | \
 836          PCI_CONF1_REG(reg))
 837
 838 /*
 839  * Extension of PCI Config Address for accessing extended PCIe registers
 840  *
 841  * No standardized specification, but used on lot of non-ECAM-compliant ARM SoCs
 842  * or on AMD Barcelona and new CPUs. Reserved bits [27:24] of PCI Config Address
 843  * are used for specifying additional 4 high bits of PCI Express register.
 844  */
 845
 846 #define PCI_CONF1_EXT_REG_SHIFT 16
 847 #define PCI_CONF1_EXT_REG_MASK  0xf00
 848 #define PCI_CONF1_EXT_REG(x)    (((x) & PCI_CONF1_EXT_REG_MASK) << PCI_CONF1_EXT_REG_SHIFT)
 849
 850 #define PCI_CONF1_EXT_ADDRESS(bus, dev, func, reg) \
 851         (PCI_CONF1_ADDRESS(bus, dev, func, reg) | \
 852          PCI_CONF1_EXT_REG(reg))
 853
 854 #endif /* DRIVERS_PCI_H */