Print this page
11583 Some man3lib pages are missing parts of the SYNOPSIS
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3lib/libSMHBAAPI.3lib.man.txt
+++ new/usr/src/man/man3lib/libSMHBAAPI.3lib.man.txt
1 1 LIBSMHBAAPI(3LIB) Interface Libraries LIBSMHBAAPI(3LIB)
2 2
3 3
4 4
5 5 NAME
6 6 libSMHBAAPI, libsmhbaapi, SMHBA_GetAdapterAttributes,
7 7 SMHBA_GetAdapterPortAttributes, SMHBA_GetBindingCapability,
8 8 SMHBA_GetBindingSupport, SMHBA_GetDiscoveredPortAttributes,
9 9 SMHBA_GetFCPhyAttributes, SMHBA_GetLUNStatistics,
10 10 SMHBA_GetNumberofPorts, SMHBA_GetPersistentBinding,
11 11 SMHBA_GetPhyStatistics, SMHBA_GetPortAttributesByWWN,
12 12 SMHBA_GetPortType, SMHBA_GetProtocolStatistics,
13 13 SMHBA_GetSASPhyAttributes, SMHBA_GetTargetMapping,
14 14 SMHBA_GetVendorLibraryAttributes, SMHBA_GetVersion,
15 15 SMHBA_GetWrapperLibraryAttributes, SMHBA_RegisterForAdapterAddEvents,
16 16 SMHBA_RegisterForAdapterEvents, SMHBA_RegisterForAdapterPhyStatEvents,
17 17 SMHBA_RegisterForAdapterPortEvents,
18 18 SMHBA_RegisterForAdapterPortStatEvents, SMHBA_RegisterForTargetEvents,
19 19 SMHBA_RegisterLibrary, SMHBA_RemoveAllPersistentBindings,
20 20 SMHBA_RemovePersistentBinding, SMHBA_ScsiInquiry,
21 21 SMHBA_ScsiReadCapacity, SMHBA_ScsiReportLuns, SMHBA_SendECHO,
22 22 SMHBA_SendSMPPassThru, SMHBA_SendTEST, SMHBA_SetBindingSupport,
23 23 SMHBA_SetPersistentBinding - Common Storage Management HBA information
24 24 library
25 25
26 26 SYNOPSIS
27 27 cc [ flag... ] file... -lSMHBAAPI [ library... ]
28 28 #include <smhbaapi.h>
29 29
30 30
31 31 DESCRIPTION
32 32 The functions in this library access Fibre Channel and/or Serial
33 33 Attached SCSI HBA data depending on vendor provided implementation
34 34 underneath.
35 35
36 36
37 37 HBA information is provided through a standard interface in a vendor
38 38 independent manner. This common interface provides access to the
39 39 following information:
40 40
41 41 o Local HBA attributes
42 42
|
↓ open down ↓ |
42 lines elided |
↑ open up ↑ |
43 43 o Local HBA port attributes and statistics
44 44
45 45 o Mapping between discovered devices and operating system SCSI
46 46 information
47 47
48 48 o Discovered devices port attributes
49 49
50 50 o SCSI commands for discovered devices (Report LUNS, Read
51 51 Capacity, and Inquiry)
52 52
53 - o Storage Managment Protocol commands to discover Serial
53 + o Storage Management Protocol commands to discover Serial
54 54 Attached SCSI configuration details
55 55
56 56 o Common Transport commands to discover Fibre Channel Fabric
57 57 details
58 58
59 59 INTERFACES
60 60 The shared object libSMHBAAPI.so.1 provides the public interfaces
61 61 defined below. See Intro(3) for additional information on shared object
62 62 interfaces.
63 63
64 64
65 65
66 66
67 67 HBA_CloseAdapter HBA_FreeLibrary
68 68 HBA_GetAdapterName HBA_GetNumberOfAdapters
69 69 HBA_GetRNIDMgmtInfo HBA_LoadLibrary
70 70 HBA_OpenAdapter HBA_RefreshAdapterConfiguration
71 71 HBA_RefreshInformation HBA_RegisterForLinkEvents
72 72 HBA_RemoveCallback HBA_SendCTPassThruV2
73 73 HBA_SendLIRR HBA_SendRLS
74 74 HBA_SendRNIDV2 HBA_SendRPL
75 75 HBA_SendRPS HBA_SendSRL
76 76 HBA_SetRNIDMgmtInfo SMHBA_GetAdapterAttributes
77 77 SMHBA_GetAdapterPortAttributes SMHBA_GetBindingCapability
78 78 SMHBA_GetBindingSupport SMHBA_GetDiscoveredPortAttributes
79 79 SMHBA_GetFCPhyAttributes SMHBA_GetLUNStatistics
80 80 SMHBA_GetNumberofPorts SMHBA_GetPersistentBinding
81 81 SMHBA_GetPhyStatistics SMHBA_GetPortAttributesByWWN
82 82 SMHBA_GetPortType SMHBA_GetProtocolStatistics
83 83 SMHBA_GetSASPhyAttributes SMHBA_GetTargetMapping
84 84 SMHBA_GetVendorLibraryAttributes SMHBA_GetVersion
85 85 SMHBA_GetWrapperLibraryAttributes SMHBA_RegisterForAdapterAddEvents
86 86 SMHBA_RegisterForAdapterEvents SMHBA_RegisterForAdapterPhyStatEvents
87 87 SMHBA_RegisterForAdapterPortEvents SMHBA_RegisterForAdapterPortStatEvents
88 88 SMHBA_RegisterForTargetEvents SMHBA_RegisterLibrary
89 89 SMHBA_RemoveAllPersistentBindings SMHBA_RemovePersistentBinding
90 90 SMHBA_ScsiInquiry SMHBA_ScsiReadCapacity
91 91 SMHBA_ScsiReportLuns SMHBA_SendECHO
92 92 SMHBA_SendSMPPassThru SMHBA_SendTEST
93 93 SMHBA_SetBindingSupport SMHBA_SetPersistentBinding
94 94
95 95
96 96 USAGE
97 97 Client applications link with the Common Library (using -lSMHBAAPI) to
98 98 access the interfaces. The Common Library dynamically loads individual
99 99 Vendor-Specific Libraries (VSL) listed in /etc/smhba.conf and described
100 100 on smhba.conf(4).
101 101
102 102
103 103 Using the libSMHBAAPI involves the following steps:
104 104
105 105 1. Optionally determining the version of the library by calling
106 106 SMHBA_GetVersion().
107 107
108 108 2. Initializing the Common Library by calling
109 109 HBA_LoadLibrary().
110 110
111 111 3. Determine the number of HBAs known to the common library by
112 112 calling HBA_GetNumberOfAdapters().
113 113
114 114 4. Determine each HBA name in turn by calling
115 115 HBA_GetAdapterName().
116 116
117 117 5. Open each HBA in turn by calling HBA_OpenAdapter().
118 118
119 119 6. Operate on a given HBA by calling the following:
120 120
121 121 o SMHBA_GetAdapterAttributes()
122 122
123 123 o SMHBA_GetAdapterPortAttributes()
124 124
125 125 o SMHBA_GetDiscoveredPortAttributes()
126 126
127 127 o SMHBA_GetPortAttributesByWWN()
128 128
129 129 o SMHBA_GetNumberofPorts()
130 130
131 131 o SMHBA_GetPortType()
132 132
133 133 o SMHBA_GetProtocolStatistics()
134 134
135 135 o SMHBA_GetPhyStatistics()
136 136
137 137 o SMHBA_GetBindingCapability()
138 138
139 139 o SMHBA_GetBindingSupport()
140 140
141 141 o SMHBA_SetBindingSupport()
142 142
143 143 o SMHBA_GetTargetMapping()
144 144
145 145 o SMHBA_GetPersistentBinding()
146 146
147 147 o SMHBA_SetPersistentBinding()
148 148
149 149 o SMHBA_RemoveAllPersistentBindings()
150 150
151 151 o SMHBA_GetLUNStatistics()
152 152
153 153 o SMHBA_SendScsiInquiry()
154 154
155 155 o SMHBA_SendReportLuns()
156 156
157 157 o SMHBA_SendReadCapacity()
158 158
159 159 o SMHBA_RegisterForAdapterAddEvents()
160 160
161 161 o SMHBA_RegisterForAdapterEvents()
162 162
163 163 o SMHBA_RegisterForAdapterPortEvents()
164 164
165 165 o SMHBA_RegisterForAdapterPortStatEvents()
166 166
167 167 o SMHBA_RegisterForAdapterPhyStatEvents()
168 168
|
↓ open down ↓ |
105 lines elided |
↑ open up ↑ |
169 169 o SMHBA_RegisterForTargetEvents()
170 170
171 171 o HBA_RegisterForLinkEvents()
172 172
173 173 o HBA_RemoveCallback()
174 174 For Serial Attached HBA
175 175
176 176 o SMHBA_GetSASPhyAttributes()
177 177
178 178 o SMHBA_SendSMPPassThru()
179 - For Fibre Channle HBA
179 + For Fibre Channel HBA
180 180
181 181 o SMHBA_GetFCPhyAttributes()
182 182
183 183 o HBA_SendCTPassThruV2()
184 184
185 185 o HBA_SetRNIDMgmtInfo()
186 186
187 187 o HBA_GetRNIDMgmtInfo()
188 188
189 189 o HBA_SendRNIDV2()
190 190
191 191 o HBA_SendRPL()
192 192
193 193 o HBA_SendRPS()
194 194
195 195 o HBA_SendSRL()
196 196
197 197 o HBA_SendLIRR()
198 198
199 199 o HBA_SendRLS()
200 200
201 201 o HBA_SendTEST()
202 202
203 203 o HBA_SendECHO()
204 204
205 205 7. Close open HBAs by calling HBA_CloseAdapter().
206 206
207 207 8. Unload the library by calling HBA_FreeLibrary().
208 208
209 209 ATTRIBUTES
210 210 See attributes(5) for descriptions of the following attributes:
211 211
212 212
213 213
214 214
215 215 +--------------------+-------------------------+
216 216 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
217 217 +--------------------+-------------------------+
218 218 |Interface Stability | Committed |
219 219 +--------------------+-------------------------+
220 220 |MT-Level | MT-Safe |
221 221 +--------------------+-------------------------+
222 222 |Standard | ANSI INCITS 428 |
223 223 | | Storage Management Host |
|
↓ open down ↓ |
34 lines elided |
↑ open up ↑ |
224 224 | | Bus Adapter Application |
225 225 | | Programming Interface |
226 226 | | (SM-HBA) |
227 227 +--------------------+-------------------------+
228 228
229 229 SEE ALSO
230 230 smhba.conf(4), attributes(5)
231 231
232 232
233 233
234 - September 28, 2009 LIBSMHBAAPI(3LIB)
234 + August 19, 2019 LIBSMHBAAPI(3LIB)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX