sync comments, fix function header, rename variable name to follow coding style.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6481 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 109 insertions, 80 deletions

diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c b/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c
index 19f2823..c52fc23 100644
--- a/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c
+++ b/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c
@@ -1,21 +1,15 @@
 /** @file

-Copyright (c) 2004 - 2007, Intel Corporation

-All rights reserved. This program and the accompanying materials

-are licensed and made available under the terms and conditions of the BSD License

-which accompanies this distribution.  The full text of the license may be found at

-http://opensource.org/licenses/bsd-license.php

+    Implementation of collecting the statistics on a network interface.

+ 

+Copyright (c) 2004 - 2007, Intel Corporation. <BR> 

+All rights reserved. This program and the accompanying materials are licensed 

+and made available under the terms and conditions of the BSD License which 

+accompanies this distribution. The full text of the license may be found at 

+http://opensource.org/licenses/bsd-license.php 

 

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module name:

-  statistics.c

-

-Abstract:

-

-Revision history:

-  2000-Feb-17 M(f)J   Genesis.

-

 **/

 

 

@@ -23,50 +17,85 @@ Revision history:
 

 

 /**

-  This is the SNP interface routine for getting the NIC's statistics.

-  This routine basically retrieves snp structure, checks the SNP state and

-  calls the pxe_ routine to actually do the

-

-  @param  this              context pointer

-  @param  ResetFlag         true to reset the NIC's statistics counters to zero.

-  @param  StatTableSizePtr  pointer to the statistics table size

-  @param  StatTablePtr      pointer to the statistics table

-

+  Resets or collects the statistics on a network interface.

+  

+  This function resets or collects the statistics on a network interface. If the

+  size of the statistics table specified by StatisticsSize is not big enough for

+  all the statistics that are collected by the network interface, then a partial

+  buffer of statistics is returned in StatisticsTable, StatisticsSize is set to 

+  the size required to collect all the available statistics, and 

+  EFI_BUFFER_TOO_SMALL is returned.

+  If StatisticsSize is big enough for all the statistics, then StatisticsTable 

+  will be filled, StatisticsSize will be set to the size of the returned 

+  StatisticsTable structure, and EFI_SUCCESS is returned.

+  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

+  If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then

+  no operations will be performed, and EFI_SUCCESS will be returned.

+  If Reset is TRUE, then all of the supported statistics counters on this network

+  interface will be reset to zero.

+

+  @param This            A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

+  @param Reset           Set to TRUE to reset the statistics for the network interface.

+  @param StatisticsSize  On input the size, in bytes, of StatisticsTable. On output 

+                         the size, in bytes, of the resulting table of statistics.

+  @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that 

+                         contains the statistics. Type EFI_NETWORK_STATISTICS is 

+                         defined in "Related Definitions" below. 

+  

+  @retval EFI_SUCCESS           The requested operation succeeded.

+  @retval EFI_NOT_STARTED       The Simple Network Protocol interface has not been

+                                started by calling Start().

+  @retval EFI_BUFFER_TOO_SMALL  StatisticsSize is not NULL and StatisticsTable is 

+                                NULL. The current buffer size that is needed to 

+                                hold all the statistics is returned in StatisticsSize.

+  @retval EFI_BUFFER_TOO_SMALL  StatisticsSize is not NULL and StatisticsTable is 

+                                not NULL. The current buffer size that is needed

+                                to hold all the statistics is returned in 

+                                StatisticsSize. A partial set of statistics is 

+                                returned in StatisticsTable.

+  @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not 

+                                NULL.

+  @retval EFI_DEVICE_ERROR      The Simple Network Protocol interface has not 

+                                been initialized by calling Initialize().

+  @retval EFI_DEVICE_ERROR      An error was encountered collecting statistics 

+                                from the NIC.

+  @retval EFI_UNSUPPORTED       The NIC does not support collecting statistics 

+                                from the network interface.

 

 **/

 EFI_STATUS

 EFIAPI

