From 0a63dd31e4c612ae222a3c8fed65c9c12ac3839d Mon Sep 17 00:00:00 2001
From: Benjamin Drung <benjamin.drung@cloud.ionos.com>
Date: Wed, 11 Nov 2020 13:03:59 +0100
Subject: Fix POD errors
Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
---
ibdiag/doc/ibdiagui.pod | 7 +-
ibdm/doc/ibdm-ibnl-file.pod | 15 +-
ibdm/doc/ibdm-topo-file.pod | 4 +-
ibdm/doc/ibdmchk.pod | 16 ++
ibdm/doc/ibdmsh.pod | 42 +++-
ibdm/doc/ibdmtr.pod | 39 ++--
ibdm/doc/ibtopodiff.pod | 8 +
ibis/doc/ibis.pod | 374 +++++++++++++++++++++++++++---------
8 files changed, 376 insertions(+), 129 deletions(-)
diff --git a/ibdiag/doc/ibdiagui.pod b/ibdiag/doc/ibdiagui.pod
index 86a2df9..6c21394 100644
--- a/ibdiag/doc/ibdiagui.pod
+++ b/ibdiag/doc/ibdiagui.pod
@@ -12,8 +12,8 @@ ibdiagui [-c <count>] [-v] [-r] [-u] [-o <out-dir>]
=head1 DESCRIPTION
- ibdiagui is a GUI wrapper for ibdiagnet.
- Its main features:
+ibdiagui is a GUI wrapper for ibdiagnet.
+Its main features:
=over
@@ -27,5 +27,8 @@ ibdiagui [-c <count>] [-v] [-r] [-u] [-o <out-dir>]
=head1 OPTIONS
+=over
+
=item ibdiagui simply passes its options to ibdiagnet. Please see ibdiagnet man page for the complete list.
+=back
diff --git a/ibdm/doc/ibdm-ibnl-file.pod b/ibdm/doc/ibdm-ibnl-file.pod
index ffdd560..219154e 100644
--- a/ibdm/doc/ibdm-ibnl-file.pod
+++ b/ibdm/doc/ibdm-ibnl-file.pod
@@ -34,7 +34,7 @@ The top most system defined in the given file
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.
-=back 4
+=back
=head1 2. File Format
@@ -50,7 +50,7 @@ Connections are defined inside the SYSTEM/TOPSYSTEM section only and thus might
=item 2. From any node or sub-system to a connector of the system.
-=back 4
+=back
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.
@@ -93,6 +93,7 @@ SYSTEM LEAF:12x,LEAF:12X
...
+=back
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:
@@ -108,7 +109,7 @@ LEAF leaf2
...
-=back 4
+=back
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:
@@ -116,6 +117,8 @@ The actual 4x or 12x version of the LEAF board can then be specified in the topo
MyIbSystem N001 CFG: leaf2=12x
+=back
+
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.
=item e)
@@ -158,9 +161,7 @@ SUBSYSTEM LEAF leaf1
12XP1 -> L1/P1-12x
-=back 4
-
-=over 4
+=back
=item f)
@@ -171,6 +172,8 @@ Place the file in the <prefix>/lib/IBDM/ibdm1.0/ibnl directory
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.
+=back
+
=head1 4. Formal definition in YACC Syntax:
INT ::= ([1-9][0-9]*|0) ;
diff --git a/ibdm/doc/ibdm-topo-file.pod b/ibdm/doc/ibdm-topo-file.pod
index af89afc..7deba46 100644
--- a/ibdm/doc/ibdm-topo-file.pod
+++ b/ibdm/doc/ibdm-topo-file.pod
@@ -11,7 +11,7 @@ It serves two purposes:
=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.
-=back 4
+=back
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.
@@ -62,7 +62,7 @@ The name of the system connected to the local port.
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.
-=back 4
+=back
=head1 EXAMPLE
diff --git a/ibdm/doc/ibdmchk.pod b/ibdm/doc/ibdmchk.pod
index dabfafa..a66dce0 100644
--- a/ibdm/doc/ibdmchk.pod
+++ b/ibdm/doc/ibdmchk.pod
@@ -24,6 +24,8 @@ The Design mode is intended to be used before the cluster is built. It provides
=head1 ARGUMENTS:
+=over
+
=item -t|--topo <topo file>
The B<topology file> specifying the network. See man B<ibdm-topology-file>
@@ -36,8 +38,12 @@ The name of the Subnet Manager node (syntax: <Topo-File-System>/U1)
The port number by which the SM nodes is attached to the fabric.
+=back
+
=head1 OPTIONS
+=over
+
=item -v|--verbose
Verbsoe mode
@@ -57,6 +63,8 @@ Use enhanced routing algorithm when LMC > 0 and report the resulting paths corre
=item -r|--roots <roots file>
A file with all the roots node names (one on each line).
+=back
+
=head1 VERIFICATION MODE DESCRIPTION
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.
@@ -65,12 +73,18 @@ In case of an LMC > 0 it reports histograms for how many systems and nodes are c
=head1 ARGUMENTS
+=over
+
=item -l|--lmc <lmc>
The LMC value used while running OpenSM. Mandatory if not the default 0.
+=back
+
=head1 OPTIONS
+=over
+
=item -v|--verbose
Verbsoe mode
@@ -120,6 +134,8 @@ Include multicast routing in credit loops analysis.
Verify not only CA-CA paths but also SW-SW, CA-SW and SW-CA.
Both check for FDB path connectivity and also for credit loops.
+=back
+
=head1 AUTHOR
Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
diff --git a/ibdm/doc/ibdmsh.pod b/ibdm/doc/ibdmsh.pod
index 3892143..599a5ad 100644
--- a/ibdm/doc/ibdmsh.pod
+++ b/ibdm/doc/ibdmsh.pod
@@ -23,7 +23,7 @@ The following constants are used by the node object type field
[ Constant : int ] $IB_CA_NODE = IB_CA_NODE
-=back 4
+=back
=head2 Log Verbosity Flags
@@ -39,7 +39,7 @@ The following constants are used as argument bits for the global variable $Fabri
[ Constant : int ] $FABU_LOG_VERBOSE = 0x4
-=back 4
+=back
=head1 IBDM Globals
@@ -49,7 +49,7 @@ Log level: set to FABU_LOG* values
[ Global : int ] $FabricUtilsVerboseLevel
-=back 4
+=back
=head1 IBDM Objects
@@ -102,6 +102,8 @@ B<Objects:>
The following are the different fields and methods of the IB Port class which describes an IB device (chip) physical port.
+=over
+
=item [ Member data: returns IBPort * ] -p_remotePort
Port connected on the other side of link
@@ -158,10 +160,14 @@ Connect the port to another node port with optional width and speed parameters
Disconnect the port. Return 0 if successful
+=back
+
=head2 class IBNode
The IB Node class represents a single IB Device (chip)
+=over
+
=item [ Member data: returns string * ] -name
Name of the node (instance name of the chip)
@@ -258,10 +264,14 @@ Get the LFT for a given LID
Dump out the min hop table of the node
+=back
+
=head2 class IBSysPort
The IBSysPort class represents an IB plug on the system front or back pannels
+=over
+
=item [ Member data: returns string * ] -name
The front pannel name (silk) of the port
@@ -290,10 +300,14 @@ Connect two SysPorts
Disconnect the SysPort (and ports). Return 0 if successful
+=back
+
=head2 class IBSystem
The IBSystem class represents an entire chassis
+=over
+
=item [ Member data: returns string * ] -name
The "host" name of the system
@@ -338,10 +352,14 @@ Get the node port for the given sys port by name
Get a Sys Port by name
+=back
+
=head2 class IBFabric
Represents an entire IB subnet made of systems
+=over
+
=item [ Member data: returns map_str_pnode * ] -NodeByName
Provide a list of node name and pointer pairs
@@ -470,6 +488,8 @@ Construct a new fabric
Destruct a fabric
+=back
+
=head1 IBDM Functions
This section provide the details about the functions IBDM exposes.
@@ -480,6 +500,8 @@ They all return 0 on succes.
The file holds a set of utilities to be run on the subnet to mimic OpenSM initialization and analyze the results:
+=over
+
=item [ returns int ] ibdmAssignLids p_smNodePort ?lmc?
Assign LIDs with an optional LMC (multiple LID per port)
@@ -548,10 +570,14 @@ Analyze multicast routing to make sure it obeys Up/Down rule
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
+=back
+
=head2 Tracing Utilities
These functions allows tracing paths reporting back the visited nodes
+=over
+
=item [ returns int ] ibdmTraceDRPathRoute p_smNodePort drPathPortNums
Trace a directed route path from the given port
@@ -564,10 +590,14 @@ Trace a path along the MinHop from the source to destination LIDs
Trace a path following the LFT updating the hops and node list variables
+=back
+
=head2 Topology Matching Utilities
The following utilities matches two fabrics providing both missmatch messages and a unified fabric
+=over
+
=item [ returns int ] ibdmMatchFabrics p_spec_fabric p_discovered_fabric anchorNodeName anchorPortNum anchorPortGuid
Match a topology based fabric with a discovered one starting at the enchor port
@@ -576,10 +606,14 @@ Match a topology based fabric with a discovered one starting at the enchor port
After matching using ibdmMatchFabrics populate the "merged fabric" with information merged for the matched nodes
+=back
+
=head2 Congestion Analysis Utilities
Provide ability to track and report link oversubscription
+=over
+
=item [ returns int ] ibdmCongInit p_fabric
Initialize the tracking system
@@ -604,6 +638,8 @@ Report the resulting congestion information
Dump all congestion tracking info
+=back
+
=head1 AUTHOR
Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
diff --git a/ibdm/doc/ibdmtr.pod b/ibdm/doc/ibdmtr.pod
index 15ad7e5..c8f168d 100644
--- a/ibdm/doc/ibdmtr.pod
+++ b/ibdm/doc/ibdmtr.pod
@@ -12,67 +12,50 @@ ibdmtr [-v][-h] {-c <cbaling file>|-t <topo file>} -s <sm node name>
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.
=head1 ARGUMENTS
+
Required arguments description.
=over
=item -t|--topology <file>
-=over
-
-=item Topology file describing the network. See man ibdm-topology-file.
-
-=back
+Topology file describing the network. See man ibdm-topology-file.
=item -c|--cables <file>
+Cabling list file. Following the line format:
+
=over
-=item Cabling list file. Following the line format:
+<Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
=back
-<Sys1Type> <Sys1Name> <Port1Name> <Sys2Type> <Sys2Name> <Port2Name>
-
=item -s|--sm-node <name>
-=over
-
-=item The name of the SM node (not system). E.g. OSM/U1.
-
-=back
+The name of the SM node (not system). E.g. OSM/U1.
=item -p|--port-num <num>
-=over
-
-=item The number of the SM node port the SM is attached to
-
-=back
+The number of the SM node port the SM is attached to
=item -d|--dr-path <comm-sep-dr-path>
-=over
-
-=item A list of ports to go out through
+A list of ports to go out through
=back
=head1 OPTIONS
-=item -v|--verbose
-
=over
-=item verbsoe mode
+=item -v|--verbose
-=back
+verbsoe mode
=item -h|--help
-=over
-
-=item provide this help message
+provide this help message
=back
diff --git a/ibdm/doc/ibtopodiff.pod b/ibdm/doc/ibtopodiff.pod
index caf71f4..cdb2dd7 100644
--- a/ibdm/doc/ibtopodiff.pod
+++ b/ibdm/doc/ibtopodiff.pod
@@ -13,6 +13,8 @@ This utility performs matching between a given topology file (see man B<ibdm-top
=head1 ARGUMENTS
+=over
+
=item -t|--topology <file>
Topology file. See man B<ibdm-topology-file> for its definition.
@@ -33,8 +35,12 @@ The number of the matching start port, also known as anchor port
The guid of the matching start port
+=back
+
=head1 OPTIONS
+=over
+
=item -v|--verbose
Verbsoe mode
@@ -43,6 +49,8 @@ Verbsoe mode
Provides this help message
+=back
+
=head1 AUTHOR
Eitan Zahavi, Mellanox Technologies LTD, eitan@mellanox.co.il
diff --git a/ibis/doc/ibis.pod b/ibis/doc/ibis.pod
index d75fd5e..7102ca1 100644
--- a/ibis/doc/ibis.pod
+++ b/ibis/doc/ibis.pod
@@ -36,11 +36,15 @@ These constants are provided by IBIS:
=item [ Constant : int ] $IBIS_LOG_FRAMES = 0x20
+=back
+
=head1 IBIS Functions
This section provide the details about the functions IBIS exposes.
They all return 0 on succes.
+=over
+
=item [return list] ibis_get_local_ports_info
Return the list of available IB ports with GUID, LID, state and port number.
@@ -74,23 +78,26 @@ Exit IBIS.
Appends a message to the OpenSM log
-=back 4
+=back
=head2 IBIS Options Object
-=over 4
-
-
The IBIS options are available through the predefined object: ibis_opts.
It can be manipulated using the standard Tcl methods: cget and configure.
Examples:
- ibis_opts cget -force_log_flush
+=over 4
+
+ibis_opts cget -force_log_flush
- ibis_opts configure -force_log_flush TRUE
+ibis_opts configure -force_log_flush TRUE
+
+=back
The following are the different options that can be configured:
+=over
+
=item [ Member data: returns boolean_t * ] -single_thread
Run single threaded
@@ -120,6 +127,8 @@ The M_Key to be used when sending SubnetMgt
The Vendor Key to be used when sending Vendor Specific MADs.
+=back
+
=head1 IBPM
IBPM stands for IB Performance Monitoring MADs. IB provides standard facilities for tracking statistics on every port.
@@ -127,6 +136,8 @@ IBPM stands for IB Performance Monitoring MADs. IB provides standard facilities
This section provide the details about the functions IBPM exposes.
They all return 0 on succes.
+=over
+
=item [ returns int ] pmMultiMaxGet
Obtain the maximal number of parallel queries that can be sent
@@ -154,23 +165,22 @@ Sends a command to "clear all counters" on the given LID and port
Send a batch of "clear all counters" commands to the given list of LIDs and ports.
num - defines the number of elements in each list.
+=back
+
=head1 IBSAC
IBSAC stands for IB Subnet Administrator (SA) Client. It provide means to query the SA for information about the various objects it manages
The following sections describe the concepts behind the SAC interface and then provides detailed description of each attribute that can be queried.
-=back 4
-
=head2 IBSAC Objects
-=over 4
-
-
IBSAC uses predefined global objects to facilitate SA Queries.
Such objects are named sac<Attribute>Query. Each such object
exposes a standard set of methods:
+=over
+
=item dump
dump out all fields and values for the obejct
@@ -253,15 +263,14 @@ Queries of non embedded attributes:
=item vlarb:<idx>= VL Arbitration table record
-=back 4
+=back
=head2 NODE INFO RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : int ] $IB_NR_COMPMASK_LID = 0x1
=item [ Constant : int ] $IB_NR_COMPMASK_RESERVED1 = 0x2
@@ -292,6 +301,8 @@ Component mask bits:
=item [ Constant : int ] $IB_NR_COMPMASK_NODEDESC = 0x4000
+=back
+
----
=head3 class sacNodeInfo
@@ -299,6 +310,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns uint8_t * ] -base_version
=item [ Member data: returns uint8_t * ] -class_version
@@ -323,37 +336,42 @@ Fields:
=item [ Member : returns void ] delete
+=back
+
----
=head3 class sacNodeRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
=item [ Member data: returns sacNodeInfo * ] -node_info
=item [ Member data: returns ib_node_desc_t * ] -node_desc
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
=item [ Member : returns void ] delete
-
-=back 4
+=back
=head2 PORT INFO RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_PIR_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_PIR_COMPMASK_PORTNUM = 0x2
@@ -450,13 +468,16 @@ Component mask bits:
=item [ Constant : char * ] $IB_PIR_COMPMASK_OVERRUNERR = 0x1000000000000
+=back
+
----
=head3 class sacPortInfo
-
Fields:
+=over
+
=item [ Member data: returns ib_net64_t * ] -m_key
=item [ Member data: returns ib_net64_t * ] -subnet_prefix
@@ -527,37 +548,42 @@ VlCap and InitType
=item [ Member : returns void ] delete
+=back
+
----
=head3 class sacPortRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
=item [ Member data: returns uint8_t * ] -port_num
=item [ Member data: returns sacPortInfo * ] -port_info
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
=item [ Member : returns void ] delete
-
-=back 4
+=back
=head2 SM INFO RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_SMR_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_SMR_COMPMASK_GUID = 0x2
@@ -570,13 +596,16 @@ Component mask bits:
=item [ Constant : int ] $IB_SMR_COMPMASK_PRI = 0x20
+=back
+
----
=head3 class sacSmInfo
-
Fields:
+=over
+
=item [ Member data: returns ib_net64_t * ] -guid
=item [ Member data: returns ib_net64_t * ] -sm_key
@@ -587,19 +616,26 @@ Fields:
=item [ Member : returns void ] delete
+=back
+
----
=head3 class sacSmRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
=item [ Member data: returns sacSmInfo * ] -sm_info
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -607,15 +643,14 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 SWITCH INFO RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_SWR_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_SWR_COMPMASK_LIN_CAP = 0x2
@@ -642,6 +677,8 @@ Component mask bits:
=item [ Constant : char * ] $IB_SWR_COMPMASK_FLAGS = 0x1000
+=back
+
----
=head3 class sacSwInfo
@@ -649,6 +686,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lin_cap
=item [ Member data: returns ib_net16_t * ] -rand_cap
@@ -673,19 +712,26 @@ Fields:
=item [ Member : returns void ] delete
+=back
+
----
=head3 class sacSwRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
=item [ Member data: returns sacSwInfo * ] -switch_info
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -693,15 +739,14 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 LINK RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : int ] $IB_LR_COMPMASK_FROM_LID = 0x1
=item [ Constant : int ] $IB_LR_COMPMASK_FROM_PORT = 0x2
@@ -710,6 +755,8 @@ Component mask bits:
=item [ Constant : int ] $IB_LR_COMPMASK_TO_LID = 0x8
+=back
+
----
=head3 class sacLinkRec
@@ -717,6 +764,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -from_lid
=item [ Member data: returns uint8_t * ] -from_port_num
@@ -725,9 +774,12 @@ Fields:
=item [ Member data: returns ib_net16_t * ] -to_lid
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -735,15 +787,14 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 PATH RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : int ] $IB_PR_COMPMASK_DGID = 0x4
=item [ Constant : int ] $IB_PR_COMPMASK_SGID = 0x8
@@ -784,6 +835,8 @@ Component mask bits:
=item [ Constant : int ] $IB_PR_COMPMASK_PFTLIFETIME = 0x200000
+=back
+
----
=head3 class sacPathRec
@@ -791,6 +844,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_gid_t * ] -dgid
=item [ Member data: returns ib_gid_t * ] -sgid
@@ -817,8 +872,12 @@ Fields:
=item [ Member data: returns uint8_t * ] -preference
+=back
+
Methds:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -826,19 +885,21 @@ Methds:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 LINEAR FORWARDING TABLE
-=over 4
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_LFT_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_LFT_COMPMASK_BLOCK = 0x2
+=back
+
----
=head3 class sacLFTRec
@@ -846,15 +907,20 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
=item [ Member data: returns ib_net16_t * ] -block_num
=item [ Member data: returns ib_lft_t * ] -lft
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -862,15 +928,14 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 MULTICAST MEMBER RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_MCR_COMPMASK_GID = 0x1
=item [ Constant : char * ] $IB_MCR_COMPMASK_MGID = 0x1
@@ -909,6 +974,8 @@ Component mask bits:
=item [ Constant : char * ] $IB_MCR_COMPMASK_PROXY = 0x20000
+=back
+
----
=head3 class sacMCMRec
@@ -916,6 +983,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_gid_t * ] -mgid
=item [ Member data: returns ib_gid_t * ] -port_gid
@@ -938,9 +1007,12 @@ Fields:
=item [ Member data: returns uint8_t * ] -scope_state
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -962,12 +1034,10 @@ Instead of simple field configure
Delete the object
-=back 4
+=back
=head2 SA CLASS PORT INFO
-=over 4
-
----
=head3 class sacClassPortInfo
@@ -975,6 +1045,8 @@ Delete the object
Fields:
+=over 4
+
=item [ Member data: returns uint8_t * ] -base_ver
=item [ Member data: returns uint8_t * ] -class_ver
@@ -1007,20 +1079,21 @@ Fields:
=item [ Member data: returns ib_net32_t * ] -trap_qkey
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 INFORM INFO RECORD
-=over 4
-
The inform Info is built with heirarchy of objects. So several classes are defined.
@@ -1031,6 +1104,8 @@ The inform Info is built with heirarchy of objects. So several classes are defin
Fields:
+=over 4
+
=item [ Member data: returns ib_gid_t * ] -gid
=item [ Member data: returns ib_net16_t * ] -lid_range_begin
@@ -1047,13 +1122,18 @@ Fields:
=item [ Member data: returns sacInformInfo_g_or_v * ] -g_or_v
+=back
Methods:
+=over
+
=item [ Member : returns char * ] set
=item [ Member : returns void ] delete
+=back
+
----
=head3 class sacInformInfo_g_or_v
@@ -1061,10 +1141,14 @@ Methods:
Fields:
+=over
+
=item [ Member data: returns sacInformInfo_g_or_v_generic * ] -generic
=item [ Member data: returns sacInformInfo_g_or_v_vend * ] -vend
+=back
+
----
=head3 class sacInformInfo_g_or_v_generic
@@ -1072,6 +1156,8 @@ Fields:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -trap_num
=item [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
@@ -1082,6 +1168,8 @@ Fields:
=item [ Member data: returns ib_net16_t * ] -node_type_lsb
+=back
+
----
=head3 class sacInformInfo_g_or_v_vend
@@ -1089,6 +1177,8 @@ Fields:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -dev_id
=item [ Member data: returns ib_net32_t * ] -qpn_resp_time_val
@@ -1099,16 +1189,14 @@ Fields:
=item [ Member data: returns ib_net16_t * ] -vendor_id_lsb
-
-=back 4
+=back
=head2 SERVICE RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_SR_COMPMASK_SID = 0x1
=item [ Constant : char * ] $IB_SR_COMPMASK_SGID = 0x1
@@ -1183,6 +1271,8 @@ Component mask bits:
=item [ Constant : char * ] $IB_SR_COMPMASK_SDATA64_1 = 0x800000000
+=back
+
----
=head3 class sacServiceRec
@@ -1190,6 +1280,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net64_t * ] -service_id
=item [ Member data: returns ib_gid_t * ] -service_gid
@@ -1212,9 +1304,12 @@ Fields:
=item [ Member data: returns ib_net64_array_t * ] -service_data64
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] set comp_mask
@@ -1226,33 +1321,40 @@ Methods:
=item [ Member : returns void ] obj_delete
-=back 4
+=back
=head2 SL to VL TABLE RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_SLVL_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_SLVL_COMPMASK_IN_PORT = 0x2
=item [ Constant : char * ] $IB_SLVL_COMPMASK_OUT_PORT = 0x4
+=back
+
----
=head3 class sacSlVlTbl
+=over
+
=item [ Member data: returns uint8_array_t * ] -raw_vl_by_sl
+=back
+
----
=head3 class sacSlVlRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
for CA: lid of port, for switch lid of port 0
@@ -1269,9 +1371,12 @@ reserved for CA's
=item [ Member data: returns sacSlVlTbl * ] -slvl_tbl
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -1279,21 +1384,22 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 VL ARBITRATION TABLE RECORD
-=over 4
-
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_VLA_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_VLA_COMPMASK_OUT_PORT = 0x2
=item [ Constant : char * ] $IB_VLA_COMPMASK_BLOCK = 0x4
+=back
+
----
=head3 class sacVlArbRec
@@ -1301,6 +1407,8 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
for CA: lid of port, for switch lid of port 0
@@ -1313,9 +1421,12 @@ for CA: lid of port, for switch lid of port 0
=item [ Member data: returns sac_vl_arb_tbl_t * ] -vl_arb_tbl
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
@@ -1323,21 +1434,23 @@ Methods:
=item [ Member : returns void ] delete
-=back 4
+=back
=head2 PKEY TABLE RECORD
-=over 4
-
Component mask bits:
+=over 4
+
=item [ Constant : char * ] $IB_PKEY_COMPMASK_LID = 0x1
=item [ Constant : char * ] $IB_PKEY_COMPMASK_BLOCK = 0x2
=item [ Constant : char * ] $IB_PKEY_COMPMASK_PORT = 0x4
+=back
+
----
=head3 class sacPKeyTbl
@@ -1345,14 +1458,20 @@ Component mask bits:
Fields:
+=over
+
=item [ Member data: returns ib_net16_array_t * ] -pkey_entry
+=back
+
----
=head3 class sacPKeyRec
RID Fields:
+=over
+
=item [ Member data: returns ib_net16_t * ] -lid
for CA: lid of port, for switch lid of port 0
@@ -1369,21 +1488,29 @@ for switch: port number, for CA: reserved
=item [ Member data: returns sacPKeyTbl * ] -pkey_tbl
+=back
Methods:
+=over
+
=item [ Member : returns char * ] get comp_mask
=item [ Member : returns char * ] getTable comp_mask
=item [ Member : returns void ] delete
+=back
+
=head1 Subnet Management MADs (SMPs)
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.
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.
Extra methods are provided for each object:
+
+=over
+
=item setByDr <dr> <attrMod>
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.
@@ -1392,25 +1519,23 @@ Set the attribute on the object accessible by the given directed route. A direct
Get the attribute value by traversing a directed route.
-setByLid <lid> <attrMod>
+=item setByLid <lid> <attrMod>
Set the attribute on the object accessible by the given LID
-getByLid <lid> <attrMod>
+=item getByLid <lid> <attrMod>
get the attribute on the object accessible by the given LID
-=back 4
+=back
=head2 class smNodeInfo
-=over 4
-
-
-
Fields:
+=over 4
+
=item [ Member data: returns uint8_t * ] -base_version
=item [ Member data: returns uint8_t * ] -class_version
@@ -1433,9 +1558,12 @@ Fields:
=item [ Member data: returns ib_net32_t * ] -port_num_vendor_id
+=back
Methods:
+=over
+
=item [ Member : returns int ] getByDr dr
=item [ Member : returns int ] setByDr dr
@@ -1444,11 +1572,15 @@ Methods:
=item [ Member : returns int ] setByLid lid
+=back
+
=head1 class smPortInfo
Fields:
+=over
+
=item [ Member data: returns ib_net64_t * ] -m_key
=item [ Member data: returns ib_net64_t * ] -subnet_prefix
@@ -1517,9 +1649,12 @@ VlCap and InitType
=item [ Member data: returns uint8_t * ] -error_threshold
+=back
Methods:
+=over
+
=item [ Member : returns int ] getByDr dr portNum
=item [ Member : returns int ] setByDr dr portNum
@@ -1529,7 +1664,7 @@ Methods:
=item [ Member : returns int ] setByLid lid portNum
-=back 4
+=back
=head2 class smSwInfo
@@ -1567,7 +1702,7 @@ Methods:
=item [ Member : returns int ] setByLid lid
-=back 4
+=back
=head2 class smLftBlock
@@ -1585,7 +1720,7 @@ Methods:
=item [ Member : returns int ] setByLid lid blockNum
-=back 4
+=back
=head2 class smMftBlock
@@ -1603,7 +1738,7 @@ Methods:
=item [ Member : returns int ] setByLid lid startLid startPort
-=back 4
+=back
=head2 class smGuidInfo
@@ -1621,7 +1756,7 @@ Methods:
=item [ Member : returns int ] setByLid lid blockNum
-=back 4
+=back
=head2 class smPkeyTable
@@ -1639,7 +1774,7 @@ Methods:
=item [ Member : returns int ] setByLid lid portNum blockNum
-=back 4
+=back
=head2 class smSlVlTable
@@ -1657,7 +1792,7 @@ Methods:
=item [ Member : returns int ] setByLid lid inPortNum outPortNum
-=back 4
+=back
=head2 class smVlArbTable
@@ -1675,7 +1810,7 @@ Methods:
=item [ Member : returns int ] setByLid lid portNum block
-=back 4
+=back
=head2 class smNodeDesc
@@ -1693,7 +1828,7 @@ Methods:
=item [ Member : returns int ] setByLid lid
-=back 4
+=back
=head2 class smSMInfo
@@ -1717,15 +1852,14 @@ Methods:
=item [ Member : returns int ] setByLid lid
-=back 4
+=back
=head2 class smNotice
-=over 4
-
-
The NOTICE attribute is built out of several sub objects
+=over 4
+
=item [ Member data: returns uint8_t * ] -generic_type
=item [ Member data: returns ib_net16_t * ] -issuer_lid
@@ -1742,18 +1876,26 @@ The NOTICE attribute is built out of several sub objects
=item [ Member : returns int ] trapByLid lid
+=back
+
----
=head3 class smNotice_g_or_v
+=over
+
=item [ Member data: returns smNotice_g_or_v_generic * ] -generic
=item [ Member data: returns smNotice_g_or_v_vend * ] -vend
+=back
+
----
=head3 class smNotice_data_details
+=over
+
=item [ Member data: returns smNotice_data_details_raw_data * ] -raw_data
=item [ Member data: returns smNotice_data_details_ntc_64_67 * ] -ntc_64_67
@@ -1772,55 +1914,78 @@ The NOTICE attribute is built out of several sub objects
=item [ Member data: returns smNotice_data_details_ntc_259 * ] -ntc_259
+=back
+
----
=head3 class smNotice_g_or_v_generic
+=over
+
=item [ Member data: returns uint8_t * ] -prod_type_msb
=item [ Member data: returns ib_net16_t * ] -prod_type_lsb
=item [ Member data: returns ib_net16_t * ] -trap_num
+=back
+
----
=head3 class smNotice_g_or_v_vend
+=over
+
=item [ Member data: returns uint8_t * ] -vend_id_msb
=item [ Member data: returns ib_net16_t * ] -vend_id_lsb
=item [ Member data: returns ib_net16_t * ] -dev_id
+=back
+
----
=head3 class smNotice_data_details_raw_data
+=over
+
=item [ Member data: returns uint8_array_t * ] -details
+=back
----
=head3 class smNotice_data_details_ntc_64_67
+=over
+
=item [ Member data: returns uint8_array_t * ] -res
=item [ Member data: returns ib_gid_t * ] -gid
the Node or Multicast Group that came in/out
+=back
+
----
=head3 class smNotice_data_details_ntc_128
+=over
+
=item [ Member data: returns ib_net16_t * ] -sw_lid
the sw lid of which link state changed
+=back
+
----
=head3 class smNotice_data_details_ntc_129_131
+=over
+
=item [ Member data: returns ib_net16_t * ] -pad
=item [ Member data: returns ib_net16_t * ] -lid
@@ -1829,10 +1994,14 @@ lid and port number of the violation
=item [ Member data: returns uint8_t * ] -port_num
+=back
+
----
=head3 class smNotice_data_details_ntc_144
+=over
+
=item [ Member data: returns ib_net16_t * ] -pad1
=item [ Member data: returns ib_net16_t * ] -lid
@@ -1845,10 +2014,14 @@ lid where capability mask changed
new capability mask
+=back
+
----
=head3 class smNotice_data_details_ntc_145
+=over
+
=item [ Member data: returns ib_net16_t * ] -pad1
=item [ Member data: returns ib_net16_t * ] -lid
@@ -1861,10 +2034,14 @@ lid where sys guid changed
new system image guid
+=back
+
----
=head3 class smNotice_data_details_ntc_256
+=over
+
=item [ Member data: returns ib_net16_t * ] -pad1
=item [ Member data: returns ib_net16_t * ] -lid
@@ -1887,10 +2064,14 @@ new system image guid
=item [ Member data: returns uint8_array_t * ] -dr_rtn_path
+=back
+
----
=head3 class smNotice_data_details_ntc_257_258
+=over
+
=item [ Member data: returns ib_net16_t * ] -pad1
=item [ Member data: returns ib_net16_t * ] -lid1
@@ -1909,10 +2090,14 @@ new system image guid
=item [ Member data: returns ib_gid_t * ] -gid2
+=back
+
----
=head3 class smNotice_data_details_ntc_259
+=over
+
=item [ Member data: returns ib_net16_t * ] -data_valid
=item [ Member data: returns ib_net16_t * ] -lid1
@@ -1937,6 +2122,8 @@ new system image guid
=item [ Member data: returns uint8_t * ] -port_no
+=back
+
=head1 IBCR Functions
Provides vendor specific access to the device internal coniguration space
@@ -1944,6 +2131,8 @@ Provides vendor specific access to the device internal coniguration space
This section provide the details about the functions IBCR exposes.
They all return 0 on succes.
+=over
+
=item [ returns int ] crMultiMaxGet
=item [ returns int ] crRead lid address
@@ -1954,6 +2143,8 @@ They all return 0 on succes.
=item [ returns int ] crWriteMulti num lid_list data address
+=back
+
=head1 IB Vendor Specific Functions
IBVS stands for Vendor Specific MADs.
@@ -1961,6 +2152,8 @@ IBVS stands for Vendor Specific MADs.
This section provide the details about the functions IBVS exposes.
They all return 0 on succes.
+=over
+
=item [ returns int ] vsMultiMaxGet
=item [ returns int ] vsCpuRead lid size cpu_traget_size address
@@ -1997,11 +2190,15 @@ They all return 0 on succes.
=item [ returns int ] vsMirrorWrite lid rx_mirror tx_mirror
+=back
+
=head1 IBBBM Functions
This section provide the details about the functions IBBBM exposes.
They all return 0 on succes.
+=over
+
=item [ returns int ] bbmVpdRead lid vpd_device_selector bytes_num offset
=item [ returns int ] bbmVpdWrite lid vpd_device_selector bytes_num offset p_data
@@ -2016,6 +2213,7 @@ They all return 0 on succes.
=item [ returns int ] bbmFWVerRead lid
+=back
=head1 AUTHOR
--
2.25.1