contrib/ofed/management/opensm/include/vendor/osm_mtl_bind.h

   1 /*
   2  * Copyright (c) 2004, 2005 Voltaire, Inc. All rights reserved.
   3  * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved.
   4  * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
   5  *
   6  * This software is available to you under a choice of one of two
   7  * licenses.  You may choose to be licensed under the terms of the GNU
   8  * General Public License (GPL) Version 2, available from the file
   9  * COPYING in the main directory of this source tree, or the
  10  * OpenIB.org BSD license below:
  11  *
  12  *     Redistribution and use in source and binary forms, with or
  13  *     without modification, are permitted provided that the following
  14  *     conditions are met:
  15  *
  16  *      - Redistributions of source code must retain the above
  17  *        copyright notice, this list of conditions and the following
  18  *        disclaimer.
  19  *
  20  *      - Redistributions in binary form must reproduce the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer in the documentation and/or other materials
  23  *        provided with the distribution.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32  * SOFTWARE.
  33  *
  34  */
  35
  36 #ifndef _OSM_BIND_H_
  37 #define _OSM_BIND_H_
  38
  39 #include <opensm/osm_helper.h>
  40 #include <vendor/osm_vendor_mtl.h>
  41 #include <vendor/osm_vendor_api.h>
  42 #include <opensm/osm_subnet.h>
  43 #include <opensm/osm_opensm.h>
  44
  45 #ifdef __cplusplus
  46 #  define BEGIN_C_DECLS extern "C" {
  47 #  define END_C_DECLS   }
  48 #else                           /* !__cplusplus */
  49 #  define BEGIN_C_DECLS
  50 #  define END_C_DECLS
  51 #endif                          /* __cplusplus */
  52
  53 BEGIN_C_DECLS
  54 /****s* OpenSM: Vendor/osm_vendor_mgt_bind
  55 * NAME
  56 *   osm_vendor_mgt_bind_t
  57 *
  58 * DESCRIPTION
  59 *       Tracks the handles returned by IB_MGT to the SMI and GSI
  60 *  Nulled on init of the vendor obj. Populated on first bind.
  61 *
  62 * SYNOPSIS
  63 */
  64 typedef struct _osm_vendor_mgt_bind {
  65         boolean_t smi_init, gsi_init;
  66         IB_MGT_mad_hndl_t smi_mads_hdl;
  67         IB_MGT_mad_hndl_t gsi_mads_hdl;
  68         struct _osm_mtl_bind_info *smi_p_bind;
  69 } osm_vendor_mgt_bind_t;
  70
  71 /*
  72 * FIELDS
  73 *       smi_mads_hdl
  74 *               Handle returned by IB_MGT_get_handle to the IB_MGT_SMI
  75 *
  76 *       gsi_mads_hdl
  77 *               Handle returned by IB_MGT_get_handle to the IB_MGT_GSI
  78 *
  79 * SEE ALSO
  80 *********/
  81
  82 /****s* OpenSM: Vendor osm_mtl_bind_info_t
  83 * NAME
  84 *   osm_mtl_bind_info_t
  85 *
  86 * DESCRIPTION
  87 *       Handle to the result of binding a class callbacks to IB_MGT.
  88 *
  89 * SYNOPSIS
  90 */
  91 typedef struct _osm_mtl_bind_info {
  92         IB_MGT_mad_hndl_t mad_hndl;
  93         osm_vendor_t *p_vend;
  94         void *client_context;
  95         VAPI_hca_hndl_t hca_hndl;
  96         VAPI_hca_id_t hca_id;
  97         uint8_t port_num;
  98         osm_vend_mad_recv_callback_t rcv_callback;
  99         osm_vend_mad_send_err_callback_t send_err_callback;
 100         osm_mad_pool_t *p_osm_pool;
 101 } osm_mtl_bind_info_t;
 102
 103 /*
 104 * FIELDS
 105 *       mad_hndl
 106 *               the handle returned from the registration in IB_MGT
 107 *
 108 *       p_vend
 109 *               Pointer to the vendor object.
 110 *
 111 *       client_context
 112 *               User's context passed during osm_bind
 113 *
 114 *  hca_id
 115 *     HCA Id we bind to.
 116 *
 117 *       port_num
 118 *               Port number (within the HCA) of the bound port.
 119 *
 120 *       rcv_callback
 121 *               OSM Callback function to be called on receive of MAD.
 122 *
 123 *  send_err_callback
 124 *     OSM Callback to be called on send error.
 125 *
 126 *  p_osm_pool
 127 *     Points to the MAD pool used by OSM
 128 *
 129 *
 130 * SEE ALSO
 131 *********/
 132 ib_api_status_t
 133 osm_mtl_send_mad(IN osm_mtl_bind_info_t * p_bind, IN osm_madw_t * const p_madw);
 134
 135 END_C_DECLS
 136 #endif                          // _OSM_BIND_H_