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_DRAFT20_VERSION 0x00
26 /* default iSCSI listen port for incoming connections */
27 #define ISCSI_LISTEN_PORT 3260
29 /* Padding word length */
30 #define ISCSI_PAD_LEN 4
33 * useful common(control and data pathes) macro
35 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
36 #define hton24(p, v) { \
37 p[0] = (((v) >> 16) & 0xFF); \
38 p[1] = (((v) >> 8) & 0xFF); \
39 p[2] = ((v) & 0xFF); \
41 #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}
43 /* initiator tags; opaque for target */
44 typedef uint32_t __bitwise__ itt_t;
45 /* below makes sense only for initiator that created this tag */
46 #define build_itt(itt, id, age) ((__force itt_t)\
47 ((itt) | ((id) << ISCSI_CID_SHIFT) | ((age) << ISCSI_AGE_SHIFT)))
48 #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK)
49 #define RESERVED_ITT ((__force itt_t)0xffffffff)
52 * iSCSI Template Message Header
56 uint8_t flags; /* Final bit */
58 uint8_t hlength; /* AHSs total length */
59 uint8_t dlength[3]; /* Data length */
61 itt_t itt; /* Initiator Task Tag, opaque for target */
62 __be32 ttt; /* Target Task Tag */
69 /************************* RFC 3720 Begin *****************************/
71 #define ISCSI_RESERVED_TAG 0xffffffff
73 /* Opcode encoding bits */
74 #define ISCSI_OP_RETRY 0x80
75 #define ISCSI_OP_IMMEDIATE 0x40
76 #define ISCSI_OPCODE_MASK 0x3F
78 /* Initiator Opcode values */
79 #define ISCSI_OP_NOOP_OUT 0x00
80 #define ISCSI_OP_SCSI_CMD 0x01
81 #define ISCSI_OP_SCSI_TMFUNC 0x02
82 #define ISCSI_OP_LOGIN 0x03
83 #define ISCSI_OP_TEXT 0x04
84 #define ISCSI_OP_SCSI_DATA_OUT 0x05
85 #define ISCSI_OP_LOGOUT 0x06
86 #define ISCSI_OP_SNACK 0x10
88 #define ISCSI_OP_VENDOR1_CMD 0x1c
89 #define ISCSI_OP_VENDOR2_CMD 0x1d
90 #define ISCSI_OP_VENDOR3_CMD 0x1e
91 #define ISCSI_OP_VENDOR4_CMD 0x1f
93 /* Target Opcode values */
94 #define ISCSI_OP_NOOP_IN 0x20
95 #define ISCSI_OP_SCSI_CMD_RSP 0x21
96 #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22
97 #define ISCSI_OP_LOGIN_RSP 0x23
98 #define ISCSI_OP_TEXT_RSP 0x24
99 #define ISCSI_OP_SCSI_DATA_IN 0x25
100 #define ISCSI_OP_LOGOUT_RSP 0x26
101 #define ISCSI_OP_R2T 0x31
102 #define ISCSI_OP_ASYNC_EVENT 0x32
103 #define ISCSI_OP_REJECT 0x3f
105 struct iscsi_ahs_hdr {
111 #define ISCSI_AHSTYPE_CDB 1
112 #define ISCSI_AHSTYPE_RLENGTH 2
114 /* iSCSI PDU Header */
122 itt_t itt; /* Initiator Task Tag */
126 uint8_t cdb[16]; /* SCSI Command Block */
127 /* Additional Data (Command Dependent) */
130 /* Command PDU flags */
131 #define ISCSI_FLAG_CMD_FINAL 0x80
132 #define ISCSI_FLAG_CMD_READ 0x40
133 #define ISCSI_FLAG_CMD_WRITE 0x20
134 #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */
136 /* SCSI Command Attribute values */
137 #define ISCSI_ATTR_UNTAGGED 0
138 #define ISCSI_ATTR_SIMPLE 1
139 #define ISCSI_ATTR_ORDERED 2
140 #define ISCSI_ATTR_HEAD_OF_QUEUE 3
141 #define ISCSI_ATTR_ACA 4
143 struct iscsi_rlength_ahdr {
150 /* Extended CDB AHS */
151 struct iscsi_ecdb_ahdr {
152 __be16 ahslength; /* CDB length - 15, including reserved byte */
155 uint8_t ecdb[260 - 16]; /* 4-byte aligned extended CDB spillover */
158 /* SCSI Response Header */
159 struct iscsi_cmd_rsp {
167 itt_t itt; /* Initiator Task Tag */
173 __be32 bi_residual_count;
174 __be32 residual_count;
175 /* Response or Sense Data (optional) */
178 /* Command Response PDU flags */
179 #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10
180 #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08
181 #define ISCSI_FLAG_CMD_OVERFLOW 0x04
182 #define ISCSI_FLAG_CMD_UNDERFLOW 0x02
184 /* iSCSI Status values. Valid if Rsp Selector bit is not set */
185 #define ISCSI_STATUS_CMD_COMPLETED 0
186 #define ISCSI_STATUS_TARGET_FAILURE 1
187 #define ISCSI_STATUS_SUBSYS_FAILURE 2
189 /* Asynchronous Event Header */
209 /* iSCSI Event Codes */
210 #define ISCSI_ASYNC_MSG_SCSI_EVENT 0
211 #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1
212 #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2
213 #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3
214 #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4
215 #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255
217 /* NOP-Out Message */
218 struct iscsi_nopout {
225 itt_t itt; /* Initiator Task Tag */
226 __be32 ttt; /* Target Transfer Tag */
240 itt_t itt; /* Initiator Task Tag */
241 __be32 ttt; /* Target Transfer Tag */
248 /* SCSI Task Management Message Header */
256 itt_t itt; /* Initiator Task Tag */
257 itt_t rtt; /* Reference Task Tag */
265 #define ISCSI_FLAG_TM_FUNC_MASK 0x7F
267 /* Function values */
268 #define ISCSI_TM_FUNC_ABORT_TASK 1
269 #define ISCSI_TM_FUNC_ABORT_TASK_SET 2
270 #define ISCSI_TM_FUNC_CLEAR_ACA 3
271 #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4
272 #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5
273 #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6
274 #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7
275 #define ISCSI_TM_FUNC_TASK_REASSIGN 8
277 /* SCSI Task Management Response Header */
278 struct iscsi_tm_rsp {
281 uint8_t response; /* see Response values below */
286 itt_t itt; /* Initiator Task Tag */
287 itt_t rtt; /* Reference Task Tag */
294 /* Response values */
295 #define ISCSI_TMF_RSP_COMPLETE 0x00
296 #define ISCSI_TMF_RSP_NO_TASK 0x01
297 #define ISCSI_TMF_RSP_NO_LUN 0x02
298 #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03
299 #define ISCSI_TMF_RSP_NO_FAILOVER 0x04
300 #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05
301 #define ISCSI_TMF_RSP_AUTH_FAILED 0x06
302 #define ISCSI_TMF_RSP_REJECTED 0xff
304 /* Ready To Transfer Header */
305 struct iscsi_r2t_rsp {
312 itt_t itt; /* Initiator Task Tag */
313 __be32 ttt; /* Target Transfer Tag */
341 /* SCSI Data Response Hdr */
342 struct iscsi_data_rsp {
357 __be32 residual_count;
360 /* Data Response PDU flags */
361 #define ISCSI_FLAG_DATA_ACK 0x40
362 #define ISCSI_FLAG_DATA_OVERFLOW 0x04
363 #define ISCSI_FLAG_DATA_UNDERFLOW 0x02
364 #define ISCSI_FLAG_DATA_STATUS 0x01
379 /* Text - key=value pairs */
382 #define ISCSI_FLAG_TEXT_CONTINUE 0x40
384 /* Text Response Header */
385 struct iscsi_text_rsp {
398 /* Text Response - key:value pairs */
405 uint8_t max_version; /* Max. version supported */
406 uint8_t min_version; /* Min. version supported */
409 uint8_t isid[6]; /* Initiator Session ID */
410 __be16 tsih; /* Target Session Handle */
411 itt_t itt; /* Initiator Task Tag */
419 /* Login PDU flags */
420 #define ISCSI_FLAG_LOGIN_TRANSIT 0x80
421 #define ISCSI_FLAG_LOGIN_CONTINUE 0x40
422 #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */
423 #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */
425 #define ISCSI_LOGIN_CURRENT_STAGE(flags) \
426 ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
427 #define ISCSI_LOGIN_NEXT_STAGE(flags) \
428 (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)
430 /* Login Response Header */
431 struct iscsi_login_rsp {
434 uint8_t max_version; /* Max. version supported */
435 uint8_t active_version; /* Active version */
438 uint8_t isid[6]; /* Initiator Session ID */
439 __be16 tsih; /* Target Session Handle */
440 itt_t itt; /* Initiator Task Tag */
445 uint8_t status_class; /* see Login RSP ststus classes below */
446 uint8_t status_detail; /* see Login RSP Status details below */
450 /* Login stage (phase) codes for CSG, NSG */
451 #define ISCSI_INITIAL_LOGIN_STAGE -1
452 #define ISCSI_SECURITY_NEGOTIATION_STAGE 0
453 #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1
454 #define ISCSI_FULL_FEATURE_PHASE 3
456 /* Login Status response classes */
457 #define ISCSI_STATUS_CLS_SUCCESS 0x00
458 #define ISCSI_STATUS_CLS_REDIRECT 0x01
459 #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02
460 #define ISCSI_STATUS_CLS_TARGET_ERR 0x03
462 /* Login Status response detail codes */
463 /* Class-0 (Success) */
464 #define ISCSI_LOGIN_STATUS_ACCEPT 0x00
466 /* Class-1 (Redirection) */
467 #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01
468 #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02
470 /* Class-2 (Initiator Error) */
471 #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00
472 #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01
473 #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02
474 #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03
475 #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04
476 #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05
477 #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06
478 #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07
479 #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08
480 #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09
481 #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a
482 #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b
484 /* Class-3 (Target Error) */
485 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00
486 #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01
487 #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02
490 struct iscsi_logout {
497 itt_t itt; /* Initiator Task Tag */
505 /* Logout PDU flags */
506 #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F
508 /* logout reason_code values */
510 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
511 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
512 #define ISCSI_LOGOUT_REASON_RECOVERY 2
513 #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3
515 /* Logout Response Header */
516 struct iscsi_logout_rsp {
519 uint8_t response; /* see Logout response values below */
524 itt_t itt; /* Initiator Task Tag */
535 /* logout response status values */
537 #define ISCSI_LOGOUT_SUCCESS 0
538 #define ISCSI_LOGOUT_CID_NOT_FOUND 1
539 #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2
540 #define ISCSI_LOGOUT_CLEANUP_FAILED 3
556 /* SNACK PDU flags */
557 #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */
559 /* Reject Message Header */
560 struct iscsi_reject {
575 /* Text - Rejected hdr */
578 /* Reason for Reject */
579 #define ISCSI_REASON_CMD_BEFORE_LOGIN 1
580 #define ISCSI_REASON_DATA_DIGEST_ERROR 2
581 #define ISCSI_REASON_DATA_SNACK_REJECT 3
582 #define ISCSI_REASON_PROTOCOL_ERROR 4
583 #define ISCSI_REASON_CMD_NOT_SUPPORTED 5
584 #define ISCSI_REASON_IMM_CMD_REJECT 6
585 #define ISCSI_REASON_TASK_IN_PROGRESS 7
586 #define ISCSI_REASON_INVALID_SNACK 8
587 #define ISCSI_REASON_BOOKMARK_INVALID 9
588 #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10
589 #define ISCSI_REASON_NEGOTIATION_RESET 11
591 /* Max. number of Key=Value pairs in a text message */
592 #define MAX_KEY_VALUE_PAIRS 8192
594 /* maximum length for text keys/values */
595 #define KEY_MAXLEN 64
596 #define VALUE_MAXLEN 255
597 #define TARGET_NAME_MAXLEN VALUE_MAXLEN
599 #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192
600 #define ISCSI_MIN_MAX_RECV_SEG_LEN 512
601 #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215
603 #define ISCSI_DEF_FIRST_BURST_LEN 65536
604 #define ISCSI_MIN_FIRST_BURST_LEN 512
605 #define ISCSI_MAX_FIRST_BURST_LEN 16777215
607 #define ISCSI_DEF_MAX_BURST_LEN 262144
608 #define ISCSI_MIN_MAX_BURST_LEN 512
609 #define ISCSI_MAX_MAX_BURST_LEN 16777215
611 #define ISCSI_DEF_TIME2WAIT 2
613 /************************* RFC 3720 End *****************************/
615 #endif /* ISCSI_PROTO_H */