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)
24 #define PCIE_PORT_DEVICE_MAXSERVICES 4
27 int pcie_aer_init(void);
29 static inline int pcie_aer_init(void) { return 0; }
32 #ifdef CONFIG_HOTPLUG_PCI_PCIE
33 int pcie_hp_init(void);
35 static inline int pcie_hp_init(void) { return 0; }
38 #ifdef CONFIG_PCIE_PME
39 int pcie_pme_init(void);
41 static inline int pcie_pme_init(void) { return 0; }
44 #ifdef CONFIG_PCIE_DPC
45 int pcie_dpc_init(void);
47 static inline int pcie_dpc_init(void) { return 0; }
51 #define PCIE_ANY_PORT (~0)
54 int irq; /* Service IRQ/MSI/MSI-X Vector */
55 struct pci_dev *port; /* Root/Upstream/Downstream Port */
56 u32 service; /* Port service this device represents */
57 void *priv_data; /* Service Private Data */
58 struct device device; /* Generic Device Interface */
60 #define to_pcie_device(d) container_of(d, struct pcie_device, device)
62 static inline void set_service_data(struct pcie_device *dev, void *data)
64 dev->priv_data = data;
67 static inline void *get_service_data(struct pcie_device *dev)
69 return dev->priv_data;
72 struct pcie_port_service_driver {
74 int (*probe) (struct pcie_device *dev);
75 void (*remove) (struct pcie_device *dev);
76 int (*suspend) (struct pcie_device *dev);
77 int (*resume_noirq) (struct pcie_device *dev);
78 int (*resume) (struct pcie_device *dev);
79 int (*runtime_suspend) (struct pcie_device *dev);
80 int (*runtime_resume) (struct pcie_device *dev);
82 /* Device driver may resume normal operations */
83 void (*error_resume)(struct pci_dev *dev);
85 /* Link Reset Capability - AER service driver specific */
86 pci_ers_result_t (*reset_link) (struct pci_dev *dev);
88 int port_type; /* Type of the port this driver can handle */
89 u32 service; /* Port service this device represents */
91 struct device_driver driver;
93 #define to_service_driver(d) \
94 container_of(d, struct pcie_port_service_driver, driver)
96 int pcie_port_service_register(struct pcie_port_service_driver *new);
97 void pcie_port_service_unregister(struct pcie_port_service_driver *new);
100 * The PCIe Capability Interrupt Message Number (PCIe r3.1, sec 7.8.2) must
101 * be one of the first 32 MSI-X entries. Per PCI r3.0, sec 6.8.3.1, MSI
102 * supports a maximum of 32 vectors per function.
104 #define PCIE_PORT_MAX_MSI_ENTRIES 32
106 #define get_descriptor_id(type, service) (((type - 4) << 8) | service)
108 extern struct bus_type pcie_port_bus_type;
109 int pcie_port_device_register(struct pci_dev *dev);
111 int pcie_port_device_suspend(struct device *dev);
112 int pcie_port_device_resume_noirq(struct device *dev);
113 int pcie_port_device_resume(struct device *dev);
114 int pcie_port_device_runtime_suspend(struct device *dev);
115 int pcie_port_device_runtime_resume(struct device *dev);
117 void pcie_port_device_remove(struct pci_dev *dev);
118 int __must_check pcie_port_bus_register(void);
119 void pcie_port_bus_unregister(void);
123 #ifdef CONFIG_PCIE_PME
124 extern bool pcie_pme_msi_disabled;
126 static inline void pcie_pme_disable_msi(void)
128 pcie_pme_msi_disabled = true;
131 static inline bool pcie_pme_no_msi(void)
133 return pcie_pme_msi_disabled;
136 void pcie_pme_interrupt_enable(struct pci_dev *dev, bool enable);
137 #else /* !CONFIG_PCIE_PME */
138 static inline void pcie_pme_disable_msi(void) {}
139 static inline bool pcie_pme_no_msi(void) { return false; }
140 static inline void pcie_pme_interrupt_enable(struct pci_dev *dev, bool en) {}
141 #endif /* !CONFIG_PCIE_PME */
143 #ifdef CONFIG_ACPI_APEI
144 int pcie_aer_get_firmware_first(struct pci_dev *pci_dev);
146 static inline int pcie_aer_get_firmware_first(struct pci_dev *pci_dev)
148 if (pci_dev->__aer_firmware_first_valid)
149 return pci_dev->__aer_firmware_first;
154 struct pcie_port_service_driver *pcie_port_find_service(struct pci_dev *dev,
156 struct device *pcie_port_find_device(struct pci_dev *dev, u32 service);
157 #endif /* _PORTDRV_H_ */