xref: /linux/drivers/misc/cxl/cxl.h (revision b24413180f5600bcb3bb70fbed5cf186b60864bd)
1 /*
2  * Copyright 2014 IBM Corp.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version
7  * 2 of the License, or (at your option) any later version.
8  */
9 
10 #ifndef _CXL_H_
11 #define _CXL_H_
12 
13 #include <linux/interrupt.h>
14 #include <linux/semaphore.h>
15 #include <linux/device.h>
16 #include <linux/types.h>
17 #include <linux/cdev.h>
18 #include <linux/pid.h>
19 #include <linux/io.h>
20 #include <linux/pci.h>
21 #include <linux/fs.h>
22 #include <asm/cputable.h>
23 #include <asm/mmu.h>
24 #include <asm/reg.h>
25 #include <misc/cxl-base.h>
26 
27 #include <misc/cxl.h>
28 #include <uapi/misc/cxl.h>
29 
30 extern uint cxl_verbose;
31 
32 #define CXL_TIMEOUT 5
33 
34 /*
35  * Bump version each time a user API change is made, whether it is
36  * backwards compatible ot not.
37  */
38 #define CXL_API_VERSION 3
39 #define CXL_API_VERSION_COMPATIBLE 1
40 
41 /*
42  * Opaque types to avoid accidentally passing registers for the wrong MMIO
43  *
44  * At the end of the day, I'm not married to using typedef here, but it might
45  * (and has!) help avoid bugs like mixing up CXL_PSL_CtxTime and
46  * CXL_PSL_CtxTime_An, or calling cxl_p1n_write instead of cxl_p1_write.
47  *
48  * I'm quite happy if these are changed back to #defines before upstreaming, it
49  * should be little more than a regexp search+replace operation in this file.
50  */
51 typedef struct {
52 	const int x;
53 } cxl_p1_reg_t;
54 typedef struct {
55 	const int x;
56 } cxl_p1n_reg_t;
57 typedef struct {
58 	const int x;
59 } cxl_p2n_reg_t;
60 #define cxl_reg_off(reg) \
61 	(reg.x)
62 
63 /* Memory maps. Ref CXL Appendix A */
64 
65 /* PSL Privilege 1 Memory Map */
66 /* Configuration and Control area - CAIA 1&2 */
67 static const cxl_p1_reg_t CXL_PSL_CtxTime = {0x0000};
68 static const cxl_p1_reg_t CXL_PSL_ErrIVTE = {0x0008};
69 static const cxl_p1_reg_t CXL_PSL_KEY1    = {0x0010};
70 static const cxl_p1_reg_t CXL_PSL_KEY2    = {0x0018};
71 static const cxl_p1_reg_t CXL_PSL_Control = {0x0020};
72 /* Downloading */
73 static const cxl_p1_reg_t CXL_PSL_DLCNTL  = {0x0060};
74 static const cxl_p1_reg_t CXL_PSL_DLADDR  = {0x0068};
75 
76 /* PSL Lookaside Buffer Management Area - CAIA 1 */
77 static const cxl_p1_reg_t CXL_PSL_LBISEL  = {0x0080};
78 static const cxl_p1_reg_t CXL_PSL_SLBIE   = {0x0088};
79 static const cxl_p1_reg_t CXL_PSL_SLBIA   = {0x0090};
80 static const cxl_p1_reg_t CXL_PSL_TLBIE   = {0x00A0};
81 static const cxl_p1_reg_t CXL_PSL_TLBIA   = {0x00A8};
82 static const cxl_p1_reg_t CXL_PSL_AFUSEL  = {0x00B0};
83 
84 /* 0x00C0:7EFF Implementation dependent area */
85 /* PSL registers - CAIA 1 */
86 static const cxl_p1_reg_t CXL_PSL_FIR1      = {0x0100};
87 static const cxl_p1_reg_t CXL_PSL_FIR2      = {0x0108};
88 static const cxl_p1_reg_t CXL_PSL_Timebase  = {0x0110};
89 static const cxl_p1_reg_t CXL_PSL_VERSION   = {0x0118};
90 static const cxl_p1_reg_t CXL_PSL_RESLCKTO  = {0x0128};
91 static const cxl_p1_reg_t CXL_PSL_TB_CTLSTAT = {0x0140};
92 static const cxl_p1_reg_t CXL_PSL_FIR_CNTL  = {0x0148};
93 static const cxl_p1_reg_t CXL_PSL_DSNDCTL   = {0x0150};
94 static const cxl_p1_reg_t CXL_PSL_SNWRALLOC = {0x0158};
95 static const cxl_p1_reg_t CXL_PSL_TRACE     = {0x0170};
96 /* XSL registers (Mellanox CX4) */
97 static const cxl_p1_reg_t CXL_XSL_Timebase  = {0x0100};
98 static const cxl_p1_reg_t CXL_XSL_TB_CTLSTAT = {0x0108};
99 static const cxl_p1_reg_t CXL_XSL_FEC       = {0x0158};
100 static const cxl_p1_reg_t CXL_XSL_DSNCTL    = {0x0168};
101 /* PSL registers - CAIA 2 */
102 static const cxl_p1_reg_t CXL_PSL9_CONTROL  = {0x0020};
103 static const cxl_p1_reg_t CXL_XSL9_DSNCTL   = {0x0168};
104 static const cxl_p1_reg_t CXL_PSL9_FIR1     = {0x0300};
105 static const cxl_p1_reg_t CXL_PSL9_FIR2     = {0x0308};
106 static const cxl_p1_reg_t CXL_PSL9_Timebase = {0x0310};
107 static const cxl_p1_reg_t CXL_PSL9_DEBUG    = {0x0320};
108 static const cxl_p1_reg_t CXL_PSL9_FIR_CNTL = {0x0348};
109 static const cxl_p1_reg_t CXL_PSL9_DSNDCTL  = {0x0350};
110 static const cxl_p1_reg_t CXL_PSL9_TB_CTLSTAT = {0x0340};
111 static const cxl_p1_reg_t CXL_PSL9_TRACECFG = {0x0368};
112 static const cxl_p1_reg_t CXL_PSL9_APCDEDALLOC = {0x0378};
113 static const cxl_p1_reg_t CXL_PSL9_APCDEDTYPE = {0x0380};
114 static const cxl_p1_reg_t CXL_PSL9_TNR_ADDR = {0x0388};
115 static const cxl_p1_reg_t CXL_PSL9_GP_CT = {0x0398};
116 static const cxl_p1_reg_t CXL_XSL9_IERAT = {0x0588};
117 static const cxl_p1_reg_t CXL_XSL9_ILPP  = {0x0590};
118 
119 /* 0x7F00:7FFF Reserved PCIe MSI-X Pending Bit Array area */
120 /* 0x8000:FFFF Reserved PCIe MSI-X Table Area */
121 
122 /* PSL Slice Privilege 1 Memory Map */
123 /* Configuration Area - CAIA 1&2 */
124 static const cxl_p1n_reg_t CXL_PSL_SR_An          = {0x00};
125 static const cxl_p1n_reg_t CXL_PSL_LPID_An        = {0x08};
126 static const cxl_p1n_reg_t CXL_PSL_AMBAR_An       = {0x10};
127 static const cxl_p1n_reg_t CXL_PSL_SPOffset_An    = {0x18};
128 static const cxl_p1n_reg_t CXL_PSL_ID_An          = {0x20};
129 static const cxl_p1n_reg_t CXL_PSL_SERR_An        = {0x28};
130 /* Memory Management and Lookaside Buffer Management - CAIA 1*/
131 static const cxl_p1n_reg_t CXL_PSL_SDR_An         = {0x30};
132 /* Memory Management and Lookaside Buffer Management - CAIA 1&2 */
133 static const cxl_p1n_reg_t CXL_PSL_AMOR_An        = {0x38};
134 /* Pointer Area - CAIA 1&2 */
135 static const cxl_p1n_reg_t CXL_HAURP_An           = {0x80};
136 static const cxl_p1n_reg_t CXL_PSL_SPAP_An        = {0x88};
137 static const cxl_p1n_reg_t CXL_PSL_LLCMD_An       = {0x90};
138 /* Control Area - CAIA 1&2 */
139 static const cxl_p1n_reg_t CXL_PSL_SCNTL_An       = {0xA0};
140 static const cxl_p1n_reg_t CXL_PSL_CtxTime_An     = {0xA8};
141 static const cxl_p1n_reg_t CXL_PSL_IVTE_Offset_An = {0xB0};
142 static const cxl_p1n_reg_t CXL_PSL_IVTE_Limit_An  = {0xB8};
143 /* 0xC0:FF Implementation Dependent Area - CAIA 1&2 */
144 static const cxl_p1n_reg_t CXL_PSL_FIR_SLICE_An   = {0xC0};
145 static const cxl_p1n_reg_t CXL_AFU_DEBUG_An       = {0xC8};
146 /* 0xC0:FF Implementation Dependent Area - CAIA 1 */
147 static const cxl_p1n_reg_t CXL_PSL_APCALLOC_A     = {0xD0};
148 static const cxl_p1n_reg_t CXL_PSL_COALLOC_A      = {0xD8};
149 static const cxl_p1n_reg_t CXL_PSL_RXCTL_A        = {0xE0};
150 static const cxl_p1n_reg_t CXL_PSL_SLICE_TRACE    = {0xE8};
151 
152 /* PSL Slice Privilege 2 Memory Map */
153 /* Configuration and Control Area - CAIA 1&2 */
154 static const cxl_p2n_reg_t CXL_PSL_PID_TID_An = {0x000};
155 static const cxl_p2n_reg_t CXL_CSRP_An        = {0x008};
156 /* Configuration and Control Area - CAIA 1 */
157 static const cxl_p2n_reg_t CXL_AURP0_An       = {0x010};
158 static const cxl_p2n_reg_t CXL_AURP1_An       = {0x018};
159 static const cxl_p2n_reg_t CXL_SSTP0_An       = {0x020};
160 static const cxl_p2n_reg_t CXL_SSTP1_An       = {0x028};
161 /* Configuration and Control Area - CAIA 1 */
162 static const cxl_p2n_reg_t CXL_PSL_AMR_An     = {0x030};
163 /* Segment Lookaside Buffer Management - CAIA 1 */
164 static const cxl_p2n_reg_t CXL_SLBIE_An       = {0x040};
165 static const cxl_p2n_reg_t CXL_SLBIA_An       = {0x048};
166 static const cxl_p2n_reg_t CXL_SLBI_Select_An = {0x050};
167 /* Interrupt Registers - CAIA 1&2 */
168 static const cxl_p2n_reg_t CXL_PSL_DSISR_An   = {0x060};
169 static const cxl_p2n_reg_t CXL_PSL_DAR_An     = {0x068};
170 static const cxl_p2n_reg_t CXL_PSL_DSR_An     = {0x070};
171 static const cxl_p2n_reg_t CXL_PSL_TFC_An     = {0x078};
172 static const cxl_p2n_reg_t CXL_PSL_PEHandle_An = {0x080};
173 static const cxl_p2n_reg_t CXL_PSL_ErrStat_An = {0x088};
174 /* AFU Registers - CAIA 1&2 */
175 static const cxl_p2n_reg_t CXL_AFU_Cntl_An    = {0x090};
176 static const cxl_p2n_reg_t CXL_AFU_ERR_An     = {0x098};
177 /* Work Element Descriptor - CAIA 1&2 */
178 static const cxl_p2n_reg_t CXL_PSL_WED_An     = {0x0A0};
179 /* 0x0C0:FFF Implementation Dependent Area */
180 
181 #define CXL_PSL_SPAP_Addr 0x0ffffffffffff000ULL
182 #define CXL_PSL_SPAP_Size 0x0000000000000ff0ULL
183 #define CXL_PSL_SPAP_Size_Shift 4
184 #define CXL_PSL_SPAP_V    0x0000000000000001ULL
185 
186 /****** CXL_PSL_Control ****************************************************/
187 #define CXL_PSL_Control_tb              (0x1ull << (63-63))
188 #define CXL_PSL_Control_Fr              (0x1ull << (63-31))
189 #define CXL_PSL_Control_Fs_MASK         (0x3ull << (63-29))
190 #define CXL_PSL_Control_Fs_Complete     (0x3ull << (63-29))
191 
192 /****** CXL_PSL_DLCNTL *****************************************************/
193 #define CXL_PSL_DLCNTL_D (0x1ull << (63-28))
194 #define CXL_PSL_DLCNTL_C (0x1ull << (63-29))
195 #define CXL_PSL_DLCNTL_E (0x1ull << (63-30))
196 #define CXL_PSL_DLCNTL_S (0x1ull << (63-31))
197 #define CXL_PSL_DLCNTL_CE (CXL_PSL_DLCNTL_C | CXL_PSL_DLCNTL_E)
198 #define CXL_PSL_DLCNTL_DCES (CXL_PSL_DLCNTL_D | CXL_PSL_DLCNTL_CE | CXL_PSL_DLCNTL_S)
199 
200 /****** CXL_PSL_SR_An ******************************************************/
201 #define CXL_PSL_SR_An_SF  MSR_SF            /* 64bit */
202 #define CXL_PSL_SR_An_TA  (1ull << (63-1))  /* Tags active,   GA1: 0 */
203 #define CXL_PSL_SR_An_HV  MSR_HV            /* Hypervisor,    GA1: 0 */
204 #define CXL_PSL_SR_An_XLAT_hpt (0ull << (63-6))/* Hashed page table (HPT) mode */
205 #define CXL_PSL_SR_An_XLAT_roh (2ull << (63-6))/* Radix on HPT mode */
206 #define CXL_PSL_SR_An_XLAT_ror (3ull << (63-6))/* Radix on Radix mode */
207 #define CXL_PSL_SR_An_BOT (1ull << (63-10)) /* Use the in-memory segment table */
208 #define CXL_PSL_SR_An_PR  MSR_PR            /* Problem state, GA1: 1 */
209 #define CXL_PSL_SR_An_ISL (1ull << (63-53)) /* Ignore Segment Large Page */
210 #define CXL_PSL_SR_An_TC  (1ull << (63-54)) /* Page Table secondary hash */
211 #define CXL_PSL_SR_An_US  (1ull << (63-56)) /* User state,    GA1: X */
212 #define CXL_PSL_SR_An_SC  (1ull << (63-58)) /* Segment Table secondary hash */
213 #define CXL_PSL_SR_An_R   MSR_DR            /* Relocate,      GA1: 1 */
214 #define CXL_PSL_SR_An_MP  (1ull << (63-62)) /* Master Process */
215 #define CXL_PSL_SR_An_LE  (1ull << (63-63)) /* Little Endian */
216 
217 /****** CXL_PSL_ID_An ****************************************************/
218 #define CXL_PSL_ID_An_F	(1ull << (63-31))
219 #define CXL_PSL_ID_An_L	(1ull << (63-30))
220 
221 /****** CXL_PSL_SERR_An ****************************************************/
222 #define CXL_PSL_SERR_An_afuto	(1ull << (63-0))
223 #define CXL_PSL_SERR_An_afudis	(1ull << (63-1))
224 #define CXL_PSL_SERR_An_afuov	(1ull << (63-2))
225 #define CXL_PSL_SERR_An_badsrc	(1ull << (63-3))
226 #define CXL_PSL_SERR_An_badctx	(1ull << (63-4))
227 #define CXL_PSL_SERR_An_llcmdis	(1ull << (63-5))
228 #define CXL_PSL_SERR_An_llcmdto	(1ull << (63-6))
229 #define CXL_PSL_SERR_An_afupar	(1ull << (63-7))
230 #define CXL_PSL_SERR_An_afudup	(1ull << (63-8))
231 #define CXL_PSL_SERR_An_IRQS	( \
232 	CXL_PSL_SERR_An_afuto | CXL_PSL_SERR_An_afudis | CXL_PSL_SERR_An_afuov | \
233 	CXL_PSL_SERR_An_badsrc | CXL_PSL_SERR_An_badctx | CXL_PSL_SERR_An_llcmdis | \
234 	CXL_PSL_SERR_An_llcmdto | CXL_PSL_SERR_An_afupar | CXL_PSL_SERR_An_afudup)
235 #define CXL_PSL_SERR_An_afuto_mask	(1ull << (63-32))
236 #define CXL_PSL_SERR_An_afudis_mask	(1ull << (63-33))
237 #define CXL_PSL_SERR_An_afuov_mask	(1ull << (63-34))
238 #define CXL_PSL_SERR_An_badsrc_mask	(1ull << (63-35))
239 #define CXL_PSL_SERR_An_badctx_mask	(1ull << (63-36))
240 #define CXL_PSL_SERR_An_llcmdis_mask	(1ull << (63-37))
241 #define CXL_PSL_SERR_An_llcmdto_mask	(1ull << (63-38))
242 #define CXL_PSL_SERR_An_afupar_mask	(1ull << (63-39))
243 #define CXL_PSL_SERR_An_afudup_mask	(1ull << (63-40))
244 #define CXL_PSL_SERR_An_IRQ_MASKS	( \
245 	CXL_PSL_SERR_An_afuto_mask | CXL_PSL_SERR_An_afudis_mask | CXL_PSL_SERR_An_afuov_mask | \
246 	CXL_PSL_SERR_An_badsrc_mask | CXL_PSL_SERR_An_badctx_mask | CXL_PSL_SERR_An_llcmdis_mask | \
247 	CXL_PSL_SERR_An_llcmdto_mask | CXL_PSL_SERR_An_afupar_mask | CXL_PSL_SERR_An_afudup_mask)
248 
249 #define CXL_PSL_SERR_An_AE	(1ull << (63-30))
250 
251 /****** CXL_PSL_SCNTL_An ****************************************************/
252 #define CXL_PSL_SCNTL_An_CR          (0x1ull << (63-15))
253 /* Programming Modes: */
254 #define CXL_PSL_SCNTL_An_PM_MASK     (0xffffull << (63-31))
255 #define CXL_PSL_SCNTL_An_PM_Shared   (0x0000ull << (63-31))
256 #define CXL_PSL_SCNTL_An_PM_OS       (0x0001ull << (63-31))
257 #define CXL_PSL_SCNTL_An_PM_Process  (0x0002ull << (63-31))
258 #define CXL_PSL_SCNTL_An_PM_AFU      (0x0004ull << (63-31))
259 #define CXL_PSL_SCNTL_An_PM_AFU_PBT  (0x0104ull << (63-31))
260 /* Purge Status (ro) */
261 #define CXL_PSL_SCNTL_An_Ps_MASK     (0x3ull << (63-39))
262 #define CXL_PSL_SCNTL_An_Ps_Pending  (0x1ull << (63-39))
263 #define CXL_PSL_SCNTL_An_Ps_Complete (0x3ull << (63-39))
264 /* Purge */
265 #define CXL_PSL_SCNTL_An_Pc          (0x1ull << (63-48))
266 /* Suspend Status (ro) */
267 #define CXL_PSL_SCNTL_An_Ss_MASK     (0x3ull << (63-55))
268 #define CXL_PSL_SCNTL_An_Ss_Pending  (0x1ull << (63-55))
269 #define CXL_PSL_SCNTL_An_Ss_Complete (0x3ull << (63-55))
270 /* Suspend Control */
271 #define CXL_PSL_SCNTL_An_Sc          (0x1ull << (63-63))
272 
273 /* AFU Slice Enable Status (ro) */
274 #define CXL_AFU_Cntl_An_ES_MASK     (0x7ull << (63-2))
275 #define CXL_AFU_Cntl_An_ES_Disabled (0x0ull << (63-2))
276 #define CXL_AFU_Cntl_An_ES_Enabled  (0x4ull << (63-2))
277 /* AFU Slice Enable */
278 #define CXL_AFU_Cntl_An_E           (0x1ull << (63-3))
279 /* AFU Slice Reset status (ro) */
280 #define CXL_AFU_Cntl_An_RS_MASK     (0x3ull << (63-5))
281 #define CXL_AFU_Cntl_An_RS_Pending  (0x1ull << (63-5))
282 #define CXL_AFU_Cntl_An_RS_Complete (0x2ull << (63-5))
283 /* AFU Slice Reset */
284 #define CXL_AFU_Cntl_An_RA          (0x1ull << (63-7))
285 
286 /****** CXL_SSTP0/1_An ******************************************************/
287 /* These top bits are for the segment that CONTAINS the segment table */
288 #define CXL_SSTP0_An_B_SHIFT    SLB_VSID_SSIZE_SHIFT
289 #define CXL_SSTP0_An_KS             (1ull << (63-2))
290 #define CXL_SSTP0_An_KP             (1ull << (63-3))
291 #define CXL_SSTP0_An_N              (1ull << (63-4))
292 #define CXL_SSTP0_An_L              (1ull << (63-5))
293 #define CXL_SSTP0_An_C              (1ull << (63-6))
294 #define CXL_SSTP0_An_TA             (1ull << (63-7))
295 #define CXL_SSTP0_An_LP_SHIFT                (63-9)  /* 2 Bits */
296 /* And finally, the virtual address & size of the segment table: */
297 #define CXL_SSTP0_An_SegTableSize_SHIFT      (63-31) /* 12 Bits */
298 #define CXL_SSTP0_An_SegTableSize_MASK \
299 	(((1ull << 12) - 1) << CXL_SSTP0_An_SegTableSize_SHIFT)
300 #define CXL_SSTP0_An_STVA_U_MASK   ((1ull << (63-49))-1)
301 #define CXL_SSTP1_An_STVA_L_MASK (~((1ull << (63-55))-1))
302 #define CXL_SSTP1_An_V              (1ull << (63-63))
303 
304 /****** CXL_PSL_SLBIE_[An] - CAIA 1 **************************************************/
305 /* write: */
306 #define CXL_SLBIE_C        PPC_BIT(36)         /* Class */
307 #define CXL_SLBIE_SS       PPC_BITMASK(37, 38) /* Segment Size */
308 #define CXL_SLBIE_SS_SHIFT PPC_BITLSHIFT(38)
309 #define CXL_SLBIE_TA       PPC_BIT(38)         /* Tags Active */
310 /* read: */
311 #define CXL_SLBIE_MAX      PPC_BITMASK(24, 31)
312 #define CXL_SLBIE_PENDING  PPC_BITMASK(56, 63)
313 
314 /****** Common to all CXL_TLBIA/SLBIA_[An] - CAIA 1 **********************************/
315 #define CXL_TLB_SLB_P          (1ull) /* Pending (read) */
316 
317 /****** Common to all CXL_TLB/SLB_IA/IE_[An] registers - CAIA 1 **********************/
318 #define CXL_TLB_SLB_IQ_ALL     (0ull) /* Inv qualifier */
319 #define CXL_TLB_SLB_IQ_LPID    (1ull) /* Inv qualifier */
320 #define CXL_TLB_SLB_IQ_LPIDPID (3ull) /* Inv qualifier */
321 
322 /****** CXL_PSL_AFUSEL ******************************************************/
323 #define CXL_PSL_AFUSEL_A (1ull << (63-55)) /* Adapter wide invalidates affect all AFUs */
324 
325 /****** CXL_PSL_DSISR_An - CAIA 1 ****************************************************/
326 #define CXL_PSL_DSISR_An_DS (1ull << (63-0))  /* Segment not found */
327 #define CXL_PSL_DSISR_An_DM (1ull << (63-1))  /* PTE not found (See also: M) or protection fault */
328 #define CXL_PSL_DSISR_An_ST (1ull << (63-2))  /* Segment Table PTE not found */
329 #define CXL_PSL_DSISR_An_UR (1ull << (63-3))  /* AURP PTE not found */
330 #define CXL_PSL_DSISR_TRANS (CXL_PSL_DSISR_An_DS | CXL_PSL_DSISR_An_DM | CXL_PSL_DSISR_An_ST | CXL_PSL_DSISR_An_UR)
331 #define CXL_PSL_DSISR_An_PE (1ull << (63-4))  /* PSL Error (implementation specific) */
332 #define CXL_PSL_DSISR_An_AE (1ull << (63-5))  /* AFU Error */
333 #define CXL_PSL_DSISR_An_OC (1ull << (63-6))  /* OS Context Warning */
334 #define CXL_PSL_DSISR_PENDING (CXL_PSL_DSISR_TRANS | CXL_PSL_DSISR_An_PE | CXL_PSL_DSISR_An_AE | CXL_PSL_DSISR_An_OC)
335 /* NOTE: Bits 32:63 are undefined if DSISR[DS] = 1 */
336 #define CXL_PSL_DSISR_An_M  DSISR_NOHPTE      /* PTE not found */
337 #define CXL_PSL_DSISR_An_P  DSISR_PROTFAULT   /* Storage protection violation */
338 #define CXL_PSL_DSISR_An_A  (1ull << (63-37)) /* AFU lock access to write through or cache inhibited storage */
339 #define CXL_PSL_DSISR_An_S  DSISR_ISSTORE     /* Access was afu_wr or afu_zero */
340 #define CXL_PSL_DSISR_An_K  DSISR_KEYFAULT    /* Access not permitted by virtual page class key protection */
341 
342 /****** CXL_PSL_DSISR_An - CAIA 2 ****************************************************/
343 #define CXL_PSL9_DSISR_An_TF (1ull << (63-3))  /* Translation fault */
344 #define CXL_PSL9_DSISR_An_PE (1ull << (63-4))  /* PSL Error (implementation specific) */
345 #define CXL_PSL9_DSISR_An_AE (1ull << (63-5))  /* AFU Error */
346 #define CXL_PSL9_DSISR_An_OC (1ull << (63-6))  /* OS Context Warning */
347 #define CXL_PSL9_DSISR_An_S (1ull << (63-38))  /* TF for a write operation */
348 #define CXL_PSL9_DSISR_PENDING (CXL_PSL9_DSISR_An_TF | CXL_PSL9_DSISR_An_PE | CXL_PSL9_DSISR_An_AE | CXL_PSL9_DSISR_An_OC)
349 /*
350  * NOTE: Bits 56:63 (Checkout Response Status) are valid when DSISR_An[TF] = 1
351  * Status (0:7) Encoding
352  */
353 #define CXL_PSL9_DSISR_An_CO_MASK 0x00000000000000ffULL
354 #define CXL_PSL9_DSISR_An_SF      0x0000000000000080ULL  /* Segment Fault                        0b10000000 */
355 #define CXL_PSL9_DSISR_An_PF_SLR  0x0000000000000088ULL  /* PTE not found (Single Level Radix)   0b10001000 */
356 #define CXL_PSL9_DSISR_An_PF_RGC  0x000000000000008CULL  /* PTE not found (Radix Guest (child))  0b10001100 */
357 #define CXL_PSL9_DSISR_An_PF_RGP  0x0000000000000090ULL  /* PTE not found (Radix Guest (parent)) 0b10010000 */
358 #define CXL_PSL9_DSISR_An_PF_HRH  0x0000000000000094ULL  /* PTE not found (HPT/Radix Host)       0b10010100 */
359 #define CXL_PSL9_DSISR_An_PF_STEG 0x000000000000009CULL  /* PTE not found (STEG VA)              0b10011100 */
360 #define CXL_PSL9_DSISR_An_URTCH   0x00000000000000B4ULL  /* Unsupported Radix Tree Configuration 0b10110100 */
361 
362 /****** CXL_PSL_TFC_An ******************************************************/
363 #define CXL_PSL_TFC_An_A  (1ull << (63-28)) /* Acknowledge non-translation fault */
364 #define CXL_PSL_TFC_An_C  (1ull << (63-29)) /* Continue (abort transaction) */
365 #define CXL_PSL_TFC_An_AE (1ull << (63-30)) /* Restart PSL with address error */
366 #define CXL_PSL_TFC_An_R  (1ull << (63-31)) /* Restart PSL transaction */
367 
368 /****** CXL_XSL9_IERAT_ERAT - CAIA 2 **********************************/
369 #define CXL_XSL9_IERAT_MLPID    (1ull << (63-0))  /* Match LPID */
370 #define CXL_XSL9_IERAT_MPID     (1ull << (63-1))  /* Match PID */
371 #define CXL_XSL9_IERAT_PRS      (1ull << (63-4))  /* PRS bit for Radix invalidations */
372 #define CXL_XSL9_IERAT_INVR     (1ull << (63-3))  /* Invalidate Radix */
373 #define CXL_XSL9_IERAT_IALL     (1ull << (63-8))  /* Invalidate All */
374 #define CXL_XSL9_IERAT_IINPROG  (1ull << (63-63)) /* Invalidate in progress */
375 
376 /* cxl_process_element->software_status */
377 #define CXL_PE_SOFTWARE_STATE_V (1ul << (31 -  0)) /* Valid */
378 #define CXL_PE_SOFTWARE_STATE_C (1ul << (31 - 29)) /* Complete */
379 #define CXL_PE_SOFTWARE_STATE_S (1ul << (31 - 30)) /* Suspend */
380 #define CXL_PE_SOFTWARE_STATE_T (1ul << (31 - 31)) /* Terminate */
381 
382 /****** CXL_PSL_RXCTL_An (Implementation Specific) **************************
383  * Controls AFU Hang Pulse, which sets the timeout for the AFU to respond to
384  * the PSL for any response (except MMIO). Timeouts will occur between 1x to 2x
385  * of the hang pulse frequency.
386  */
387 #define CXL_PSL_RXCTL_AFUHP_4S      0x7000000000000000ULL
388 
389 /* SPA->sw_command_status */
390 #define CXL_SPA_SW_CMD_MASK         0xffff000000000000ULL
391 #define CXL_SPA_SW_CMD_TERMINATE    0x0001000000000000ULL
392 #define CXL_SPA_SW_CMD_REMOVE       0x0002000000000000ULL
393 #define CXL_SPA_SW_CMD_SUSPEND      0x0003000000000000ULL
394 #define CXL_SPA_SW_CMD_RESUME       0x0004000000000000ULL
395 #define CXL_SPA_SW_CMD_ADD          0x0005000000000000ULL
396 #define CXL_SPA_SW_CMD_UPDATE       0x0006000000000000ULL
397 #define CXL_SPA_SW_STATE_MASK       0x0000ffff00000000ULL
398 #define CXL_SPA_SW_STATE_TERMINATED 0x0000000100000000ULL
399 #define CXL_SPA_SW_STATE_REMOVED    0x0000000200000000ULL
400 #define CXL_SPA_SW_STATE_SUSPENDED  0x0000000300000000ULL
401 #define CXL_SPA_SW_STATE_RESUMED    0x0000000400000000ULL
402 #define CXL_SPA_SW_STATE_ADDED      0x0000000500000000ULL
403 #define CXL_SPA_SW_STATE_UPDATED    0x0000000600000000ULL
404 #define CXL_SPA_SW_PSL_ID_MASK      0x00000000ffff0000ULL
405 #define CXL_SPA_SW_LINK_MASK        0x000000000000ffffULL
406 
407 #define CXL_MAX_SLICES 4
408 #define MAX_AFU_MMIO_REGS 3
409 
410 #define CXL_MODE_TIME_SLICED 0x4
411 #define CXL_SUPPORTED_MODES (CXL_MODE_DEDICATED | CXL_MODE_DIRECTED)
412 
413 #define CXL_DEV_MINORS 13   /* 1 control + 4 AFUs * 3 (dedicated/master/shared) */
414 #define CXL_CARD_MINOR(adapter) (adapter->adapter_num * CXL_DEV_MINORS)
415 #define CXL_DEVT_ADAPTER(dev) (MINOR(dev) / CXL_DEV_MINORS)
416 
417 enum cxl_context_status {
418 	CLOSED,
419 	OPENED,
420 	STARTED
421 };
422 
423 enum prefault_modes {
424 	CXL_PREFAULT_NONE,
425 	CXL_PREFAULT_WED,
426 	CXL_PREFAULT_ALL,
427 };
428 
429 enum cxl_attrs {
430 	CXL_ADAPTER_ATTRS,
431 	CXL_AFU_MASTER_ATTRS,
432 	CXL_AFU_ATTRS,
433 };
434 
435 struct cxl_sste {
436 	__be64 esid_data;
437 	__be64 vsid_data;
438 };
439 
440 #define to_cxl_adapter(d) container_of(d, struct cxl, dev)
441 #define to_cxl_afu(d) container_of(d, struct cxl_afu, dev)
442 
443 struct cxl_afu_native {
444 	void __iomem *p1n_mmio;
445 	void __iomem *afu_desc_mmio;
446 	irq_hw_number_t psl_hwirq;
447 	unsigned int psl_virq;
448 	struct mutex spa_mutex;
449 	/*
450 	 * Only the first part of the SPA is used for the process element
451 	 * linked list. The only other part that software needs to worry about
452 	 * is sw_command_status, which we store a separate pointer to.
453 	 * Everything else in the SPA is only used by hardware
454 	 */
455 	struct cxl_process_element *spa;
456 	__be64 *sw_command_status;
457 	unsigned int spa_size;
458 	int spa_order;
459 	int spa_max_procs;
460 	u64 pp_offset;
461 };
462 
463 struct cxl_afu_guest {
464 	struct cxl_afu *parent;
465 	u64 handle;
466 	phys_addr_t p2n_phys;
467 	u64 p2n_size;
468 	int max_ints;
469 	bool handle_err;
470 	struct delayed_work work_err;
471 	int previous_state;
472 };
473 
474 struct cxl_afu {
475 	struct cxl_afu_native *native;
476 	struct cxl_afu_guest *guest;
477 	irq_hw_number_t serr_hwirq;
478 	unsigned int serr_virq;
479 	char *psl_irq_name;
480 	char *err_irq_name;
481 	void __iomem *p2n_mmio;
482 	phys_addr_t psn_phys;
483 	u64 pp_size;
484 
485 	struct cxl *adapter;
486 	struct device dev;
487 	struct cdev afu_cdev_s, afu_cdev_m, afu_cdev_d;
488 	struct device *chardev_s, *chardev_m, *chardev_d;
489 	struct idr contexts_idr;
490 	struct dentry *debugfs;
491 	struct mutex contexts_lock;
492 	spinlock_t afu_cntl_lock;
493 
494 	/* -1: AFU deconfigured/locked, >= 0: number of readers */
495 	atomic_t configured_state;
496 
497 	/* AFU error buffer fields and bin attribute for sysfs */
498 	u64 eb_len, eb_offset;
499 	struct bin_attribute attr_eb;
500 
501 	/* pointer to the vphb */
502 	struct pci_controller *phb;
503 
504 	int pp_irqs;
505 	int irqs_max;
506 	int num_procs;
507 	int max_procs_virtualised;
508 	int slice;
509 	int modes_supported;
510 	int current_mode;
511 	int crs_num;
512 	u64 crs_len;
513 	u64 crs_offset;
514 	struct list_head crs;
515 	enum prefault_modes prefault_mode;
516 	bool psa;
517 	bool pp_psa;
518 	bool enabled;
519 };
520 
521 
522 struct cxl_irq_name {
523 	struct list_head list;
524 	char *name;
525 };
526 
527 struct irq_avail {
528 	irq_hw_number_t offset;
529 	irq_hw_number_t range;
530 	unsigned long   *bitmap;
531 };
532 
533 /*
534  * This is a cxl context.  If the PSL is in dedicated mode, there will be one
535  * of these per AFU.  If in AFU directed there can be lots of these.
536  */
537 struct cxl_context {
538 	struct cxl_afu *afu;
539 
540 	/* Problem state MMIO */
541 	phys_addr_t psn_phys;
542 	u64 psn_size;
543 
544 	/* Used to unmap any mmaps when force detaching */
545 	struct address_space *mapping;
546 	struct mutex mapping_lock;
547 	struct page *ff_page;
548 	bool mmio_err_ff;
549 	bool kernelapi;
550 
551 	spinlock_t sste_lock; /* Protects segment table entries */
552 	struct cxl_sste *sstp;
553 	u64 sstp0, sstp1;
554 	unsigned int sst_size, sst_lru;
555 
556 	wait_queue_head_t wq;
557 	/* use mm context associated with this pid for ds faults */
558 	struct pid *pid;
559 	spinlock_t lock; /* Protects pending_irq_mask, pending_fault and fault_addr */
560 	/* Only used in PR mode */
561 	u64 process_token;
562 
563 	/* driver private data */
564 	void *priv;
565 
566 	unsigned long *irq_bitmap; /* Accessed from IRQ context */
567 	struct cxl_irq_ranges irqs;
568 	struct list_head irq_names;
569 	u64 fault_addr;
570 	u64 fault_dsisr;
571 	u64 afu_err;
572 
573 	/*
574 	 * This status and it's lock pretects start and detach context
575 	 * from racing.  It also prevents detach from racing with
576 	 * itself
577 	 */
578 	enum cxl_context_status status;
579 	struct mutex status_mutex;
580 
581 
582 	/* XXX: Is it possible to need multiple work items at once? */
583 	struct work_struct fault_work;
584 	u64 dsisr;
585 	u64 dar;
586 
587 	struct cxl_process_element *elem;
588 
589 	/*
590 	 * pe is the process element handle, assigned by this driver when the
591 	 * context is initialized.
592 	 *
593 	 * external_pe is the PE shown outside of cxl.
594 	 * On bare-metal, pe=external_pe, because we decide what the handle is.
595 	 * In a guest, we only find out about the pe used by pHyp when the
596 	 * context is attached, and that's the value we want to report outside
597 	 * of cxl.
598 	 */
599 	int pe;
600 	int external_pe;
601 
602 	u32 irq_count;
603 	bool pe_inserted;
604 	bool master;
605 	bool kernel;
606 	bool real_mode;
607 	bool pending_irq;
608 	bool pending_fault;
609 	bool pending_afu_err;
610 
611 	/* Used by AFU drivers for driver specific event delivery */
612 	struct cxl_afu_driver_ops *afu_driver_ops;
613 	atomic_t afu_driver_events;
614 
615 	struct rcu_head rcu;
616 
617 	/*
618 	 * Only used when more interrupts are allocated via
619 	 * pci_enable_msix_range than are supported in the default context, to
620 	 * use additional contexts to overcome the limitation. i.e. Mellanox
621 	 * CX4 only:
622 	 */
623 	struct list_head extra_irq_contexts;
624 
625 	struct mm_struct *mm;
626 };
627 
628 struct cxl_irq_info;
629 
630 struct cxl_service_layer_ops {
631 	int (*adapter_regs_init)(struct cxl *adapter, struct pci_dev *dev);
632 	int (*invalidate_all)(struct cxl *adapter);
633 	int (*afu_regs_init)(struct cxl_afu *afu);
634 	int (*sanitise_afu_regs)(struct cxl_afu *afu);
635 	int (*register_serr_irq)(struct cxl_afu *afu);
636 	void (*release_serr_irq)(struct cxl_afu *afu);
637 	irqreturn_t (*handle_interrupt)(int irq, struct cxl_context *ctx, struct cxl_irq_info *irq_info);
638 	irqreturn_t (*fail_irq)(struct cxl_afu *afu, struct cxl_irq_info *irq_info);
639 	int (*activate_dedicated_process)(struct cxl_afu *afu);
640 	int (*attach_afu_directed)(struct cxl_context *ctx, u64 wed, u64 amr);
641 	int (*attach_dedicated_process)(struct cxl_context *ctx, u64 wed, u64 amr);
642 	void (*update_dedicated_ivtes)(struct cxl_context *ctx);
643 	void (*debugfs_add_adapter_regs)(struct cxl *adapter, struct dentry *dir);
644 	void (*debugfs_add_afu_regs)(struct cxl_afu *afu, struct dentry *dir);
645 	void (*psl_irq_dump_registers)(struct cxl_context *ctx);
646 	void (*err_irq_dump_registers)(struct cxl *adapter);
647 	void (*debugfs_stop_trace)(struct cxl *adapter);
648 	void (*write_timebase_ctrl)(struct cxl *adapter);
649 	u64 (*timebase_read)(struct cxl *adapter);
650 	int capi_mode;
651 	bool needs_reset_before_disable;
652 };
653 
654 struct cxl_native {
655 	u64 afu_desc_off;
656 	u64 afu_desc_size;
657 	void __iomem *p1_mmio;
658 	void __iomem *p2_mmio;
659 	irq_hw_number_t err_hwirq;
660 	unsigned int err_virq;
661 	u64 ps_off;
662 	const struct cxl_service_layer_ops *sl_ops;
663 };
664 
665 struct cxl_guest {
666 	struct platform_device *pdev;
667 	int irq_nranges;
668 	struct cdev cdev;
669 	irq_hw_number_t irq_base_offset;
670 	struct irq_avail *irq_avail;
671 	spinlock_t irq_alloc_lock;
672 	u64 handle;
673 	char *status;
674 	u16 vendor;
675 	u16 device;
676 	u16 subsystem_vendor;
677 	u16 subsystem;
678 };
679 
680 struct cxl {
681 	struct cxl_native *native;
682 	struct cxl_guest *guest;
683 	spinlock_t afu_list_lock;
684 	struct cxl_afu *afu[CXL_MAX_SLICES];
685 	struct device dev;
686 	struct dentry *trace;
687 	struct dentry *psl_err_chk;
688 	struct dentry *debugfs;
689 	char *irq_name;
690 	struct bin_attribute cxl_attr;
691 	int adapter_num;
692 	int user_irqs;
693 	int min_pe;
694 	u64 ps_size;
695 	u16 psl_rev;
696 	u16 base_image;
697 	u8 vsec_status;
698 	u8 caia_major;
699 	u8 caia_minor;
700 	u8 slices;
701 	bool user_image_loaded;
702 	bool perst_loads_image;
703 	bool perst_select_user;
704 	bool perst_same_image;
705 	bool psl_timebase_synced;
706 
707 	/*
708 	 * number of contexts mapped on to this card. Possible values are:
709 	 * >0: Number of contexts mapped and new one can be mapped.
710 	 *  0: No active contexts and new ones can be mapped.
711 	 * -1: No contexts mapped and new ones cannot be mapped.
712 	 */
713 	atomic_t contexts_num;
714 };
715 
716 int cxl_pci_alloc_one_irq(struct cxl *adapter);
717 void cxl_pci_release_one_irq(struct cxl *adapter, int hwirq);
718 int cxl_pci_alloc_irq_ranges(struct cxl_irq_ranges *irqs, struct cxl *adapter, unsigned int num);
719 void cxl_pci_release_irq_ranges(struct cxl_irq_ranges *irqs, struct cxl *adapter);
720 int cxl_pci_setup_irq(struct cxl *adapter, unsigned int hwirq, unsigned int virq);
721 int cxl_update_image_control(struct cxl *adapter);
722 int cxl_pci_reset(struct cxl *adapter);
723 void cxl_pci_release_afu(struct device *dev);
724 ssize_t cxl_pci_read_adapter_vpd(struct cxl *adapter, void *buf, size_t len);
725 
726 /* common == phyp + powernv - CAIA 1&2 */
727 struct cxl_process_element_common {
728 	__be32 tid;
729 	__be32 pid;
730 	__be64 csrp;
731 	union {
732 		struct {
733 			__be64 aurp0;
734 			__be64 aurp1;
735 			__be64 sstp0;
736 			__be64 sstp1;
737 		} psl8;  /* CAIA 1 */
738 		struct {
739 			u8     reserved2[8];
740 			u8     reserved3[8];
741 			u8     reserved4[8];
742 			u8     reserved5[8];
743 		} psl9;  /* CAIA 2 */
744 	} u;
745 	__be64 amr;
746 	u8     reserved6[4];
747 	__be64 wed;
748 } __packed;
749 
750 /* just powernv - CAIA 1&2 */
751 struct cxl_process_element {
752 	__be64 sr;
753 	__be64 SPOffset;
754 	union {
755 		__be64 sdr;          /* CAIA 1 */
756 		u8     reserved1[8]; /* CAIA 2 */
757 	} u;
758 	__be64 haurp;
759 	__be32 ctxtime;
760 	__be16 ivte_offsets[4];
761 	__be16 ivte_ranges[4];
762 	__be32 lpid;
763 	struct cxl_process_element_common common;
764 	__be32 software_state;
765 } __packed;
766 
767 static inline bool cxl_adapter_link_ok(struct cxl *cxl, struct cxl_afu *afu)
768 {
769 	struct pci_dev *pdev;
770 
771 	if (cpu_has_feature(CPU_FTR_HVMODE)) {
772 		pdev = to_pci_dev(cxl->dev.parent);
773 		return !pci_channel_offline(pdev);
774 	}
775 	return true;
776 }
777 
778 static inline void __iomem *_cxl_p1_addr(struct cxl *cxl, cxl_p1_reg_t reg)
779 {
780 	WARN_ON(!cpu_has_feature(CPU_FTR_HVMODE));
781 	return cxl->native->p1_mmio + cxl_reg_off(reg);
782 }
783 
784 static inline void cxl_p1_write(struct cxl *cxl, cxl_p1_reg_t reg, u64 val)
785 {
786 	if (likely(cxl_adapter_link_ok(cxl, NULL)))
787 		out_be64(_cxl_p1_addr(cxl, reg), val);
788 }
789 
790 static inline u64 cxl_p1_read(struct cxl *cxl, cxl_p1_reg_t reg)
791 {
792 	if (likely(cxl_adapter_link_ok(cxl, NULL)))
793 		return in_be64(_cxl_p1_addr(cxl, reg));
794 	else
795 		return ~0ULL;
796 }
797 
798 static inline void __iomem *_cxl_p1n_addr(struct cxl_afu *afu, cxl_p1n_reg_t reg)
799 {
800 	WARN_ON(!cpu_has_feature(CPU_FTR_HVMODE));
801 	return afu->native->p1n_mmio + cxl_reg_off(reg);
802 }
803 
804 static inline void cxl_p1n_write(struct cxl_afu *afu, cxl_p1n_reg_t reg, u64 val)
805 {
806 	if (likely(cxl_adapter_link_ok(afu->adapter, afu)))
807 		out_be64(_cxl_p1n_addr(afu, reg), val);
808 }
809 
810 static inline u64 cxl_p1n_read(struct cxl_afu *afu, cxl_p1n_reg_t reg)
811 {
812 	if (likely(cxl_adapter_link_ok(afu->adapter, afu)))
813 		return in_be64(_cxl_p1n_addr(afu, reg));
814 	else
815 		return ~0ULL;
816 }
817 
818 static inline void __iomem *_cxl_p2n_addr(struct cxl_afu *afu, cxl_p2n_reg_t reg)
819 {
820 	return afu->p2n_mmio + cxl_reg_off(reg);
821 }
822 
823 static inline void cxl_p2n_write(struct cxl_afu *afu, cxl_p2n_reg_t reg, u64 val)
824 {
825 	if (likely(cxl_adapter_link_ok(afu->adapter, afu)))
826 		out_be64(_cxl_p2n_addr(afu, reg), val);
827 }
828 
829 static inline u64 cxl_p2n_read(struct cxl_afu *afu, cxl_p2n_reg_t reg)
830 {
831 	if (likely(cxl_adapter_link_ok(afu->adapter, afu)))
832 		return in_be64(_cxl_p2n_addr(afu, reg));
833 	else
834 		return ~0ULL;
835 }
836 
837 static inline bool cxl_is_power8(void)
838 {
839 	if ((pvr_version_is(PVR_POWER8E)) ||
840 	    (pvr_version_is(PVR_POWER8NVL)) ||
841 	    (pvr_version_is(PVR_POWER8)))
842 		return true;
843 	return false;
844 }
845 
846 static inline bool cxl_is_power9(void)
847 {
848 	if (pvr_version_is(PVR_POWER9))
849 		return true;
850 	return false;
851 }
852 
853 static inline bool cxl_is_power9_dd1(void)
854 {
855 	if ((pvr_version_is(PVR_POWER9)) &&
856 	    cpu_has_feature(CPU_FTR_POWER9_DD1))
857 		return true;
858 	return false;
859 }
860 
861 ssize_t cxl_pci_afu_read_err_buffer(struct cxl_afu *afu, char *buf,
862 				loff_t off, size_t count);
863 
864 /* Internal functions wrapped in cxl_base to allow PHB to call them */
865 bool _cxl_pci_associate_default_context(struct pci_dev *dev, struct cxl_afu *afu);
866 void _cxl_pci_disable_device(struct pci_dev *dev);
867 int _cxl_next_msi_hwirq(struct pci_dev *pdev, struct cxl_context **ctx, int *afu_irq);
868 int _cxl_cx4_setup_msi_irqs(struct pci_dev *pdev, int nvec, int type);
869 void _cxl_cx4_teardown_msi_irqs(struct pci_dev *pdev);
870 
871 struct cxl_calls {
872 	void (*cxl_slbia)(struct mm_struct *mm);
873 	bool (*cxl_pci_associate_default_context)(struct pci_dev *dev, struct cxl_afu *afu);
874 	void (*cxl_pci_disable_device)(struct pci_dev *dev);
875 	int (*cxl_next_msi_hwirq)(struct pci_dev *pdev, struct cxl_context **ctx, int *afu_irq);
876 	int (*cxl_cx4_setup_msi_irqs)(struct pci_dev *pdev, int nvec, int type);
877 	void (*cxl_cx4_teardown_msi_irqs)(struct pci_dev *pdev);
878 
879 	struct module *owner;
880 };
881 int register_cxl_calls(struct cxl_calls *calls);
882 void unregister_cxl_calls(struct cxl_calls *calls);
883 int cxl_update_properties(struct device_node *dn, struct property *new_prop);
884 
885 void cxl_remove_adapter_nr(struct cxl *adapter);
886 
887 void cxl_release_spa(struct cxl_afu *afu);
888 
889 dev_t cxl_get_dev(void);
890 int cxl_file_init(void);
891 void cxl_file_exit(void);
892 int cxl_register_adapter(struct cxl *adapter);
893 int cxl_register_afu(struct cxl_afu *afu);
894 int cxl_chardev_d_afu_add(struct cxl_afu *afu);
895 int cxl_chardev_m_afu_add(struct cxl_afu *afu);
896 int cxl_chardev_s_afu_add(struct cxl_afu *afu);
897 void cxl_chardev_afu_remove(struct cxl_afu *afu);
898 
899 void cxl_context_detach_all(struct cxl_afu *afu);
900 void cxl_context_free(struct cxl_context *ctx);
901 void cxl_context_detach(struct cxl_context *ctx);
902 
903 int cxl_sysfs_adapter_add(struct cxl *adapter);
904 void cxl_sysfs_adapter_remove(struct cxl *adapter);
905 int cxl_sysfs_afu_add(struct cxl_afu *afu);
906 void cxl_sysfs_afu_remove(struct cxl_afu *afu);
907 int cxl_sysfs_afu_m_add(struct cxl_afu *afu);
908 void cxl_sysfs_afu_m_remove(struct cxl_afu *afu);
909 
910 struct cxl *cxl_alloc_adapter(void);
911 struct cxl_afu *cxl_alloc_afu(struct cxl *adapter, int slice);
912 int cxl_afu_select_best_mode(struct cxl_afu *afu);
913 
914 int cxl_native_register_psl_irq(struct cxl_afu *afu);
915 void cxl_native_release_psl_irq(struct cxl_afu *afu);
916 int cxl_native_register_psl_err_irq(struct cxl *adapter);
917 void cxl_native_release_psl_err_irq(struct cxl *adapter);
918 int cxl_native_register_serr_irq(struct cxl_afu *afu);
919 void cxl_native_release_serr_irq(struct cxl_afu *afu);
920 int afu_register_irqs(struct cxl_context *ctx, u32 count);
921 void afu_release_irqs(struct cxl_context *ctx, void *cookie);
922 void afu_irq_name_free(struct cxl_context *ctx);
923 
924 int cxl_attach_afu_directed_psl9(struct cxl_context *ctx, u64 wed, u64 amr);
925 int cxl_attach_afu_directed_psl8(struct cxl_context *ctx, u64 wed, u64 amr);
926 int cxl_activate_dedicated_process_psl9(struct cxl_afu *afu);
927 int cxl_activate_dedicated_process_psl8(struct cxl_afu *afu);
928 int cxl_attach_dedicated_process_psl9(struct cxl_context *ctx, u64 wed, u64 amr);
929 int cxl_attach_dedicated_process_psl8(struct cxl_context *ctx, u64 wed, u64 amr);
930 void cxl_update_dedicated_ivtes_psl9(struct cxl_context *ctx);
931 void cxl_update_dedicated_ivtes_psl8(struct cxl_context *ctx);
932 
933 #ifdef CONFIG_DEBUG_FS
934 
935 int cxl_debugfs_init(void);
936 void cxl_debugfs_exit(void);
937 int cxl_debugfs_adapter_add(struct cxl *adapter);
938 void cxl_debugfs_adapter_remove(struct cxl *adapter);
939 int cxl_debugfs_afu_add(struct cxl_afu *afu);
940 void cxl_debugfs_afu_remove(struct cxl_afu *afu);
941 void cxl_stop_trace_psl9(struct cxl *cxl);
942 void cxl_stop_trace_psl8(struct cxl *cxl);
943 void cxl_debugfs_add_adapter_regs_psl9(struct cxl *adapter, struct dentry *dir);
944 void cxl_debugfs_add_adapter_regs_psl8(struct cxl *adapter, struct dentry *dir);
945 void cxl_debugfs_add_adapter_regs_xsl(struct cxl *adapter, struct dentry *dir);
946 void cxl_debugfs_add_afu_regs_psl9(struct cxl_afu *afu, struct dentry *dir);
947 void cxl_debugfs_add_afu_regs_psl8(struct cxl_afu *afu, struct dentry *dir);
948 
949 #else /* CONFIG_DEBUG_FS */
950 
951 static inline int __init cxl_debugfs_init(void)
952 {
953 	return 0;
954 }
955 
956 static inline void cxl_debugfs_exit(void)
957 {
958 }
959 
960 static inline int cxl_debugfs_adapter_add(struct cxl *adapter)
961 {
962 	return 0;
963 }
964 
965 static inline void cxl_debugfs_adapter_remove(struct cxl *adapter)
966 {
967 }
968 
969 static inline int cxl_debugfs_afu_add(struct cxl_afu *afu)
970 {
971 	return 0;
972 }
973 
974 static inline void cxl_debugfs_afu_remove(struct cxl_afu *afu)
975 {
976 }
977 
978 static inline void cxl_stop_trace_psl9(struct cxl *cxl)
979 {
980 }
981 
982 static inline void cxl_stop_trace_psl8(struct cxl *cxl)
983 {
984 }
985 
986 static inline void cxl_debugfs_add_adapter_regs_psl9(struct cxl *adapter,
987 						    struct dentry *dir)
988 {
989 }
990 
991 static inline void cxl_debugfs_add_adapter_regs_psl8(struct cxl *adapter,
992 						    struct dentry *dir)
993 {
994 }
995 
996 static inline void cxl_debugfs_add_adapter_regs_xsl(struct cxl *adapter,
997 						    struct dentry *dir)
998 {
999 }
1000 
1001 static inline void cxl_debugfs_add_afu_regs_psl9(struct cxl_afu *afu, struct dentry *dir)
1002 {
1003 }
1004 
1005 static inline void cxl_debugfs_add_afu_regs_psl8(struct cxl_afu *afu, struct dentry *dir)
1006 {
1007 }
1008 
1009 #endif /* CONFIG_DEBUG_FS */
1010 
1011 void cxl_handle_fault(struct work_struct *work);
1012 void cxl_prefault(struct cxl_context *ctx, u64 wed);
1013 int cxl_handle_mm_fault(struct mm_struct *mm, u64 dsisr, u64 dar);
1014 
1015 struct cxl *get_cxl_adapter(int num);
1016 int cxl_alloc_sst(struct cxl_context *ctx);
1017 void cxl_dump_debug_buffer(void *addr, size_t size);
1018 
1019 void init_cxl_native(void);
1020 
1021 struct cxl_context *cxl_context_alloc(void);
1022 int cxl_context_init(struct cxl_context *ctx, struct cxl_afu *afu, bool master);
1023 void cxl_context_set_mapping(struct cxl_context *ctx,
1024 			struct address_space *mapping);
1025 void cxl_context_free(struct cxl_context *ctx);
1026 int cxl_context_iomap(struct cxl_context *ctx, struct vm_area_struct *vma);
1027 unsigned int cxl_map_irq(struct cxl *adapter, irq_hw_number_t hwirq,
1028 			 irq_handler_t handler, void *cookie, const char *name);
1029 void cxl_unmap_irq(unsigned int virq, void *cookie);
1030 int __detach_context(struct cxl_context *ctx);
1031 
1032 /*
1033  * This must match the layout of the H_COLLECT_CA_INT_INFO retbuf defined
1034  * in PAPR.
1035  * Field pid_tid is now 'reserved' because it's no more used on bare-metal.
1036  * On a guest environment, PSL_PID_An is located on the upper 32 bits and
1037  * PSL_TID_An register in the lower 32 bits.
1038  */
1039 struct cxl_irq_info {
1040 	u64 dsisr;
1041 	u64 dar;
1042 	u64 dsr;
1043 	u64 reserved;
1044 	u64 afu_err;
1045 	u64 errstat;
1046 	u64 proc_handle;
1047 	u64 padding[2]; /* to match the expected retbuf size for plpar_hcall9 */
1048 };
1049 
1050 void cxl_assign_psn_space(struct cxl_context *ctx);
1051 int cxl_invalidate_all_psl9(struct cxl *adapter);
1052 int cxl_invalidate_all_psl8(struct cxl *adapter);
1053 irqreturn_t cxl_irq_psl9(int irq, struct cxl_context *ctx, struct cxl_irq_info *irq_info);
1054 irqreturn_t cxl_irq_psl8(int irq, struct cxl_context *ctx, struct cxl_irq_info *irq_info);
1055 irqreturn_t cxl_fail_irq_psl(struct cxl_afu *afu, struct cxl_irq_info *irq_info);
1056 int cxl_register_one_irq(struct cxl *adapter, irq_handler_t handler,
1057 			void *cookie, irq_hw_number_t *dest_hwirq,
1058 			unsigned int *dest_virq, const char *name);
1059 
1060 int cxl_check_error(struct cxl_afu *afu);
1061 int cxl_afu_slbia(struct cxl_afu *afu);
1062 int cxl_data_cache_flush(struct cxl *adapter);
1063 int cxl_afu_disable(struct cxl_afu *afu);
1064 int cxl_psl_purge(struct cxl_afu *afu);
1065 int cxl_calc_capp_routing(struct pci_dev *dev, u64 *chipid,
1066 			  u32 *phb_index, u64 *capp_unit_id);
1067 int cxl_slot_is_switched(struct pci_dev *dev);
1068 int cxl_get_xsl9_dsnctl(u64 capp_unit_id, u64 *reg);
1069 u64 cxl_calculate_sr(bool master, bool kernel, bool real_mode, bool p9);
1070 
1071 void cxl_native_irq_dump_regs_psl9(struct cxl_context *ctx);
1072 void cxl_native_irq_dump_regs_psl8(struct cxl_context *ctx);
1073 void cxl_native_err_irq_dump_regs(struct cxl *adapter);
1074 int cxl_pci_vphb_add(struct cxl_afu *afu);
1075 void cxl_pci_vphb_remove(struct cxl_afu *afu);
1076 void cxl_release_mapping(struct cxl_context *ctx);
1077 
1078 extern struct pci_driver cxl_pci_driver;
1079 extern struct platform_driver cxl_of_driver;
1080 int afu_allocate_irqs(struct cxl_context *ctx, u32 count);
1081 
1082 int afu_open(struct inode *inode, struct file *file);
1083 int afu_release(struct inode *inode, struct file *file);
1084 long afu_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1085 int afu_mmap(struct file *file, struct vm_area_struct *vm);
1086 unsigned int afu_poll(struct file *file, struct poll_table_struct *poll);
1087 ssize_t afu_read(struct file *file, char __user *buf, size_t count, loff_t *off);
1088 extern const struct file_operations afu_fops;
1089 
1090 struct cxl *cxl_guest_init_adapter(struct device_node *np, struct platform_device *dev);
1091 void cxl_guest_remove_adapter(struct cxl *adapter);
1092 int cxl_of_read_adapter_handle(struct cxl *adapter, struct device_node *np);
1093 int cxl_of_read_adapter_properties(struct cxl *adapter, struct device_node *np);
1094 ssize_t cxl_guest_read_adapter_vpd(struct cxl *adapter, void *buf, size_t len);
1095 ssize_t cxl_guest_read_afu_vpd(struct cxl_afu *afu, void *buf, size_t len);
1096 int cxl_guest_init_afu(struct cxl *adapter, int slice, struct device_node *afu_np);
1097 void cxl_guest_remove_afu(struct cxl_afu *afu);
1098 int cxl_of_read_afu_handle(struct cxl_afu *afu, struct device_node *afu_np);
1099 int cxl_of_read_afu_properties(struct cxl_afu *afu, struct device_node *afu_np);
1100 int cxl_guest_add_chardev(struct cxl *adapter);
1101 void cxl_guest_remove_chardev(struct cxl *adapter);
1102 void cxl_guest_reload_module(struct cxl *adapter);
1103 int cxl_of_probe(struct platform_device *pdev);
1104 
1105 struct cxl_backend_ops {
1106 	struct module *module;
1107 	int (*adapter_reset)(struct cxl *adapter);
1108 	int (*alloc_one_irq)(struct cxl *adapter);
1109 	void (*release_one_irq)(struct cxl *adapter, int hwirq);
1110 	int (*alloc_irq_ranges)(struct cxl_irq_ranges *irqs,
1111 				struct cxl *adapter, unsigned int num);
1112 	void (*release_irq_ranges)(struct cxl_irq_ranges *irqs,
1113 				struct cxl *adapter);
1114 	int (*setup_irq)(struct cxl *adapter, unsigned int hwirq,
1115 			unsigned int virq);
1116 	irqreturn_t (*handle_psl_slice_error)(struct cxl_context *ctx,
1117 					u64 dsisr, u64 errstat);
1118 	irqreturn_t (*psl_interrupt)(int irq, void *data);
1119 	int (*ack_irq)(struct cxl_context *ctx, u64 tfc, u64 psl_reset_mask);
1120 	void (*irq_wait)(struct cxl_context *ctx);
1121 	int (*attach_process)(struct cxl_context *ctx, bool kernel,
1122 			u64 wed, u64 amr);
1123 	int (*detach_process)(struct cxl_context *ctx);
1124 	void (*update_ivtes)(struct cxl_context *ctx);
1125 	bool (*support_attributes)(const char *attr_name, enum cxl_attrs type);
1126 	bool (*link_ok)(struct cxl *cxl, struct cxl_afu *afu);
1127 	void (*release_afu)(struct device *dev);
1128 	ssize_t (*afu_read_err_buffer)(struct cxl_afu *afu, char *buf,
1129 				loff_t off, size_t count);
1130 	int (*afu_check_and_enable)(struct cxl_afu *afu);
1131 	int (*afu_activate_mode)(struct cxl_afu *afu, int mode);
1132 	int (*afu_deactivate_mode)(struct cxl_afu *afu, int mode);
1133 	int (*afu_reset)(struct cxl_afu *afu);
1134 	int (*afu_cr_read8)(struct cxl_afu *afu, int cr_idx, u64 offset, u8 *val);
1135 	int (*afu_cr_read16)(struct cxl_afu *afu, int cr_idx, u64 offset, u16 *val);
1136 	int (*afu_cr_read32)(struct cxl_afu *afu, int cr_idx, u64 offset, u32 *val);
1137 	int (*afu_cr_read64)(struct cxl_afu *afu, int cr_idx, u64 offset, u64 *val);
1138 	int (*afu_cr_write8)(struct cxl_afu *afu, int cr_idx, u64 offset, u8 val);
1139 	int (*afu_cr_write16)(struct cxl_afu *afu, int cr_idx, u64 offset, u16 val);
1140 	int (*afu_cr_write32)(struct cxl_afu *afu, int cr_idx, u64 offset, u32 val);
1141 	ssize_t (*read_adapter_vpd)(struct cxl *adapter, void *buf, size_t count);
1142 };
1143 extern const struct cxl_backend_ops cxl_native_ops;
1144 extern const struct cxl_backend_ops cxl_guest_ops;
1145 extern const struct cxl_backend_ops *cxl_ops;
1146 
1147 /* check if the given pci_dev is on the the cxl vphb bus */
1148 bool cxl_pci_is_vphb_device(struct pci_dev *dev);
1149 
1150 /* decode AFU error bits in the PSL register PSL_SERR_An */
1151 void cxl_afu_decode_psl_serr(struct cxl_afu *afu, u64 serr);
1152 
1153 /*
1154  * Increments the number of attached contexts on an adapter.
1155  * In case an adapter_context_lock is taken the return -EBUSY.
1156  */
1157 int cxl_adapter_context_get(struct cxl *adapter);
1158 
1159 /* Decrements the number of attached contexts on an adapter */
1160 void cxl_adapter_context_put(struct cxl *adapter);
1161 
1162 /* If no active contexts then prevents contexts from being attached */
1163 int cxl_adapter_context_lock(struct cxl *adapter);
1164 
1165 /* Unlock the contexts-lock if taken. Warn and force unlock otherwise */
1166 void cxl_adapter_context_unlock(struct cxl *adapter);
1167 
1168 /* Increases the reference count to "struct mm_struct" */
1169 void cxl_context_mm_count_get(struct cxl_context *ctx);
1170 
1171 /* Decrements the reference count to "struct mm_struct" */
1172 void cxl_context_mm_count_put(struct cxl_context *ctx);
1173 
1174 #endif
1175