xref: /NextBSD/sys/ofed/drivers/infiniband/core/mad_priv.h (revision 287e3b14e9552995def1802ec9c5034f4adf28ec)
1 /*
2  * Copyright (c) 2004, 2005, Voltaire, Inc. All rights reserved.
3  * Copyright (c) 2005 Intel Corporation. All rights reserved.
4  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
5  * Copyright (c) 2009 HNR Consulting. All rights reserved.
6  *
7  * This software is available to you under a choice of one of two
8  * licenses.  You may choose to be licensed under the terms of the GNU
9  * General Public License (GPL) Version 2, available from the file
10  * COPYING in the main directory of this source tree, or the
11  * OpenIB.org BSD license below:
12  *
13  *     Redistribution and use in source and binary forms, with or
14  *     without modification, are permitted provided that the following
15  *     conditions are met:
16  *
17  *      - Redistributions of source code must retain the above
18  *        copyright notice, this list of conditions and the following
19  *        disclaimer.
20  *
21  *      - Redistributions in binary form must reproduce the above
22  *        copyright notice, this list of conditions and the following
23  *        disclaimer in the documentation and/or other materials
24  *        provided with the distribution.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  */
35 
36 #ifndef __IB_MAD_PRIV_H__
37 #define __IB_MAD_PRIV_H__
38 
39 #include <linux/completion.h>
40 #include <linux/err.h>
41 #include <linux/workqueue.h>
42 #include <rdma/ib_mad.h>
43 #include <rdma/ib_smi.h>
44 
45 
46 #define PFX "ib_mad: "
47 
48 #define IB_MAD_QPS_CORE		2 /* Always QP0 and QP1 as a minimum */
49 
50 /* QP and CQ parameters */
51 #define IB_MAD_QP_SEND_SIZE	128
52 #define IB_MAD_QP_RECV_SIZE	512
53 #define IB_MAD_QP_MIN_SIZE	64
54 #define IB_MAD_QP_MAX_SIZE	8192
55 #define IB_MAD_SEND_REQ_MAX_SG	2
56 #define IB_MAD_RECV_REQ_MAX_SG	1
57 
58 #define IB_MAD_SEND_Q_PSN	0
59 
60 /* Registration table sizes */
61 #define MAX_MGMT_CLASS		80
62 #define MAX_MGMT_VERSION	8
63 #define MAX_MGMT_OUI		8
64 #define MAX_MGMT_VENDOR_RANGE2	(IB_MGMT_CLASS_VENDOR_RANGE2_END - \
65 				IB_MGMT_CLASS_VENDOR_RANGE2_START + 1)
66 
67 struct ib_mad_list_head {
68 	struct list_head list;
69 	struct ib_mad_queue *mad_queue;
70 };
71 
72 struct ib_mad_private_header {
73 	struct ib_mad_list_head mad_list;
74 	struct ib_mad_recv_wc recv_wc;
75 	struct ib_wc wc;
76 	u64 mapping;
77 } __attribute__ ((packed));
78 
79 struct ib_mad_private {
80 	struct ib_mad_private_header header;
81 	struct ib_grh grh;
82 	union {
83 		struct ib_mad mad;
84 		struct ib_rmpp_mad rmpp_mad;
85 		struct ib_smp smp;
86 	} mad;
87 } __attribute__ ((packed));
88 
89 struct ib_rmpp_segment {
90 	struct list_head list;
91 	u32 num;
92 	u8 data[0];
93 };
94 
95 struct ib_mad_agent_private {
96 	struct list_head agent_list;
97 	struct ib_mad_agent agent;
98 	struct ib_mad_reg_req *reg_req;
99 	struct ib_mad_qp_info *qp_info;
100 
101 	spinlock_t lock;
102 	struct list_head send_list;
103 	struct list_head wait_list;
104 	struct list_head done_list;
105 	struct delayed_work timed_work;
106 	unsigned long timeout;
107 	struct list_head local_list;
108 	struct work_struct local_work;
109 	struct list_head rmpp_list;
110 
111 	atomic_t refcount;
112 	struct completion comp;
113 };
114 
115 struct ib_mad_snoop_private {
116 	struct ib_mad_agent agent;
117 	struct ib_mad_qp_info *qp_info;
118 	int snoop_index;
119 	int mad_snoop_flags;
120 	atomic_t refcount;
121 	struct completion comp;
122 };
123 
124 /* Structure for timeout-fifo entry */
125 struct tf_entry {
126 	unsigned long exp_time;	    /* entry expiration time */
127 	struct list_head fifo_list; /* to keep entries in fifo order */
128 	struct list_head to_list;   /* to keep entries in timeout order */
129 	int canceled;		    /* indicates whether entry is canceled */
130 };
131 
132 struct ib_mad_send_wr_private {
133 	struct ib_mad_list_head mad_list;
134 	struct list_head agent_list;
135 	struct ib_mad_agent_private *mad_agent_priv;
136 	struct ib_mad_send_buf send_buf;
137 	u64 header_mapping;
138 	u64 payload_mapping;
139 	struct ib_send_wr send_wr;
140 	struct ib_sge sg_list[IB_MAD_SEND_REQ_MAX_SG];
141 	__be64 tid;
142 	unsigned long timeout;
143 	int max_retries;
144 	int retries_left;
145 	int retry;
146 	int refcount;
147 	enum ib_wc_status status;
148 
149 	/* RMPP control */
150 	struct list_head rmpp_list;
151 	struct ib_rmpp_segment *last_ack_seg;
152 	struct ib_rmpp_segment *cur_seg;
153 	int last_ack;
154 	int seg_num;
155 	int newwin;
156 	int pad;
157 
158 	/* SA congestion controlled MAD */
159 	int is_sa_cc_mad;
160 	struct tf_entry tf_list;
161 };
162 
163 struct ib_mad_local_private {
164 	struct list_head completion_list;
165 	struct ib_mad_private *mad_priv;
166 	struct ib_mad_agent_private *recv_mad_agent;
167 	struct ib_mad_send_wr_private *mad_send_wr;
168 };
169 
170 struct ib_mad_mgmt_method_table {
171 	struct ib_mad_agent_private *agent[IB_MGMT_MAX_METHODS];
172 };
173 
174 struct ib_mad_mgmt_class_table {
175 	struct ib_mad_mgmt_method_table *method_table[MAX_MGMT_CLASS];
176 };
177 
178 struct ib_mad_mgmt_vendor_class {
179 	u8	oui[MAX_MGMT_OUI][3];
180 	struct ib_mad_mgmt_method_table *method_table[MAX_MGMT_OUI];
181 };
182 
183 struct ib_mad_mgmt_vendor_class_table {
184 	struct ib_mad_mgmt_vendor_class *vendor_class[MAX_MGMT_VENDOR_RANGE2];
185 };
186 
187 struct ib_mad_mgmt_version_table {
188 	struct ib_mad_mgmt_class_table *class;
189 	struct ib_mad_mgmt_vendor_class_table *vendor;
190 };
191 
192 struct ib_mad_queue {
193 	spinlock_t lock;
194 	struct list_head list;
195 	int count;
196 	int max_active;
197 	struct ib_mad_qp_info *qp_info;
198 };
199 
200 struct ib_mad_qp_info {
201 	struct ib_mad_port_private *port_priv;
202 	struct ib_qp *qp;
203 	struct ib_mad_queue send_queue;
204 	struct ib_mad_queue recv_queue;
205 	struct list_head overflow_list;
206 	spinlock_t snoop_lock;
207 	struct ib_mad_snoop_private **snoop_table;
208 	int snoop_table_size;
209 	atomic_t snoop_count;
210 };
211 
212 struct to_fifo {
213 	struct list_head to_head;
214 	struct list_head fifo_head;
215 	spinlock_t lists_lock;
216 	struct timer_list timer;
217 	struct work_struct work;
218 	u32 fifo_size;
219 	u32 num_items;
220 	int stop_enqueue;
221 	struct workqueue_struct *workq;
222 };
223 
224 /* SA congestion control data */
225 struct sa_cc_data {
226 	spinlock_t lock;
227 	unsigned long outstanding;
228 	struct to_fifo  *tf;
229 };
230 
231 struct ib_mad_port_private {
232 	struct list_head port_list;
233 	struct ib_device *device;
234 	int port_num;
235 	struct ib_cq *cq;
236 	struct ib_pd *pd;
237 	struct ib_mr *mr;
238 
239 	spinlock_t reg_lock;
240 	struct ib_mad_mgmt_version_table version[MAX_MGMT_VERSION];
241 	struct list_head agent_list;
242 	struct workqueue_struct *wq;
243 	struct work_struct work;
244 	struct ib_mad_qp_info qp_info[IB_MAD_QPS_CORE];
245 	struct sa_cc_data sa_cc;
246 };
247 
248 int ib_send_mad(struct ib_mad_send_wr_private *mad_send_wr);
249 
250 struct ib_mad_send_wr_private *
251 ib_find_send_mad(struct ib_mad_agent_private *mad_agent_priv,
252 		 struct ib_mad_recv_wc *mad_recv_wc);
253 
254 void ib_mad_complete_send_wr(struct ib_mad_send_wr_private *mad_send_wr,
255 			     struct ib_mad_send_wc *mad_send_wc);
256 
257 void ib_mark_mad_done(struct ib_mad_send_wr_private *mad_send_wr);
258 
259 void ib_reset_mad_timeout(struct ib_mad_send_wr_private *mad_send_wr,
260 			  int timeout_ms);
261 
262 #endif	/* __IB_MAD_PRIV_H__ */
263