]>
Commit | Line | Data |
---|---|---|
83cbd279 | 1 | /** @file\r |
3e8c18da | 2 | Header for the DHCP4 driver.\r |
3 | \r | |
284ee2e8 | 4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
83cbd279 | 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 | |
83cbd279 | 13 | **/\r |
14 | \r | |
15 | #ifndef __EFI_DHCP4_DRIVER_H__\r | |
16 | #define __EFI_DHCP4_DRIVER_H__\r | |
17 | \r | |
18 | extern EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName;\r | |
19 | extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2;\r | |
20 | \r | |
7bce0c5a | 21 | /**\r |
ed729a0c | 22 | Test to see if this driver supports ControllerHandle. This service\r |
23 | is called by the EFI boot service ConnectController(). In\r | |
24 | order to make drivers as small as possible, there are a few calling\r | |
25 | restrictions for this service. ConnectController() must\r | |
26 | follow these calling restrictions. If any other agent wishes to call\r | |
27 | Supported() it must also follow these calling restrictions.\r | |
28 | \r | |
3e8c18da | 29 | @param[in] This Protocol instance pointer.\r |
30 | @param[in] ControllerHandle Handle of device to test\r | |
31 | @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r | |
32 | device to start.\r | |
ed729a0c | 33 | \r |
34 | @retval EFI_SUCCESS This driver supports this device\r | |
35 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
36 | @retval other This driver does not support this device\r | |
7bce0c5a | 37 | \r |
38 | **/\r | |
83cbd279 | 39 | EFI_STATUS\r |
40 | EFIAPI\r | |
41 | Dhcp4DriverBindingSupported (\r | |
42 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
43 | IN EFI_HANDLE ControllerHandle,\r | |
44 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
45 | );\r | |
46 | \r | |
7bce0c5a | 47 | /**\r |
ed729a0c | 48 | Start this driver on ControllerHandle. This service is called by the\r |
49 | EFI boot service ConnectController(). In order to make\r | |
50 | drivers as small as possible, there are a few calling restrictions for\r | |
51 | this service. ConnectController() must follow these\r | |
52 | calling restrictions. If any other agent wishes to call Start() it\r | |
53 | must also follow these calling restrictions.\r | |
54 | \r | |
3e8c18da | 55 | @param[in] This Protocol instance pointer.\r |
56 | @param[in] ControllerHandle Handle of device to bind driver to\r | |
57 | @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r | |
58 | device to start.\r | |
ed729a0c | 59 | \r |
60 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
61 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
62 | @retval other This driver does not support this device\r | |
7bce0c5a | 63 | \r |
64 | **/\r | |
83cbd279 | 65 | EFI_STATUS\r |
66 | EFIAPI\r | |
67 | Dhcp4DriverBindingStart (\r | |
68 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
69 | IN EFI_HANDLE ControllerHandle,\r | |
70 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
71 | );\r | |
72 | \r | |
7bce0c5a | 73 | /**\r |
ed729a0c | 74 | Stop this driver on ControllerHandle. This service is called by the\r |
75 | EFI boot service DisconnectController(). In order to\r | |
76 | make drivers as small as possible, there are a few calling\r | |
77 | restrictions for this service. DisconnectController()\r | |
78 | must follow these calling restrictions. If any other agent wishes\r | |
79 | to call Stop() it must also follow these calling restrictions.\r | |
80 | \r | |
3e8c18da | 81 | @param[in] This Protocol instance pointer.\r |
82 | @param[in] ControllerHandle Handle of device to stop driver on\r | |
83 | @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
84 | children is zero stop the entire bus driver.\r | |
85 | @param[in] ChildHandleBuffer List of Child Handles to Stop.\r | |
ed729a0c | 86 | \r |
87 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
88 | @retval other This driver was not removed from this device\r | |
7bce0c5a | 89 | \r |
90 | **/\r | |
83cbd279 | 91 | EFI_STATUS\r |
92 | EFIAPI\r | |
93 | Dhcp4DriverBindingStop (\r | |
94 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
95 | IN EFI_HANDLE ControllerHandle,\r | |
96 | IN UINTN NumberOfChildren,\r | |
97 | IN EFI_HANDLE *ChildHandleBuffer\r | |
98 | );\r | |
99 | \r | |
7bce0c5a | 100 | /**\r |
3e8c18da | 101 | Creates a child handle and installs a protocol.\r |
102 | \r | |
103 | The CreateChild() function installs a protocol on ChildHandle. \r | |
104 | If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r | |
105 | If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r | |
7bce0c5a | 106 | \r |
3e8c18da | 107 | @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r |
108 | @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r | |
109 | then a new handle is created. If it is a pointer to an existing UEFI handle, \r | |
110 | then the protocol is added to the existing UEFI handle.\r | |
7bce0c5a | 111 | \r |
3e8c18da | 112 | @retval EFI_SUCCES The protocol was added to ChildHandle.\r |
ed729a0c | 113 | @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r |
114 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r | |
115 | the child\r | |
116 | @retval other The child handle was not created\r | |
7bce0c5a | 117 | \r |
118 | **/\r | |
83cbd279 | 119 | EFI_STATUS\r |
120 | EFIAPI\r | |
121 | Dhcp4ServiceBindingCreateChild (\r | |
122 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
123 | IN EFI_HANDLE *ChildHandle\r | |
124 | );\r | |
125 | \r | |
7bce0c5a | 126 | /**\r |
3e8c18da | 127 | Destroys a child handle with a protocol installed on it.\r |
128 | \r | |
129 | The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r | |
130 | that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r | |
131 | last protocol on ChildHandle, then ChildHandle is destroyed.\r | |
7bce0c5a | 132 | \r |
3e8c18da | 133 | @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r |
ed729a0c | 134 | @param ChildHandle Handle of the child to destroy\r |
135 | \r | |
3e8c18da | 136 | @retval EFI_SUCCES The protocol was removed from ChildHandle.\r |
137 | @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r | |
284ee2e8 | 138 | @retval EFI_INVALID_PARAMETER Child handle is NULL.\r |
3e8c18da | 139 | @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r |
140 | because its services are being used.\r | |
ed729a0c | 141 | @retval other The child handle was not destroyed\r |
7bce0c5a | 142 | \r |
143 | **/\r | |
83cbd279 | 144 | EFI_STATUS\r |
145 | EFIAPI\r | |
146 | Dhcp4ServiceBindingDestroyChild (\r | |
147 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
148 | IN EFI_HANDLE ChildHandle\r | |
149 | );\r | |
150 | \r | |
151 | #endif\r |