xref: /freebsd/contrib/ofed/opensm/include/vendor/osm_vendor_test.h (revision 87181516ef48be852d5e5fee53c6e0dbfc62f21e)
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_VENDOR_TEST_H_
37 #define _OSM_VENDOR_TEST_H_
38 
39 #include <iba/ib_types.h>
40 #include <opensm/osm_base.h>
41 #include <opensm/osm_log.h>
42 
43 #ifdef __cplusplus
44 #  define BEGIN_C_DECLS extern "C" {
45 #  define END_C_DECLS   }
46 #else				/* !__cplusplus */
47 #  define BEGIN_C_DECLS
48 #  define END_C_DECLS
49 #endif				/* __cplusplus */
50 
51 BEGIN_C_DECLS
52 /* This value must be zero for the TEST transport. */
53 #define OSM_BIND_INVALID_HANDLE 0
54 /*
55  * Abstract:
56  * 	Declaration of vendor specific transport interface.
57  *  This is the "Test" vendor which allows compilation and some
58  *  testing without a real vendor interface.
59  *	These objects are part of the OpenSM family of objects.
60  */
61 /****h* OpenSM/Vendor Test
62 * NAME
63 *	Vendor Test
64 *
65 * DESCRIPTION
66 *	The Vendor Test structure encapsulates an artificial transport layer
67 *	interface for testing.
68 *
69 * AUTHOR
70 *	Steve King, Intel
71 *
72 *********/
73 /****s* OpenSM: Vendor Test/osm_vend_wrap_t
74 * NAME
75 *	osm_vend_wrap_t
76 *
77 * DESCRIPTION
78 *	Vendor specific MAD wrapper context.
79 *
80 *	This structure allows direct access to member variables.
81 *
82 * SYNOPSIS
83 */
84 typedef struct _osm_vend_wrap {
85 	uint32_t dummy;
86 
87 } osm_vend_wrap_t;
88 /*********/
89 
90 /****s* OpenSM: Vendor Test/osm_vendor_t
91 * NAME
92 *	osm_vendor_t
93 *
94 * DESCRIPTION
95 *	Vendor specific MAD interface.
96 *
97 *	This interface defines access to the vendor specific MAD
98 *	transport layer.
99 *
100 * SYNOPSIS
101 */
102 typedef struct _osm_vendor {
103 	osm_log_t *p_log;
104 	uint32_t timeout;
105 
106 } osm_vendor_t;
107 /*********/
108 
109 typedef struct _osm_bind_handle {
110 	osm_vendor_t *p_vend;
111 	ib_net64_t port_guid;
112 	uint8_t mad_class;
113 	uint8_t class_version;
114 	boolean_t is_responder;
115 	boolean_t is_trap_processor;
116 	boolean_t is_report_processor;
117 	uint32_t send_q_size;
118 	uint32_t recv_q_size;
119 
120 } *osm_bind_handle_t;
121 
122 END_C_DECLS
123 #endif				/* _OSM_VENDOR_TEST_H_ */
124