1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (C) 2014-2015 Broadcom Corporation
4  */
5 
6 #ifndef _PCIE_IPROC_H
7 #define _PCIE_IPROC_H
8 
9 /**
10  * iProc PCIe interface type
11  *
12  * PAXB is the wrapper used in root complex that can be connected to an
13  * external endpoint device.
14  *
15  * PAXC is the wrapper used in root complex dedicated for internal emulated
16  * endpoint devices.
17  */
18 enum iproc_pcie_type {
19 	IPROC_PCIE_PAXB_BCMA = 0,
20 	IPROC_PCIE_PAXB,
21 	IPROC_PCIE_PAXB_V2,
22 	IPROC_PCIE_PAXC,
23 	IPROC_PCIE_PAXC_V2,
24 };
25 
26 /**
27  * iProc PCIe outbound mapping
28  * @axi_offset: offset from the AXI address to the internal address used by
29  * the iProc PCIe core
30  * @nr_windows: total number of supported outbound mapping windows
31  */
32 struct iproc_pcie_ob {
33 	resource_size_t axi_offset;
34 	unsigned int nr_windows;
35 };
36 
37 /**
38  * iProc PCIe inbound mapping
39  * @nr_regions: total number of supported inbound mapping regions
40  */
41 struct iproc_pcie_ib {
42 	unsigned int nr_regions;
43 };
44 
45 struct iproc_pcie_ob_map;
46 struct iproc_pcie_ib_map;
47 struct iproc_msi;
48 
49 /**
50  * iProc PCIe device
51  *
52  * @dev: pointer to device data structure
53  * @type: iProc PCIe interface type
54  * @reg_offsets: register offsets
55  * @base: PCIe host controller I/O register base
56  * @base_addr: PCIe host controller register base physical address
57  * @root_bus: pointer to root bus
58  * @phy: optional PHY device that controls the Serdes
59  * @map_irq: function callback to map interrupts
60  * @ep_is_internal: indicates an internal emulated endpoint device is connected
61  * @has_apb_err_disable: indicates the controller can be configured to prevent
62  * unsupported request from being forwarded as an APB bus error
63  *
64  * @need_ob_cfg: indicates SW needs to configure the outbound mapping window
65  * @ob: outbound mapping related parameters
66  * @ob_map: outbound mapping related parameters specific to the controller
67  *
68  * @need_ib_cfg: indicates SW needs to configure the inbound mapping window
69  * @ib: inbound mapping related parameters
70  * @ib_map: outbound mapping region related parameters
71  *
72  * @need_msi_steer: indicates additional configuration of the iProc PCIe
73  * controller is required to steer MSI writes to external interrupt controller
74  * @msi: MSI data
75  */
76 struct iproc_pcie {
77 	struct device *dev;
78 	enum iproc_pcie_type type;
79 	u16 *reg_offsets;
80 	void __iomem *base;
81 	phys_addr_t base_addr;
82 	struct resource mem;
83 	struct pci_bus *root_bus;
84 	struct phy *phy;
85 	int (*map_irq)(const struct pci_dev *, u8, u8);
86 	bool ep_is_internal;
87 	bool has_apb_err_disable;
88 
89 	bool need_ob_cfg;
90 	struct iproc_pcie_ob ob;
91 	const struct iproc_pcie_ob_map *ob_map;
92 
93 	bool need_ib_cfg;
94 	struct iproc_pcie_ib ib;
95 	const struct iproc_pcie_ib_map *ib_map;
96 
97 	bool need_msi_steer;
98 	struct iproc_msi *msi;
99 };
100 
101 int iproc_pcie_setup(struct iproc_pcie *pcie, struct list_head *res);
102 int iproc_pcie_remove(struct iproc_pcie *pcie);
103 int iproc_pcie_shutdown(struct iproc_pcie *pcie);
104 
105 #ifdef CONFIG_PCIE_IPROC_MSI
106 int iproc_msi_init(struct iproc_pcie *pcie, struct device_node *node);
107 void iproc_msi_exit(struct iproc_pcie *pcie);
108 #else
109 static inline int iproc_msi_init(struct iproc_pcie *pcie,
110 				 struct device_node *node)
111 {
112 	return -ENODEV;
113 }
114 static inline void iproc_msi_exit(struct iproc_pcie *pcie)
115 {
116 }
117 #endif
118 
119 #endif /* _PCIE_IPROC_H */
120