pci.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. #ifndef DRIVERS_PCI_H
  2. #define DRIVERS_PCI_H
  3. #define PCI_CFG_SPACE_SIZE 256
  4. #define PCI_CFG_SPACE_EXP_SIZE 4096
  5. #define PCI_FIND_CAP_TTL 48
  6. extern const unsigned char pcie_link_speed[];
  7. bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
  8. /* Functions internal to the PCI core code */
  9. int pci_create_sysfs_dev_files(struct pci_dev *pdev);
  10. void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
  11. #if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
  12. static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
  13. { return; }
  14. static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
  15. { return; }
  16. #else
  17. void pci_create_firmware_label_files(struct pci_dev *pdev);
  18. void pci_remove_firmware_label_files(struct pci_dev *pdev);
  19. #endif
  20. void pci_cleanup_rom(struct pci_dev *dev);
  21. #ifdef HAVE_PCI_MMAP
  22. enum pci_mmap_api {
  23. PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
  24. PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
  25. };
  26. int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
  27. enum pci_mmap_api mmap_api);
  28. #endif
  29. int pci_probe_reset_function(struct pci_dev *dev);
  30. /**
  31. * struct pci_platform_pm_ops - Firmware PM callbacks
  32. *
  33. * @is_manageable: returns 'true' if given device is power manageable by the
  34. * platform firmware
  35. *
  36. * @set_state: invokes the platform firmware to set the device's power state
  37. *
  38. * @choose_state: returns PCI power state of given device preferred by the
  39. * platform; to be used during system-wide transitions from a
  40. * sleeping state to the working state and vice versa
  41. *
  42. * @sleep_wake: enables/disables the system wake up capability of given device
  43. *
  44. * @run_wake: enables/disables the platform to generate run-time wake-up events
  45. * for given device (the device's wake-up capability has to be
  46. * enabled by @sleep_wake for this feature to work)
  47. *
  48. * @need_resume: returns 'true' if the given device (which is currently
  49. * suspended) needs to be resumed to be configured for system
  50. * wakeup.
  51. *
  52. * If given platform is generally capable of power managing PCI devices, all of
  53. * these callbacks are mandatory.
  54. */
  55. struct pci_platform_pm_ops {
  56. bool (*is_manageable)(struct pci_dev *dev);
  57. int (*set_state)(struct pci_dev *dev, pci_power_t state);
  58. pci_power_t (*choose_state)(struct pci_dev *dev);
  59. int (*sleep_wake)(struct pci_dev *dev, bool enable);
  60. int (*run_wake)(struct pci_dev *dev, bool enable);
  61. bool (*need_resume)(struct pci_dev *dev);
  62. };
  63. int pci_set_platform_pm(const struct pci_platform_pm_ops *ops);
  64. void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
  65. void pci_power_up(struct pci_dev *dev);
  66. void pci_disable_enabled_device(struct pci_dev *dev);
  67. int pci_finish_runtime_suspend(struct pci_dev *dev);
  68. int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
  69. bool pci_dev_keep_suspended(struct pci_dev *dev);
  70. void pci_dev_complete_resume(struct pci_dev *pci_dev);
  71. void pci_config_pm_runtime_get(struct pci_dev *dev);
  72. void pci_config_pm_runtime_put(struct pci_dev *dev);
  73. void pci_pm_init(struct pci_dev *dev);
  74. void pci_ea_init(struct pci_dev *dev);
  75. void pci_allocate_cap_save_buffers(struct pci_dev *dev);
  76. void pci_free_cap_save_buffers(struct pci_dev *dev);
  77. static inline void pci_wakeup_event(struct pci_dev *dev)
  78. {
  79. /* Wait 100 ms before the system can be put into a sleep state. */
  80. pm_wakeup_event(&dev->dev, 100);
  81. }
  82. static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
  83. {
  84. return !!(pci_dev->subordinate);
  85. }
  86. struct pci_vpd_ops {
  87. ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
  88. ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
  89. };
  90. struct pci_vpd {
  91. unsigned int len;
  92. const struct pci_vpd_ops *ops;
  93. struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
  94. };
  95. int pci_vpd_init(struct pci_dev *dev);
  96. void pci_vpd_release(struct pci_dev *dev);
  97. /* PCI /proc functions */
  98. #ifdef CONFIG_PROC_FS
  99. int pci_proc_attach_device(struct pci_dev *dev);
  100. int pci_proc_detach_device(struct pci_dev *dev);
  101. int pci_proc_detach_bus(struct pci_bus *bus);
  102. #else
  103. static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
  104. static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
  105. static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
  106. #endif
  107. /* Functions for PCI Hotplug drivers to use */
  108. int pci_hp_add_bridge(struct pci_dev *dev);
  109. #ifdef HAVE_PCI_LEGACY
  110. void pci_create_legacy_files(struct pci_bus *bus);
  111. void pci_remove_legacy_files(struct pci_bus *bus);
  112. #else
  113. static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
  114. static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
  115. #endif
  116. /* Lock for read/write access to pci device and bus lists */
  117. extern struct rw_semaphore pci_bus_sem;
  118. extern raw_spinlock_t pci_lock;
  119. extern unsigned int pci_pm_d3_delay;
  120. #ifdef CONFIG_PCI_MSI
  121. void pci_no_msi(void);
  122. #else
  123. static inline void pci_no_msi(void) { }
  124. #endif
  125. static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
  126. {
  127. u16 control;
  128. pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
  129. control &= ~PCI_MSI_FLAGS_ENABLE;
  130. if (enable)
  131. control |= PCI_MSI_FLAGS_ENABLE;
  132. pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
  133. }
  134. static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
  135. {
  136. u16 ctrl;
  137. pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
  138. ctrl &= ~clear;
  139. ctrl |= set;
  140. pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
  141. }
  142. void pci_realloc_get_opt(char *);
  143. static inline int pci_no_d1d2(struct pci_dev *dev)
  144. {
  145. unsigned int parent_dstates = 0;
  146. if (dev->bus->self)
  147. parent_dstates = dev->bus->self->no_d1d2;
  148. return (dev->no_d1d2 || parent_dstates);
  149. }
  150. extern const struct attribute_group *pci_dev_groups[];
  151. extern const struct attribute_group *pcibus_groups[];
  152. extern struct device_type pci_dev_type;
  153. extern const struct attribute_group *pci_bus_groups[];
  154. /**
  155. * pci_match_one_device - Tell if a PCI device structure has a matching
  156. * PCI device id structure
  157. * @id: single PCI device id structure to match
  158. * @dev: the PCI device structure to match against
  159. *
  160. * Returns the matching pci_device_id structure or %NULL if there is no match.
  161. */
  162. static inline const struct pci_device_id *
  163. pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
  164. {
  165. if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
  166. (id->device == PCI_ANY_ID || id->device == dev->device) &&
  167. (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
  168. (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
  169. !((id->class ^ dev->class) & id->class_mask))
  170. return id;
  171. return NULL;
  172. }
  173. /* PCI slot sysfs helper code */
  174. #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
  175. extern struct kset *pci_slots_kset;
  176. struct pci_slot_attribute {
  177. struct attribute attr;
  178. ssize_t (*show)(struct pci_slot *, char *);
  179. ssize_t (*store)(struct pci_slot *, const char *, size_t);
  180. };
  181. #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
  182. enum pci_bar_type {
  183. pci_bar_unknown, /* Standard PCI BAR probe */
  184. pci_bar_io, /* An io port BAR */
  185. pci_bar_mem32, /* A 32-bit memory BAR */
  186. pci_bar_mem64, /* A 64-bit memory BAR */
  187. };
  188. bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
  189. int crs_timeout);
  190. int pci_setup_device(struct pci_dev *dev);
  191. int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
  192. struct resource *res, unsigned int reg);
  193. int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
  194. void pci_configure_ari(struct pci_dev *dev);
  195. void __pci_bus_size_bridges(struct pci_bus *bus,
  196. struct list_head *realloc_head);
  197. void __pci_bus_assign_resources(const struct pci_bus *bus,
  198. struct list_head *realloc_head,
  199. struct list_head *fail_head);
  200. bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
  201. void pci_reassigndev_resource_alignment(struct pci_dev *dev);
  202. void pci_disable_bridge_window(struct pci_dev *dev);
  203. /* Single Root I/O Virtualization */
  204. struct pci_sriov {
  205. int pos; /* capability position */
  206. int nres; /* number of resources */
  207. u32 cap; /* SR-IOV Capabilities */
  208. u16 ctrl; /* SR-IOV Control */
  209. u16 total_VFs; /* total VFs associated with the PF */
  210. u16 initial_VFs; /* initial VFs associated with the PF */
  211. u16 num_VFs; /* number of VFs available */
  212. u16 offset; /* first VF Routing ID offset */
  213. u16 stride; /* following VF stride */
  214. u32 pgsz; /* page size for BAR alignment */
  215. u8 link; /* Function Dependency Link */
  216. u8 max_VF_buses; /* max buses consumed by VFs */
  217. u16 driver_max_VFs; /* max num VFs driver supports */
  218. struct pci_dev *dev; /* lowest numbered PF */
  219. struct pci_dev *self; /* this PF */
  220. struct mutex lock; /* lock for VF bus */
  221. resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
  222. };
  223. #ifdef CONFIG_PCI_ATS
  224. void pci_restore_ats_state(struct pci_dev *dev);
  225. #else
  226. static inline void pci_restore_ats_state(struct pci_dev *dev)
  227. {
  228. }
  229. #endif /* CONFIG_PCI_ATS */
  230. #ifdef CONFIG_PCI_IOV
  231. int pci_iov_init(struct pci_dev *dev);
  232. void pci_iov_release(struct pci_dev *dev);
  233. int pci_iov_resource_bar(struct pci_dev *dev, int resno);
  234. resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
  235. void pci_restore_iov_state(struct pci_dev *dev);
  236. int pci_iov_bus_range(struct pci_bus *bus);
  237. #else
  238. static inline int pci_iov_init(struct pci_dev *dev)
  239. {
  240. return -ENODEV;
  241. }
  242. static inline void pci_iov_release(struct pci_dev *dev)
  243. {
  244. }
  245. static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno)
  246. {
  247. return 0;
  248. }
  249. static inline void pci_restore_iov_state(struct pci_dev *dev)
  250. {
  251. }
  252. static inline int pci_iov_bus_range(struct pci_bus *bus)
  253. {
  254. return 0;
  255. }
  256. #endif /* CONFIG_PCI_IOV */
  257. unsigned long pci_cardbus_resource_alignment(struct resource *);
  258. static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
  259. struct resource *res)
  260. {
  261. #ifdef CONFIG_PCI_IOV
  262. int resno = res - dev->resource;
  263. if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
  264. return pci_sriov_resource_alignment(dev, resno);
  265. #endif
  266. if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
  267. return pci_cardbus_resource_alignment(res);
  268. return resource_alignment(res);
  269. }
  270. void pci_enable_acs(struct pci_dev *dev);
  271. struct pci_dev_reset_methods {
  272. u16 vendor;
  273. u16 device;
  274. int (*reset)(struct pci_dev *dev, int probe);
  275. };
  276. #ifdef CONFIG_PCI_QUIRKS
  277. int pci_dev_specific_reset(struct pci_dev *dev, int probe);
  278. #else
  279. static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
  280. {
  281. return -ENOTTY;
  282. }
  283. #endif
  284. #endif /* DRIVERS_PCI_H */