HBA_GetFC4Statistics Subroutine

Purpose

Returns traffic statistics for a specific FC-4 protocol through a specific local HBA and local end port.

Syntax

HBA_STATUS HBA_GetFC4Statistics(
		HBA_HANDLE handle,
		HBA_WWN hbaPortWWN,
		HBA_UINT8 FC4type,
		HBA_FC4STATISTICS *statistics
);

Description

The HBA_GetFC4Statistics function returns traffic statistics for a specific FC-4 protocol through a specific local HBA and local end port.

Note: Basic Link Service, Extended Link Service, and CT each have specific Data Structure TYPE values, so their traffic can be requested.

Parameters

Item	Description
handle	A handle to an open HBA containing the end port for which FC-4 statistics can return.
hbaPortWWN	The Port Name of the local HBA end port for which FC-4 statistics can return.
FC4type	The Data Structure TYPE assigned by FC-FS to the FC-4 protocol for which FC-4 statistics are requested.
statistics	A pointer to an FC-4 Statistics structure in which the statistics for the specified FC-4 protocol can be returned.

Return Values

The value of the HBA_GetFC4Statistics function is a valid status return value that indicates the reason for completion of the requested function. HBA_STATUS_OK is returned to indicate that the statistics for the specified FC-4 and end port have been returned. A valid status return value that most closely describes the result of the function should be returned to indicate a reason with no required value.

The return value for the following parameter is as follows:

Item	Description
statistics	Remains unchanged. The structure to which it points contains the statistics for the specified FC-4 protocol.

Error Codes

Item	Description
HBA_STATUS_ERROR_ILLEGAL_WWN	Indicates that the HBA referenced by handle does not contain an end port with Port Name hbaPortWWN.
HBA_STATUS_ERROR_UNSUPPORTED_FC4	Indicates that the specified HBA end port does not support the specified FC-4 protocol.
HBA_STATUS_ERROR	Returned to indicate any problem with no required value.