xref: /openbmc/linux/drivers/infiniband/ulp/srp/ib_srp.h (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
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 
33 #ifndef IB_SRP_H
34 #define IB_SRP_H
35 
36 #include <linux/types.h>
37 #include <linux/list.h>
38 #include <linux/mutex.h>
39 #include <linux/scatterlist.h>
40 
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>
47 #include <rdma/ib_fmr_pool.h>
48 
49 enum {
50 	SRP_PATH_REC_TIMEOUT_MS	= 1000,
51 	SRP_ABORT_TIMEOUT_MS	= 5000,
52 
53 	SRP_PORT_REDIRECT	= 1,
54 	SRP_DLID_REDIRECT	= 2,
55 	SRP_STALE_CONN		= 3,
56 
57 	SRP_MAX_LUN		= 512,
58 	SRP_DEF_SG_TABLESIZE	= 12,
59 
60 	SRP_RQ_SHIFT    	= 6,
61 	SRP_RQ_SIZE		= 1 << SRP_RQ_SHIFT,
62 
63 	SRP_SQ_SIZE		= SRP_RQ_SIZE,
64 	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,
68 
69 	SRP_TAG_NO_REQ		= ~0U,
70 	SRP_TAG_TSK_MGMT	= 1U << 31,
71 
72 	SRP_FMR_SIZE		= 256,
73 	SRP_FMR_POOL_SIZE	= 1024,
74 	SRP_FMR_DIRTY_SIZE	= SRP_FMR_POOL_SIZE / 4
75 };
76 
77 enum srp_target_state {
78 	SRP_TARGET_LIVE,
79 	SRP_TARGET_CONNECTING,
80 	SRP_TARGET_DEAD,
81 	SRP_TARGET_REMOVED
82 };
83 
84 enum srp_iu_type {
85 	SRP_IU_CMD,
86 	SRP_IU_TSK_MGMT,
87 	SRP_IU_RSP,
88 };
89 
90 struct srp_device {
91 	struct list_head	dev_list;
92 	struct ib_device       *dev;
93 	struct ib_pd	       *pd;
94 	struct ib_mr	       *mr;
95 	struct ib_fmr_pool     *fmr_pool;
96 	int			fmr_page_shift;
97 	int			fmr_page_size;
98 	u64			fmr_page_mask;
99 };
100 
101 struct srp_host {
102 	struct srp_device      *srp_dev;
103 	u8			port;
104 	struct device		dev;
105 	struct list_head	target_list;
106 	spinlock_t		target_lock;
107 	struct completion	released;
108 	struct list_head	list;
109 };
110 
111 struct srp_request {
112 	struct list_head	list;
113 	struct scsi_cmnd       *scmnd;
114 	struct srp_iu	       *cmd;
115 	struct ib_pool_fmr     *fmr;
116 	short			index;
117 };
118 
119 struct srp_target_port {
120 	/* These are RW in the hot path, and commonly used together */
121 	struct list_head	free_tx;
122 	struct list_head	free_reqs;
123 	spinlock_t		lock;
124 	s32			req_lim;
125 
126 	/* These are read-only in the hot path */
127 	struct ib_cq	       *send_cq ____cacheline_aligned_in_smp;
128 	struct ib_cq	       *recv_cq;
129 	struct ib_qp	       *qp;
130 	u32			lkey;
131 	u32			rkey;
132 	enum srp_target_state	state;
133 
134 	/* Everything above this point is used in the hot path of
135 	 * command processing. Try to keep them packed into cachelines.
136 	 */
137 
138 	__be64			id_ext;
139 	__be64			ioc_guid;
140 	__be64			service_id;
141 	__be64			initiator_ext;
142 	u16			io_class;
143 	struct srp_host	       *srp_host;
144 	struct Scsi_Host       *scsi_host;
145 	char			target_name[32];
146 	unsigned int		scsi_id;
147 
148 	struct ib_sa_path_rec	path;
149 	__be16			orig_dgid[8];
150 	struct ib_sa_query     *path_query;
151 	int			path_query_id;
152 
153 	struct ib_cm_id	       *cm_id;
154 
155 	int			max_ti_iu_len;
156 
157 	int			zero_req_lim;
158 
159 	struct srp_iu	       *tx_ring[SRP_SQ_SIZE];
160 	struct srp_iu	       *rx_ring[SRP_RQ_SIZE];
161 	struct srp_request	req_ring[SRP_CMD_SQ_SIZE];
162 
163 	struct work_struct	work;
164 
165 	struct list_head	list;
166 	struct completion	done;
167 	int			status;
168 	int			qp_in_error;
169 
170 	struct completion	tsk_mgmt_done;
171 	u8			tsk_mgmt_status;
172 };
173 
174 struct srp_iu {
175 	struct list_head	list;
176 	u64			dma;
177 	void		       *buf;
178 	size_t			size;
179 	enum dma_data_direction	direction;
180 };
181 
182 #endif /* IB_SRP_H */
183