summaryrefslogtreecommitdiff
path: root/usr/src/lib/smhba/common/vendorsmhbaapi.h
blob: 42982bc909046895d91f936469c44cdb66018fde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
 * ****************************************************************************
 *
 * Description
 *	vendorhbaapi.h - incombination with hbaapi.h, defines interface to
 *		vendor specific API
 *
 * License:
 *	The contents of this file are subject to the SNIA Public License
 *	Version 1.0 (the "License"); you may not use this file except in
 *	compliance with the License. You may obtain a copy of the License at
 *
 *	/http://www.snia.org/English/Resources/Code/OpenSource.html
 *
 *	Software distributed under the License is distributed on an "AS IS"
 *	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 *	the License for the specific language governing rights and limitations
 *	under the License.
 *
 * The Original Code is  SNIA HBA API general header file
 *
 * The Initial Developer of the Original Code is:
 *	Benjamin F. Kuo, Troika Networks, Inc. (benk@troikanetworks.com)
 *
 * Contributor(s):
 *	Tuan Lam, QLogic Corp. (t_lam@qlc.com)
 *	Dan Willie, Emulex Corp. (Dan.Willie@emulex.com)
 *	Dixon Hutchinson, Legato Systems, Inc. (dhutchin@legato.com)
 *	David Dillard, VERITAS Software Corp. (david.dillard@veritas.com)
 *
 * ****************************************************************************
 *
 *   Changes:
 *	12/12/2001 Original revision, code split out of hbaapi.h
 *	(for other changes... see the CVS logs)
 * ****************************************************************************
 */
/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _VENDORSMHBAAPI_H_
#define	_VENDORSMHBAAPI_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <vendorhbaapi.h>

/* SM-HBA-2 6.9.2 Function Prototypes */
typedef HBA_UINT32 (* SMHBAGetVersionFunc)();
typedef HBA_UINT32 (* SMHBAGetWrapperLibraryAttributesFunc)
	(HBA_UINT32, SMHBA_LIBRARYATTRIBUTES *);
typedef HBA_UINT32 (* SMHBAGetVendorLibraryAttributesFunc)
	(SMHBA_LIBRARYATTRIBUTES *);
typedef HBA_STATUS (* SMHBAGetAdapterAttributesFunc)
	(HBA_HANDLE, SMHBA_ADAPTERATTRIBUTES *);
typedef HBA_STATUS (* SMHBAGetNumberOfPortsFunc)
	(HBA_HANDLE, HBA_UINT32 *);
typedef HBA_STATUS (* SMHBAGetPortTypeFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_PORTTYPE *);
typedef HBA_STATUS (* SMHBAGetAdapterPortAttributesFunc)
	(HBA_HANDLE, HBA_UINT32, SMHBA_PORTATTRIBUTES *);
typedef HBA_STATUS (* SMHBAGetDiscoveredPortAttributesFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_UINT32, SMHBA_PORTATTRIBUTES *);
typedef HBA_STATUS (* SMHBAGetPortAttributesByWWNFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_PORTATTRIBUTES *);
typedef HBA_STATUS (* SMHBAGetFCPhyAttributesFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_UINT32, SMHBA_FC_PHY *);
typedef HBA_STATUS (* SMHBAGetSASPhyAttributesFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_UINT32, SMHBA_SAS_PHY *);
typedef HBA_STATUS (* SMHBAGetProtocolStatisticsFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_UINT32, SMHBA_PROTOCOLSTATISTICS *);
typedef HBA_STATUS (* SMHBAGetPhyStatisticsFunc)
	(HBA_HANDLE, HBA_UINT32, HBA_UINT32, SMHBA_PHYSTATISTICS *);
typedef HBA_STATUS (* SMHBASendTESTFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, void *, HBA_UINT32);
typedef HBA_STATUS (* SMHBASendECHOFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_UINT32, void *, HBA_UINT32,
	void *, HBA_UINT32 *);
