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 #include <linux/types.h>
25 #include <scsi/scsi.h>
27 #define ISCSI_DRAFT20_VERSION 0x00
29 /* default iSCSI listen port for incoming connections */
30 #define ISCSI_LISTEN_PORT 3260
32 /* Padding word length */
33 #define ISCSI_PAD_LEN 4
36 * useful common(control and data pathes) macro
38 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
39 #define hton24(p, v) { \
40 p[0] = (((v) >> 16) & 0xFF); \
41 p[1] = (((v) >> 8) & 0xFF); \
42 p[2] = ((v) & 0xFF); \
44 #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}
46 /* initiator tags; opaque for target */
47 typedef uint32_t __bitwise__ itt_t;
48 /* below makes sense only for initiator that created this tag */
49 #define build_itt(itt, age) ((__force itt_t)\
50 ((itt) | ((age) << ISCSI_AGE_SHIFT)))
51 #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK)
52 #define RESERVED_ITT ((__force itt_t)0xffffffff)
55 * iSCSI Template Message Header
59 uint8_t flags; /* Final bit */
61 uint8_t hlength; /* AHSs total length */
62 uint8_t dlength[3]; /* Data length */
64 itt_t itt; /* Initiator Task Tag, opaque for target */
65 __be32 ttt; /* Target Task Tag */
72 /************************* RFC 3720 Begin *****************************/
74 #define ISCSI_RESERVED_TAG 0xffffffff
76 /* Opcode encoding bits */
77 #define ISCSI_OP_RETRY 0x80
78 #define ISCSI_OP_IMMEDIATE 0x40
79 #define ISCSI_OPCODE_MASK 0x3F
81 /* Initiator Opcode values */
82 #define ISCSI_OP_NOOP_OUT 0x00
83 #define ISCSI_OP_SCSI_CMD 0x01
84 #define ISCSI_OP_SCSI_TMFUNC 0x02
85 #define ISCSI_OP_LOGIN 0x03
86 #define ISCSI_OP_TEXT 0x04
87 #define ISCSI_OP_SCSI_DATA_OUT 0x05
88 #define ISCSI_OP_LOGOUT 0x06
89 #define ISCSI_OP_SNACK 0x10
91 #define ISCSI_OP_VENDOR1_CMD 0x1c
92 #define ISCSI_OP_VENDOR2_CMD 0x1d
93 #define ISCSI_OP_VENDOR3_CMD 0x1e
94 #define ISCSI_OP_VENDOR4_CMD 0x1f
96 /* Target Opcode values */
97 #define ISCSI_OP_NOOP_IN 0x20
98 #define ISCSI_OP_SCSI_CMD_RSP 0x21
99 #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22
100 #define ISCSI_OP_LOGIN_RSP 0x23
101 #define ISCSI_OP_TEXT_RSP 0x24
102 #define ISCSI_OP_SCSI_DATA_IN 0x25
103 #define ISCSI_OP_LOGOUT_RSP 0x26
104 #define ISCSI_OP_R2T 0x31
105 #define ISCSI_OP_ASYNC_EVENT 0x32
106 #define ISCSI_OP_REJECT 0x3f
108 struct iscsi_ahs_hdr {
114 #define ISCSI_AHSTYPE_CDB 1
115 #define ISCSI_AHSTYPE_RLENGTH 2
116 #define ISCSI_CDB_SIZE 16
118 /* iSCSI PDU Header */
126 itt_t itt; /* Initiator Task Tag */
130 uint8_t cdb[ISCSI_CDB_SIZE]; /* SCSI Command Block */
131 /* Additional Data (Command Dependent) */
134 /* Command PDU flags */
135 #define ISCSI_FLAG_CMD_FINAL 0x80
136 #define ISCSI_FLAG_CMD_READ 0x40
137 #define ISCSI_FLAG_CMD_WRITE 0x20
138 #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */
140 /* SCSI Command Attribute values */
141 #define ISCSI_ATTR_UNTAGGED 0
142 #define ISCSI_ATTR_SIMPLE 1
143 #define ISCSI_ATTR_ORDERED 2
144 #define ISCSI_ATTR_HEAD_OF_QUEUE 3
145 #define ISCSI_ATTR_ACA 4
147 struct iscsi_rlength_ahdr {
154 /* Extended CDB AHS */
155 struct iscsi_ecdb_ahdr {
156 __be16 ahslength; /* CDB length - 15, including reserved byte */
159 /* 4-byte aligned extended CDB spillover */
160 uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE];
163 /* SCSI Response Header */
164 struct iscsi_cmd_rsp {
172 itt_t itt; /* Initiator Task Tag */
178 __be32 bi_residual_count;
179 __be32 residual_count;
180 /* Response or Sense Data (optional) */
183 /* Command Response PDU flags */
184 #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10
185 #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08
186 #define ISCSI_FLAG_CMD_OVERFLOW 0x04
187 #define ISCSI_FLAG_CMD_UNDERFLOW 0x02
189 /* iSCSI Status values. Valid if Rsp Selector bit is not set */
190 #define ISCSI_STATUS_CMD_COMPLETED 0
191 #define ISCSI_STATUS_TARGET_FAILURE 1
192 #define ISCSI_STATUS_SUBSYS_FAILURE 2
194 /* Asynchronous Event Header */
214 /* iSCSI Event Codes */
215 #define ISCSI_ASYNC_MSG_SCSI_EVENT 0
216 #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1
217 #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2
218 #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3
219 #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4
220 #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255
222 /* NOP-Out Message */
223 struct iscsi_nopout {
230 itt_t itt; /* Initiator Task Tag */
231 __be32 ttt; /* Target Transfer Tag */
245 itt_t itt; /* Initiator Task Tag */
246 __be32 ttt; /* Target Transfer Tag */
253 /* SCSI Task Management Message Header */
261 itt_t itt; /* Initiator Task Tag */
262 itt_t rtt; /* Reference Task Tag */
270 #define ISCSI_FLAG_TM_FUNC_MASK 0x7F
272 /* Function values */
273 #define ISCSI_TM_FUNC_ABORT_TASK 1
274 #define ISCSI_TM_FUNC_ABORT_TASK_SET 2
275 #define ISCSI_TM_FUNC_CLEAR_ACA 3
276 #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4
277 #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5
278 #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6
279 #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7
280 #define ISCSI_TM_FUNC_TASK_REASSIGN 8
282 /* SCSI Task Management Response Header */
283 struct iscsi_tm_rsp {
286 uint8_t response; /* see Response values below */
291 itt_t itt; /* Initiator Task Tag */
292 itt_t rtt; /* Reference Task Tag */
299 /* Response values */
300 #define ISCSI_TMF_RSP_COMPLETE 0x00
301 #define ISCSI_TMF_RSP_NO_TASK 0x01
302 #define ISCSI_TMF_RSP_NO_LUN 0x02
303 #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03
304 #define ISCSI_TMF_RSP_NO_FAILOVER 0x04
305 #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05
306 #define ISCSI_TMF_RSP_AUTH_FAILED 0x06
307 #define ISCSI_TMF_RSP_REJECTED 0xff
309 /* Ready To Transfer Header */
310 struct iscsi_r2t_rsp {
317 itt_t itt; /* Initiator Task Tag */
318 __be32 ttt; /* Target Transfer Tag */
346 /* SCSI Data Response Hdr */
347 struct iscsi_data_rsp {
362 __be32 residual_count;
365 /* Data Response PDU flags */
366 #define ISCSI_FLAG_DATA_ACK 0x40
367 #define ISCSI_FLAG_DATA_OVERFLOW 0x04
368 #define ISCSI_FLAG_DATA_UNDERFLOW 0x02
369 #define ISCSI_FLAG_DATA_STATUS 0x01
384 /* Text - key=value pairs */
387 #define ISCSI_FLAG_TEXT_CONTINUE 0x40
389 /* Text Response Header */
390 struct iscsi_text_rsp {
403 /* Text Response - key:value pairs */
410 uint8_t max_version; /* Max. version supported */
411 uint8_t min_version; /* Min. version supported */
414 uint8_t isid[6]; /* Initiator Session ID */
415 __be16 tsih; /* Target Session Handle */
416 itt_t itt; /* Initiator Task Tag */
424 /* Login PDU flags */
425 #define ISCSI_FLAG_LOGIN_TRANSIT 0x80
426 #define ISCSI_FLAG_LOGIN_CONTINUE 0x40
427 #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */
428 #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */
430 #define ISCSI_LOGIN_CURRENT_STAGE(flags) \
431 ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
432 #define ISCSI_LOGIN_NEXT_STAGE(flags) \
433 (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)
435 /* Login Response Header */
436 struct iscsi_login_rsp {
439 uint8_t max_version; /* Max. version supported */
440 uint8_t active_version; /* Active version */
443 uint8_t isid[6]; /* Initiator Session ID */
444 __be16 tsih; /* Target Session Handle */
445 itt_t itt; /* Initiator Task Tag */
450 uint8_t status_class; /* see Login RSP ststus classes below */
451 uint8_t status_detail; /* see Login RSP Status details below */
455 /* Login stage (phase) codes for CSG, NSG */
456 #define ISCSI_INITIAL_LOGIN_STAGE -1
457 #define ISCSI_SECURITY_NEGOTIATION_STAGE 0
458 #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1
459 #define ISCSI_FULL_FEATURE_PHASE 3
461 /* Login Status response classes */
462 #define ISCSI_STATUS_CLS_SUCCESS 0x00
463 #define ISCSI_STATUS_CLS_REDIRECT 0x01
464 #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02
465 #define ISCSI_STATUS_CLS_TARGET_ERR 0x03
467 /* Login Status response detail codes */
468 /* Class-0 (Success) */
469 #define ISCSI_LOGIN_STATUS_ACCEPT 0x00
471 /* Class-1 (Redirection) */
472 #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01
473 #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02
475 /* Class-2 (Initiator Error) */
476 #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00
477 #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01
478 #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02
479 #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03
480 #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04
481 #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05
482 #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06
483 #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07
484 #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08
485 #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09
486 #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a
487 #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b
489 /* Class-3 (Target Error) */
490 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00
491 #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01
492 #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02
495 struct iscsi_logout {
502 itt_t itt; /* Initiator Task Tag */
510 /* Logout PDU flags */
511 #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F
513 /* logout reason_code values */
515 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
516 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
517 #define ISCSI_LOGOUT_REASON_RECOVERY 2
518 #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3
520 /* Logout Response Header */
521 struct iscsi_logout_rsp {
524 uint8_t response; /* see Logout response values below */
529 itt_t itt; /* Initiator Task Tag */
540 /* logout response status values */
542 #define ISCSI_LOGOUT_SUCCESS 0
543 #define ISCSI_LOGOUT_CID_NOT_FOUND 1
544 #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2
545 #define ISCSI_LOGOUT_CLEANUP_FAILED 3
561 /* SNACK PDU flags */
562 #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */
564 /* Reject Message Header */
565 struct iscsi_reject {
580 /* Text - Rejected hdr */
583 /* Reason for Reject */
584 #define ISCSI_REASON_CMD_BEFORE_LOGIN 1
585 #define ISCSI_REASON_DATA_DIGEST_ERROR 2
586 #define ISCSI_REASON_DATA_SNACK_REJECT 3
587 #define ISCSI_REASON_PROTOCOL_ERROR 4
588 #define ISCSI_REASON_CMD_NOT_SUPPORTED 5
589 #define ISCSI_REASON_IMM_CMD_REJECT 6
590 #define ISCSI_REASON_TASK_IN_PROGRESS 7
591 #define ISCSI_REASON_INVALID_SNACK 8
592 #define ISCSI_REASON_BOOKMARK_INVALID 9
593 #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10
594 #define ISCSI_REASON_NEGOTIATION_RESET 11
596 /* Max. number of Key=Value pairs in a text message */
597 #define MAX_KEY_VALUE_PAIRS 8192
599 /* maximum length for text keys/values */
600 #define KEY_MAXLEN 64
601 #define VALUE_MAXLEN 255
602 #define TARGET_NAME_MAXLEN VALUE_MAXLEN
604 #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192
605 #define ISCSI_MIN_MAX_RECV_SEG_LEN 512
606 #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215
608 #define ISCSI_DEF_FIRST_BURST_LEN 65536
609 #define ISCSI_MIN_FIRST_BURST_LEN 512
610 #define ISCSI_MAX_FIRST_BURST_LEN 16777215
612 #define ISCSI_DEF_MAX_BURST_LEN 262144
613 #define ISCSI_MIN_MAX_BURST_LEN 512
614 #define ISCSI_MAX_MAX_BURST_LEN 16777215
616 #define ISCSI_DEF_TIME2WAIT 2
618 /************************* RFC 3720 End *****************************/
620 #endif /* ISCSI_PROTO_H */