NetworkPkg: comments clean up.

[mirror_edk2.git] / NetworkPkg / Mtftp6Dxe / Mtftp6Driver.h

/** @file\r
  Driver Binding functions and Service Binding functions\r
  declaration for Mtftp6 Driver.\r
\r
  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
\r
  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
**/\r
\r
#ifndef __EFI_MTFTP6_DRIVER_H__\r
#define __EFI_MTFTP6_DRIVER_H__\r
\r
#include <Protocol/ServiceBinding.h>\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL  gMtftp6ComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;\r
\r
/**\r
  Test to see if this driver supports Controller. This service\r
  is called by the EFI boot service ConnectController(). In\r
  order to make drivers as small as possible, there are a few calling\r
  restrictions for this service. ConnectController() must\r
  follow these calling restrictions. If any other agent wishes to call\r
  Supported(), it must also follow these calling restrictions.\r
\r
  @param[in]  This                Protocol instance pointer.\r
  @param[in]  Controller          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 Others              This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6DriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Start this driver on Controller. This service is called by the\r
  EFI boot service ConnectController(). In order to make\r
  drivers as small as possible, there are calling restrictions for\r
  this service. ConnectController() must follow these\r
  calling restrictions. If any other agent wishes to call Start() it\r
  must also follow these calling restrictions.\r
\r
  @param[in]  This                 Protocol instance pointer.\r
  @param[in]  Controller           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 Controller.\r
  @retval EFI_ALREADY_STARTED  This driver is already running on Controller.\r
  @retval Others               This driver does not support this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6DriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\r
  );\r
\r
/**\r
  Stop this driver on Controller. This service is called by the\r
  EFI boot service DisconnectController(). In order to\r
  make drivers as small as possible, there are calling\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[in]  This              Protocol instance pointer.\r
  @param[in]  Controller        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 Controller.\r
  @retval EFI_DEVICE_ERROR  An unexpected error.\r
  @retval Others            This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6DriverBindingStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN  EFI_HANDLE                  Controller,\r
  IN  UINTN                       NumberOfChildren,\r
  IN  EFI_HANDLE                  *ChildHandleBuffer\r
  );\r
\r
/**\r
  Creates a child handle and installs a protocol.\r
\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
  @param[in]      This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in, out] 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\r
                              UEFI handle, 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 Others                The child handle was not created.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6ServiceBindingCreateChild (\r
  IN     EFI_SERVICE_BINDING_PROTOCOL *This,\r
  IN OUT EFI_HANDLE                   *ChildHandle\r
  );\r
\r
/**\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
  @param[in]  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param[in]  ChildHandle Handle of the child to destroy.\r
\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 not a valid UEFI Handle.\r
  @retval Others                The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Mtftp6ServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                   ChildHandle\r
  );\r
\r
#endif\r