1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIBSMHBAAPI 3LIB "Sep 28, 2009"
7 .SH NAME
8 libSMHBAAPI, libsmhbaapi, SMHBA_GetAdapterAttributes,
9 SMHBA_GetAdapterPortAttributes, SMHBA_GetBindingCapability,
10 SMHBA_GetBindingSupport, SMHBA_GetDiscoveredPortAttributes,
11 SMHBA_GetFCPhyAttributes, SMHBA_GetLUNStatistics, SMHBA_GetNumberofPorts,
12 SMHBA_GetPersistentBinding, SMHBA_GetPhyStatistics,
13 SMHBA_GetPortAttributesByWWN, SMHBA_GetPortType, SMHBA_GetProtocolStatistics,
14 SMHBA_GetSASPhyAttributes, SMHBA_GetTargetMapping,
15 SMHBA_GetVendorLibraryAttributes, SMHBA_GetVersion,
16 SMHBA_GetWrapperLibraryAttributes, SMHBA_RegisterForAdapterAddEvents,
17 SMHBA_RegisterForAdapterEvents, SMHBA_RegisterForAdapterPhyStatEvents,
18 SMHBA_RegisterForAdapterPortEvents, SMHBA_RegisterForAdapterPortStatEvents,
19 SMHBA_RegisterForTargetEvents, SMHBA_RegisterLibrary,
20 SMHBA_RemoveAllPersistentBindings, SMHBA_RemovePersistentBinding,
21 SMHBA_ScsiInquiry, SMHBA_ScsiReadCapacity, SMHBA_ScsiReportLuns,
22 SMHBA_SendECHO, SMHBA_SendSMPPassThru, SMHBA_SendTEST, SMHBA_SetBindingSupport,
23 SMHBA_SetPersistentBinding \- Common Storage Management HBA information library
24 .SH SYNOPSIS
25 .LP
26 .nf
27 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lSMHBAAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
28 #include <smhbaapi.h>
29 .fi
30
31 .SH DESCRIPTION
32 .sp
33 .LP
34 The functions in this library access Fibre Channel and/or Serial Attached SCSI
35 HBA data depending on vendor provided implementation underneath.
36 .sp
37 .LP
38 HBA information is provided through a standard interface in a vendor
39 independent manner. This common interface provides access to the following
40 information:
41 .RS +4
42 .TP
43 .ie t \(bu
44 .el o
45 Local HBA attributes
46 .RE
47 .RS +4
48 .TP
49 .ie t \(bu
50 .el o
51 Local HBA port attributes and statistics
52 .RE
53 .RS +4
55 .ie t \(bu
56 .el o
57 Mapping between discovered devices and operating system SCSI information
58 .RE
59 .RS +4
60 .TP
61 .ie t \(bu
62 .el o
63 Discovered devices port attributes
64 .RE
65 .RS +4
66 .TP
67 .ie t \(bu
68 .el o
69 SCSI commands for discovered devices (Report LUNS, Read Capacity, and Inquiry)
70 .RE
71 .RS +4
72 .TP
73 .ie t \(bu
74 .el o
75 Storage Managment Protocol commands to discover Serial Attached SCSI
76 configuration details
77 .RE
78 .RS +4
79 .TP
80 .ie t \(bu
81 .el o
82 Common Transport commands to discover Fibre Channel Fabric details
83 .RE
84 .SH INTERFACES
85 .sp
86 .LP
87 The shared object \fBlibSMHBAAPI.so.1\fR provides the public interfaces defined
88 below. See \fBIntro\fR(3) for additional information on shared object
89 interfaces.
90 .sp
91
92 .sp
93 .TS
94 l l
95 l l .
96 \fBHBA_CloseAdapter\fR \fBHBA_FreeLibrary\fR
97 \fBHBA_GetAdapterName\fR \fBHBA_GetNumberOfAdapters\fR
98 \fBHBA_GetRNIDMgmtInfo\fR \fBHBA_LoadLibrary\fR
99 \fBHBA_OpenAdapter\fR \fBHBA_RefreshAdapterConfiguration\fR
100 \fBHBA_RefreshInformation\fR \fBHBA_RegisterForLinkEvents\fR
101 \fBHBA_RemoveCallback\fR \fBHBA_SendCTPassThruV2\fR
102 \fBHBA_SendLIRR\fR \fBHBA_SendRLS\fR
103 \fBHBA_SendRNIDV2\fR \fBHBA_SendRPL\fR
104 \fBHBA_SendRPS\fR \fBHBA_SendSRL\fR
105 \fBHBA_SetRNIDMgmtInfo\fR \fBSMHBA_GetAdapterAttributes\fR
106 \fBSMHBA_GetAdapterPortAttributes\fR \fBSMHBA_GetBindingCapability\fR
107 \fBSMHBA_GetBindingSupport\fR \fBSMHBA_GetDiscoveredPortAttributes\fR
108 \fBSMHBA_GetFCPhyAttributes\fR \fBSMHBA_GetLUNStatistics\fR
109 \fBSMHBA_GetNumberofPorts\fR \fBSMHBA_GetPersistentBinding\fR
110 \fBSMHBA_GetPhyStatistics\fR \fBSMHBA_GetPortAttributesByWWN\fR
111 \fBSMHBA_GetPortType\fR \fBSMHBA_GetProtocolStatistics\fR
112 \fBSMHBA_GetSASPhyAttributes\fR \fBSMHBA_GetTargetMapping\fR
113 \fBSMHBA_GetVendorLibraryAttributes\fR \fBSMHBA_GetVersion\fR
114 \fBSMHBA_GetWrapperLibraryAttributes\fR \fBSMHBA_RegisterForAdapterAddEvents\fR
115 \fBSMHBA_RegisterForAdapterEvents\fR \fBSMHBA_RegisterForAdapterPhyStatEvents\fR
116 \fBSMHBA_RegisterForAdapterPortEvents\fR \fBSMHBA_RegisterForAdapterPortStatEvents\fR
117 \fBSMHBA_RegisterForTargetEvents\fR \fBSMHBA_RegisterLibrary\fR
118 \fBSMHBA_RemoveAllPersistentBindings\fR \fBSMHBA_RemovePersistentBinding\fR
119 \fBSMHBA_ScsiInquiry\fR \fBSMHBA_ScsiReadCapacity\fR
120 \fBSMHBA_ScsiReportLuns\fR \fBSMHBA_SendECHO\fR
121 \fBSMHBA_SendSMPPassThru\fR \fBSMHBA_SendTEST\fR
122 \fBSMHBA_SetBindingSupport\fR \fBSMHBA_SetPersistentBinding\fR
123 .TE
124
125 .SH USAGE
126 .sp
127 .LP
128 Client applications link with the Common Library (using -\fBlSMHBAAPI\fR) to
129 access the interfaces. The Common Library dynamically loads individual
130 Vendor-Specific Libraries (VSL) listed in \fB/etc/smhba.conf\fR and described
131 on \fBsmhba.conf\fR(4).
132 .sp
133 .LP
134 Using the \fBlibSMHBAAPI\fR involves the following steps:
135 .RS +4
136 .TP
137 1.
138 Optionally determining the version of the library by calling
139 \fBSMHBA_GetVersion()\fR.
140 .RE
141 .RS +4
142 .TP
143 2.
144 Initializing the Common Library by calling \fBHBA_LoadLibrary()\fR.
145 .RE
146 .RS +4
147 .TP
321 .RE
322 .RS +4
323 .TP
324 .ie t \(bu
325 .el o
326 \fBHBA_RemoveCallback()\fR
327 .RE
328 For Serial Attached HBA
329 .RS +4
330 .TP
331 .ie t \(bu
332 .el o
333 \fBSMHBA_GetSASPhyAttributes()\fR
334 .RE
335 .RS +4
336 .TP
337 .ie t \(bu
338 .el o
339 \fBSMHBA_SendSMPPassThru()\fR
340 .RE
341 For Fibre Channle HBA
342 .RS +4
343 .TP
344 .ie t \(bu
345 .el o
346 \fBSMHBA_GetFCPhyAttributes()\fR
347 .RE
348 .RS +4
349 .TP
350 .ie t \(bu
351 .el o
352 \fBHBA_SendCTPassThruV2()\fR
353 .RE
354 .RS +4
355 .TP
356 .ie t \(bu
357 .el o
358 \fBHBA_SetRNIDMgmtInfo()\fR
359 .RE
360 .RS +4
361 .TP
406 \fBHBA_SendTEST()\fR
407 .RE
408 .RS +4
409 .TP
410 .ie t \(bu
411 .el o
412 \fBHBA_SendECHO()\fR
413 .RE
414 .RE
415 .RS +4
416 .TP
417 7.
418 Close open HBAs by calling \fBHBA_CloseAdapter()\fR.
419 .RE
420 .RS +4
421 .TP
422 8.
423 Unload the library by calling \fBHBA_FreeLibrary()\fR.
424 .RE
425 .SH ATTRIBUTES
426 .sp
427 .LP
428 See \fBattributes\fR(5) for descriptions of the following attributes:
429 .sp
430
431 .sp
432 .TS
433 box;
434 c | c
435 l | l .
436 ATTRIBUTE TYPE ATTRIBUTE VALUE
437 _
438 Interface Stability Committed
439 _
440 MT-Level MT-Safe
441 _
442 Standard T{
443 ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Interface (SM-HBA)
444 T}
445 .TE
446
447 .SH SEE ALSO
448 .sp
449 .LP
450 \fBsmhba.conf\fR(4), \fBattributes\fR(5)
|
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH LIBSMHBAAPI 3LIB "Aug 19, 2019"
7 .SH NAME
8 libSMHBAAPI, libsmhbaapi, SMHBA_GetAdapterAttributes,
9 SMHBA_GetAdapterPortAttributes, SMHBA_GetBindingCapability,
10 SMHBA_GetBindingSupport, SMHBA_GetDiscoveredPortAttributes,
11 SMHBA_GetFCPhyAttributes, SMHBA_GetLUNStatistics, SMHBA_GetNumberofPorts,
12 SMHBA_GetPersistentBinding, SMHBA_GetPhyStatistics,
13 SMHBA_GetPortAttributesByWWN, SMHBA_GetPortType, SMHBA_GetProtocolStatistics,
14 SMHBA_GetSASPhyAttributes, SMHBA_GetTargetMapping,
15 SMHBA_GetVendorLibraryAttributes, SMHBA_GetVersion,
16 SMHBA_GetWrapperLibraryAttributes, SMHBA_RegisterForAdapterAddEvents,
17 SMHBA_RegisterForAdapterEvents, SMHBA_RegisterForAdapterPhyStatEvents,
18 SMHBA_RegisterForAdapterPortEvents, SMHBA_RegisterForAdapterPortStatEvents,
19 SMHBA_RegisterForTargetEvents, SMHBA_RegisterLibrary,
20 SMHBA_RemoveAllPersistentBindings, SMHBA_RemovePersistentBinding,
21 SMHBA_ScsiInquiry, SMHBA_ScsiReadCapacity, SMHBA_ScsiReportLuns,
22 SMHBA_SendECHO, SMHBA_SendSMPPassThru, SMHBA_SendTEST, SMHBA_SetBindingSupport,
23 SMHBA_SetPersistentBinding \- Common Storage Management HBA information library
24 .SH SYNOPSIS
25 .nf
26 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lSMHBAAPI\fR [ \fIlibrary\fR... ]
27 #include <smhbaapi.h>
28 .fi
29
30 .SH DESCRIPTION
31 The functions in this library access Fibre Channel and/or Serial Attached SCSI
32 HBA data depending on vendor provided implementation underneath.
33 .sp
34 .LP
35 HBA information is provided through a standard interface in a vendor
36 independent manner. This common interface provides access to the following
37 information:
38 .RS +4
39 .TP
40 .ie t \(bu
41 .el o
42 Local HBA attributes
43 .RE
44 .RS +4
45 .TP
46 .ie t \(bu
47 .el o
48 Local HBA port attributes and statistics
49 .RE
50 .RS +4
52 .ie t \(bu
53 .el o
54 Mapping between discovered devices and operating system SCSI information
55 .RE
56 .RS +4
57 .TP
58 .ie t \(bu
59 .el o
60 Discovered devices port attributes
61 .RE
62 .RS +4
63 .TP
64 .ie t \(bu
65 .el o
66 SCSI commands for discovered devices (Report LUNS, Read Capacity, and Inquiry)
67 .RE
68 .RS +4
69 .TP
70 .ie t \(bu
71 .el o
72 Storage Management Protocol commands to discover Serial Attached SCSI
73 configuration details
74 .RE
75 .RS +4
76 .TP
77 .ie t \(bu
78 .el o
79 Common Transport commands to discover Fibre Channel Fabric details
80 .RE
81 .SH INTERFACES
82 The shared object \fBlibSMHBAAPI.so.1\fR provides the public interfaces defined
83 below. See \fBIntro\fR(3) for additional information on shared object
84 interfaces.
85 .sp
86
87 .sp
88 .TS
89 l l
90 l l .
91 \fBHBA_CloseAdapter\fR \fBHBA_FreeLibrary\fR
92 \fBHBA_GetAdapterName\fR \fBHBA_GetNumberOfAdapters\fR
93 \fBHBA_GetRNIDMgmtInfo\fR \fBHBA_LoadLibrary\fR
94 \fBHBA_OpenAdapter\fR \fBHBA_RefreshAdapterConfiguration\fR
95 \fBHBA_RefreshInformation\fR \fBHBA_RegisterForLinkEvents\fR
96 \fBHBA_RemoveCallback\fR \fBHBA_SendCTPassThruV2\fR
97 \fBHBA_SendLIRR\fR \fBHBA_SendRLS\fR
98 \fBHBA_SendRNIDV2\fR \fBHBA_SendRPL\fR
99 \fBHBA_SendRPS\fR \fBHBA_SendSRL\fR
100 \fBHBA_SetRNIDMgmtInfo\fR \fBSMHBA_GetAdapterAttributes\fR
101 \fBSMHBA_GetAdapterPortAttributes\fR \fBSMHBA_GetBindingCapability\fR
102 \fBSMHBA_GetBindingSupport\fR \fBSMHBA_GetDiscoveredPortAttributes\fR
103 \fBSMHBA_GetFCPhyAttributes\fR \fBSMHBA_GetLUNStatistics\fR
104 \fBSMHBA_GetNumberofPorts\fR \fBSMHBA_GetPersistentBinding\fR
105 \fBSMHBA_GetPhyStatistics\fR \fBSMHBA_GetPortAttributesByWWN\fR
106 \fBSMHBA_GetPortType\fR \fBSMHBA_GetProtocolStatistics\fR
107 \fBSMHBA_GetSASPhyAttributes\fR \fBSMHBA_GetTargetMapping\fR
108 \fBSMHBA_GetVendorLibraryAttributes\fR \fBSMHBA_GetVersion\fR
109 \fBSMHBA_GetWrapperLibraryAttributes\fR \fBSMHBA_RegisterForAdapterAddEvents\fR
110 \fBSMHBA_RegisterForAdapterEvents\fR \fBSMHBA_RegisterForAdapterPhyStatEvents\fR
111 \fBSMHBA_RegisterForAdapterPortEvents\fR \fBSMHBA_RegisterForAdapterPortStatEvents\fR
112 \fBSMHBA_RegisterForTargetEvents\fR \fBSMHBA_RegisterLibrary\fR
113 \fBSMHBA_RemoveAllPersistentBindings\fR \fBSMHBA_RemovePersistentBinding\fR
114 \fBSMHBA_ScsiInquiry\fR \fBSMHBA_ScsiReadCapacity\fR
115 \fBSMHBA_ScsiReportLuns\fR \fBSMHBA_SendECHO\fR
116 \fBSMHBA_SendSMPPassThru\fR \fBSMHBA_SendTEST\fR
117 \fBSMHBA_SetBindingSupport\fR \fBSMHBA_SetPersistentBinding\fR
118 .TE
119
120 .SH USAGE
121 Client applications link with the Common Library (using -\fBlSMHBAAPI\fR) to
122 access the interfaces. The Common Library dynamically loads individual
123 Vendor-Specific Libraries (VSL) listed in \fB/etc/smhba.conf\fR and described
124 on \fBsmhba.conf\fR(4).
125 .sp
126 .LP
127 Using the \fBlibSMHBAAPI\fR involves the following steps:
128 .RS +4
129 .TP
130 1.
131 Optionally determining the version of the library by calling
132 \fBSMHBA_GetVersion()\fR.
133 .RE
134 .RS +4
135 .TP
136 2.
137 Initializing the Common Library by calling \fBHBA_LoadLibrary()\fR.
138 .RE
139 .RS +4
140 .TP
314 .RE
315 .RS +4
316 .TP
317 .ie t \(bu
318 .el o
319 \fBHBA_RemoveCallback()\fR
320 .RE
321 For Serial Attached HBA
322 .RS +4
323 .TP
324 .ie t \(bu
325 .el o
326 \fBSMHBA_GetSASPhyAttributes()\fR
327 .RE
328 .RS +4
329 .TP
330 .ie t \(bu
331 .el o
332 \fBSMHBA_SendSMPPassThru()\fR
333 .RE
334 For Fibre Channel HBA
335 .RS +4
336 .TP
337 .ie t \(bu
338 .el o
339 \fBSMHBA_GetFCPhyAttributes()\fR
340 .RE
341 .RS +4
342 .TP
343 .ie t \(bu
344 .el o
345 \fBHBA_SendCTPassThruV2()\fR
346 .RE
347 .RS +4
348 .TP
349 .ie t \(bu
350 .el o
351 \fBHBA_SetRNIDMgmtInfo()\fR
352 .RE
353 .RS +4
354 .TP
399 \fBHBA_SendTEST()\fR
400 .RE
401 .RS +4
402 .TP
403 .ie t \(bu
404 .el o
405 \fBHBA_SendECHO()\fR
406 .RE
407 .RE
408 .RS +4
409 .TP
410 7.
411 Close open HBAs by calling \fBHBA_CloseAdapter()\fR.
412 .RE
413 .RS +4
414 .TP
415 8.
416 Unload the library by calling \fBHBA_FreeLibrary()\fR.
417 .RE
418 .SH ATTRIBUTES
419 See \fBattributes\fR(5) for descriptions of the following attributes:
420 .sp
421
422 .sp
423 .TS
424 box;
425 c | c
426 l | l .
427 ATTRIBUTE TYPE ATTRIBUTE VALUE
428 _
429 Interface Stability Committed
430 _
431 MT-Level MT-Safe
432 _
433 Standard T{
434 ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Interface (SM-HBA)
435 T}
436 .TE
437
438 .SH SEE ALSO
439 \fBsmhba.conf\fR(4), \fBattributes\fR(5)
|