typedef HBA_STATUS (* SMHBASendSMPPassThruFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN, void *, HBA_UINT32, void *,
	HBA_UINT32 *);
typedef HBA_STATUS (* SMHBAGetBindingCapabilityFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_BIND_CAPABILITY *);
typedef HBA_STATUS (* SMHBAGetBindingSupportFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_BIND_CAPABILITY *);
typedef HBA_STATUS (* SMHBASetBindingSupportFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_BIND_CAPABILITY);
typedef HBA_STATUS (* SMHBAGetTargetMappingFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_TARGETMAPPING *);
typedef HBA_STATUS (* SMHBAGetPersistentBindingFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, SMHBA_BINDING *);
typedef HBA_STATUS (* SMHBASetPersistentBindingFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, const SMHBA_BINDING *);
typedef HBA_STATUS (* SMHBARemovePersistentBindingFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, const SMHBA_BINDING *);
typedef HBA_STATUS (* SMHBARemoveAllPersistentBindingsFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN);
typedef HBA_STATUS (* SMHBAGetLUNStatisticsFunc)
	(HBA_HANDLE, const HBA_SCSIID *, SMHBA_PROTOCOLSTATISTICS *);
typedef HBA_STATUS (* SMHBARegisterForAdapterAddEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_UINT32), void *, HBA_CALLBACKHANDLE *);
typedef HBA_STATUS (* SMHBARegisterForAdapterEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_UINT32),
	void *, HBA_HANDLE, HBA_CALLBACKHANDLE *);
typedef HBA_STATUS    (* SMHBARegisterForAdapterPortEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_UINT32, HBA_UINT32),
	void *, HBA_HANDLE, HBA_WWN, HBA_UINT32, HBA_CALLBACKHANDLE *);
typedef HBA_STATUS    (* SMHBARegisterForAdapterPortStatEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_UINT32, HBA_UINT32),
	void *, HBA_HANDLE, HBA_WWN, HBA_UINT32, SMHBA_PROTOCOLSTATISTICS,
	HBA_UINT32, HBA_CALLBACKHANDLE *);
typedef HBA_STATUS    (* SMHBARegisterForAdapterPhyStatEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_UINT32, HBA_UINT32),
	void *, HBA_HANDLE, HBA_WWN, HBA_UINT32, SMHBA_PHYSTATISTICS,
	HBA_UINT32, HBA_CALLBACKHANDLE *);
typedef HBA_STATUS    (* SMHBARegisterForTargetEventsFunc)
	(void (*)(void *, HBA_WWN, HBA_WWN, HBA_WWN, HBA_UINT32),
	void *, HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN,
	HBA_CALLBACKHANDLE *, HBA_UINT32);
typedef HBA_STATUS    (* SMHBAScsiInquiryFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN, SMHBA_SCSILUN, HBA_UINT8,
	HBA_UINT8, void *, HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *);
typedef HBA_STATUS    (* SMHBAScsiReportLUNsFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN, void *, HBA_UINT32 *,
	HBA_UINT8 *, void *, HBA_UINT32 *);
typedef HBA_STATUS    (* SMHBAScsiReadCapacityFunc)
	(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN, SMHBA_SCSILUN, void *,
	HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *);

