MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h

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