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