blob: 24ba9dc8910a2ccf7c8735d7c8601e147ad13cb1 [file] [log] [blame]
Zhao, Yu557848c2008-10-13 19:18:07 +08001#ifndef DRIVERS_PCI_H
2#define DRIVERS_PCI_H
3
4#define PCI_CFG_SPACE_SIZE 256
5#define PCI_CFG_SPACE_EXP_SIZE 4096
6
Wei Yangfff905f2015-06-30 09:16:41 +08007#define PCI_FIND_CAP_TTL 48
8
Jacob Keller343e51a2013-07-31 06:53:16 +00009extern const unsigned char pcie_link_speed[];
10
Yinghai Lu7a1562d2014-11-11 12:09:46 -080011bool pcie_cap_has_lnkctl(const struct pci_dev *dev);
12
Linus Torvalds1da177e2005-04-16 15:20:36 -070013/* Functions internal to the PCI core code */
14
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060015int pci_create_sysfs_dev_files(struct pci_dev *pdev);
16void pci_remove_sysfs_dev_files(struct pci_dev *pdev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053017#if !defined(CONFIG_DMI) && !defined(CONFIG_ACPI)
Narendra K911e1c92010-07-26 05:56:50 -050018static inline void pci_create_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050019{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050020static inline void pci_remove_firmware_label_files(struct pci_dev *pdev)
Narendra Kb879743f2010-08-02 07:44:29 -050021{ return; }
Narendra K911e1c92010-07-26 05:56:50 -050022#else
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060023void pci_create_firmware_label_files(struct pci_dev *pdev);
24void pci_remove_firmware_label_files(struct pci_dev *pdev);
Narendra K911e1c92010-07-26 05:56:50 -050025#endif
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060026void pci_cleanup_rom(struct pci_dev *dev);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070027#ifdef HAVE_PCI_MMAP
Martin Wilck3b519e42010-11-10 11:03:21 +010028enum pci_mmap_api {
29 PCI_MMAP_SYSFS, /* mmap on /sys/bus/pci/devices/<BDF>/resource<N> */
30 PCI_MMAP_PROCFS /* mmap on /proc/bus/pci/<BDF> */
31};
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060032int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vmai,
33 enum pci_mmap_api mmap_api);
Jesse Barnes9eff02e2008-10-24 10:32:33 -070034#endif
Michael S. Tsirkin711d5772009-07-27 23:37:48 +030035int pci_probe_reset_function(struct pci_dev *dev);
Kumar Galace5ccde2007-07-16 23:27:10 -050036
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020037/**
Randy Dunlapb33bfde2009-01-09 17:04:26 -080038 * struct pci_platform_pm_ops - Firmware PM callbacks
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020039 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080040 * @is_manageable: returns 'true' if given device is power manageable by the
41 * platform firmware
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020042 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080043 * @set_state: invokes the platform firmware to set the device's power state
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020044 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080045 * @choose_state: returns PCI power state of given device preferred by the
46 * platform; to be used during system-wide transitions from a
47 * sleeping state to the working state and vice versa
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020048 *
Randy Dunlapb33bfde2009-01-09 17:04:26 -080049 * @sleep_wake: enables/disables the system wake up capability of given device
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020050 *
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010051 * @run_wake: enables/disables the platform to generate run-time wake-up events
52 * for given device (the device's wake-up capability has to be
53 * enabled by @sleep_wake for this feature to work)
54 *
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010055 * @need_resume: returns 'true' if the given device (which is currently
56 * suspended) needs to be resumed to be configured for system
57 * wakeup.
58 *
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020059 * If given platform is generally capable of power managing PCI devices, all of
60 * these callbacks are mandatory.
61 */
62struct pci_platform_pm_ops {
63 bool (*is_manageable)(struct pci_dev *dev);
64 int (*set_state)(struct pci_dev *dev, pci_power_t state);
65 pci_power_t (*choose_state)(struct pci_dev *dev);
Rafael J. Wysockieb9d0fe2008-07-07 03:34:48 +020066 int (*sleep_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockib67ea762010-02-17 23:44:09 +010067 int (*run_wake)(struct pci_dev *dev, bool enable);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010068 bool (*need_resume)(struct pci_dev *dev);
Rafael J. Wysocki961d9122008-07-07 03:32:02 +020069};
70
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060071int pci_set_platform_pm(struct pci_platform_pm_ops *ops);
72void pci_update_current_state(struct pci_dev *dev, pci_power_t state);
73void pci_power_up(struct pci_dev *dev);
74void pci_disable_enabled_device(struct pci_dev *dev);
75int pci_finish_runtime_suspend(struct pci_dev *dev);
76int __pci_pme_wakeup(struct pci_dev *dev, void *ign);
Rafael J. Wysockibac2a902015-01-21 02:17:42 +010077bool pci_dev_keep_suspended(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -060078void pci_config_pm_runtime_get(struct pci_dev *dev);
79void pci_config_pm_runtime_put(struct pci_dev *dev);
80void pci_pm_init(struct pci_dev *dev);
81void pci_allocate_cap_save_buffers(struct pci_dev *dev);
Yinghai Luf7968412012-02-11 00:18:30 -080082void pci_free_cap_save_buffers(struct pci_dev *dev);
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010083
Rafael J. Wysockib6e335a2010-12-29 13:21:23 +010084static inline void pci_wakeup_event(struct pci_dev *dev)
85{
86 /* Wait 100 ms before the system can be put into a sleep state. */
87 pm_wakeup_event(&dev->dev, 100);
88}
89
Yijing Wang326c1cd2014-05-04 12:23:36 +080090static inline bool pci_has_subordinate(struct pci_dev *pci_dev)
Rafael J. Wysockiaa8c6c92009-01-16 21:54:43 +010091{
92 return !!(pci_dev->subordinate);
93}
David Shaohua Li0f644742005-03-19 00:15:48 -050094
Ben Hutchings94e61082008-03-05 16:52:39 +000095struct pci_vpd_ops {
Stephen Hemminger287d19c2008-12-18 09:17:16 -080096 ssize_t (*read)(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
97 ssize_t (*write)(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
Ben Hutchings94e61082008-03-05 16:52:39 +000098 void (*release)(struct pci_dev *dev);
99};
100
101struct pci_vpd {
Benjamin Li99cb233d2008-07-02 10:59:04 -0700102 unsigned int len;
Stephen Hemminger287d19c2008-12-18 09:17:16 -0800103 const struct pci_vpd_ops *ops;
Ben Hutchings94e61082008-03-05 16:52:39 +0000104 struct bin_attribute *attr; /* descriptor for sysfs VPD entry */
105};
106
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600107int pci_vpd_pci22_init(struct pci_dev *dev);
Ben Hutchings94e61082008-03-05 16:52:39 +0000108static inline void pci_vpd_release(struct pci_dev *dev)
109{
110 if (dev->vpd)
111 dev->vpd->ops->release(dev);
112}
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/* PCI /proc functions */
115#ifdef CONFIG_PROC_FS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600116int pci_proc_attach_device(struct pci_dev *dev);
117int pci_proc_detach_device(struct pci_dev *dev);
118int pci_proc_detach_bus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119#else
120static inline int pci_proc_attach_device(struct pci_dev *dev) { return 0; }
121static inline int pci_proc_detach_device(struct pci_dev *dev) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122static inline int pci_proc_detach_bus(struct pci_bus *bus) { return 0; }
123#endif
124
125/* Functions for PCI Hotplug drivers to use */
Yinghai Lua8e4b9c2012-05-18 13:46:34 -0600126int pci_hp_add_bridge(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000128#ifdef HAVE_PCI_LEGACY
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600129void pci_create_legacy_files(struct pci_bus *bus);
130void pci_remove_legacy_files(struct pci_bus *bus);
Benjamin Herrenschmidtf19aeb12008-10-03 19:49:32 +1000131#else
132static inline void pci_create_legacy_files(struct pci_bus *bus) { return; }
133static inline void pci_remove_legacy_files(struct pci_bus *bus) { return; }
134#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136/* Lock for read/write access to pci device and bus lists */
Zhang Yanmind71374d2006-06-02 12:35:43 +0800137extern struct rw_semaphore pci_bus_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Jan Kiszkaa2e27782011-11-04 09:46:00 +0100139extern raw_spinlock_t pci_lock;
140
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700141extern unsigned int pci_pm_d3_delay;
Michael Ellerman88187df2007-01-25 19:34:07 +1100142
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700143#ifdef CONFIG_PCI_MSI
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700144void pci_no_msi(void);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600145void pci_msi_init_pci_dev(struct pci_dev *dev);
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700146#else
Matthew Wilcox309e57d2006-03-05 22:33:34 -0700147static inline void pci_no_msi(void) { }
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000148static inline void pci_msi_init_pci_dev(struct pci_dev *dev) { }
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700149#endif
Michael Ellerman8fed4b62007-01-25 19:34:08 +1100150
Michael S. Tsirkin6a25f5e2015-05-07 09:52:21 -0500151static inline void pci_msi_set_enable(struct pci_dev *dev, int enable)
152{
153 u16 control;
154
155 pci_read_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, &control);
156 control &= ~PCI_MSI_FLAGS_ENABLE;
157 if (enable)
158 control |= PCI_MSI_FLAGS_ENABLE;
159 pci_write_config_word(dev, dev->msi_cap + PCI_MSI_FLAGS, control);
160}
161
162static inline void pci_msix_clear_and_set_ctrl(struct pci_dev *dev, u16 clear, u16 set)
163{
164 u16 ctrl;
165
166 pci_read_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, &ctrl);
167 ctrl &= ~clear;
168 ctrl |= set;
169 pci_write_config_word(dev, dev->msix_cap + PCI_MSIX_FLAGS, ctrl);
170}
171
Yinghai Lub55438f2012-02-23 19:23:30 -0800172void pci_realloc_get_opt(char *);
Ram Paif483d392011-07-07 11:19:10 -0700173
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700174static inline int pci_no_d1d2(struct pci_dev *dev)
175{
176 unsigned int parent_dstates = 0;
Andrew Morton4b47b0e2005-08-16 15:16:05 -0700177
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700178 if (dev->bus->self)
179 parent_dstates = dev->bus->self->no_d1d2;
180 return (dev->no_d1d2 || parent_dstates);
181
182}
Greg Kroah-Hartman5136b2d2013-10-06 23:55:40 -0700183extern const struct attribute_group *pci_dev_groups[];
Greg Kroah-Hartman56039e62013-07-24 15:05:17 -0700184extern const struct attribute_group *pcibus_groups[];
Yinghai Lu4e15c462012-11-05 15:20:34 -0500185extern struct device_type pci_dev_type;
Greg Kroah-Hartman0f49ba52013-10-07 14:51:02 -0600186extern const struct attribute_group *pci_bus_groups[];
Alex Chiang705b1aa2009-03-20 14:56:31 -0600187
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189/**
190 * pci_match_one_device - Tell if a PCI device structure has a matching
191 * PCI device id structure
192 * @id: single PCI device id structure to match
193 * @dev: the PCI device structure to match against
Greg Kroah-Hartman367b09f2008-01-30 15:21:33 -0800194 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 * Returns the matching pci_device_id structure or %NULL if there is no match.
196 */
197static inline const struct pci_device_id *
198pci_match_one_device(const struct pci_device_id *id, const struct pci_dev *dev)
199{
200 if ((id->vendor == PCI_ANY_ID || id->vendor == dev->vendor) &&
201 (id->device == PCI_ANY_ID || id->device == dev->device) &&
202 (id->subvendor == PCI_ANY_ID || id->subvendor == dev->subsystem_vendor) &&
203 (id->subdevice == PCI_ANY_ID || id->subdevice == dev->subsystem_device) &&
204 !((id->class ^ dev->class) & id->class_mask))
205 return id;
206 return NULL;
207}
208
Alex Chiangf46753c2008-06-10 15:28:50 -0600209/* PCI slot sysfs helper code */
210#define to_pci_slot(s) container_of(s, struct pci_slot, kobj)
211
212extern struct kset *pci_slots_kset;
213
214struct pci_slot_attribute {
215 struct attribute attr;
216 ssize_t (*show)(struct pci_slot *, char *);
217 ssize_t (*store)(struct pci_slot *, const char *, size_t);
218};
219#define to_pci_slot_attr(s) container_of(s, struct pci_slot_attribute, attr)
220
Yu Zhao0b400c72008-11-22 02:40:40 +0800221enum pci_bar_type {
222 pci_bar_unknown, /* Standard PCI BAR probe */
223 pci_bar_io, /* An io port BAR */
224 pci_bar_mem32, /* A 32-bit memory BAR */
225 pci_bar_mem64, /* A 64-bit memory BAR */
226};
227
Yinghai Luefdc87d2012-01-27 10:55:10 -0800228bool pci_bus_read_dev_vendor_id(struct pci_bus *bus, int devfn, u32 *pl,
229 int crs_timeout);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600230int pci_setup_device(struct pci_dev *dev);
231int __pci_read_base(struct pci_dev *dev, enum pci_bar_type type,
232 struct resource *res, unsigned int reg);
233int pci_resource_bar(struct pci_dev *dev, int resno, enum pci_bar_type *type);
234void pci_configure_ari(struct pci_dev *dev);
Bjorn Helgaas10874f52014-04-14 16:11:40 -0600235void __pci_bus_size_bridges(struct pci_bus *bus,
Jiang Liud66ecb72013-06-23 01:01:35 +0200236 struct list_head *realloc_head);
Bjorn Helgaas10874f52014-04-14 16:11:40 -0600237void __pci_bus_assign_resources(const struct pci_bus *bus,
238 struct list_head *realloc_head,
239 struct list_head *fail_head);
Yinghai Lu0f7e7ae2015-01-15 16:21:49 -0600240bool pci_bus_clip_resource(struct pci_dev *dev, int idx);
Bjorn Helgaas939de1d2013-01-26 17:35:58 -0700241
Yinghai Lu2069ecf2012-02-15 21:40:31 -0800242void pci_reassigndev_resource_alignment(struct pci_dev *dev);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600243void pci_disable_bridge_window(struct pci_dev *dev);
Yuji Shimada32a9a6822009-03-16 17:13:39 +0900244
Yu Zhaod1b054d2009-03-20 11:25:11 +0800245/* Single Root I/O Virtualization */
246struct pci_sriov {
247 int pos; /* capability position */
248 int nres; /* number of resources */
249 u32 cap; /* SR-IOV Capabilities */
250 u16 ctrl; /* SR-IOV Control */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700251 u16 total_VFs; /* total VFs associated with the PF */
252 u16 initial_VFs; /* initial VFs associated with the PF */
253 u16 num_VFs; /* number of VFs available */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800254 u16 offset; /* first VF Routing ID offset */
255 u16 stride; /* following VF stride */
256 u32 pgsz; /* page size for BAR alignment */
257 u8 link; /* Function Dependency Link */
Wei Yang4449f072015-03-25 16:23:47 +0800258 u8 max_VF_buses; /* max buses consumed by VFs */
Bjorn Helgaas6b136722012-11-09 20:27:53 -0700259 u16 driver_max_VFs; /* max num VFs driver supports */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800260 struct pci_dev *dev; /* lowest numbered PF */
261 struct pci_dev *self; /* this PF */
262 struct mutex lock; /* lock for VF bus */
Wei Yang0e6c9122015-03-25 16:23:44 +0800263 resource_size_t barsz[PCI_SRIOV_NUM_BARS]; /* VF BAR size */
Yu Zhaod1b054d2009-03-20 11:25:11 +0800264};
265
Hao, Xudong1900ca12011-12-17 21:24:40 +0800266#ifdef CONFIG_PCI_ATS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600267void pci_restore_ats_state(struct pci_dev *dev);
Hao, Xudong1900ca12011-12-17 21:24:40 +0800268#else
269static inline void pci_restore_ats_state(struct pci_dev *dev)
270{
271}
272#endif /* CONFIG_PCI_ATS */
273
Yu Zhaod1b054d2009-03-20 11:25:11 +0800274#ifdef CONFIG_PCI_IOV
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600275int pci_iov_init(struct pci_dev *dev);
276void pci_iov_release(struct pci_dev *dev);
Myron Stowe26ff46c2014-11-11 08:04:50 -0700277int pci_iov_resource_bar(struct pci_dev *dev, int resno);
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600278resource_size_t pci_sriov_resource_alignment(struct pci_dev *dev, int resno);
279void pci_restore_iov_state(struct pci_dev *dev);
280int pci_iov_bus_range(struct pci_bus *bus);
Yu Zhao302b4212009-05-18 13:51:32 +0800281
Yu Zhaod1b054d2009-03-20 11:25:11 +0800282#else
283static inline int pci_iov_init(struct pci_dev *dev)
284{
285 return -ENODEV;
286}
287static inline void pci_iov_release(struct pci_dev *dev)
288
289{
290}
Myron Stowe26ff46c2014-11-11 08:04:50 -0700291static inline int pci_iov_resource_bar(struct pci_dev *dev, int resno)
Yu Zhaod1b054d2009-03-20 11:25:11 +0800292{
293 return 0;
294}
Yu Zhao8c5cdb62009-03-20 11:25:12 +0800295static inline void pci_restore_iov_state(struct pci_dev *dev)
296{
297}
Yu Zhaoa28724b2009-03-20 11:25:13 +0800298static inline int pci_iov_bus_range(struct pci_bus *bus)
299{
300 return 0;
301}
Yu Zhao302b4212009-05-18 13:51:32 +0800302
Yu Zhaod1b054d2009-03-20 11:25:11 +0800303#endif /* CONFIG_PCI_IOV */
304
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600305unsigned long pci_cardbus_resource_alignment(struct resource *);
Ram Pai0a2daa12011-07-25 13:08:41 -0700306
Cam Macdonell0e522472010-09-07 17:25:20 -0700307static inline resource_size_t pci_resource_alignment(struct pci_dev *dev,
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600308 struct resource *res)
Chris Wright6faf17f2009-08-28 13:00:06 -0700309{
310#ifdef CONFIG_PCI_IOV
311 int resno = res - dev->resource;
312
313 if (resno >= PCI_IOV_RESOURCES && resno <= PCI_IOV_RESOURCE_END)
314 return pci_sriov_resource_alignment(dev, resno);
315#endif
Ram Pai0a2daa12011-07-25 13:08:41 -0700316 if (dev->class >> 8 == PCI_CLASS_BRIDGE_CARDBUS)
317 return pci_cardbus_resource_alignment(res);
Chris Wright6faf17f2009-08-28 13:00:06 -0700318 return resource_alignment(res);
319}
320
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600321void pci_enable_acs(struct pci_dev *dev);
Allen Kayae21ee62009-10-07 10:27:17 -0700322
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800323struct pci_dev_reset_methods {
324 u16 vendor;
325 u16 device;
326 int (*reset)(struct pci_dev *dev, int probe);
327};
328
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100329#ifdef CONFIG_PCI_QUIRKS
Bjorn Helgaasf39d5b72013-04-12 12:02:59 -0600330int pci_dev_specific_reset(struct pci_dev *dev, int probe);
Rafael J. Wysocki93177a72010-01-02 22:57:24 +0100331#else
332static inline int pci_dev_specific_reset(struct pci_dev *dev, int probe)
333{
334 return -ENOTTY;
335}
336#endif
Dexuan Cuib9c3b262009-12-07 13:03:21 +0800337
Aaron Lu3390e082015-03-25 14:32:25 +0800338struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
339
Zhao, Yu557848c2008-10-13 19:18:07 +0800340#endif /* DRIVERS_PCI_H */