code scrub for UefiPxeBcDxe.

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

1 files changed, 64 insertions, 65 deletions

diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h
index 8e5bc7dd6d..333dd76870 100644
--- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h
+++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h
@@ -1,6 +1,6 @@
 /** @file

 

-Copyright (c) 2007, Intel Corporation

+Copyright (c) 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

@@ -9,95 +9,94 @@ 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:

-

-  PxeBcDriver.h

-

-Abstract:

-

-

 **/

 

 #ifndef __EFI_PXEBC_DRIVER_H__

 #define __EFI_PXEBC_DRIVER_H__

 

+/**

+  Test to see if this driver supports ControllerHandle. This service

+  is called by the EFI boot service ConnectController(). In

+  order to make drivers as small as possible, there are a few calling

+  restrictions for this service. ConnectController() must

+  follow these calling restrictions. If any other agent wishes to call

+  Supported() it must also follow these calling restrictions.

+  PxeBc requires DHCP4 and MTFTP4 protocols.

+

+  @param  This                Protocol instance pointer.

+  @param  ControllerHandle    Handle of device to test

+  @param  RemainingDevicePath Optional parameter use to pick a specific child

+                              device to start.

+

+  @retval EFI_SUCCESS         This driver supports this device

+  @retval EFI_ALREADY_STARTED This driver is already running on this device

+  @retval other               This driver does not support this device

+

+**/

 EFI_STATUS

+EFIAPI

 PxeBcDriverBindingSupported (

-  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

-  IN EFI_HANDLE                   Controller,

-  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath

-  )

-/*++

-

-  Routine Description:

-    Test to see if this driver supports ControllerHandle.

-

-  Arguments:

-    This                - Protocol instance pointer.

-    ControllerHandle    - Handle of device to test

-    RemainingDevicePath - Optional parameter use to pick a specific child

-                          device to start.

-

-  Returns:

-    EFI_SUCCES

-    EFI_ALREADY_STARTED

-    Others

-

---*/

-// GC_NOTO:    Controller - add argument and description to function comment

-;

-

-

+  IN EFI_DRIVER_BINDING_PROTOCOL  * This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL

+  );

+  

 /**

-  Start this driver on ControllerHandle.

+  Start this driver on ControllerHandle. This service is called by the

+  EFI boot service ConnectController(). In order to make

+  drivers as small as possible, there are a few calling restrictions for

+  this service. ConnectController() must follow these

+  calling restrictions. If any other agent wishes to call Start() it

+  must also follow these calling restrictions.

 

   @param  This                 Protocol instance pointer.

   @param  ControllerHandle     Handle of device to bind driver to

   @param  RemainingDevicePath  Optional parameter use to pick a specific child

                                device to start.

 

-  @return EFI_SUCCES

-  @return EFI_ALREADY_STARTED

-  @return EFI_OUT_OF_RESOURCES

-  @return Others

+  @retval EFI_SUCCESS          This driver is added to ControllerHandle

+  @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle

+  @retval other                This driver does not support this device

 

 **/

-// GC_NOTO:    Controller - add argument and description to function comment

 EFI_STATUS

+EFIAPI

 PxeBcDriverBindingStart (

-  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

-  IN EFI_HANDLE                   Controller,

-  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath

-  )

-;

-

-

+  IN EFI_DRIVER_BINDING_PROTOCOL  * This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL

+  );

+  

 /**

-  Stop this driver on ControllerHandle.

-

-  @param  This                 Protocol instance pointer.

-  @param  ControllerHandle     Handle of device to stop driver on

-  @param  NumberOfChildren     Number of Handles in ChildHandleBuffer. If number of

-                                children is zero stop the entire bus driver.

-  @param  ChildHandleBuffer    List of Child Handles to Stop.

-

-  @return EFI_SUCCESS

-  @return EFI_DEVICE_ERROR

-  @return Others

+  Stop this driver on ControllerHandle. This service is called by the

+  EFI boot service DisconnectController(). In order to

+  make drivers as small as possible, there are a few calling

+  restrictions for this service. DisconnectController()

+  must follow these calling restrictions. If any other agent wishes

+  to call Stop() it must also follow these calling restrictions.

+  

+  @param  This              Protocol instance pointer.

+  @param  ControllerHandle  Handle of device to stop driver on

+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of

+                            children is zero stop the entire bus driver.

+  @param  ChildHandleBuffer List of Child Handles to Stop.

+

+  @retval EFI_SUCCESS       This driver is removed ControllerHandle

+  @retval other             This driver was not removed from this device

 

 **/

-// GC_NOTO:    Controller - add argument and description to function comment

 EFI_STATUS

+EFIAPI

 PxeBcDriverBindingStop (

-  IN  EFI_DRIVER_BINDING_PROTOCOL *This,

-  IN  EFI_HANDLE                  Controller,

-  IN  UINTN                       NumberOfChildren,

-  IN  EFI_HANDLE                  *ChildHandleBuffer

-  )

-;

-

+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,

+  IN EFI_HANDLE                   ControllerHandle,

+  IN UINTN                        NumberOfChildren,

+  IN EFI_HANDLE                   *ChildHandleBuffer

+  );

+  

 extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2;

 extern EFI_COMPONENT_NAME_PROTOCOL  gPxeBcComponentName;

 extern EFI_DRIVER_BINDING_PROTOCOL  gPxeBcDriverBinding;

+

 #endif