MdePkg/Include/Protocol/DriverBinding.h

   1 /** @file
   2   EFI ControllerHandle Driver Protocol
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_DRIVER_BINDING_H__
  16 #define __EFI_DRIVER_BINDING_H__
  17
  18 #include <Protocol/DevicePath.h>
  19 //
  20 // Global ID for the ControllerHandle Driver Protocol
  21 //
  22 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
  23   { \
  24     0x18a031ab, 0xb443, 0x4d1a, {0xa5, 0xc0, 0xc, 0x9, 0x26, 0x1e, 0x9f, 0x71 } \
  25   }
  26
  27 typedef struct _EFI_DRIVER_BINDING_PROTOCOL  EFI_DRIVER_BINDING_PROTOCOL;
  28
  29 /**
  30   Test to see if this driver supports ControllerHandle.
  31
  32   @param  This                Protocol instance pointer.
  33   @param  ControllerHandle    Handle of device to test
  34   @param  RemainingDevicePath Optional parameter use to pick a specific child
  35                               device to start.
  36
  37   @retval EFI_SUCCESS         This driver supports this device
  38   @retval EFI_ALREADY_STARTED This driver is already running on this device
  39   @retval other               This driver does not support this device
  40
  41 **/
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *EFI_DRIVER_BINDING_SUPPORTED) (
  45   IN EFI_DRIVER_BINDING_PROTOCOL            *This,
  46   IN EFI_HANDLE                             ControllerHandle,
  47   IN EFI_DEVICE_PATH_PROTOCOL               *RemainingDevicePath OPTIONAL
  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   @retval EFI_SUCCESS          This driver is added to ControllerHandle
  60   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle
  61   @retval other                This driver does not support this device
  62
  63 **/
  64 typedef
  65 EFI_STATUS
  66 (EFIAPI *EFI_DRIVER_BINDING_START) (
  67   IN EFI_DRIVER_BINDING_PROTOCOL            *This,
  68   IN EFI_HANDLE                             ControllerHandle,
  69   IN EFI_DEVICE_PATH_PROTOCOL               *RemainingDevicePath OPTIONAL
  70   )
  71 ;
  72
  73 /**
  74   Stop this driver on ControllerHandle.
  75
  76   @param  This              Protocol instance pointer.
  77   @param  ControllerHandle  Handle of device to stop driver on
  78   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
  79                             children is zero stop the entire bus driver.
  80   @param  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 typedef
  87 EFI_STATUS
  88 (EFIAPI *EFI_DRIVER_BINDING_STOP) (
  89   IN EFI_DRIVER_BINDING_PROTOCOL            *This,
  90   IN  EFI_HANDLE                            ControllerHandle,
  91   IN  UINTN                                 NumberOfChildren,
  92   IN  EFI_HANDLE                            *ChildHandleBuffer OPTIONAL
  93   )
  94 ;
  95
  96 //
  97 // Interface structure for the ControllerHandle Driver Protocol
  98 //
  99 struct _EFI_DRIVER_BINDING_PROTOCOL {
 100   EFI_DRIVER_BINDING_SUPPORTED  Supported;
 101   EFI_DRIVER_BINDING_START      Start;
 102   EFI_DRIVER_BINDING_STOP       Stop;
 103   UINT32                        Version;
 104   EFI_HANDLE                    ImageHandle;
 105   EFI_HANDLE                    DriverBindingHandle;
 106 };
 107
 108 extern EFI_GUID gEfiDriverBindingProtocolGuid;
 109
 110 #endif