NetworkPkg/Dhcp6Dxe/Dhcp6Driver.h

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