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
+++ new/usr/src/man/man3lib/libSMHBAAPI.3lib
1 1 '\" te
2 2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
3 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 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 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"
6 +.TH LIBSMHBAAPI 3LIB "Aug 19, 2019"
7 7 .SH NAME
8 8 libSMHBAAPI, libsmhbaapi, SMHBA_GetAdapterAttributes,
9 9 SMHBA_GetAdapterPortAttributes, SMHBA_GetBindingCapability,
10 10 SMHBA_GetBindingSupport, SMHBA_GetDiscoveredPortAttributes,
11 11 SMHBA_GetFCPhyAttributes, SMHBA_GetLUNStatistics, SMHBA_GetNumberofPorts,
12 12 SMHBA_GetPersistentBinding, SMHBA_GetPhyStatistics,
13 13 SMHBA_GetPortAttributesByWWN, SMHBA_GetPortType, SMHBA_GetProtocolStatistics,
14 14 SMHBA_GetSASPhyAttributes, SMHBA_GetTargetMapping,
15 15 SMHBA_GetVendorLibraryAttributes, SMHBA_GetVersion,
16 16 SMHBA_GetWrapperLibraryAttributes, SMHBA_RegisterForAdapterAddEvents,
17 17 SMHBA_RegisterForAdapterEvents, SMHBA_RegisterForAdapterPhyStatEvents,
18 18 SMHBA_RegisterForAdapterPortEvents, SMHBA_RegisterForAdapterPortStatEvents,
19 19 SMHBA_RegisterForTargetEvents, SMHBA_RegisterLibrary,
20 20 SMHBA_RemoveAllPersistentBindings, SMHBA_RemovePersistentBinding,
21 21 SMHBA_ScsiInquiry, SMHBA_ScsiReadCapacity, SMHBA_ScsiReportLuns,
22 22 SMHBA_SendECHO, SMHBA_SendSMPPassThru, SMHBA_SendTEST, SMHBA_SetBindingSupport,
23 23 SMHBA_SetPersistentBinding \- Common Storage Management HBA information library
24 24 .SH SYNOPSIS
25 -.LP
26 25 .nf
27 -cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lSMHBAAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
26 +cc [ \fIflag\fR... ] \fIfile\fR... \fB-lSMHBAAPI\fR [ \fIlibrary\fR... ]
28 27 #include <smhbaapi.h>
29 28 .fi
30 29
31 30 .SH DESCRIPTION
32 -.sp
33 -.LP
34 31 The functions in this library access Fibre Channel and/or Serial Attached SCSI
35 32 HBA data depending on vendor provided implementation underneath.
36 33 .sp
37 34 .LP
38 35 HBA information is provided through a standard interface in a vendor
39 36 independent manner. This common interface provides access to the following
40 37 information:
41 38 .RS +4
42 39 .TP
43 40 .ie t \(bu
44 41 .el o
45 42 Local HBA attributes
46 43 .RE
47 44 .RS +4
48 45 .TP
49 46 .ie t \(bu
50 47 .el o
51 48 Local HBA port attributes and statistics
52 49 .RE
53 50 .RS +4
54 51 .TP
55 52 .ie t \(bu
56 53 .el o
57 54 Mapping between discovered devices and operating system SCSI information
58 55 .RE
59 56 .RS +4
60 57 .TP
61 58 .ie t \(bu
62 59 .el o
63 60 Discovered devices port attributes
64 61 .RE
|
↓ open down ↓ |
21 lines elided |
↑ open up ↑ |
65 62 .RS +4
66 63 .TP
67 64 .ie t \(bu
68 65 .el o
69 66 SCSI commands for discovered devices (Report LUNS, Read Capacity, and Inquiry)
70 67 .RE
71 68 .RS +4
72 69 .TP
73 70 .ie t \(bu
74 71 .el o
75 -Storage Managment Protocol commands to discover Serial Attached SCSI
72 +Storage Management Protocol commands to discover Serial Attached SCSI
76 73 configuration details
77 74 .RE
78 75 .RS +4
79 76 .TP
80 77 .ie t \(bu
81 78 .el o
82 79 Common Transport commands to discover Fibre Channel Fabric details
83 80 .RE
84 81 .SH INTERFACES
85 -.sp
86 -.LP
87 82 The shared object \fBlibSMHBAAPI.so.1\fR provides the public interfaces defined
88 83 below. See \fBIntro\fR(3) for additional information on shared object
89 84 interfaces.
90 85 .sp
91 86
92 87 .sp
93 88 .TS
94 89 l l
95 90 l l .
96 91 \fBHBA_CloseAdapter\fR \fBHBA_FreeLibrary\fR
97 92 \fBHBA_GetAdapterName\fR \fBHBA_GetNumberOfAdapters\fR
98 93 \fBHBA_GetRNIDMgmtInfo\fR \fBHBA_LoadLibrary\fR
99 94 \fBHBA_OpenAdapter\fR \fBHBA_RefreshAdapterConfiguration\fR
100 95 \fBHBA_RefreshInformation\fR \fBHBA_RegisterForLinkEvents\fR
101 96 \fBHBA_RemoveCallback\fR \fBHBA_SendCTPassThruV2\fR
102 97 \fBHBA_SendLIRR\fR \fBHBA_SendRLS\fR
103 98 \fBHBA_SendRNIDV2\fR \fBHBA_SendRPL\fR
104 99 \fBHBA_SendRPS\fR \fBHBA_SendSRL\fR
105 100 \fBHBA_SetRNIDMgmtInfo\fR \fBSMHBA_GetAdapterAttributes\fR
106 101 \fBSMHBA_GetAdapterPortAttributes\fR \fBSMHBA_GetBindingCapability\fR
107 102 \fBSMHBA_GetBindingSupport\fR \fBSMHBA_GetDiscoveredPortAttributes\fR
108 103 \fBSMHBA_GetFCPhyAttributes\fR \fBSMHBA_GetLUNStatistics\fR
109 104 \fBSMHBA_GetNumberofPorts\fR \fBSMHBA_GetPersistentBinding\fR
110 105 \fBSMHBA_GetPhyStatistics\fR \fBSMHBA_GetPortAttributesByWWN\fR
111 106 \fBSMHBA_GetPortType\fR \fBSMHBA_GetProtocolStatistics\fR
112 107 \fBSMHBA_GetSASPhyAttributes\fR \fBSMHBA_GetTargetMapping\fR
113 108 \fBSMHBA_GetVendorLibraryAttributes\fR \fBSMHBA_GetVersion\fR
114 109 \fBSMHBA_GetWrapperLibraryAttributes\fR \fBSMHBA_RegisterForAdapterAddEvents\fR
115 110 \fBSMHBA_RegisterForAdapterEvents\fR \fBSMHBA_RegisterForAdapterPhyStatEvents\fR
|
↓ open down ↓ |
19 lines elided |
↑ open up ↑ |
116 111 \fBSMHBA_RegisterForAdapterPortEvents\fR \fBSMHBA_RegisterForAdapterPortStatEvents\fR
117 112 \fBSMHBA_RegisterForTargetEvents\fR \fBSMHBA_RegisterLibrary\fR
118 113 \fBSMHBA_RemoveAllPersistentBindings\fR \fBSMHBA_RemovePersistentBinding\fR
119 114 \fBSMHBA_ScsiInquiry\fR \fBSMHBA_ScsiReadCapacity\fR
120 115 \fBSMHBA_ScsiReportLuns\fR \fBSMHBA_SendECHO\fR
121 116 \fBSMHBA_SendSMPPassThru\fR \fBSMHBA_SendTEST\fR
122 117 \fBSMHBA_SetBindingSupport\fR \fBSMHBA_SetPersistentBinding\fR
123 118 .TE
124 119
125 120 .SH USAGE
126 -.sp
127 -.LP
128 121 Client applications link with the Common Library (using -\fBlSMHBAAPI\fR) to
129 122 access the interfaces. The Common Library dynamically loads individual
130 123 Vendor-Specific Libraries (VSL) listed in \fB/etc/smhba.conf\fR and described
131 124 on \fBsmhba.conf\fR(4).
132 125 .sp
133 126 .LP
134 127 Using the \fBlibSMHBAAPI\fR involves the following steps:
135 128 .RS +4
136 129 .TP
137 130 1.
138 131 Optionally determining the version of the library by calling
139 132 \fBSMHBA_GetVersion()\fR.
140 133 .RE
141 134 .RS +4
142 135 .TP
143 136 2.
144 137 Initializing the Common Library by calling \fBHBA_LoadLibrary()\fR.
145 138 .RE
146 139 .RS +4
147 140 .TP
148 141 3.
149 142 Determine the number of HBAs known to the common library by calling
150 143 \fBHBA_GetNumberOfAdapters()\fR.
151 144 .RE
152 145 .RS +4
153 146 .TP
154 147 4.
155 148 Determine each HBA name in turn by calling \fBHBA_GetAdapterName()\fR.
156 149 .RE
157 150 .RS +4
158 151 .TP
159 152 5.
160 153 Open each HBA in turn by calling \fBHBA_OpenAdapter()\fR.
161 154 .RE
162 155 .RS +4
163 156 .TP
164 157 6.
165 158 Operate on a given HBA by calling the following:
166 159 .RS +4
167 160 .TP
168 161 .ie t \(bu
169 162 .el o
170 163 \fBSMHBA_GetAdapterAttributes()\fR
171 164 .RE
172 165 .RS +4
173 166 .TP
174 167 .ie t \(bu
175 168 .el o
176 169 \fBSMHBA_GetAdapterPortAttributes()\fR
177 170 .RE
178 171 .RS +4
179 172 .TP
180 173 .ie t \(bu
181 174 .el o
182 175 \fBSMHBA_GetDiscoveredPortAttributes()\fR
183 176 .RE
184 177 .RS +4
185 178 .TP
186 179 .ie t \(bu
187 180 .el o
188 181 \fBSMHBA_GetPortAttributesByWWN()\fR
189 182 .RE
190 183 .RS +4
191 184 .TP
192 185 .ie t \(bu
193 186 .el o
194 187 \fBSMHBA_GetNumberofPorts()\fR
195 188 .RE
196 189 .RS +4
197 190 .TP
198 191 .ie t \(bu
199 192 .el o
200 193 \fBSMHBA_GetPortType()\fR
201 194 .RE
202 195 .RS +4
203 196 .TP
204 197 .ie t \(bu
205 198 .el o
206 199 \fBSMHBA_GetProtocolStatistics()\fR
207 200 .RE
208 201 .RS +4
209 202 .TP
210 203 .ie t \(bu
211 204 .el o
212 205 \fBSMHBA_GetPhyStatistics()\fR
213 206 .RE
214 207 .RS +4
215 208 .TP
216 209 .ie t \(bu
217 210 .el o
218 211 \fBSMHBA_GetBindingCapability()\fR
219 212 .RE
220 213 .RS +4
221 214 .TP
222 215 .ie t \(bu
223 216 .el o
224 217 \fBSMHBA_GetBindingSupport()\fR
225 218 .RE
226 219 .RS +4
227 220 .TP
228 221 .ie t \(bu
229 222 .el o
230 223 \fBSMHBA_SetBindingSupport()\fR
231 224 .RE
232 225 .RS +4
233 226 .TP
234 227 .ie t \(bu
235 228 .el o
236 229 \fBSMHBA_GetTargetMapping()\fR
237 230 .RE
238 231 .RS +4
239 232 .TP
240 233 .ie t \(bu
241 234 .el o
242 235 \fBSMHBA_GetPersistentBinding()\fR
243 236 .RE
244 237 .RS +4
245 238 .TP
246 239 .ie t \(bu
247 240 .el o
248 241 \fBSMHBA_SetPersistentBinding()\fR
249 242 .RE
250 243 .RS +4
251 244 .TP
252 245 .ie t \(bu
253 246 .el o
254 247 \fBSMHBA_RemoveAllPersistentBindings()\fR
255 248 .RE
256 249 .RS +4
257 250 .TP
258 251 .ie t \(bu
259 252 .el o
260 253 \fBSMHBA_GetLUNStatistics()\fR
261 254 .RE
262 255 .RS +4
263 256 .TP
264 257 .ie t \(bu
265 258 .el o
266 259 \fBSMHBA_SendScsiInquiry()\fR
267 260 .RE
268 261 .RS +4
269 262 .TP
270 263 .ie t \(bu
271 264 .el o
272 265 \fBSMHBA_SendReportLuns()\fR
273 266 .RE
274 267 .RS +4
275 268 .TP
276 269 .ie t \(bu
277 270 .el o
278 271 \fBSMHBA_SendReadCapacity()\fR
279 272 .RE
280 273 .RS +4
281 274 .TP
282 275 .ie t \(bu
283 276 .el o
284 277 \fBSMHBA_RegisterForAdapterAddEvents()\fR
285 278 .RE
286 279 .RS +4
287 280 .TP
288 281 .ie t \(bu
289 282 .el o
290 283 \fBSMHBA_RegisterForAdapterEvents()\fR
291 284 .RE
292 285 .RS +4
293 286 .TP
294 287 .ie t \(bu
295 288 .el o
296 289 \fBSMHBA_RegisterForAdapterPortEvents()\fR
297 290 .RE
298 291 .RS +4
299 292 .TP
300 293 .ie t \(bu
301 294 .el o
302 295 \fBSMHBA_RegisterForAdapterPortStatEvents()\fR
303 296 .RE
304 297 .RS +4
305 298 .TP
306 299 .ie t \(bu
307 300 .el o
308 301 \fBSMHBA_RegisterForAdapterPhyStatEvents()\fR
309 302 .RE
310 303 .RS +4
311 304 .TP
312 305 .ie t \(bu
313 306 .el o
314 307 \fBSMHBA_RegisterForTargetEvents()\fR
315 308 .RE
316 309 .RS +4
317 310 .TP
318 311 .ie t \(bu
319 312 .el o
320 313 \fBHBA_RegisterForLinkEvents()\fR
321 314 .RE
322 315 .RS +4
323 316 .TP
324 317 .ie t \(bu
325 318 .el o
326 319 \fBHBA_RemoveCallback()\fR
327 320 .RE
328 321 For Serial Attached HBA
329 322 .RS +4
330 323 .TP
|
↓ open down ↓ |
193 lines elided |
↑ open up ↑ |
331 324 .ie t \(bu
332 325 .el o
333 326 \fBSMHBA_GetSASPhyAttributes()\fR
334 327 .RE
335 328 .RS +4
336 329 .TP
337 330 .ie t \(bu
338 331 .el o
339 332 \fBSMHBA_SendSMPPassThru()\fR
340 333 .RE
341 -For Fibre Channle HBA
334 +For Fibre Channel HBA
342 335 .RS +4
343 336 .TP
344 337 .ie t \(bu
345 338 .el o
346 339 \fBSMHBA_GetFCPhyAttributes()\fR
347 340 .RE
348 341 .RS +4
349 342 .TP
350 343 .ie t \(bu
351 344 .el o
352 345 \fBHBA_SendCTPassThruV2()\fR
353 346 .RE
354 347 .RS +4
355 348 .TP
356 349 .ie t \(bu
357 350 .el o
358 351 \fBHBA_SetRNIDMgmtInfo()\fR
359 352 .RE
360 353 .RS +4
361 354 .TP
362 355 .ie t \(bu
363 356 .el o
364 357 \fBHBA_GetRNIDMgmtInfo()\fR
365 358 .RE
366 359 .RS +4
367 360 .TP
368 361 .ie t \(bu
369 362 .el o
370 363 \fBHBA_SendRNIDV2()\fR
371 364 .RE
372 365 .RS +4
373 366 .TP
374 367 .ie t \(bu
375 368 .el o
376 369 \fBHBA_SendRPL()\fR
377 370 .RE
378 371 .RS +4
379 372 .TP
380 373 .ie t \(bu
381 374 .el o
382 375 \fBHBA_SendRPS()\fR
383 376 .RE
384 377 .RS +4
385 378 .TP
386 379 .ie t \(bu
387 380 .el o
388 381 \fBHBA_SendSRL()\fR
389 382 .RE
390 383 .RS +4
391 384 .TP
392 385 .ie t \(bu
393 386 .el o
394 387 \fBHBA_SendLIRR()\fR
395 388 .RE
396 389 .RS +4
397 390 .TP
398 391 .ie t \(bu
399 392 .el o
400 393 \fBHBA_SendRLS()\fR
401 394 .RE
402 395 .RS +4
403 396 .TP
404 397 .ie t \(bu
405 398 .el o
406 399 \fBHBA_SendTEST()\fR
407 400 .RE
408 401 .RS +4
409 402 .TP
410 403 .ie t \(bu
411 404 .el o
412 405 \fBHBA_SendECHO()\fR
413 406 .RE
414 407 .RE
415 408 .RS +4
|
↓ open down ↓ |
64 lines elided |
↑ open up ↑ |
416 409 .TP
417 410 7.
418 411 Close open HBAs by calling \fBHBA_CloseAdapter()\fR.
419 412 .RE
420 413 .RS +4
421 414 .TP
422 415 8.
423 416 Unload the library by calling \fBHBA_FreeLibrary()\fR.
424 417 .RE
425 418 .SH ATTRIBUTES
426 -.sp
427 -.LP
428 419 See \fBattributes\fR(5) for descriptions of the following attributes:
429 420 .sp
430 421
431 422 .sp
432 423 .TS
433 424 box;
434 425 c | c
435 426 l | l .
436 427 ATTRIBUTE TYPE ATTRIBUTE VALUE
437 428 _
438 429 Interface Stability Committed
439 430 _
440 431 MT-Level MT-Safe
441 432 _
442 433 Standard T{
443 434 ANSI INCITS 428 Storage Management Host Bus Adapter Application Programming Interface (SM-HBA)
444 435 T}
445 436 .TE
446 437
447 438 .SH SEE ALSO
448 -.sp
449 -.LP
450 439 \fBsmhba.conf\fR(4), \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX