Technical Reference: Base Operating System and Extensions, Volume 1

HBA_GetPortStatistics Subroutine

Purpose

Gets the statistics for a Host Bus Adapter (HBA).

Library

Common Host Bus Adapter Library (libHBAAPI.a)

Syntax

#include <hbaapi.h>

void HBA_GetPortStatistics (handle, portindex, portstatistics)
HBA_HANDLE handle;
HBA_UINT32 portindex;
HBA_PORTSTATISTICS *portstatistics;

Description

The HBA_GetPortStatistics subroutine retrieves the statistics for the specified adapter. Only single-port adapters are supported, and the portindex parameter is disregarded. The exact meaning of events being counted for each statistic is vendor specific. The HBA_PORTSTATISTICS structure includes the following fields:

SecondsSinceLastReset
TxFrames
TxWords
RxFrames
RxWords
LIPCount
NOSCount
ErrorFrames
DumpedFrames
LinkFailureCount
LossOfSyncCount
LossOfSignalCount
PrimitiveSeqProtocolErrCount
InvalidTxWordCount
InvalidCRCCount

Parameters

handle	HBA_HANDLE to an open adapter.
portindex	Not used.
portstatistics	Pointer to an HBA_PORTSTATISTICS structure.

Return Values

Upon successful completion, HBA_STATUS_OK is returned. If the subroutine is unable to retrieve the statistics for an HBA, it returns HBA_STATUS_ERROR.