/* SM-HBA-2 6.9.3 Entry Point Data Declarations */
typedef struct SMHBA_EntryPoints {
	SMHBAGetVersionFunc			GetVersionHandler;
	HBALoadLibraryFunc			LoadLibraryHandler;
	HBAFreeLibraryFunc			FreeLibraryHandler;
	HBAGetNumberOfAdaptersFunc		GetNumberOfAdaptersHandler;
	HBARefreshInformationFunc		RefreshInformationHandler;
	SMHBAGetVendorLibraryAttributesFunc
		GetVendorLibraryAttributesHandler;
	HBAGetAdapterNameFunc			GetAdapterNameHandler;
	HBAOpenAdapterFunc			OpenAdapterHandler;
	HBACloseAdapterFunc			CloseAdapterHandler;
	SMHBAGetAdapterAttributesFunc		GetAdapterAttributesHandler;
	SMHBAGetNumberOfPortsFunc		GetNumberOfPortsHandler;
	SMHBAGetPortTypeFunc			GetPortTypeHandler;
	SMHBAGetAdapterPortAttributesFunc
		GetAdapterPortAttributesHandler;
	SMHBAGetDiscoveredPortAttributesFunc
		GetDiscoveredPortAttributesHandler;
	SMHBAGetPortAttributesByWWNFunc		GetPortAttributesByWWNHandler;
	SMHBAGetFCPhyAttributesFunc		GetFCPhyAttributesHandler;
	SMHBAGetSASPhyAttributesFunc		GetSASPhyAttributesHandler;
	SMHBAGetProtocolStatisticsFunc		GetProtocolStatisticsHandler;
	SMHBAGetPhyStatisticsFunc		GetPhyStatisticsHandler;
	HBASendCTPassThruV2Func			SendCTPassThruV2Handler;
	HBASetRNIDMgmtInfoFunc			SetRNIDMgmtInfoHandler;
	HBAGetRNIDMgmtInfoFunc			GetRNIDMgmtInfoHandler;
	HBASendRNIDV2Func			SendRNIDV2Handler;
	HBASendRPLFunc				SendRPLHandler;
	HBASendRPSFunc				SendRPSHandler;
	HBASendSRLFunc				SendSRLHandler;
	HBASendLIRRFunc				SendLIRRHandler;
	HBASendRLSFunc				SendRLSHandler;
	SMHBASendTESTFunc			SendTESTHandler;
	SMHBASendECHOFunc			SendECHOHandler;
	SMHBASendSMPPassThruFunc		SendSMPPassThruHandler;
	SMHBAGetBindingCapabilityFunc		GetBindingCapabilityHandler;
	SMHBAGetBindingSupportFunc		GetBindingSupportHandler;
	SMHBASetBindingSupportFunc		SetBindingSupportHandler;
	SMHBAGetTargetMappingFunc		GetTargetMappingHandler;
	SMHBAGetPersistentBindingFunc		GetPersistentBindingHandler;
	SMHBASetPersistentBindingFunc		SetPersistentBindingHandler;
	SMHBARemovePersistentBindingFunc	RemovePersistentBindingHandler;
	SMHBARemoveAllPersistentBindingsFunc
		RemoveAllPersistentBindingsHandler;
	SMHBAGetLUNStatisticsFunc		GetLUNStatisticsHandler;
	SMHBAScsiInquiryFunc			ScsiInquiryHandler;
	SMHBAScsiReportLUNsFunc			ScsiReportLUNsHandler;
	SMHBAScsiReadCapacityFunc		ScsiReadCapacityHandler;
	SMHBARegisterForAdapterAddEventsFunc
		RegisterForAdapterAddEventsHandler;
	SMHBARegisterForAdapterEventsFunc	RegisterForAdapterEventsHandler;
	SMHBARegisterForAdapterPortEventsFunc
		RegisterForAdapterPortEventsHandler;
	SMHBARegisterForAdapterPortStatEventsFunc
		RegisterForAdapterPortStatEventsHandler;
	SMHBARegisterForAdapterPhyStatEventsFunc
		RegisterForAdapterPhyStatEventsHandler;
	SMHBARegisterForTargetEventsFunc	RegisterForTargetEventsHandler;
	HBARegisterForLinkEventsFunc		RegisterForLinkEventsHandler;
	HBARemoveCallbackFunc			RemoveCallbackHandler;
} SMHBA_ENTRYPOINTS, *PSMHBA_ENTRYPOINTS;

typedef HBA_UINT32 (* SMHBARegisterLibraryFunc)(SMHBA_ENTRYPOINTS *);

HBA_STATUS SMHBA_RegisterLibrary(
	SMHBA_ENTRYPOINTS	*functionTable
);

#ifdef __cplusplus
}
#endif

#endif /* _VENDORSMHBAAPI_H_ */