MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h

   1 /** @file
   2
   3 Copyright (c) 2007, 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   PxeBcDriver.h
  15
  16 Abstract:
  17
  18
  19 **/
  20
  21 #ifndef __EFI_PXEBC_DRIVER_H__
  22 #define __EFI_PXEBC_DRIVER_H__
  23
  24 EFI_STATUS
  25 PxeBcDriverBindingSupported (
  26   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  27   IN EFI_HANDLE                   Controller,
  28   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  29   )
  30 /*++
  31
  32   Routine Description:
  33     Test to see if this driver supports ControllerHandle.
  34
  35   Arguments:
  36     This                - Protocol instance pointer.
  37     ControllerHandle    - Handle of device to test
  38     RemainingDevicePath - Optional parameter use to pick a specific child
  39                           device to start.
  40
  41   Returns:
  42     EFI_SUCCES
  43     EFI_ALREADY_STARTED
  44     Others
  45
  46 --*/
  47 // GC_NOTO:    Controller - add argument and description to function comment
  48 ;
  49
  50
  51 /**
  52   Start this driver on ControllerHandle.
  53
  54   @param  This                 Protocol instance pointer.
  55   @param  ControllerHandle     Handle of device to bind driver to
  56   @param  RemainingDevicePath  Optional parameter use to pick a specific child
  57                                device to start.
  58
  59   @return EFI_SUCCES
  60   @return EFI_ALREADY_STARTED
  61   @return EFI_OUT_OF_RESOURCES
  62   @return Others
  63
  64 **/
  65 // GC_NOTO:    Controller - add argument and description to function comment
  66 EFI_STATUS
  67 PxeBcDriverBindingStart (
  68   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  69   IN EFI_HANDLE                   Controller,
  70   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  71   )
  72 ;
  73
  74
  75 /**
  76   Stop this driver on ControllerHandle.
  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   @return EFI_SUCCESS
  85   @return EFI_DEVICE_ERROR
  86   @return Others
  87
  88 **/
  89 // GC_NOTO:    Controller - add argument and description to function comment
  90 EFI_STATUS
  91 PxeBcDriverBindingStop (
  92   IN  EFI_DRIVER_BINDING_PROTOCOL *This,
  93   IN  EFI_HANDLE                  Controller,
  94   IN  UINTN                       NumberOfChildren,
  95   IN  EFI_HANDLE                  *ChildHandleBuffer
  96   )
  97 ;
  98
  99 extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2;
 100 extern EFI_COMPONENT_NAME_PROTOCOL  gPxeBcComponentName;
 101 extern EFI_DRIVER_BINDING_PROTOCOL  gPxeBcDriverBinding;
 102 #endif
 103