NetworkPkg/Mtftp6Dxe/Mtftp6Driver.h

   1 /** @file
   2   Driver Binding functions and Service Binding functions
   3   declaration for Mtftp6 Driver.
   4
   5   Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
   6
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php.
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __EFI_MTFTP6_DRIVER_H__
  18 #define __EFI_MTFTP6_DRIVER_H__
  19
  20 #include <Protocol/ServiceBinding.h>
  21
  22 extern EFI_COMPONENT_NAME_PROTOCOL  gMtftp6ComponentName;
  23 extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;
  24
  25 /**
  26   Test to see if this driver supports ControllerHandle. This service
  27   is called by the EFI boot service ConnectController(). In
  28   order to make drivers as small as possible, there are a few calling
  29   restrictions for this service. ConnectController() must
  30   follow these calling restrictions. If any other agent wishes to call
  31   Supported(), it must also follow these calling restrictions.
  32
  33   @param[in]  This                Protocol instance pointer.
  34   @param[in]  ControllerHandle    Handle of device to test.
  35   @param[in]  RemainingDevicePath Optional parameter use to pick a specific child
  36                                   device to start.
  37
  38   @retval EFI_SUCCESS         This driver supports this device.
  39   @retval Others              This driver does not support this device.
  40
  41 **/
  42 EFI_STATUS
  43 EFIAPI
  44 Mtftp6DriverBindingSupported (
  45   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  46   IN EFI_HANDLE                   Controller,
  47   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  48   );
  49
  50 /**
  51   Start this driver on ControllerHandle. This service is called by the
  52   EFI boot service ConnectController(). In order to make
  53   drivers as small as possible, there are calling restrictions for
  54   this service. ConnectController() must follow these
  55   calling restrictions. If any other agent wishes to call Start() it
  56   must also follow these calling restrictions.
  57
  58   @param[in]  This                 Protocol instance pointer.
  59   @param[in]  ControllerHandle     Handle of device to bind driver to.
  60   @param[in]  RemainingDevicePath  Optional parameter use to pick a specific child
  61                                    device to start.
  62
  63   @retval EFI_SUCCESS          This driver is added to ControllerHandle.
  64   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle.
  65   @retval Others               This driver does not support this device.
  66
  67 **/
  68 EFI_STATUS
  69 EFIAPI
  70 Mtftp6DriverBindingStart (
  71   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  72   IN EFI_HANDLE                   Controller,
  73   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  74   );
  75
  76 /**
  77   Stop this driver on ControllerHandle. This service is called by the
  78   EFI boot service DisconnectController(). In order to
  79   make drivers as small as possible, there are calling
  80   restrictions for this service. DisconnectController()
  81   must follow these calling restrictions. If any other agent wishes
  82   to call Stop(), it must also follow these calling restrictions.
  83
  84   @param[in]  This              Protocol instance pointer.
  85   @param[in]  ControllerHandle  Handle of device to stop driver on
  86   @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
  87                                 children is zero, stop the entire bus driver.
  88   @param[in]  ChildHandleBuffer List of Child Handles to Stop.
  89
  90   @retval EFI_SUCCESS       This driver is removed ControllerHandle.
  91   @retval EFI_DEVICE_ERROR  An unexpected error.
  92   @retval Others            This driver was not removed from this device.
  93
  94 **/
  95 EFI_STATUS
  96 EFIAPI
  97 Mtftp6DriverBindingStop (
  98   IN  EFI_DRIVER_BINDING_PROTOCOL *This,
  99   IN  EFI_HANDLE                  Controller,
 100   IN  UINTN                       NumberOfChildren,
 101   IN  EFI_HANDLE                  *ChildHandleBuffer
 102   );
 103
 104 /**
 105   Creates a child handle and installs a protocol.
 106
 107   The CreateChild() function installs a protocol on ChildHandle.
 108   If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
 109   If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
 110
 111   @param[in]      This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
 112   @param[in, out] ChildHandle Pointer to the handle of the child to create. If it is NULL,
 113                               then a new handle is created. If it is a pointer to an existing
 114                               UEFI handle, then the protocol is added to the existing UEFI handle.
 115
 116   @retval EFI_SUCCES            The protocol was added to ChildHandle.
 117   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
 118   @retval Others                The child handle was not created.
 119
 120 **/
 121 EFI_STATUS
 122 EFIAPI
 123 Mtftp6ServiceBindingCreateChild (
 124   IN     EFI_SERVICE_BINDING_PROTOCOL *This,
 125   IN OUT EFI_HANDLE                   *ChildHandle
 126   );
 127
 128 /**
 129   Destroys a child handle with a protocol installed on it.
 130
 131   The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
 132   that was installed by CreateChild() from ChildHandle. If the removed protocol is the
 133   last protocol on ChildHandle, then ChildHandle is destroyed.
 134
 135   @param[in]  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
 136   @param[in]  ChildHandle Handle of the child to destroy.
 137
 138   @retval EFI_SUCCES            The protocol was removed from ChildHandle.
 139   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
 140   @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.
 141   @retval Others                The child handle was not destroyed
 142
 143 **/
 144 EFI_STATUS
 145 EFIAPI
 146 Mtftp6ServiceBindingDestroyChild (
 147   IN EFI_SERVICE_BINDING_PROTOCOL *This,
 148   IN EFI_HANDLE                   ChildHandle
 149   );
 150
 151 #endif