]>
Commit | Line | Data |
---|---|---|
83cbd279 | 1 | /** @file\r |
2 | \r | |
7bce0c5a | 3 | Copyright (c) 2006 - 2008, Intel Corporation\r |
83cbd279 | 4 | All rights reserved. This program and the accompanying materials\r |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | Dhcp4Driver.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Header for the DHCP4 driver\r | |
19 | \r | |
20 | \r | |
21 | **/\r | |
22 | \r | |
23 | #ifndef __EFI_DHCP4_DRIVER_H__\r | |
24 | #define __EFI_DHCP4_DRIVER_H__\r | |
25 | \r | |
26 | extern EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName;\r | |
27 | extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2;\r | |
28 | \r | |
7bce0c5a | 29 | /**\r |
ed729a0c | 30 | Test to see if this driver supports ControllerHandle. This service\r |
31 | is called by the EFI boot service ConnectController(). In\r | |
32 | order to make drivers as small as possible, there are a few calling\r | |
33 | restrictions for this service. ConnectController() must\r | |
34 | follow these calling restrictions. If any other agent wishes to call\r | |
35 | Supported() it must also follow these calling restrictions.\r | |
36 | \r | |
37 | @param This Protocol instance pointer.\r | |
38 | @param ControllerHandle Handle of device to test\r | |
39 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
40 | device to start.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS This driver supports this device\r | |
43 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
44 | @retval other This driver does not support this device\r | |
7bce0c5a | 45 | \r |
46 | **/\r | |
83cbd279 | 47 | EFI_STATUS\r |
48 | EFIAPI\r | |
49 | Dhcp4DriverBindingSupported (\r | |
50 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
51 | IN EFI_HANDLE ControllerHandle,\r | |
52 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
53 | );\r | |
54 | \r | |
7bce0c5a | 55 | /**\r |
ed729a0c | 56 | Start this driver on ControllerHandle. This service is called by the\r |
57 | EFI boot service ConnectController(). In order to make\r | |
58 | drivers as small as possible, there are a few calling restrictions for\r | |
59 | this service. ConnectController() must follow these\r | |
60 | calling restrictions. If any other agent wishes to call Start() it\r | |
61 | must also follow these calling restrictions.\r | |
62 | \r | |
63 | @param This Protocol instance pointer.\r | |
64 | @param ControllerHandle Handle of device to bind driver to\r | |
65 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
66 | device to start.\r | |
67 | \r | |
68 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
69 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
70 | @retval other This driver does not support this device\r | |
7bce0c5a | 71 | \r |
72 | **/\r | |
83cbd279 | 73 | EFI_STATUS\r |
74 | EFIAPI\r | |
75 | Dhcp4DriverBindingStart (\r | |
76 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
77 | IN EFI_HANDLE ControllerHandle,\r | |
78 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
79 | );\r | |
80 | \r | |
7bce0c5a | 81 | /**\r |
ed729a0c | 82 | Stop this driver on ControllerHandle. This service is called by the\r |
83 | EFI boot service DisconnectController(). In order to\r | |
84 | make drivers as small as possible, there are a few calling\r | |
85 | restrictions for this service. DisconnectController()\r | |
86 | must follow these calling restrictions. If any other agent wishes\r | |
87 | to call Stop() it must also follow these calling restrictions.\r | |
88 | \r | |
89 | @param This Protocol instance pointer.\r | |
90 | @param ControllerHandle Handle of device to stop driver on\r | |
91 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
92 | children is zero stop the entire bus driver.\r | |
93 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
94 | \r | |
95 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
96 | @retval other This driver was not removed from this device\r | |
7bce0c5a | 97 | \r |
98 | **/\r | |
83cbd279 | 99 | EFI_STATUS\r |
100 | EFIAPI\r | |
101 | Dhcp4DriverBindingStop (\r | |
102 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
103 | IN EFI_HANDLE ControllerHandle,\r | |
104 | IN UINTN NumberOfChildren,\r | |
105 | IN EFI_HANDLE *ChildHandleBuffer\r | |
106 | );\r | |
107 | \r | |
7bce0c5a | 108 | /**\r |
109 | Creates a child handle with a set of I/O services.\r | |
110 | \r | |
ed729a0c | 111 | @param This Protocol instance pointer.\r |
112 | @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r | |
113 | then a new handle is created. If it is not NULL, then the\r | |
114 | I/O services are added to the existing child handle.\r | |
7bce0c5a | 115 | \r |
ed729a0c | 116 | @retval EFI_SUCCES The child handle was created with the I/O services\r |
117 | @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r | |
118 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r | |
119 | the child\r | |
120 | @retval other The child handle was not created\r | |
7bce0c5a | 121 | \r |
122 | **/\r | |
83cbd279 | 123 | EFI_STATUS\r |
124 | EFIAPI\r | |
125 | Dhcp4ServiceBindingCreateChild (\r | |
126 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
127 | IN EFI_HANDLE *ChildHandle\r | |
128 | );\r | |
129 | \r | |
7bce0c5a | 130 | /**\r |
131 | Destroys a child handle with a set of I/O services.\r | |
132 | \r | |
ed729a0c | 133 | @param This Protocol instance pointer.\r |
134 | @param ChildHandle Handle of the child to destroy\r | |
135 | \r | |
136 | @retval EFI_SUCCES The I/O services were removed from the child handle\r | |
137 | @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r | |
138 | that are being removed.\r | |
139 | @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r | |
140 | @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r | |
141 | I/O services are being used.\r | |
142 | @retval other The child handle was not destroyed\r | |
7bce0c5a | 143 | \r |
144 | **/\r | |
83cbd279 | 145 | EFI_STATUS\r |
146 | EFIAPI\r | |
147 | Dhcp4ServiceBindingDestroyChild (\r | |
148 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
149 | IN EFI_HANDLE ChildHandle\r | |
150 | );\r | |
151 | \r | |
152 | #endif\r |