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