2 * RFC 3720 (iSCSI) protocol data types
4 * Copyright (C) 2005 Dmitry Yusupov
5 * Copyright (C) 2005 Alex Aizman
6 * maintained by open-iscsi@googlegroups.com
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published
10 * by the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * See the file COPYING included with this distribution for more details.
24 #define ISCSI_VERSION_STR "0.3"
25 #define ISCSI_DATE_STR "22-Apr-2005"
26 #define ISCSI_DRAFT20_VERSION 0x00
28 /* default iSCSI listen port for incoming connections */
29 #define ISCSI_LISTEN_PORT 3260
31 /* Padding word length */
32 #define PAD_WORD_LEN 4
35 * useful common(control and data pathes) macro
37 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
38 #define hton24(p, v) { \
39 p[0] = (((v) >> 16) & 0xFF); \
40 p[1] = (((v) >> 8) & 0xFF); \
41 p[2] = ((v) & 0xFF); \
43 #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}
46 * iSCSI Template Message Header
50 uint8_t flags; /* Final bit */
52 uint8_t hlength; /* AHSs total length */
53 uint8_t dlength[3]; /* Data length */
55 __be32 itt; /* Initiator Task Tag */
56 __be32 ttt; /* Target Task Tag */
63 /************************* RFC 3720 Begin *****************************/
65 #define ISCSI_RESERVED_TAG 0xffffffff
67 /* Opcode encoding bits */
68 #define ISCSI_OP_RETRY 0x80
69 #define ISCSI_OP_IMMEDIATE 0x40
70 #define ISCSI_OPCODE_MASK 0x3F
72 /* Initiator Opcode values */
73 #define ISCSI_OP_NOOP_OUT 0x00
74 #define ISCSI_OP_SCSI_CMD 0x01
75 #define ISCSI_OP_SCSI_TMFUNC 0x02
76 #define ISCSI_OP_LOGIN 0x03
77 #define ISCSI_OP_TEXT 0x04
78 #define ISCSI_OP_SCSI_DATA_OUT 0x05
79 #define ISCSI_OP_LOGOUT 0x06
80 #define ISCSI_OP_SNACK 0x10
82 #define ISCSI_OP_VENDOR1_CMD 0x1c
83 #define ISCSI_OP_VENDOR2_CMD 0x1d
84 #define ISCSI_OP_VENDOR3_CMD 0x1e
85 #define ISCSI_OP_VENDOR4_CMD 0x1f
87 /* Target Opcode values */
88 #define ISCSI_OP_NOOP_IN 0x20
89 #define ISCSI_OP_SCSI_CMD_RSP 0x21
90 #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22
91 #define ISCSI_OP_LOGIN_RSP 0x23
92 #define ISCSI_OP_TEXT_RSP 0x24
93 #define ISCSI_OP_SCSI_DATA_IN 0x25
94 #define ISCSI_OP_LOGOUT_RSP 0x26
95 #define ISCSI_OP_R2T 0x31
96 #define ISCSI_OP_ASYNC_EVENT 0x32
97 #define ISCSI_OP_REJECT 0x3f
99 struct iscsi_ahs_hdr {
105 #define ISCSI_AHSTYPE_CDB 1
106 #define ISCSI_AHSTYPE_RLENGTH 2
108 /* iSCSI PDU Header */
116 __be32 itt; /* Initiator Task Tag */
120 uint8_t cdb[16]; /* SCSI Command Block */
121 /* Additional Data (Command Dependent) */
124 /* Command PDU flags */
125 #define ISCSI_FLAG_CMD_FINAL 0x80
126 #define ISCSI_FLAG_CMD_READ 0x40
127 #define ISCSI_FLAG_CMD_WRITE 0x20
128 #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */
130 /* SCSI Command Attribute values */
131 #define ISCSI_ATTR_UNTAGGED 0
132 #define ISCSI_ATTR_SIMPLE 1
133 #define ISCSI_ATTR_ORDERED 2
134 #define ISCSI_ATTR_HEAD_OF_QUEUE 3
135 #define ISCSI_ATTR_ACA 4
137 struct iscsi_rlength_ahdr {
144 /* SCSI Response Header */
145 struct iscsi_cmd_rsp {
153 __be32 itt; /* Initiator Task Tag */
159 __be32 bi_residual_count;
160 __be32 residual_count;
161 /* Response or Sense Data (optional) */
164 /* Command Response PDU flags */
165 #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10
166 #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08
167 #define ISCSI_FLAG_CMD_OVERFLOW 0x04
168 #define ISCSI_FLAG_CMD_UNDERFLOW 0x02
170 /* iSCSI Status values. Valid if Rsp Selector bit is not set */
171 #define ISCSI_STATUS_CMD_COMPLETED 0
172 #define ISCSI_STATUS_TARGET_FAILURE 1
173 #define ISCSI_STATUS_SUBSYS_FAILURE 2
175 /* Asynchronous Event Header */
195 /* iSCSI Event Codes */
196 #define ISCSI_ASYNC_MSG_SCSI_EVENT 0
197 #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1
198 #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2
199 #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3
200 #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4
201 #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255
203 /* NOP-Out Message */
204 struct iscsi_nopout {
211 __be32 itt; /* Initiator Task Tag */
212 __be32 ttt; /* Target Transfer Tag */
226 __be32 itt; /* Initiator Task Tag */
227 __be32 ttt; /* Target Transfer Tag */
234 /* SCSI Task Management Message Header */
242 __be32 itt; /* Initiator Task Tag */
243 __be32 rtt; /* Reference Task Tag */
251 #define ISCSI_FLAG_TM_FUNC_MASK 0x7F
253 /* Function values */
254 #define ISCSI_TM_FUNC_ABORT_TASK 1
255 #define ISCSI_TM_FUNC_ABORT_TASK_SET 2
256 #define ISCSI_TM_FUNC_CLEAR_ACA 3
257 #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4
258 #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5
259 #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6
260 #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7
261 #define ISCSI_TM_FUNC_TASK_REASSIGN 8
263 /* SCSI Task Management Response Header */
264 struct iscsi_tm_rsp {
267 uint8_t response; /* see Response values below */
272 __be32 itt; /* Initiator Task Tag */
273 __be32 rtt; /* Reference Task Tag */
280 /* Response values */
281 #define ISCSI_TMF_RSP_COMPLETE 0x00
282 #define ISCSI_TMF_RSP_NO_TASK 0x01
283 #define ISCSI_TMF_RSP_NO_LUN 0x02
284 #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03
285 #define ISCSI_TMF_RSP_NO_FAILOVER 0x04
286 #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05
287 #define ISCSI_TMF_RSP_AUTH_FAILED 0x06
288 #define ISCSI_TMF_RSP_REJECTED 0xff
290 /* Ready To Transfer Header */
291 struct iscsi_r2t_rsp {
298 __be32 itt; /* Initiator Task Tag */
299 __be32 ttt; /* Target Transfer Tag */
327 /* SCSI Data Response Hdr */
328 struct iscsi_data_rsp {
343 __be32 residual_count;
346 /* Data Response PDU flags */
347 #define ISCSI_FLAG_DATA_ACK 0x40
348 #define ISCSI_FLAG_DATA_OVERFLOW 0x04
349 #define ISCSI_FLAG_DATA_UNDERFLOW 0x02
350 #define ISCSI_FLAG_DATA_STATUS 0x01
365 /* Text - key=value pairs */
368 #define ISCSI_FLAG_TEXT_CONTINUE 0x40
370 /* Text Response Header */
371 struct iscsi_text_rsp {
384 /* Text Response - key:value pairs */
391 uint8_t max_version; /* Max. version supported */
392 uint8_t min_version; /* Min. version supported */
395 uint8_t isid[6]; /* Initiator Session ID */
396 __be16 tsih; /* Target Session Handle */
397 __be32 itt; /* Initiator Task Tag */
405 /* Login PDU flags */
406 #define ISCSI_FLAG_LOGIN_TRANSIT 0x80
407 #define ISCSI_FLAG_LOGIN_CONTINUE 0x40
408 #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */
409 #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */
411 #define ISCSI_LOGIN_CURRENT_STAGE(flags) \
412 ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
413 #define ISCSI_LOGIN_NEXT_STAGE(flags) \
414 (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)
416 /* Login Response Header */
417 struct iscsi_login_rsp {
420 uint8_t max_version; /* Max. version supported */
421 uint8_t active_version; /* Active version */
424 uint8_t isid[6]; /* Initiator Session ID */
425 __be16 tsih; /* Target Session Handle */
426 __be32 itt; /* Initiator Task Tag */
431 uint8_t status_class; /* see Login RSP ststus classes below */
432 uint8_t status_detail; /* see Login RSP Status details below */
436 /* Login stage (phase) codes for CSG, NSG */
437 #define ISCSI_INITIAL_LOGIN_STAGE -1
438 #define ISCSI_SECURITY_NEGOTIATION_STAGE 0
439 #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1
440 #define ISCSI_FULL_FEATURE_PHASE 3
442 /* Login Status response classes */
443 #define ISCSI_STATUS_CLS_SUCCESS 0x00
444 #define ISCSI_STATUS_CLS_REDIRECT 0x01
445 #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02
446 #define ISCSI_STATUS_CLS_TARGET_ERR 0x03
448 /* Login Status response detail codes */
449 /* Class-0 (Success) */
450 #define ISCSI_LOGIN_STATUS_ACCEPT 0x00
452 /* Class-1 (Redirection) */
453 #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01
454 #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02
456 /* Class-2 (Initiator Error) */
457 #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00
458 #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01
459 #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02
460 #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03
461 #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04
462 #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05
463 #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06
464 #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07
465 #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08
466 #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09
467 #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a
468 #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b
470 /* Class-3 (Target Error) */
471 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00
472 #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01
473 #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02
476 struct iscsi_logout {
483 __be32 itt; /* Initiator Task Tag */
491 /* Logout PDU flags */
492 #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F
494 /* logout reason_code values */
496 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
497 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
498 #define ISCSI_LOGOUT_REASON_RECOVERY 2
499 #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3
501 /* Logout Response Header */
502 struct iscsi_logout_rsp {
505 uint8_t response; /* see Logout response values below */
510 __be32 itt; /* Initiator Task Tag */
521 /* logout response status values */
523 #define ISCSI_LOGOUT_SUCCESS 0
524 #define ISCSI_LOGOUT_CID_NOT_FOUND 1
525 #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2
526 #define ISCSI_LOGOUT_CLEANUP_FAILED 3
542 /* SNACK PDU flags */
543 #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */
545 /* Reject Message Header */
546 struct iscsi_reject {
561 /* Text - Rejected hdr */
564 /* Reason for Reject */
565 #define ISCSI_REASON_CMD_BEFORE_LOGIN 1
566 #define ISCSI_REASON_DATA_DIGEST_ERROR 2
567 #define ISCSI_REASON_DATA_SNACK_REJECT 3
568 #define ISCSI_REASON_PROTOCOL_ERROR 4
569 #define ISCSI_REASON_CMD_NOT_SUPPORTED 5
570 #define ISCSI_REASON_IMM_CMD_REJECT 6
571 #define ISCSI_REASON_TASK_IN_PROGRESS 7
572 #define ISCSI_REASON_INVALID_SNACK 8
573 #define ISCSI_REASON_BOOKMARK_INVALID 9
574 #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10
575 #define ISCSI_REASON_NEGOTIATION_RESET 11
577 /* Max. number of Key=Value pairs in a text message */
578 #define MAX_KEY_VALUE_PAIRS 8192
580 /* maximum length for text keys/values */
581 #define KEY_MAXLEN 64
582 #define VALUE_MAXLEN 255
583 #define TARGET_NAME_MAXLEN VALUE_MAXLEN
585 #define DEFAULT_MAX_RECV_DATA_SEGMENT_LENGTH 8192
587 /************************* RFC 3720 End *****************************/
589 #endif /* ISCSI_PROTO_H */