1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Purpose: PCI Express Port Bus Driver's Internal Data Structures 4 * 5 * Copyright (C) 2004 Intel 6 * Copyright (C) Tom Long Nguyen (tom.l.nguyen@intel.com) 7 */ 8 9 #ifndef _PORTDRV_H_ 10 #define _PORTDRV_H_ 11 12 #include <linux/compiler.h> 13 14 /* Service Type */ 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 24 #define PCIE_PORT_DEVICE_MAXSERVICES 4 25 26 /* Port Type */ 27 #define PCIE_ANY_PORT (~0) 28 29 struct pcie_device { 30 int irq; /* Service IRQ/MSI/MSI-X Vector */ 31 struct pci_dev *port; /* Root/Upstream/Downstream Port */ 32 u32 service; /* Port service this device represents */ 33 void *priv_data; /* Service Private Data */ 34 struct device device; /* Generic Device Interface */ 35 }; 36 #define to_pcie_device(d) container_of(d, struct pcie_device, device) 37 38 static inline void set_service_data(struct pcie_device *dev, void *data) 39 { 40 dev->priv_data = data; 41 } 42 43 static inline void *get_service_data(struct pcie_device *dev) 44 { 45 return dev->priv_data; 46 } 47 48 struct pcie_port_service_driver { 49 const char *name; 50 int (*probe) (struct pcie_device *dev); 51 void (*remove) (struct pcie_device *dev); 52 int (*suspend) (struct pcie_device *dev); 53 int (*resume) (struct pcie_device *dev); 54 55 /* Device driver may resume normal operations */ 56 void (*error_resume)(struct pci_dev *dev); 57 58 /* Link Reset Capability - AER service driver specific */ 59 pci_ers_result_t (*reset_link) (struct pci_dev *dev); 60 61 int port_type; /* Type of the port this driver can handle */ 62 u32 service; /* Port service this device represents */ 63 64 struct device_driver driver; 65 }; 66 #define to_service_driver(d) \ 67 container_of(d, struct pcie_port_service_driver, driver) 68 69 int pcie_port_service_register(struct pcie_port_service_driver *new); 70 void pcie_port_service_unregister(struct pcie_port_service_driver *new); 71 72 /* 73 * The PCIe Capability Interrupt Message Number (PCIe r3.1, sec 7.8.2) must 74 * be one of the first 32 MSI-X entries. Per PCI r3.0, sec 6.8.3.1, MSI 75 * supports a maximum of 32 vectors per function. 76 */ 77 #define PCIE_PORT_MAX_MSI_ENTRIES 32 78 79 #define get_descriptor_id(type, service) (((type - 4) << 8) | service) 80 81 extern struct bus_type pcie_port_bus_type; 82 int pcie_port_device_register(struct pci_dev *dev); 83 #ifdef CONFIG_PM 84 int pcie_port_device_suspend(struct device *dev); 85 int pcie_port_device_resume(struct device *dev); 86 #endif 87 void pcie_port_device_remove(struct pci_dev *dev); 88 int __must_check pcie_port_bus_register(void); 89 void pcie_port_bus_unregister(void); 90 91 struct pci_dev; 92 93 #ifdef CONFIG_PCIE_PME 94 extern bool pcie_pme_msi_disabled; 95 96 static inline void pcie_pme_disable_msi(void) 97 { 98 pcie_pme_msi_disabled = true; 99 } 100 101 static inline bool pcie_pme_no_msi(void) 102 { 103 return pcie_pme_msi_disabled; 104 } 105 106 void pcie_pme_interrupt_enable(struct pci_dev *dev, bool enable); 107 #else /* !CONFIG_PCIE_PME */ 108 static inline void pcie_pme_disable_msi(void) {} 109 static inline bool pcie_pme_no_msi(void) { return false; } 110 static inline void pcie_pme_interrupt_enable(struct pci_dev *dev, bool en) {} 111 #endif /* !CONFIG_PCIE_PME */ 112 113 #ifdef CONFIG_ACPI_APEI 114 int pcie_aer_get_firmware_first(struct pci_dev *pci_dev); 115 #else 116 static inline int pcie_aer_get_firmware_first(struct pci_dev *pci_dev) 117 { 118 if (pci_dev->__aer_firmware_first_valid) 119 return pci_dev->__aer_firmware_first; 120 return 0; 121 } 122 #endif 123 124 #ifdef CONFIG_PCIEAER 125 irqreturn_t aer_irq(int irq, void *context); 126 #endif 127 128 struct pcie_port_service_driver *pcie_port_find_service(struct pci_dev *dev, 129 u32 service); 130 struct device *pcie_port_find_device(struct pci_dev *dev, u32 service); 131 #endif /* _PORTDRV_H_ */ 132