Package list ibutils / f8fbb7c
Fix POD errors Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com> Benjamin Drung 1 year, 7 months ago
3 changed file(s) with 1813 addition(s) and 2 deletion(s). Raw diff Collapse all Expand all
0 From 0a63dd31e4c612ae222a3c8fed65c9c12ac3839d Mon Sep 17 00:00:00 2001
1 From: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2 Date: Wed, 11 Nov 2020 13:03:59 +0100
3 Subject: Fix POD errors
4
5 Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
6 ---
7 ibdiag/doc/ibdiagui.pod | 7 +-
8 ibdm/doc/ibdm-ibnl-file.pod | 15 +-
9 ibdm/doc/ibdm-topo-file.pod | 4 +-
10 ibdm/doc/ibdmchk.pod | 16 ++
11 ibdm/doc/ibdmsh.pod | 42 +++-
12 ibdm/doc/ibdmtr.pod | 39 ++--
13 ibdm/doc/ibtopodiff.pod | 8 +
14 ibis/doc/ibis.pod | 374 +++++++++++++++++++++++++++---------
15 8 files changed, 376 insertions(+), 129 deletions(-)
16
17 diff --git a/ibdiag/doc/ibdiagui.pod b/ibdiag/doc/ibdiagui.pod
18 index 86a2df9..6c21394 100644
19 --- a/ibdiag/doc/ibdiagui.pod
20 +++ b/ibdiag/doc/ibdiagui.pod
21 @@ -12,8 +12,8 @@ ibdiagui [-c <count>] [-v] [-r] [-u] [-o <out-dir>]
22
23 =head1 DESCRIPTION
24
25 - ibdiagui is a GUI wrapper for ibdiagnet.
26 - Its main features:
27 +ibdiagui is a GUI wrapper for ibdiagnet.
28 +Its main features:
29
30 =over
31
32 @@ -27,5 +27,8 @@ ibdiagui [-c <count>] [-v] [-r] [-u] [-o <out-dir>]
33
34 =head1 OPTIONS
35
36 +=over
37 +
38 =item ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list.
39
40 +=back
41 diff --git a/ibdm/doc/ibdm-ibnl-file.pod b/ibdm/doc/ibdm-ibnl-file.pod
42 index ffdd560..219154e 100644
43 --- a/ibdm/doc/ibdm-ibnl-file.pod
44 +++ b/ibdm/doc/ibdm-ibnl-file.pod
45 @@ -34,7 +34,7 @@ The top most system defined in the given file
46
47 Many systems allow multiple variations of their subsystem such as a 12X version of a leaf board in a MTS9600. The modifier is a suffix to the board name. The IBNL format supports assigning multiple names to the same board.
48
49 -=back 4
50 +=back
51
52 =head1 2. File Format
53
54 @@ -50,7 +50,7 @@ Connections are defined inside the SYSTEM/TOPSYSTEM section only and thus might
55
56 =item 2. From any node or sub-system to a connector of the system.
57
58 -=back 4
59 +=back
60
61
62 NOTE-1: The top system can define ports that might be redundant and not connected to any lower level board connector. In these cases the ports are simply omitted from the resulting system. This feature enables defining the front panel ports of a 12X/4X such that if a 12X leaf is selected only the 12X front panel ports are used.
63 @@ -93,6 +93,7 @@ SYSTEM LEAF:12x,LEAF:12X
64
65 ...
66
67 +=back
68
69 NOTE-3: The instantiations of the LEAF boards in another board or the top system need not specify the postfix and are being decided upon only when the topology file is being parsed. The "SYSTEM LEAF" with no postfix will be used by default. To continue the example here is how the LEAFs are instantiated in the top system:
70
71 @@ -108,7 +109,7 @@ LEAF leaf2
72
73 ...
74
75 -=back 4
76 +=back
77
78 The actual 4x or 12x version of the LEAF board can then be specified in the topology file CFG section to select the right combination of optional boards in the system. An example will be:
79
80 @@ -116,6 +117,8 @@ The actual 4x or 12x version of the LEAF board can then be specified in the topo
81
82 MyIbSystem N001 CFG: leaf2=12x
83
84 +=back
85 +
86 In this case leaf1 will be 4x as no special modifier is defined for it (and LEAF is by default a 4x leaf). Leaf2 will be 12x as defined in the CFG section.
87
88 =item e)
89 @@ -158,9 +161,7 @@ SUBSYSTEM LEAF leaf1
90
91 12XP1 -> L1/P1-12x
92
93 -=back 4
94 -
95 -=over 4
96 +=back
97
98 =item f)
99
100 @@ -171,6 +172,8 @@ Place the file in the <prefix>/lib/IBDM/ibdm1.0/ibnl directory
101
102 Check the new file syntax by placing it in the ibnl directory as described above, creating a simple topology (B<ibdm-topo-file> file with one such system and running B<ibdmtr> utility to parse it tracing a simple path through it.
103
104 +=back
105 +
106 =head1 4. Formal definition in YACC Syntax:
107
108 INT ::= ([1-9][0-9]*|0) ;
109 diff --git a/ibdm/doc/ibdm-topo-file.pod b/ibdm/doc/ibdm-topo-file.pod
110 index af89afc..7deba46 100644
111 --- a/ibdm/doc/ibdm-topo-file.pod
112 +++ b/ibdm/doc/ibdm-topo-file.pod
113 @@ -11,7 +11,7 @@ It serves two purposes:
114
115 =item 2. Connectivity verification: The specified network topology is verified against the discovered one. Mismatch errors resulting from missing cables and/or wrong connections are reported by IBADM.
116
117 -=back 4
118 +=back
119
120 The topology file is composed "system" sections. Each such section describes the connectivity of one system to other systems in the network. The first line of each section is a declaration of the system composed of a system-type, its system-name section, and optional configuration details. The lines to follow until the next empty line describe the connections between this system ports to the other systems. The following is a formal definition of a system section syntax.
121
122 @@ -62,7 +62,7 @@ The name of the system connected to the local port.
123
124 A name of the remote system port. We use the numbers as printed on the front panel and Ln for Leaf number N or Sn for Spine number N.
125
126 -=back 4
127 +=back
128
129 =head1 EXAMPLE
130
131 diff --git a/ibdm/doc/ibdmchk.pod b/ibdm/doc/ibdmchk.pod
132 index dabfafa..a66dce0 100644
133 --- a/ibdm/doc/ibdmchk.pod
134 +++ b/ibdm/doc/ibdmchk.pod
135 @@ -24,6 +24,8 @@ The Design mode is intended to be used before the cluster is built. It provides
136
137 =head1 ARGUMENTS:
138
139 +=over
140 +
141 =item -t|--topo <topo file>
142
143 The B<topology file> specifying the network. See man B<ibdm-topology-file>
144 @@ -36,8 +38,12 @@ The name of the Subnet Manager node (syntax: <Topo-File-System>/U1)
145
146 The port number by which the SM nodes is attached to the fabric.
147
148 +=back
149 +
150 =head1 OPTIONS
151
152 +=over
153 +
154 =item -v|--verbose
155
156 Verbsoe mode
157 @@ -57,6 +63,8 @@ Use enhanced routing algorithm when LMC > 0 and report the resulting paths corre
158 =item -r|--roots <roots file>
159 A file with all the roots node names (one on each line).
160
161 +=back
162 +
163 =head1 VERIFICATION MODE DESCRIPTION
164
165 After the cluster is built and OpenSM is run (using flag -D 0x43) it reports the subnet and FDB tables into the files osm-subnet.lst, osm.fdbs and osm.fdbs in /var/log/ (or subnet.lst, osm.fdbs and osm.mcfdbs into /tmp in older OpenSM versions). ibdiagnet is also producing the same files in its output directory.
166 @@ -65,12 +73,18 @@ In case of an LMC > 0 it reports histograms for how many systems and nodes are c
167
168 =head1 ARGUMENTS
169
170 +=over
171 +
172 =item -l|--lmc <lmc>
173
174 The LMC value used while running OpenSM. Mandatory if not the default 0.
175
176 +=back
177 +
178 =head1 OPTIONS
179
180 +=over
181 +
182 =item -v|--verbose
183
184 Verbsoe mode
185 @@ -120,6 +134,8 @@ Include multicast routing in credit loops analysis.
186 Verify not only CA-CA paths but also SW-SW, CA-SW and SW-CA.
187 Both check for FDB path connectivity and also for credit loops.
188
189 +=back
190 +
191 =head1 AUTHOR
192
193 Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
194 diff --git a/ibdm/doc/ibdmsh.pod b/ibdm/doc/ibdmsh.pod
195 index 3892143..599a5ad 100644
196 --- a/ibdm/doc/ibdmsh.pod
197 +++ b/ibdm/doc/ibdmsh.pod
198 @@ -23,7 +23,7 @@ The following constants are used by the node object type field
199
200 [ Constant : int ] $IB_CA_NODE = IB_CA_NODE
201
202 -=back 4
203 +=back
204
205 =head2 Log Verbosity Flags
206
207 @@ -39,7 +39,7 @@ The following constants are used as argument bits for the global variable $Fabri
208
209 [ Constant : int ] $FABU_LOG_VERBOSE = 0x4
210
211 -=back 4
212 +=back
213
214 =head1 IBDM Globals
215
216 @@ -49,7 +49,7 @@ Log level: set to FABU_LOG* values
217
218 [ Global : int ] $FabricUtilsVerboseLevel
219
220 -=back 4
221 +=back
222
223 =head1 IBDM Objects
224
225 @@ -102,6 +102,8 @@ B<Objects:>
226
227 The following are the different fields and methods of the IB Port class which describes an IB device (chip) physical port.
228
229 +=over
230 +
231 =item [ Member data: returns IBPort * ] -p_remotePort
232
233 Port connected on the other side of link
234 @@ -158,10 +160,14 @@ Connect the port to another node port with optional width and speed parameters
235
236 Disconnect the port. Return 0 if successful
237
238 +=back
239 +
240 =head2 class IBNode
241
242 The IB Node class represents a single IB Device (chip)
243
244 +=over
245 +
246 =item [ Member data: returns string * ] -name
247
248 Name of the node (instance name of the chip)
249 @@ -258,10 +264,14 @@ Get the LFT for a given LID
250
251 Dump out the min hop table of the node
252
253 +=back
254 +
255 =head2 class IBSysPort
256
257 The IBSysPort class represents an IB plug on the system front or back pannels
258
259 +=over
260 +
261 =item [ Member data: returns string * ] -name
262
263 The front pannel name (silk) of the port
264 @@ -290,10 +300,14 @@ Connect two SysPorts
265
266 Disconnect the SysPort (and ports). Return 0 if successful
267
268 +=back
269 +
270 =head2 class IBSystem
271
272 The IBSystem class represents an entire chassis
273
274 +=over
275 +
276 =item [ Member data: returns string * ] -name
277
278 The "host" name of the system
279 @@ -338,10 +352,14 @@ Get the node port for the given sys port by name
280
281 Get a Sys Port by name
282
283 +=back
284 +
285 =head2 class IBFabric
286
287 Represents an entire IB subnet made of systems
288
289 +=over
290 +
291 =item [ Member data: returns map_str_pnode * ] -NodeByName
292
293 Provide a list of node name and pointer pairs
294 @@ -470,6 +488,8 @@ Construct a new fabric
295
296 Destruct a fabric
297
298 +=back
299 +
300 =head1 IBDM Functions
301
302 This section provide the details about the functions IBDM exposes.
303 @@ -480,6 +500,8 @@ They all return 0 on succes.
304
305 The file holds a set of utilities to be run on the subnet to mimic OpenSM initialization and analyze the results:
306
307 +=over
308 +
309 =item [ returns int ] ibdmAssignLids p_smNodePort ?lmc?
310
311 Assign LIDs with an optional LMC (multiple LID per port)
312 @@ -548,10 +570,14 @@ Analyze multicast routing to make sure it obeys Up/Down rule
313
314 Prepare a schedule for transmission from a set of sources to destinations such that in each stage there are no links that are over subscribed and after all stages all the links of the fabric were excersized
315
316 +=back
317 +
318 =head2 Tracing Utilities
319
320 These functions allows tracing paths reporting back the visited nodes
321
322 +=over
323 +
324 =item [ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums
325
326 Trace a directed route path from the given port
327 @@ -564,10 +590,14 @@ Trace a path along the MinHop from the source to destination LIDs
328
329 Trace a path following the LFT updating the hops and node list variables
330
331 +=back
332 +
333 =head2 Topology Matching Utilities
334
335 The following utilities matches two fabrics providing both missmatch messages and a unified fabric
336
337 +=over
338 +
339 =item [ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid
340
341 Match a topology based fabric with a discovered one starting at the enchor port
342 @@ -576,10 +606,14 @@ Match a topology based fabric with a discovered one starting at the enchor port
343
344 After matching using ibdmMatchFabrics populate the "merged fabric" with information merged for the matched nodes
345
346 +=back
347 +
348 =head2 Congestion Analysis Utilities
349
350 Provide ability to track and report link oversubscription
351
352 +=over
353 +
354 =item [ returns int ] ibdmCongInit p_fabric
355
356 Initialize the tracking system
357 @@ -604,6 +638,8 @@ Report the resulting congestion information
358
359 Dump all congestion tracking info
360
361 +=back
362 +
363 =head1 AUTHOR
364
365 Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
366 diff --git a/ibdm/doc/ibdmtr.pod b/ibdm/doc/ibdmtr.pod
367 index 15ad7e5..c8f168d 100644
368 --- a/ibdm/doc/ibdmtr.pod
369 +++ b/ibdm/doc/ibdmtr.pod
370 @@ -12,67 +12,50 @@ ibdmtr [-v][-h] {-c <cbaling file>|-t <topo file>} -s <sm node name>
371 This utility parses a cabling list or topology file describing the systems connections that make a fabric. Then it start following the direct route provided and print out the systems and nodes on the route.
372
373 =head1 ARGUMENTS
374 +
375 Required arguments description.
376
377 =over
378
379 =item -t|--topology <file>
380
381 -=over
382 -
383 -=item Topology file describing the network. See man ibdm-topology-file.
384 -
385 -=back
386 +Topology file describing the network. See man ibdm-topology-file.
387
388 =item -c|--cables <file>
389
390 +Cabling list file. Following the line format:
391 +
392 =over
393
394 -=item Cabling list file. Following the line format:
395 +<Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
396
397 =back
398
399 -<Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
400 -
401 =item -s|--sm-node <name>
402
403 -=over
404 -
405 -=item The name of the SM node (not system). E.g. OSM/U1.
406 -
407 -=back
408 +The name of the SM node (not system). E.g. OSM/U1.
409
410 =item -p|--port-num <num>
411
412 -=over
413 -
414 -=item The number of the SM node port the SM is attached to
415 -
416 -=back
417 +The number of the SM node port the SM is attached to
418
419 =item -d|--dr-path <comm-sep-dr-path>
420
421 -=over
422 -
423 -=item A list of ports to go out through
424 +A list of ports to go out through
425
426 =back
427
428 =head1 OPTIONS
429
430 -=item -v|--verbose
431 -
432 =over
433
434 -=item verbsoe mode
435 +=item -v|--verbose
436
437 -=back
438 +verbsoe mode
439
440 =item -h|--help
441
442 -=over
443 -
444 -=item provide this help message
445 +provide this help message
446
447 =back
448
449 diff --git a/ibdm/doc/ibtopodiff.pod b/ibdm/doc/ibtopodiff.pod
450 index caf71f4..cdb2dd7 100644
451 --- a/ibdm/doc/ibtopodiff.pod
452 +++ b/ibdm/doc/ibtopodiff.pod
453 @@ -13,6 +13,8 @@ This utility performs matching between a given topology file (see man B<ibdm-top
454
455 =head1 ARGUMENTS
456
457 +=over
458 +
459 =item -t|--topology <file>
460
461 Topology file. See man B<ibdm-topology-file> for its definition.
462 @@ -33,8 +35,12 @@ The number of the matching start port, also known as anchor port
463
464 The guid of the matching start port
465
466 +=back
467 +
468 =head1 OPTIONS
469
470 +=over
471 +
472 =item -v|--verbose
473
474 Verbsoe mode
475 @@ -43,6 +49,8 @@ Verbsoe mode
476
477 Provides this help message
478
479 +=back
480 +
481 =head1 AUTHOR
482
483 Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
484 diff --git a/ibis/doc/ibis.pod b/ibis/doc/ibis.pod
485 index d75fd5e..7102ca1 100644
486 --- a/ibis/doc/ibis.pod
487 +++ b/ibis/doc/ibis.pod
488 @@ -36,11 +36,15 @@ These constants are provided by IBIS:
489
490 =item [ Constant : int ] $IBIS_LOG_FRAMES = 0x20
491
492 +=back
493 +
494 =head1 IBIS Functions
495
496 This section provide the details about the functions IBIS exposes.
497 They all return 0 on succes.
498
499 +=over
500 +
501 =item [return list] ibis_get_local_ports_info
502
503 Return the list of available IB ports with GUID, LID, state and port number.
504 @@ -74,23 +78,26 @@ Exit IBIS.
505
506 Appends a message to the OpenSM log
507
508 -=back 4
509 +=back
510
511 =head2 IBIS Options Object
512
513 -=over 4
514 -
515 -
516 The IBIS options are available through the predefined object: ibis_opts.
517 It can be manipulated using the standard Tcl methods: cget and configure.
518 Examples:
519
520 - ibis_opts cget -force_log_flush
521 +=over 4
522 +
523 +ibis_opts cget -force_log_flush
524
525 - ibis_opts configure -force_log_flush TRUE
526 +ibis_opts configure -force_log_flush TRUE
527 +
528 +=back
529
530 The following are the different options that can be configured:
531
532 +=over
533 +
534 =item [ Member data: returns boolean_t * ] -single_thread
535
536 Run single threaded
537 @@ -120,6 +127,8 @@ The M_Key to be used when sending SubnetMgt
538
539 The Vendor Key to be used when sending Vendor Specific MADs.
540
541 +=back
542 +
543 =head1 IBPM
544
545 IBPM stands for IB Performance Monitoring MADs. IB provides standard facilities for tracking statistics on every port.
546 @@ -127,6 +136,8 @@ IBPM stands for IB Performance Monitoring MADs. IB provides standard facilities
547 This section provide the details about the functions IBPM exposes.
548 They all return 0 on succes.
549
550 +=over
551 +
552 =item [ returns int ] pmMultiMaxGet
553
554 Obtain the maximal number of parallel queries that can be sent
555 @@ -154,23 +165,22 @@ Sends a command to "clear all counters" on the given LID and port
556 Send a batch of "clear all counters" commands to the given list of LIDs and ports.
557 num - defines the number of elements in each list.
558
559 +=back
560 +
561 =head1 IBSAC
562
563 IBSAC stands for IB Subnet Administrator (SA) Client. It provide means to query the SA for information about the various objects it manages
564
565 The following sections describe the concepts behind the SAC interface and then provides detailed description of each attribute that can be queried.
566
567 -=back 4
568 -
569 =head2 IBSAC Objects
570
571 -=over 4
572 -
573 -
574 IBSAC uses predefined global objects to facilitate SA Queries.
575 Such objects are named sac<Attribute>Query. Each such object
576 exposes a standard set of methods:
577
578 +=over
579 +
580 =item dump
581
582 dump out all fields and values for the obejct
583 @@ -253,15 +263,14 @@ Queries of non embedded attributes:
584 =item vlarb:<idx>= VL Arbitration table record
585
586
587 -=back 4
588 +=back
589
590 =head2 NODE INFO RECORD
591
592 -=over 4
593 -
594 -
595 Component mask bits:
596
597 +=over 4
598 +
599 =item [ Constant : int ] $IB_NR_COMPMASK_LID = 0x1
600
601 =item [ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2
602 @@ -292,6 +301,8 @@ Component mask bits:
603
604 =item [ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000
605
606 +=back
607 +
608 ----
609
610 =head3 class sacNodeInfo
611 @@ -299,6 +310,8 @@ Component mask bits:
612
613 Fields:
614
615 +=over
616 +
617 =item [ Member data: returns uint8_t * ] -base_version
618
619 =item [ Member data: returns uint8_t * ] -class_version
620 @@ -323,37 +336,42 @@ Fields:
621
622 =item [ Member : returns void ] delete
623
624 +=back
625 +
626 ----
627
628 =head3 class sacNodeRec
629
630 RID Fields:
631
632 +=over
633 +
634 =item [ Member data: returns ib_net16_t * ] -lid
635
636 =item [ Member data: returns sacNodeInfo * ] -node_info
637
638 =item [ Member data: returns ib_node_desc_t * ] -node_desc
639
640 +=back
641
642 Methods:
643
644 +=over
645 +
646 =item [ Member : returns char * ] get comp_mask
647
648 =item [ Member : returns char * ] getTable comp_mask
649
650 =item [ Member : returns void ] delete
651
652 -
653 -=back 4
654 +=back
655
656 =head2 PORT INFO RECORD
657
658 -=over 4
659 -
660 -
661 Component mask bits:
662
663 +=over 4
664 +
665 =item [ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1
666
667 =item [ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2
668 @@ -450,13 +468,16 @@ Component mask bits:
669
670 =item [ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000
671
672 +=back
673 +
674 ----
675
676 =head3 class sacPortInfo
677
678 -
679 Fields:
680
681 +=over
682 +
683 =item [ Member data: returns ib_net64_t * ] -m_key
684
685 =item [ Member data: returns ib_net64_t * ] -subnet_prefix
686 @@ -527,37 +548,42 @@ VlCap and InitType
687
688 =item [ Member : returns void ] delete
689
690 +=back
691 +
692 ----
693
694 =head3 class sacPortRec
695
696 RID Fields:
697
698 +=over
699 +
700 =item [ Member data: returns ib_net16_t * ] -lid
701
702 =item [ Member data: returns uint8_t * ] -port_num
703
704 =item [ Member data: returns sacPortInfo * ] -port_info
705
706 +=back
707
708 Methods:
709
710 +=over
711 +
712 =item [ Member : returns char * ] get comp_mask
713
714 =item [ Member : returns char * ] getTable comp_mask
715
716 =item [ Member : returns void ] delete
717
718 -
719 -=back 4
720 +=back
721
722 =head2 SM INFO RECORD
723
724 -=over 4
725 -
726 -
727 Component mask bits:
728
729 +=over 4
730 +
731 =item [ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1
732
733 =item [ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2
734 @@ -570,13 +596,16 @@ Component mask bits:
735
736 =item [ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20
737
738 +=back
739 +
740 ----
741
742 =head3 class sacSmInfo
743
744 -
745 Fields:
746
747 +=over
748 +
749 =item [ Member data: returns ib_net64_t * ] -guid
750
751 =item [ Member data: returns ib_net64_t * ] -sm_key
752 @@ -587,19 +616,26 @@ Fields:
753
754 =item [ Member : returns void ] delete
755
756 +=back
757 +
758 ----
759
760 =head3 class sacSmRec
761
762 RID Fields:
763
764 +=over
765 +
766 =item [ Member data: returns ib_net16_t * ] -lid
767
768 =item [ Member data: returns sacSmInfo * ] -sm_info
769
770 +=back
771
772 Methods:
773
774 +=over
775 +
776 =item [ Member : returns char * ] get comp_mask
777
778 =item [ Member : returns char * ] getTable comp_mask
779 @@ -607,15 +643,14 @@ Methods:
780 =item [ Member : returns void ] delete
781
782
783 -=back 4
784 +=back
785
786 =head2 SWITCH INFO RECORD
787
788 -=over 4
789 -
790 -
791 Component mask bits:
792
793 +=over 4
794 +
795 =item [ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1
796
797 =item [ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2
798 @@ -642,6 +677,8 @@ Component mask bits:
799
800 =item [ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000
801
802 +=back
803 +
804 ----
805
806 =head3 class sacSwInfo
807 @@ -649,6 +686,8 @@ Component mask bits:
808
809 Fields:
810
811 +=over
812 +
813 =item [ Member data: returns ib_net16_t * ] -lin_cap
814
815 =item [ Member data: returns ib_net16_t * ] -rand_cap
816 @@ -673,19 +712,26 @@ Fields:
817
818 =item [ Member : returns void ] delete
819
820 +=back
821 +
822 ----
823
824 =head3 class sacSwRec
825
826 RID Fields:
827
828 +=over
829 +
830 =item [ Member data: returns ib_net16_t * ] -lid
831
832 =item [ Member data: returns sacSwInfo * ] -switch_info
833
834 +=back
835
836 Methods:
837
838 +=over
839 +
840 =item [ Member : returns char * ] get comp_mask
841
842 =item [ Member : returns char * ] getTable comp_mask
843 @@ -693,15 +739,14 @@ Methods:
844 =item [ Member : returns void ] delete
845
846
847 -=back 4
848 +=back
849
850 =head2 LINK RECORD
851
852 -=over 4
853 -
854 -
855 Component mask bits:
856
857 +=over 4
858 +
859 =item [ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1
860
861 =item [ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2
862 @@ -710,6 +755,8 @@ Component mask bits:
863
864 =item [ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8
865
866 +=back
867 +
868 ----
869
870 =head3 class sacLinkRec
871 @@ -717,6 +764,8 @@ Component mask bits:
872
873 Fields:
874
875 +=over
876 +
877 =item [ Member data: returns ib_net16_t * ] -from_lid
878
879 =item [ Member data: returns uint8_t * ] -from_port_num
880 @@ -725,9 +774,12 @@ Fields:
881
882 =item [ Member data: returns ib_net16_t * ] -to_lid
883
884 +=back
885
886 Methods:
887
888 +=over
889 +
890 =item [ Member : returns char * ] get comp_mask
891
892 =item [ Member : returns char * ] getTable comp_mask
893 @@ -735,15 +787,14 @@ Methods:
894 =item [ Member : returns void ] delete
895
896
897 -=back 4
898 +=back
899
900 =head2 PATH RECORD
901
902 -=over 4
903 -
904 -
905 Component mask bits:
906
907 +=over 4
908 +
909 =item [ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4
910
911 =item [ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8
912 @@ -784,6 +835,8 @@ Component mask bits:
913
914 =item [ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000
915
916 +=back
917 +
918 ----
919
920 =head3 class sacPathRec
921 @@ -791,6 +844,8 @@ Component mask bits:
922
923 Fields:
924
925 +=over
926 +
927 =item [ Member data: returns ib_gid_t * ] -dgid
928
929 =item [ Member data: returns ib_gid_t * ] -sgid
930 @@ -817,8 +872,12 @@ Fields:
931
932 =item [ Member data: returns uint8_t * ] -preference
933
934 +=back
935 +
936 Methds:
937
938 +=over
939 +
940 =item [ Member : returns char * ] get comp_mask
941
942 =item [ Member : returns char * ] getTable comp_mask
943 @@ -826,19 +885,21 @@ Methds:
944 =item [ Member : returns void ] delete
945
946
947 -=back 4
948 +=back
949
950 =head2 LINEAR FORWARDING TABLE
951
952 -=over 4
953 -
954
955 Component mask bits:
956
957 +=over 4
958 +
959 =item [ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1
960
961 =item [ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2
962
963 +=back
964 +
965 ----
966
967 =head3 class sacLFTRec
968 @@ -846,15 +907,20 @@ Component mask bits:
969
970 Fields:
971
972 +=over
973 +
974 =item [ Member data: returns ib_net16_t * ] -lid
975
976 =item [ Member data: returns ib_net16_t * ] -block_num
977
978 =item [ Member data: returns ib_lft_t * ] -lft
979
980 +=back
981
982 Methods:
983
984 +=over
985 +
986 =item [ Member : returns char * ] get comp_mask
987
988 =item [ Member : returns char * ] getTable comp_mask
989 @@ -862,15 +928,14 @@ Methods:
990 =item [ Member : returns void ] delete
991
992
993 -=back 4
994 +=back
995
996 =head2 MULTICAST MEMBER RECORD
997
998 -=over 4
999 -
1000 -
1001 Component mask bits:
1002
1003 +=over 4
1004 +
1005 =item [ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1
1006
1007 =item [ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1
1008 @@ -909,6 +974,8 @@ Component mask bits:
1009
1010 =item [ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000
1011
1012 +=back
1013 +
1014 ----
1015
1016 =head3 class sacMCMRec
1017 @@ -916,6 +983,8 @@ Component mask bits:
1018
1019 Fields:
1020
1021 +=over
1022 +
1023 =item [ Member data: returns ib_gid_t * ] -mgid
1024
1025 =item [ Member data: returns ib_gid_t * ] -port_gid
1026 @@ -938,9 +1007,12 @@ Fields:
1027
1028 =item [ Member data: returns uint8_t * ] -scope_state
1029
1030 +=back
1031
1032 Methods:
1033
1034 +=over
1035 +
1036 =item [ Member : returns char * ] get comp_mask
1037
1038 =item [ Member : returns char * ] getTable comp_mask
1039 @@ -962,12 +1034,10 @@ Instead of simple field configure
1040 Delete the object
1041
1042
1043 -=back 4
1044 +=back
1045
1046 =head2 SA CLASS PORT INFO
1047
1048 -=over 4
1049 -
1050 ----
1051
1052 =head3 class sacClassPortInfo
1053 @@ -975,6 +1045,8 @@ Delete the object
1054
1055 Fields:
1056
1057 +=over 4
1058 +
1059 =item [ Member data: returns uint8_t * ] -base_ver
1060
1061 =item [ Member data: returns uint8_t * ] -class_ver
1062 @@ -1007,20 +1079,21 @@ Fields:
1063
1064 =item [ Member data: returns ib_net32_t * ] -trap_qkey
1065
1066 +=back
1067
1068 Methods:
1069
1070 +=over
1071 +
1072 =item [ Member : returns char * ] get
1073
1074 =item [ Member : returns void ] delete
1075
1076
1077 -=back 4
1078 +=back
1079
1080 =head2 INFORM INFO RECORD
1081
1082 -=over 4
1083 -
1084
1085 The inform Info is built with heirarchy of objects. So several classes are defined.
1086
1087 @@ -1031,6 +1104,8 @@ The inform Info is built with heirarchy of objects. So several classes are defin
1088
1089 Fields:
1090
1091 +=over 4
1092 +
1093 =item [ Member data: returns ib_gid_t * ] -gid
1094
1095 =item [ Member data: returns ib_net16_t * ] -lid_range_begin
1096 @@ -1047,13 +1122,18 @@ Fields:
1097
1098 =item [ Member data: returns sacInformInfo_g_or_v * ] -g_or_v
1099
1100 +=back
1101
1102 Methods:
1103
1104 +=over
1105 +
1106 =item [ Member : returns char * ] set
1107
1108 =item [ Member : returns void ] delete
1109
1110 +=back
1111 +
1112 ----
1113
1114 =head3 class sacInformInfo_g_or_v
1115 @@ -1061,10 +1141,14 @@ Methods:
1116
1117 Fields:
1118
1119 +=over
1120 +
1121 =item [ Member data: returns sacInformInfo_g_or_v_generic * ] -generic
1122
1123 =item [ Member data: returns sacInformInfo_g_or_v_vend * ] -vend
1124
1125 +=back
1126 +
1127 ----
1128
1129 =head3 class sacInformInfo_g_or_v_generic
1130 @@ -1072,6 +1156,8 @@ Fields:
1131
1132 Fields:
1133
1134 +=over
1135 +
1136 =item [ Member data: returns ib_net16_t * ] -trap_num
1137
1138 =item [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
1139 @@ -1082,6 +1168,8 @@ Fields:
1140
1141 =item [ Member data: returns ib_net16_t * ] -node_type_lsb
1142
1143 +=back
1144 +
1145 ----
1146
1147 =head3 class sacInformInfo_g_or_v_vend
1148 @@ -1089,6 +1177,8 @@ Fields:
1149
1150 Fields:
1151
1152 +=over
1153 +
1154 =item [ Member data: returns ib_net16_t * ] -dev_id
1155
1156 =item [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
1157 @@ -1099,16 +1189,14 @@ Fields:
1158
1159 =item [ Member data: returns ib_net16_t * ] -vendor_id_lsb
1160
1161 -
1162 -=back 4
1163 +=back
1164
1165 =head2 SERVICE RECORD
1166
1167 -=over 4
1168 -
1169 -
1170 Component mask bits:
1171
1172 +=over 4
1173 +
1174 =item [ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1
1175
1176 =item [ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1
1177 @@ -1183,6 +1271,8 @@ Component mask bits:
1178
1179 =item [ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000
1180
1181 +=back
1182 +
1183 ----
1184
1185 =head3 class sacServiceRec
1186 @@ -1190,6 +1280,8 @@ Component mask bits:
1187
1188 Fields:
1189
1190 +=over
1191 +
1192 =item [ Member data: returns ib_net64_t * ] -service_id
1193
1194 =item [ Member data: returns ib_gid_t * ] -service_gid
1195 @@ -1212,9 +1304,12 @@ Fields:
1196
1197 =item [ Member data: returns ib_net64_array_t * ] -service_data64
1198
1199 +=back
1200
1201 Methods:
1202
1203 +=over
1204 +
1205 =item [ Member : returns char * ] get comp_mask
1206
1207 =item [ Member : returns char * ] set comp_mask
1208 @@ -1226,33 +1321,40 @@ Methods:
1209 =item [ Member : returns void ] obj_delete
1210
1211
1212 -=back 4
1213 +=back
1214
1215 =head2 SL to VL TABLE RECORD
1216
1217 -=over 4
1218 -
1219 -
1220 Component mask bits:
1221
1222 +=over 4
1223 +
1224 =item [ Constant : char * ] $IB_SLVL_COMPMASK_LID = 0x1
1225
1226 =item [ Constant : char * ] $IB_SLVL_COMPMASK_IN_PORT = 0x2
1227
1228 =item [ Constant : char * ] $IB_SLVL_COMPMASK_OUT_PORT = 0x4
1229
1230 +=back
1231 +
1232 ----
1233
1234 =head3 class sacSlVlTbl
1235
1236 +=over
1237 +
1238 =item [ Member data: returns uint8_array_t * ] -raw_vl_by_sl
1239
1240 +=back
1241 +
1242 ----
1243
1244 =head3 class sacSlVlRec
1245
1246 RID Fields:
1247
1248 +=over
1249 +
1250 =item [ Member data: returns ib_net16_t * ] -lid
1251
1252 for CA: lid of port, for switch lid of port 0
1253 @@ -1269,9 +1371,12 @@ reserved for CA's
1254
1255 =item [ Member data: returns sacSlVlTbl * ] -slvl_tbl
1256
1257 +=back
1258
1259 Methods:
1260
1261 +=over
1262 +
1263 =item [ Member : returns char * ] get comp_mask
1264
1265 =item [ Member : returns char * ] getTable comp_mask
1266 @@ -1279,21 +1384,22 @@ Methods:
1267 =item [ Member : returns void ] delete
1268
1269
1270 -=back 4
1271 +=back
1272
1273 =head2 VL ARBITRATION TABLE RECORD
1274
1275 -=over 4
1276 -
1277 -
1278 Component mask bits:
1279
1280 +=over 4
1281 +
1282 =item [ Constant : char * ] $IB_VLA_COMPMASK_LID = 0x1
1283
1284 =item [ Constant : char * ] $IB_VLA_COMPMASK_OUT_PORT = 0x2
1285
1286 =item [ Constant : char * ] $IB_VLA_COMPMASK_BLOCK = 0x4
1287
1288 +=back
1289 +
1290 ----
1291
1292 =head3 class sacVlArbRec
1293 @@ -1301,6 +1407,8 @@ Component mask bits:
1294
1295 Fields:
1296
1297 +=over
1298 +
1299 =item [ Member data: returns ib_net16_t * ] -lid
1300
1301 for CA: lid of port, for switch lid of port 0
1302 @@ -1313,9 +1421,12 @@ for CA: lid of port, for switch lid of port 0
1303
1304 =item [ Member data: returns sac_vl_arb_tbl_t * ] -vl_arb_tbl
1305
1306 +=back
1307
1308 Methods:
1309
1310 +=over
1311 +
1312 =item [ Member : returns char * ] get comp_mask
1313
1314 =item [ Member : returns char * ] getTable comp_mask
1315 @@ -1323,21 +1434,23 @@ Methods:
1316 =item [ Member : returns void ] delete
1317
1318
1319 -=back 4
1320 +=back
1321
1322 =head2 PKEY TABLE RECORD
1323
1324 -=over 4
1325 -
1326
1327 Component mask bits:
1328
1329 +=over 4
1330 +
1331 =item [ Constant : char * ] $IB_PKEY_COMPMASK_LID = 0x1
1332
1333 =item [ Constant : char * ] $IB_PKEY_COMPMASK_BLOCK = 0x2
1334
1335 =item [ Constant : char * ] $IB_PKEY_COMPMASK_PORT = 0x4
1336
1337 +=back
1338 +
1339 ----
1340
1341 =head3 class sacPKeyTbl
1342 @@ -1345,14 +1458,20 @@ Component mask bits:
1343
1344 Fields:
1345
1346 +=over
1347 +
1348 =item [ Member data: returns ib_net16_array_t * ] -pkey_entry
1349
1350 +=back
1351 +
1352 ----
1353
1354 =head3 class sacPKeyRec
1355
1356 RID Fields:
1357
1358 +=over
1359 +
1360 =item [ Member data: returns ib_net16_t * ] -lid
1361
1362 for CA: lid of port, for switch lid of port 0
1363 @@ -1369,21 +1488,29 @@ for switch: port number, for CA: reserved
1364
1365 =item [ Member data: returns sacPKeyTbl * ] -pkey_tbl
1366
1367 +=back
1368
1369 Methods:
1370
1371 +=over
1372 +
1373 =item [ Member : returns char * ] get comp_mask
1374
1375 =item [ Member : returns char * ] getTable comp_mask
1376
1377 =item [ Member : returns void ] delete
1378
1379 +=back
1380 +
1381 =head1 Subnet Management MADs (SMPs)
1382
1383 The SM interface supports sending Subnet Management Packets to the fabric devices. The specific attributes that can be access is provided in detail in each sub section below.
1384
1385 A set of object types is defined. The user can allocate a new attribute object. Then the object can be set using configure or the direct manipulation methods.
1386 Extra methods are provided for each object:
1387 +
1388 +=over
1389 +
1390 =item setByDr <dr> <attrMod>
1391
1392 Set the attribute on the object accessible by the given directed route. A directed route is a list of port numbers to go out from.
1393 @@ -1392,25 +1519,23 @@ Set the attribute on the object accessible by the given directed route. A direct
1394
1395 Get the attribute value by traversing a directed route.
1396
1397 -setByLid <lid> <attrMod>
1398 +=item setByLid <lid> <attrMod>
1399
1400 Set the attribute on the object accessible by the given LID
1401
1402 -getByLid <lid> <attrMod>
1403 +=item getByLid <lid> <attrMod>
1404
1405 get the attribute on the object accessible by the given LID
1406
1407
1408 -=back 4
1409 +=back
1410
1411 =head2 class smNodeInfo
1412
1413 -=over 4
1414 -
1415 -
1416 -
1417 Fields:
1418
1419 +=over 4
1420 +
1421 =item [ Member data: returns uint8_t * ] -base_version
1422
1423 =item [ Member data: returns uint8_t * ] -class_version
1424 @@ -1433,9 +1558,12 @@ Fields:
1425
1426 =item [ Member data: returns ib_net32_t * ] -port_num_vendor_id
1427
1428 +=back
1429
1430 Methods:
1431
1432 +=over
1433 +
1434 =item [ Member : returns int ] getByDr dr
1435
1436 =item [ Member : returns int ] setByDr dr
1437 @@ -1444,11 +1572,15 @@ Methods:
1438
1439 =item [ Member : returns int ] setByLid lid
1440
1441 +=back
1442 +
1443 =head1 class smPortInfo
1444
1445
1446 Fields:
1447
1448 +=over
1449 +
1450 =item [ Member data: returns ib_net64_t * ] -m_key
1451
1452 =item [ Member data: returns ib_net64_t * ] -subnet_prefix
1453 @@ -1517,9 +1649,12 @@ VlCap and InitType
1454
1455 =item [ Member data: returns uint8_t * ] -error_threshold
1456
1457 +=back
1458
1459 Methods:
1460
1461 +=over
1462 +
1463 =item [ Member : returns int ] getByDr dr portNum
1464
1465 =item [ Member : returns int ] setByDr dr portNum
1466 @@ -1529,7 +1664,7 @@ Methods:
1467 =item [ Member : returns int ] setByLid lid portNum
1468
1469
1470 -=back 4
1471 +=back
1472
1473 =head2 class smSwInfo
1474
1475 @@ -1567,7 +1702,7 @@ Methods:
1476 =item [ Member : returns int ] setByLid lid
1477
1478
1479 -=back 4
1480 +=back
1481
1482 =head2 class smLftBlock
1483
1484 @@ -1585,7 +1720,7 @@ Methods:
1485 =item [ Member : returns int ] setByLid lid blockNum
1486
1487
1488 -=back 4
1489 +=back
1490
1491 =head2 class smMftBlock
1492
1493 @@ -1603,7 +1738,7 @@ Methods:
1494 =item [ Member : returns int ] setByLid lid startLid startPort
1495
1496
1497 -=back 4
1498 +=back
1499
1500 =head2 class smGuidInfo
1501
1502 @@ -1621,7 +1756,7 @@ Methods:
1503 =item [ Member : returns int ] setByLid lid blockNum
1504
1505
1506 -=back 4
1507 +=back
1508
1509 =head2 class smPkeyTable
1510
1511 @@ -1639,7 +1774,7 @@ Methods:
1512 =item [ Member : returns int ] setByLid lid portNum blockNum
1513
1514
1515 -=back 4
1516 +=back
1517
1518 =head2 class smSlVlTable
1519
1520 @@ -1657,7 +1792,7 @@ Methods:
1521 =item [ Member : returns int ] setByLid lid inPortNum outPortNum
1522
1523
1524 -=back 4
1525 +=back
1526
1527 =head2 class smVlArbTable
1528
1529 @@ -1675,7 +1810,7 @@ Methods:
1530 =item [ Member : returns int ] setByLid lid portNum block
1531
1532
1533 -=back 4
1534 +=back
1535
1536 =head2 class smNodeDesc
1537
1538 @@ -1693,7 +1828,7 @@ Methods:
1539 =item [ Member : returns int ] setByLid lid
1540
1541
1542 -=back 4
1543 +=back
1544
1545 =head2 class smSMInfo
1546
1547 @@ -1717,15 +1852,14 @@ Methods:
1548 =item [ Member : returns int ] setByLid lid
1549
1550
1551 -=back 4
1552 +=back
1553
1554 =head2 class smNotice
1555
1556 -=over 4
1557 -
1558 -
1559 The NOTICE attribute is built out of several sub objects
1560
1561 +=over 4
1562 +
1563 =item [ Member data: returns uint8_t * ] -generic_type
1564
1565 =item [ Member data: returns ib_net16_t * ] -issuer_lid
1566 @@ -1742,18 +1876,26 @@ The NOTICE attribute is built out of several sub objects
1567
1568 =item [ Member : returns int ] trapByLid lid
1569
1570 +=back
1571 +
1572 ----
1573
1574 =head3 class smNotice_g_or_v
1575
1576 +=over
1577 +
1578 =item [ Member data: returns smNotice_g_or_v_generic * ] -generic
1579
1580 =item [ Member data: returns smNotice_g_or_v_vend * ] -vend
1581
1582 +=back
1583 +
1584 ----
1585
1586 =head3 class smNotice_data_details
1587
1588 +=over
1589 +
1590 =item [ Member data: returns smNotice_data_details_raw_data * ] -raw_data
1591
1592 =item [ Member data: returns smNotice_data_details_ntc_64_67 * ] -ntc_64_67
1593 @@ -1772,55 +1914,78 @@ The NOTICE attribute is built out of several sub objects
1594
1595 =item [ Member data: returns smNotice_data_details_ntc_259 * ] -ntc_259
1596
1597 +=back
1598 +
1599 ----
1600
1601 =head3 class smNotice_g_or_v_generic
1602
1603 +=over
1604 +
1605 =item [ Member data: returns uint8_t * ] -prod_type_msb
1606
1607 =item [ Member data: returns ib_net16_t * ] -prod_type_lsb
1608
1609 =item [ Member data: returns ib_net16_t * ] -trap_num
1610
1611 +=back
1612 +
1613 ----
1614
1615 =head3 class smNotice_g_or_v_vend
1616
1617 +=over
1618 +
1619 =item [ Member data: returns uint8_t * ] -vend_id_msb
1620
1621 =item [ Member data: returns ib_net16_t * ] -vend_id_lsb
1622
1623 =item [ Member data: returns ib_net16_t * ] -dev_id
1624
1625 +=back
1626 +
1627 ----
1628
1629 =head3 class smNotice_data_details_raw_data
1630
1631 +=over
1632 +
1633 =item [ Member data: returns uint8_array_t * ] -details
1634
1635 +=back
1636
1637 ----
1638
1639 =head3 class smNotice_data_details_ntc_64_67
1640
1641 +=over
1642 +
1643 =item [ Member data: returns uint8_array_t * ] -res
1644
1645 =item [ Member data: returns ib_gid_t * ] -gid
1646
1647 the Node or Multicast Group that came in/out
1648
1649 +=back
1650 +
1651 ----
1652
1653 =head3 class smNotice_data_details_ntc_128
1654
1655 +=over
1656 +
1657 =item [ Member data: returns ib_net16_t * ] -sw_lid
1658
1659 the sw lid of which link state changed
1660
1661 +=back
1662 +
1663 ----
1664
1665 =head3 class smNotice_data_details_ntc_129_131
1666
1667 +=over
1668 +
1669 =item [ Member data: returns ib_net16_t * ] -pad
1670
1671 =item [ Member data: returns ib_net16_t * ] -lid
1672 @@ -1829,10 +1994,14 @@ lid and port number of the violation
1673
1674 =item [ Member data: returns uint8_t * ] -port_num
1675
1676 +=back
1677 +
1678 ----
1679
1680 =head3 class smNotice_data_details_ntc_144
1681
1682 +=over
1683 +
1684 =item [ Member data: returns ib_net16_t * ] -pad1
1685
1686 =item [ Member data: returns ib_net16_t * ] -lid
1687 @@ -1845,10 +2014,14 @@ lid where capability mask changed
1688
1689 new capability mask
1690
1691 +=back
1692 +
1693 ----
1694
1695 =head3 class smNotice_data_details_ntc_145
1696
1697 +=over
1698 +
1699 =item [ Member data: returns ib_net16_t * ] -pad1
1700
1701 =item [ Member data: returns ib_net16_t * ] -lid
1702 @@ -1861,10 +2034,14 @@ lid where sys guid changed
1703
1704 new system image guid
1705
1706 +=back
1707 +
1708 ----
1709
1710 =head3 class smNotice_data_details_ntc_256
1711
1712 +=over
1713 +
1714 =item [ Member data: returns ib_net16_t * ] -pad1
1715
1716 =item [ Member data: returns ib_net16_t * ] -lid
1717 @@ -1887,10 +2064,14 @@ new system image guid
1718
1719 =item [ Member data: returns uint8_array_t * ] -dr_rtn_path
1720
1721 +=back
1722 +
1723 ----
1724
1725 =head3 class smNotice_data_details_ntc_257_258
1726
1727 +=over
1728 +
1729 =item [ Member data: returns ib_net16_t * ] -pad1
1730
1731 =item [ Member data: returns ib_net16_t * ] -lid1
1732 @@ -1909,10 +2090,14 @@ new system image guid
1733
1734 =item [ Member data: returns ib_gid_t * ] -gid2
1735
1736 +=back
1737 +
1738 ----
1739
1740 =head3 class smNotice_data_details_ntc_259
1741
1742 +=over
1743 +
1744 =item [ Member data: returns ib_net16_t * ] -data_valid
1745
1746 =item [ Member data: returns ib_net16_t * ] -lid1
1747 @@ -1937,6 +2122,8 @@ new system image guid
1748
1749 =item [ Member data: returns uint8_t * ] -port_no
1750
1751 +=back
1752 +
1753 =head1 IBCR Functions
1754
1755 Provides vendor specific access to the device internal coniguration space
1756 @@ -1944,6 +2131,8 @@ Provides vendor specific access to the device internal coniguration space
1757 This section provide the details about the functions IBCR exposes.
1758 They all return 0 on succes.
1759
1760 +=over
1761 +
1762 =item [ returns int ] crMultiMaxGet
1763
1764 =item [ returns int ] crRead lid address
1765 @@ -1954,6 +2143,8 @@ They all return 0 on succes.
1766
1767 =item [ returns int ] crWriteMulti num lid_list data address
1768
1769 +=back
1770 +
1771 =head1 IB Vendor Specific Functions
1772
1773 IBVS stands for Vendor Specific MADs.
1774 @@ -1961,6 +2152,8 @@ IBVS stands for Vendor Specific MADs.
1775 This section provide the details about the functions IBVS exposes.
1776 They all return 0 on succes.
1777
1778 +=over
1779 +
1780 =item [ returns int ] vsMultiMaxGet
1781
1782 =item [ returns int ] vsCpuRead lid size cpu_traget_size address
1783 @@ -1997,11 +2190,15 @@ They all return 0 on succes.
1784
1785 =item [ returns int ] vsMirrorWrite lid rx_mirror tx_mirror
1786
1787 +=back
1788 +
1789 =head1 IBBBM Functions
1790
1791 This section provide the details about the functions IBBBM exposes.
1792 They all return 0 on succes.
1793
1794 +=over
1795 +
1796 =item [ returns int ] bbmVpdRead lid vpd_device_selector bytes_num offset
1797
1798 =item [ returns int ] bbmVpdWrite lid vpd_device_selector bytes_num offset p_data
1799 @@ -2016,6 +2213,7 @@ They all return 0 on succes.
1800
1801 =item [ returns int ] bbmFWVerRead lid
1802
1803 +=back
1804
1805 =head1 AUTHOR
1806
1807 --
1808 2.25.1
1809
147147 index dabfafa..ed85818 100644
148148 --- a/ibdm/doc/ibdmchk.pod
149149 +++ b/ibdm/doc/ibdmchk.pod
150 @@ -59,7 +59,7 @@ A file with all the roots node names (one on each line).
150 @@ -67,7 +67,7 @@ A file with all the roots node names (one on each line).
151151
152152 =head1 VERIFICATION MODE DESCRIPTION
153153
156156 Based on these files the utility checks all CA to CA connectivity. Further analysis for credit deadlock potential is performed and reported.
157157 In case of an LMC > 0 it reports histograms for how many systems and nodes are common between the different paths for the same port pairs.
158158
159 @@ -81,15 +81,15 @@ Provides this help message
159 @@ -95,15 +95,15 @@ Provides this help message
160160
161161 =item -s|--subnet <file>
162162
00 01-fix-with_osm_libs.patch
11 02-fix-format-warning.patch
22 03-remove-rpath.patch
3 Fix-POD-errors.patch
34 do_not_use_tmp.patch
45 makefile_dependencies.patch
56 cross.patch