1/*
2 * Copyright (c) 2005 Cisco Systems.  All rights reserved.
3 *
4 * This software is available to you under a choice of one of two
5 * licenses.  You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
9 *
10 *     Redistribution and use in source and binary forms, with or
11 *     without modification, are permitted provided that the following
12 *     conditions are met:
13 *
14 *      - Redistributions of source code must retain the above
15 *        copyright notice, this list of conditions and the following
16 *        disclaimer.
17 *
18 *      - Redistributions in binary form must reproduce the above
19 *        copyright notice, this list of conditions and the following
20 *        disclaimer in the documentation and/or other materials
21 *        provided with the distribution.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * SOFTWARE.
31 *
32 * $Id$
33 */
34
35#ifndef SCSI_SRP_H
36#define SCSI_SRP_H
37
38/*
39 * Structures and constants for the SCSI RDMA Protocol (SRP) as
40 * defined by the INCITS T10 committee.  This file was written using
41 * draft Revision 16a of the SRP standard.
42 */
43
44#include <linux/types.h>
45#include <scsi/scsi.h>
46
47enum {
48	SRP_LOGIN_REQ	= 0x00,
49	SRP_TSK_MGMT	= 0x01,
50	SRP_CMD		= 0x02,
51	SRP_I_LOGOUT	= 0x03,
52	SRP_LOGIN_RSP	= 0xc0,
53	SRP_RSP		= 0xc1,
54	SRP_LOGIN_REJ	= 0xc2,
55	SRP_T_LOGOUT	= 0x80,
56	SRP_CRED_REQ	= 0x81,
57	SRP_AER_REQ	= 0x82,
58	SRP_CRED_RSP	= 0x41,
59	SRP_AER_RSP	= 0x42
60};
61
62enum {
63	SRP_BUF_FORMAT_DIRECT	= 1 << 1,
64	SRP_BUF_FORMAT_INDIRECT	= 1 << 2
65};
66
67enum {
68	SRP_NO_DATA_DESC	= 0,
69	SRP_DATA_DESC_DIRECT	= 1,
70	SRP_DATA_DESC_INDIRECT	= 2
71};
72
73enum {
74	SRP_TSK_ABORT_TASK	= 0x01,
75	SRP_TSK_ABORT_TASK_SET	= 0x02,
76	SRP_TSK_CLEAR_TASK_SET	= 0x04,
77	SRP_TSK_LUN_RESET	= 0x08,
78	SRP_TSK_CLEAR_ACA	= 0x40
79};
80
81enum srp_login_rej_reason {
82	SRP_LOGIN_REJ_UNABLE_ESTABLISH_CHANNEL		= 0x00010000,
83	SRP_LOGIN_REJ_INSUFFICIENT_RESOURCES		= 0x00010001,
84	SRP_LOGIN_REJ_REQ_IT_IU_LENGTH_TOO_LARGE	= 0x00010002,
85	SRP_LOGIN_REJ_UNABLE_ASSOCIATE_CHANNEL		= 0x00010003,
86	SRP_LOGIN_REJ_UNSUPPORTED_DESCRIPTOR_FMT	= 0x00010004,
87	SRP_LOGIN_REJ_MULTI_CHANNEL_UNSUPPORTED		= 0x00010005,
88	SRP_LOGIN_REJ_CHANNEL_LIMIT_REACHED		= 0x00010006
89};
90
91enum {
92	SRP_REV10_IB_IO_CLASS	= 0xff00,
93	SRP_REV16A_IB_IO_CLASS	= 0x0100
94};
95
96struct srp_direct_buf {
97	__be64	va;
98	__be32	key;
99	__be32  len;
100};
101
102/*
103 * We need the packed attribute because the SRP spec puts the list of
104 * descriptors at an offset of 20, which is not aligned to the size of
105 * struct srp_direct_buf.  The whole structure must be packed to avoid
106 * having the 20-byte structure padded to 24 bytes on 64-bit architectures.
107 */
108struct srp_indirect_buf {
109	struct srp_direct_buf	table_desc;
110	__be32			len;
111	struct srp_direct_buf	desc_list[0];
112} __attribute__((packed));
113
114enum {
115	SRP_MULTICHAN_SINGLE = 0,
116	SRP_MULTICHAN_MULTI  = 1
117};
118
119struct srp_login_req {
120	u8	opcode;
121	u8	reserved1[7];
122	u64	tag;
123	__be32	req_it_iu_len;
124	u8	reserved2[4];
125	__be16	req_buf_fmt;
126	u8	req_flags;
127	u8	reserved3[5];
128	u8	initiator_port_id[16];
129	u8	target_port_id[16];
130};
131
132/*
133 * The SRP spec defines the size of the LOGIN_RSP structure to be 52
134 * bytes, so it needs to be packed to avoid having it padded to 56
135 * bytes on 64-bit architectures.
136 */
137struct srp_login_rsp {
138	u8	opcode;
139	u8	reserved1[3];
140	__be32	req_lim_delta;
141	u64	tag;
142	__be32	max_it_iu_len;
143	__be32	max_ti_iu_len;
144	__be16	buf_fmt;
145	u8	rsp_flags;
146	u8	reserved2[25];
147} __attribute__((packed));
148
149struct srp_login_rej {
150	u8	opcode;
151	u8	reserved1[3];
152	__be32	reason;
153	u64	tag;
154	u8	reserved2[8];
155	__be16	buf_fmt;
156	u8	reserved3[6];
157};
158
159struct srp_i_logout {
160	u8	opcode;
161	u8	reserved[7];
162	u64	tag;
163};
164
165struct srp_t_logout {
166	u8	opcode;
167	u8	sol_not;
168	u8	reserved[2];
169	__be32	reason;
170	u64	tag;
171};
172
173/*
174 * We need the packed attribute because the SRP spec only aligns the
175 * 8-byte LUN field to 4 bytes.
176 */
177struct srp_tsk_mgmt {
178	u8	opcode;
179	u8	sol_not;
180	u8	reserved1[6];
181	u64	tag;
182	u8	reserved2[4];
183	struct scsi_lun	lun;
184	u8	reserved3[2];
185	u8	tsk_mgmt_func;
186	u8	reserved4;
187	u64	task_tag;
188	u8	reserved5[8];
189};
190
191/*
192 * We need the packed attribute because the SRP spec only aligns the
193 * 8-byte LUN field to 4 bytes.
194 */
195struct srp_cmd {
196	u8	opcode;
197	u8	sol_not;
198	u8	reserved1[3];
199	u8	buf_fmt;
200	u8	data_out_desc_cnt;
201	u8	data_in_desc_cnt;
202	u64	tag;
203	u8	reserved2[4];
204	struct scsi_lun	lun;
205	u8	reserved3;
206	u8	task_attr;
207	u8	reserved4;
208	u8	add_cdb_len;
209	u8	cdb[16];
210	u8	add_data[0];
211};
212
213enum {
214	SRP_RSP_FLAG_RSPVALID = 1 << 0,
215	SRP_RSP_FLAG_SNSVALID = 1 << 1,
216	SRP_RSP_FLAG_DOOVER   = 1 << 2,
217	SRP_RSP_FLAG_DOUNDER  = 1 << 3,
218	SRP_RSP_FLAG_DIOVER   = 1 << 4,
219	SRP_RSP_FLAG_DIUNDER  = 1 << 5
220};
221
222/*
223 * The SRP spec defines the size of the RSP structure to be 36 bytes,
224 * so it needs to be packed to avoid having it padded to 40 bytes on
225 * 64-bit architectures.
226 */
227struct srp_rsp {
228	u8	opcode;
229	u8	sol_not;
230	u8	reserved1[2];
231	__be32	req_lim_delta;
232	u64	tag;
233	u8	reserved2[2];
234	u8	flags;
235	u8	status;
236	__be32	data_out_res_cnt;
237	__be32	data_in_res_cnt;
238	__be32	sense_data_len;
239	__be32	resp_data_len;
240	u8	data[0];
241} __attribute__((packed));
242
243struct srp_cred_req {
244	u8	opcode;
245	u8	sol_not;
246	u8	reserved[2];
247	__be32	req_lim_delta;
248	u64	tag;
249};
250
251struct srp_cred_rsp {
252	u8	opcode;
253	u8	reserved[7];
254	u64	tag;
255};
256
257/*
258 * The SRP spec defines the fixed portion of the AER_REQ structure to be
259 * 36 bytes, so it needs to be packed to avoid having it padded to 40 bytes
260 * on 64-bit architectures.
261 */
262struct srp_aer_req {
263	u8	opcode;
264	u8	sol_not;
265	u8	reserved[2];
266	__be32	req_lim_delta;
267	u64	tag;
268	u32	reserved2;
269	struct scsi_lun	lun;
270	__be32	sense_data_len;
271	u32	reserved3;
272	u8	sense_data[0];
273} __attribute__((packed));
274
275struct srp_aer_rsp {
276	u8	opcode;
277	u8	reserved[7];
278	u64	tag;
279};
280
281#endif /* SCSI_SRP_H */
282