NetworkPkg/Dhcp6Dxe/Dhcp6Driver.h

   1 /** @file
   2   Driver Binding functions and Service Binding functions
   3   declaration for Dhcp6 Driver.
   4
   5   Copyright (c) 2009 - 2012, 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_DHCP6_DRIVER_H__
  18 #define __EFI_DHCP6_DRIVER_H__
  19
  20 #include <Protocol/ServiceBinding.h>
  21
  22 extern EFI_COMPONENT_NAME_PROTOCOL  gDhcp6ComponentName;
  23 extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp6ComponentName2;
  24 extern EFI_UNICODE_STRING_TABLE     *gDhcp6ControllerNameTable;
  25
  26 /**
  27   Test to see if this driver supports ControllerHandle. This service
  28   is called by the EFI boot service ConnectController(). In
  29   order to make drivers as small as possible, there are a few calling
  30   restrictions for this service. ConnectController() must
  31   follow these calling restrictions. If any other agent wishes to call
  32   Supported(), it must also follow these calling restrictions.
  33
  34   @param[in]  This                Protocol instance pointer.
  35   @param[in]  ControllerHandle    Handle of device to test.
  36   @param[in]  RemainingDevicePath Optional parameter use to pick a specific child
  37                                   device to start.
  38
  39   @retval EFI_SUCCESS         This driver supports this device.
  40   @retval EFI_ALREADY_STARTED This driver is already running on this device.
  41   @retval other               This driver does not support this device.
  42
  43 **/
  44 EFI_STATUS
  45 EFIAPI
  46 Dhcp6DriverBindingSupported (
  47   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  48   IN EFI_HANDLE                   ControllerHandle,
  49   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  50   );
  51
  52 /**
  53   Start this driver on ControllerHandle. This service is called by the
  54   EFI boot service ConnectController(). In order to make
  55   drivers as small as possible, there are a few calling restrictions for
  56   this service. ConnectController() must follow these
  57   calling restrictions. If any other agent wishes to call Start(), it
  58   must also follow these calling restrictions.
  59
  60   @param[in]  This                 Protocol instance pointer.
  61   @param[in]  ControllerHandle     Handle of device to bind driver to.
  62   @param[in]  RemainingDevicePath  Optional parameter use to pick a specific child
  63                                    device to start.
  64
  65   @retval EFI_SUCCESS          This driver is added to ControllerHandle.
  66   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle.
  67   @retval other                This driver does not support this device.
  68
  69 **/
  70 EFI_STATUS
  71 EFIAPI
  72 Dhcp6DriverBindingStart (
  73   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  74   IN EFI_HANDLE                   ControllerHandle,
  75   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  76   );
  77
  78 /**
  79   Stop this driver on ControllerHandle. This service is called by the
  80   EFI boot service DisconnectController(). In order to
  81   make drivers as small as possible, there are a few calling
  82   restrictions for this service. DisconnectController()
  83   must follow these calling restrictions. If any other agent wishes
  84   to call Stop() it must also follow these calling restrictions.
  85
  86   @param[in]  This              Protocol instance pointer.
  87   @param[in]  ControllerHandle  Handle of device to stop driver on.
  88   @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If the number of
  89                                 children is zero, stop the entire bus driver.
  90   @param[in]  ChildHandleBuffer List of Child Handles to Stop.
  91
  92   @retval EFI_SUCCESS       This driver is removed ControllerHandle.
  93   @retval other             This driver was not removed from this device.
  94
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 Dhcp6DriverBindingStop (
  99   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 100   IN  EFI_HANDLE                   ControllerHandle,
 101   IN  UINTN                        NumberOfChildren,
 102   IN  EFI_HANDLE                   *ChildHandleBuffer      OPTIONAL
 103   );
 104
 105 /**
 106   Creates a child handle and installs a protocol.
 107
 108   The CreateChild() function installs a protocol on ChildHandle.
 109   If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
 110   If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
 111
 112   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
 113   @param  ChildHandle Pointer to the handle of the child to create. If it is NULL,
 114                       then a new handle is created. If it is a pointer to an existing UEFI handle,
 115                       then the protocol is added to the existing UEFI handle.
 116
 117   @retval EFI_SUCCES            The protocol was added to ChildHandle.
 118   @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
 119   @retval EFI_OUT_OF_RESOURCES  There are not enough resources availabe to create
 120                                 the child.
 121   @retval other                 The child handle was not created.
 122
 123 **/
 124 EFI_STATUS
 125 EFIAPI
 126 Dhcp6ServiceBindingCreateChild (
 127   IN     EFI_SERVICE_BINDING_PROTOCOL  *This,
 128   IN OUT EFI_HANDLE                    *ChildHandle
 129   );
 130
 131 /**
 132   Destroys a child handle with a protocol installed on it.
 133
 134   The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
 135   that was installed by CreateChild() from ChildHandle. If the removed protocol is the
 136   last protocol on ChildHandle, then ChildHandle is destroyed.
 137
 138   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
 139   @param  ChildHandle Handle of the child to destroy.
 140
 141   @retval EFI_SUCCES            The protocol was removed from ChildHandle.
 142   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
 143   @retval EFI_INVALID_PARAMETER Child handle is NULL.
 144   @retval EFI_ACCESS_DENIED     The protocol could not be removed from the ChildHandle
 145                                 because its services are being used.
 146   @retval other                 The child handle was not destroyed
 147
 148 **/
 149 EFI_STATUS
 150 EFIAPI
 151 Dhcp6ServiceBindingDestroyChild (
 152   IN EFI_SERVICE_BINDING_PROTOCOL  *This,
 153   IN EFI_HANDLE                    ChildHandle
 154   );
 155
 156 #endif