BaseTools:Change the path of the file that Binary Cache

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Udp4Dxe / Udp4Driver.h

diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h
index 371216574af40bdd14360d8a28ab6c16dc63c08c..4e9a0c73565a99bdd3b9853116a35ad415a3d031 100644 (file)
--- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h
+++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h
@@ -1,27 +1,14 @@
 /** @file\r
 \r
 /** @file\r
 \r

-Copyright (c) 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
-  Udp4Driver.h\r
-\r
-Abstract:\r
-\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r

 \r
 **/\r
 \r
 #ifndef _UDP4_DRIVER_H_\r
 #define _UDP4_DRIVER_H_\r
 \r
 \r
 **/\r
 \r
 #ifndef _UDP4_DRIVER_H_\r
 #define _UDP4_DRIVER_H_\r
 \r

-#include <PiDxe.h>\r
+#include <Uefi.h>\r

 #include <Library/BaseLib.h>\r
 #include <Library/NetLib.h>\r
 #include <Protocol/DriverBinding.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/NetLib.h>\r
 #include <Protocol/DriverBinding.h>\r


@@ -35,10 +22,10 @@ Abstract:
   follow these calling restrictions. If any other agent wishes to call\r
   Supported() it must also follow these calling restrictions.\r
 \r
   follow these calling restrictions. If any other agent wishes to call\r
   Supported() it must also follow these calling restrictions.\r
 \r

-  @param  This                Protocol instance pointer.\r
-  @param  ControllerHandle    Handle of device to test\r
-  @param  RemainingDevicePath Optional parameter use to pick a specific child\r
-                              device to start.\r
+  @param[in]  This                Protocol instance pointer.\r
+  @param[in]  ControllerHandle    Handle of device to test\r
+  @param[in]  RemainingDevicePath Optional parameter use to pick a specific child\r
+                                  device to start.\r

 \r
   @retval EFI_SUCCESS         This driver supports this device\r
   @retval EFI_ALREADY_STARTED This driver is already running on this device\r
 \r
   @retval EFI_SUCCESS         This driver supports this device\r
   @retval EFI_ALREADY_STARTED This driver is already running on this device\r


@@ -61,10 +48,10 @@ Udp4DriverBindingSupported (
   calling restrictions. If any other agent wishes to call Start() it\r
   must also follow these calling restrictions.\r
 \r
   calling restrictions. If any other agent wishes to call Start() it\r
   must also follow these calling restrictions.\r
 \r

-  @param  This                 Protocol instance pointer.\r
-  @param  ControllerHandle     Handle of device to bind driver to\r
-  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
-                               device to start.\r
+  @param[in]  This                 Protocol instance pointer.\r
+  @param[in]  ControllerHandle     Handle of device to bind driver to\r
+  @param[in]  RemainingDevicePath  Optional parameter use to pick a specific child\r
+                                   device to start.\r

 \r
   @retval EFI_SUCCESS          This driver is added to ControllerHandle\r
   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle\r
 \r
   @retval EFI_SUCCESS          This driver is added to ControllerHandle\r
   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle\r


@@ -86,12 +73,12 @@ Udp4DriverBindingStart (
   restrictions for this service. DisconnectController()\r
   must follow these calling restrictions. If any other agent wishes\r
   to call Stop() it must also follow these calling restrictions.\r
   restrictions for this service. DisconnectController()\r
   must follow these calling restrictions. If any other agent wishes\r
   to call Stop() it must also follow these calling restrictions.\r

-  \r
-  @param  This              Protocol instance pointer.\r
-  @param  ControllerHandle  Handle of device to stop driver on\r
-  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
-                            children is zero stop the entire bus driver.\r
-  @param  ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+  @param[in]  This              Protocol instance pointer.\r
+  @param[in]  ControllerHandle  Handle of device to stop driver on\r
+  @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
+                                children is zero stop the entire bus driver.\r
+  @param[in]  ChildHandleBuffer List of Child Handles to Stop.\r

 \r
   @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
   @retval other             This driver was not removed from this device\r
 \r
   @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
   @retval other             This driver was not removed from this device\r


@@ -107,16 +94,20 @@ Udp4DriverBindingStop (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Creates a child handle with a set of I/O services.\r
+  Creates a child handle and installs a protocol.\r

 \r
 \r

-  @param  This        Protocol instance pointer.\r
-  @param  ChildHandle Pointer to the handle of the child to create.  If it is NULL,\r
-                      then a new handle is created.  If it is not NULL, then the\r
-                      I/O services are added to the existing child handle.\r
+  The CreateChild() function installs a protocol on ChildHandle.\r
+  If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
+  If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r

 \r
 \r

-  @retval EFI_SUCCES            The child handle was created with the I/O services\r
+  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+  @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+                         then a new handle is created. If it is a pointer to an existing UEFI handle,\r
+                         then the protocol is added to the existing UEFI handle.\r
+\r
+  @retval EFI_SUCCES            The protocol was added to ChildHandle.\r

   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r

-  @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create\r
+  @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create\r

                                 the child\r
   @retval other                 The child handle was not created\r
 \r
                                 the child\r
   @retval other                 The child handle was not created\r
 \r


@@ -129,17 +120,20 @@ Udp4ServiceBindingCreateChild (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Destroys a child handle with a set of I/O services.\r
+  Destroys a child handle with a protocol installed on it.\r
+\r
+  The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
+  that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
+  last protocol on ChildHandle, then ChildHandle is destroyed.\r

 \r
 \r

-  @param  This        Protocol instance pointer.\r
-  @param  ChildHandle Handle of the child to destroy\r
+  @param[in] This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+  @param[in] ChildHandle Handle of the child to destroy\r

 \r
 \r

-  @retval EFI_SUCCES            The I/O services were removed from the child handle\r
-  @retval EFI_UNSUPPORTED       The child handle does not support the I/O services\r
-                                that are being removed.\r
-  @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
-  @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its\r
-                                I/O services are being used.\r
+  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
+  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
+  @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
+  @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle\r
+                                because its services are being used.\r

   @retval other                 The child handle was not destroyed\r
 \r
 **/\r
   @retval other                 The child handle was not destroyed\r
 \r
 **/\r