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