-snp_undi32_statistics (

-  IN EFI_SIMPLE_NETWORK_PROTOCOL * this,

-  IN BOOLEAN                     ResetFlag,

-  IN OUT UINTN                   *StatTableSizePtr OPTIONAL,

-  IN OUT EFI_NETWORK_STATISTICS  * StatTablePtr OPTIONAL

+SnpUndi32Statistics (

+  IN EFI_SIMPLE_NETWORK_PROTOCOL *This,

+  IN BOOLEAN                     Reset,

+  IN OUT UINTN                   *StatisticsSize, OPTIONAL

+  IN OUT EFI_NETWORK_STATISTICS  *StatisticsTable OPTIONAL

   )

 {

-  SNP_DRIVER        *snp;

-  PXE_DB_STATISTICS *db;

-  UINT64            *stp;

-  UINT64            mask;

-  UINTN             size;

-  UINTN             n;

+  SNP_DRIVER        *Snp;

+  PXE_DB_STATISTICS *Db;

+  UINT64            *Stp;

+  UINT64            Mask;

+  UINTN             Size;

+  UINTN             Index;

   EFI_TPL           OldTpl;

   EFI_STATUS        Status;

 

   //

-  // Get pointer to SNP driver instance for *this.

+  // Get pointer to SNP driver instance for *This.

   //

-  if (this == NULL) {

+  if (This == NULL) {

     return EFI_INVALID_PARAMETER;

   }

 

-  snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (this);

+  Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This);

 

   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

 

   //

   // Return error if the SNP is not initialized.

   //

-  switch (snp->mode.State) {

+  switch (Snp->Mode.State) {

   case EfiSimpleNetworkInitialized:

     break;

 

@@ -82,39 +111,39 @@ snp_undi32_statistics (
   // if we are not resetting the counters, we have to have a valid stat table

   // with >0 size. if no reset, no table and no size, return success.

   //

-  if (!ResetFlag && StatTableSizePtr == NULL) {

-    Status = StatTablePtr ? EFI_INVALID_PARAMETER : EFI_SUCCESS;

+  if (!Reset && StatisticsSize == NULL) {

+    Status = (StatisticsTable != NULL) ? EFI_INVALID_PARAMETER : EFI_SUCCESS;

     goto ON_EXIT;

   }

   //

   // Initialize UNDI Statistics CDB

   //

-  snp->cdb.OpCode     = PXE_OPCODE_STATISTICS;

-  snp->cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;

-  snp->cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;

-  snp->cdb.StatCode   = PXE_STATCODE_INITIALIZE;

-  snp->cdb.StatFlags  = PXE_STATFLAGS_INITIALIZE;

-  snp->cdb.IFnum      = snp->if_num;

-  snp->cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;

-

-  if (ResetFlag) {

-    snp->cdb.OpFlags  = PXE_OPFLAGS_STATISTICS_RESET;

-    snp->cdb.DBsize   = PXE_DBSIZE_NOT_USED;

-    snp->cdb.DBaddr   = PXE_DBADDR_NOT_USED;

-    db                = snp->db;

+  Snp->Cdb.OpCode     = PXE_OPCODE_STATISTICS;

+  Snp->Cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;

+  Snp->Cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;

+  Snp->Cdb.StatCode   = PXE_STATCODE_INITIALIZE;

+  Snp->Cdb.StatFlags  = PXE_STATFLAGS_INITIALIZE;

+  Snp->Cdb.IFnum      = Snp->IfNum;

+  Snp->Cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;

+

+  if (Reset) {

+    Snp->Cdb.OpFlags  = PXE_OPFLAGS_STATISTICS_RESET;

+    Snp->Cdb.DBsize   = PXE_DBSIZE_NOT_USED;

+    Snp->Cdb.DBaddr   = PXE_DBADDR_NOT_USED;

+    Db                = Snp->Db;

   } else {

-    snp->cdb.OpFlags                = PXE_OPFLAGS_STATISTICS_READ;

-    snp->cdb.DBsize                 = sizeof (PXE_DB_STATISTICS);

-    snp->cdb.DBaddr                 = (UINT64)(UINTN) (db = snp->db);

+    Snp->Cdb.OpFlags                = PXE_OPFLAGS_STATISTICS_READ;

+    Snp->Cdb.DBsize                 = sizeof (PXE_DB_STATISTICS);

+    Snp->Cdb.DBaddr                 = (UINT64)(UINTN) (Db = Snp->Db);

   }

   //

   // Issue UNDI command and check result.

   //

   DEBUG ((EFI_D_NET, "\nsnp->undi.statistics()  "));

 

-  (*snp->issue_undi32_command) ((UINT64)(UINTN) &snp->cdb);

+  (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);

 

-  switch (snp->cdb.StatCode) {

+  switch (Snp->Cdb.StatCode) {

   case PXE_STATCODE_SUCCESS:

     break;

 

@@ -122,8 +151,8 @@ snp_undi32_statistics (
     DEBUG (

       (EFI_D_ERROR,

       "\nsnp->undi.statistics()  %xh:%xh\n",

-      snp->cdb.StatFlags,

-      snp->cdb.StatCode)

+      Snp->Cdb.StatFlags,

+      Snp->Cdb.StatCode)

       );

 

     Status = EFI_UNSUPPORTED;

@@ -133,21 +162,21 @@ snp_undi32_statistics (
     DEBUG (

       (EFI_D_ERROR,

       "\nsnp->undi.statistics()  %xh:%xh\n",

-      snp->cdb.StatFlags,

-      snp->cdb.StatCode)

+      Snp->Cdb.StatFlags,

+      Snp->Cdb.StatCode)

       );

 

     Status = EFI_DEVICE_ERROR;

     goto ON_EXIT;

   }

 

-  if (ResetFlag) {

+  if (Reset) {

     Status = EFI_SUCCESS;

     goto ON_EXIT;

   }

 

-  if (StatTablePtr == NULL) {

-    *StatTableSizePtr = sizeof (EFI_NETWORK_STATISTICS);

+  if (StatisticsTable == NULL) {

+    *StatisticsSize = sizeof (EFI_NETWORK_STATISTICS);

     Status = EFI_BUFFER_TOO_SMALL;

     goto ON_EXIT;

   }

@@ -155,42 +184,42 @@ snp_undi32_statistics (
   // Convert the UNDI statistics information to SNP statistics

   // information.

   //

-  ZeroMem (StatTablePtr, *StatTableSizePtr);

-  stp   = (UINT64 *) StatTablePtr;

-  size  = 0;

+  ZeroMem (StatisticsTable, *StatisticsSize);

+  Stp   = (UINT64 *) StatisticsTable;

+  Size  = 0;

 

-  for (n = 0, mask = 1; n < 64; n++, mask = LShiftU64 (mask, 1), stp++) {

+  for (Index = 0, Mask = 1; Index < 64; Index++, Mask = LShiftU64 (Mask, 1), Stp++) {

     //

     // There must be room for a full UINT64.  Partial

     // numbers will not be stored.

     //

-    if ((n + 1) * sizeof (UINT64) > *StatTableSizePtr) {

+    if ((Index + 1) * sizeof (UINT64) > *StatisticsSize) {

       break;

     }

 

-    if (db->Supported & mask) {

-      *stp  = db->Data[n];

-      size  = n + 1;

+    if (Db->Supported & Mask) {

+      *Stp  = Db->Data[Index];

+      Size  = Index + 1;

     } else {

-      SetMem (stp, sizeof (UINT64), 0xFF);

+      SetMem (Stp, sizeof (UINT64), 0xFF);

     }

   }

   //

   // Compute size up to last supported statistic.

   //

-  while (++n < 64) {

-    if (db->Supported & (mask = LShiftU64 (mask, 1))) {

-      size = n;

+  while (++Index < 64) {

+    if (Db->Supported & (Mask = LShiftU64 (Mask, 1))) {

+      Size = Index;

     }

   }

 

-  size *= sizeof (UINT64);

+  Size *= sizeof (UINT64);

 

-  if (*StatTableSizePtr >= size) {

-    *StatTableSizePtr = size;

+  if (*StatisticsSize >= Size) {

+    *StatisticsSize = Size;

     Status = EFI_SUCCESS;

   } else {

-    *StatTableSizePtr = size;

+    *StatisticsSize = Size;

     Status = EFI_BUFFER_TOO_SMALL;

   }