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_SMP_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/** 266 * ib_get_cpi_resp_time - Returns the resp_time value from 267 * cap_mask2_resp_time in ib_class_port_info. 268 * @cpi: A struct ib_class_port_info mad. 269 */ 270static inline u8 ib_get_cpi_resp_time(struct ib_class_port_info *cpi) 271{ 272 return (u8)(be32_to_cpu(cpi->cap_mask2_resp_time) & 273 IB_CLASS_PORT_INFO_RESP_TIME_MASK); 274} 275 276/** 277 * ib_set_cpi_resptime - Sets the response time in an 278 * ib_class_port_info mad. 279 * @cpi: A struct ib_class_port_info. 280 * @rtime: The response time to set. 281 */ 282static inline void ib_set_cpi_resp_time(struct ib_class_port_info *cpi, 283 u8 rtime) 284{ 285 cpi->cap_mask2_resp_time = 286 (cpi->cap_mask2_resp_time & 287 cpu_to_be32(~IB_CLASS_PORT_INFO_RESP_TIME_MASK)) | 288 cpu_to_be32(rtime & IB_CLASS_PORT_INFO_RESP_TIME_MASK); 289} 290 291/** 292 * ib_get_cpi_capmask2 - Returns the capmask2 value from 293 * cap_mask2_resp_time in ib_class_port_info. 294 * @cpi: A struct ib_class_port_info mad. 295 */ 296static inline u32 ib_get_cpi_capmask2(struct ib_class_port_info *cpi) 297{ 298 return (be32_to_cpu(cpi->cap_mask2_resp_time) >> 299 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE); 300} 301 302/** 303 * ib_set_cpi_capmask2 - Sets the capmask2 in an 304 * ib_class_port_info mad. 305 * @cpi: A struct ib_class_port_info. 306 * @capmask2: The capmask2 to set. 307 */ 308static inline void ib_set_cpi_capmask2(struct ib_class_port_info *cpi, 309 u32 capmask2) 310{ 311 cpi->cap_mask2_resp_time = 312 (cpi->cap_mask2_resp_time & 313 cpu_to_be32(IB_CLASS_PORT_INFO_RESP_TIME_MASK)) | 314 cpu_to_be32(capmask2 << 315 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE); 316} 317 318struct ib_mad_notice_attr { 319 u8 generic_type; 320 u8 prod_type_msb; 321 __be16 prod_type_lsb; 322 __be16 trap_num; 323 __be16 issuer_lid; 324 __be16 toggle_count; 325 326 union { 327 struct { 328 u8 details[54]; 329 } raw_data; 330 331 struct { 332 __be16 reserved; 333 __be16 lid; /* where violation happened */ 334 u8 port_num; /* where violation happened */ 335 } __packed ntc_129_131; 336 337 struct { 338 __be16 reserved; 339 __be16 lid; /* LID where change occurred */ 340 u8 reserved2; 341 u8 local_changes; /* low bit - local changes */ 342 __be32 new_cap_mask; /* new capability mask */ 343 u8 reserved3; 344 u8 change_flags; /* low 3 bits only */ 345 } __packed ntc_144; 346 347 struct { 348 __be16 reserved; 349 __be16 lid; /* lid where sys guid changed */ 350 __be16 reserved2; 351 __be64 new_sys_guid; 352 } __packed ntc_145; 353 354 struct { 355 __be16 reserved; 356 __be16 lid; 357 __be16 dr_slid; 358 u8 method; 359 u8 reserved2; 360 __be16 attr_id; 361 __be32 attr_mod; 362 __be64 mkey; 363 u8 reserved3; 364 u8 dr_trunc_hop; 365 u8 dr_rtn_path[30]; 366 } __packed ntc_256; 367 368 struct { 369 __be16 reserved; 370 __be16 lid1; 371 __be16 lid2; 372 __be32 key; 373 __be32 sl_qp1; /* SL: high 4 bits */ 374 __be32 qp2; /* high 8 bits reserved */ 375 union ib_gid gid1; 376 union ib_gid gid2; 377 } __packed ntc_257_258; 378 379 } details; 380}; 381 382/** 383 * ib_mad_send_buf - MAD data buffer and work request for sends. 384 * @next: A pointer used to chain together MADs for posting. 385 * @mad: References an allocated MAD data buffer for MADs that do not have 386 * RMPP active. For MADs using RMPP, references the common and management 387 * class specific headers. 388 * @mad_agent: MAD agent that allocated the buffer. 389 * @ah: The address handle to use when sending the MAD. 390 * @context: User-controlled context fields. 391 * @hdr_len: Indicates the size of the data header of the MAD. This length 392 * includes the common MAD, RMPP, and class specific headers. 393 * @data_len: Indicates the total size of user-transferred data. 394 * @seg_count: The number of RMPP segments allocated for this send. 395 * @seg_size: Size of the data in each RMPP segment. This does not include 396 * class specific headers. 397 * @seg_rmpp_size: Size of each RMPP segment including the class specific 398 * headers. 399 * @timeout_ms: Time to wait for a response. 400 * @retries: Number of times to retry a request for a response. For MADs 401 * using RMPP, this applies per window. On completion, returns the number 402 * of retries needed to complete the transfer. 403 * 404 * Users are responsible for initializing the MAD buffer itself, with the 405 * exception of any RMPP header. Additional segment buffer space allocated 406 * beyond data_len is padding. 407 */ 408struct ib_mad_send_buf { 409 struct ib_mad_send_buf *next; 410 void *mad; 411 struct ib_mad_agent *mad_agent; 412 struct ib_ah *ah; 413 void *context[2]; 414 int hdr_len; 415 int data_len; 416 int seg_count; 417 int seg_size; 418 int seg_rmpp_size; 419 int timeout_ms; 420 int retries; 421}; 422 423/** 424 * ib_response_mad - Returns if the specified MAD has been generated in 425 * response to a sent request or trap. 426 */ 427int ib_response_mad(const struct ib_mad_hdr *hdr); 428 429/** 430 * ib_get_rmpp_resptime - Returns the RMPP response time. 431 * @rmpp_hdr: An RMPP header. 432 */ 433static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr) 434{ 435 return rmpp_hdr->rmpp_rtime_flags >> 3; 436} 437 438/** 439 * ib_get_rmpp_flags - Returns the RMPP flags. 440 * @rmpp_hdr: An RMPP header. 441 */ 442static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr) 443{ 444 return rmpp_hdr->rmpp_rtime_flags & 0x7; 445} 446 447/** 448 * ib_set_rmpp_resptime - Sets the response time in an RMPP header. 449 * @rmpp_hdr: An RMPP header. 450 * @rtime: The response time to set. 451 */ 452static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime) 453{ 454 rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3); 455} 456 457/** 458 * ib_set_rmpp_flags - Sets the flags in an RMPP header. 459 * @rmpp_hdr: An RMPP header. 460 * @flags: The flags to set. 461 */ 462static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags) 463{ 464 rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) | 465 (flags & 0x7); 466} 467 468struct ib_mad_agent; 469struct ib_mad_send_wc; 470struct ib_mad_recv_wc; 471 472/** 473 * ib_mad_send_handler - callback handler for a sent MAD. 474 * @mad_agent: MAD agent that sent the MAD. 475 * @mad_send_wc: Send work completion information on the sent MAD. 476 */ 477typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent, 478 struct ib_mad_send_wc *mad_send_wc); 479 480/** 481 * ib_mad_snoop_handler - Callback handler for snooping sent MADs. 482 * @mad_agent: MAD agent that snooped the MAD. 483 * @send_buf: send MAD data buffer. 484 * @mad_send_wc: Work completion information on the sent MAD. Valid 485 * only for snooping that occurs on a send completion. 486 * 487 * Clients snooping MADs should not modify data referenced by the @send_buf 488 * or @mad_send_wc. 489 */ 490typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent, 491 struct ib_mad_send_buf *send_buf, 492 struct ib_mad_send_wc *mad_send_wc); 493 494/** 495 * ib_mad_recv_handler - callback handler for a received MAD. 496 * @mad_agent: MAD agent requesting the received MAD. 497 * @send_buf: Send buffer if found, else NULL 498 * @mad_recv_wc: Received work completion information on the received MAD. 499 * 500 * MADs received in response to a send request operation will be handed to 501 * the user before the send operation completes. All data buffers given 502 * to registered agents through this routine are owned by the receiving 503 * client, except for snooping agents. Clients snooping MADs should not 504 * modify the data referenced by @mad_recv_wc. 505 */ 506typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent, 507 struct ib_mad_send_buf *send_buf, 508 struct ib_mad_recv_wc *mad_recv_wc); 509 510/** 511 * ib_mad_agent - Used to track MAD registration with the access layer. 512 * @device: Reference to device registration is on. 513 * @qp: Reference to QP used for sending and receiving MADs. 514 * @mr: Memory region for system memory usable for DMA. 515 * @recv_handler: Callback handler for a received MAD. 516 * @send_handler: Callback handler for a sent MAD. 517 * @snoop_handler: Callback handler for snooped sent MADs. 518 * @context: User-specified context associated with this registration. 519 * @hi_tid: Access layer assigned transaction ID for this client. 520 * Unsolicited MADs sent by this client will have the upper 32-bits 521 * of their TID set to this value. 522 * @flags: registration flags 523 * @port_num: Port number on which QP is registered 524 * @rmpp_version: If set, indicates the RMPP version used by this agent. 525 */ 526enum { 527 IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP, 528}; 529struct ib_mad_agent { 530 struct ib_device *device; 531 struct ib_qp *qp; 532 ib_mad_recv_handler recv_handler; 533 ib_mad_send_handler send_handler; 534 ib_mad_snoop_handler snoop_handler; 535 void *context; 536 u32 hi_tid; 537 u32 flags; 538 u8 port_num; 539 u8 rmpp_version; 540}; 541 542/** 543 * ib_mad_send_wc - MAD send completion information. 544 * @send_buf: Send MAD data buffer associated with the send MAD request. 545 * @status: Completion status. 546 * @vendor_err: Optional vendor error information returned with a failed 547 * request. 548 */ 549struct ib_mad_send_wc { 550 struct ib_mad_send_buf *send_buf; 551 enum ib_wc_status status; 552 u32 vendor_err; 553}; 554 555/** 556 * ib_mad_recv_buf - received MAD buffer information. 557 * @list: Reference to next data buffer for a received RMPP MAD. 558 * @grh: References a data buffer containing the global route header. 559 * The data refereced by this buffer is only valid if the GRH is 560 * valid. 561 * @mad: References the start of the received MAD. 562 */ 563struct ib_mad_recv_buf { 564 struct list_head list; 565 struct ib_grh *grh; 566 union { 567 struct ib_mad *mad; 568 struct opa_mad *opa_mad; 569 }; 570}; 571 572/** 573 * ib_mad_recv_wc - received MAD information. 574 * @wc: Completion information for the received data. 575 * @recv_buf: Specifies the location of the received data buffer(s). 576 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers. 577 * @mad_len: The length of the received MAD, without duplicated headers. 578 * @mad_seg_size: The size of individual MAD segments 579 * 580 * For received response, the wr_id contains a pointer to the ib_mad_send_buf 581 * for the corresponding send request. 582 */ 583struct ib_mad_recv_wc { 584 struct ib_wc *wc; 585 struct ib_mad_recv_buf recv_buf; 586 struct list_head rmpp_list; 587 int mad_len; 588 size_t mad_seg_size; 589}; 590 591/** 592 * ib_mad_reg_req - MAD registration request 593 * @mgmt_class: Indicates which management class of MADs should be receive 594 * by the caller. This field is only required if the user wishes to 595 * receive unsolicited MADs, otherwise it should be 0. 596 * @mgmt_class_version: Indicates which version of MADs for the given 597 * management class to receive. 598 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class 599 * in the range from 0x30 to 0x4f. Otherwise not used. 600 * @method_mask: The caller will receive unsolicited MADs for any method 601 * where @method_mask = 1. 602 * 603 */ 604struct ib_mad_reg_req { 605 u8 mgmt_class; 606 u8 mgmt_class_version; 607 u8 oui[3]; 608 DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS); 609}; 610 611/** 612 * ib_register_mad_agent - Register to send/receive MADs. 613 * @device: The device to register with. 614 * @port_num: The port on the specified device to use. 615 * @qp_type: Specifies which QP to access. Must be either 616 * IB_QPT_SMI or IB_QPT_GSI. 617 * @mad_reg_req: Specifies which unsolicited MADs should be received 618 * by the caller. This parameter may be NULL if the caller only 619 * wishes to receive solicited responses. 620 * @rmpp_version: If set, indicates that the client will send 621 * and receive MADs that contain the RMPP header for the given version. 622 * If set to 0, indicates that RMPP is not used by this client. 623 * @send_handler: The completion callback routine invoked after a send 624 * request has completed. 625 * @recv_handler: The completion callback routine invoked for a received 626 * MAD. 627 * @context: User specified context associated with the registration. 628 * @registration_flags: Registration flags to set for this agent 629 */ 630struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device, 631 u8 port_num, 632 enum ib_qp_type qp_type, 633 struct ib_mad_reg_req *mad_reg_req, 634 u8 rmpp_version, 635 ib_mad_send_handler send_handler, 636 ib_mad_recv_handler recv_handler, 637 void *context, 638 u32 registration_flags); 639 640enum ib_mad_snoop_flags { 641 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/ 642 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/ 643 IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2), 644 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/ 645 IB_MAD_SNOOP_RECVS = (1<<4) 646 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/ 647 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/ 648}; 649 650/** 651 * ib_register_mad_snoop - Register to snoop sent and received MADs. 652 * @device: The device to register with. 653 * @port_num: The port on the specified device to use. 654 * @qp_type: Specifies which QP traffic to snoop. Must be either 655 * IB_QPT_SMI or IB_QPT_GSI. 656 * @mad_snoop_flags: Specifies information where snooping occurs. 657 * @send_handler: The callback routine invoked for a snooped send. 658 * @recv_handler: The callback routine invoked for a snooped receive. 659 * @context: User specified context associated with the registration. 660 */ 661struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device, 662 u8 port_num, 663 enum ib_qp_type qp_type, 664 int mad_snoop_flags, 665 ib_mad_snoop_handler snoop_handler, 666 ib_mad_recv_handler recv_handler, 667 void *context); 668 669/** 670 * ib_unregister_mad_agent - Unregisters a client from using MAD services. 671 * @mad_agent: Corresponding MAD registration request to deregister. 672 * 673 * After invoking this routine, MAD services are no longer usable by the 674 * client on the associated QP. 675 */ 676int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent); 677 678/** 679 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated 680 * with the registered client. 681 * @send_buf: Specifies the information needed to send the MAD(s). 682 * @bad_send_buf: Specifies the MAD on which an error was encountered. This 683 * parameter is optional if only a single MAD is posted. 684 * 685 * Sent MADs are not guaranteed to complete in the order that they were posted. 686 * 687 * If the MAD requires RMPP, the data buffer should contain a single copy 688 * of the common MAD, RMPP, and class specific headers, followed by the class 689 * defined data. If the class defined data would not divide evenly into 690 * RMPP segments, then space must be allocated at the end of the referenced 691 * buffer for any required padding. To indicate the amount of class defined 692 * data being transferred, the paylen_newwin field in the RMPP header should 693 * be set to the size of the class specific header plus the amount of class 694 * defined data being transferred. The paylen_newwin field should be 695 * specified in network-byte order. 696 */ 697int ib_post_send_mad(struct ib_mad_send_buf *send_buf, 698 struct ib_mad_send_buf **bad_send_buf); 699 700 701/** 702 * ib_free_recv_mad - Returns data buffers used to receive a MAD. 703 * @mad_recv_wc: Work completion information for a received MAD. 704 * 705 * Clients receiving MADs through their ib_mad_recv_handler must call this 706 * routine to return the work completion buffers to the access layer. 707 */ 708void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc); 709 710/** 711 * ib_cancel_mad - Cancels an outstanding send MAD operation. 712 * @mad_agent: Specifies the registration associated with sent MAD. 713 * @send_buf: Indicates the MAD to cancel. 714 * 715 * MADs will be returned to the user through the corresponding 716 * ib_mad_send_handler. 717 */ 718void ib_cancel_mad(struct ib_mad_agent *mad_agent, 719 struct ib_mad_send_buf *send_buf); 720 721/** 722 * ib_modify_mad - Modifies an outstanding send MAD operation. 723 * @mad_agent: Specifies the registration associated with sent MAD. 724 * @send_buf: Indicates the MAD to modify. 725 * @timeout_ms: New timeout value for sent MAD. 726 * 727 * This call will reset the timeout value for a sent MAD to the specified 728 * value. 729 */ 730int ib_modify_mad(struct ib_mad_agent *mad_agent, 731 struct ib_mad_send_buf *send_buf, u32 timeout_ms); 732 733/** 734 * ib_redirect_mad_qp - Registers a QP for MAD services. 735 * @qp: Reference to a QP that requires MAD services. 736 * @rmpp_version: If set, indicates that the client will send 737 * and receive MADs that contain the RMPP header for the given version. 738 * If set to 0, indicates that RMPP is not used by this client. 739 * @send_handler: The completion callback routine invoked after a send 740 * request has completed. 741 * @recv_handler: The completion callback routine invoked for a received 742 * MAD. 743 * @context: User specified context associated with the registration. 744 * 745 * Use of this call allows clients to use MAD services, such as RMPP, 746 * on user-owned QPs. After calling this routine, users may send 747 * MADs on the specified QP by calling ib_mad_post_send. 748 */ 749struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp, 750 u8 rmpp_version, 751 ib_mad_send_handler send_handler, 752 ib_mad_recv_handler recv_handler, 753 void *context); 754 755/** 756 * ib_process_mad_wc - Processes a work completion associated with a 757 * MAD sent or received on a redirected QP. 758 * @mad_agent: Specifies the registered MAD service using the redirected QP. 759 * @wc: References a work completion associated with a sent or received 760 * MAD segment. 761 * 762 * This routine is used to complete or continue processing on a MAD request. 763 * If the work completion is associated with a send operation, calling 764 * this routine is required to continue an RMPP transfer or to wait for a 765 * corresponding response, if it is a request. If the work completion is 766 * associated with a receive operation, calling this routine is required to 767 * process an inbound or outbound RMPP transfer, or to match a response MAD 768 * with its corresponding request. 769 */ 770int ib_process_mad_wc(struct ib_mad_agent *mad_agent, 771 struct ib_wc *wc); 772 773/** 774 * ib_create_send_mad - Allocate and initialize a data buffer and work request 775 * for sending a MAD. 776 * @mad_agent: Specifies the registered MAD service to associate with the MAD. 777 * @remote_qpn: Specifies the QPN of the receiving node. 778 * @pkey_index: Specifies which PKey the MAD will be sent using. This field 779 * is valid only if the remote_qpn is QP 1. 780 * @rmpp_active: Indicates if the send will enable RMPP. 781 * @hdr_len: Indicates the size of the data header of the MAD. This length 782 * should include the common MAD header, RMPP header, plus any class 783 * specific header. 784 * @data_len: Indicates the size of any user-transferred data. The call will 785 * automatically adjust the allocated buffer size to account for any 786 * additional padding that may be necessary. 787 * @gfp_mask: GFP mask used for the memory allocation. 788 * @base_version: Base Version of this MAD 789 * 790 * This routine allocates a MAD for sending. The returned MAD send buffer 791 * will reference a data buffer usable for sending a MAD, along 792 * with an initialized work request structure. Users may modify the returned 793 * MAD data buffer before posting the send. 794 * 795 * The returned MAD header, class specific headers, and any padding will be 796 * cleared. Users are responsible for initializing the common MAD header, 797 * any class specific header, and MAD data area. 798 * If @rmpp_active is set, the RMPP header will be initialized for sending. 799 */ 800struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent, 801 u32 remote_qpn, u16 pkey_index, 802 int rmpp_active, 803 int hdr_len, int data_len, 804 gfp_t gfp_mask, 805 u8 base_version); 806 807/** 808 * ib_is_mad_class_rmpp - returns whether given management class 809 * supports RMPP. 810 * @mgmt_class: management class 811 * 812 * This routine returns whether the management class supports RMPP. 813 */ 814int ib_is_mad_class_rmpp(u8 mgmt_class); 815 816/** 817 * ib_get_mad_data_offset - returns the data offset for a given 818 * management class. 819 * @mgmt_class: management class 820 * 821 * This routine returns the data offset in the MAD for the management 822 * class requested. 823 */ 824int ib_get_mad_data_offset(u8 mgmt_class); 825 826/** 827 * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment. 828 * @send_buf: Previously allocated send data buffer. 829 * @seg_num: number of segment to return 830 * 831 * This routine returns a pointer to the data buffer of an RMPP MAD. 832 * Users must provide synchronization to @send_buf around this call. 833 */ 834void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num); 835 836/** 837 * ib_free_send_mad - Returns data buffers used to send a MAD. 838 * @send_buf: Previously allocated send data buffer. 839 */ 840void ib_free_send_mad(struct ib_mad_send_buf *send_buf); 841 842/** 843 * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP. 844 * @agent: the agent in question 845 * @return: true if agent is performing rmpp, false otherwise. 846 */ 847int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent); 848 849#endif /* IB_MAD_H */ 850