xref: /openbmc/linux/drivers/scsi/cxlflash/sislite.h (revision f7d84fa7)
1 /*
2  * CXL Flash Device Driver
3  *
4  * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5  *             Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
6  *
7  * Copyright (C) 2015 IBM Corporation
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version
12  * 2 of the License, or (at your option) any later version.
13  */
14 
15 #ifndef _SISLITE_H
16 #define _SISLITE_H
17 
18 #include <linux/types.h>
19 
20 typedef u16 ctx_hndl_t;
21 typedef u32 res_hndl_t;
22 
23 #define SIZE_4K		4096
24 #define SIZE_64K	65536
25 
26 /*
27  * IOARCB: 64 bytes, min 16 byte alignment required, host native endianness
28  * except for SCSI CDB which remains big endian per SCSI standards.
29  */
30 struct sisl_ioarcb {
31 	u16 ctx_id;		/* ctx_hndl_t */
32 	u16 req_flags;
33 #define SISL_REQ_FLAGS_RES_HNDL       0x8000U	/* bit 0 (MSB) */
34 #define SISL_REQ_FLAGS_PORT_LUN_ID    0x0000U
35 
36 #define SISL_REQ_FLAGS_SUP_UNDERRUN   0x4000U	/* bit 1 */
37 
38 #define SISL_REQ_FLAGS_TIMEOUT_SECS   0x0000U	/* bits 8,9 */
39 #define SISL_REQ_FLAGS_TIMEOUT_MSECS  0x0040U
40 #define SISL_REQ_FLAGS_TIMEOUT_USECS  0x0080U
41 #define SISL_REQ_FLAGS_TIMEOUT_CYCLES 0x00C0U
42 
43 #define SISL_REQ_FLAGS_TMF_CMD        0x0004u	/* bit 13 */
44 
45 #define SISL_REQ_FLAGS_AFU_CMD        0x0002U	/* bit 14 */
46 
47 #define SISL_REQ_FLAGS_HOST_WRITE     0x0001U	/* bit 15 (LSB) */
48 #define SISL_REQ_FLAGS_HOST_READ      0x0000U
49 
50 	union {
51 		u32 res_hndl;	/* res_hndl_t */
52 		u32 port_sel;	/* this is a selection mask:
53 				 * 0x1 -> port#0 can be selected,
54 				 * 0x2 -> port#1 can be selected.
55 				 * Can be bitwise ORed.
56 				 */
57 	};
58 	u64 lun_id;
59 	u32 data_len;		/* 4K for read/write */
60 	u32 ioadl_len;
61 	union {
62 		u64 data_ea;	/* min 16 byte aligned */
63 		u64 ioadl_ea;
64 	};
65 	u8 msi;			/* LISN to send on RRQ write */
66 #define SISL_MSI_CXL_PFAULT        0	/* reserved for CXL page faults */
67 #define SISL_MSI_SYNC_ERROR        1	/* recommended for AFU sync error */
68 #define SISL_MSI_RRQ_UPDATED       2	/* recommended for IO completion */
69 #define SISL_MSI_ASYNC_ERROR       3	/* master only - for AFU async error */
70 
71 	u8 rrq;			/* 0 for a single RRQ */
72 	u16 timeout;		/* in units specified by req_flags */
73 	u32 rsvd1;
74 	u8 cdb[16];		/* must be in big endian */
75 	union {
76 		u64 reserved;			/* Reserved for IOARRIN mode */
77 		struct sisl_ioasa *ioasa;	/* IOASA EA for SQ Mode */
78 	};
79 } __packed;
80 
81 struct sisl_rc {
82 	u8 flags;
83 #define SISL_RC_FLAGS_SENSE_VALID         0x80U
84 #define SISL_RC_FLAGS_FCP_RSP_CODE_VALID  0x40U
85 #define SISL_RC_FLAGS_OVERRUN             0x20U
86 #define SISL_RC_FLAGS_UNDERRUN            0x10U
87 
88 	u8 afu_rc;
89 #define SISL_AFU_RC_RHT_INVALID           0x01U	/* user error */
90 #define SISL_AFU_RC_RHT_UNALIGNED         0x02U	/* should never happen */
91 #define SISL_AFU_RC_RHT_OUT_OF_BOUNDS     0x03u	/* user error */
92 #define SISL_AFU_RC_RHT_DMA_ERR           0x04u	/* see afu_extra
93 						 * may retry if afu_retry is off
94 						 * possible on master exit
95 						 */
96 #define SISL_AFU_RC_RHT_RW_PERM           0x05u	/* no RW perms, user error */
97 #define SISL_AFU_RC_LXT_UNALIGNED         0x12U	/* should never happen */
98 #define SISL_AFU_RC_LXT_OUT_OF_BOUNDS     0x13u	/* user error */
99 #define SISL_AFU_RC_LXT_DMA_ERR           0x14u	/* see afu_extra
100 						 * may retry if afu_retry is off
101 						 * possible on master exit
102 						 */
103 #define SISL_AFU_RC_LXT_RW_PERM           0x15u	/* no RW perms, user error */
104 
105 #define SISL_AFU_RC_NOT_XLATE_HOST        0x1au	/* possible if master exited */
106 
107 	/* NO_CHANNELS means the FC ports selected by dest_port in
108 	 * IOARCB or in the LXT entry are down when the AFU tried to select
109 	 * a FC port. If the port went down on an active IO, it will set
110 	 * fc_rc to =0x54(NOLOGI) or 0x57(LINKDOWN) instead.
111 	 */
112 #define SISL_AFU_RC_NO_CHANNELS           0x20U	/* see afu_extra, may retry */
113 #define SISL_AFU_RC_CAP_VIOLATION         0x21U	/* either user error or
114 						 * afu reset/master restart
115 						 */
116 #define SISL_AFU_RC_OUT_OF_DATA_BUFS      0x30U	/* always retry */
117 #define SISL_AFU_RC_DATA_DMA_ERR          0x31U	/* see afu_extra
118 						 * may retry if afu_retry is off
119 						 */
120 
121 	u8 scsi_rc;		/* SCSI status byte, retry as appropriate */
122 #define SISL_SCSI_RC_CHECK                0x02U
123 #define SISL_SCSI_RC_BUSY                 0x08u
124 
125 	u8 fc_rc;		/* retry */
126 	/*
127 	 * We should only see fc_rc=0x57 (LINKDOWN) or 0x54(NOLOGI) for
128 	 * commands that are in flight when a link goes down or is logged out.
129 	 * If the link is down or logged out before AFU selects the port, either
130 	 * it will choose the other port or we will get afu_rc=0x20 (no_channel)
131 	 * if there is no valid port to use.
132 	 *
133 	 * ABORTPEND/ABORTOK/ABORTFAIL/TGTABORT can be retried, typically these
134 	 * would happen if a frame is dropped and something times out.
135 	 * NOLOGI or LINKDOWN can be retried if the other port is up.
136 	 * RESIDERR can be retried as well.
137 	 *
138 	 * ABORTFAIL might indicate that lots of frames are getting CRC errors.
139 	 * So it maybe retried once and reset the link if it happens again.
140 	 * The link can also be reset on the CRC error threshold interrupt.
141 	 */
142 #define SISL_FC_RC_ABORTPEND	0x52	/* exchange timeout or abort request */
143 #define SISL_FC_RC_WRABORTPEND	0x53	/* due to write XFER_RDY invalid */
144 #define SISL_FC_RC_NOLOGI	0x54	/* port not logged in, in-flight cmds */
145 #define SISL_FC_RC_NOEXP	0x55	/* FC protocol error or HW bug */
146 #define SISL_FC_RC_INUSE	0x56	/* tag already in use, HW bug */
147 #define SISL_FC_RC_LINKDOWN	0x57	/* link down, in-flight cmds */
148 #define SISL_FC_RC_ABORTOK	0x58	/* pending abort completed w/success */
149 #define SISL_FC_RC_ABORTFAIL	0x59	/* pending abort completed w/fail */
150 #define SISL_FC_RC_RESID	0x5A	/* ioasa underrun/overrun flags set */
151 #define SISL_FC_RC_RESIDERR	0x5B	/* actual data len does not match SCSI
152 					 * reported len, possibly due to dropped
153 					 * frames
154 					 */
155 #define SISL_FC_RC_TGTABORT	0x5C	/* command aborted by target */
156 };
157 
158 #define SISL_SENSE_DATA_LEN     20	/* Sense data length         */
159 
160 /*
161  * IOASA: 64 bytes & must follow IOARCB, min 16 byte alignment required,
162  * host native endianness
163  */
164 struct sisl_ioasa {
165 	union {
166 		struct sisl_rc rc;
167 		u32 ioasc;
168 #define SISL_IOASC_GOOD_COMPLETION        0x00000000U
169 	};
170 	u32 resid;
171 	u8 port;
172 	u8 afu_extra;
173 	/* when afu_rc=0x04, 0x14, 0x31 (_xxx_DMA_ERR):
174 	 * afu_exta contains PSL response code. Useful codes are:
175 	 */
176 #define SISL_AFU_DMA_ERR_PAGE_IN	0x0A	/* AFU_retry_on_pagein Action
177 						 *  Enabled            N/A
178 						 *  Disabled           retry
179 						 */
180 #define SISL_AFU_DMA_ERR_INVALID_EA	0x0B	/* this is a hard error
181 						 * afu_rc	Implies
182 						 * 0x04, 0x14	master exit.
183 						 * 0x31         user error.
184 						 */
185 	/* when afu rc=0x20 (no channels):
186 	 * afu_extra bits [4:5]: available portmask,  [6:7]: requested portmask.
187 	 */
188 #define SISL_AFU_NO_CLANNELS_AMASK(afu_extra) (((afu_extra) & 0x0C) >> 2)
189 #define SISL_AFU_NO_CLANNELS_RMASK(afu_extra) ((afu_extra) & 0x03)
190 
191 	u8 scsi_extra;
192 	u8 fc_extra;
193 	u8 sense_data[SISL_SENSE_DATA_LEN];
194 
195 	/* These fields are defined by the SISlite architecture for the
196 	 * host to use as they see fit for their implementation.
197 	 */
198 	union {
199 		u64 host_use[4];
200 		u8 host_use_b[32];
201 	};
202 } __packed;
203 
204 #define SISL_RESP_HANDLE_T_BIT        0x1ULL	/* Toggle bit */
205 
206 /* MMIO space is required to support only 64-bit access */
207 
208 /*
209  * This AFU has two mechanisms to deal with endian-ness.
210  * One is a global configuration (in the afu_config) register
211  * below that specifies the endian-ness of the host.
212  * The other is a per context (i.e. application) specification
213  * controlled by the endian_ctrl field here. Since the master
214  * context is one such application the master context's
215  * endian-ness is set to be the same as the host.
216  *
217  * As per the SISlite spec, the MMIO registers are always
218  * big endian.
219  */
220 #define SISL_ENDIAN_CTRL_BE           0x8000000000000080ULL
221 #define SISL_ENDIAN_CTRL_LE           0x0000000000000000ULL
222 
223 #ifdef __BIG_ENDIAN
224 #define SISL_ENDIAN_CTRL              SISL_ENDIAN_CTRL_BE
225 #else
226 #define SISL_ENDIAN_CTRL              SISL_ENDIAN_CTRL_LE
227 #endif
228 
229 /* per context host transport MMIO  */
230 struct sisl_host_map {
231 	__be64 endian_ctrl;	/* Per context Endian Control. The AFU will
232 				 * operate on whatever the context is of the
233 				 * host application.
234 				 */
235 
236 	__be64 intr_status;	/* this sends LISN# programmed in ctx_ctrl.
237 				 * Only recovery in a PERM_ERR is a context
238 				 * exit since there is no way to tell which
239 				 * command caused the error.
240 				 */
241 #define SISL_ISTATUS_PERM_ERR_CMDROOM    0x0010ULL	/* b59, user error */
242 #define SISL_ISTATUS_PERM_ERR_RCB_READ   0x0008ULL	/* b60, user error */
243 #define SISL_ISTATUS_PERM_ERR_SA_WRITE   0x0004ULL	/* b61, user error */
244 #define SISL_ISTATUS_PERM_ERR_RRQ_WRITE  0x0002ULL	/* b62, user error */
245 	/* Page in wait accessing RCB/IOASA/RRQ is reported in b63.
246 	 * Same error in data/LXT/RHT access is reported via IOASA.
247 	 */
248 #define SISL_ISTATUS_TEMP_ERR_PAGEIN     0x0001ULL	/* b63, can be generated
249 							 * only when AFU auto
250 							 * retry is disabled.
251 							 * If user can determine
252 							 * the command that
253 							 * caused the error, it
254 							 * can be retried.
255 							 */
256 #define SISL_ISTATUS_UNMASK  (0x001FULL)	/* 1 means unmasked */
257 #define SISL_ISTATUS_MASK    ~(SISL_ISTATUS_UNMASK)	/* 1 means masked */
258 
259 	__be64 intr_clear;
260 	__be64 intr_mask;
261 	__be64 ioarrin;		/* only write what cmd_room permits */
262 	__be64 rrq_start;	/* start & end are both inclusive */
263 	__be64 rrq_end;		/* write sequence: start followed by end */
264 	__be64 cmd_room;
265 	__be64 ctx_ctrl;	/* least significant byte or b56:63 is LISN# */
266 	__be64 mbox_w;		/* restricted use */
267 	__be64 sq_start;	/* Submission Queue (R/W): write sequence and */
268 	__be64 sq_end;		/* inclusion semantics are the same as RRQ    */
269 	__be64 sq_head;		/* Submission Queue Head (R): for debugging   */
270 	__be64 sq_tail;		/* Submission Queue TAIL (R/W): next IOARCB   */
271 	__be64 sq_ctx_reset;	/* Submission Queue Context Reset (R/W)	      */
272 };
273 
274 /* per context provisioning & control MMIO */
275 struct sisl_ctrl_map {
276 	__be64 rht_start;
277 	__be64 rht_cnt_id;
278 	/* both cnt & ctx_id args must be ULL */
279 #define SISL_RHT_CNT_ID(cnt, ctx_id)  (((cnt) << 48) | ((ctx_id) << 32))
280 
281 	__be64 ctx_cap;	/* afu_rc below is when the capability is violated */
282 #define SISL_CTX_CAP_PROXY_ISSUE       0x8000000000000000ULL /* afu_rc 0x21 */
283 #define SISL_CTX_CAP_REAL_MODE         0x4000000000000000ULL /* afu_rc 0x21 */
284 #define SISL_CTX_CAP_HOST_XLATE        0x2000000000000000ULL /* afu_rc 0x1a */
285 #define SISL_CTX_CAP_PROXY_TARGET      0x1000000000000000ULL /* afu_rc 0x21 */
286 #define SISL_CTX_CAP_AFU_CMD           0x0000000000000008ULL /* afu_rc 0x21 */
287 #define SISL_CTX_CAP_GSCSI_CMD         0x0000000000000004ULL /* afu_rc 0x21 */
288 #define SISL_CTX_CAP_WRITE_CMD         0x0000000000000002ULL /* afu_rc 0x21 */
289 #define SISL_CTX_CAP_READ_CMD          0x0000000000000001ULL /* afu_rc 0x21 */
290 	__be64 mbox_r;
291 };
292 
293 /* single copy global regs */
294 struct sisl_global_regs {
295 	__be64 aintr_status;
296 	/*
297 	 * In cxlflash, FC port/link are arranged in port pairs, each
298 	 * gets a byte of status:
299 	 *
300 	 *	*_OTHER:	other err, FC_ERRCAP[31:20]
301 	 *	*_LOGO:		target sent FLOGI/PLOGI/LOGO while logged in
302 	 *	*_CRC_T:	CRC threshold exceeded
303 	 *	*_LOGI_R:	login state machine timed out and retrying
304 	 *	*_LOGI_F:	login failed, FC_ERROR[19:0]
305 	 *	*_LOGI_S:	login succeeded
306 	 *	*_LINK_DN:	link online to offline
307 	 *	*_LINK_UP:	link offline to online
308 	 */
309 #define SISL_ASTATUS_FC2_OTHER	 0x80000000ULL /* b32 */
310 #define SISL_ASTATUS_FC2_LOGO    0x40000000ULL /* b33 */
311 #define SISL_ASTATUS_FC2_CRC_T   0x20000000ULL /* b34 */
312 #define SISL_ASTATUS_FC2_LOGI_R  0x10000000ULL /* b35 */
313 #define SISL_ASTATUS_FC2_LOGI_F  0x08000000ULL /* b36 */
314 #define SISL_ASTATUS_FC2_LOGI_S  0x04000000ULL /* b37 */
315 #define SISL_ASTATUS_FC2_LINK_DN 0x02000000ULL /* b38 */
316 #define SISL_ASTATUS_FC2_LINK_UP 0x01000000ULL /* b39 */
317 
318 #define SISL_ASTATUS_FC3_OTHER   0x00800000ULL /* b40 */
319 #define SISL_ASTATUS_FC3_LOGO    0x00400000ULL /* b41 */
320 #define SISL_ASTATUS_FC3_CRC_T   0x00200000ULL /* b42 */
321 #define SISL_ASTATUS_FC3_LOGI_R  0x00100000ULL /* b43 */
322 #define SISL_ASTATUS_FC3_LOGI_F  0x00080000ULL /* b44 */
323 #define SISL_ASTATUS_FC3_LOGI_S  0x00040000ULL /* b45 */
324 #define SISL_ASTATUS_FC3_LINK_DN 0x00020000ULL /* b46 */
325 #define SISL_ASTATUS_FC3_LINK_UP 0x00010000ULL /* b47 */
326 
327 #define SISL_ASTATUS_FC0_OTHER	 0x00008000ULL /* b48 */
328 #define SISL_ASTATUS_FC0_LOGO    0x00004000ULL /* b49 */
329 #define SISL_ASTATUS_FC0_CRC_T   0x00002000ULL /* b50 */
330 #define SISL_ASTATUS_FC0_LOGI_R  0x00001000ULL /* b51 */
331 #define SISL_ASTATUS_FC0_LOGI_F  0x00000800ULL /* b52 */
332 #define SISL_ASTATUS_FC0_LOGI_S  0x00000400ULL /* b53 */
333 #define SISL_ASTATUS_FC0_LINK_DN 0x00000200ULL /* b54 */
334 #define SISL_ASTATUS_FC0_LINK_UP 0x00000100ULL /* b55 */
335 
336 #define SISL_ASTATUS_FC1_OTHER   0x00000080ULL /* b56 */
337 #define SISL_ASTATUS_FC1_LOGO    0x00000040ULL /* b57 */
338 #define SISL_ASTATUS_FC1_CRC_T   0x00000020ULL /* b58 */
339 #define SISL_ASTATUS_FC1_LOGI_R  0x00000010ULL /* b59 */
340 #define SISL_ASTATUS_FC1_LOGI_F  0x00000008ULL /* b60 */
341 #define SISL_ASTATUS_FC1_LOGI_S  0x00000004ULL /* b61 */
342 #define SISL_ASTATUS_FC1_LINK_DN 0x00000002ULL /* b62 */
343 #define SISL_ASTATUS_FC1_LINK_UP 0x00000001ULL /* b63 */
344 
345 #define SISL_FC_INTERNAL_UNMASK	0x0000000300000000ULL	/* 1 means unmasked */
346 #define SISL_FC_INTERNAL_MASK	~(SISL_FC_INTERNAL_UNMASK)
347 #define SISL_FC_INTERNAL_SHIFT	32
348 
349 #define SISL_FC_SHUTDOWN_NORMAL		0x0000000000000010ULL
350 #define SISL_FC_SHUTDOWN_ABRUPT		0x0000000000000020ULL
351 
352 #define SISL_STATUS_SHUTDOWN_ACTIVE	0x0000000000000010ULL
353 #define SISL_STATUS_SHUTDOWN_COMPLETE	0x0000000000000020ULL
354 
355 #define SISL_ASTATUS_UNMASK	0xFFFFFFFFULL		/* 1 means unmasked */
356 #define SISL_ASTATUS_MASK	~(SISL_ASTATUS_UNMASK)	/* 1 means masked */
357 
358 	__be64 aintr_clear;
359 	__be64 aintr_mask;
360 	__be64 afu_ctrl;
361 	__be64 afu_hb;
362 	__be64 afu_scratch_pad;
363 	__be64 afu_port_sel;
364 #define SISL_AFUCONF_AR_IOARCB	0x4000ULL
365 #define SISL_AFUCONF_AR_LXT	0x2000ULL
366 #define SISL_AFUCONF_AR_RHT	0x1000ULL
367 #define SISL_AFUCONF_AR_DATA	0x0800ULL
368 #define SISL_AFUCONF_AR_RSRC	0x0400ULL
369 #define SISL_AFUCONF_AR_IOASA	0x0200ULL
370 #define SISL_AFUCONF_AR_RRQ	0x0100ULL
371 /* Aggregate all Auto Retry Bits */
372 #define SISL_AFUCONF_AR_ALL	(SISL_AFUCONF_AR_IOARCB|SISL_AFUCONF_AR_LXT| \
373 				 SISL_AFUCONF_AR_RHT|SISL_AFUCONF_AR_DATA|   \
374 				 SISL_AFUCONF_AR_RSRC|SISL_AFUCONF_AR_IOASA| \
375 				 SISL_AFUCONF_AR_RRQ)
376 #ifdef __BIG_ENDIAN
377 #define SISL_AFUCONF_ENDIAN            0x0000ULL
378 #else
379 #define SISL_AFUCONF_ENDIAN            0x0020ULL
380 #endif
381 #define SISL_AFUCONF_MBOX_CLR_READ     0x0010ULL
382 	__be64 afu_config;
383 	__be64 rsvd[0xf8];
384 	__le64 afu_version;
385 	__be64 interface_version;
386 #define SISL_INTVER_CAP_SHIFT			16
387 #define SISL_INTVER_MAJ_SHIFT			8
388 #define SISL_INTVER_CAP_MASK			0xFFFFFFFF00000000ULL
389 #define SISL_INTVER_MAJ_MASK			0x00000000FFFF0000ULL
390 #define SISL_INTVER_MIN_MASK			0x000000000000FFFFULL
391 #define SISL_INTVER_CAP_IOARRIN_CMD_MODE	0x800000000000ULL
392 #define SISL_INTVER_CAP_SQ_CMD_MODE		0x400000000000ULL
393 #define SISL_INTVER_CAP_RESERVED_CMD_MODE_A	0x200000000000ULL
394 #define SISL_INTVER_CAP_RESERVED_CMD_MODE_B	0x100000000000ULL
395 };
396 
397 #define CXLFLASH_NUM_FC_PORTS_PER_BANK	2	/* fixed # of ports per bank */
398 #define CXLFLASH_MAX_FC_BANKS		2	/* max # of banks supported */
399 #define CXLFLASH_MAX_FC_PORTS	(CXLFLASH_NUM_FC_PORTS_PER_BANK *	\
400 				 CXLFLASH_MAX_FC_BANKS)
401 #define CXLFLASH_MAX_CONTEXT	512	/* number of contexts per AFU */
402 #define CXLFLASH_NUM_VLUNS	512	/* number of vluns per AFU/port */
403 #define CXLFLASH_NUM_REGS	512	/* number of registers per port */
404 
405 struct fc_port_bank {
406 	__be64 fc_port_regs[CXLFLASH_NUM_FC_PORTS_PER_BANK][CXLFLASH_NUM_REGS];
407 	__be64 fc_port_luns[CXLFLASH_NUM_FC_PORTS_PER_BANK][CXLFLASH_NUM_VLUNS];
408 };
409 
410 struct sisl_global_map {
411 	union {
412 		struct sisl_global_regs regs;
413 		char page0[SIZE_4K];	/* page 0 */
414 	};
415 
416 	char page1[SIZE_4K];	/* page 1 */
417 
418 	struct fc_port_bank bank[CXLFLASH_MAX_FC_BANKS]; /* pages 2 - 9 */
419 
420 	/* pages 10 - 15 are reserved */
421 
422 };
423 
424 /*
425  * CXL Flash Memory Map
426  *
427  *	+-------------------------------+
428  *	|    512 * 64 KB User MMIO      |
429  *	|        (per context)          |
430  *	|       User Accessible         |
431  *	+-------------------------------+
432  *	|    512 * 128 B per context    |
433  *	|    Provisioning and Control   |
434  *	|   Trusted Process accessible  |
435  *	+-------------------------------+
436  *	|         64 KB Global          |
437  *	|   Trusted Process accessible  |
438  *	+-------------------------------+
439  */
440 struct cxlflash_afu_map {
441 	union {
442 		struct sisl_host_map host;
443 		char harea[SIZE_64K];	/* 64KB each */
444 	} hosts[CXLFLASH_MAX_CONTEXT];
445 
446 	union {
447 		struct sisl_ctrl_map ctrl;
448 		char carea[cache_line_size()];	/* 128B each */
449 	} ctrls[CXLFLASH_MAX_CONTEXT];
450 
451 	union {
452 		struct sisl_global_map global;
453 		char garea[SIZE_64K];	/* 64KB single block */
454 	};
455 };
456 
457 /*
458  * LXT - LBA Translation Table
459  * LXT control blocks
460  */
461 struct sisl_lxt_entry {
462 	u64 rlba_base;	/* bits 0:47 is base
463 			 * b48:55 is lun index
464 			 * b58:59 is write & read perms
465 			 * (if no perm, afu_rc=0x15)
466 			 * b60:63 is port_sel mask
467 			 */
468 };
469 
470 /*
471  * RHT - Resource Handle Table
472  * Per the SISlite spec, RHT entries are to be 16-byte aligned
473  */
474 struct sisl_rht_entry {
475 	struct sisl_lxt_entry *lxt_start;
476 	u32 lxt_cnt;
477 	u16 rsvd;
478 	u8 fp;			/* format & perm nibbles.
479 				 * (if no perm, afu_rc=0x05)
480 				 */
481 	u8 nmask;
482 } __packed __aligned(16);
483 
484 struct sisl_rht_entry_f1 {
485 	u64 lun_id;
486 	union {
487 		struct {
488 			u8 valid;
489 			u8 rsvd[5];
490 			u8 fp;
491 			u8 port_sel;
492 		};
493 
494 		u64 dw;
495 	};
496 } __packed __aligned(16);
497 
498 /* make the fp byte */
499 #define SISL_RHT_FP(fmt, perm) (((fmt) << 4) | (perm))
500 
501 /* make the fp byte for a clone from a source fp and clone flags
502  * flags must be only 2 LSB bits.
503  */
504 #define SISL_RHT_FP_CLONE(src_fp, cln_flags) ((src_fp) & (0xFC | (cln_flags)))
505 
506 #define RHT_PERM_READ  0x01U
507 #define RHT_PERM_WRITE 0x02U
508 #define RHT_PERM_RW    (RHT_PERM_READ | RHT_PERM_WRITE)
509 
510 /* extract the perm bits from a fp */
511 #define SISL_RHT_PERM(fp) ((fp) & RHT_PERM_RW)
512 
513 #define PORT0  0x01U
514 #define PORT1  0x02U
515 #define PORT2  0x04U
516 #define PORT3  0x08U
517 #define PORT_MASK(_n)	((1 << (_n)) - 1)
518 
519 /* AFU Sync Mode byte */
520 #define AFU_LW_SYNC 0x0U
521 #define AFU_HW_SYNC 0x1U
522 #define AFU_GSYNC   0x2U
523 
524 /* Special Task Management Function CDB */
525 #define TMF_LUN_RESET  0x1U
526 #define TMF_CLEAR_ACA  0x2U
527 
528 
529 #define SISLITE_MAX_WS_BLOCKS 512
530 
531 #endif /* _SISLITE_H */
532