include/rdma/ib_mad.h

1 /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
7  * Copyright (c) 2004-2006 Voltaire Corporation.  All rights reserved.
18 /* Management base versions */
24 /* Management classes */
42 /* Management methods */
165  * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
310  * ib_get_cpi_resp_time - Returns the resp_time value from
316 	return (u8)(be32_to_cpu(cpi->cap_mask2_resp_time) &  in ib_get_cpi_resp_time()
321  * ib_set_cpi_resptime - Sets the response time in an
329 	cpi->cap_mask2_resp_time =  in ib_set_cpi_resp_time()
330 		(cpi->cap_mask2_resp_time &  in ib_set_cpi_resp_time()
336  * ib_get_cpi_capmask2 - Returns the capmask2 value from
342 	return (be32_to_cpu(cpi->cap_mask2_resp_time) >>  in ib_get_cpi_capmask2()
347  * ib_set_cpi_capmask2 - Sets the capmask2 in an
355 	cpi->cap_mask2_resp_time =  in ib_set_cpi_capmask2()
356 		(cpi->cap_mask2_resp_time &  in ib_set_cpi_capmask2()
363  * opa_get_cpi_capmask2 - Returns the capmask2 value from
369 	return (be32_to_cpu(cpi->cap_mask2_resp_time) >>  in opa_get_cpi_capmask2()
396 			u8	local_changes;	/* low bit - local changes */
438  * ib_mad_send_buf - MAD data buffer and work request for sends.
441  *   RMPP active.  For MADs using RMPP, references the common and management
445  * @context: User-controlled context fields.
448  * @data_len: Indicates the total size of user-transferred data.
479  * ib_response_mad - Returns if the specified MAD has been generated in
485  * ib_get_rmpp_resptime - Returns the RMPP response time.
490 	return rmpp_hdr->rmpp_rtime_flags >> 3;  in ib_get_rmpp_resptime()
494  * ib_get_rmpp_flags - Returns the RMPP flags.
499 	return rmpp_hdr->rmpp_rtime_flags & 0x7;  in ib_get_rmpp_flags()
503  * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
509 	rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);  in ib_set_rmpp_resptime()
513  * ib_set_rmpp_flags - Sets the flags in an RMPP header.
519 	rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |  in ib_set_rmpp_flags()
528  * ib_mad_send_handler - callback handler for a sent MAD.
536  * ib_mad_recv_handler - callback handler for a received MAD.
542  * the user before the send operation completes.  All data buffers given
551  * ib_mad_agent - Used to track MAD registration with the access layer.
557  * @context: User-specified context associated with this registration.
559  *   Unsolicited MADs sent by this client will have the upper 32-bits
584  * ib_mad_send_wc - MAD send completion information.
597  * ib_mad_recv_buf - received MAD buffer information.
614  * ib_mad_recv_wc - received MAD information.
633  * ib_mad_reg_req - MAD registration request
634  * @mgmt_class: Indicates which management class of MADs should be receive
635  *   by the caller.  This field is only required if the user wishes to
638  *   management class to receive.
653  * ib_register_mad_agent - Register to send/receive MADs.
668  * @context: User specified context associated with the registration.
681  * ib_unregister_mad_agent - Unregisters a client from using MAD services.
690  * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
706  * specified in network-byte order.
713  * ib_free_recv_mad - Returns data buffers used to receive a MAD.
722  * ib_modify_mad - Modifies an outstanding send MAD operation.
732  * ib_cancel_mad - Cancels an outstanding send MAD operation.
735  * MADs will be returned to the user through the corresponding
744  * ib_create_send_mad - Allocate and initialize a data buffer and work request
754  * @data_len: Indicates the size of any user-transferred data.  The call will
778  * ib_is_mad_class_rmpp - returns whether given management class
780  * @mgmt_class: management class
782  * This routine returns whether the management class supports RMPP.
787  * ib_get_mad_data_offset - returns the data offset for a given
788  * management class.
789  * @mgmt_class: management class
791  * This routine returns the data offset in the MAD for the management
797  * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
807  * ib_free_send_mad - Returns data buffers used to send a MAD.
813  * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.