blob: e641088c14dc37bda98e95134b4235f151e3c0fc [file] [log] [blame]
Roland Dreieraef9ec32005-11-02 14:07:13 -08001/*
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.
Roland Dreieraef9ec32005-11-02 14:07:13 -080031 */
32
33#ifndef IB_SRP_H
34#define IB_SRP_H
35
36#include <linux/types.h>
37#include <linux/list.h>
Ingo Molnar8e9e5f4f2006-01-30 15:21:21 -080038#include <linux/mutex.h>
Roland Dreiercf368712006-03-24 15:47:26 -080039#include <linux/scatterlist.h>
Roland Dreieraef9ec32005-11-02 14:07:13 -080040
41#include <scsi/scsi_host.h>
42#include <scsi/scsi_cmnd.h>
43
44#include <rdma/ib_verbs.h>
45#include <rdma/ib_sa.h>
46#include <rdma/ib_cm.h>
Roland Dreierf5358a12006-06-17 20:37:29 -070047#include <rdma/ib_fmr_pool.h>
Roland Dreieraef9ec32005-11-02 14:07:13 -080048
49enum {
50 SRP_PATH_REC_TIMEOUT_MS = 1000,
51 SRP_ABORT_TIMEOUT_MS = 5000,
52
53 SRP_PORT_REDIRECT = 1,
54 SRP_DLID_REDIRECT = 2,
David Dillow9fe4bcf2008-01-08 17:08:52 -050055 SRP_STALE_CONN = 3,
Roland Dreieraef9ec32005-11-02 14:07:13 -080056
Roland Dreier5f068992005-11-11 14:06:01 -080057 SRP_MAX_LUN = 512,
Vu Pham74b0a152006-06-17 20:37:32 -070058 SRP_DEF_SG_TABLESIZE = 12,
Roland Dreieraef9ec32005-11-02 14:07:13 -080059
60 SRP_RQ_SHIFT = 6,
61 SRP_RQ_SIZE = 1 << SRP_RQ_SHIFT,
Bart Van Asschedd5e6e32010-08-30 19:27:20 +000062
63 SRP_SQ_SIZE = SRP_RQ_SIZE,
Bart Van Asschedd5e6e32010-08-30 19:27:20 +000064 SRP_RSP_SQ_SIZE = 1,
65 SRP_REQ_SQ_SIZE = SRP_SQ_SIZE - SRP_RSP_SQ_SIZE,
66 SRP_TSK_MGMT_SQ_SIZE = 1,
67 SRP_CMD_SQ_SIZE = SRP_REQ_SQ_SIZE - SRP_TSK_MGMT_SQ_SIZE,
Roland Dreieraef9ec32005-11-02 14:07:13 -080068
David Dillowf8b6e312010-11-26 13:02:21 -050069 SRP_TAG_NO_REQ = ~0U,
70 SRP_TAG_TSK_MGMT = 1U << 31,
Roland Dreierf5358a12006-06-17 20:37:29 -070071
David Dillowbe8b9812011-01-18 21:58:09 -050072 SRP_FMR_SIZE = 512,
73 SRP_FMR_MIN_SIZE = 128,
Roland Dreierf5358a12006-06-17 20:37:29 -070074 SRP_FMR_POOL_SIZE = 1024,
David Dillow8f26c9f2011-01-14 19:45:50 -050075 SRP_FMR_DIRTY_SIZE = SRP_FMR_POOL_SIZE / 4,
76
77 SRP_MAP_ALLOW_FMR = 0,
78 SRP_MAP_NO_FMR = 1,
Roland Dreieraef9ec32005-11-02 14:07:13 -080079};
80
Roland Dreieraef9ec32005-11-02 14:07:13 -080081enum srp_target_state {
82 SRP_TARGET_LIVE,
Bart Van Asscheef6c49d2011-12-26 16:49:18 +000083 SRP_TARGET_REMOVED,
Roland Dreieraef9ec32005-11-02 14:07:13 -080084};
85
David Dillowbb125882010-10-08 14:40:47 -040086enum srp_iu_type {
87 SRP_IU_CMD,
88 SRP_IU_TSK_MGMT,
89 SRP_IU_RSP,
David Dillow8cba2072007-12-19 17:08:43 -050090};
91
Roland Dreierf5358a12006-06-17 20:37:29 -070092struct srp_device {
93 struct list_head dev_list;
Roland Dreieraef9ec32005-11-02 14:07:13 -080094 struct ib_device *dev;
Roland Dreieraef9ec32005-11-02 14:07:13 -080095 struct ib_pd *pd;
96 struct ib_mr *mr;
Roland Dreierf5358a12006-06-17 20:37:29 -070097 struct ib_fmr_pool *fmr_pool;
Roland Dreierbf628dc2006-12-15 14:01:49 -080098 u64 fmr_page_mask;
David Dillow8f26c9f2011-01-14 19:45:50 -050099 int fmr_page_size;
100 int fmr_max_size;
Roland Dreierf5358a12006-06-17 20:37:29 -0700101};
102
103struct srp_host {
Greg Kroah-Hartman05321932008-03-06 00:13:36 +0100104 struct srp_device *srp_dev;
Roland Dreierf5358a12006-06-17 20:37:29 -0700105 u8 port;
Tony Jonesee959b02008-02-22 00:13:36 +0100106 struct device dev;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800107 struct list_head target_list;
Matthew Wilcoxb3589fd2006-06-17 20:37:30 -0700108 spinlock_t target_lock;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800109 struct completion released;
110 struct list_head list;
111};
112
113struct srp_request {
114 struct list_head list;
115 struct scsi_cmnd *scmnd;
116 struct srp_iu *cmd;
David Dillow8f26c9f2011-01-14 19:45:50 -0500117 struct ib_pool_fmr **fmr_list;
118 u64 *map_page;
David Dillowc07d4242011-01-16 13:57:10 -0500119 struct srp_direct_buf *indirect_desc;
120 dma_addr_t indirect_dma_addr;
David Dillow8f26c9f2011-01-14 19:45:50 -0500121 short nfmr;
Roland Dreierd945e1d2006-05-09 10:50:28 -0700122 short index;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800123};
124
125struct srp_target_port {
David Dillow9af76272010-11-26 15:34:46 -0500126 /* These are RW in the hot path, and commonly used together */
127 struct list_head free_tx;
128 struct list_head free_reqs;
129 spinlock_t lock;
130 s32 req_lim;
131
132 /* These are read-only in the hot path */
133 struct ib_cq *send_cq ____cacheline_aligned_in_smp;
134 struct ib_cq *recv_cq;
135 struct ib_qp *qp;
136 u32 lkey;
137 u32 rkey;
138 enum srp_target_state state;
David Dillow49248642011-01-14 18:23:24 -0500139 unsigned int max_iu_len;
140 unsigned int cmd_sg_cnt;
David Dillowc07d4242011-01-16 13:57:10 -0500141 unsigned int indirect_size;
142 bool allow_ext_sg;
Bart Van Assche2ce19e72013-02-21 17:20:00 +0000143 bool transport_offline;
David Dillow9af76272010-11-26 15:34:46 -0500144
145 /* Everything above this point is used in the hot path of
146 * command processing. Try to keep them packed into cachelines.
147 */
148
Roland Dreieraef9ec32005-11-02 14:07:13 -0800149 __be64 id_ext;
150 __be64 ioc_guid;
151 __be64 service_id;
Ishai Rabinovitz01cb9bc2006-10-04 15:28:56 +0200152 __be64 initiator_ext;
Ramachandra K0c0450db2006-06-17 20:37:38 -0700153 u16 io_class;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800154 struct srp_host *srp_host;
155 struct Scsi_Host *scsi_host;
156 char target_name[32];
157 unsigned int scsi_id;
David Dillowc07d4242011-01-16 13:57:10 -0500158 unsigned int sg_tablesize;
Bart Van Assche4b5e5f42013-06-28 14:57:42 +0200159 int comp_vector;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800160
161 struct ib_sa_path_rec path;
Ishai Rabinovitz3633b3d2007-05-06 21:18:11 -0700162 __be16 orig_dgid[8];
Roland Dreieraef9ec32005-11-02 14:07:13 -0800163 struct ib_sa_query *path_query;
164 int path_query_id;
165
Bart Van Asschec9b03c12011-09-03 09:34:48 +0200166 u32 rq_tmo_jiffies;
Bart Van Assche294c8752011-12-25 12:18:12 +0000167 bool connected;
Bart Van Asschec9b03c12011-09-03 09:34:48 +0200168
Roland Dreieraef9ec32005-11-02 14:07:13 -0800169 struct ib_cm_id *cm_id;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800170
171 int max_ti_iu_len;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800172
Roland Dreier6bfa24f2006-06-17 20:37:33 -0700173 int zero_req_lim;
174
Bart Van Asschedd5e6e32010-08-30 19:27:20 +0000175 struct srp_iu *tx_ring[SRP_SQ_SIZE];
David Dillow9af76272010-11-26 15:34:46 -0500176 struct srp_iu *rx_ring[SRP_RQ_SIZE];
Bart Van Asschedd5e6e32010-08-30 19:27:20 +0000177 struct srp_request req_ring[SRP_CMD_SQ_SIZE];
Roland Dreieraef9ec32005-11-02 14:07:13 -0800178
Bart Van Asscheef6c49d2011-12-26 16:49:18 +0000179 struct work_struct remove_work;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800180
181 struct list_head list;
182 struct completion done;
183 int status;
Bart Van Assche948d1e82011-09-03 09:25:42 +0200184 bool qp_in_error;
David Dillowf8b6e312010-11-26 13:02:21 -0500185
186 struct completion tsk_mgmt_done;
187 u8 tsk_mgmt_status;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800188};
189
190struct srp_iu {
Bart Van Asschedcb4cb82010-11-26 13:22:48 -0500191 struct list_head list;
Ralph Campbell85507bc2006-12-12 14:30:55 -0800192 u64 dma;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800193 void *buf;
194 size_t size;
195 enum dma_data_direction direction;
Roland Dreieraef9ec32005-11-02 14:07:13 -0800196};
197
David Dillow8f26c9f2011-01-14 19:45:50 -0500198struct srp_map_state {
199 struct ib_pool_fmr **next_fmr;
200 struct srp_direct_buf *desc;
201 u64 *pages;
202 dma_addr_t base_dma_addr;
203 u32 fmr_len;
204 u32 total_len;
205 unsigned int npages;
206 unsigned int nfmr;
207 unsigned int ndesc;
208 struct scatterlist *unmapped_sg;
209 int unmapped_index;
210 dma_addr_t unmapped_addr;
211};
212
Roland Dreieraef9ec32005-11-02 14:07:13 -0800213#endif /* IB_SRP_H */