/*
* Abstract:
- * Specification of the OpenSM SA API. This API uses the basic osm vendor
- * API to provide SA Client interface.
+ * Specification of the OpenSM SA Client API. This API uses the basic osm
+ * vendor API to provide SA Client interface.
*
* Environment:
* Linux User Mode
OSMV_QUERY_PATH_REC_BY_LIDS,
OSMV_QUERY_UD_MULTICAST_SET,
- OSMV_QUERY_UD_MULTICAST_DELETE
+ OSMV_QUERY_UD_MULTICAST_DELETE,
} osmv_query_type_t;
/*
* VALUES
* OSMV_QUERY_USER_DEFINED
* Query the SA based on user-defined input. Queries of this type
-* should reference an osmv_user_query_t structure as input into the
+* should reference an osmv_user_query_t structure as input to the
* query.
*
* OSMV_QUERY_SVC_REC_BY_NAME
* Query for service records based on the service name. Queries of
* this type should reference an ib_svc_name_t structure as input
-* into the query.
+* to the query.
*
* OSMV_QUERY_SVC_REC_BY_ID
* Query for service records based on the service ID. Queries of
-* this type should reference an ib_net64_t value that indicates the
-* ID of the service being requested.
+* this type should reference an ib_net64_t value that indicates
+* the ID of the service being requested.
*
* OSMV_QUERY_NODE_REC_BY_NODE_GUID
* Query for node information based on the node's GUID. Queries of
-* this type should reference an ib_net64_t value that indicates the
-* GUID of the node being requested.
+* this type should reference an ib_net64_t value that indicates
+* the GUID of the node being requested.
*
* OSMV_QUERY_PORT_REC_BY_LID
-* Query for port information based on the port's base LID. Queries of
-* this type should reference an ib_net16_t value that indicates the
-* base LID of the port being requested.
+* Query for port information based on the port's base LID. Queries
+* of this type should reference an ib_net16_t value that indicates
+* the base LID of the port being requested.
*
* OSMV_QUERY_PORT_REC_BY_LID_AND_NUM
* Query for port information based on the port's LID and port num.
* Queries of this type should reference an osmv_user_query_t
-* structure as input into the query. The port num and lid should
+* structure as input to the query. The port num and lid should
* be provided by it.
*
* OSMV_QUERY_PATH_REC_BY_PORT_GUIDS
* Query for path records between the specified pair of port GUIDs.
-* Queries of this type should reference an osmv_guid_pair_t structure
-* that indicates the GUIDs of the path being requested.
+* Queries of this type should reference an osmv_guid_pair_t
+* structure that indicates the GUIDs of the path being requested.
*
* OSMV_QUERY_PATH_REC_BY_GIDS
* Query for path records between the specified pair of port GIDs.
-* Queries of this type should reference an osmv_gid_pair_t structure
-* that indicates the GIDs of the path being requested.
+* Queries of this type should reference an osmv_gid_pair_t
+* structure that indicates the GIDs of the path being requested.
*
* OSMV_QUERY_PATH_REC_BY_LIDS
* Query for path records between the specified pair of port LIDs.
-* Queries of this type should reference an osmv_lid_pair_t structure
-* that indicates the LIDs of the path being requested.
+* Queries of this type should reference an osmv_lid_pair_t
+* structure that indicates the LIDs of the path being requested.
*
* NOTES
* This enum is used to define abstracted queries provided by the access
* layer. Users may issue queries not listed here by sending MADs directly
-* to the subnet administrator or a class manager. These queries are
+* to subnet administration or a class manager. These queries are
* intended to represent those most often used by clients.
*
* SEE ALSO
* FIELDS
*
* method
-* Method to be run
+* Method to be used
*
* attr_id
* Attribute identifier of query data.
*
* attr_offset
-* Size of the query attribute, in 8-byte words. Users can set this
-* value by passing in the sizeof( attribute ) into the
+* Size of the query attribute, in 8-byte words. Users can set
+* this value by passing in the sizeof( attribute ) into the
* ib_get_attr_offset() routine.
*
* comp_mask
* NOTES
* This structure is used to describe a user-defined query. The attribute
* ID, attribute offset, component mask, and attribute structure must match
-* those defined by the IBA specification. Users should refer to chapter 15
-* of the IBA specification for additional details.
+* those defined by the IBA specification. Users should refer to chapter
+* 15 of the IBA specification for additional details.
*
* SEE ALSO
* osmv_query_type_t, ib_get_attr_offset, ib_get_attr_size, osmv_query_sa
/*
* FIELDS
* query_context
-* User-defined context information associated with the query through
-* the osm_vendor_query_sa call.
+* User-defined context information associated with the query
+* through the osm_vendor_query_sa call.
*
* status
* Indicates the success of the query operation.
*
* query_type
* Indicates the type of query for which the results are being returned.
-* This matches the query_type specified through the osm_vendor_query_sa
-* call.
+* This matches the query_type specified through the
+* osm_vendor_query_sa call.
*
* result_cnt
* The number of result structures that were returned by the query.
*
* p_result_madw
-* For queries returning IB_SUCCESS or IB_REMOTE_ERROR, this references
-* the MAD wrapper returned by the subnet administrator containing the list
-* of results or the returned error code.
+* For queries returning IB_SUCCESS or IB_REMOTE_ERROR, this
+* references the MAD wrapper returned by subnet administration
+* containing the list of results or the returned error code.
*
* NOTES
* A query result structure is returned to a client through their
* osmv_pfn_query_cb_t routine to notify them of the results of a subnet
* administration query. If the query was successful or received an error
-* from the subnet administrator, p_result_madw will reference a MAD wrapper
+* from subnet administration, p_result_madw will reference a MAD wrapper
* containing the results. The MAD referenced by p_result_madw is owned by
* the user and remains available even after their callback returns. Users
* must call osm_mad_pool_put() to return the MAD wrapper back to the
* [in] A zero-based index indicating which result to return.
*
* NOTES
-* This call returns a pointer to the start of a result structure from a call
-* to osmv_query_sa(). The type of result structure must be known to the user
-* either through the user's context or the query_type returned as part of
-* the osmv_query_res_t structure.
+* This call returns a pointer to the start of a result structure from a
+* call to osmv_query_sa(). The type of result structure must be known to
+* the user either through the user's context or the query_type returned as
+* part of the osmv_query_res_t structure.
*
* SEE ALSO
* osmv_query_res_t, osm_madw_t
* [in] A zero-based index indicating which result to return.
*
* NOTES
-* This call returns a pointer to the start of a port info record result from
-* a call to osmv_query_sa().
+* This call returns a pointer to the start of a port info record result
+* from a call to osmv_query_sa().
*
* SEE ALSO
* osmv_query_res_t, osm_madw_t, osmv_get_query_result, ib_portinfo_record_t
* osmv_pfn_query_cb_t
*
* DESCRIPTION
-* User-defined callback invoked on completion of a subnet administrator
+* User-defined callback invoked on completion of subnet administration
* query.
*
* SYNOPSIS
/*
* PARAMETERS
* p_query_res
-* [in] This is a reference to a structure containing the result of the
-* query.
+* [in] This is a reference to a structure containing the result of
+* the query.
*
* NOTES
* This routine is invoked to notify a client of the result of a subnet
* administration query. The p_query_rec parameter references the result
* of the query and, in the case of a successful query, any information
-* returned by the subnet administrator.
+* returned by subnet administration.
*
-* In the kernel, this callback is usually invoked using a tasklet, dependent
-* on the implementation of the underlying verbs provider driver.
+* In the kernel, this callback is usually invoked using a tasklet,
+* dependent on the implementation of the underlying verbs provider driver.
*
* SEE ALSO
* osmv_query_res_t
* osmv_query_req_t
*
* DESCRIPTION
-* Information used to request an access layer provided query of the subnet
-* administrator.
+* Information used to request an access layer provided query of subnet
+* administration.
*
* SYNOPSIS
*/
* Indicates the type of query that the access layer should perform.
*
* p_query_input
-* A pointer to the input for the query. The data referenced by this
-* structure is dependent on the type of query being requested and is
-* determined by the specified query_type.
+* A pointer to the input for the query. The data referenced by
+* this structure is dependent on the type of query being requested
+* and is determined by the specified query_type.
*
* sm_key
* The M_Key to be provided with the SA MAD for authentication.
* this query until retrying or timing out the request.
*
* retry_cnt
-* Specifies the number of times that the query will be retried before
-* failing the request.
+* Specifies the number of times that the query will be retried
+* before failing the request.
*
* flags
* Used to describe the mode of operation. Set to IB_FLAGS_SYNC to
* process the called routine synchronously.
*
* query_context
-* User-defined context information associated with this query. The
-* context data is returned to the user as a part of their query
-* callback.
+* User-defined context information associated with this query.
+* The context data is returned to the user as a part of their
+* query callback.
*
* pfn_query_cb
* A user-defined callback that is invoked upon completion of the query.
*
* NOTES
* This structure is used when requesting an osm vendor provided query
-* of the subnet administrator. Clients specify the type of query through
+* of subnet administration. Clients specify the type of query through
* the query_type field. Based on the type of query, the p_query_input
* field is set to reference the appropriate data structure.
*
*
* RETURN VALUE
* IB_SUCCESS if completed successfuly (or in ASYNC mode
-* if the erquest was sent).
+* if the request was sent).
*
* NOTES
*
projects / ~shefty / rdma-win.git / commitdiff