pci.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  1. #ifndef DRIVERS_PCI_H
  2. #define DRIVERS_PCI_H
  3. #include <linux/workqueue.h>
  4. #define PCI_CFG_SPACE_SIZE 256
  5. #define PCI_CFG_SPACE_EXP_SIZE 4096
  6. /* Functions internal to the PCI core code */
  7. extern int pci_uevent(struct device *dev, struct kobj_uevent_env *env);
  8. extern int pci_create_sysfs_dev_files(struct pci_dev *pdev);
  9. extern void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
  10. #ifndef CONFIG_DMI
  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. extern void pci_create_firmware_label_files(struct pci_dev *pdev);
  17. extern void pci_remove_firmware_label_files(struct pci_dev *pdev);
  18. #endif
  19. extern 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. extern int pci_mmap_fits(struct pci_dev *pdev, int resno,
  26. 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. * @can_wakeup: returns 'true' if given device is capable of waking up the
  43. * system from a sleeping state
  44. *
  45. * @sleep_wake: enables/disables the system wake up capability of given device
  46. *
  47. * @run_wake: enables/disables the platform to generate run-time wake-up events
  48. * for given device (the device's wake-up capability has to be
  49. * enabled by @sleep_wake for this feature to work)
  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. bool (*can_wakeup)(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. };
  62. extern int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
  63. extern void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
  64. extern void pci_disable_enabled_device(struct pci_dev *dev);
  65. extern int pci_finish_runtime_suspend(struct pci_dev *dev);
  66. extern int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
  67. extern void pci_pm_init(struct pci_dev *dev);
  68. extern void platform_pci_wakeup_init(struct pci_dev *dev);
  69. extern void pci_allocate_cap_save_buffers(struct pci_dev *dev);
  70. static inline bool pci_is_bridge(struct pci_dev *pci_dev)
  71. {
  72. return !!(pci_dev->subordinate);
  73. }
  74. extern int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
  75. extern int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
  76. extern int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
  77. extern int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
  78. extern int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
  79. extern int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
  80. struct pci_vpd_ops {
  81. ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
  82. ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
  83. void (*release)(struct pci_dev *dev);
  84. };
  85. struct pci_vpd {
  86. unsigned int len;
  87. const struct pci_vpd_ops *ops;
  88. struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
  89. };
  90. extern int pci_vpd_pci22_init(struct pci_dev *dev);
  91. static inline void pci_vpd_release(struct pci_dev *dev)
  92. {
  93. if (dev->vpd)
  94. dev->vpd->ops->release(dev);
  95. }
  96. /* PCI /proc functions */
  97. #ifdef CONFIG_PROC_FS
  98. extern int pci_proc_attach_device(struct pci_dev *dev);
  99. extern int pci_proc_detach_device(struct pci_dev *dev);
  100. extern int pci_proc_detach_bus(struct pci_bus *bus);
  101. #else
  102. static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
  103. static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
  104. static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
  105. #endif
  106. /* Functions for PCI Hotplug drivers to use */
  107. extern unsigned int pci_do_scan_bus(struct pci_bus *bus);
  108. #ifdef HAVE_PCI_LEGACY
  109. extern void pci_create_legacy_files(struct pci_bus *bus);
  110. extern void pci_remove_legacy_files(struct pci_bus *bus);
  111. #else
  112. static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
  113. static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
  114. #endif
  115. /* Lock for read/write access to pci device and bus lists */
  116. extern struct rw_semaphore pci_bus_sem;
  117. extern unsigned int pci_pm_d3_delay;
  118. #ifdef CONFIG_PCI_MSI
  119. void pci_no_msi(void);
  120. extern void pci_msi_init_pci_dev(struct pci_dev *dev);
  121. #else
  122. static inline void pci_no_msi(void) { }
  123. static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
  124. #endif
  125. #ifdef CONFIG_PCIEAER
  126. void pci_no_aer(void);
  127. bool pci_aer_available(void);
  128. #else
  129. static inline void pci_no_aer(void) { }
  130. static inline bool pci_aer_available(void) { return false; }
  131. #endif
  132. static inline int pci_no_d1d2(struct pci_dev *dev)
  133. {
  134. unsigned int parent_dstates = 0;
  135. if (dev->bus->self)
  136. parent_dstates = dev->bus->self->no_d1d2;
  137. return (dev->no_d1d2 || parent_dstates);
  138. }
  139. extern struct device_attribute pci_dev_attrs[];
  140. extern struct device_attribute dev_attr_cpuaffinity;
  141. extern struct device_attribute dev_attr_cpulistaffinity;
  142. #ifdef CONFIG_HOTPLUG
  143. extern struct bus_attribute pci_bus_attrs[];
  144. #else
  145. #define pci_bus_attrs NULL
  146. #endif
  147. /**
  148. * pci_match_one_device - Tell if a PCI device structure has a matching
  149. * PCI device id structure
  150. * @id: single PCI device id structure to match
  151. * @dev: the PCI device structure to match against
  152. *
  153. * Returns the matching pci_device_id structure or %NULL if there is no match.
  154. */
  155. static inline const struct pci_device_id *
  156. pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
  157. {
  158. if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
  159. (id->device == PCI_ANY_ID || id->device == dev->device) &&
  160. (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
  161. (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
  162. !((id->class ^ dev->class) & id->class_mask))
  163. return id;
  164. return NULL;
  165. }
  166. struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
  167. /* PCI slot sysfs helper code */
  168. #define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
  169. extern struct kset *pci_slots_kset;
  170. struct pci_slot_attribute {
  171. struct attribute attr;
  172. ssize_t (*show)(struct pci_slot *, char *);
  173. ssize_t (*store)(struct pci_slot *, const char *, size_t);
  174. };
  175. #define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
  176. enum pci_bar_type {
  177. pci_bar_unknown, /* Standard PCI BAR probe */
  178. pci_bar_io, /* An io port BAR */
  179. pci_bar_mem32, /* A 32-bit memory BAR */
  180. pci_bar_mem64, /* A 64-bit memory BAR */
  181. };
  182. extern int pci_setup_device(struct pci_dev *dev);
  183. extern int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
  184. struct resource *res, unsigned int reg);
  185. extern int pci_resource_bar(struct pci_dev *dev, int resno,
  186. enum pci_bar_type *type);
  187. extern int pci_bus_add_child(struct pci_bus *bus);
  188. extern void pci_enable_ari(struct pci_dev *dev);
  189. /**
  190. * pci_ari_enabled - query ARI forwarding status
  191. * @bus: the PCI bus
  192. *
  193. * Returns 1 if ARI forwarding is enabled, or 0 if not enabled;
  194. */
  195. static inline int pci_ari_enabled(struct pci_bus *bus)
  196. {
  197. return bus->self && bus->self->ari_enabled;
  198. }
  199. #ifdef CONFIG_PCI_QUIRKS
  200. extern int pci_is_reassigndev(struct pci_dev *dev);
  201. resource_size_t pci_specified_resource_alignment(struct pci_dev *dev);
  202. extern void pci_disable_bridge_window(struct pci_dev *dev);
  203. #endif
  204. /* Single Root I/O Virtualization */
  205. struct pci_sriov {
  206. int pos; /* capability position */
  207. int nres; /* number of resources */
  208. u32 cap; /* SR-IOV Capabilities */
  209. u16 ctrl; /* SR-IOV Control */
  210. u16 total; /* total VFs associated with the PF */
  211. u16 initial; /* initial VFs associated with the PF */
  212. u16 nr_virtfn; /* number of VFs available */
  213. u16 offset; /* first VF Routing ID offset */
  214. u16 stride; /* following VF stride */
  215. u32 pgsz; /* page size for BAR alignment */
  216. u8 link; /* Function Dependency Link */
  217. struct pci_dev *dev; /* lowest numbered PF */
  218. struct pci_dev *self; /* this PF */
  219. struct mutex lock; /* lock for VF bus */
  220. struct work_struct mtask; /* VF Migration task */
  221. u8 __iomem *mstate; /* VF Migration State Array */
  222. };
  223. /* Address Translation Service */
  224. struct pci_ats {
  225. int pos; /* capability position */
  226. int stu; /* Smallest Translation Unit */
  227. int qdep; /* Invalidate Queue Depth */
  228. int ref_cnt; /* Physical Function reference count */
  229. unsigned int is_enabled:1; /* Enable bit is set */
  230. };
  231. #ifdef CONFIG_PCI_IOV
  232. extern int pci_iov_init(struct pci_dev *dev);
  233. extern void pci_iov_release(struct pci_dev *dev);
  234. extern int pci_iov_resource_bar(struct pci_dev *dev, int resno,
  235. enum pci_bar_type *type);
  236. extern resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev,
  237. int resno);
  238. extern void pci_restore_iov_state(struct pci_dev *dev);
  239. extern int pci_iov_bus_range(struct pci_bus *bus);
  240. extern int pci_enable_ats(struct pci_dev *dev, int ps);
  241. extern void pci_disable_ats(struct pci_dev *dev);
  242. extern int pci_ats_queue_depth(struct pci_dev *dev);
  243. /**
  244. * pci_ats_enabled - query the ATS status
  245. * @dev: the PCI device
  246. *
  247. * Returns 1 if ATS capability is enabled, or 0 if not.
  248. */
  249. static inline int pci_ats_enabled(struct pci_dev *dev)
  250. {
  251. return dev->ats && dev->ats->is_enabled;
  252. }
  253. #else
  254. static inline int pci_iov_init(struct pci_dev *dev)
  255. {
  256. return -ENODEV;
  257. }
  258. static inline void pci_iov_release(struct pci_dev *dev)
  259. {
  260. }
  261. static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno,
  262. enum pci_bar_type *type)
  263. {
  264. return 0;
  265. }
  266. static inline void pci_restore_iov_state(struct pci_dev *dev)
  267. {
  268. }
  269. static inline int pci_iov_bus_range(struct pci_bus *bus)
  270. {
  271. return 0;
  272. }
  273. static inline int pci_enable_ats(struct pci_dev *dev, int ps)
  274. {
  275. return -ENODEV;
  276. }
  277. static inline void pci_disable_ats(struct pci_dev *dev)
  278. {
  279. }
  280. static inline int pci_ats_queue_depth(struct pci_dev *dev)
  281. {
  282. return -ENODEV;
  283. }
  284. static inline int pci_ats_enabled(struct pci_dev *dev)
  285. {
  286. return 0;
  287. }
  288. #endif /* CONFIG_PCI_IOV */
  289. static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
  290. struct resource *res)
  291. {
  292. #ifdef CONFIG_PCI_IOV
  293. int resno = res - dev->resource;
  294. if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
  295. return pci_sriov_resource_alignment(dev, resno);
  296. #endif
  297. return resource_alignment(res);
  298. }
  299. extern void pci_enable_acs(struct pci_dev *dev);
  300. struct pci_dev_reset_methods {
  301. u16 vendor;
  302. u16 device;
  303. int (*reset)(struct pci_dev *dev, int probe);
  304. };
  305. #ifdef CONFIG_PCI_QUIRKS
  306. extern int pci_dev_specific_reset(struct pci_dev *dev, int probe);
  307. #else
  308. static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
  309. {
  310. return -ENOTTY;
  311. }
  312. #endif
  313. #endif /* DRIVERS_PCI_H */