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, 61 insertions, 68 deletions

diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Start.c b/MdeModulePkg/Universal/Network/SnpDxe/Start.c
index eaba03c57d..5c5daeaa60 100644
--- a/MdeModulePkg/Universal/Network/SnpDxe/Start.c
+++ b/MdeModulePkg/Universal/Network/SnpDxe/Start.c
@@ -1,94 +1,90 @@
 /** @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 starting a network adapter.

+ 

+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:

-  start.c

-

-Abstract:

-

-Revision history:

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

-

 **/

 

 #include "Snp.h"

 

 

 /**

-  this routine calls undi to start the interface and changes the snp state!

-

-  @param  snp                    pointer to snp driver structure

+  this routine calls undi to start the interface and changes the snp state.

 

+  @param  Snp                    pointer to snp driver structure

 

+  @retval EFI_DEVICE_ERROR       UNDI could not be started

+  @retval EFI_SUCCESS            UNDI is started successfully

+  

 **/

 EFI_STATUS

-pxe_start (

-  SNP_DRIVER *snp

+PxeStart (

+  IN SNP_DRIVER *Snp

   )

 {

-  PXE_CPB_START_31  *cpb_31;

+  PXE_CPB_START_31  *Cpb31;

 

-  cpb_31  = snp->cpb;

+  Cpb31  = Snp->Cpb;

   //

   // Initialize UNDI Start CDB for H/W UNDI

   //

-  snp->cdb.OpCode     = PXE_OPCODE_START;

-  snp->cdb.OpFlags    = PXE_OPFLAGS_NOT_USED;

-  snp->cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;

-  snp->cdb.DBsize     = PXE_DBSIZE_NOT_USED;

-  snp->cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;

-  snp->cdb.DBaddr     = PXE_DBADDR_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;

+  Snp->Cdb.OpCode     = PXE_OPCODE_START;

+  Snp->Cdb.OpFlags    = PXE_OPFLAGS_NOT_USED;

+  Snp->Cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;

+  Snp->Cdb.DBsize     = PXE_DBSIZE_NOT_USED;

+  Snp->Cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;

+  Snp->Cdb.DBaddr     = PXE_DBADDR_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;

 

   //

   // Make changes to H/W UNDI Start CDB if this is

   // a S/W UNDI.

   //

-  if (snp->is_swundi) {

-    snp->cdb.CPBsize  = sizeof (PXE_CPB_START_31);

-    snp->cdb.CPBaddr  = (UINT64)(UINTN) cpb_31;

+  if (Snp->IsSwUndi) {

+    Snp->Cdb.CPBsize  = sizeof (PXE_CPB_START_31);

+    Snp->Cdb.CPBaddr  = (UINT64)(UINTN) Cpb31;

 

-    cpb_31->Delay     = (UINT64)(UINTN) &snp_undi32_callback_delay;

-    cpb_31->Block     = (UINT64)(UINTN) &snp_undi32_callback_block;

+    Cpb31->Delay     = (UINT64)(UINTN) &SnpUndi32CallbackDelay;

+    Cpb31->Block     = (UINT64)(UINTN) &SnpUndi32CallbackBlock;

 

     //

     // Virtual == Physical.  This can be set to zero.

     //

-    cpb_31->Virt2Phys = (UINT64)(UINTN) 0;

-    cpb_31->Mem_IO    = (UINT64)(UINTN) &snp_undi32_callback_memio;

+    Cpb31->Virt2Phys = (UINT64)(UINTN) 0;

+    Cpb31->Mem_IO    = (UINT64)(UINTN) &SnpUndi32CallbackMemio;

 

-    cpb_31->Map_Mem   = (UINT64)(UINTN) &snp_undi32_callback_map;

-    cpb_31->UnMap_Mem = (UINT64)(UINTN) &snp_undi32_callback_unmap;

-    cpb_31->Sync_Mem  = (UINT64)(UINTN) &snp_undi32_callback_sync;

+    Cpb31->Map_Mem   = (UINT64)(UINTN) &SnpUndi32CallbackMap;

+    Cpb31->UnMap_Mem = (UINT64)(UINTN) &SnpUndi32CallbackUnmap;

+    Cpb31->Sync_Mem  = (UINT64)(UINTN) &SnpUndi32CallbackSync;

 

-    cpb_31->Unique_ID = (UINT64)(UINTN) snp;

+    Cpb31->Unique_ID = (UINT64)(UINTN) Snp;

   }

   //

   // Issue UNDI command and check result.

   //

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

 

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

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

 

-  if (snp->cdb.StatCode != PXE_STATCODE_SUCCESS) {

+  if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) {

     //

     // UNDI could not be started. Return UNDI error.

     //

     DEBUG (

       (EFI_D_ERROR,

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

-      snp->cdb.StatCode,

-      snp->cdb.StatFlags)

+      Snp->Cdb.StatCode,

+      Snp->Cdb.StatFlags)

       );

 

     return EFI_DEVICE_ERROR;

@@ -96,34 +92,31 @@ pxe_start (
   //

   // Set simple network state to Started and return success.

   //

-  snp->mode.State = EfiSimpleNetworkStarted;

+  Snp->Mode.State = EfiSimpleNetworkStarted;

 

   return EFI_SUCCESS;

 }

 

 

 /**

-  This is the SNP interface routine for starting the interface

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

-  calls the pxe_start routine to actually do start undi interface

-

-  @param  This                   context pointer

-

-  @retval EFI_INVALID_PARAMETER  "This" is Null

-  @retval      No                SNP driver can be extracted from "This"

-  @retval EFI_ALREADY_STARTED    The state of SNP is EfiSimpleNetworkStarted or

-                                 EfiSimpleNetworkInitialized

-  @retval EFI_DEVICE_ERROR       The state of SNP is other than

-                                 EfiSimpleNetworkStarted,

-                                 EfiSimpleNetworkInitialized, and

-                                 EfiSimpleNetworkStopped

-  @retval EFI_SUCCESS            UNDI interface is succesfully started

-  @retval Other                  Error occurs while calling pxe_start function.

+  Changes the state of a network interface from "stopped" to "started."

+  

+  This function starts a network interface. If the network interface successfully

+  starts, then EFI_SUCCESS will be returned.

+

+  @param  This                   A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.

+

+  @retval EFI_SUCCESS            The network interface was started.

+  @retval EFI_ALREADY_STARTED    The network interface is already in the started state.

+  @retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid 

+                                 EFI_SIMPLE_NETWORK_PROTOCOL structure.

+  @retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.

+  @retval EFI_UNSUPPORTED        This function is not supported by the network interface.

 

 **/

 EFI_STATUS

 EFIAPI

-snp_undi32_start (

+SnpUndi32Start (

   IN EFI_SIMPLE_NETWORK_PROTOCOL *This

   )

 {

@@ -140,7 +133,7 @@ snp_undi32_start (
 

   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

 

-  switch (Snp->mode.State) {

+  switch (Snp->Mode.State) {

   case EfiSimpleNetworkStopped:

     break;

 

@@ -154,7 +147,7 @@ snp_undi32_start (
     goto ON_EXIT;

   }

 

-  Status = pxe_start (Snp);

+  Status = PxeStart (Snp);

   if (EFI_ERROR (Status)) {

     goto ON_EXIT;

   }

@@ -162,11 +155,11 @@ snp_undi32_start (
   // clear the map_list in SNP structure

   //

   for (Index = 0; Index < MAX_MAP_LENGTH; Index++) {

-    Snp->map_list[Index].virt       = 0;

-    Snp->map_list[Index].map_cookie = 0;

+    Snp->MapList[Index].VirtualAddress = 0;

+    Snp->MapList[Index].MapCookie      = 0;

   }

 

-  Snp->mode.MCastFilterCount = 0;

+  Snp->Mode.MCastFilterCount = 0;

 

 ON_EXIT:

   gBS->RestoreTPL (OldTpl);