xref: /OK3568_Linux_fs/kernel/drivers/pci/controller/cadence/pcie-cadence.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun // Copyright (c) 2017 Cadence
3*4882a593Smuzhiyun // Cadence PCIe controller driver.
4*4882a593Smuzhiyun // Author: Cyrille Pitchen <cyrille.pitchen@free-electrons.com>
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #ifndef _PCIE_CADENCE_H
7*4882a593Smuzhiyun #define _PCIE_CADENCE_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/kernel.h>
10*4882a593Smuzhiyun #include <linux/pci.h>
11*4882a593Smuzhiyun #include <linux/phy/phy.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /* Parameters for the waiting for link up routine */
14*4882a593Smuzhiyun #define LINK_WAIT_MAX_RETRIES	10
15*4882a593Smuzhiyun #define LINK_WAIT_USLEEP_MIN	90000
16*4882a593Smuzhiyun #define LINK_WAIT_USLEEP_MAX	100000
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun /*
19*4882a593Smuzhiyun  * Local Management Registers
20*4882a593Smuzhiyun  */
21*4882a593Smuzhiyun #define CDNS_PCIE_LM_BASE	0x00100000
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun /* Vendor ID Register */
24*4882a593Smuzhiyun #define CDNS_PCIE_LM_ID		(CDNS_PCIE_LM_BASE + 0x0044)
25*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_VENDOR_MASK	GENMASK(15, 0)
26*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_VENDOR_SHIFT	0
27*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_VENDOR(vid) \
28*4882a593Smuzhiyun 	(((vid) << CDNS_PCIE_LM_ID_VENDOR_SHIFT) & CDNS_PCIE_LM_ID_VENDOR_MASK)
29*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_SUBSYS_MASK	GENMASK(31, 16)
30*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_SUBSYS_SHIFT	16
31*4882a593Smuzhiyun #define  CDNS_PCIE_LM_ID_SUBSYS(sub) \
32*4882a593Smuzhiyun 	(((sub) << CDNS_PCIE_LM_ID_SUBSYS_SHIFT) & CDNS_PCIE_LM_ID_SUBSYS_MASK)
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun /* Root Port Requestor ID Register */
35*4882a593Smuzhiyun #define CDNS_PCIE_LM_RP_RID	(CDNS_PCIE_LM_BASE + 0x0228)
36*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RP_RID_MASK	GENMASK(15, 0)
37*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RP_RID_SHIFT	0
38*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RP_RID_(rid) \
39*4882a593Smuzhiyun 	(((rid) << CDNS_PCIE_LM_RP_RID_SHIFT) & CDNS_PCIE_LM_RP_RID_MASK)
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /* Endpoint Bus and Device Number Register */
42*4882a593Smuzhiyun #define CDNS_PCIE_LM_EP_ID	(CDNS_PCIE_LM_BASE + 0x022c)
43*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_ID_DEV_MASK	GENMASK(4, 0)
44*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_ID_DEV_SHIFT	0
45*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_ID_BUS_MASK	GENMASK(15, 8)
46*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_ID_BUS_SHIFT	8
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun /* Endpoint Function f BAR b Configuration Registers */
49*4882a593Smuzhiyun #define CDNS_PCIE_LM_EP_FUNC_BAR_CFG0(fn) \
50*4882a593Smuzhiyun 	(CDNS_PCIE_LM_BASE + 0x0240 + (fn) * 0x0008)
51*4882a593Smuzhiyun #define CDNS_PCIE_LM_EP_FUNC_BAR_CFG1(fn) \
52*4882a593Smuzhiyun 	(CDNS_PCIE_LM_BASE + 0x0244 + (fn) * 0x0008)
53*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_APERTURE_MASK(b) \
54*4882a593Smuzhiyun 	(GENMASK(4, 0) << ((b) * 8))
55*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_APERTURE(b, a) \
56*4882a593Smuzhiyun 	(((a) << ((b) * 8)) & CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_APERTURE_MASK(b))
57*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_CTRL_MASK(b) \
58*4882a593Smuzhiyun 	(GENMASK(7, 5) << ((b) * 8))
59*4882a593Smuzhiyun #define  CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_CTRL(b, c) \
60*4882a593Smuzhiyun 	(((c) << ((b) * 8 + 5)) & CDNS_PCIE_LM_EP_FUNC_BAR_CFG_BAR_CTRL_MASK(b))
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /* Endpoint Function Configuration Register */
63*4882a593Smuzhiyun #define CDNS_PCIE_LM_EP_FUNC_CFG	(CDNS_PCIE_LM_BASE + 0x02c0)
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun /* Root Complex BAR Configuration Register */
66*4882a593Smuzhiyun #define CDNS_PCIE_LM_RC_BAR_CFG	(CDNS_PCIE_LM_BASE + 0x0300)
67*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR0_APERTURE_MASK	GENMASK(5, 0)
68*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR0_APERTURE(a) \
69*4882a593Smuzhiyun 	(((a) << 0) & CDNS_PCIE_LM_RC_BAR_CFG_BAR0_APERTURE_MASK)
70*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR0_CTRL_MASK		GENMASK(8, 6)
71*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR0_CTRL(c) \
72*4882a593Smuzhiyun 	(((c) << 6) & CDNS_PCIE_LM_RC_BAR_CFG_BAR0_CTRL_MASK)
73*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR1_APERTURE_MASK	GENMASK(13, 9)
74*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR1_APERTURE(a) \
75*4882a593Smuzhiyun 	(((a) << 9) & CDNS_PCIE_LM_RC_BAR_CFG_BAR1_APERTURE_MASK)
76*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR1_CTRL_MASK		GENMASK(16, 14)
77*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_BAR1_CTRL(c) \
78*4882a593Smuzhiyun 	(((c) << 14) & CDNS_PCIE_LM_RC_BAR_CFG_BAR1_CTRL_MASK)
79*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_PREFETCH_MEM_ENABLE	BIT(17)
80*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_PREFETCH_MEM_32BITS	0
81*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_PREFETCH_MEM_64BITS	BIT(18)
82*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_IO_ENABLE		BIT(19)
83*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_IO_16BITS		0
84*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_IO_32BITS		BIT(20)
85*4882a593Smuzhiyun #define  CDNS_PCIE_LM_RC_BAR_CFG_CHECK_ENABLE		BIT(31)
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun /* BAR control values applicable to both Endpoint Function and Root Complex */
88*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_DISABLED		0x0
89*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_IO_32BITS		0x1
90*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_MEM_32BITS		0x4
91*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_PREFETCH_MEM_32BITS	0x5
92*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_MEM_64BITS		0x6
93*4882a593Smuzhiyun #define  CDNS_PCIE_LM_BAR_CFG_CTRL_PREFETCH_MEM_64BITS	0x7
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_DISABLED(bar)		\
96*4882a593Smuzhiyun 		(CDNS_PCIE_LM_BAR_CFG_CTRL_DISABLED << (((bar) * 8) + 6))
97*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_IO_32BITS(bar)		\
98*4882a593Smuzhiyun 		(CDNS_PCIE_LM_BAR_CFG_CTRL_IO_32BITS << (((bar) * 8) + 6))
99*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_MEM_32BITS(bar)		\
100*4882a593Smuzhiyun 		(CDNS_PCIE_LM_BAR_CFG_CTRL_MEM_32BITS << (((bar) * 8) + 6))
101*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_PREF_MEM_32BITS(bar)	\
102*4882a593Smuzhiyun 	(CDNS_PCIE_LM_BAR_CFG_CTRL_PREFETCH_MEM_32BITS << (((bar) * 8) + 6))
103*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_MEM_64BITS(bar)		\
104*4882a593Smuzhiyun 		(CDNS_PCIE_LM_BAR_CFG_CTRL_MEM_64BITS << (((bar) * 8) + 6))
105*4882a593Smuzhiyun #define LM_RC_BAR_CFG_CTRL_PREF_MEM_64BITS(bar)	\
106*4882a593Smuzhiyun 	(CDNS_PCIE_LM_BAR_CFG_CTRL_PREFETCH_MEM_64BITS << (((bar) * 8) + 6))
107*4882a593Smuzhiyun #define LM_RC_BAR_CFG_APERTURE(bar, aperture)		\
108*4882a593Smuzhiyun 					(((aperture) - 2) << ((bar) * 8))
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /*
111*4882a593Smuzhiyun  * Endpoint Function Registers (PCI configuration space for endpoint functions)
112*4882a593Smuzhiyun  */
113*4882a593Smuzhiyun #define CDNS_PCIE_EP_FUNC_BASE(fn)	(((fn) << 12) & GENMASK(19, 12))
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun #define CDNS_PCIE_EP_FUNC_MSI_CAP_OFFSET	0x90
116*4882a593Smuzhiyun #define CDNS_PCIE_EP_FUNC_MSIX_CAP_OFFSET	0xb0
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun /*
119*4882a593Smuzhiyun  * Root Port Registers (PCI configuration space for the root port function)
120*4882a593Smuzhiyun  */
121*4882a593Smuzhiyun #define CDNS_PCIE_RP_BASE	0x00200000
122*4882a593Smuzhiyun #define CDNS_PCIE_RP_CAP_OFFSET 0xc0
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun /*
125*4882a593Smuzhiyun  * Address Translation Registers
126*4882a593Smuzhiyun  */
127*4882a593Smuzhiyun #define CDNS_PCIE_AT_BASE	0x00400000
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun /* Region r Outbound AXI to PCIe Address Translation Register 0 */
130*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_PCI_ADDR0(r) \
131*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0000 + ((r) & 0x1f) * 0x0020)
132*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_NBITS_MASK	GENMASK(5, 0)
133*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_NBITS(nbits) \
134*4882a593Smuzhiyun 	(((nbits) - 1) & CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_NBITS_MASK)
135*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_DEVFN_MASK	GENMASK(19, 12)
136*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_DEVFN(devfn) \
137*4882a593Smuzhiyun 	(((devfn) << 12) & CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_DEVFN_MASK)
138*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_BUS_MASK	GENMASK(27, 20)
139*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_BUS(bus) \
140*4882a593Smuzhiyun 	(((bus) << 20) & CDNS_PCIE_AT_OB_REGION_PCI_ADDR0_BUS_MASK)
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun /* Region r Outbound AXI to PCIe Address Translation Register 1 */
143*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_PCI_ADDR1(r) \
144*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0004 + ((r) & 0x1f) * 0x0020)
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun /* Region r Outbound PCIe Descriptor Register 0 */
147*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_DESC0(r) \
148*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0008 + ((r) & 0x1f) * 0x0020)
149*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_MASK		GENMASK(3, 0)
150*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_MEM		0x2
151*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_IO		0x6
152*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_CONF_TYPE0	0xa
153*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_CONF_TYPE1	0xb
154*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_NORMAL_MSG	0xc
155*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_TYPE_VENDOR_MSG	0xd
156*4882a593Smuzhiyun /* Bit 23 MUST be set in RC mode. */
157*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_HARDCODED_RID	BIT(23)
158*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_DEVFN_MASK	GENMASK(31, 24)
159*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC0_DEVFN(devfn) \
160*4882a593Smuzhiyun 	(((devfn) << 24) & CDNS_PCIE_AT_OB_REGION_DESC0_DEVFN_MASK)
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun /* Region r Outbound PCIe Descriptor Register 1 */
163*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_DESC1(r)	\
164*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x000c + ((r) & 0x1f) * 0x0020)
165*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC1_BUS_MASK	GENMASK(7, 0)
166*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_DESC1_BUS(bus) \
167*4882a593Smuzhiyun 	((bus) & CDNS_PCIE_AT_OB_REGION_DESC1_BUS_MASK)
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun /* Region r AXI Region Base Address Register 0 */
170*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_CPU_ADDR0(r) \
171*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0018 + ((r) & 0x1f) * 0x0020)
172*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_CPU_ADDR0_NBITS_MASK	GENMASK(5, 0)
173*4882a593Smuzhiyun #define  CDNS_PCIE_AT_OB_REGION_CPU_ADDR0_NBITS(nbits) \
174*4882a593Smuzhiyun 	(((nbits) - 1) & CDNS_PCIE_AT_OB_REGION_CPU_ADDR0_NBITS_MASK)
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun /* Region r AXI Region Base Address Register 1 */
177*4882a593Smuzhiyun #define CDNS_PCIE_AT_OB_REGION_CPU_ADDR1(r) \
178*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x001c + ((r) & 0x1f) * 0x0020)
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun /* Root Port BAR Inbound PCIe to AXI Address Translation Register */
181*4882a593Smuzhiyun #define CDNS_PCIE_AT_IB_RP_BAR_ADDR0(bar) \
182*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0800 + (bar) * 0x0008)
183*4882a593Smuzhiyun #define  CDNS_PCIE_AT_IB_RP_BAR_ADDR0_NBITS_MASK	GENMASK(5, 0)
184*4882a593Smuzhiyun #define  CDNS_PCIE_AT_IB_RP_BAR_ADDR0_NBITS(nbits) \
185*4882a593Smuzhiyun 	(((nbits) - 1) & CDNS_PCIE_AT_IB_RP_BAR_ADDR0_NBITS_MASK)
186*4882a593Smuzhiyun #define CDNS_PCIE_AT_IB_RP_BAR_ADDR1(bar) \
187*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0804 + (bar) * 0x0008)
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun /* AXI link down register */
190*4882a593Smuzhiyun #define CDNS_PCIE_AT_LINKDOWN (CDNS_PCIE_AT_BASE + 0x0824)
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun /* LTSSM Capabilities register */
193*4882a593Smuzhiyun #define CDNS_PCIE_LTSSM_CONTROL_CAP             (CDNS_PCIE_LM_BASE + 0x0054)
194*4882a593Smuzhiyun #define  CDNS_PCIE_DETECT_QUIET_MIN_DELAY_MASK  GENMASK(2, 1)
195*4882a593Smuzhiyun #define  CDNS_PCIE_DETECT_QUIET_MIN_DELAY_SHIFT 1
196*4882a593Smuzhiyun #define  CDNS_PCIE_DETECT_QUIET_MIN_DELAY(delay) \
197*4882a593Smuzhiyun 	 (((delay) << CDNS_PCIE_DETECT_QUIET_MIN_DELAY_SHIFT) & \
198*4882a593Smuzhiyun 	 CDNS_PCIE_DETECT_QUIET_MIN_DELAY_MASK)
199*4882a593Smuzhiyun 
200*4882a593Smuzhiyun enum cdns_pcie_rp_bar {
201*4882a593Smuzhiyun 	RP_BAR_UNDEFINED = -1,
202*4882a593Smuzhiyun 	RP_BAR0,
203*4882a593Smuzhiyun 	RP_BAR1,
204*4882a593Smuzhiyun 	RP_NO_BAR
205*4882a593Smuzhiyun };
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun #define CDNS_PCIE_RP_MAX_IB	0x3
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun struct cdns_pcie_rp_ib_bar {
210*4882a593Smuzhiyun 	u64 size;
211*4882a593Smuzhiyun 	bool free;
212*4882a593Smuzhiyun };
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun /* Endpoint Function BAR Inbound PCIe to AXI Address Translation Register */
215*4882a593Smuzhiyun #define CDNS_PCIE_AT_IB_EP_FUNC_BAR_ADDR0(fn, bar) \
216*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0840 + (fn) * 0x0040 + (bar) * 0x0008)
217*4882a593Smuzhiyun #define CDNS_PCIE_AT_IB_EP_FUNC_BAR_ADDR1(fn, bar) \
218*4882a593Smuzhiyun 	(CDNS_PCIE_AT_BASE + 0x0844 + (fn) * 0x0040 + (bar) * 0x0008)
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun /* Normal/Vendor specific message access: offset inside some outbound region */
221*4882a593Smuzhiyun #define CDNS_PCIE_NORMAL_MSG_ROUTING_MASK	GENMASK(7, 5)
222*4882a593Smuzhiyun #define CDNS_PCIE_NORMAL_MSG_ROUTING(route) \
223*4882a593Smuzhiyun 	(((route) << 5) & CDNS_PCIE_NORMAL_MSG_ROUTING_MASK)
224*4882a593Smuzhiyun #define CDNS_PCIE_NORMAL_MSG_CODE_MASK		GENMASK(15, 8)
225*4882a593Smuzhiyun #define CDNS_PCIE_NORMAL_MSG_CODE(code) \
226*4882a593Smuzhiyun 	(((code) << 8) & CDNS_PCIE_NORMAL_MSG_CODE_MASK)
227*4882a593Smuzhiyun #define CDNS_PCIE_MSG_NO_DATA			BIT(16)
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun struct cdns_pcie;
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun enum cdns_pcie_msg_code {
232*4882a593Smuzhiyun 	MSG_CODE_ASSERT_INTA	= 0x20,
233*4882a593Smuzhiyun 	MSG_CODE_ASSERT_INTB	= 0x21,
234*4882a593Smuzhiyun 	MSG_CODE_ASSERT_INTC	= 0x22,
235*4882a593Smuzhiyun 	MSG_CODE_ASSERT_INTD	= 0x23,
236*4882a593Smuzhiyun 	MSG_CODE_DEASSERT_INTA	= 0x24,
237*4882a593Smuzhiyun 	MSG_CODE_DEASSERT_INTB	= 0x25,
238*4882a593Smuzhiyun 	MSG_CODE_DEASSERT_INTC	= 0x26,
239*4882a593Smuzhiyun 	MSG_CODE_DEASSERT_INTD	= 0x27,
240*4882a593Smuzhiyun };
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun enum cdns_pcie_msg_routing {
243*4882a593Smuzhiyun 	/* Route to Root Complex */
244*4882a593Smuzhiyun 	MSG_ROUTING_TO_RC,
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 	/* Use Address Routing */
247*4882a593Smuzhiyun 	MSG_ROUTING_BY_ADDR,
248*4882a593Smuzhiyun 
249*4882a593Smuzhiyun 	/* Use ID Routing */
250*4882a593Smuzhiyun 	MSG_ROUTING_BY_ID,
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun 	/* Route as Broadcast Message from Root Complex */
253*4882a593Smuzhiyun 	MSG_ROUTING_BCAST,
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	/* Local message; terminate at receiver (INTx messages) */
256*4882a593Smuzhiyun 	MSG_ROUTING_LOCAL,
257*4882a593Smuzhiyun 
258*4882a593Smuzhiyun 	/* Gather & route to Root Complex (PME_TO_Ack message) */
259*4882a593Smuzhiyun 	MSG_ROUTING_GATHER,
260*4882a593Smuzhiyun };
261*4882a593Smuzhiyun 
262*4882a593Smuzhiyun struct cdns_pcie_ops {
263*4882a593Smuzhiyun 	int	(*start_link)(struct cdns_pcie *pcie);
264*4882a593Smuzhiyun 	void	(*stop_link)(struct cdns_pcie *pcie);
265*4882a593Smuzhiyun 	bool	(*link_up)(struct cdns_pcie *pcie);
266*4882a593Smuzhiyun 	u64     (*cpu_addr_fixup)(struct cdns_pcie *pcie, u64 cpu_addr);
267*4882a593Smuzhiyun };
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun /**
270*4882a593Smuzhiyun  * struct cdns_pcie - private data for Cadence PCIe controller drivers
271*4882a593Smuzhiyun  * @reg_base: IO mapped register base
272*4882a593Smuzhiyun  * @mem_res: start/end offsets in the physical system memory to map PCI accesses
273*4882a593Smuzhiyun  * @is_rc: tell whether the PCIe controller mode is Root Complex or Endpoint.
274*4882a593Smuzhiyun  * @bus: In Root Complex mode, the bus number
275*4882a593Smuzhiyun  * @ops: Platform specific ops to control various inputs from Cadence PCIe
276*4882a593Smuzhiyun  *       wrapper
277*4882a593Smuzhiyun  */
278*4882a593Smuzhiyun struct cdns_pcie {
279*4882a593Smuzhiyun 	void __iomem		*reg_base;
280*4882a593Smuzhiyun 	struct resource		*mem_res;
281*4882a593Smuzhiyun 	struct device		*dev;
282*4882a593Smuzhiyun 	bool			is_rc;
283*4882a593Smuzhiyun 	int			phy_count;
284*4882a593Smuzhiyun 	struct phy		**phy;
285*4882a593Smuzhiyun 	struct device_link	**link;
286*4882a593Smuzhiyun 	const struct cdns_pcie_ops *ops;
287*4882a593Smuzhiyun };
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun /**
290*4882a593Smuzhiyun  * struct cdns_pcie_rc - private data for this PCIe Root Complex driver
291*4882a593Smuzhiyun  * @pcie: Cadence PCIe controller
292*4882a593Smuzhiyun  * @dev: pointer to PCIe device
293*4882a593Smuzhiyun  * @cfg_res: start/end offsets in the physical system memory to map PCI
294*4882a593Smuzhiyun  *           configuration space accesses
295*4882a593Smuzhiyun  * @cfg_base: IO mapped window to access the PCI configuration space of a
296*4882a593Smuzhiyun  *            single function at a time
297*4882a593Smuzhiyun  * @vendor_id: PCI vendor ID
298*4882a593Smuzhiyun  * @device_id: PCI device ID
299*4882a593Smuzhiyun  * @avail_ib_bar: Satus of RP_BAR0, RP_BAR1 and	RP_NO_BAR if it's free or
300*4882a593Smuzhiyun  *                available
301*4882a593Smuzhiyun  * @quirk_retrain_flag: Retrain link as quirk for PCIe Gen2
302*4882a593Smuzhiyun  * @quirk_detect_quiet_flag: LTSSM Detect Quiet min delay set as quirk
303*4882a593Smuzhiyun  */
304*4882a593Smuzhiyun struct cdns_pcie_rc {
305*4882a593Smuzhiyun 	struct cdns_pcie	pcie;
306*4882a593Smuzhiyun 	struct resource		*cfg_res;
307*4882a593Smuzhiyun 	void __iomem		*cfg_base;
308*4882a593Smuzhiyun 	u32			vendor_id;
309*4882a593Smuzhiyun 	u32			device_id;
310*4882a593Smuzhiyun 	bool			avail_ib_bar[CDNS_PCIE_RP_MAX_IB];
311*4882a593Smuzhiyun 	unsigned int		quirk_retrain_flag:1;
312*4882a593Smuzhiyun 	unsigned int		quirk_detect_quiet_flag:1;
313*4882a593Smuzhiyun };
314*4882a593Smuzhiyun 
315*4882a593Smuzhiyun /**
316*4882a593Smuzhiyun  * struct cdns_pcie_epf - Structure to hold info about endpoint function
317*4882a593Smuzhiyun  * @epf_bar: reference to the pci_epf_bar for the six Base Address Registers
318*4882a593Smuzhiyun  */
319*4882a593Smuzhiyun struct cdns_pcie_epf {
320*4882a593Smuzhiyun 	struct pci_epf_bar *epf_bar[PCI_STD_NUM_BARS];
321*4882a593Smuzhiyun };
322*4882a593Smuzhiyun 
323*4882a593Smuzhiyun /**
324*4882a593Smuzhiyun  * struct cdns_pcie_ep - private data for this PCIe endpoint controller driver
325*4882a593Smuzhiyun  * @pcie: Cadence PCIe controller
326*4882a593Smuzhiyun  * @max_regions: maximum number of regions supported by hardware
327*4882a593Smuzhiyun  * @ob_region_map: bitmask of mapped outbound regions
328*4882a593Smuzhiyun  * @ob_addr: base addresses in the AXI bus where the outbound regions start
329*4882a593Smuzhiyun  * @irq_phys_addr: base address on the AXI bus where the MSI/legacy IRQ
330*4882a593Smuzhiyun  *		   dedicated outbound regions is mapped.
331*4882a593Smuzhiyun  * @irq_cpu_addr: base address in the CPU space where a write access triggers
332*4882a593Smuzhiyun  *		  the sending of a memory write (MSI) / normal message (legacy
333*4882a593Smuzhiyun  *		  IRQ) TLP through the PCIe bus.
334*4882a593Smuzhiyun  * @irq_pci_addr: used to save the current mapping of the MSI/legacy IRQ
335*4882a593Smuzhiyun  *		  dedicated outbound region.
336*4882a593Smuzhiyun  * @irq_pci_fn: the latest PCI function that has updated the mapping of
337*4882a593Smuzhiyun  *		the MSI/legacy IRQ dedicated outbound region.
338*4882a593Smuzhiyun  * @irq_pending: bitmask of asserted legacy IRQs.
339*4882a593Smuzhiyun  * @lock: spin lock to disable interrupts while modifying PCIe controller
340*4882a593Smuzhiyun  *        registers fields (RMW) accessible by both remote RC and EP to
341*4882a593Smuzhiyun  *        minimize time between read and write
342*4882a593Smuzhiyun  * @epf: Structure to hold info about endpoint function
343*4882a593Smuzhiyun  * @quirk_detect_quiet_flag: LTSSM Detect Quiet min delay set as quirk
344*4882a593Smuzhiyun  */
345*4882a593Smuzhiyun struct cdns_pcie_ep {
346*4882a593Smuzhiyun 	struct cdns_pcie	pcie;
347*4882a593Smuzhiyun 	u32			max_regions;
348*4882a593Smuzhiyun 	unsigned long		ob_region_map;
349*4882a593Smuzhiyun 	phys_addr_t		*ob_addr;
350*4882a593Smuzhiyun 	phys_addr_t		irq_phys_addr;
351*4882a593Smuzhiyun 	void __iomem		*irq_cpu_addr;
352*4882a593Smuzhiyun 	u64			irq_pci_addr;
353*4882a593Smuzhiyun 	u8			irq_pci_fn;
354*4882a593Smuzhiyun 	u8			irq_pending;
355*4882a593Smuzhiyun 	/* protect writing to PCI_STATUS while raising legacy interrupts */
356*4882a593Smuzhiyun 	spinlock_t		lock;
357*4882a593Smuzhiyun 	struct cdns_pcie_epf	*epf;
358*4882a593Smuzhiyun 	unsigned int		quirk_detect_quiet_flag:1;
359*4882a593Smuzhiyun };
360*4882a593Smuzhiyun 
361*4882a593Smuzhiyun 
362*4882a593Smuzhiyun /* Register access */
cdns_pcie_writel(struct cdns_pcie * pcie,u32 reg,u32 value)363*4882a593Smuzhiyun static inline void cdns_pcie_writel(struct cdns_pcie *pcie, u32 reg, u32 value)
364*4882a593Smuzhiyun {
365*4882a593Smuzhiyun 	writel(value, pcie->reg_base + reg);
366*4882a593Smuzhiyun }
367*4882a593Smuzhiyun 
cdns_pcie_readl(struct cdns_pcie * pcie,u32 reg)368*4882a593Smuzhiyun static inline u32 cdns_pcie_readl(struct cdns_pcie *pcie, u32 reg)
369*4882a593Smuzhiyun {
370*4882a593Smuzhiyun 	return readl(pcie->reg_base + reg);
371*4882a593Smuzhiyun }
372*4882a593Smuzhiyun 
cdns_pcie_read_sz(void __iomem * addr,int size)373*4882a593Smuzhiyun static inline u32 cdns_pcie_read_sz(void __iomem *addr, int size)
374*4882a593Smuzhiyun {
375*4882a593Smuzhiyun 	void __iomem *aligned_addr = PTR_ALIGN_DOWN(addr, 0x4);
376*4882a593Smuzhiyun 	unsigned int offset = (unsigned long)addr & 0x3;
377*4882a593Smuzhiyun 	u32 val = readl(aligned_addr);
378*4882a593Smuzhiyun 
379*4882a593Smuzhiyun 	if (!IS_ALIGNED((uintptr_t)addr, size)) {
380*4882a593Smuzhiyun 		pr_warn("Address %p and size %d are not aligned\n", addr, size);
381*4882a593Smuzhiyun 		return 0;
382*4882a593Smuzhiyun 	}
383*4882a593Smuzhiyun 
384*4882a593Smuzhiyun 	if (size > 2)
385*4882a593Smuzhiyun 		return val;
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	return (val >> (8 * offset)) & ((1 << (size * 8)) - 1);
388*4882a593Smuzhiyun }
389*4882a593Smuzhiyun 
cdns_pcie_write_sz(void __iomem * addr,int size,u32 value)390*4882a593Smuzhiyun static inline void cdns_pcie_write_sz(void __iomem *addr, int size, u32 value)
391*4882a593Smuzhiyun {
392*4882a593Smuzhiyun 	void __iomem *aligned_addr = PTR_ALIGN_DOWN(addr, 0x4);
393*4882a593Smuzhiyun 	unsigned int offset = (unsigned long)addr & 0x3;
394*4882a593Smuzhiyun 	u32 mask;
395*4882a593Smuzhiyun 	u32 val;
396*4882a593Smuzhiyun 
397*4882a593Smuzhiyun 	if (!IS_ALIGNED((uintptr_t)addr, size)) {
398*4882a593Smuzhiyun 		pr_warn("Address %p and size %d are not aligned\n", addr, size);
399*4882a593Smuzhiyun 		return;
400*4882a593Smuzhiyun 	}
401*4882a593Smuzhiyun 
402*4882a593Smuzhiyun 	if (size > 2) {
403*4882a593Smuzhiyun 		writel(value, addr);
404*4882a593Smuzhiyun 		return;
405*4882a593Smuzhiyun 	}
406*4882a593Smuzhiyun 
407*4882a593Smuzhiyun 	mask = ~(((1 << (size * 8)) - 1) << (offset * 8));
408*4882a593Smuzhiyun 	val = readl(aligned_addr) & mask;
409*4882a593Smuzhiyun 	val |= value << (offset * 8);
410*4882a593Smuzhiyun 	writel(val, aligned_addr);
411*4882a593Smuzhiyun }
412*4882a593Smuzhiyun 
413*4882a593Smuzhiyun /* Root Port register access */
cdns_pcie_rp_writeb(struct cdns_pcie * pcie,u32 reg,u8 value)414*4882a593Smuzhiyun static inline void cdns_pcie_rp_writeb(struct cdns_pcie *pcie,
415*4882a593Smuzhiyun 				       u32 reg, u8 value)
416*4882a593Smuzhiyun {
417*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_RP_BASE + reg;
418*4882a593Smuzhiyun 
419*4882a593Smuzhiyun 	cdns_pcie_write_sz(addr, 0x1, value);
420*4882a593Smuzhiyun }
421*4882a593Smuzhiyun 
cdns_pcie_rp_writew(struct cdns_pcie * pcie,u32 reg,u16 value)422*4882a593Smuzhiyun static inline void cdns_pcie_rp_writew(struct cdns_pcie *pcie,
423*4882a593Smuzhiyun 				       u32 reg, u16 value)
424*4882a593Smuzhiyun {
425*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_RP_BASE + reg;
426*4882a593Smuzhiyun 
427*4882a593Smuzhiyun 	cdns_pcie_write_sz(addr, 0x2, value);
428*4882a593Smuzhiyun }
429*4882a593Smuzhiyun 
cdns_pcie_rp_readw(struct cdns_pcie * pcie,u32 reg)430*4882a593Smuzhiyun static inline u16 cdns_pcie_rp_readw(struct cdns_pcie *pcie, u32 reg)
431*4882a593Smuzhiyun {
432*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_RP_BASE + reg;
433*4882a593Smuzhiyun 
434*4882a593Smuzhiyun 	return cdns_pcie_read_sz(addr, 0x2);
435*4882a593Smuzhiyun }
436*4882a593Smuzhiyun 
437*4882a593Smuzhiyun /* Endpoint Function register access */
cdns_pcie_ep_fn_writeb(struct cdns_pcie * pcie,u8 fn,u32 reg,u8 value)438*4882a593Smuzhiyun static inline void cdns_pcie_ep_fn_writeb(struct cdns_pcie *pcie, u8 fn,
439*4882a593Smuzhiyun 					  u32 reg, u8 value)
440*4882a593Smuzhiyun {
441*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_EP_FUNC_BASE(fn) + reg;
442*4882a593Smuzhiyun 
443*4882a593Smuzhiyun 	cdns_pcie_write_sz(addr, 0x1, value);
444*4882a593Smuzhiyun }
445*4882a593Smuzhiyun 
cdns_pcie_ep_fn_writew(struct cdns_pcie * pcie,u8 fn,u32 reg,u16 value)446*4882a593Smuzhiyun static inline void cdns_pcie_ep_fn_writew(struct cdns_pcie *pcie, u8 fn,
447*4882a593Smuzhiyun 					  u32 reg, u16 value)
448*4882a593Smuzhiyun {
449*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_EP_FUNC_BASE(fn) + reg;
450*4882a593Smuzhiyun 
451*4882a593Smuzhiyun 	cdns_pcie_write_sz(addr, 0x2, value);
452*4882a593Smuzhiyun }
453*4882a593Smuzhiyun 
cdns_pcie_ep_fn_writel(struct cdns_pcie * pcie,u8 fn,u32 reg,u32 value)454*4882a593Smuzhiyun static inline void cdns_pcie_ep_fn_writel(struct cdns_pcie *pcie, u8 fn,
455*4882a593Smuzhiyun 					  u32 reg, u32 value)
456*4882a593Smuzhiyun {
457*4882a593Smuzhiyun 	writel(value, pcie->reg_base + CDNS_PCIE_EP_FUNC_BASE(fn) + reg);
458*4882a593Smuzhiyun }
459*4882a593Smuzhiyun 
cdns_pcie_ep_fn_readw(struct cdns_pcie * pcie,u8 fn,u32 reg)460*4882a593Smuzhiyun static inline u16 cdns_pcie_ep_fn_readw(struct cdns_pcie *pcie, u8 fn, u32 reg)
461*4882a593Smuzhiyun {
462*4882a593Smuzhiyun 	void __iomem *addr = pcie->reg_base + CDNS_PCIE_EP_FUNC_BASE(fn) + reg;
463*4882a593Smuzhiyun 
464*4882a593Smuzhiyun 	return cdns_pcie_read_sz(addr, 0x2);
465*4882a593Smuzhiyun }
466*4882a593Smuzhiyun 
cdns_pcie_ep_fn_readl(struct cdns_pcie * pcie,u8 fn,u32 reg)467*4882a593Smuzhiyun static inline u32 cdns_pcie_ep_fn_readl(struct cdns_pcie *pcie, u8 fn, u32 reg)
468*4882a593Smuzhiyun {
469*4882a593Smuzhiyun 	return readl(pcie->reg_base + CDNS_PCIE_EP_FUNC_BASE(fn) + reg);
470*4882a593Smuzhiyun }
471*4882a593Smuzhiyun 
cdns_pcie_start_link(struct cdns_pcie * pcie)472*4882a593Smuzhiyun static inline int cdns_pcie_start_link(struct cdns_pcie *pcie)
473*4882a593Smuzhiyun {
474*4882a593Smuzhiyun 	if (pcie->ops->start_link)
475*4882a593Smuzhiyun 		return pcie->ops->start_link(pcie);
476*4882a593Smuzhiyun 
477*4882a593Smuzhiyun 	return 0;
478*4882a593Smuzhiyun }
479*4882a593Smuzhiyun 
cdns_pcie_stop_link(struct cdns_pcie * pcie)480*4882a593Smuzhiyun static inline void cdns_pcie_stop_link(struct cdns_pcie *pcie)
481*4882a593Smuzhiyun {
482*4882a593Smuzhiyun 	if (pcie->ops->stop_link)
483*4882a593Smuzhiyun 		pcie->ops->stop_link(pcie);
484*4882a593Smuzhiyun }
485*4882a593Smuzhiyun 
cdns_pcie_link_up(struct cdns_pcie * pcie)486*4882a593Smuzhiyun static inline bool cdns_pcie_link_up(struct cdns_pcie *pcie)
487*4882a593Smuzhiyun {
488*4882a593Smuzhiyun 	if (pcie->ops->link_up)
489*4882a593Smuzhiyun 		return pcie->ops->link_up(pcie);
490*4882a593Smuzhiyun 
491*4882a593Smuzhiyun 	return true;
492*4882a593Smuzhiyun }
493*4882a593Smuzhiyun 
494*4882a593Smuzhiyun #ifdef CONFIG_PCIE_CADENCE_HOST
495*4882a593Smuzhiyun int cdns_pcie_host_setup(struct cdns_pcie_rc *rc);
496*4882a593Smuzhiyun void __iomem *cdns_pci_map_bus(struct pci_bus *bus, unsigned int devfn,
497*4882a593Smuzhiyun 			       int where);
498*4882a593Smuzhiyun #else
cdns_pcie_host_setup(struct cdns_pcie_rc * rc)499*4882a593Smuzhiyun static inline int cdns_pcie_host_setup(struct cdns_pcie_rc *rc)
500*4882a593Smuzhiyun {
501*4882a593Smuzhiyun 	return 0;
502*4882a593Smuzhiyun }
503*4882a593Smuzhiyun 
cdns_pci_map_bus(struct pci_bus * bus,unsigned int devfn,int where)504*4882a593Smuzhiyun static inline void __iomem *cdns_pci_map_bus(struct pci_bus *bus, unsigned int devfn,
505*4882a593Smuzhiyun 					     int where)
506*4882a593Smuzhiyun {
507*4882a593Smuzhiyun 	return NULL;
508*4882a593Smuzhiyun }
509*4882a593Smuzhiyun #endif
510*4882a593Smuzhiyun 
511*4882a593Smuzhiyun #ifdef CONFIG_PCIE_CADENCE_EP
512*4882a593Smuzhiyun int cdns_pcie_ep_setup(struct cdns_pcie_ep *ep);
513*4882a593Smuzhiyun #else
cdns_pcie_ep_setup(struct cdns_pcie_ep * ep)514*4882a593Smuzhiyun static inline int cdns_pcie_ep_setup(struct cdns_pcie_ep *ep)
515*4882a593Smuzhiyun {
516*4882a593Smuzhiyun 	return 0;
517*4882a593Smuzhiyun }
518*4882a593Smuzhiyun #endif
519*4882a593Smuzhiyun 
520*4882a593Smuzhiyun void cdns_pcie_detect_quiet_min_delay_set(struct cdns_pcie *pcie);
521*4882a593Smuzhiyun 
522*4882a593Smuzhiyun void cdns_pcie_set_outbound_region(struct cdns_pcie *pcie, u8 busnr, u8 fn,
523*4882a593Smuzhiyun 				   u32 r, bool is_io,
524*4882a593Smuzhiyun 				   u64 cpu_addr, u64 pci_addr, size_t size);
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun void cdns_pcie_set_outbound_region_for_normal_msg(struct cdns_pcie *pcie,
527*4882a593Smuzhiyun 						  u8 busnr, u8 fn,
528*4882a593Smuzhiyun 						  u32 r, u64 cpu_addr);
529*4882a593Smuzhiyun 
530*4882a593Smuzhiyun void cdns_pcie_reset_outbound_region(struct cdns_pcie *pcie, u32 r);
531*4882a593Smuzhiyun void cdns_pcie_disable_phy(struct cdns_pcie *pcie);
532*4882a593Smuzhiyun int cdns_pcie_enable_phy(struct cdns_pcie *pcie);
533*4882a593Smuzhiyun int cdns_pcie_init_phy(struct device *dev, struct cdns_pcie *pcie);
534*4882a593Smuzhiyun extern const struct dev_pm_ops cdns_pcie_pm_ops;
535*4882a593Smuzhiyun 
536*4882a593Smuzhiyun #endif /* _PCIE_CADENCE_H */
537