xref: /trueos/contrib/ofed/management/opensm/include/vendor/osm_vendor_mlx_defs.h (revision 8fe640108653f13042f1b15213769e338aa524f6)
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 _OSMV_DEFS_H_
37 #define _OSMV_DEFS_H_
38 
39 #include <vendor/osm_vendor_mlx_inout.h>
40 #include <opensm/osm_log.h>
41 #include <vendor/osm_vendor_api.h>
42 #include <vendor/osm_vendor_mlx_txn.h>
43 
44 #ifdef __cplusplus
45 #  define BEGIN_C_DECLS extern "C" {
46 #  define END_C_DECLS   }
47 #else				/* !__cplusplus */
48 #  define BEGIN_C_DECLS
49 #  define END_C_DECLS
50 #endif				/* __cplusplus */
51 
52 BEGIN_C_DECLS
53 /* The maximum number of outstanding MADs an RMPP sender can transmit */
54 #define OSMV_RMPP_RECV_WIN       16
55 /* The maximum number of retransmissions of the same MAD */
56 #define OSMV_MAX_RETRANSMIT      3
57 /* Transaction Timeout = OSMV_TXN_TIMEOUT_FACTOR * Response Timeout */
58 #define OSMV_TXN_TIMEOUT_FACTOR  128
59 /************/
60 /****s* OSM Vendor: Types/osmv_bind_obj_t
61 * NAME
62 *	osmv_bind_obj_t
63 *
64 * DESCRIPTION
65 *	The object managing a single bind context.
66 *       The bind handle is a direct pointer to it.
67 *
68 * SYNOPSIS
69 */
70 typedef struct _osmv_bind_obj {
71 	/* Used to signal when the struct is being destroyed */
72 	struct _osmv_bind_obj *magic_ptr;
73 
74 	 osm_vendor_t /*const */  * p_vendor;
75 
76 	uint32_t hca_hndl;
77 	uint32_t port_num;
78 
79 	/* Atomic access protector */
80 	cl_spinlock_t lock;
81 
82 	/* is_closing == TRUE --> the handle is being unbound */
83 	boolean_t is_closing;
84 
85 	/* Event callbacks */
86 	osm_vend_mad_recv_callback_t recv_cb;
87 	osm_vend_mad_send_err_callback_t send_err_cb;
88 	/* ... and their context */
89 	void *cb_context;
90 
91 	/* A pool to manage MAD wrappers */
92 	osm_mad_pool_t *p_osm_pool;
93 
94 	/* each subvendor implements its own transport mgr */
95 	void *p_transp_mgr;
96 
97 	/* The transaction DB */
98 	osmv_txn_mgr_t txn_mgr;
99 
100 } osmv_bind_obj_t;
101 
102 END_C_DECLS
103 #endif				/* _OSMV_DEFS_H_ */
104