do a bit of cleanup on some target mode structures and clarify a couple other minro things

This commit is contained in:
Matt Jacob 1998-12-05 01:29:43 +00:00
parent 9f8afea40b
commit ff717ff328

View File

@ -1,4 +1,5 @@
/* $Id: ispmbox.h,v 1.7 1998/09/14 23:23:26 mjacob Exp $ */
/* $Id: $ */
/* ispmbox 1.10 */
/*
* Mailbox and Queue Entry Definitions for for Qlogic ISP SCSI adapters.
*
@ -153,7 +154,7 @@ typedef struct {
#define ASYNC_RSP_XFER_ERR 0x8004
#define ASYNC_QWAKEUP 0x8005
#define ASYNC_TIMEOUT_RESET 0x8006
#define ASYNC_UNSPEC_TMODE 0x8007
#define ASYNC_DEVICE_RESET 0x8007
#define ASYNC_EXTMSG_UNDERRUN 0x800A
#define ASYNC_SCAM_INT 0x800B
#define ASYNC_HUNG_SCSI 0x800C
@ -167,7 +168,7 @@ typedef struct {
#define ASYNC_LOOP_UP 0x8011
#define ASYNC_LOOP_DOWN 0x8012
#define ASYNC_LOOP_RESET 0x8013
#define ASYNC_PDB_CHANGED 0x8014 /* Port Database Changed */
#define ASYNC_PDB_CHANGED 0x8014
#define ASYNC_CHANGE_NOTIFY 0x8015
/*
@ -241,7 +242,7 @@ typedef struct {
u_int16_t req_cdblen;
#define req_modifier req_cdblen /* marker packet */
u_int16_t req_flags;
u_int16_t _res1;
u_int16_t req_reserved;
u_int16_t req_time;
u_int16_t req_seg_count;
u_int8_t req_cdb[12];
@ -259,7 +260,7 @@ typedef struct {
u_int8_t req_lun_trn;
u_int8_t req_target;
#endif
u_int16_t _res1;
u_int16_t req_scclun;
u_int16_t req_flags;
u_int16_t _res2;
u_int16_t req_time;
@ -424,169 +425,7 @@ typedef struct {
#define RQSTF_NEGOTIATION 0x0080
/*
* Target Mode Structures
*/
/*
* Used for Enable LUN and Modify Lun types.
* (for FC, pre-1.14 FW layout revision).
*/
typedef struct {
isphdr_t req_header;
u_int32_t req_handle;
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t _reserved0;
u_int8_t req_lun; /* HOST->FW: LUN to enable */
#else
u_int8_t req_lun; /* HOST->FW: LUN to enable */
u_int8_t _reserved0;
#endif
u_int16_t _reserved1[3];
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t _reserved2;
u_int8_t req_status; /* FW->HOST: Status of Request */
u_int8_t req_imcount; /* HOST->FW: Immediate Notify Count */
u_int8_t req_cmdcount; /* HOST->FW: ATIO Count */
#else
u_int8_t req_status; /* FW->HOST: Status of Request */
u_int8_t _reserved2;
u_int8_t req_cmdcount; /* HOST->FW: ATIO Count */
u_int8_t req_imcount; /* HOST->FW: Immediate Notify Count */
#endif
u_int16_t _reserved3;
u_int16_t req_timeout; /* HOST->FW: Lun timeout value */
} isplun_t;
/* inbound status */
#define LUN_OKAY 0x01
#define LUN_ERR 0x04
#define LUN_NOCAP 0x16
#define LUN_ENABLED 0x3e
/* outbound flags */
#define LUN_INCR_CMD 0x0001
#define LUN_DECR_CMD 0x0002
#define LUN_INCR_IMMED 0x0100
#define LUN_DECR_IMMED 0x0200
typedef struct {
isphdr_t req_header;
u_int32_t req_handle;
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t req_initiator;
u_int8_t req_lun;
#else
u_int8_t req_lun;
u_int8_t req_initiator;
#endif
u_int16_t req_flags; /* NOTIFY_ACK only */
u_int16_t _reserved1[2];
u_int16_t req_status;
u_int16_t req_task_flags;
u_int16_t req_sequence;
} ispnotify_t;
#define IN_NOCAP 0x16
#define IN_IDE_RECEIVED 0x33
#define IN_RSRC_UNAVAIL 0x34
#define IN_MSG_RECEIVED 0x36
typedef struct {
isphdr_t req_header;
u_int32_t req_handle;
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t req_initiator;
u_int8_t req_lun;
#else
u_int8_t req_lun;
u_int8_t req_initiator;
#endif
u_int16_t req_rxid;
u_int16_t req_flags;
u_int16_t req_status;
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t req_taskcodes;
u_int8_t _reserved0;
u_int8_t req_execodes;
u_int8_t req_taskflags;
#else
u_int8_t _reserved0;
u_int8_t req_taskcodes;
u_int8_t req_taskflags;
u_int8_t req_execodes;
#endif
u_int8_t req_cdb[16];
u_int32_t req_datalen;
u_int16_t req_scclun;
u_int16_t _reserved1;;
u_int16_t req_scsi_status;
u_int8_t req_sense[18];
} ispatiot2_t;
#define ATIO_PATH_INVALID 0x07
#define ATIO_PHASE_ERROR 0x14
#define ATIO_NOCAP 0x16
#define ATIO_BDR_MSG 0x17
#define ATIO_CDB_RECEIVED 0x3d
#define ATIO_SENSEVALID 0x80
/*
* Continue Target I/O, type 2
*/
typedef struct {
isphdr_t req_header;
u_int32_t req_handle;
#if BYTE_ORDER == BIG_ENDIAN
u_int8_t req_initiator;
u_int8_t req_lun;
#else
u_int8_t req_lun;
u_int8_t req_initiator;
#endif
u_int16_t req_rxid;
u_int16_t req_flags;
u_int16_t req_status;
u_int16_t req_timeout;
u_int16_t req_seg_count; /* data segment count */
u_int8_t req_reloff[4]; /* relative offset */
u_int8_t req_resid[4]; /* residual */
u_int8_t _reserved0[4];
union { /* should be offset 0x20 */
struct {
u_int16_t _reserved0;
u_int16_t req_scsi_status;
u_int32_t req_datalen;
ispds_t req_dataseg[ISP_RQDSEG_T2];
} mode0;
struct {
u_int16_t req_sense_len;
u_int16_t req_scsi_status;
u_int32_t req_response_length;
u_int8_t req_response[26];
} mode1;
struct {
u_int16_t _reserved0[2];
u_int32_t req_datalen;
ispds_t req_fcpiudata;
} mode2;
} req_m;
} ispctiot2_t;
#define CTIO_SEND_STATUS 0x8000
#define CTIO_SEND_DATA 0x0040 /* To initiator */
#define CTIO_RECV_DATA 0x0080
#define CTIO_NODATA 0x00C0
#define CTIO2_SMODE0 0x0000
#define CTIO2_SMODE1 0x0001
#define CTIO2_SMODE2 0x0002
#define CTIO2_RESP_VALID 0x0100
#define CTIO2_STATUS_VALID 0x0200
#define CTIO2_RSPOVERUN 0x0400
#define CTIO2_RSPUNDERUN 0x0800
/*
* FC (ISP2100) specific data structures
* FC (ISP2100) specific initialization data structures
*/
/*
@ -659,16 +498,6 @@ typedef struct {
#define RQRSP_ADDR4863 3
#if BYTE_ORDER == BIG_ENDIAN
#define ICB_NNM0 6
#define ICB_NNM1 7
#define ICB_NNM2 4
#define ICB_NNM3 5
#define ICB_NNM4 2
#define ICB_NNM5 3
#define ICB_NNM6 0
#define ICB_NNM7 1
#else
#define ICB_NNM0 7
#define ICB_NNM1 6
#define ICB_NNM2 5
@ -677,7 +506,6 @@ typedef struct {
#define ICB_NNM5 2
#define ICB_NNM6 1
#define ICB_NNM7 0
#endif
#define MAKE_NODE_NAME_FROM_WWN(array, wwn) \
array[ICB_NNM0] = (u_int8_t) ((wwn >> 0) & 0xff), \
@ -689,4 +517,425 @@ typedef struct {
array[ICB_NNM6] = (u_int8_t) ((wwn >> 48) & 0xff), \
array[ICB_NNM7] = (u_int8_t) ((wwn >> 56) & 0xff)
/*
* Target Mode Structures
*/
#define TGTSVALID 0x80 /* scsi status & sense data valid */
#define SUGGSENSELEN 18
/*
* Structure for Enable Lun and Modify Lun queue entries
*/
typedef struct {
isphdr_t le_header;
u_int32_t le_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t le_lun;
u_int8_t le_rsvd;
u_int8_t le_ops; /* Modify LUN only */
u_int8_t le_tgt; /* Not for FC */
#endif
u_int32_t le_flags; /* Not for FC */
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t le_status;
u_int8_t le_rsvd2;
u_int8_t le_cmd_count;
u_int8_t le_in_count;
u_int8_t le_cdb6len; /* Not for FC */
u_int8_t le_cdb7len; /* Not for FC */
#endif
u_int16_t le_timeout;
u_int16_t le_reserved[20];
} lun_entry_t;
/*
* le_flags values
*/
#define LUN_TQAE 0x00000001 /* Tagged Queue Action Enable */
#define LUN_DSSM 0x01000000 /* Disable Sending SDP Message */
#define LUN_DM 0x40000000 /* Disconnects Mandatory */
/*
* le_ops values
*/
#define LUN_CCINCR 0x01 /* increment command count */
#define LUN_CCDECR 0x02 /* decrement command count */
#define LUN_ININCR 0x40 /* increment immed. notify count */
#define LUN_INDECR 0x80 /* decrement immed. notify count */
/*
* le_status values
*/
#define LUN_ERR 0x04 /* request completed with error */
#define LUN_INVAL 0x06 /* invalid request */
#define LUN_NOCAP 0x16 /* can't provide requested capability */
#define LUN_ENABLED 0x3E /* LUN already enabled */
/*
* Immediate Notify Entry structure
*/
#define IN_MSGLEN 8 /* 8 bytes */
#define IN_RSVDLEN 8 /* 8 words */
typedef struct {
isphdr_t in_header;
u_int32_t in_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t in_lun; /* lun */
u_int8_t in_iid; /* initiator */
u_int8_t in_rsvd;
u_int8_t in_tgt; /* target */
#endif
u_int32_t in_flags;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t in_status;
u_int8_t in_rsvd2;
u_int8_t in_tag_val; /* tag value */
u_int8_t in_tag_type; /* tag type */
#endif
u_int16_t in_seqid; /* sequence id */
u_int8_t in_msg[IN_MSGLEN]; /* SCSI message bytes */
u_int16_t in_reserved[IN_RSVDLEN];
u_int8_t in_sense[SUGGSENSELEN]; /* suggested sense data */
} in_entry_t;
typedef struct {
isphdr_t in_header;
u_int32_t in_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t in_lun; /* lun */
u_int8_t in_iid; /* initiator */
#endif
u_int16_t in_rsvd;
u_int32_t in_rsvd2;
u_int16_t in_status;
u_int16_t in_task_flags;
u_int16_t in_seqid; /* sequence id */
} in_fcentry_t;
/*
* Values for the in_status field
*/
#define IN_NO_RCAP 0x16 /* requested capability not available */
#define IN_IDE_RECEIVED 0x33 /* Initiator Detected Error msg received */
#define IN_RSRC_UNAVAIL 0x34 /* resource unavailable */
#define IN_MSG_RECEIVED 0x36 /* SCSI message received */
#define IN_PORT_LOGOUT 0x29 /* port has logged out (FC) */
#define IN_ABORT_TASK 0x20 /* task named in RX_ID is being aborted (FC) */
/*
* Notify Acknowledge Entry structure
*/
#define NA_RSVDLEN 22
typedef struct {
isphdr_t na_header;
u_int32_t na_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t na_lun; /* lun */
u_int8_t na_iid; /* initiator */
u_int8_t na_rsvd;
u_int8_t na_tgt; /* target */
#endif
u_int32_t na_flags;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t na_status;
u_int8_t na_event;
#endif
u_int16_t na_seqid; /* sequence id */
u_int16_t na_reserved[NA_RSVDLEN];
} na_entry_t;
/*
* Value for the na_event field
*/
#define NA_RST_CLRD 0x80 /* Clear an async event notification */
#define NA2_RSVDLEN 21
typedef struct {
isphdr_t na_header;
u_int32_t na_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t na_lun; /* lun */
u_int8_t na_iid; /* initiator */
#endif
u_int16_t na_rsvd;
u_int16_t na_flags;
u_int16_t na_rsvd2;
u_int16_t na_status;
u_int16_t na_task_flags;
u_int16_t na_seqid; /* sequence id */
u_int16_t na_reserved[NA2_RSVDLEN];
} na_fcentry_t;
#define NAFC_RST_CLRD 0x40
/*
* Value for the na_event field
*/
#define NA_RST_CLRD 0x80 /* Clear an async event notification */
/*
* Accept Target I/O Entry structure
*/
#define ATIO_CDBLEN 26
typedef struct {
isphdr_t at_header;
u_int32_t at_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t at_lun; /* lun */
u_int8_t at_iid; /* initiator */
u_int8_t at_cdblen; /* cdb length */
u_int8_t at_tgt; /* target */
#endif
u_int32_t at_flags;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t at_status; /* firmware status */
u_int8_t at_scsi_status; /* scsi status */
u_int8_t at_tag_val; /* tag value */
u_int8_t at_tag_type; /* tag type */
#endif
u_int8_t at_cdb[ATIO_CDBLEN]; /* received CDB */
u_int8_t at_sense[SUGGSENSELEN]; /* suggested sense data */
} at_entry_t;
/*
* at_flags values
*/
#define AT_NODISC 0x00008000 /* disconnect disabled */
#define AT_TQAE 0x00000001 /* Tagged Queue Action enabled */
/*
* at_status values
*/
#define AT_PATH_INVALID 0x07 /* ATIO sent to firmware for disabled lun */
#define AT_PHASE_ERROR 0x14 /* Bus phase sequence error */
#define AT_NOCAP 0x16 /* Requested capability not available */
#define AT_BDR_MSG 0x17 /* Bus Device Reset msg received */
#define AT_CDB 0x3D /* CDB received */
/*
* Accept Target I/O Entry structure, Type 2
*/
#define ATIO2_CDBLEN 16
typedef struct {
isphdr_t at_header;
u_int32_t at_reserved2;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t at_lun; /* lun */
u_int8_t at_iid; /* initiator */
#endif
u_int16_t at_rxid; /* response ID */
u_int16_t at_flags;
u_int16_t at_status; /* firmware status */
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t at_reserved1;
u_int8_t at_taskcodes;
u_int8_t at_taskflags;
u_int8_t at_execodes;
#endif
u_int8_t at_cdb[ATIO2_CDBLEN]; /* received CDB */
u_int32_t at_datalen; /* allocated data len */
u_int16_t at_scclun;
u_int16_t at_reserved3;
u_int16_t at_scsi_status;
u_int8_t at_sense[SUGGSENSELEN]; /* suggested sense data */
} at2_entry_t;
#define ATIO2_TC_ATTR_MASK 0x7
#define ATIO2_TC_ATTR_SIMPLEQ 0
#define ATIO2_TC_ATTR_HEADOFQ 1
#define ATIO2_TC_ATTR_ORDERED 2
#define ATIO2_TC_ATTR_ACAQ 4
#define ATIO2_TC_ATTR_UNTAGGED 5
#define TC2TT(code) \
(((code) == ATIO2_TC_ATTR_SIMPLEQ)? 0x20 : \
(((code) == ATIO2_TC_ATTR_HEADOFQ)? 0x21 : \
(((code) == ATIO2_TC_ATTR_ORDERED)? 0x22 : \
(((code) == ATIO2_TC_ATTR_ACAQ)? 0x24 : 0))))
/*
* Continue Target I/O Entry structure
* Request from driver. The response from the
* ISP firmware is the same except that the last 18
* bytes are overwritten by suggested sense data if
* the 'autosense valid' bit is set in the status byte.
*/
typedef struct {
isphdr_t ct_header;
u_int32_t ct_reserved;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t ct_lun; /* lun */
u_int8_t ct_iid; /* initiator id */
u_int8_t ct_rsvd;
u_int8_t ct_tgt; /* our target id */
#endif
u_int32_t ct_flags;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t ct_status; /* isp status */
u_int8_t ct_scsi_status; /* scsi status */
u_int8_t ct_tag_val; /* tag value */
u_int8_t ct_tag_type; /* tag type */
#endif
u_int32_t ct_xfrlen; /* transfer length */
u_int32_t ct_resid; /* residual length */
u_int16_t ct_timeout;
u_int16_t ct_seg_count;
ispds_t ct_dataseg[ISP_RQDSEG];
} ct_entry_t;
/*
* ct_flags values
*/
#define CT_TQAE 0x00000001 /* Tagged Queue Action enable */
#define CT_DATA_IN 0x00000040 /* Data direction */
#define CT_DATA_OUT 0x00000080 /* Data direction */
#define CT_NO_DATA 0x000000C0 /* Data direction */
#define CT_DATAMASK 0x000000C0 /* Data direction */
#define CT_NODISC 0x00008000 /* Disconnects disabled */
#define CT_DSDP 0x01000000 /* Disable Save Data Pointers */
#define CT_SENDRDP 0x04000000 /* Send Restore Pointers msg */
#define CT_SENDSTATUS 0x80000000 /* Send SCSI status byte */
/*
* ct_status values
* - set by the firmware when it returns the CTIO
*/
#define CT_OK 0x01 /* completed without error */
#define CT_ABORTED 0x02 /* aborted by host */
#define CT_ERR 0x04 /* see sense data for error */
#define CT_INVAL 0x06 /* request for disabled lun */
#define CT_NOPATH 0x07 /* invalid ITL nexus */
#define CT_INVRXID 0x08 /* (FC only) Invalid RX_ID */
#define CT_RSELTMO 0x0A /* reselection timeout after 2 tries */
#define CT_TIMEOUT 0x0B /* timed out */
#define CT_RESET 0x0E /* SCSI Bus Reset occurred */
#define CT_PHASE_ERROR 0x14 /* Bus phase sequence error */
#define CT_BDR_MSG 0x17 /* Bus Device Reset msg received */
#define CT_TERMINATED 0x19 /* due to Terminate Transfer mbox cmd */
#define CT_LOGOUT 0x29 /* port logout not acknowledged yet */
#define CT_NOACK 0x35 /* Outstanding Immed. Notify. entry */
/*
* When the firmware returns a CTIO entry, it may overwrite the last
* part of the structure with sense data. This starts at offset 0x2E
* into the entry, which is in the middle of ct_dataseg[1]. Rather
* than define a new struct for this, I'm just using the sense data
* offset.
*/
#define CTIO_SENSE_OFFSET 0x2E
/*
* Entry length in u_longs. All entries are the same size so
* any one will do as the numerator.
*/
#define UINT32_ENTRY_SIZE (sizeof(at_entry_t)/sizeof(u_int32_t))
/*
* QLA2100 CTIO (type 2) entry
*/
#define MAXRESPLEN 26
typedef struct {
isphdr_t ct_header;
u_int32_t ct_reserved;
#if BYTE_ORDER == BIG_ENDIAN
#else
u_int8_t ct_lun; /* lun */
u_int8_t ct_iid; /* initiator id */
#endif
u_int16_t ct_rxid; /* response ID */
u_int16_t ct_flags;
u_int16_t ct_status; /* isp status */
u_int16_t ct_timeout;
u_int16_t ct_seg_count;
u_int32_t ct_reloff; /* relative offset */
u_int32_t ct_resid; /* residual length */
union {
/*
* The three different modes that the target driver
* can set the CTIO2 up as.
*
* The first is for sending FCP_DATA_IUs as well as
* (optionally) sending a terminal SCSI status FCP_RSP_IU.
*
* The second is for sending SCSI sense data in an FCP_RSP_IU.
* Note that no FCP_DATA_IUs will be sent.
*
* The third is for sending FCP_RSP_IUs as built specifically
* in system memory as located by the isp_dataseg.
*/
struct {
u_int32_t _reserved;
u_int16_t _reserved2;
u_int16_t ct_scsi_status;
u_int32_t ct_xfrlen;
ispds_t ct_dataseg[ISP_RQDSEG_T2];
} m0;
struct {
u_int16_t _reserved;
u_int16_t _reserved2;
u_int16_t ct_senselen;
u_int16_t ct_scsi_status;
u_int16_t ct_resplen;
u_int8_t ct_resp[MAXRESPLEN];
} m1;
struct {
u_int32_t _reserved;
u_int16_t _reserved2;
u_int16_t _reserved3;
u_int32_t ct_datalen;
ispds_t ct_fcp_rsp_iudata;
} m2;
/*
* CTIO2 returned from F/W...
*/
struct {
u_int32_t _reserved[4];
u_int16_t ct_scsi_status;
u_int8_t ct_sense[SUGGSENSELEN];
} fw;
} rsp;
} ct2_entry_t;
/*
* ct_flags values for CTIO2
*/
#define CT2_FLAG_MMASK 0x0003
#define CT2_FLAG_MODE0 0x0000
#define CT2_FLAG_MODE1 0x0001
#define CT2_FLAG_MODE2 0x0002
#define CT2_DATA_IN CT_DATA_IN
#define CT2_DATA_OUT CT_DATA_OUT
#define CT2_NO_DATA CT_NO_DATA
#define CT2_DATAMASK CT_DATA_MASK
#define CT2_CCINCR 0x0100
#define CT2_FASTPOST 0x0200
#define CT2_SENDSTATUS 0x8000
/*
* ct_status values are (mostly) the same as that for ct_entry.
*/
/*
* ct_scsi_status values- the low 8 bits are the normal SCSI status
* we know and love. The upper 8 bits are validity markers for FCP_RSP_IU
* fields.
*/
#define CT2_RSPLEN_VALID 0x0100
#define CT2_SNSLEN_VALID 0x0200
#define CT2_DATA_OVER 0x0400
#define CT2_DATA_UNDER 0x0800
#endif /* _ISPMBOX_H */