1163899Smjacob/* $FreeBSD$ */ 2163899Smjacob/*- 3196008Smjacob * Copyright (c) 1997-2009 by Matthew Jacob 4167403Smjacob * All rights reserved. 5167403Smjacob * 6167403Smjacob * Redistribution and use in source and binary forms, with or without 7167403Smjacob * modification, are permitted provided that the following conditions 8167403Smjacob * are met: 9167403Smjacob * 10167403Smjacob * 1. Redistributions of source code must retain the above copyright 11167403Smjacob * notice, this list of conditions and the following disclaimer. 12167403Smjacob * 2. Redistributions in binary form must reproduce the above copyright 13167403Smjacob * notice, this list of conditions and the following disclaimer in the 14167403Smjacob * documentation and/or other materials provided with the distribution. 15167403Smjacob * 16167403Smjacob * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17167403Smjacob * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18167403Smjacob * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19167403Smjacob * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 20167403Smjacob * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21167403Smjacob * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22167403Smjacob * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23167403Smjacob * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24167403Smjacob * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25167403Smjacob * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26167403Smjacob * SUCH DAMAGE. 27196008Smjacob * 28163899Smjacob */ 29163899Smjacob/* 30163899Smjacob * Structures that derive directly from public standards. 31163899Smjacob */ 32163899Smjacob#ifndef _ISP_STDS_H 33163899Smjacob#define _ISP_STDS_H 34163899Smjacob/* 35163899Smjacob * FC Frame Header 36163899Smjacob * 37163899Smjacob * Source: dpANS-X3.xxx-199x, section 18 (AKA FC-PH-2) 38163899Smjacob * 39163899Smjacob */ 40163899Smjacobtypedef struct { 41163899Smjacob uint8_t r_ctl; 42163899Smjacob uint8_t d_id[3]; 43163899Smjacob uint8_t cs_ctl; 44163899Smjacob uint8_t s_id[3]; 45163899Smjacob uint8_t type; 46196008Smjacob uint8_t f_ctl[3]; 47163899Smjacob uint8_t seq_id; 48163899Smjacob uint8_t df_ctl; 49163899Smjacob uint16_t seq_cnt; 50163899Smjacob uint16_t ox_id; 51163899Smjacob uint16_t rx_id; 52163899Smjacob uint32_t parameter; 53163899Smjacob} fc_hdr_t; 54163899Smjacob 55163899Smjacob/* 56163899Smjacob * FCP_CMND_IU Payload 57163899Smjacob * 58163899Smjacob * Source: NICTS T10, Project 1144D, Revision 07a, Section 9 (AKA fcp2-r07a) 59163899Smjacob * 60163899Smjacob * Notes: 61163899Smjacob * When additional cdb length is defined in fcp_cmnd_alen_datadir, 62163899Smjacob * bits 2..7, the actual cdb length is 16 + ((fcp_cmnd_alen_datadir>>2)*4), 63163899Smjacob * with the datalength following in MSB format just after. 64163899Smjacob */ 65163899Smjacobtypedef struct { 66163899Smjacob uint8_t fcp_cmnd_lun[8]; 67163899Smjacob uint8_t fcp_cmnd_crn; 68163899Smjacob uint8_t fcp_cmnd_task_attribute; 69163899Smjacob uint8_t fcp_cmnd_task_management; 70163899Smjacob uint8_t fcp_cmnd_alen_datadir; 71163899Smjacob union { 72163899Smjacob struct { 73163899Smjacob uint8_t fcp_cmnd_cdb[16]; 74163899Smjacob uint32_t fcp_cmnd_dl; 75163899Smjacob } sf; 76163899Smjacob struct { 77163899Smjacob uint8_t fcp_cmnd_cdb[1]; 78163899Smjacob } lf; 79163899Smjacob } cdb_dl; 80163899Smjacob} fcp_cmnd_iu_t; 81163899Smjacob 82163899Smjacob 83163899Smjacob#define FCP_CMND_TASK_ATTR_SIMPLE 0x00 84163899Smjacob#define FCP_CMND_TASK_ATTR_HEAD 0x01 85163899Smjacob#define FCP_CMND_TASK_ATTR_ORDERED 0x02 86163899Smjacob#define FCP_CMND_TASK_ATTR_ACA 0x04 87163899Smjacob#define FCP_CMND_TASK_ATTR_UNTAGGED 0x05 88163899Smjacob#define FCP_CMND_TASK_ATTR_MASK 0x07 89163899Smjacob 90163899Smjacob#define FCP_CMND_ADDTL_CDBLEN_SHIFT 2 91163899Smjacob 92163899Smjacob#define FCP_CMND_DATA_WRITE 0x01 93163899Smjacob#define FCP_CMND_DATA_READ 0x02 94163899Smjacob 95163899Smjacob#define FCP_CMND_DATA_DIR_MASK 0x03 96163899Smjacob 97163899Smjacob#define FCP_CMND_TMF_CLEAR_ACA 0x40 98163899Smjacob#define FCP_CMND_TMF_TGT_RESET 0x20 99163899Smjacob#define FCP_CMND_TMF_LUN_RESET 0x10 100163899Smjacob#define FCP_CMND_TMF_CLEAR_TASK_SET 0x04 101163899Smjacob#define FCP_CMND_TMF_ABORT_TASK_SET 0x02 102163899Smjacob 103163899Smjacob/* 104163899Smjacob * Basic CT IU Header 105163899Smjacob * 106163899Smjacob * Source: X3.288-199x Generic Services 2 Rev 5.3 (FC-GS-2) Section 4.3.1 107163899Smjacob */ 108163899Smjacob 109163899Smjacobtypedef struct { 110163899Smjacob uint8_t ct_revision; 111163899Smjacob uint8_t ct_in_id[3]; 112163899Smjacob uint8_t ct_fcs_type; 113163899Smjacob uint8_t ct_fcs_subtype; 114163899Smjacob uint8_t ct_options; 115163899Smjacob uint8_t ct_reserved0; 116163899Smjacob uint16_t ct_cmd_resp; 117163899Smjacob uint16_t ct_bcnt_resid; 118163899Smjacob uint8_t ct_reserved1; 119163899Smjacob uint8_t ct_reason; 120163899Smjacob uint8_t ct_explanation; 121163899Smjacob uint8_t ct_vunique; 122163899Smjacob} ct_hdr_t; 123163899Smjacob#define CT_REVISION 1 124163899Smjacob#define CT_FC_TYPE_FC 0xFC 125163899Smjacob#define CT_FC_SUBTYPE_NS 0x02 126163899Smjacob 127163899Smjacob/* 128163899Smjacob * RFT_ID Requet CT_IU 129163899Smjacob * 130164272Smjacob * Source: NCITS xxx-200x Generic Services- 5 Rev 8.5 Section 5.2.5.30 131163899Smjacob */ 132163899Smjacobtypedef struct { 133163899Smjacob ct_hdr_t rftid_hdr; 134163899Smjacob uint8_t rftid_reserved; 135163899Smjacob uint8_t rftid_portid[3]; 136163899Smjacob uint32_t rftid_fc4types[8]; 137163899Smjacob} rft_id_t; 138163899Smjacob 139164272Smjacob/* 140238869Smjacob * FCP Response IU and bits of interest 141238869Smjacob * Source: NCITS T10, Project 1828D, Revision 02b (aka FCP4r02b) 142196008Smjacob */ 143238869Smjacobtypedef struct { 144238869Smjacob uint8_t fcp_rsp_reserved[8]; 145238869Smjacob uint16_t fcp_rsp_status_qualifier; /* SAM-5 Status Qualifier */ 146238869Smjacob uint8_t fcp_rsp_bits; 147238869Smjacob uint8_t fcp_rsp_scsi_status; /* SAM-5 SCSI Status Byte */ 148238869Smjacob uint32_t fcp_rsp_resid; 149238869Smjacob uint32_t fcp_rsp_snslen; 150238869Smjacob uint32_t fcp_rsp_rsplen; 151238869Smjacob /* 152238869Smjacob * In the bytes that follow, it's going to be 153238869Smjacob * FCP RESPONSE INFO (max 8 bytes, possibly 0) 154238869Smjacob * FCP SENSE INFO (if any) 155238869Smjacob * FCP BIDIRECTIONAL READ RESID (if any) 156238869Smjacob */ 157238869Smjacob uint8_t fcp_rsp_extra[0]; 158238869Smjacob} fcp_rsp_iu_t; 159238869Smjacob#define MIN_FCP_RESPONSE_SIZE 24 160238869Smjacob 161238869Smjacob#define FCP_BIDIR_RSP 0x80 /* Bi-Directional response */ 162238869Smjacob#define FCP_BIDIR_RESID_UNDERFLOW 0x40 163238869Smjacob#define FCP_BIDIR_RESID_OVERFLOW 0x20 164196008Smjacob#define FCP_CONF_REQ 0x10 165196008Smjacob#define FCP_RESID_UNDERFLOW 0x08 166196008Smjacob#define FCP_RESID_OVERFLOW 0x04 167196008Smjacob#define FCP_SNSLEN_VALID 0x02 168196008Smjacob#define FCP_RSPLEN_VALID 0x01 169196008Smjacob 170197372Smjacob#define FCP_MAX_RSPLEN 0x08 171196008Smjacob/* 172164272Smjacob * FCP Response Code Definitions 173196008Smjacob * Source: NCITS T10, Project 1144D, Revision 08 (aka FCP2r08) 174164272Smjacob */ 175164272Smjacob#define FCP_RSPNS_CODE_OFFSET 3 176163899Smjacob 177164272Smjacob#define FCP_RSPNS_TMF_DONE 0 178164272Smjacob#define FCP_RSPNS_DLBRSTX 1 179164272Smjacob#define FCP_RSPNS_BADCMND 2 180164272Smjacob#define FCP_RSPNS_EROFS 3 181164272Smjacob#define FCP_RSPNS_TMF_REJECT 4 182164272Smjacob#define FCP_RSPNS_TMF_FAILED 5 183197372Smjacob#define FCP_RSPNS_TMF_SUCCEEDED 8 184197372Smjacob#define FCP_RSPNS_TMF_INCORRECT_LUN 9 185164272Smjacob 186238869Smjacob/* 187238869Smjacob * R_CTL field definitions 188238869Smjacob * 189238869Smjacob * Bits 31-28 are ROUTING 190238869Smjacob * Bits 27-24 are INFORMATION 191238869Smjacob * 192238869Smjacob * These are nibble values, not bits 193238869Smjacob */ 194238869Smjacob#define R_CTL_ROUTE_DATA 0x00 195238869Smjacob#define R_CTL_ROUTE_ELS 0x02 196238869Smjacob#define R_CTL_ROUTE_FC4_LINK 0x03 197238869Smjacob#define R_CTL_ROUTE_VDATA 0x04 198238869Smjacob#define R_CTL_ROUTE_EXENDED 0x05 199238869Smjacob#define R_CTL_ROUTE_BASIC 0x08 200238869Smjacob#define R_CTL_ROUTE_LINK 0x0c 201238869Smjacob#define R_CTL_ROUTE_EXT_ROUTING 0x0f 202164272Smjacob 203238869Smjacob#define R_CTL_INFO_UNCATEGORIZED 0x00 204238869Smjacob#define R_CTL_INFO_SOLICITED_DATA 0x01 205238869Smjacob#define R_CTL_INFO_UNSOLICITED_CONTROL 0x02 206238869Smjacob#define R_CTL_INFO_SOLICITED_CONTROL 0x03 207238869Smjacob#define R_CTL_INFO_UNSOLICITED_DATA 0x04 208238869Smjacob#define R_CTL_INFO_DATA_DESCRIPTOR 0x05 209238869Smjacob#define R_CTL_INFO_UNSOLICITED_COMMAND 0x06 210238869Smjacob#define R_CTL_INFO_COMMAND_STATUS 0x07 211238869Smjacob 212238869Smjacob#define MAKE_RCTL(a, b) (((a) << 4) | (b)) 213238869Smjacob 214163899Smjacob/* unconverted miscellany */ 215163899Smjacob/* 216163899Smjacob * Basic FC Link Service defines 217163899Smjacob */ 218238869Smjacob/* #define ABTS MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_SOLICITED_DATA) */ 219238869Smjacob#define BA_ACC MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_UNSOLICITED_DATA) /* of ABORT */ 220238869Smjacob#define BA_RJT MAKE_RCTL(R_CTL_ROUTE_BASIC, R_CTL_INFO_DATA_DESCRIPTOR) /* of ABORT */ 221163899Smjacob 222163899Smjacob/* 223163899Smjacob * Link Service Accept/Reject 224163899Smjacob */ 225163899Smjacob#define LS_ACC 0x8002 226163899Smjacob#define LS_RJT 0x8001 227163899Smjacob 228163899Smjacob/* 229163899Smjacob * FC ELS Codes- bits 31-24 of the first payload word of an ELS frame. 230163899Smjacob */ 231163899Smjacob#define PLOGI 0x03 232163899Smjacob#define FLOGI 0x04 233163899Smjacob#define LOGO 0x05 234163899Smjacob#define ABTX 0x06 235163899Smjacob#define PRLI 0x20 236163899Smjacob#define PRLO 0x21 237196008Smjacob#define SCN 0x22 238163899Smjacob#define TPRLO 0x24 239196008Smjacob#define PDISC 0x50 240196008Smjacob#define ADISC 0x52 241163899Smjacob#define RNC 0x53 242163899Smjacob 243163899Smjacob/* 244238869Smjacob * PRLI Word 3 definitions 245238869Smjacob * FPC4-r02b January, 2011 246238869Smjacob */ 247238869Smjacob#define PRLI_WD3_ENHANCED_DISCOVERY (1 << 11) 248238869Smjacob#define PRLI_WD3_REC_SUPPORT (1 << 10) 249238869Smjacob#define PRLI_WD3_TASK_RETRY_IDENTIFICATION_REQUESTED (1 << 9) 250238869Smjacob#define PRLI_WD3_RETRY (1 << 8) 251238869Smjacob#define PRLI_WD3_CONFIRMED_COMPLETION_ALLOWED (1 << 7) 252238869Smjacob#define PRLI_WD3_DATA_OVERLAY_ALLOWED (1 << 6) 253238869Smjacob#define PRLI_WD3_INITIATOR_FUNCTION (1 << 5) 254238869Smjacob#define PRLI_WD3_TARGET_FUNCTION (1 << 4) 255238869Smjacob#define PRLI_WD3_READ_FCP_XFER_RDY_DISABLED (1 << 1) /* definitely supposed to be set */ 256238869Smjacob#define PRLI_WD3_WRITE_FCP_XFER_RDY_DISABLED (1 << 0) 257238869Smjacob 258238869Smjacob 259238869Smjacob 260238869Smjacob/* 261163899Smjacob * FC4 defines 262163899Smjacob */ 263163899Smjacob#define FC4_IP 5 /* ISO/EEC 8802-2 LLC/SNAP */ 264163899Smjacob#define FC4_SCSI 8 /* SCSI-3 via Fibre Channel Protocol (FCP) */ 265163899Smjacob#define FC4_FC_SVC 0x20 /* Fibre Channel Services */ 266163899Smjacob 267163899Smjacob#ifndef MSG_ABORT 268163899Smjacob#define MSG_ABORT 0x06 269163899Smjacob#endif 270163899Smjacob#ifndef MSG_BUS_DEV_RESET 271163899Smjacob#define MSG_BUS_DEV_RESET 0x0c 272163899Smjacob#endif 273163899Smjacob#ifndef MSG_ABORT_TAG 274163899Smjacob#define MSG_ABORT_TAG 0x0d 275163899Smjacob#endif 276163899Smjacob#ifndef MSG_CLEAR_QUEUE 277163899Smjacob#define MSG_CLEAR_QUEUE 0x0e 278163899Smjacob#endif 279163899Smjacob#ifndef MSG_REL_RECOVERY 280163899Smjacob#define MSG_REL_RECOVERY 0x10 281163899Smjacob#endif 282163899Smjacob#ifndef MSG_TERM_IO_PROC 283163899Smjacob#define MSG_TERM_IO_PROC 0x11 284163899Smjacob#endif 285163899Smjacob#ifndef MSG_LUN_RESET 286163899Smjacob#define MSG_LUN_RESET 0x17 287163899Smjacob#endif 288163899Smjacob 289163899Smjacob#endif /* _ISP_STDS_H */ 290