Patch from Vu Pham <vuhuong@mellanox.com>: SRP target driver
[mirror/scst/.git] / srpt / src / ib_srpt.h
1 /*
2  * Copyright (c) 2006 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 <scsi_tgt.h>
49
50 #include "ib_dm_mad.h"
51
52 #define SRP_SERVICE_NAME_PREFIX         "SRP.T10:"
53
54 enum {
55         SRP_PROTOCOL = 0x0108,
56         SRP_PROTOCOL_VERSION = 0x0001,
57         SRP_IO_SUBCLASS = 0x609e,
58         SRP_SEND_TO_IOC = 0x01,
59         SRP_SEND_FROM_IOC = 0x02,
60         SRP_RDMA_READ_FROM_IOC = 0x08,
61         SRP_RDMA_WRITE_FROM_IOC = 0x20,
62
63         SRP_TSK_MGMT_SUCCESS = 0x00,
64         SRP_TSK_MGMT_FUNC_NOT_SUPP = 0x04,
65         SRP_TSK_MGMT_FAILED = 0x05,
66
67         SRP_CMD_SIMPLE_Q = 0x0,
68         SRP_CMD_HEAD_OF_Q = 0x1,
69         SRP_CMD_ORDERED_Q = 0x2,
70         SRP_CMD_ACA = 0x4,
71
72         SRP_LOGIN_RSP_MULTICHAN_NO_CHAN = 0x0,
73         SRP_LOGIN_RSP_MULTICHAN_TERMINATED = 0x1,
74         SRP_LOGIN_RSP_MULTICHAN_MAINTAINED = 0x2,
75
76         SRPT_DEF_SG_TABLESIZE = 128,
77         SRPT_DEF_SG_PER_WQE = 16,
78
79         SRPT_SQ_SIZE = 128 * SRPT_DEF_SG_PER_WQE,
80         SRPT_RQ_SIZE = 128,
81         SRPT_SRQ_SIZE = 4095,
82
83         MAX_MESSAGE_SIZE = 996,
84         MAX_RDMA_SIZE = 65536
85 };
86
87 #define SRPT_OP_RECV                    (1 << 31)
88
89 struct rdma_iu {
90         u64 raddr;
91         u32 rkey;
92         struct ib_sge *sge;
93         u32 sge_cnt;
94         int mem_id;
95 };
96
97 struct srpt_ioctx {
98         int index;
99         void *buf;
100         dma_addr_t dma;
101         struct rdma_iu *rdma_ius;
102         struct srp_direct_buf *rbufs;
103         struct srp_direct_buf single_rbuf;
104         struct list_head wait_list;
105         struct list_head scmnd_list;
106         u16 n_rdma_ius;
107         u8 n_rdma;
108         u8 n_rbuf;
109
110         enum ib_wc_opcode op;
111         struct list_head comp_list;
112         struct srpt_rdma_ch *ch;
113         struct scst_cmd *scmnd;
114         u64 data_len;
115 };
116
117 struct srpt_mgmt_ioctx {
118         struct srpt_ioctx *ioctx;
119         struct srpt_rdma_ch *ch;
120         u64 tag;
121 };
122
123 /* channel state */
124 enum rdma_ch_state {
125         RDMA_CHANNEL_CONNECTING,
126         RDMA_CHANNEL_LIVE,
127         RDMA_CHANNEL_DISCONNECTING
128 };
129
130 struct srpt_rdma_ch {
131         struct ib_cm_id *cm_id;
132         struct ib_qp *qp;
133         struct ib_cq *cq;
134         struct srpt_port *sport;
135         u8 i_port_id[16];
136         u8 t_port_id[16];
137         atomic_t req_lim_delta;
138         spinlock_t spinlock;
139         enum rdma_ch_state state;
140         struct list_head list;
141         struct list_head cmd_wait_list;
142         struct list_head active_scmnd_list;
143         u32 active_scmnd_cnt;
144
145         struct completion scst_sess_done;
146         struct scst_session *scst_sess;
147         u8 sess_name[32];
148 };
149
150 struct srpt_port {
151         struct srpt_device *sdev;
152         struct ib_mad_agent *mad_agent;
153         u8 port;
154         u16 sm_lid;
155         u16 lid;
156         union ib_gid gid;
157         struct work_struct work;
158 };
159
160 struct srpt_device {
161         struct ib_device *device;
162         struct ib_pd *pd;
163         struct ib_mr *mr;
164         struct ib_srq *srq;
165         struct ib_cm_id *cm_id;
166         struct ib_device_attr dev_attr;
167         struct srpt_ioctx *ioctx_ring[SRPT_SRQ_SIZE];
168         struct list_head list;
169         struct list_head rch_list;
170         spinlock_t spinlock;
171         struct srpt_port port[2];
172         struct ib_event_handler event_handler;
173         struct completion scst_released;
174         struct class_device class_dev;
175
176         struct scst_tgt *scst_tgt;
177 };
178
179 /* sense code/qualifier pairs */
180 enum {
181         NO_ADD_SENSE = 0x00,
182         LUN_NOT_READY = 0x04,
183         INVALID_CDB = 0x24,
184         INTERNAL_TARGET_FAILURE = 0x44
185 };
186
187 struct sense_data {
188         u8 err_code;
189         u8 segment_number;
190         u8 key;
191         u8 info_bytes[4];
192         u8 addl_sense_len;
193         u8 cmd_info_bytes[4];
194         u8 addl_sense_code;
195         u8 addl_sense_code_qual;
196         u16 asc_ascq;
197         u8 fru_code;
198         u8 sense_bytes[3];
199 };
200
201 #endif                          /* IB_SRPT_H */