ibti_common.h revision 17a2b317610f531d565bf4e940433aab2d9e6985
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _SYS_IB_IBTL_IBTI_COMMON_H
#define _SYS_IB_IBTL_IBTI_COMMON_H
/*
*
* prototypes.
*/
#include <sys/isa_defs.h>
#include <sys/byteorder.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Max number of paths that can be requested in an ibt_get_paths() call,
* if IBT_PATH_PERF or IBT_PATH_AVAIL flag (ibt_path_flags_t) is set.
*/
#define IBT_MAX_SPECIAL_PATHS 2
/*
* The name of DDI Event, generated when the properties of IOC device
* node properties were modified.
*/
#define IB_PROP_UPDATE_EVENT "SUNW,IB:IB_PROP_UPDATE"
/* Transport Interface version */
typedef int ibt_version_t;
#define IBTI_V1 1
#define IBTI_V2 2
#define IBTI_V3 3
#define IBTI_V4 4
#define IBTI_V_CURR IBTI_V4
/*
* Driver class type. Identifies a type of client driver so that
* "IBTF Policy" decisions can be made on a driver class basis.
* The last class should always be IBT_CLNT_NUM, and any new classes added
* must be defined before IBT_CLNT_NUM. The class values must be above 0.
* Any class values below or equal to 0 shall be invalid
*/
typedef enum ibt_clnt_class_e {
IBT_NETWORK_DEV, /* Network driver with associated client H/W */
IBT_GENERIC_DEV, /* Generic client H/W device driver */
IBT_NETWORK, /* Network driver with no associated */
/* client H/W, e.g., IPoIB */
IBT_GENERIC, /* A generic IB driver not */
/* associated with client H/W */
IBT_USER, /* A user application IBT interface driver */
IBT_IBMA, /* The IBMA Module */
IBT_CM, /* The CM Module */
IBT_DM, /* The DM Module */
IBT_DM_AGENT, /* DM Agent Module */
IBT_GENERIC_MISC, /* Generic Misc Module */
IBT_CLASS_NUM /* Place holder for class count */
(class) == IBT_NETWORK_DEV || \
(class) == IBT_GENERIC_DEV)
(class) == IBT_GENERIC || \
(class) == IBT_DM_AGENT || \
(class) == IBT_TEST_DEV || \
(class) == IBT_GENERIC_MISC || \
/*
* These are some special client classes which don't have a 'dip' hence have
* to be handled specially in ibt_attach, where we bypass the check for a valid
* dip if the client belongs to the class below.
*/
(class) == IBT_DM_AGENT || \
(class) == IBT_GENERIC_MISC || \
(class) == IBT_TEST_DEV)
/*
* Event record & status returns for asynchronous events and errors.
*/
typedef struct ibt_async_event_s {
/*
* IBT Client Callback function typedefs.
*
* ibt_async_handler_t
* used by the IBT client driver that registered the function.
*/
typedef void (*ibt_async_handler_t)(void *clnt_private,
/*
* IBT Client Memory Error Callback function typedefs.
*
* ibt_memory_handler_t
*/
typedef void (*ibt_memory_handler_t)(void *clnt_private,
/*
* Define a client module information structure. All clients MUST
* define a global of type ibt_clnt_modinfo_t. A pointer to this global
* is passed into the IBTF by a client when calling ibt_attach().
* This struct must persist during the life of the client.
*
* detected on a HCA that is being used by this client.
*/
typedef struct ibt_clnt_modinfo_s {
char *mi_clnt_name; /* Client Name. */
/*
* Definitions for use with ibt_register_subnet_notices()
*/
typedef enum ibt_subnet_event_code_e {
typedef struct ibt_subnet_event_s {
/*
* MTU Request type.
*/
typedef struct ibt_mtu_req_s {
/*
* Qflags, used by ibt_resize_queues().
*/
typedef enum ibt_qflags_e {
} ibt_qflags_t;
/*
* ibt_cq_handler_t
* Pointer to a work request completion handler function. This function
* is called when a WR completes on a CQ that is being used by the IBTF
* client driver that registered the function.
*/
/* default CQ handler ID */
#define IBT_CQ_HID_DEFAULT (1)
/*
* Service Data and flags.
* (IBTA Spec Release 1.1, Vol-1 Ref: 15.2.5.14.4)
*
* The ServiceData8.1 (sb_data8[0]) through ServiceData64.2 (sb_data64[1])
* components together constitutes a 64-byte area in which any data may be
* placed. It is intended to be a convenient way for a service to provide its
* clients with some initial data.
*
* In addition, this 64-byte area is formally divided into a total of 30
* components, 16 8-bit (uint8_t) components, then 8 16-bit (uint16_t)
* components, then 6 32-bit (uint32_t) components, then 2 64-bit (uint64_t)
* components, thereby assigning ComponentMask bits (ibt_srv_data_flags_t) to
* variously-sized segments of the data. All data are in host endian format.
* This allows query operations (ibt_get_paths()) to be used which match
* parts of the Service Data, making it possible, for example, for
* service-specific parts of the ServiceData to serve as a binary-coded
* extension to the ServiceName for purposes of lookup.
*/
typedef enum ibt_srv_data_flags_e {
IBT_NO_SDATA = 0,
IBT_SDATA8_0 = (1 << 0),
IBT_SDATA_ALL = 0x3FFFFFFF
typedef struct ibt_srv_data_s {
/*
* Path flags, used in ibt_get_paths()
*/
typedef enum ibt_path_flags_e {
IBT_PATH_NO_FLAGS = 0,
/*
* Path attributes.
*
* The ibt_path_attr_t structure is used to specify required attributes in a
* path from the requesting (source) node to a specified destination node.
* Attributes that are don't care should be set to NULL or '0'.
* A destination must be specified, where a destination can be defined as
* one of the following:
*
* o Service Name
* o Service ID (SID)
* o Array of DGIDs.
* o Service Name and Array of DGIDs.
*/
typedef struct ibt_path_attr_s {
char *pa_sname; /* ASCII Service name */
/* NULL Terminated */
/*
* Path Information.
*
* The ibt_get_paths() performs SA Path record lookups to select a path(s) to
* a given destination(s), details of selected path(s) are returned in this
* structure.
*
* The ibt_path_info_t contains all the attributes of the best path(s), as
* as determined by IBTL, to the specified destination(s), including the
* local HCA and HCA port to use to access the fabric.
*
* The Service ID (pi_sid) and Service Data (pi_sdata) are returned only for
*/
typedef struct ibt_path_info_s {
/* this record is invalid */
/* cep_hca_port_num is not */
/* '0' */
/*
* Optional Alternate Path attributes.
*
* The ibt_alt_path_attr_t structure is used to specify additional optional
* attributes when requesting an alternate path for an existing channel.
*
* Attributes that are don't care should be set to NULL or '0'.
*/
typedef struct ibt_alt_path_attr_s {
/*
* Path Information for Alternate Path - input to ibt_set_alt_path().
*/
typedef struct ibt_alt_path_info_s {
/* cep_hca_port_num is not */
/* '0' */
/*
* Open Channel flags, Used in ibt_open_rc_channel call
*/
typedef enum ibt_chan_open_flags_e {
IBT_OCHAN_NO_FLAGS = 0,
IBT_OCHAN_REDIRECTED = 1 << 0,
/*
* Arguments for ibt_open_rc_channel().
*
* oc_priv_data should be NULL or point to a buffer allocated by the caller,
* the size of which should be in oc_priv_data_len, where oc_priv_data_len <=
* IBT_REQ_PRIV_DATA_SZ.
*
* When ibt_open_rc_channel returns with ibt_cm_reason_t of
* IBT_CM_REDIRECT_PORT, the client can re-issue ibt_open_rc_channel setting
* new fields as follows:
*
* Set (ibt_chan_args_t)->oc_cm_cep_path =
* original (ibt_chan_open_args_t)->oc_path->pi_prim_cep_path.
* Set (ibt_chan_args_t)->oc_cm_pkt_lt =
* original (ibt_chan_open_args_t)->oc_prim_pkt_lt.
* Update (ibt_chan_args_t)->oc_path based on path information returned
* from ibt_get_paths using the gid in the return data below:
* (ibt_rc_returns_t)->rc_arej_info.ari_redirect_info.ari_gid.
* Set flags to IBT_OCHAN_PORT_REDIRECTED.
*
* Note : oc_cm_path is not used for any other scenario, and must be set for
* IBT_OCHAN_PORT_REDIRECTED.
*
* When ibt_open_rc_channel returns with ibt_cm_reason_t of
* IBT_CM_REDIRECT_CM, the client can re-issue ibt_open_rc_channel setting
* new fields as follows:
*
* Update (ibt_chan_args_t)->oc_path based on path information returned
* from ibt_get_paths using the return data in
* (ibt_rc_returns_t)->rc_arej_info.ari_redirect_info.
*
* Set (ibt_chan_args_t)->oc_cm_redirect_info =
* Returned (ibt_rc_returns_t)->rc_arej_info.ari_redirect_info.
* Set flags to IBT_OCHAN_REDIRECTED.
*
* Note:
*
* IBT_OCHAN_PORT_REDIRECTED flag cannot be used to specify a remote CM MAD
* address, that is on a different subnet than the RC connection itself.
*
* Not specified attributes should be set to "NULL" or "0".
*/
typedef struct ibt_chan_open_args_s {
void *oc_cm_clnt_private; /* First argument to */
/* cm_handler */
/* REQ Private data */
void *oc_priv_data; /* REQ private data */
/* for port and CM */
/* redirection */
/* CM MADs on */
/* port redirection */
/* CM MADs */
/*
* Define an optional RC return arguments structure. This contains return
* parameters from ibt_open_rc_channel() when called in BLOCKING mode.
*
* rc_priv_data should be NULL or point to a buffer allocated by the caller,
* the size of which should be in rc_priv_data_len, where rc_priv_data_len <=
* IBT_REP_PRIV_DATA_SZ.
*/
typedef struct ibt_rc_returns_s {
void *rc_priv_data;
/*
* Define a callback function that can be used in Non-Blocking calls to
* ibt_recycle_rc().
*/
/*
* Define an optional return arguments structure from ibt_set_alt_path()
* This contains return parameters, when called in BLOCKING mode.
*
* ap_priv_data should be NULL or point to a buffer allocated by the caller,
* the size of which should be in ap_priv_data_len, where ap_priv_data_len <=
* IBT_APR_PRIV_DATA_SZ.
* The private data from APR is returned in ap_priv_data.
* The caller specifies amount of APR private data to be returned in
* ap_priv_data_len.
*/
typedef struct ibt_ap_returns_s {
void *ap_priv_data;
/*
* UD remote destination attributes.
*
* ud_sid, ud_addr, ud_pkt_lt and ud_pkey_ix must be specified.
* These values can be as returned in an ibt_path_info_t struct from an
* ibt_get_paths() call.
*
* ud_priv_data should be NULL or point to a buffer allocated by the caller,
* the size of which is in ud_priv_data_len, where ud_priv_data_len <=
* IBT_SIDR_REQ_PRIV_DATA_SZ.
*/
typedef struct ibt_ud_dest_attr_s {
/* which must be NULL */
/* if not specified. */
void *ud_cm_private; /* First arg to ud_cm_handler */
void *ud_priv_data; /* SIDR REQ private data */
/*
* Define an optional UD return arguments structure.
*
* ud_priv_data should be NULL or point to a buffer allocated by the caller,
* the size of which should be in ud_priv_data_len, where ud_priv_data_len <=
* IBT_SIDR_REP_PRIV_DATA_SZ.
*/
typedef struct ibt_ud_returns_s {
void *ud_priv_data;
/*
* Multicast group attributes
* Not specified attributes should be set to "NULL" or "0".
* Used by ibt_join_mcg()/ibt_query_mcg().
*
* mc_qkey, mc_pkey, mc_flow, mc_tclass, mc_sl, mc_join_state are required for
* create - ibt_join_mcg().
*/
typedef struct ibt_mcg_attr_s {
/* added to the MCG. */
/*
* Multicast group attributes.
* returned by ibt_join_mcg()/ibt_query_mcg().
*/
typedef struct ibt_mcg_info_s {
/*
* Define a callback function that can be used in Non-Blocking calls to
* ibt_join_mcg().
*/
/*
* Service Flags - sd_flags
*
* IBT_SRV_PEER_TYPE_SID Peer-to-peer Service IDs.
*/
typedef enum ibt_service_flags_e {
IBT_SRV_NO_FLAGS = 0x0,
IBT_SRV_PEER_TYPE_SID = 0x1
/*
* Define a Service ID Registration structure.
*/
typedef struct ibt_srv_desc_s {
/*
* Flag to indicate ibt_bind_service() to or NOT-to clean-up Stale matching
* Local Service Records with SA prior to binding the new request.
*/
#define IBT_SBIND_NO_FLAGS 0
#define IBT_SBIND_NO_CLEANUP 1
/*
* Define a Service ID Binding structure (data for service records).
*/
typedef struct ibt_srv_bind_s {
char *sb_name; /* Service Name (up to 63 chars) */
/* matching local service records. */
/*
* ibt_cm_delay() flags.
*
* Refer to InfiniBand Architecture Release Volume 1 Rev 1.0a:
* Section 12.6.6 MRA
*/
typedef enum ibt_cmdelay_flags_e {
IBT_CM_DELAY_REQ = 0,
IBT_CM_DELAY_REP = 1,
IBT_CM_DELAY_LAP = 2
/*
* The payload for DDI events passed on IB_PROP_UPDATE_EVENT.
* This is passed as the bus nexus data to event_handler(9e).
*/
typedef struct ibt_prop_update_payload_s {
union {
struct {
#define ib_srv_prop_updated \
#define ib_gid_prop_updated \
#define ib_prop_updated \
/*
* FUNCTION PROTOTYPES.
*/
/*
* ibt_attach() and ibt_detach():
* These are the calls into IBTF used during client driver attach() and
* detach().
*
* The IBTF returns an ibt_clnt_hdl_t to the client. This handle is used
* to identify this client device in all subsequent calls into the IBTF.
*
* The ibt_detach() routine is called from a client driver's detach()
* routine to deregister itself from the IBTF.
*/
/*
* HCA FUNCTIONS
*/
/*
* ibt_get_hca_list()
* Returns the number of HCAs in a system and their node GUIDS.
*
* If hca_list_p is not NULL then the memory for the array of GUIDs is
* allocated by the IBTF and should be freed by the caller using
* ibt_free_hca_list(). If hca_list_p is NULL then no memory is allocated
* by ibt_get_hca_list and only the number of HCAs in a system is returned.
*
* It is assumed that the caller can block in kmem_alloc.
*
* ibt_free_hca_list()
* Free the memory allocated by ibt_get_hca_list().
*/
/*
* ibt_close_hca() once. ibt_open_hca() takes a client's ibt handle
* and a GUID and returns a unique IBT client HCA
* handle.
*
* These routines can not be called from interrupt context.
*/
/*
* ibt_query_hca()
* ibt_query_hca_byguid()
* Returns the static attributes of the specified HCA
*/
/*
* ibt_query_hca_ports()
* ibt_query_hca_ports_byguid()
* ibt_query_hca_ports() allocates the memory required for the
* ibt_hca_portinfo_t struct as well as the memory required for the SGID
* and P_Key tables contained within that struct.
*
* ibt_free_portinfo()
* Frees the memory allocated for a specified ibt_hca_portinfo_t struct.
*/
/*
* ibt_get_hca_private()
*/
/*
* ibt_hca_handle_to_guid()
* A helper function to retrieve HCA GUID for the specified handle.
* Returns HCA GUID on which the specified Channel is allocated. Valid
* if it is non-NULL on return.
*/
/*
* ibt_hca_guid_to_handle()
* A helper function to retrieve a hca handle from a HCA GUID.
*/
/*
* CONNECTION ESTABLISHMENT/TEAR DOWN FUNCTIONS.
*/
/*
* ibt_get_paths
* Finds the best path to a specified destination (as determined by the
* IBTL) that satisfies the requirements specified in an ibt_path_attr_t
* struct.
*/
/*
* Callback function that can be used in ibt_aget_paths(), a Non-Blocking
* version of ibt_get_paths().
*/
/*
* Find path(s) to a given destination or service asynchronously.
* ibt_aget_paths() is a Non-Blocking version of ibt_get_paths().
*/
void *arg);
/*
* ibt_get_alt_path
* Finds the best alternate path to a specified channel (as determined by
* the IBTL) that satisfies the requirements specified in an
* ibt_alt_path_attr_t struct. The specified channel must have been
* previously opened successfully using ibt_open_rc_channel.
*/
/*
* ibt_open_rc_channel
* ibt_open_rc_channel() opens a previously allocated RC communication
* channel. The IBTL initiates the channel establishment protocol.
*/
/*
* ibt_close_rc_channel
* Close the specified channel. Outstanding work requests are flushed
* so that the client can do the associated clean up. After that, the
* client will usually deregister the previously registered memory,
* then free the channel by calling ibt_free_rc_channel().
*
* This function will reuse CM event Handler provided in
* ibt_open_rc_channel().
*/
/*
* ibt_prime_close_rc_channel
*
* Allocates resources required for a close rc channel operation.
* Calling ibt_prime_close_rc_channel() allows a channel to be
* subsequently closed in interrupt context.
*
* A call is first made to ibt_prime_close_rc_channel in non-interrupt
* context, followed by ibt_close_rc_channel in non-blocking mode from
* interrupt context
*
* ibt_prime_close_rc_channel() can only be called on a previously opened
* channel.
*/
/*
* ibt_recycle_rc
*
* Recycle a RC channel which has transitioned to Error state. The
* ibt_recycle_rc() function transitions the channel from Error
* state (IBT_STATE_ERROR) to the state ready for use by
* ibt_open_rc_channel. Basically, this function is very similar to
* ibt_alloc_rc_channel, but reuses an existing RC channel.
*
*
* Client(s) must not invoke blocking version (ie., func specified as NULL) of
* ibt_recycle_rc from cm callback for IBT_CM_EVENT_CONN_CLOSED
*
* Clients are strongly advised not to issue blocking calls from func, as this
* would block the CM threads, and could delay or block other client connections
* and ibtl related API invocations.
*/
/*
* ibt_recycle_ud
*
* Recycle a UD channel which has transitioned to Error state. The
* ibt_recycle_ud() function transitions the channel from Error
* state (IBT_STATE_ERROR) to a usable state (IBT_STATE_RTS).
* Basically, this function is very similar to ibt_alloc_ud_channel,
* but reuses an existing UD channel.
*/
/*
* MODIFY CHANNEL ATTRIBUTE FUNCTIONs.
*/
/*
* ibt_pause_sendq
* ibt_unpause_sendq
* Place the send queue of the specified channel into the send queue
* drained state.
* Applicable for both RC and UD channels.
*/
/*
* ibt_resize_queues()
*
* Applicable for both RC and UD channels.
*/
/*
* ibt_query_queues()
*
* Applicable for both RC and UD channels.
*/
/*
* ibt_modify_rdma
*
* Applicable for RC channels only.
*/
/*
* ibt_set_rdma_resource
* Change the number of resources to be used for incoming and outgoing
* RDMA reads & Atomics.
*/
/*
* ibt_change_port
* Change the primary physical port of an RC channel. (This is done only
* if HCA supports this capability). Can only be called on a paused
* channel.
* Applicable for RC channels only.
*/
/*
* SERVICE REGISTRATION FUNCTIONS
*/
/*
* ibt_register_service()
* ibt_deregister_service()
* Register/deregister a Service (range of Service IDs) with the IBTF.
*
* ibt_bind_service()
* ibt_unbind_service()
* ibt_unbind_all_services()
* Bind a Service to a given port (GID), and optionally create
* service record(s) with the SA for ibt_get_paths() to find.
*/
/*
* ibt_cm_delay
* A client CM handler/srv_handler function can call this function to
* extend its response time to a CM event.
* Applicable for RC channels only.
*/
/*
* ibt_cm_proceed
*
* An IBT client calls ibt_cm_proceed() to proceed with a connection that
* previously deferred by the client returning IBT_CM_DEFER on a CM handler
* callback. CM events that can be deferred and continued with ibt_cm_proceed()
* are REQ_RCV, REP_RCV, LAP_RCV, and DREQ_RCV.
*
* NOTE :
*
* Typically CM completes processing of a client's CM handler return, with
* IBT_CM_DEFER status, before processing of the corresponding ibt_cm_proceed()
* is started. However a race exists where by CM may not have completed the
* client's handler return processing when ibt_cm_proceed() is called by a
* client. In this case ibt_cm_proceed() will block until processing of the
* client's CM handler return is complete.
*
* A client that returns IBT_CM_DEFER from the cm handler must
* subsequently make a call to ibt_cm_proceed(). It is illegal to call
* ibt_cm_proceed() on a channel that has not had the connection
* establishment deferred.
*
* Client cannot call ibt_cm_proceed from the cm handler.
*/
/*
* ibt_cm_ud_proceed
*
* An IBT client calls ibt_cm_ud_proceed() to proceed with an
* IBT_CM_UD_EVENT_SIDR_REQ UD event that was previously deferred by the
* client returning IBT_CM_DEFER on a CM UD handler callback.
* NOTE :
*
* Typically CM completes processing of a client's CM handler return, with
* IBT_CM_DEFER status, before processing of the corresponding
* ibt_cm_ud_proceed() is started. However a race exists where by CM may not
* have completed the client's handler return processing when
* ibt_cm_ud_proceed() is called by a client. In this case ibt_cm_ud_proceed()
* will block until processing of the client's CM handler return is complete.
*
* A client that returns IBT_CM_DEFER from the cm handler must
* subsequently make a call to ibt_cm_ud_proceed(). It is illegal to call
* ibt_cm_ud_proceed() on a channel that has not had the connection
* establishment deferred.
*
* Client cannot call ibt_cm_ud_proceed from the cm handler.
*/
/*
* COMPLETION QUEUES.
*
* ibt_alloc_cq_sched()
* Reserve CQ scheduling class resources
*
* ibt_free_cq_sched()
* Free CQ scheduling class resources
*/
/*
* ibt_alloc_cq()
* Allocate a completion queue.
*/
/*
* ibt_free_cq()
* Free allocated CQ resources.
*/
/*
* ibt_enable_cq_notify()
* Enable notification requests on the specified CQ.
* Applicable for both RC and UD channels.
*
* Completion notifications are disabled by setting the completion
* handler to NULL by calling ibt_set_cq_handler().
*/
/*
* ibt_set_cq_handler()
* Register a work request completion handler with the IBTF.
* Applicable for both RC and UD channels.
*
* Completion notifications are disabled by setting the completion
* handler to NULL. When setting the handler to NULL, no additional
* calls to the CQ handler will be initiated.
*
* This function does not otherwise change the state of previous
* calls to ibt_enable_cq_notify().
*/
/*
* ibt_poll_cq()
* Poll the specified CQ for the completion of work requests (WRs).
* If the CQ contains completed WRs, up to num_wc of them are returned.
* Applicable for both RC and UD channels.
*/
/*
* ibt_query_cq()
* Return the total number of entries in the CQ.
*/
/*
* ibt_query_cq_handler_id()
* Return interrupt characteristics of the CQ handler
*/
/*
* ibt_resize_cq()
* Change the size of a CQ.
*/
/*
* ibt_modify_cq()
* Change the interrupt moderation values of a CQ.
* "count" is number of completions before interrupting.
* "usec" is the number of microseconds before interrupting.
*/
/*
* ibt_set_cq_private()
* ibt_get_cq_private()
*/
/*
* Memory Management Functions.
* Applicable for both RC and UD channels.
*
* ibt_register_mr()
* Prepares a virtually addressed memory region for use by a HCA. A
* description of the registered memory suitable for use in Work Requests
* (WRs) is returned in the ibt_mr_desc_t parameter.
*
* ibt_register_buf()
* Prepares a memory region described by a buf(9S) struct for use by a
* HCA. A description of the registered memory suitable for use in
* Work Requests (WRs) is returned in the ibt_mr_desc_t parameter.
*
* ibt_query_mr()
* Retrieves information about a specified memory region.
*
* ibt_deregister_mr()
* Remove a memory region from a HCA translation table, and free all
* resources associated with the memory region.
*
* ibt_reregister_mr()
* ibt_reregister_buf()
* Modify the attributes of an existing memory region.
*
* ibt_register_shared_mr()
* Given an existing memory region, a new memory region associated with
* the same physical locations is created.
*
* ibt_sync_mr()
* Sync a memory region for either RDMA reads or RDMA writes
*
* ibt_alloc_mw()
* Allocate a memory window.
*
* ibt_query_mw()
* Retrieves information about a specified memory window.
*
* ibt_free_mw()
* De-allocate the Memory Window.
*/
/*
* ibt_alloc_lkey()
* Allocates physical buffer list resources for use in memory
* registrations.
*
* Applicable for both RC and UD channels.
*/
/*
* Physical Memory Management Functions.
* Applicable for both RC and UD channels.
*
* ibt_register_phys_mr()
* Prepares a physically addressed memory region for use by a HCA.
*
* ibt_reregister_phys_mr()
* Modify the attributes of an existing memory region.
*/
/*
* Register DMA Memory Region
*/
/*
* Address Translation.
*/
/*
* ibt_map_mem_area()
* Translate a kernel virtual address range into HCA physical addresses.
* A set of physical addresses, that can be used with "Reserved L_Key",
* register physical, and "Fast Registration Work Request" operations
* is returned.
*/
/*
* ibt_unmap_mem_area()
* Un pin physical pages pinned during an ibt_map_mem_area() call.
*/
/* ibt_map_mem_iov() */
/* ibt_unmap_mem_iov() */
/*
* Work Request Functions
* Applicable for RC and UD channels.
*
* ibt_post_send()
* Post send work requests to the specified channel.
*
* ibt_post_recv()
* ibt_post_srq()
* Post receive work requests to the specified channel.
*/
/*
* Alternate Path Migration Functions.
* Applicable for RC channels only.
*
*
* ibt_get_alt_path()
* Finds the best alternate path to a specified channel (as determined by
* the IBTL) that satisfies the requirements specified in an
* ibt_alt_path_attr_t struct. The specified channel must have been
* previously opened successfully using ibt_open_rc_channel.
* This function also ensures that the service being accessed by the
* channel is available at the selected alternate port.
*
* Note: The apa_dgid must be on the same destination channel adapter,
* if specified.
*
*
* ibt_set_alt_path()
* Load the specified alternate path. Causes the CM to send an LAP message
* to the remote node. If successful, the local channel is updated with
* the new alternate path and the channel migration state is set to REARM.
* Can only be called on a previously opened RC channel. The channel must
* be either in RTS or paused state.
*
*
* ibt_migrate_path()
* Force the CI to use the alternate path. The alternate path becomes
* the primary path. A new alternate path should be loaded and enabled.
*/
/*
* Multicast group Functions.
* Applicable for UD channels only.
*/
/*
* ibt_attach_mcg()
* Attaches a UD channel to the specified multicast group. On successful
* completion, this channel will be provided with a copy of every
* multicast message addressed to the group specified by the MGID
* (mcg_info->mc_adds_vect.av_dgid) and received on the HCA port with
* which the channel is associated.
*/
/*
* ibt_detach_mcg()
* Detach the specified UD channel from the specified multicast group.
*/
/*
* ibt_join_mcg()
* Join a multicast group. The first full member "join" causes the MCG
* to be created.
*/
/*
* ibt_leave_mcg()
* The port associated with the port GID shall be removed from the
* multicast group specified by MGID (mc_gid) or from all the multicast
* groups of which it is a member if the MGID (mc_gid) is not specified
* (i.e. mc_gid.mgid_prefix must have 8-bits of 11111111 at the start of
* the GID to identify this as being a multicast GID).
*
* The last full member to leave causes the destruction of the Multicast
* Group.
*/
/*
* ibt_query_mcg()
* Request information on multicast groups that match the parameters
* specified in mcg_attr. Information on each multicast group is returned
* to the caller in the form of an array of ibt_mcg_info_t.
* ibt_query_mcg() allocates the memory for this array and returns a
* pointer to the array (mcgs_p) and the number of entries in the array
* (entries_p). This memory should be freed by the client using
* ibt_free_mcg_info().
*/
/*
* ibt_free_mcg_info()
* Free the memory allocated by successful ibt_query_mcg()
*/
/*
* ibt_register_subnet_notices()
* Register a handler to be called for subnet notifications.
*/
/*
* Protection Domain Functions.
*
* ibt_alloc_pd()
* ibt_free_pd()
*/
ibt_pd_hdl_t *pd);
/*
* P_Key to P_Key Index conversion Functions.
*
* ibt_pkey2index_byguid
* ibt_pkey2index Convert a P_Key into a P_Key index.
*
* ibt_index2pkey_byguid
* ibt_index2pkey Convert a P_Key Index into a P_Key.
*/
/*
* ibt_ci_data_in()
*
* Pass CI specific userland data for CI objects to the CI.
*/
/*
* ibt_ci_data_out()
*
* Obtain CI specific userland data for CI objects.
*/
/*
* Node Information.
*/
/* Node type : n_node_type */
#define IBT_NODE_TYPE_SWITCH 2
#define IBT_NODE_TYPE_ROUTER 3
typedef struct ibt_node_info_s {
/*
* ibt_gid_to_node_info()
* Retrieve node information for the specified GID.
*/
/*
* ibt_reprobe_dev
* Reprobe properties for IOC device node.
*/
/*
* ibt_get_companion_port_gids()
*
* Get list of GID's available on a companion port(s) of the specified
* GUID.
*/
/*
* SHARED RECEIVE QUEUE
*/
/*
* ibt_alloc_srq()
* Allocate a shared receive queue.
*/
/*
* ibt_free_srq()
* Free allocated SRQ resources.
*/
/*
* ibt_query_srq()
* Query a shared receive queue.
*/
/*
* ibt_modify_srq()
* Modify a shared receive queue.
*/
/*
* ibt_set_srq_private()
* ibt_get_srq_private()
*/
/*
* ibt_check_failure()
* Function to test for special case failures
*/
/*
* ibt_hw_is_present() returns 0 when there is no IB hardware actively
* running. This is primarily useful for modules like rpcmod which needs a
* quick check to decide whether or not it should try to use InfiniBand.
*/
int ibt_hw_is_present();
/*
* Fast Memory Registration (FMR).
*
* ibt_create_fmr_pool
* Not fast-path.
* ibt_create_fmr_pool() verifies that the HCA supports FMR and allocates
* and initializes an "FMR pool". This pool contains state specific to
* this registration, including the watermark setting to determine when
* to sync, and the total number of FMR regions available within this pool.
*
* ibt_destroy_fmr_pool
* ibt_destroy_fmr_pool() deallocates all of the FMR regions in a specific
* pool. All state and information regarding the pool are destroyed and
* returned as free space once again. No more use of FMR regions in this
* pool are possible without a subsequent call to ibt_create_fmr_pool().
*
* ibt_flush_fmr_pool
* ibt_flush_fmr_pool forces a flush to occur. At the client's request,
* any unmapped FMR regions (See 'ibt_deregister_mr())') are returned to
* a free state. This function allows for an asynchronous cleanup of
* formerly used FMR regions. Sync operation is also performed internally
* by HCA driver, when 'watermark' settings for the number of free FMR
* regions left in the "pool" is reached.
*
* ibt_register_physical_fmr
* ibt_register_physical_fmr() assigns a "free" entry from the FMR Pool.
* It first consults the "FMR cache" to see if this is a duplicate memory
* registration to something already in use. If not, then a free entry
* in the "pool" is marked used.
*
* ibt_deregister_fmr
* The ibt_deregister_fmr un-maps the resources reserved from the FMR
* pool by ibt_register_physical_fmr(). The ibt_deregister_fmr() will
* mark the region as free in the FMR Pool.
*/
/*
* IP SUPPORT
*/
/*
* IP get_paths
* Returns an array (or single) of paths and source IP addresses. In the
* simplest form just the destination IP address is specified, and one path
* is requested, then one ibt_path_info_t struct and one source IP.
*
* More than one path can be requested to a single destination, in which case
* the requested number of ibt_path_info_t's are returned, and the same
* number of SRC IP address, with the first SRC IP address corrosponding
* to the first ibt_path_info_t, etc.
*
* Restrictions on the source end point can be specified, in the form of a
* source IP address (this implicitly defines the HCA, HCA port and Pkey)
* HCA, HCA port, and sgid (implicitly defines HCA and HCA port).
* Combinations are allowed but they must be consistent.
*
* Path attributes can also be specified, these can also affect local HCA
* selection.
*
* ibt_get_ip_paths() internally does (among other things):
*
* o ibt_get_list_of_ibd_ipaddr_and_macaddr( OUT list_ipaddr_macaddr)
*
* o extract_pkey_and_sgid(IN list_ipaddr_macaddr, OUT list_pkey_and_sgid)
*
* o map_dst_ip_addr(IN dst_ip_addr, OUT dst_pkey, OUT dgid) - See Note
*
* o filter_by_pkey(IN list_pkey_and_sgid, IN dst_pkey, OUT list_of_sgid)
*
* o do_multipath_query(IN list_of_sgid, IN dst_pkey, IN dgid, OUT path_list)
*
* o pick_a_good_path(IN path_list, OUT the_path)
*
* o find_matching_src_ip(IN the_path, IN list_ipaddr_macaddr, OUT src_ip)
*
* The ibd instance which got the ARP response is only on one P_Key
* knowing the ibd instance (or which IPonIB MCG) got the ARP response
* determins the P_Key associated with a dgid. If the proposedi "ip2mac()"
* API is used to get an IP to GID translations, then returned 'sockaddr_dl'
* contains the interface name and index.
*
*
* Example:
* ip_path_attr.ipa_dst_ip = dst_ip_addr;
* ip_path_attr.ipa_ndst = 1;
* ip_path_attr.ipa_max_paths = 1;
*
* status = ibt_get_ip_paths(clnt_hdl, flags, &ip_path_attr, &paths,
* &num_paths_p, &src_ip);
*
* sid = ibt_get_ip_sid(protocol_num, dst_port);
* path_info->sid = sid;
*
* ip_cm_info.src_addr = src_ip;
* ip_cm_info.dst_addr = dst_ip_addr;
* ip_cm_info.src_port = src_port
*
* ibt_format_ip_private_data(ip_cm_info, priv_data_len, &priv_data);
* ibt_open_rc_channel(chan, private_data);
*/
typedef struct ibt_ip_path_attr_s {
/*
* Path SRC IP addresses
*/
typedef struct ibt_path_ip_src_s {
/*
* ibt_get_src_ip()
* Get List of IP-Address that matches the parameters specified in
* srcip_attr. As a given MAC address can have both IPv4 and IPv6
* addressed configured, caller can optional request to return only
* the desired family by specifying the "sip_family" field. If
* "sip_family" is AF_UNSPEC, then all assigned IP address (IPv4
* for that specific address will also be returned.
* "sip_zoneid" will specify the zones the user is interested in.
*
* Information on each ip-address is returned to the caller in the
* form of an array of ibt_srcip_info_t. ibt_get_src_ip() allocates the
* memory for this array and returns a pointer to the array (src_info_p)
* and the number of entries in the array (entries_p). This memory
* should be freed by the client using ibt_free_srcip_info().
*
* ibt_free_srcip_info()
* Free the memory allocated by successful ibt_get_src_ip()
*/
typedef struct ibt_srcip_attr_s {
/*
* ip_flag : Flag to indicate whether the returned list of ip-address
* has any duplicate records.
*/
#define IBT_IPADDR_NO_FLAGS 0
#define IBT_IPADDR_DUPLICATE 1
typedef struct ibt_srcip_info_s {
/*
* Callback function that can be used in ibt_aget_ip_paths(), a Non-Blocking
* version of ibt_get_ip_paths().
*/
/*
* Find path(s) to a given destination or service asynchronously.
* ibt_aget_ip_paths() is a Non-Blocking version of ibt_get_ip_paths().
*/
/*
* IP RDMA protocol functions
*/
/*
* IBTF manages the port number space for non well known ports. If a ULP
* an sid based on the IP protocol number '0' (reserved) and an IBTF assigned
* port number. ibt_release_ip_sid() should be used to release the hold
* of SID created by ibt_get_ip_sid().
*/
/*
*/
typedef struct ibt_ip_cm_info_s {
/*
* If a ULP is using IP addressing as defined by the RDMA IP CM Service IBTA
* Annex 11, then it must always allocate a private data buffer for use in
* the ibt_open_rc_channel(9F) call. The minimum size of the buffer is
* IBT_IP_HDR_PRIV_DATA_SZ, if the ULP has no ULP specific private data.
* This allows ibt_format_ip_private_data() to place the RDMA IP CM service
* hello message in the private data of the REQ. If the ULP has some ULP
* specific private data then it should allocate a buffer big enough to
* contain that data plus an additional IBT_IP_HDR_PRIV_DATA_SZ bytes.
* The ULP should place its ULP specific private data at offset
* IBT_IP_HDR_PRIV_DATA_SZ in the allocated buffer before calling
* ibt_format_ip_private_data().
*/
/*
* The ibt_alt_ip_path_attr_t structure is used to specify additional optional
* attributes when requesting an alternate path for an existing channel.
*
* Attributes that are don't care should be set to NULL or '0'.
*/
typedef struct ibt_alt_ip_path_attr_s {
/*
* CONTRACT PRIVATE ONLY INTERFACES
*
* DO NOT USE THE FOLLOWING FUNCTIONS WITHOUT SIGNING THE CONTRACT
* WITH IBTF GROUP.
*/
/* Define an Address Record structure (data for ATS service records). */
typedef struct ibt_ar_s {
} ibt_ar_t;
/*
* ibt_register_ar()
* ibt_deregister_ar()
* Register/deregister an Address Record with the SA.
* ibt_query_ar()
*/
/*
* ibt_modify_system_image()
* ibt_modify_system_image_byguid()
* Modify specified HCA's system image GUID.
*/
/*
* ibt_modify_port()
* ibt_modify_port_byguid()
* Modify the specified port, or all ports attribute(s).
*/
/*
* ibt_get_port_state()
* ibt_get_port_state_byguid()
* Return the most commonly requested attributes of an HCA port.
* If the link state is not IBT_PORT_ACTIVE, the other returned values
* are undefined.
*/
/*
* ibt_alloc_io_mem()
* ibt_free_io_mem()
* Allocate and deallocate dma-able memory.
*/
caddr_t *, ibt_mem_alloc_hdl_t *);
/*
* Interfaces to get IB partition information.
*/
typedef struct ibt_part_attr_s {
ibt_status_t (*)(ibt_part_attr_t **, int *));
void ibt_unregister_part_attr_cb(void);
/*
* ibt_lid_to_node_info()
* Retrieve node record information for the specified LID.
*/
#ifdef __cplusplus
}
#endif
#endif /* _SYS_IB_IBTL_IBTI_COMMON_H */