Open System Services Library Calls Reference Manual (G06.29+, H06.08+, J06.03+)

OSS Library Calls (g - h) HBA_GetPortStatistics(3)
NAME
HBA_GetPortStatistics - Retrieves statistics for a specified a port of a Fibre Channel Host Bus
Adapter
LIBRARY
H-series OSS processes: /usr/lib/libcmnapi.a
SYNOPSIS
#include <snia_common.h>
HBA_STATUS HBA_GetPortStatistics (
HBA_HANDLE handle,
HBA_UINT32 port_index,
PHBA_PortStatisticsS *port_statistics
);
PARAMETERS
handle Handle to an adapter that has been opened by a call to the
HBA_OpenAdapter( ) function.
port_index Index of the port to be queried. The port index value ranges from 0 (zero) to 1
less than the NumberOfPorts returned from the HBA_GetAdapterAttributes( )
function.
port_statistics Used for returning the adapter port statistics.
DESCRIPTION
The HBA_GetPortStatistics( ) function retrieves the statistics for the specified port on an
adapter. The events tracked for statistics is HBA vendor-dependent. LinkFailureCount,
LossOfSyncCount, LossOfSignalCount, PrimitiveSeqProtocolErrCount, InvalidTxWordCount,
and InvalidCRCCount are values that are maintained by the port in its Link Error Status Block
(see the Fibre Channel Framing and Signaling Interface (FC-FS) standard by the International
Committee for Information Technology Standards (formerly NCITS)).
The handle parameter is of type HBA_HANDLE (defined in the Fibre Channel - Methodologies
for Interconnects (FC-MI) Revision 1.6) and is obtained through a call to the
HBA_OpenAdapter( ) function.
The port_statistics parameter is a pointer to a structure of type HBA_PORTSTATISTICS, which
is defined in the Fibre Channel - Methodologies for Interconnects (FC-MI) Revision 1.6.
If an HBA does not support a specific statistic it returns an All-Ones unsigned integer.
Calling Order
You must call the HBA_GetAdapterAttributes( ) function for an adapter before you can call the
HBA_GetAdapterPortAttributes( ) function or the HBA_GetPortStatistics( ) function for the
same adapter.
You must call the HBA_GetAdapterPortAttributes( ) function for an adapter and port before
you can call the HBA_DiscoveredPortAttributes( ) function for the same adapter and port.
527187-017 Hewlett-Packard Company 3−183