contrib/ofed/management/opensm/include/vendor/osm_vendor_mlx_transport.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 /**
  37  *  FILE                   osmv_transport.h
  38  *  AUTHOR                 Edward Bortnikov
  39  *
  40  *  DESCRIPTION
  41  *     The lower-level MAD transport interface implementation
  42  *     that allows sending a single MAD/receiving a callback
  43  *     when a single MAD is received.
  44 */
  45
  46 #ifndef _OSMV_TRANSPORT_H_
  47 #define _OSMV_TRANSPORT_H_
  48
  49 #include <vendor/osm_vendor_mlx.h>
  50 #include <vendor/osm_vendor_mlx_defs.h>
  51
  52 #ifdef __cplusplus
  53 #  define BEGIN_C_DECLS extern "C" {
  54 #  define END_C_DECLS   }
  55 #else                           /* !__cplusplus */
  56 #  define BEGIN_C_DECLS
  57 #  define END_C_DECLS
  58 #endif                          /* __cplusplus */
  59
  60 BEGIN_C_DECLS
  61 /*
  62  * NAME
  63  *   osmv_transport_init
  64  *
  65  * DESCRIPTION
  66  *   Setup the MAD transport infrastructure (filters, callbacks etc).
  67  */
  68 #define VENDOR_HCA_MAXNAMES 32
  69 ib_api_status_t
  70 osmv_transport_init(IN osm_bind_info_t * p_info,
  71                     IN char hca_id[VENDOR_HCA_MAXNAMES],
  72                     IN uint8_t hca_idx, IN osmv_bind_obj_t * p_bo);
  73
  74 /*
  75  * NAME
  76  *   osmv_transport_send_mad
  77  *
  78  * DESCRIPTION
  79  *   Send a single MAD (256 byte)
  80  */
  81 ib_api_status_t
  82 osmv_transport_mad_send(IN const osm_bind_handle_t h_bind,
  83                         IN void *p_mad, IN const osm_mad_addr_t * p_mad_addr);
  84
  85 /*
  86  * NAME
  87  *   osmv_transport_done
  88  *
  89  * DESCRIPTION
  90  *   deallocator of transportation infrastructure
  91  */
  92 void osmv_transport_done(IN const osm_bind_handle_t h_bind);
  93
  94 END_C_DECLS
  95 #endif                          /* _OSMV_TRANSPORT_H_ */