1aca7f65d9141832ad973de64e30d60f45bc02af
[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         MIN_MAX_MESSAGE_SIZE = 996,
96 };
97
98 #define SRPT_OP_RECV                    (1 << 31)
99
100 struct rdma_iu {
101         u64 raddr;
102         u32 rkey;
103         struct ib_sge *sge;
104         u32 sge_cnt;
105         int mem_id;
106 };
107
108 /* Command states. */
109 enum srpt_command_state {
110         /* New command arrived and is being processed. */
111         SRPT_STATE_NEW = 0,
112         /* Processing a write or bidir command and waiting for data arrival. */
113         SRPT_STATE_NEED_DATA = 1,
114         /* Data for the write or bidir command arrived and is being processed.*/
115         SRPT_STATE_DATA_IN = 2,
116         /* Command processing finished. */
117         SRPT_STATE_PROCESSED = 3,
118         /* Command processing has been aborted. */
119         SRPT_STATE_ABORTED = 4,
120 };
121
122 /* SRPT I/O context: SRPT-private data associated with a struct scst_cmd. */
123 struct srpt_ioctx {
124         int index;
125         void *buf;
126         dma_addr_t dma;
127         struct rdma_iu *rdma_ius;
128         struct srp_direct_buf *rbufs;
129         struct srp_direct_buf single_rbuf;
130         /* Node for insertion in srpt_rdma_ch::cmd_wait_list. */
131         struct list_head wait_list;
132         u16 n_rdma_ius;
133         u8 n_rdma;
134         u8 n_rbuf;
135
136         enum ib_wc_opcode op;
137         /* Node for insertion in the srpt_thread::thread_ioctx_list. */
138         struct list_head comp_list;
139         struct srpt_rdma_ch *ch;
140         struct scst_cmd *scmnd;
141         u64 data_len;
142         atomic_t state; /*enum srpt_command_state*/
143 };
144
145 /* Additional context information for SCST management commands. */
146 struct srpt_mgmt_ioctx {
147         struct srpt_ioctx *ioctx;
148         struct srpt_rdma_ch *ch;
149         u64 tag;
150 };
151
152 /* channel state */
153 enum rdma_ch_state {
154         RDMA_CHANNEL_CONNECTING,
155         RDMA_CHANNEL_LIVE,
156         RDMA_CHANNEL_DISCONNECTING
157 };
158
159 struct srpt_rdma_ch {
160         struct ib_cm_id *cm_id;
161         /* IB queue pair. */
162         struct ib_qp *qp;
163         /* Number of WR's in the QP 'qp' that are not in use. */
164         atomic_t qp_wr_avail;
165         struct ib_cq *cq;
166         struct srpt_port *sport;
167         /* 128-bit initiator port identifier copied from SRP_LOGIN_REQ. */
168         u8 i_port_id[16];
169         /* 128-bit target port identifier copied from SRP_LOGIN_REQ. */
170         u8 t_port_id[16];
171         atomic_t req_lim_delta;
172         spinlock_t spinlock;
173         atomic_t state; /*enum rdma_ch_state*/
174         /* Node for insertion in the srpt_device::rch_list list. */
175         struct list_head list;
176         /*
177          * List of SCST commands that arrived before the RTU event.
178          * This list contains struct srpt_ioctx elements.
179          */
180         struct list_head cmd_wait_list;
181
182         struct scst_session *scst_sess;
183         u8 sess_name[36];
184 };
185
186 struct srpt_port {
187         struct srpt_device *sdev;
188         struct ib_mad_agent *mad_agent;
189         /* One-based port number. */
190         u8 port;
191         /* Cached values of the port's sm_lid, lid and gid. */
192         u16 sm_lid;
193         u16 lid;
194         union ib_gid gid;
195         /* Work structure for refreshing the aforementioned cached values. */
196         struct work_struct work;
197 };
198
199 /*
200  * Data stored by the ib_srpt kernel module per InfiniBand device
201  * (struct ib_device).
202  */
203 struct srpt_device {
204         /* Backpointer to the struct ib_device managed by the IB core. */
205         struct ib_device *device;
206         /* Protection domain. */
207         struct ib_pd *pd;
208         /* L_Key (local key) with write access to all local memory. */
209         struct ib_mr *mr;
210         /* SRQ (shared receive queue). */
211         struct ib_srq *srq;
212         /* Connection identifier. */
213         struct ib_cm_id *cm_id;
214         /*
215          * Attributes of the InfiniBand device as obtained during the
216          * ib_client::add() callback.
217          */
218         struct ib_device_attr dev_attr;
219         struct srpt_ioctx *ioctx_ring[SRPT_SRQ_SIZE];
220         /*
221          * List node for insertion in the srpt_rdma_ch::list list.
222          * This list is protected by srpt_device::spinlock.
223          */
224         struct list_head rch_list;
225         spinlock_t spinlock;
226         struct srpt_port port[2];
227         struct ib_event_handler event_handler;
228 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26)
229         /* per-port srpt-<portname> device instance. */
230         struct class_device class_dev;
231 #else
232         struct device dev;
233 #endif
234 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
235         char init_name[20];
236 #endif
237
238         struct scst_tgt *scst_tgt;
239 };
240
241 /*
242  * Sense code/qualifier pairs (sense_data::key) as defined in the SCSI Primary
243  * Commands (SPC) standard. Bits 0 .. 3 contain the sense key, bit 4 is
244  * reserved, bit 5 is the ILI (incorrect length indicator) bit, bit 6 is the
245  * EOM (end-of-medium) bit and bit 7 is the
246  * FILEMARK bit.
247  */
248 enum {
249         NO_ADD_SENSE            = 0x00,
250         LUN_NOT_READY           = 0x04, /* HARDWARE ERROR */
251         INVALID_CDB             = 0x24, /* ILI | HARDWARE ERROR */
252         INTERNAL_TARGET_FAILURE = 0x44  /* EOM | HARDWARE ERROR */
253 };
254
255 /*
256  * Sense data structure containing three sense bytes. See also the SCSI Primary
257  * Commands (SPC) standard.
258  */
259 struct sense_data {
260         u8 err_code;
261         u8 segment_number;
262         u8 key;
263         u8 info_bytes[4];
264         u8 addl_sense_len;
265         u8 cmd_info_bytes[4];
266         u8 addl_sense_code;
267         u8 addl_sense_code_qual;
268         u16 asc_ascq;
269         u8 fru_code;
270         u8 sense_bytes[3];
271 };
272
273 #endif                          /* IB_SRPT_H */