pci.h 11 KB

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