MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h

   1 /** @file
   2
   3 Copyright (c) 2007, Intel Corporation.<BR>
   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 **/
  13
  14 #ifndef __EFI_PXEBC_DRIVER_H__
  15 #define __EFI_PXEBC_DRIVER_H__
  16
  17 /**
  18   Test to see if this driver supports ControllerHandle. This service
  19   is called by the EFI boot service ConnectController(). In
  20   order to make drivers as small as possible, there are a few calling
  21   restrictions for this service. ConnectController() must
  22   follow these calling restrictions. If any other agent wishes to call
  23   Supported() it must also follow these calling restrictions.
  24   PxeBc requires DHCP4 and MTFTP4 protocols.
  25
  26   @param  This                Protocol instance pointer.
  27   @param  ControllerHandle    Handle of device to test
  28   @param  RemainingDevicePath Optional parameter use to pick a specific child
  29                               device to start.
  30
  31   @retval EFI_SUCCESS         This driver supports this device
  32   @retval EFI_ALREADY_STARTED This driver is already running on this device
  33   @retval other               This driver does not support this device
  34
  35 **/
  36 EFI_STATUS
  37 EFIAPI
  38 PxeBcDriverBindingSupported (
  39   IN EFI_DRIVER_BINDING_PROTOCOL  * This,
  40   IN EFI_HANDLE                   ControllerHandle,
  41   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
  42   );
  43
  44 /**
  45   Start this driver on ControllerHandle. This service is called by the
  46   EFI boot service ConnectController(). In order to make
  47   drivers as small as possible, there are a few calling restrictions for
  48   this service. ConnectController() must follow these
  49   calling restrictions. If any other agent wishes to call Start() it
  50   must also follow these calling restrictions.
  51
  52   @param  This                 Protocol instance pointer.
  53   @param  ControllerHandle     Handle of device to bind driver to
  54   @param  RemainingDevicePath  Optional parameter use to pick a specific child
  55                                device to start.
  56
  57   @retval EFI_SUCCESS          This driver is added to ControllerHandle
  58   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle
  59   @retval other                This driver does not support this device
  60
  61 **/
  62 EFI_STATUS
  63 EFIAPI
  64 PxeBcDriverBindingStart (
  65   IN EFI_DRIVER_BINDING_PROTOCOL  * This,
  66   IN EFI_HANDLE                   ControllerHandle,
  67   IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL
  68   );
  69
  70 /**
  71   Stop this driver on ControllerHandle. This service is called by the
  72   EFI boot service DisconnectController(). In order to
  73   make drivers as small as possible, there are a few calling
  74   restrictions for this service. DisconnectController()
  75   must follow these calling restrictions. If any other agent wishes
  76   to call Stop() it must also follow these calling restrictions.
  77
  78   @param  This              Protocol instance pointer.
  79   @param  ControllerHandle  Handle of device to stop driver on
  80   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
  81                             children is zero stop the entire bus driver.
  82   @param  ChildHandleBuffer List of Child Handles to Stop.
  83
  84   @retval EFI_SUCCESS       This driver is removed ControllerHandle
  85   @retval other             This driver was not removed from this device
  86
  87 **/
  88 EFI_STATUS
  89 EFIAPI
  90 PxeBcDriverBindingStop (
  91   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  92   IN EFI_HANDLE                   ControllerHandle,
  93   IN UINTN                        NumberOfChildren,
  94   IN EFI_HANDLE                   *ChildHandleBuffer
  95   );
  96
  97 extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2;
  98 extern EFI_COMPONENT_NAME_PROTOCOL  gPxeBcComponentName;
  99 extern EFI_DRIVER_BINDING_PROTOCOL  gPxeBcDriverBinding;
 100
 101 #endif
 102