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