1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright (c) 1995,1997-1998 by Sun Microsystems, Inc. 24 * All rights reserved. 25 */ 26 27 #ifndef _SYS_FC4_FC_H 28 #define _SYS_FC4_FC_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 /* 35 * Fibre Channel Physical and Signaling Interface (FC-PH) definitions. 36 * 37 * NOTE: modifications of this file affect drivers, mpsas models, PLUTO 38 * firmware, SOC assembly code. Please be communicative. 39 */ 40 41 #define FC_PH_VERSION 0x06 /* 0x06 means 4.0 ! */ 42 #define MAX_FRAME_SIZE 2112 /* maximum size of frame payload */ 43 44 /* 45 * This is the standard frame header for FC-PH frames. 46 */ 47 48 typedef struct FC2_FRAME_HDR { 49 uint_t r_ctl:8, d_id:24; 50 uint_t reserved1:8, s_id:24; 51 uint_t type:8, f_ctl:24; 52 uint_t seq_id:8, df_ctl:8, seq_cnt:16; 53 ushort_t ox_id, rx_id; 54 uint_t ro; 55 }aFC2_FRAME_HDR, *FC2_FRAME_HDRptr, fc_frame_header_t; 56 57 #define WE_ARE_ORIGINATOR(fh) (fh->f_ctl & F_CTL_XCHG_CONTEXT) 58 #define UNSOLICITED_FRAME(fh) (fh->rx_id == 0xffff) 59 #define FIRST_SEQUENCE(fh) (fh->f_ctl & F_CTL_FIRST_SEQ) 60 #define LAST_FRAME_OF_SEQUENCE(fh) (fh->f_ctl & F_CTL_END_SEQ) 61 #define LAST_SEQUENCE_OF_EXCHANGE(fh) (fh->f_ctl & F_CTL_LAST_SEQ) 62 #define TRANSFER_INITIATIVE(fh) (fh->f_ctl & F_CTL_SEQ_INITIATIVE) 63 64 65 /* legal values for r_ctl */ 66 #define R_CTL_ROUTING 0xf0 /* mask for routing bits */ 67 #define R_CTL_INFO 0x0f /* mask for information bits */ 68 69 #define R_CTL_DEVICE_DATA 0x00 /* all I/O related frames */ 70 #define R_CTL_EXTENDED_SVC 0x20 /* extended link services (PLOGI) */ 71 #define R_CTL_FC4_SVC 0x30 /* FC-4 link services (FCP_LOGI) */ 72 #define R_CTL_VIDEO_BUFF 0x40 /* not yet defined */ 73 #define R_CTL_BASIC_SVC 0x80 /* basic link services (NOP) */ 74 #define R_CTL_LINK_CTL 0xc0 /* ACKs, etc. */ 75 76 /* legal values for r_ctl: Device Data */ 77 #define R_CTL_UNCATEGORIZED 0x00 78 #define R_CTL_SOLICITED_DATA 0x01 79 #define R_CTL_UNSOL_CONTROL 0x02 80 #define R_CTL_SOLICITED_CONTROL 0x03 81 #define R_CTL_UNSOL_DATA 0x04 82 #define R_CTL_XFER_RDY 0x05 83 #define R_CTL_COMMAND 0x06 84 #define R_CTL_STATUS 0x07 85 86 /* legal values for r_ctl: Basic Link Services, type 0 */ 87 #define R_CTL_LS_NOP 0x80 88 #define R_CTL_LS_ABTS 0x81 89 #define R_CTL_LS_RMC 0x82 90 #define R_CTL_LS_BA_ACC 0x84 91 #define R_CTL_LS_BA_RJT 0x85 92 93 /* legal values for r_ctl: Extended Link Services, type 1 */ 94 #define R_CTL_ELS_REQ 0x22 95 #define R_CTL_ELS_RSP 0x23 96 97 /* Extended Link Service command codes, type 1 */ 98 #define LS_RJT 0x01000000 99 #define LS_ACC 0x02000000 100 #define LS_PLOGI 0x03000000 101 #define LS_FLOGI 0x04000000 102 #define LS_LOGO 0x05000000 103 #define LS_ABTX 0x06000000 104 #define LS_RCS 0x07000000 105 #define LS_RES 0x08000000 106 #define LS_RSS 0x09000000 107 #define LS_RSI 0x0a000000 108 #define LS_ESTS 0x0b000000 109 #define LS_ESTC 0x0c000000 110 #define LS_ADVC 0x0d000000 111 #define LS_RTV 0x0e000000 112 #define LS_RLS 0x0f000000 113 #define LS_ECHO 0x10000000 114 #define LS_TEST 0x11000000 115 #define LS_RRQ 0x12000000 116 #define LS_IDENT 0x20000000 /* vendor unique */ 117 #define LS_DISPLAY 0x21000000 /* vendor unique */ 118 119 /* legal values for r_ctl: Link Control */ 120 #define R_CTL_ACK_1 0xc0 121 #define R_CTL_ACK_N 0xc1 122 #define R_CTL_P_RJT 0xc2 123 #define R_CTL_F_RJT 0xc3 124 #define R_CTL_P_BSY 0xc4 125 #define R_CTL_F_BSY_DF 0xc5 126 #define R_CTL_F_BSY_LC 0xc6 127 #define R_CTL_LCR 0xc7 128 129 /* type field definitions for Link Data frames: */ 130 #define TYPE_BASIC_LS 0x00 131 #define TYPE_EXTENDED_LS 0x01 132 133 /* type field definitions for Device Data frames (from FC-PH 4.1): */ 134 #define TYPE_IS8802 0x04 135 #define TYPE_IS8802_SNAP 0x05 136 #define TYPE_SCSI_FCP 0x08 /* we use this one */ 137 #define TYPE_SCSI_GPP 0x09 138 #define TYPE_HIPP_FP 0x0a 139 #define TYPE_IPI3_MASTER 0x11 140 #define TYPE_IPI3_SLAVE 0x12 141 #define TYPE_IPI3_PEER 0x13 142 143 #define F_CTL_XCHG_CONTEXT 0x800000 /* 0 if SID is XCHG originator */ 144 #define F_CTL_SEQ_CONTEXT 0x400000 /* 0 if SID is SEQ initiator */ 145 #define F_CTL_FIRST_SEQ 0x200000 /* 1 if first sequence of XCHG */ 146 #define F_CTL_LAST_SEQ 0x100000 /* 1 if last SEQ of XCHG */ 147 #define F_CTL_END_SEQ 0x080000 /* 1 if last frame of a SEQ */ 148 #define F_CTL_END_CONNECT 0x040000 /* always 0 */ 149 #define F_CTL_CHAINED_SEQ 0x020000 /* always 0 */ 150 #define F_CTL_SEQ_INITIATIVE 0x010000 /* when 1 xfrs SEQ initiative */ 151 #define F_CTL_XID_REASSIGNED 0x008000 /* always 0 */ 152 #define F_CTL_INVALIDATE_XID 0x004000 /* always 0 */ 153 #define F_CTL_CONTINUE_SEQ 0x0000C0 /* always 0 */ 154 #define F_CTL_ABORT_SEQ 0x000030 /* always 0 */ 155 #define F_CTL_RO_PRESENT 0x000008 /* 1 if param field == RO */ 156 #define F_CTL_XCHG_REASSEMBLE 0x000004 /* always 0 */ 157 #define F_CTL_FILL_BYTES 0x000003 /* # of fill bytes in this frame */ 158 #define F_CTL_RESERVED 0x003F00 159 #define F_CTL_ALWAYS_ZERO (F_CTL_RESERVED | F_CTL_XCHG_REASSEMBLE | \ 160 F_CTL_ABORT_SEQ | F_CTL_CONTINUE_SEQ| F_CTL_INVALIDATE_XID | \ 161 F_CTL_XID_REASSIGNED | F_CTL_CHAINED_SEQ | F_CTL_END_CONNECT) 162 163 /* Well known addresses ... */ 164 #define FS_GENERAL_MULTICAST 0xfffff7 165 #define FS_WELL_KNOWN_MULTICAST 0xfffff8 166 #define FS_HUNT_GROUP 0xfffff9 167 #define FS_MANAGEMENT_SERVER 0xfffffa 168 #define FS_TIME_SERVER 0xfffffb 169 #define FS_NAME_SERVER 0xfffffc 170 #define FS_FABRIC_CONTROLLER 0xfffffd 171 #define FS_FABRIC_F_PORT 0xfffffe 172 #define FS_BROADCAST 0xffffff 173 174 /* Fabric Busy Reason Codes */ 175 #define FABRIC_BUSY 0x01 176 #define NPORT_BUSY 0x03 177 178 /* NPort Busy Reason Codes */ 179 #define PHYSICAL_BUSY 0x01 180 #define RESOURSE_BUSY 0x03 181 182 /* Reject Reason Codes */ 183 184 typedef struct FC2_RJT_PARAM { 185 uchar_t rjt_action; 186 uchar_t rjt_reason; 187 uchar_t reserved[2]; 188 } aFC2_RJT_PARAM; 189 190 #define INVALID_D_ID 0x01 191 #define INVALID_S_ID 0x02 192 #define NPORT_NOT_AVAIL_TEMP 0x03 193 #define NPORT_NOT_AVAIL_PERM 0x04 194 #define CLASS_NOT_SUPPORTED 0x05 195 #define DELIMITER_ERROR 0x06 196 #define TYPE_NOT_SUPPORTED 0x07 197 #define INVALID_LINK_CONTROL 0x08 198 #define INVALID_R_CTL 0x09 199 #define INVALID_F_CTL 0x0a 200 #define INVALID_OX_ID 0x0b 201 #define INVALID_RX_ID 0x0c 202 #define INVALID_SEQ_ID 0x0d 203 #define INVALID_DF_CTL 0x0e 204 #define INVALID_SEQ_CNT 0x0f 205 #define INVALID_PARAMETER 0x10 206 #define EXCHANGE_ERROR 0x11 207 #define PROTOCOL_ERROR 0x12 208 #define INCORRECT_LENGTH 0x13 209 #define UNEXPECTED_ACK 0x14 210 #define UNEXPECTED_LINK_RESP 0x15 211 #define LOGIN_REQUIRED 0x16 212 #define EXCESSIVE_SEQUENCES 0x17 213 #define CANT_ESTABLISH_EXCHANGE 0x18 214 #define SECURITY_NOT_SUPPORTED 0x19 215 216 /* BA_RJT and LS_RJT reason codes */ 217 #define RJT_INVALID_CMD_CODE 0x01 218 #define RJT_LOGICAL_ERROR 0x03 219 #define RJT_LOGICAL_BUSY 0x05 220 #define RJT_PROTOCOL_ERR 0x07 221 #define RJT_CANT_PERFORM_RQST 0x09 222 #define RJT_CMD_NOT_SUPPORTED 0x0b 223 224 225 /* 226 * Frame Payloads that the SOC understands 227 * Transfer Ready: 228 */ 229 230 typedef struct Xfer_Rdy { 231 int seq_ro; 232 int burst_len; 233 int reserved; 234 } aXFER_RDY, *XFER_RDYptr; 235 236 /* 237 * Link Error Status Block 238 */ 239 240 typedef struct LA_RLS_reply { 241 int code; 242 int link_failure; 243 int loss_of_sync; 244 int loss_of_signal; 245 int primitive_error; 246 int code_violations; 247 int invalid_crc; 248 } aLA_RLS_reply, *LA_RLS_replyptr; 249 250 251 /* 252 * Login 253 */ 254 255 typedef struct LOGI_PAYLOAD { 256 uint_t code; 257 uchar_t common_service_params[16]; 258 uchar_t port_name[8]; 259 uchar_t node_name[8]; 260 uchar_t class1_service_params[16]; 261 uchar_t class2_service_params[16]; 262 uchar_t class3_service_params[16]; 263 } aLOGI_PAYLOAD, *LOGI_PAYLOADptr; 264 265 #define SP_F_PORT_LOGIN 0x10 266 267 268 /* 269 * Extended Link Service Payload 270 */ 271 272 /* Arbitrary upper limit for now... */ 273 #define FC_MAX_ELS (60-4) 274 275 typedef struct ELS_payload { 276 union els_cmd_u { 277 struct { 278 uchar_t ls_command; 279 uchar_t reserved[3]; 280 } c; 281 uint_t i; 282 } els_cmd; 283 uchar_t els_data[FC_MAX_ELS]; 284 } els_payload_t; 285 286 /* 287 * NOTE: This dataseg definition makes this file unique 288 * from the Pluto fc_ph file. 289 */ 290 291 /* 292 * Data segment definition 293 */ 294 typedef struct fc_dataseg { 295 uint32_t fc_base; /* Address of buffer. */ 296 uint32_t fc_count; /* Length of buffer. */ 297 } fc_dataseg_t; 298 299 #ifdef __cplusplus 300 } 301 #endif 302 303 #endif /* !_SYS_FC4_FC_H */ 304