1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Purpose: PCI Express Port Bus Driver's Internal Data Structures
5 * Copyright (C) 2004 Intel
6 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com)
12 #include <linux/compiler.h>
15 #define PCIE_PORT_SERVICE_PME_SHIFT 0 /* Power Management Event */
16 #define PCIE_PORT_SERVICE_PME (1 << PCIE_PORT_SERVICE_PME_SHIFT)
17 #define PCIE_PORT_SERVICE_AER_SHIFT 1 /* Advanced Error Reporting */
18 #define PCIE_PORT_SERVICE_AER (1 << PCIE_PORT_SERVICE_AER_SHIFT)
19 #define PCIE_PORT_SERVICE_HP_SHIFT 2 /* Native Hotplug */
20 #define PCIE_PORT_SERVICE_HP (1 << PCIE_PORT_SERVICE_HP_SHIFT)
21 #define PCIE_PORT_SERVICE_DPC_SHIFT 3 /* Downstream Port Containment */
22 #define PCIE_PORT_SERVICE_DPC (1 << PCIE_PORT_SERVICE_DPC_SHIFT)
23 #define PCIE_PORT_SERVICE_BWNOTIF_SHIFT 4 /* Bandwidth notification */
24 #define PCIE_PORT_SERVICE_BWNOTIF (1 << PCIE_PORT_SERVICE_BWNOTIF_SHIFT)
26 #define PCIE_PORT_DEVICE_MAXSERVICES 5
28 extern bool pcie_ports_dpc_native;
31 int pcie_aer_init(void);
33 static inline int pcie_aer_init(void) { return 0; }
36 #ifdef CONFIG_HOTPLUG_PCI_PCIE
37 int pcie_hp_init(void);
39 static inline int pcie_hp_init(void) { return 0; }
42 #ifdef CONFIG_PCIE_PME
43 int pcie_pme_init(void);
45 static inline int pcie_pme_init(void) { return 0; }
48 #ifdef CONFIG_PCIE_DPC
49 int pcie_dpc_init(void);
51 static inline int pcie_dpc_init(void) { return 0; }
55 int pcie_bandwidth_notification_init(void);
57 static inline int pcie_bandwidth_notification_init(void) { return 0; }
61 #define PCIE_ANY_PORT (~0)
64 int irq; /* Service IRQ/MSI/MSI-X Vector */
65 struct pci_dev *port; /* Root/Upstream/Downstream Port */
66 u32 service; /* Port service this device represents */
67 void *priv_data; /* Service Private Data */
68 struct device device; /* Generic Device Interface */
70 #define to_pcie_device(d) container_of(d, struct pcie_device, device)
72 static inline void set_service_data(struct pcie_device *dev, void *data)
74 dev->priv_data = data;
77 static inline void *get_service_data(struct pcie_device *dev)
79 return dev->priv_data;
82 struct pcie_port_service_driver {
84 int (*probe)(struct pcie_device *dev);
85 void (*remove)(struct pcie_device *dev);
86 int (*suspend)(struct pcie_device *dev);
87 int (*resume_noirq)(struct pcie_device *dev);
88 int (*resume)(struct pcie_device *dev);
89 int (*runtime_suspend)(struct pcie_device *dev);
90 int (*runtime_resume)(struct pcie_device *dev);
92 /* Device driver may resume normal operations */
93 void (*error_resume)(struct pci_dev *dev);
95 /* Link Reset Capability - AER service driver specific */
96 pci_ers_result_t (*reset_link)(struct pci_dev *dev);
98 int port_type; /* Type of the port this driver can handle */
99 u32 service; /* Port service this device represents */
101 struct device_driver driver;
103 #define to_service_driver(d) \
104 container_of(d, struct pcie_port_service_driver, driver)
106 int pcie_port_service_register(struct pcie_port_service_driver *new);
107 void pcie_port_service_unregister(struct pcie_port_service_driver *new);
110 * The PCIe Capability Interrupt Message Number (PCIe r3.1, sec 7.8.2) must
111 * be one of the first 32 MSI-X entries. Per PCI r3.0, sec 6.8.3.1, MSI
112 * supports a maximum of 32 vectors per function.
114 #define PCIE_PORT_MAX_MSI_ENTRIES 32
116 #define get_descriptor_id(type, service) (((type - 4) << 8) | service)
118 extern struct bus_type pcie_port_bus_type;
119 int pcie_port_device_register(struct pci_dev *dev);
121 int pcie_port_device_suspend(struct device *dev);
122 int pcie_port_device_resume_noirq(struct device *dev);
123 int pcie_port_device_resume(struct device *dev);
124 int pcie_port_device_runtime_suspend(struct device *dev);
125 int pcie_port_device_runtime_resume(struct device *dev);
127 void pcie_port_device_remove(struct pci_dev *dev);
128 int __must_check pcie_port_bus_register(void);
129 void pcie_port_bus_unregister(void);
133 #ifdef CONFIG_PCIE_PME
134 extern bool pcie_pme_msi_disabled;
136 static inline void pcie_pme_disable_msi(void)
138 pcie_pme_msi_disabled = true;
141 static inline bool pcie_pme_no_msi(void)
143 return pcie_pme_msi_disabled;
146 void pcie_pme_interrupt_enable(struct pci_dev *dev, bool enable);
147 #else /* !CONFIG_PCIE_PME */
148 static inline void pcie_pme_disable_msi(void) {}
149 static inline bool pcie_pme_no_msi(void) { return false; }
150 static inline void pcie_pme_interrupt_enable(struct pci_dev *dev, bool en) {}
151 #endif /* !CONFIG_PCIE_PME */
153 #ifdef CONFIG_ACPI_APEI
154 int pcie_aer_get_firmware_first(struct pci_dev *pci_dev);
156 static inline int pcie_aer_get_firmware_first(struct pci_dev *pci_dev)
158 if (pci_dev->__aer_firmware_first_valid)
159 return pci_dev->__aer_firmware_first;
164 struct pcie_port_service_driver *pcie_port_find_service(struct pci_dev *dev,
166 struct device *pcie_port_find_device(struct pci_dev *dev, u32 service);
167 #endif /* _PORTDRV_H_ */