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