xref: /illumos-gate/usr/src/uts/common/io/scsi/adapters/iscsi/isns_protocol.h (revision fcf3ce441efd61da9bb2884968af01cb7c1452cc)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_ISNS_PROTOCOL_H
27 #define	_ISNS_PROTOCOL_H
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #include <netinet/in.h>
34 #include <sys/socket.h>
35 #include <sys/types.h>
36 
37 #define	ISNSP_VERSION			(0x01)
38 
39 #define	ISNS_DEFAULT_SERVER_PORT	(3205)
40 
41 #define	ISNSP_HEADER_SIZE		(12)
42 #define	ISNSP_MAX_PAYLOAD_SIZE		(65532)
43 #define	ISNSP_MAX_PDU_SIZE		(ISNSP_HEADER_SIZE + \
44 					ISNSP_MAX_PAYLOAD_SIZE)
45 
46 #define	ISNS_TLV_ATTR_ID_LEN		(4)
47 #define	ISNS_TLV_ATTR_LEN_LEN		(4)
48 #define	MAX_ISNS_MESG_ATTR_ENTRIES	(8)
49 #define	MAX_ISNS_OPER_ATTR_ENTRIES	(32)
50 
51 /* iSNS Entity Protocol, iSNS Draft - section 6.2.2. */
52 #define	ISNS_ENTITY_PROTOCOL_NO		(1)
53 #define	ISNS_ENTITY_PROTOCOL_ISCSI	(2)
54 #define	ISNS_ENTITY_PROTOCOL_FCP	(3)
55 
56 /* iSNS Function IDs, iSNS Draft - section 4.1.3. */
57 #define	ISNS_DEV_ATTR_REG		(0x0001)
58 #define	ISNS_DEV_ATTR_QRY		(0x0002)
59 #define	ISNS_DEV_GET_NEXT		(0x0003)
60 #define	ISNS_DEV_DEREG			(0x0004)
61 #define	ISNS_SCN_REG			(0x0005)
62 #define	ISNS_SCN_DEREG			(0x0006)
63 #define	ISNS_SCN			(0x0008)
64 #define	ISNS_ESI			(0x000D)
65 #define	ISNS_HEARTBEAT			(0x000E)
66 #define	ISNS_DEV_ATTR_REG_RSP		(0x8001)
67 #define	ISNS_DEV_ATTR_QRY_RSP		(0x8002)
68 #define	ISNS_DEV_DEREG_RSP		(0x8004)
69 #define	ISNS_SCN_REG_RSP		(0x8005)
70 #define	ISNS_SCN_DEREG_RSP		(0x8006)
71 #define	ISNS_SCN_RSP			(0x8008)
72 #define	ISNS_ESI_RSP			(0x800D)
73 
74 /* iSNS Flags, iSNS Draft - section 5.1.4. */
75 #define	ISNS_FLAG_FIRST_PDU		(0x0400)
76 #define	ISNS_FLAG_LAST_PDU		(0x0800)
77 #define	ISNS_FLAG_REPLACE_REG		(0x1000)
78 #define	ISNS_FLAG_AUTH_BLK_PRESENTED	(0x2000)
79 #define	ISNS_FLAG_SERVER		(0x4000)
80 #define	ISNS_FLAG_CLIENT		(0x8000)
81 
82 /* iSNS Response Status, iSNS Draft - section 5.4 */
83 #define	ISNS_RSP_SUCCESSFUL		(0)
84 #define	ISNS_RSP_UNKNOWN_ERROR		(1)
85 #define	ISNS_RSP_MSG_FORMAT_ERROR	(2)
86 #define	ISNS_RSP_INVALID_REGIS		(3)
87 #define	ISNS_RSP_INVALID_QRY		(5)
88 #define	ISNS_RSP_SRC_UNKNOWN		(6)
89 #define	ISNS_RSP_SRC_ABSENT		(7)
90 #define	ISNS_RSP_SRC_UNAUTHORIZED	(8)
91 #define	ISNS_RSP_NO_SUCH_ENTRY		(9)
92 #define	ISNS_RSP_VER_NOT_SUPPORTED	(10)
93 #define	ISNS_RSP_INTERNAL_ERROR		(11)
94 #define	ISNS_RSP_BUSY			(12)
95 #define	ISNS_RSP_OPTION_NOT_UNDERSTOOD	(13)
96 #define	ISNS_RSP_INVALID_UPDATE		(14)
97 #define	ISNS_RSP_MSG_NOT_SUPPORTED	(15)
98 #define	ISNS_RSP_SCN_EVENT_REJECTED	(16)
99 #define	ISNS_RSP_SCN_REGIS_REJECTED	(17)
100 #define	ISNS_RSP_ATTR_NOT_IMPL		(18)
101 #define	ISNS_RSP_ESI_NOT_AVAILABLE	(21)
102 #define	ISNS_RSP_INVALID_DEREGIS	(22)
103 #define	ISNS_RSP_REGIS_NOT_SUPPORTED	(23)
104 
105 /* iSCSI Node Type, iSNS Draft - section 6.4.2. */
106 #define	ISNS_TARGET_NODE_TYPE		(0x0001)
107 #define	ISNS_INITIATOR_NODE_TYPE	(0x0002)
108 #define	ISNS_CONTROL_NODE_TYPE		(0x0004)
109 
110 /* iSCSI Node SCN Bitmap, iSNS Draft - section 6.4.4. */
111 #define	ISNS_INIT_SELF_INFO_ONLY	(0x0080)	/* Bit 24 */
112 #define	ISNS_TARGET_SELF_INFO_ONLY	(0x0040)	/* Bit 25 */
113 #define	ISNS_MGMT_REG			(0x0020)	/* Bit 26 */
114 #define	ISNS_OBJ_REMOVED		(0x0010)	/* Bit 27 */
115 #define	ISNS_OBJ_ADDED			(0x0008)	/* Bit 28 */
116 #define	ISNS_OBJ_UPDATED		(0x0004)	/* Bit 29 */
117 #define	ISNS_OBJ_MEMBER_REMOVED		(0x0002)	/* Bit 30 */
118 #define	ISNS_OBJ_MEMBER_ADDED		(0x0001)	/* Bit 31 */
119 
120 /* iSNS Attribute IDs, iSNS Draft - section 6.1. */
121 #define	ISNS_DELIMITER_ATTR_ID		(0)
122 #define	ISNS_EID_ATTR_ID		(1)
123 #define	ISNS_ENTITY_PROTOCOL_ATTR_ID	(2)
124 #define	ISNS_TIMESTAMP_ATTR_ID		(4)
125 #define	ISNS_PORTAL_IP_ADDR_ATTR_ID	(16)
126 #define	ISNS_PORTAL_PORT_ATTR_ID	(17)
127 #define	ISNS_PORTAL_NAME_ATTR_ID	(18)
128 #define	ISNS_ESI_INTERVAL_ATTR_ID	(19)
129 #define	ISNS_ESI_PORT_ATTR_ID		(20)
130 #define	ISNS_SCN_PORT_ATTR_ID		(23)
131 #define	ISNS_ISCSI_NAME_ATTR_ID		(32)
132 #define	ISNS_ISCSI_NODE_TYPE_ATTR_ID	(33)
133 #define	ISNS_ISCSI_ALIAS_ATTR_ID	(34)
134 #define	ISNS_ISCSI_SCN_BITMAP_ATTR_ID	(35)
135 #define	ISNS_PG_ISCSI_NAME_ATTR_ID	(48)
136 #define	ISNS_PG_PORTAL_IP_ADDR_ATTR_ID	(49)
137 #define	ISNS_PG_PORTAL_PORT_ATTR_ID	(50)
138 #define	ISNS_PG_TAG_ATTR_ID		(51)
139 #define	ISNS_PG_INDEX_ATTR_ID		(52)
140 
141 /* iSNS Defaults */
142 #define	ISNS_DEFAULT_SERVER_PORT	(3205)
143 
144 typedef struct isns_tlv {
145 	uint32_t attr_id;
146 	uint32_t attr_len;
147 	uint8_t attr_value[1];
148 } isns_tlv_t;
149 
150 typedef struct isns_packet_data {
151 	uint16_t version;
152 	uint16_t func_id;
153 	uint16_t payload_len;
154 	uint16_t flags;
155 	uint16_t xid;
156 	uint16_t seq;
157 
158 	int num_of_tlvs;
159 	isns_tlv_t tlvs[MAX_ISNS_OPER_ATTR_ENTRIES];
160 } isns_packet_data_t;
161 
162 typedef struct isns_reg_mesg {
163 	isns_tlv_t src_attr;
164 	int num_of_mesg_attrs;
165 	isns_tlv_t *mesg_attrs[MAX_ISNS_MESG_ATTR_ENTRIES];
166 	isns_tlv_t delimiter_attr;
167 	isns_tlv_t *operating_attrs[MAX_ISNS_OPER_ATTR_ENTRIES];
168 } isns_reg_mesg_t;
169 
170 typedef struct isns_resp_mesg {
171 	uint8_t	status[4];
172 	isns_tlv_t messages_attrs[MAX_ISNS_MESG_ATTR_ENTRIES];
173 	isns_tlv_t delimiter_attr;
174 	isns_tlv_t operating_attrs[MAX_ISNS_OPER_ATTR_ENTRIES];
175 } isns_resp_mesg_t;
176 
177 typedef struct isns_pdu {
178 	uint16_t version;
179 	uint16_t func_id;
180 	uint16_t payload_len;
181 	uint16_t flags;
182 	uint16_t xid;
183 	uint16_t seq;
184 	uint8_t payload[1];
185 } isns_pdu_t;
186 
187 typedef struct isns_resp {
188 	uint32_t status;
189 	uint8_t data[1];
190 } isns_resp_t;
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 
196 #endif /* _ISNS_PROTOCOL_H */
197