4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Implementation of collecting the statistics on a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncand made available under the terms and conditions of the BSD License which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncaccompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Resets or collects the statistics on a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function resets or collects the statistics on a network interface. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size of the statistics table specified by StatisticsSize is not big enough for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync all the statistics that are collected by the network interface, then a partial
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer of statistics is returned in StatisticsTable, StatisticsSize is set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the size required to collect all the available statistics, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BUFFER_TOO_SMALL is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If StatisticsSize is big enough for all the statistics, then StatisticsTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be filled, StatisticsSize will be set to the size of the returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatisticsTable structure, and EFI_SUCCESS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync no operations will be performed, and EFI_SUCCESS will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Reset is TRUE, then all of the supported statistics counters on this network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface will be reset to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Reset Set to TRUE to reset the statistics for the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatisticsSize On input the size, in bytes, of StatisticsTable. On output
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the size, in bytes, of the resulting table of statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contains the statistics. Type EFI_NETWORK_STATISTICS is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined in "Related Definitions" below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The requested operation succeeded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync started by calling Start().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL. The current buffer size that is needed to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync hold all the statistics is returned in StatisticsSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not NULL. The current buffer size that is needed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to hold all the statistics is returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatisticsSize. A partial set of statistics is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned in StatisticsTable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been initialized by calling Initialize().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An error was encountered collecting statistics
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the NIC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The NIC does not support collecting statistics
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get pointer to SNP driver instance for *This.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return error if the SNP is not initialized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if we are not resetting the counters, we have to have a valid stat table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // with >0 size. if no reset, no table and no size, return success.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = (StatisticsTable != NULL) ? EFI_INVALID_PARAMETER : EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize UNDI Statistics CDB
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATISTICS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Issue UNDI command and check result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "\nsnp->undi.statistics() %xh:%xh\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "\nsnp->undi.statistics() %xh:%xh\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Convert the UNDI statistics information to SNP statistics
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0, Mask = 1; Index < 64; Index++, Mask = LShiftU64 (Mask, 1), Stp++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There must be room for a full UINT64. Partial
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // numbers will not be stored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((Index + 1) * sizeof (UINT64) > *StatisticsSize) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Compute size up to last supported statistic.