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 * @phy: optional PHY device that controls the Serdes
58 * @map_irq: function callback to map interrupts
59 * @ep_is_internal: indicates an internal emulated endpoint device is connected
60 * @iproc_cfg_read: indicates the iProc config read function should be used
61 * @rej_unconfig_pf: indicates the root complex needs to detect and reject
62 * enumeration against unconfigured physical functions emulated in the ASIC
63 * @has_apb_err_disable: indicates the controller can be configured to prevent
64 * unsupported request from being forwarded as an APB bus error
65 * @fix_paxc_cap: indicates the controller has corrupted capability list in its
66 * config space registers and requires SW based fixup
67 *
68 * @need_ob_cfg: indicates SW needs to configure the outbound mapping window
69 * @ob: outbound mapping related parameters
70 * @ob_map: outbound mapping related parameters specific to the controller
71 *
72 * @need_ib_cfg: indicates SW needs to configure the inbound mapping window
73 * @ib: inbound mapping related parameters
74 * @ib_map: outbound mapping region related parameters
75 *
76 * @need_msi_steer: indicates additional configuration of the iProc PCIe
77 * controller is required to steer MSI writes to external interrupt controller
78 * @msi: MSI data
79 */
80 struct iproc_pcie {
81 struct device *dev;
82 enum iproc_pcie_type type;
83 u16 *reg_offsets;
84 void __iomem *base;
85 phys_addr_t base_addr;
86 struct resource mem;
87 struct phy *phy;
88 int (*map_irq)(const struct pci_dev *, u8, u8);
89 bool ep_is_internal;
90 bool iproc_cfg_read;
91 bool rej_unconfig_pf;
92 bool has_apb_err_disable;
93 bool fix_paxc_cap;
94
95 bool need_ob_cfg;
96 struct iproc_pcie_ob ob;
97 const struct iproc_pcie_ob_map *ob_map;
98
99 bool need_ib_cfg;
100 struct iproc_pcie_ib ib;
101 const struct iproc_pcie_ib_map *ib_map;
102
103 bool need_msi_steer;
104 struct iproc_msi *msi;
105 };
106
107 int iproc_pcie_setup(struct iproc_pcie *pcie, struct list_head *res);
108 int iproc_pcie_remove(struct iproc_pcie *pcie);
109 int iproc_pcie_shutdown(struct iproc_pcie *pcie);
110
111 #ifdef CONFIG_PCIE_IPROC_MSI
112 int iproc_msi_init(struct iproc_pcie *pcie, struct device_node *node);
113 void iproc_msi_exit(struct iproc_pcie *pcie);
114 #else
iproc_msi_init(struct iproc_pcie * pcie,struct device_node * node)115 static inline int iproc_msi_init(struct iproc_pcie *pcie,
116 struct device_node *node)
117 {
118 return -ENODEV;
119 }
iproc_msi_exit(struct iproc_pcie * pcie)120 static inline void iproc_msi_exit(struct iproc_pcie *pcie)
121 {
122 }
123 #endif
124
125 #endif /* _PCIE_IPROC_H */
126