1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
4 * Copyright (c) 2004 Mellanox Technologies Ltd. All rights reserved.
5 * Copyright (c) 2004 Infinicon Corporation. All rights reserved.
6 * Copyright (c) 2004 Intel Corporation. All rights reserved.
7 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
8 * Copyright (c) 2004-2006 Voltaire Corporation. All rights reserved.
9 *
10 * This software is available to you under a choice of one of two
11 * licenses. You may choose to be licensed under the terms of the GNU
12 * General Public License (GPL) Version 2, available from the file
13 * COPYING in the main directory of this source tree, or the
14 * OpenIB.org BSD license below:
15 *
16 * Redistribution and use in source and binary forms, with or
17 * without modification, are permitted provided that the following
18 * conditions are met:
19 *
20 * - Redistributions of source code must retain the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer.
23 *
24 * - Redistributions in binary form must reproduce the above
25 * copyright notice, this list of conditions and the following
26 * disclaimer in the documentation and/or other materials
27 * provided with the distribution.
28 *
29 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
33 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
34 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
35 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 * SOFTWARE.
37 */
38
39 #if !defined(IB_MAD_H)
40 #define IB_MAD_H
41
42 #include <linux/list.h>
43
44 #include <rdma/ib_verbs.h>
45 #include <uapi/rdma/ib_user_mad.h>
46
47 /* Management base versions */
48 #define IB_MGMT_BASE_VERSION 1
49 #define OPA_MGMT_BASE_VERSION 0x80
50
51 #define OPA_SMP_CLASS_VERSION 0x80
52
53 /* Management classes */
54 #define IB_MGMT_CLASS_SUBN_LID_ROUTED 0x01
55 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE 0x81
56 #define IB_MGMT_CLASS_SUBN_ADM 0x03
57 #define IB_MGMT_CLASS_PERF_MGMT 0x04
58 #define IB_MGMT_CLASS_BM 0x05
59 #define IB_MGMT_CLASS_DEVICE_MGMT 0x06
60 #define IB_MGMT_CLASS_CM 0x07
61 #define IB_MGMT_CLASS_SNMP 0x08
62 #define IB_MGMT_CLASS_DEVICE_ADM 0x10
63 #define IB_MGMT_CLASS_BOOT_MGMT 0x11
64 #define IB_MGMT_CLASS_BIS 0x12
65 #define IB_MGMT_CLASS_CONG_MGMT 0x21
66 #define IB_MGMT_CLASS_VENDOR_RANGE2_START 0x30
67 #define IB_MGMT_CLASS_VENDOR_RANGE2_END 0x4F
68
69 #define IB_OPENIB_OUI (0x001405)
70
71 /* Management methods */
72 #define IB_MGMT_METHOD_GET 0x01
73 #define IB_MGMT_METHOD_SET 0x02
74 #define IB_MGMT_METHOD_GET_RESP 0x81
75 #define IB_MGMT_METHOD_SEND 0x03
76 #define IB_MGMT_METHOD_TRAP 0x05
77 #define IB_MGMT_METHOD_REPORT 0x06
78 #define IB_MGMT_METHOD_REPORT_RESP 0x86
79 #define IB_MGMT_METHOD_TRAP_REPRESS 0x07
80
81 #define IB_MGMT_METHOD_RESP 0x80
82 #define IB_BM_ATTR_MOD_RESP cpu_to_be32(1)
83
84 #define IB_MGMT_MAX_METHODS 128
85
86 /* MAD Status field bit masks */
87 #define IB_MGMT_MAD_STATUS_SUCCESS 0x0000
88 #define IB_MGMT_MAD_STATUS_BUSY 0x0001
89 #define IB_MGMT_MAD_STATUS_REDIRECT_REQD 0x0002
90 #define IB_MGMT_MAD_STATUS_BAD_VERSION 0x0004
91 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD 0x0008
92 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD_ATTRIB 0x000c
93 #define IB_MGMT_MAD_STATUS_INVALID_ATTRIB_VALUE 0x001c
94
95 /* RMPP information */
96 #define IB_MGMT_RMPP_VERSION 1
97
98 #define IB_MGMT_RMPP_TYPE_DATA 1
99 #define IB_MGMT_RMPP_TYPE_ACK 2
100 #define IB_MGMT_RMPP_TYPE_STOP 3
101 #define IB_MGMT_RMPP_TYPE_ABORT 4
102
103 #define IB_MGMT_RMPP_FLAG_ACTIVE 1
104 #define IB_MGMT_RMPP_FLAG_FIRST (1<<1)
105 #define IB_MGMT_RMPP_FLAG_LAST (1<<2)
106
107 #define IB_MGMT_RMPP_NO_RESPTIME 0x1F
108
109 #define IB_MGMT_RMPP_STATUS_SUCCESS 0
110 #define IB_MGMT_RMPP_STATUS_RESX 1
111 #define IB_MGMT_RMPP_STATUS_ABORT_MIN 118
112 #define IB_MGMT_RMPP_STATUS_T2L 118
113 #define IB_MGMT_RMPP_STATUS_BAD_LEN 119
114 #define IB_MGMT_RMPP_STATUS_BAD_SEG 120
115 #define IB_MGMT_RMPP_STATUS_BADT 121
116 #define IB_MGMT_RMPP_STATUS_W2S 122
117 #define IB_MGMT_RMPP_STATUS_S2B 123
118 #define IB_MGMT_RMPP_STATUS_BAD_STATUS 124
119 #define IB_MGMT_RMPP_STATUS_UNV 125
120 #define IB_MGMT_RMPP_STATUS_TMR 126
121 #define IB_MGMT_RMPP_STATUS_UNSPEC 127
122 #define IB_MGMT_RMPP_STATUS_ABORT_MAX 127
123
124 #define IB_QP0 0
125 #define IB_QP1 cpu_to_be32(1)
126 #define IB_QP1_QKEY 0x80010000
127 #define IB_QP_SET_QKEY 0x80000000
128
129 #define IB_DEFAULT_PKEY_PARTIAL 0x7FFF
130 #define IB_DEFAULT_PKEY_FULL 0xFFFF
131
132 /*
133 * Generic trap/notice types
134 */
135 #define IB_NOTICE_TYPE_FATAL 0x80
136 #define IB_NOTICE_TYPE_URGENT 0x81
137 #define IB_NOTICE_TYPE_SECURITY 0x82
138 #define IB_NOTICE_TYPE_SM 0x83
139 #define IB_NOTICE_TYPE_INFO 0x84
140
141 /*
142 * Generic trap/notice producers
143 */
144 #define IB_NOTICE_PROD_CA cpu_to_be16(1)
145 #define IB_NOTICE_PROD_SWITCH cpu_to_be16(2)
146 #define IB_NOTICE_PROD_ROUTER cpu_to_be16(3)
147 #define IB_NOTICE_PROD_CLASS_MGR cpu_to_be16(4)
148
149 enum {
150 IB_MGMT_MAD_HDR = 24,
151 IB_MGMT_MAD_DATA = 232,
152 IB_MGMT_RMPP_HDR = 36,
153 IB_MGMT_RMPP_DATA = 220,
154 IB_MGMT_VENDOR_HDR = 40,
155 IB_MGMT_VENDOR_DATA = 216,
156 IB_MGMT_SA_HDR = 56,
157 IB_MGMT_SA_DATA = 200,
158 IB_MGMT_DEVICE_HDR = 64,
159 IB_MGMT_DEVICE_DATA = 192,
160 IB_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + IB_MGMT_MAD_DATA,
161 OPA_MGMT_MAD_DATA = 2024,
162 OPA_MGMT_RMPP_DATA = 2012,
163 OPA_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + OPA_MGMT_MAD_DATA,
164 };
165
166 struct ib_mad_hdr {
167 u8 base_version;
168 u8 mgmt_class;
169 u8 class_version;
170 u8 method;
171 __be16 status;
172 __be16 class_specific;
173 __be64 tid;
174 __be16 attr_id;
175 __be16 resv;
176 __be32 attr_mod;
177 };
178
179 struct ib_rmpp_hdr {
180 u8 rmpp_version;
181 u8 rmpp_type;
182 u8 rmpp_rtime_flags;
183 u8 rmpp_status;
184 __be32 seg_num;
185 __be32 paylen_newwin;
186 };
187
188 typedef u64 __bitwise ib_sa_comp_mask;
189
190 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
191
192 /*
193 * ib_sa_hdr and ib_sa_mad structures must be packed because they have
194 * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
195 * lay them out wrong otherwise. (And unfortunately they are sent on
196 * the wire so we can't change the layout)
197 */
198 struct ib_sa_hdr {
199 __be64 sm_key;
200 __be16 attr_offset;
201 __be16 reserved;
202 ib_sa_comp_mask comp_mask;
203 } __attribute__ ((packed));
204
205 struct ib_mad {
206 struct ib_mad_hdr mad_hdr;
207 u8 data[IB_MGMT_MAD_DATA];
208 };
209
210 struct opa_mad {
211 struct ib_mad_hdr mad_hdr;
212 u8 data[OPA_MGMT_MAD_DATA];
213 };
214
215 struct ib_rmpp_mad {
216 struct ib_mad_hdr mad_hdr;
217 struct ib_rmpp_hdr rmpp_hdr;
218 u8 data[IB_MGMT_RMPP_DATA];
219 };
220
221 struct opa_rmpp_mad {
222 struct ib_mad_hdr mad_hdr;
223 struct ib_rmpp_hdr rmpp_hdr;
224 u8 data[OPA_MGMT_RMPP_DATA];
225 };
226
227 struct ib_sa_mad {
228 struct ib_mad_hdr mad_hdr;
229 struct ib_rmpp_hdr rmpp_hdr;
230 struct ib_sa_hdr sa_hdr;
231 u8 data[IB_MGMT_SA_DATA];
232 } __attribute__ ((packed));
233
234 struct ib_vendor_mad {
235 struct ib_mad_hdr mad_hdr;
236 struct ib_rmpp_hdr rmpp_hdr;
237 u8 reserved;
238 u8 oui[3];
239 u8 data[IB_MGMT_VENDOR_DATA];
240 };
241
242 #define IB_MGMT_CLASSPORTINFO_ATTR_ID cpu_to_be16(0x0001)
243
244 #define IB_CLASS_PORT_INFO_RESP_TIME_MASK 0x1F
245 #define IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE 5
246
247 struct ib_class_port_info {
248 u8 base_version;
249 u8 class_version;
250 __be16 capability_mask;
251 /* 27 bits for cap_mask2, 5 bits for resp_time */
252 __be32 cap_mask2_resp_time;
253 u8 redirect_gid[16];
254 __be32 redirect_tcslfl;
255 __be16 redirect_lid;
256 __be16 redirect_pkey;
257 __be32 redirect_qp;
258 __be32 redirect_qkey;
259 u8 trap_gid[16];
260 __be32 trap_tcslfl;
261 __be16 trap_lid;
262 __be16 trap_pkey;
263 __be32 trap_hlqp;
264 __be32 trap_qkey;
265 };
266
267 #define OPA_CLASS_PORT_INFO_PR_SUPPORT BIT(26)
268
269 struct opa_class_port_info {
270 u8 base_version;
271 u8 class_version;
272 __be16 cap_mask;
273 __be32 cap_mask2_resp_time;
274
275 u8 redirect_gid[16];
276 __be32 redirect_tc_fl;
277 __be32 redirect_lid;
278 __be32 redirect_sl_qp;
279 __be32 redirect_qkey;
280
281 u8 trap_gid[16];
282 __be32 trap_tc_fl;
283 __be32 trap_lid;
284 __be32 trap_hl_qp;
285 __be32 trap_qkey;
286
287 __be16 trap_pkey;
288 __be16 redirect_pkey;
289
290 u8 trap_sl_rsvd;
291 u8 reserved[3];
292 } __packed;
293
294 /**
295 * ib_get_cpi_resp_time - Returns the resp_time value from
296 * cap_mask2_resp_time in ib_class_port_info.
297 * @cpi: A struct ib_class_port_info mad.
298 */
ib_get_cpi_resp_time(struct ib_class_port_info * cpi)299 static inline u8 ib_get_cpi_resp_time(struct ib_class_port_info *cpi)
300 {
301 return (u8)(be32_to_cpu(cpi->cap_mask2_resp_time) &
302 IB_CLASS_PORT_INFO_RESP_TIME_MASK);
303 }
304
305 /**
306 * ib_set_cpi_resptime - Sets the response time in an
307 * ib_class_port_info mad.
308 * @cpi: A struct ib_class_port_info.
309 * @rtime: The response time to set.
310 */
ib_set_cpi_resp_time(struct ib_class_port_info * cpi,u8 rtime)311 static inline void ib_set_cpi_resp_time(struct ib_class_port_info *cpi,
312 u8 rtime)
313 {
314 cpi->cap_mask2_resp_time =
315 (cpi->cap_mask2_resp_time &
316 cpu_to_be32(~IB_CLASS_PORT_INFO_RESP_TIME_MASK)) |
317 cpu_to_be32(rtime & IB_CLASS_PORT_INFO_RESP_TIME_MASK);
318 }
319
320 /**
321 * ib_get_cpi_capmask2 - Returns the capmask2 value from
322 * cap_mask2_resp_time in ib_class_port_info.
323 * @cpi: A struct ib_class_port_info mad.
324 */
ib_get_cpi_capmask2(struct ib_class_port_info * cpi)325 static inline u32 ib_get_cpi_capmask2(struct ib_class_port_info *cpi)
326 {
327 return (be32_to_cpu(cpi->cap_mask2_resp_time) >>
328 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE);
329 }
330
331 /**
332 * ib_set_cpi_capmask2 - Sets the capmask2 in an
333 * ib_class_port_info mad.
334 * @cpi: A struct ib_class_port_info.
335 * @capmask2: The capmask2 to set.
336 */
ib_set_cpi_capmask2(struct ib_class_port_info * cpi,u32 capmask2)337 static inline void ib_set_cpi_capmask2(struct ib_class_port_info *cpi,
338 u32 capmask2)
339 {
340 cpi->cap_mask2_resp_time =
341 (cpi->cap_mask2_resp_time &
342 cpu_to_be32(IB_CLASS_PORT_INFO_RESP_TIME_MASK)) |
343 cpu_to_be32(capmask2 <<
344 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE);
345 }
346
347 /**
348 * opa_get_cpi_capmask2 - Returns the capmask2 value from
349 * cap_mask2_resp_time in ib_class_port_info.
350 * @cpi: A struct opa_class_port_info mad.
351 */
opa_get_cpi_capmask2(struct opa_class_port_info * cpi)352 static inline u32 opa_get_cpi_capmask2(struct opa_class_port_info *cpi)
353 {
354 return (be32_to_cpu(cpi->cap_mask2_resp_time) >>
355 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE);
356 }
357
358 struct ib_mad_notice_attr {
359 u8 generic_type;
360 u8 prod_type_msb;
361 __be16 prod_type_lsb;
362 __be16 trap_num;
363 __be16 issuer_lid;
364 __be16 toggle_count;
365
366 union {
367 struct {
368 u8 details[54];
369 } raw_data;
370
371 struct {
372 __be16 reserved;
373 __be16 lid; /* where violation happened */
374 u8 port_num; /* where violation happened */
375 } __packed ntc_129_131;
376
377 struct {
378 __be16 reserved;
379 __be16 lid; /* LID where change occurred */
380 u8 reserved2;
381 u8 local_changes; /* low bit - local changes */
382 __be32 new_cap_mask; /* new capability mask */
383 u8 reserved3;
384 u8 change_flags; /* low 3 bits only */
385 } __packed ntc_144;
386
387 struct {
388 __be16 reserved;
389 __be16 lid; /* lid where sys guid changed */
390 __be16 reserved2;
391 __be64 new_sys_guid;
392 } __packed ntc_145;
393
394 struct {
395 __be16 reserved;
396 __be16 lid;
397 __be16 dr_slid;
398 u8 method;
399 u8 reserved2;
400 __be16 attr_id;
401 __be32 attr_mod;
402 __be64 mkey;
403 u8 reserved3;
404 u8 dr_trunc_hop;
405 u8 dr_rtn_path[30];
406 } __packed ntc_256;
407
408 struct {
409 __be16 reserved;
410 __be16 lid1;
411 __be16 lid2;
412 __be32 key;
413 __be32 sl_qp1; /* SL: high 4 bits */
414 __be32 qp2; /* high 8 bits reserved */
415 union ib_gid gid1;
416 union ib_gid gid2;
417 } __packed ntc_257_258;
418
419 } details;
420 };
421
422 /**
423 * ib_mad_send_buf - MAD data buffer and work request for sends.
424 * @next: A pointer used to chain together MADs for posting.
425 * @mad: References an allocated MAD data buffer for MADs that do not have
426 * RMPP active. For MADs using RMPP, references the common and management
427 * class specific headers.
428 * @mad_agent: MAD agent that allocated the buffer.
429 * @ah: The address handle to use when sending the MAD.
430 * @context: User-controlled context fields.
431 * @hdr_len: Indicates the size of the data header of the MAD. This length
432 * includes the common MAD, RMPP, and class specific headers.
433 * @data_len: Indicates the total size of user-transferred data.
434 * @seg_count: The number of RMPP segments allocated for this send.
435 * @seg_size: Size of the data in each RMPP segment. This does not include
436 * class specific headers.
437 * @seg_rmpp_size: Size of each RMPP segment including the class specific
438 * headers.
439 * @timeout_ms: Time to wait for a response.
440 * @retries: Number of times to retry a request for a response. For MADs
441 * using RMPP, this applies per window. On completion, returns the number
442 * of retries needed to complete the transfer.
443 *
444 * Users are responsible for initializing the MAD buffer itself, with the
445 * exception of any RMPP header. Additional segment buffer space allocated
446 * beyond data_len is padding.
447 */
448 struct ib_mad_send_buf {
449 struct ib_mad_send_buf *next;
450 void *mad;
451 struct ib_mad_agent *mad_agent;
452 struct ib_ah *ah;
453 void *context[2];
454 int hdr_len;
455 int data_len;
456 int seg_count;
457 int seg_size;
458 int seg_rmpp_size;
459 int timeout_ms;
460 int retries;
461 };
462
463 /**
464 * ib_response_mad - Returns if the specified MAD has been generated in
465 * response to a sent request or trap.
466 */
467 int ib_response_mad(const struct ib_mad_hdr *hdr);
468
469 /**
470 * ib_get_rmpp_resptime - Returns the RMPP response time.
471 * @rmpp_hdr: An RMPP header.
472 */
ib_get_rmpp_resptime(struct ib_rmpp_hdr * rmpp_hdr)473 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
474 {
475 return rmpp_hdr->rmpp_rtime_flags >> 3;
476 }
477
478 /**
479 * ib_get_rmpp_flags - Returns the RMPP flags.
480 * @rmpp_hdr: An RMPP header.
481 */
ib_get_rmpp_flags(const struct ib_rmpp_hdr * rmpp_hdr)482 static inline u8 ib_get_rmpp_flags(const struct ib_rmpp_hdr *rmpp_hdr)
483 {
484 return rmpp_hdr->rmpp_rtime_flags & 0x7;
485 }
486
487 /**
488 * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
489 * @rmpp_hdr: An RMPP header.
490 * @rtime: The response time to set.
491 */
ib_set_rmpp_resptime(struct ib_rmpp_hdr * rmpp_hdr,u8 rtime)492 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
493 {
494 rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
495 }
496
497 /**
498 * ib_set_rmpp_flags - Sets the flags in an RMPP header.
499 * @rmpp_hdr: An RMPP header.
500 * @flags: The flags to set.
501 */
ib_set_rmpp_flags(struct ib_rmpp_hdr * rmpp_hdr,u8 flags)502 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
503 {
504 rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
505 (flags & 0x7);
506 }
507
508 struct ib_mad_agent;
509 struct ib_mad_send_wc;
510 struct ib_mad_recv_wc;
511
512 /**
513 * ib_mad_send_handler - callback handler for a sent MAD.
514 * @mad_agent: MAD agent that sent the MAD.
515 * @mad_send_wc: Send work completion information on the sent MAD.
516 */
517 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
518 struct ib_mad_send_wc *mad_send_wc);
519
520 /**
521 * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
522 * @mad_agent: MAD agent that snooped the MAD.
523 * @send_buf: send MAD data buffer.
524 * @mad_send_wc: Work completion information on the sent MAD. Valid
525 * only for snooping that occurs on a send completion.
526 *
527 * Clients snooping MADs should not modify data referenced by the @send_buf
528 * or @mad_send_wc.
529 */
530 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
531 struct ib_mad_send_buf *send_buf,
532 struct ib_mad_send_wc *mad_send_wc);
533
534 /**
535 * ib_mad_recv_handler - callback handler for a received MAD.
536 * @mad_agent: MAD agent requesting the received MAD.
537 * @send_buf: Send buffer if found, else NULL
538 * @mad_recv_wc: Received work completion information on the received MAD.
539 *
540 * MADs received in response to a send request operation will be handed to
541 * the user before the send operation completes. All data buffers given
542 * to registered agents through this routine are owned by the receiving
543 * client, except for snooping agents. Clients snooping MADs should not
544 * modify the data referenced by @mad_recv_wc.
545 */
546 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
547 struct ib_mad_send_buf *send_buf,
548 struct ib_mad_recv_wc *mad_recv_wc);
549
550 /**
551 * ib_mad_agent - Used to track MAD registration with the access layer.
552 * @device: Reference to device registration is on.
553 * @qp: Reference to QP used for sending and receiving MADs.
554 * @mr: Memory region for system memory usable for DMA.
555 * @recv_handler: Callback handler for a received MAD.
556 * @send_handler: Callback handler for a sent MAD.
557 * @snoop_handler: Callback handler for snooped sent MADs.
558 * @context: User-specified context associated with this registration.
559 * @hi_tid: Access layer assigned transaction ID for this client.
560 * Unsolicited MADs sent by this client will have the upper 32-bits
561 * of their TID set to this value.
562 * @flags: registration flags
563 * @port_num: Port number on which QP is registered
564 * @rmpp_version: If set, indicates the RMPP version used by this agent.
565 */
566 enum {
567 IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
568 };
569 struct ib_mad_agent {
570 struct ib_device *device;
571 struct ib_qp *qp;
572 ib_mad_recv_handler recv_handler;
573 ib_mad_send_handler send_handler;
574 ib_mad_snoop_handler snoop_handler;
575 void *context;
576 u32 hi_tid;
577 u32 flags;
578 u8 port_num;
579 u8 rmpp_version;
580 };
581
582 /**
583 * ib_mad_send_wc - MAD send completion information.
584 * @send_buf: Send MAD data buffer associated with the send MAD request.
585 * @status: Completion status.
586 * @vendor_err: Optional vendor error information returned with a failed
587 * request.
588 */
589 struct ib_mad_send_wc {
590 struct ib_mad_send_buf *send_buf;
591 enum ib_wc_status status;
592 u32 vendor_err;
593 };
594
595 /**
596 * ib_mad_recv_buf - received MAD buffer information.
597 * @list: Reference to next data buffer for a received RMPP MAD.
598 * @grh: References a data buffer containing the global route header.
599 * The data referenced by this buffer is only valid if the GRH is
600 * valid.
601 * @mad: References the start of the received MAD.
602 */
603 struct ib_mad_recv_buf {
604 struct list_head list;
605 struct ib_grh *grh;
606 union {
607 struct ib_mad *mad;
608 struct opa_mad *opa_mad;
609 };
610 };
611
612 /**
613 * ib_mad_recv_wc - received MAD information.
614 * @wc: Completion information for the received data.
615 * @recv_buf: Specifies the location of the received data buffer(s).
616 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
617 * @mad_len: The length of the received MAD, without duplicated headers.
618 * @mad_seg_size: The size of individual MAD segments
619 *
620 * For received response, the wr_id contains a pointer to the ib_mad_send_buf
621 * for the corresponding send request.
622 */
623 struct ib_mad_recv_wc {
624 struct ib_wc *wc;
625 struct ib_mad_recv_buf recv_buf;
626 struct list_head rmpp_list;
627 int mad_len;
628 size_t mad_seg_size;
629 };
630
631 /**
632 * ib_mad_reg_req - MAD registration request
633 * @mgmt_class: Indicates which management class of MADs should be receive
634 * by the caller. This field is only required if the user wishes to
635 * receive unsolicited MADs, otherwise it should be 0.
636 * @mgmt_class_version: Indicates which version of MADs for the given
637 * management class to receive.
638 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
639 * in the range from 0x30 to 0x4f. Otherwise not used.
640 * @method_mask: The caller will receive unsolicited MADs for any method
641 * where @method_mask = 1.
642 *
643 */
644 struct ib_mad_reg_req {
645 u8 mgmt_class;
646 u8 mgmt_class_version;
647 u8 oui[3];
648 DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
649 };
650
651 /**
652 * ib_register_mad_agent - Register to send/receive MADs.
653 * @device: The device to register with.
654 * @port_num: The port on the specified device to use.
655 * @qp_type: Specifies which QP to access. Must be either
656 * IB_QPT_SMI or IB_QPT_GSI.
657 * @mad_reg_req: Specifies which unsolicited MADs should be received
658 * by the caller. This parameter may be NULL if the caller only
659 * wishes to receive solicited responses.
660 * @rmpp_version: If set, indicates that the client will send
661 * and receive MADs that contain the RMPP header for the given version.
662 * If set to 0, indicates that RMPP is not used by this client.
663 * @send_handler: The completion callback routine invoked after a send
664 * request has completed.
665 * @recv_handler: The completion callback routine invoked for a received
666 * MAD.
667 * @context: User specified context associated with the registration.
668 * @registration_flags: Registration flags to set for this agent
669 */
670 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
671 u8 port_num,
672 enum ib_qp_type qp_type,
673 struct ib_mad_reg_req *mad_reg_req,
674 u8 rmpp_version,
675 ib_mad_send_handler send_handler,
676 ib_mad_recv_handler recv_handler,
677 void *context,
678 u32 registration_flags);
679
680 enum ib_mad_snoop_flags {
681 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
682 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
683 IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2),
684 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
685 IB_MAD_SNOOP_RECVS = (1<<4)
686 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
687 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
688 };
689
690 /**
691 * ib_register_mad_snoop - Register to snoop sent and received MADs.
692 * @device: The device to register with.
693 * @port_num: The port on the specified device to use.
694 * @qp_type: Specifies which QP traffic to snoop. Must be either
695 * IB_QPT_SMI or IB_QPT_GSI.
696 * @mad_snoop_flags: Specifies information where snooping occurs.
697 * @send_handler: The callback routine invoked for a snooped send.
698 * @recv_handler: The callback routine invoked for a snooped receive.
699 * @context: User specified context associated with the registration.
700 */
701 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
702 u8 port_num,
703 enum ib_qp_type qp_type,
704 int mad_snoop_flags,
705 ib_mad_snoop_handler snoop_handler,
706 ib_mad_recv_handler recv_handler,
707 void *context);
708
709 /**
710 * ib_unregister_mad_agent - Unregisters a client from using MAD services.
711 * @mad_agent: Corresponding MAD registration request to deregister.
712 *
713 * After invoking this routine, MAD services are no longer usable by the
714 * client on the associated QP.
715 */
716 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
717
718 /**
719 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
720 * with the registered client.
721 * @send_buf: Specifies the information needed to send the MAD(s).
722 * @bad_send_buf: Specifies the MAD on which an error was encountered. This
723 * parameter is optional if only a single MAD is posted.
724 *
725 * Sent MADs are not guaranteed to complete in the order that they were posted.
726 *
727 * If the MAD requires RMPP, the data buffer should contain a single copy
728 * of the common MAD, RMPP, and class specific headers, followed by the class
729 * defined data. If the class defined data would not divide evenly into
730 * RMPP segments, then space must be allocated at the end of the referenced
731 * buffer for any required padding. To indicate the amount of class defined
732 * data being transferred, the paylen_newwin field in the RMPP header should
733 * be set to the size of the class specific header plus the amount of class
734 * defined data being transferred. The paylen_newwin field should be
735 * specified in network-byte order.
736 */
737 int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
738 struct ib_mad_send_buf **bad_send_buf);
739
740
741 /**
742 * ib_free_recv_mad - Returns data buffers used to receive a MAD.
743 * @mad_recv_wc: Work completion information for a received MAD.
744 *
745 * Clients receiving MADs through their ib_mad_recv_handler must call this
746 * routine to return the work completion buffers to the access layer.
747 */
748 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
749
750 /**
751 * ib_cancel_mad - Cancels an outstanding send MAD operation.
752 * @mad_agent: Specifies the registration associated with sent MAD.
753 * @send_buf: Indicates the MAD to cancel.
754 *
755 * MADs will be returned to the user through the corresponding
756 * ib_mad_send_handler.
757 */
758 void ib_cancel_mad(struct ib_mad_agent *mad_agent,
759 struct ib_mad_send_buf *send_buf);
760
761 /**
762 * ib_modify_mad - Modifies an outstanding send MAD operation.
763 * @mad_agent: Specifies the registration associated with sent MAD.
764 * @send_buf: Indicates the MAD to modify.
765 * @timeout_ms: New timeout value for sent MAD.
766 *
767 * This call will reset the timeout value for a sent MAD to the specified
768 * value.
769 */
770 int ib_modify_mad(struct ib_mad_agent *mad_agent,
771 struct ib_mad_send_buf *send_buf, u32 timeout_ms);
772
773 /**
774 * ib_redirect_mad_qp - Registers a QP for MAD services.
775 * @qp: Reference to a QP that requires MAD services.
776 * @rmpp_version: If set, indicates that the client will send
777 * and receive MADs that contain the RMPP header for the given version.
778 * If set to 0, indicates that RMPP is not used by this client.
779 * @send_handler: The completion callback routine invoked after a send
780 * request has completed.
781 * @recv_handler: The completion callback routine invoked for a received
782 * MAD.
783 * @context: User specified context associated with the registration.
784 *
785 * Use of this call allows clients to use MAD services, such as RMPP,
786 * on user-owned QPs. After calling this routine, users may send
787 * MADs on the specified QP by calling ib_mad_post_send.
788 */
789 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
790 u8 rmpp_version,
791 ib_mad_send_handler send_handler,
792 ib_mad_recv_handler recv_handler,
793 void *context);
794
795 /**
796 * ib_process_mad_wc - Processes a work completion associated with a
797 * MAD sent or received on a redirected QP.
798 * @mad_agent: Specifies the registered MAD service using the redirected QP.
799 * @wc: References a work completion associated with a sent or received
800 * MAD segment.
801 *
802 * This routine is used to complete or continue processing on a MAD request.
803 * If the work completion is associated with a send operation, calling
804 * this routine is required to continue an RMPP transfer or to wait for a
805 * corresponding response, if it is a request. If the work completion is
806 * associated with a receive operation, calling this routine is required to
807 * process an inbound or outbound RMPP transfer, or to match a response MAD
808 * with its corresponding request.
809 */
810 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
811 struct ib_wc *wc);
812
813 /**
814 * ib_create_send_mad - Allocate and initialize a data buffer and work request
815 * for sending a MAD.
816 * @mad_agent: Specifies the registered MAD service to associate with the MAD.
817 * @remote_qpn: Specifies the QPN of the receiving node.
818 * @pkey_index: Specifies which PKey the MAD will be sent using. This field
819 * is valid only if the remote_qpn is QP 1.
820 * @rmpp_active: Indicates if the send will enable RMPP.
821 * @hdr_len: Indicates the size of the data header of the MAD. This length
822 * should include the common MAD header, RMPP header, plus any class
823 * specific header.
824 * @data_len: Indicates the size of any user-transferred data. The call will
825 * automatically adjust the allocated buffer size to account for any
826 * additional padding that may be necessary.
827 * @gfp_mask: GFP mask used for the memory allocation.
828 * @base_version: Base Version of this MAD
829 *
830 * This routine allocates a MAD for sending. The returned MAD send buffer
831 * will reference a data buffer usable for sending a MAD, along
832 * with an initialized work request structure. Users may modify the returned
833 * MAD data buffer before posting the send.
834 *
835 * The returned MAD header, class specific headers, and any padding will be
836 * cleared. Users are responsible for initializing the common MAD header,
837 * any class specific header, and MAD data area.
838 * If @rmpp_active is set, the RMPP header will be initialized for sending.
839 */
840 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
841 u32 remote_qpn, u16 pkey_index,
842 int rmpp_active,
843 int hdr_len, int data_len,
844 gfp_t gfp_mask,
845 u8 base_version);
846
847 /**
848 * ib_is_mad_class_rmpp - returns whether given management class
849 * supports RMPP.
850 * @mgmt_class: management class
851 *
852 * This routine returns whether the management class supports RMPP.
853 */
854 int ib_is_mad_class_rmpp(u8 mgmt_class);
855
856 /**
857 * ib_get_mad_data_offset - returns the data offset for a given
858 * management class.
859 * @mgmt_class: management class
860 *
861 * This routine returns the data offset in the MAD for the management
862 * class requested.
863 */
864 int ib_get_mad_data_offset(u8 mgmt_class);
865
866 /**
867 * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
868 * @send_buf: Previously allocated send data buffer.
869 * @seg_num: number of segment to return
870 *
871 * This routine returns a pointer to the data buffer of an RMPP MAD.
872 * Users must provide synchronization to @send_buf around this call.
873 */
874 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
875
876 /**
877 * ib_free_send_mad - Returns data buffers used to send a MAD.
878 * @send_buf: Previously allocated send data buffer.
879 */
880 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
881
882 /**
883 * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
884 * @agent: the agent in question
885 * @return: true if agent is performing rmpp, false otherwise.
886 */
887 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
888
889 #endif /* IB_MAD_H */
890