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