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