Added more comments.
[mirror/scst/.git] / srpt / src / ib_srpt.h
1 /*
2  * Copyright (c) 2006 - 2009 Mellanox Technology Inc.  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  */
33
34 #ifndef IB_SRPT_H
35 #define IB_SRPT_H
36
37 #include <linux/version.h>
38 #include <linux/types.h>
39 #include <linux/list.h>
40 #include <linux/mutex.h>
41
42 #include <rdma/ib_verbs.h>
43 #include <rdma/ib_sa.h>
44 #include <rdma/ib_cm.h>
45
46 #include <scsi/srp.h>
47
48 #include <scst.h>
49
50 #include "ib_dm_mad.h"
51
52 /*
53  * The prefix the ServiceName field of the ServiceName/ServiceID pair in the
54  * device management ServiceEntries attribute pair must start with, as specified
55  * in the SRP r16a document.
56  */
57 #define SRP_SERVICE_NAME_PREFIX         "SRP.T10:"
58
59 enum {
60         /*
61          * SRP IOControllerProfile attributes for SRP target ports that have
62          * not been defined in <scsi/srp.h>. Source: section B.7, table B.7
63          * in the T10 SRP r16a document.
64          */
65         SRP_PROTOCOL = 0x0108,
66         SRP_PROTOCOL_VERSION = 0x0001,
67         SRP_IO_SUBCLASS = 0x609e,
68         SRP_SEND_TO_IOC = 0x01,
69         SRP_SEND_FROM_IOC = 0x02,
70         SRP_RDMA_READ_FROM_IOC = 0x08,
71         SRP_RDMA_WRITE_FROM_IOC = 0x20,
72
73         /* See also table 24 in the T10 r16a document. */
74         SRP_TSK_MGMT_SUCCESS = 0x00,
75         SRP_TSK_MGMT_FUNC_NOT_SUPP = 0x04,
76         SRP_TSK_MGMT_FAILED = 0x05,
77
78         /* See also table 21 in the T10 r16a document. */
79         SRP_CMD_SIMPLE_Q = 0x0,
80         SRP_CMD_HEAD_OF_Q = 0x1,
81         SRP_CMD_ORDERED_Q = 0x2,
82         SRP_CMD_ACA = 0x4,
83
84         SRP_LOGIN_RSP_MULTICHAN_NO_CHAN = 0x0,
85         SRP_LOGIN_RSP_MULTICHAN_TERMINATED = 0x1,
86         SRP_LOGIN_RSP_MULTICHAN_MAINTAINED = 0x2,
87
88         SRPT_DEF_SG_TABLESIZE = 128,
89         SRPT_DEF_SG_PER_WQE = 16,
90
91         SRPT_SQ_SIZE = 128 * SRPT_DEF_SG_PER_WQE,
92         SRPT_RQ_SIZE = 128,
93         SRPT_SRQ_SIZE = 4095,
94
95         MAX_MESSAGE_SIZE = 996,
96         MAX_RDMA_SIZE = 65536
97 };
98
99 #define SRPT_OP_RECV                    (1 << 31)
100
101 struct rdma_iu {
102         u64 raddr;
103         u32 rkey;
104         struct ib_sge *sge;
105         u32 sge_cnt;
106         int mem_id;
107 };
108
109 /* Command states. */
110 enum srpt_command_state {
111         SRPT_STATE_NEW       = 0, /* New command being processed.      */
112         SRPT_STATE_PROCESSED = 1, /* Processing finished.              */
113         SRPT_STATE_NEED_DATA = 2, /* Data needed to continue.          */
114         SRPT_STATE_DATA_IN   = 3, /* Data arrived and being processed. */
115         SRPT_STATE_ABORTED   = 4, /* Command aborted.                  */
116 };
117
118 /* SRPT I/O context: SRPT-private data associated with a struct scst_cmd. */
119 struct srpt_ioctx {
120         int index;
121         void *buf;
122         dma_addr_t dma;
123         struct rdma_iu *rdma_ius;
124         struct srp_direct_buf *rbufs;
125         struct srp_direct_buf single_rbuf;
126         /* Node for insertion in srpt_rdma_ch::cmd_wait_list. */
127         struct list_head wait_list;
128         /* Node for insertion in srpt_rdma_ch::active_scmnd_list. */
129         struct list_head scmnd_list;
130         u16 n_rdma_ius;
131         u8 n_rdma;
132         u8 n_rbuf;
133
134         enum ib_wc_opcode op;
135         /* Node for insertion in the srpt_thread::thread_ioctx_list. */
136         struct list_head comp_list;
137         struct srpt_rdma_ch *ch;
138         struct scst_cmd *scmnd;
139         u64 data_len;
140         enum srpt_command_state state;
141 };
142
143 /* Additional context information for SCST management commands. */
144 struct srpt_mgmt_ioctx {
145         struct srpt_ioctx *ioctx;
146         struct srpt_rdma_ch *ch;
147         u64 tag;
148 };
149
150 /* channel state */
151 enum rdma_ch_state {
152         RDMA_CHANNEL_CONNECTING,
153         RDMA_CHANNEL_LIVE,
154         RDMA_CHANNEL_DISCONNECTING
155 };
156
157 struct srpt_rdma_ch {
158         struct ib_cm_id *cm_id;
159         struct ib_qp *qp;
160         struct ib_cq *cq;
161         struct srpt_port *sport;
162         u8 i_port_id[16];
163         u8 t_port_id[16];
164         atomic_t req_lim_delta;
165         spinlock_t spinlock;
166         enum rdma_ch_state state;
167         /* Node for insertion in the srpt_device::rch_list list. */
168         struct list_head list;
169         /* List of waiting SCST commands (containt struct srpt_ioctx elem's). */
170         struct list_head cmd_wait_list;
171         /* SCST commands being processed (contains struct srpt_ioctx elem's). */
172         struct list_head active_scmnd_list;
173         u32 active_scmnd_cnt;
174
175         struct scst_session *scst_sess;
176         u8 sess_name[36];
177 };
178
179 struct srpt_port {
180         struct srpt_device *sdev;
181         struct ib_mad_agent *mad_agent;
182         /* One-based port number. */
183         u8 port;
184         /* Cached values of the port's sm_lid, lid and gid. */
185         u16 sm_lid;
186         u16 lid;
187         union ib_gid gid;
188         /* Work structure for refreshing the aforementioned cached values. */
189         struct work_struct work;
190 };
191
192 /*
193  * Data stored by the ib_srpt kernel module per InfiniBand device
194  * (struct ib_device).
195  */
196 struct srpt_device {
197         /* Backpointer to the struct ib_device managed by the IB core. */
198         struct ib_device *device;
199         /* Protection domain. */
200         struct ib_pd *pd;
201         /* L_Key (local key) with write access to all local memory. */
202         struct ib_mr *mr;
203         /* SRQ (shared receive queue). */
204         struct ib_srq *srq;
205         /* Connection identifier. */
206         struct ib_cm_id *cm_id;
207         /*
208          * Attributes of the InfiniBand device as obtained during the
209          * ib_client::add() callback.
210          */
211         struct ib_device_attr dev_attr;
212         struct srpt_ioctx *ioctx_ring[SRPT_SRQ_SIZE];
213         /*
214          * List node for insertion in the srpt_rdma_ch::list list.
215          * This list is protected by srpt_device::spinlock.
216          */
217         struct list_head rch_list;
218         spinlock_t spinlock;
219         struct srpt_port port[2];
220         struct ib_event_handler event_handler;
221 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26)
222         /* per-port srpt-<portname> device instance. */
223         struct class_device class_dev;
224 #else
225         struct device dev;
226 #endif
227 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
228         char init_name[20];
229 #endif
230
231         struct scst_tgt *scst_tgt;
232 };
233
234 /* sense code/qualifier pairs */
235 enum {
236         NO_ADD_SENSE = 0x00,
237         LUN_NOT_READY = 0x04,
238         INVALID_CDB = 0x24,
239         INTERNAL_TARGET_FAILURE = 0x44
240 };
241
242 struct sense_data {
243         u8 err_code;
244         u8 segment_number;
245         u8 key;
246         u8 info_bytes[4];
247         u8 addl_sense_len;
248         u8 cmd_info_bytes[4];
249         u8 addl_sense_code;
250         u8 addl_sense_code_qual;
251         u16 asc_ascq;
252         u8 fru_code;
253         u8 sense_bytes[3];
254 };
255
256 #endif                          /* IB_SRPT_H */