drivers/scsi/cxlflash/sislite.h

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