2 EFI ControllerHandle Driver Protocol
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
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.
13 Module Name: DriverBinding.h
17 #ifndef __EFI_DRIVER_BINDING_H__
18 #define __EFI_DRIVER_BINDING_H__
21 // Global ID for the ControllerHandle Driver Protocol
23 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
25 0x18a031ab, 0xb443, 0x4d1a, {0xa5, 0xc0, 0xc, 0x9, 0x26, 0x1e, 0x9f, 0x71 } \
28 typedef struct _EFI_DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING_PROTOCOL
;
31 Test to see if this driver supports ControllerHandle.
33 @param This Protocol instance pointer.
34 @param ControllerHandle Handle of device to test
35 @param RemainingDevicePath Optional parameter use to pick a specific child
38 @retval EFI_SUCCESS This driver supports this device
39 @retval EFI_ALREADY_STARTED This driver is already running on this device
40 @retval other This driver does not support this device
45 (EFIAPI
*EFI_DRIVER_BINDING_SUPPORTED
) (
46 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
47 IN EFI_HANDLE ControllerHandle
,
48 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
53 Start this driver on ControllerHandle.
55 @param This Protocol instance pointer.
56 @param ControllerHandle Handle of device to bind driver to
57 @param RemainingDevicePath Optional parameter use to pick a specific child
60 @retval EFI_SUCCESS This driver is added to ControllerHandle
61 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
62 @retval other This driver does not support this device
67 (EFIAPI
*EFI_DRIVER_BINDING_START
) (
68 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
69 IN EFI_HANDLE ControllerHandle
,
70 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
75 Stop this driver on ControllerHandle.
77 @param This Protocol instance pointer.
78 @param ControllerHandle Handle of device to stop driver on
79 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
80 children is zero stop the entire bus driver.
81 @param ChildHandleBuffer List of Child Handles to Stop.
83 @retval EFI_SUCCESS This driver is removed ControllerHandle
84 @retval other This driver was not removed from this device
89 (EFIAPI
*EFI_DRIVER_BINDING_STOP
) (
90 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
91 IN EFI_HANDLE ControllerHandle
,
92 IN UINTN NumberOfChildren
,
93 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
98 // Interface structure for the ControllerHandle Driver Protocol
100 struct _EFI_DRIVER_BINDING_PROTOCOL
{
101 EFI_DRIVER_BINDING_SUPPORTED Supported
;
102 EFI_DRIVER_BINDING_START Start
;
103 EFI_DRIVER_BINDING_STOP Stop
;
105 EFI_HANDLE ImageHandle
;
106 EFI_HANDLE DriverBindingHandle
;
109 extern EFI_GUID gEfiDriverBindingProtocolGuid
;