NetworkPkg/UefiPxeBcDxe/PxeBcDriver.h

   1 /** @file
   2   Driver Binding functions declaration for UefiPxeBc Driver.
   3
   4   Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php.
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __EFI_PXEBC_DRIVER_H__
  17 #define __EFI_PXEBC_DRIVER_H__
  18
  19 extern EFI_COMPONENT_NAME_PROTOCOL  gPxeBcComponentName;
  20 extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2;
  21
  22 /**
  23   Test to see if this driver supports ControllerHandle. This service
  24   is called by the EFI boot service ConnectController(). In
  25   order to make drivers as small as possible, there are a few calling
  26   restrictions for this service. ConnectController() must
  27   follow these calling restrictions. If any other agent wishes to call
  28   Supported() it must also follow these calling restrictions.
  29
  30   @param[in]  This                The pointer to the driver binding protocol.
  31   @param[in]  ControllerHandle    The handle of device to be tested.
  32   @param[in]  RemainingDevicePath Optional parameter use to pick a specific child
  33                                   device to be started.
  34
  35   @retval EFI_SUCCESS         This driver supports this device.
  36   @retval EFI_UNSUPPORTED     This driver does not support this device.
  37
  38 **/
  39 EFI_STATUS
  40 EFIAPI
  41 PxeBcDriverBindingSupported (
  42   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  43   IN EFI_HANDLE                   ControllerHandle,
  44   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  45   );
  46
  47
  48 /**
  49   Start this driver on ControllerHandle. This service is called by the
  50   EFI boot service ConnectController(). In order to make
  51   drivers as small as possible, there are a few calling restrictions for
  52   this service. ConnectController() must follow these
  53   calling restrictions. If any other agent wishes to call Start() it
  54   must also follow these calling restrictions.
  55
  56   @param[in]  This                 The pointer to the driver binding protocol.
  57   @param[in]  ControllerHandle     The handle of device to be started.
  58   @param[in]  RemainingDevicePath  Optional parameter used to pick a specific child
  59                                    device to be started.
  60
  61   @retval EFI_SUCCESS          This driver is installed to ControllerHandle.
  62   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle.
  63   @retval other                This driver does not support this device.
  64
  65 **/
  66 EFI_STATUS
  67 EFIAPI
  68 PxeBcDriverBindingStart (
  69   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  70   IN EFI_HANDLE                   ControllerHandle,
  71   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  72   );
  73
  74
  75 /**
  76   Stop this driver on ControllerHandle. This service is called by the
  77   EFI boot service DisconnectController(). In order to
  78   make drivers as small as possible, there are a few calling
  79   restrictions for this service. DisconnectController()
  80   must follow these calling restrictions. If any other agent wishes
  81   to call Stop() it must also follow these calling restrictions.
  82
  83   @param[in]  This              Protocol instance pointer.
  84   @param[in]  ControllerHandle  Handle of device to stop driver on
  85   @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
  86                                 children is zero stop the entire bus driver.
  87   @param[in]  ChildHandleBuffer List of Child Handles to Stop.
  88
  89   @retval EFI_SUCCESS           This driver is removed ControllerHandle
  90   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.
  91   @retval Others                This driver was not removed from this device.
  92
  93 **/
  94 EFI_STATUS
  95 EFIAPI
  96 PxeBcDriverBindingStop (
  97   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  98   IN EFI_HANDLE                   ControllerHandle,
  99   IN UINTN                        NumberOfChildren,
 100   IN EFI_HANDLE                   *ChildHandleBuffer
 101   );
 102
 103 #endif
 104