MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h

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