xref: /freebsd/sys/dev/ntb/ntb_hw/ntb_hw_intel.h (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
1 /*-
2  * Copyright (c) 2016 Alexander Motin <mav@FreeBSD.org>
3  * Copyright (C) 2013 Intel Corporation
4  * Copyright (C) 2015 EMC Corporation
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _NTB_REGS_H_
30 #define _NTB_REGS_H_
31 #include <sys/types.h>
32 #include <sys/stdint.h>
33 
34 /*---------------------------------------------------------------------------
35  *   Macro: M*_M : Create a mask to isolate a bit field of a data word.
36  *          M*_F : Extract value from a bit field of a data word.
37  *          M*_I : Insert value into a bit field of a data word.
38  *
39  * Purpose: Bit field manipulation macros for mask, insert and extract for
40  *          8-bit, 16-bit, 32-bit and 64-bit data words.
41  *
42  *  Params: [in] P = Bit position of start of the bit field (lsb is 0).
43  *          [in] N = Size of the bit field in bits.
44  *          [in] X = Value to insert or remove from the bit field.
45  *---------------------------------------------------------------------------
46  */
47 #define M8_M(P, N)      ((UINT8_MAX >> (8 - (N))) << (P))
48 #define M8_F(X, P, N)   (((uint8_t)(X) & M8_M(P, N)) >> (P))
49 #define M8_I(X, P, N)   (((uint8_t)(X) << (P)) & M8_M(P, N))
50 
51 #define NTB_LINK_STATUS_ACTIVE	0x2000
52 #define NTB_LINK_SPEED_MASK	0x000f
53 #define NTB_LINK_WIDTH_MASK	0x03f0
54 #define NTB_LNK_STA_WIDTH(sta)	(((sta) & NTB_LINK_WIDTH_MASK) >> 4)
55 
56 #define XEON_SNB_MW_COUNT	2
57 #define XEON_HSX_SPLIT_MW_COUNT	3
58 /* Reserve the uppermost bit for link interrupt */
59 #define XEON_DB_COUNT		15
60 #define XEON_DB_TOTAL_SHIFT	16
61 #define XEON_DB_LINK		15
62 #define XEON_DB_MSIX_VECTOR_COUNT	4
63 #define XEON_DB_MSIX_VECTOR_SHIFT	5
64 #define XEON_DB_LINK_BIT	(1 << XEON_DB_LINK)
65 #define XEON_NONLINK_DB_MSIX_BITS	3
66 
67 #define XEON_SPCICMD_OFFSET	0x0504
68 #define XEON_DEVCTRL_OFFSET	0x0598
69 #define XEON_DEVSTS_OFFSET	0x059a
70 #define XEON_LINK_STATUS_OFFSET	0x01a2
71 #define XEON_SLINK_STATUS_OFFSET	0x05a2
72 
73 #define XEON_PBAR2LMT_OFFSET	0x0000
74 #define XEON_PBAR4LMT_OFFSET	0x0008
75 #define XEON_PBAR5LMT_OFFSET	0x000c
76 #define XEON_PBAR2XLAT_OFFSET	0x0010
77 #define XEON_PBAR4XLAT_OFFSET	0x0018
78 #define XEON_PBAR5XLAT_OFFSET	0x001c
79 #define XEON_SBAR2LMT_OFFSET	0x0020
80 #define XEON_SBAR4LMT_OFFSET	0x0028
81 #define XEON_SBAR5LMT_OFFSET	0x002c
82 #define XEON_SBAR2XLAT_OFFSET	0x0030
83 #define XEON_SBAR4XLAT_OFFSET	0x0038
84 #define XEON_SBAR5XLAT_OFFSET	0x003c
85 #define XEON_SBAR0BASE_OFFSET	0x0040
86 #define XEON_SBAR2BASE_OFFSET	0x0048
87 #define XEON_SBAR4BASE_OFFSET	0x0050
88 #define XEON_SBAR5BASE_OFFSET	0x0054
89 #define XEON_NTBCNTL_OFFSET	0x0058
90 #define XEON_SBDF_OFFSET	0x005c
91 #define XEON_PDOORBELL_OFFSET	0x0060
92 #define XEON_PDBMSK_OFFSET	0x0062
93 #define XEON_SDOORBELL_OFFSET	0x0064
94 #define XEON_SDBMSK_OFFSET	0x0066
95 #define XEON_USMEMMISS_OFFSET	0x0070
96 #define XEON_SPAD_OFFSET	0x0080
97 #define XEON_SPAD_COUNT		16
98 #define XEON_SPADSEMA4_OFFSET	0x00c0
99 #define XEON_WCCNTRL_OFFSET	0x00e0
100 #define XEON_UNCERRSTS_OFFSET	0x014c
101 #define XEON_CORERRSTS_OFFSET	0x0158
102 #define XEON_B2B_SPAD_OFFSET	0x0100
103 #define XEON_B2B_DOORBELL_OFFSET	0x0140
104 #define XEON_B2B_XLAT_OFFSETL	0x0144
105 #define XEON_B2B_XLAT_OFFSETU	0x0148
106 
107 #define ATOM_MW_COUNT		2
108 #define ATOM_DB_COUNT		34
109 #define ATOM_DB_MSIX_VECTOR_COUNT	34
110 #define ATOM_DB_MSIX_VECTOR_SHIFT	1
111 
112 #define ATOM_SPCICMD_OFFSET	0xb004
113 #define ATOM_MBAR23_OFFSET	0xb018
114 #define ATOM_MBAR45_OFFSET	0xb020
115 #define ATOM_DEVCTRL_OFFSET	0xb048
116 #define ATOM_LINK_STATUS_OFFSET	0xb052
117 #define ATOM_ERRCORSTS_OFFSET	0xb110
118 
119 #define ATOM_SBAR2XLAT_OFFSET	0x0008
120 #define ATOM_SBAR4XLAT_OFFSET	0x0010
121 #define ATOM_PDOORBELL_OFFSET	0x0020
122 #define ATOM_PDBMSK_OFFSET	0x0028
123 #define ATOM_NTBCNTL_OFFSET	0x0060
124 #define ATOM_EBDF_OFFSET		0x0064
125 #define ATOM_SPAD_OFFSET		0x0080
126 #define ATOM_SPAD_COUNT		16
127 #define ATOM_SPADSEMA_OFFSET	0x00c0
128 #define ATOM_STKYSPAD_OFFSET	0x00c4
129 #define ATOM_PBAR2XLAT_OFFSET	0x8008
130 #define ATOM_PBAR4XLAT_OFFSET	0x8010
131 #define ATOM_B2B_DOORBELL_OFFSET	0x8020
132 #define ATOM_B2B_SPAD_OFFSET	0x8080
133 #define ATOM_B2B_SPADSEMA_OFFSET	0x80c0
134 #define ATOM_B2B_STKYSPAD_OFFSET	0x80c4
135 
136 #define ATOM_MODPHY_PCSREG4	0x1c004
137 #define ATOM_MODPHY_PCSREG6	0x1c006
138 
139 #define ATOM_IP_BASE		0xc000
140 #define ATOM_DESKEWSTS_OFFSET	(ATOM_IP_BASE + 0x3024)
141 #define	ATOM_LTSSMERRSTS0_OFFSET (ATOM_IP_BASE + 0x3180)
142 #define ATOM_LTSSMSTATEJMP_OFFSET	(ATOM_IP_BASE + 0x3040)
143 #define ATOM_IBSTERRRCRVSTS0_OFFSET	(ATOM_IP_BASE + 0x3324)
144 
145 #define ATOM_DESKEWSTS_DBERR		(1 << 15)
146 #define ATOM_LTSSMERRSTS0_UNEXPECTEDEI	(1 << 20)
147 #define ATOM_LTSSMSTATEJMP_FORCEDETECT	(1 << 2)
148 #define ATOM_IBIST_ERR_OFLOW		0x7fff7fff
149 
150 #define NTB_CNTL_CFG_LOCK		(1 << 0)
151 #define NTB_CNTL_LINK_DISABLE		(1 << 1)
152 #define NTB_CNTL_S2P_BAR23_SNOOP	(1 << 2)
153 #define NTB_CNTL_P2S_BAR23_SNOOP	(1 << 4)
154 #define NTB_CNTL_S2P_BAR4_SNOOP		(1 << 6)
155 #define NTB_CNTL_P2S_BAR4_SNOOP		(1 << 8)
156 #define NTB_CNTL_S2P_BAR5_SNOOP		(1 << 12)
157 #define NTB_CNTL_P2S_BAR5_SNOOP		(1 << 14)
158 #define ATOM_CNTL_LINK_DOWN		(1 << 16)
159 
160 #define XEON_PBAR23SZ_OFFSET	0x00d0
161 #define XEON_PBAR45SZ_OFFSET	0x00d1
162 #define XEON_PBAR4SZ_OFFSET	0x00d1
163 #define XEON_PBAR5SZ_OFFSET	0x00d5
164 #define XEON_SBAR23SZ_OFFSET	0x00d2
165 #define XEON_SBAR4SZ_OFFSET	0x00d3
166 #define XEON_SBAR5SZ_OFFSET	0x00d6
167 #define NTB_PPD_OFFSET		0x00d4
168 #define XEON_PPD_CONN_TYPE	0x0003
169 #define XEON_PPD_DEV_TYPE	0x0010
170 #define XEON_PPD_SPLIT_BAR	0x0040
171 #define ATOM_PPD_INIT_LINK	0x0008
172 #define ATOM_PPD_CONN_TYPE	0x0300
173 #define ATOM_PPD_DEV_TYPE	0x1000
174 
175 /* All addresses are in low 32-bit space so 32-bit BARs can function */
176 #define XEON_B2B_BAR0_ADDR	0x1000000000000000ull
177 #define XEON_B2B_BAR2_ADDR64	0x2000000000000000ull
178 #define XEON_B2B_BAR4_ADDR64	0x4000000000000000ull
179 #define XEON_B2B_BAR4_ADDR32	0x20000000ull
180 #define XEON_B2B_BAR5_ADDR32	0x40000000ull
181 
182 /* The peer ntb secondary config space is 32KB fixed size */
183 #define XEON_B2B_MIN_SIZE		0x8000
184 #define XEON_GEN3_MW_COUNT		2
185 #define XEON_GEN3_SPLIT_MW_COUNT	3
186 #define XEON_GEN3_SPAD_COUNT		16
187 #define XEON_GEN3_DB_COUNT		32
188 #define XEON_GEN3_DB_LINK		32
189 #define XEON_GEN3_DB_LINK_BIT		(1ULL << XEON_GEN3_DB_LINK)
190 #define XEON_GEN3_DB_MSIX_VECTOR_COUNT	33
191 #define XEON_GEN3_DB_MSIX_VECTOR_SHIFT	1
192 
193 #define XEON_GEN3_LINK_VECTOR_INDEX	31
194 
195 /* Xeon Skylake NTB register definitions */
196 
197 /*
198  * Internal EndPoint Configuration Registers
199  */
200 #define XEON_GEN3_INT_REG_BAR0BASE	0x10
201 #define XEON_GEN3_INT_REG_BAR1BASE	0x18
202 #define XEON_GEN3_INT_REG_BAR2BASE	0x20
203 #define XEON_GEN3_INT_REG_IMBAR1SZ	0xd0
204 #define XEON_GEN3_INT_REG_IMBAR2SZ	0xd1
205 #define XEON_GEN3_INT_REG_EMBAR1SZ	0xd2
206 #define XEON_GEN3_INT_REG_EMBAR2SZ	0xd3
207 #define XEON_GEN3_INT_REG_PPD		0xd4
208 #define XEON_GEN3_INT_LNK_STS_OFFSET	0x01a2
209 
210 /*
211  * External EndPoint Configuration Registers
212  * These are located within BAR0 of the internal endpoint.
213  */
214 #define XEON_GEN3_EXT_REG_PCI_CMD	0x4504
215 #define XEON_GEN3_EXT_REG_BAR0BASE	0x4510
216 #define XEON_GEN3_EXT_REG_BAR1BASE	0x4518
217 #define XEON_GEN3_EXT_REG_BAR2BASE	0x4520
218 
219 /*
220  * Internal Endpoint Memory Mapped Registers
221  */
222 #define XEON_GEN3_REG_IMNTB_CTRL	0x0000
223 #define XEON_GEN3_REG_IMBAR1XBASE	0x0010
224 #define XEON_GEN3_REG_IMBAR1XLIMIT	0x0018
225 #define XEON_GEN3_REG_IMBAR2XBASE	0x0020
226 #define XEON_GEN3_REG_IMBAR2XLIMIT	0x0028
227 #define XEON_GEN3_REG_IMINT_STATUS	0x0040
228 #define XEON_GEN3_REG_IMINT_DISABLE	0x0048
229 #define XEON_GEN3_REG_IMSPAD		0x0080
230 #define XEON_GEN3_REG_IMINTVEC00	0x00d0
231 #define XEON_GEN3_REG_IMDOORBELL	0x0100
232 #define XEON_GEN3_REG_IMB2B_SSPAD	0x0180	/* Pseudo SP registers */
233 
234 /*
235  * External Endpoint Memory Mapped Registers
236  */
237 #define XEON_GEN3_REG_EMBAR0XBASE	0x4008
238 #define XEON_GEN3_REG_EMBAR1XBASE	0x4010
239 #define XEON_GEN3_REG_EMBAR1XLIMIT	0x4018
240 #define XEON_GEN3_REG_EMBAR2XBASE	0x4020
241 #define XEON_GEN3_REG_EMBAR2XLIMIT	0x4028
242 #define XEON_GEN3_REG_EMINT_STATUS	0x4040
243 #define XEON_GEN3_REG_EMINT_DISABLE	0x4048
244 #define XEON_GEN3_REG_EMSPAD		0x4080
245 #define XEON_GEN3_REG_EMDOORBELL	0x4100
246 
247 /* XEON_GEN3_INT_REG_PPD: PPD register */
248 #define XEON_GEN3_REG_PPD_PORT_DEF_F(X)		M8_F(X, 0, 2)
249 #define XEON_GEN3_REG_PPD_CONF_STS_F(X)		M8_F(X, 4, 1)
250 #define XEON_GEN3_REG_PPD_ONE_MSIX_F(X)		M8_F(X, 5, 1)
251 #define XEON_GEN3_REG_PPD_BAR45_SPL_F(X)	M8_F(X, 6, 1)
252 
253 #endif /* _NTB_REGS_H_ */
254