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  * Abstract:
38  * 	Declaration of osm_mad_wrapper_t.
39  *	This object represents the context wrapper for OpenSM MAD processing.
40  *	This object is part of the OpenSM family of objects.
41  */
42 
43 #ifndef _OSM_VENDOR_UMADT_h_
44 #define _OSM_VENDOR_UMADT_h_
45 
46 #include "iba/ib_types.h"
47 #include "complib/cl_qlist.h"
48 #include "complib/cl_thread.h"
49 #include <opensm/osm_base.h>
50 #include <vendor/umadt.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 /****h* OpenSM/ Vendor Umadt
62 * NAME
63 *	MAD Wrapper
64 *
65 * DESCRIPTION
66 *
67 *
68 * AUTHOR
69 *	Ranjit Pandit, Intel
70 *
71 *********/
72 typedef void *osm_vendor_t;
73 #define OSM_BIND_INVALID_HANDLE 0
74 
75 /****s* OpenSM: Vendor Umadt /osm_bind_handle_t
76 * NAME
77 *   osm_bind_handle_t
78 *
79 * DESCRIPTION
80 * 	handle returned by the vendor transport bind call.
81 *
82 * SYNOPSIS
83 */
84 
85 typedef void *osm_bind_handle_t;
86 
87 /****s* OpenSM: Vendor Umadt /mad_direction_t
88 * NAME
89 *	mad_direction_t
90 *
91 * DESCRIPTION
92 *	Tags for mad wrapper to indicate the direction of mads.
93 *	Umadt vendor transport layer uses this tag to call the appropriate
94 * 	Umadt APIs.
95 *
96 * SYNOPSIS
97 */
98 typedef enum _mad_direction_t {
99 	SEND = 0,
100 	RECEIVE,
101 } mad_direction_t;
102 
103 /****s* OpenSM/ osm_vend_wrap_t
104 * NAME
105 *   Umadt Vendor MAD Wrapper
106 *
107 * DESCRIPTION
108 *	Umadt specific MAD wrapper. Umadt transport layer sets this for
109 *	housekeeping.
110 *
111 * SYNOPSIS
112 *********/
113 typedef struct _osm_vend_wrap_t {
114 	MadtStruct *p_madt_struct;
115 	mad_direction_t direction;	// send or receive
116 	uint32_t size;
117 } osm_vend_wrap_t;
118 /*
119 * FIELDS
120 *	p_madt_struct
121 *		Umadt mad structure to identify a mad.
122 *
123 *	direction
124 *		Used to identify a mad with it's direction.
125 *
126 * SEE ALSO
127 *********/
128 
129 END_C_DECLS
130 #endif				/* _OSM_VENDOR_UMADT_h_ */
131