| 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 |
| 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_SUCCES 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 |
| 83cbd279 |
42 | EFI_STATUS\r |
| 43 | EFIAPI\r |
| 44 | Dhcp4DriverBindingSupported (\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 |
| 7bce0c5a |
50 | /**\r |
| 51 | Start this driver on ControllerHandle.\r |
| 52 | \r |
| 53 | @param This Protocol instance pointer.\r |
| 54 | @param ControllerHandle Handle of device to bind driver to\r |
| 55 | @param RemainingDevicePath Optional parameter use to pick a specific child\r |
| 56 | device to start.\r |
| 57 | \r |
| 58 | @retval EFI_SUCCES This driver is added to ControllerHandle\r |
| 59 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r |
| 60 | @retval other This driver does not support this device\r |
| 61 | \r |
| 62 | **/\r |
| 83cbd279 |
63 | EFI_STATUS\r |
| 64 | EFIAPI\r |
| 65 | Dhcp4DriverBindingStart (\r |
| 66 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
| 67 | IN EFI_HANDLE ControllerHandle,\r |
| 68 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r |
| 69 | );\r |
| 70 | \r |
| 7bce0c5a |
71 | /**\r |
| 72 | Stop this driver on ControllerHandle.\r |
| 73 | \r |
| 74 | @param This Protocol instance pointer.\r |
| 75 | @param ControllerHandle Handle of device to stop driver on\r |
| 76 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r |
| 77 | of children is zero stop the entire bus driver.\r |
| 78 | @param ChildHandleBuffer List of Child Handles to Stop.\r |
| 79 | \r |
| 80 | @retval EFI_SUCCES This driver is removed ControllerHandle\r |
| 81 | @retval other This driver was not removed from this device\r |
| 82 | \r |
| 83 | **/\r |
| 83cbd279 |
84 | EFI_STATUS\r |
| 85 | EFIAPI\r |
| 86 | Dhcp4DriverBindingStop (\r |
| 87 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
| 88 | IN EFI_HANDLE ControllerHandle,\r |
| 89 | IN UINTN NumberOfChildren,\r |
| 90 | IN EFI_HANDLE *ChildHandleBuffer\r |
| 91 | );\r |
| 92 | \r |
| 7bce0c5a |
93 | /**\r |
| 94 | Creates a child handle with a set of I/O services.\r |
| 95 | \r |
| 96 | @param This Protocol instance pointer.\r |
| 97 | @param ChildHandle Pointer to the handle of the child to create. If\r |
| 98 | it is NULL, then a new handle is created. If it is\r |
| 99 | not NULL, then the I/O services are added to the\r |
| 100 | existing child handle.\r |
| 101 | \r |
| 102 | @retval EFI_SUCCES The child handle was created with the I/O\r |
| 103 | services.\r |
| 104 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r |
| 105 | the child.\r |
| 106 | @retval other The child handle was not created.\r |
| 107 | \r |
| 108 | **/\r |
| 83cbd279 |
109 | EFI_STATUS\r |
| 110 | EFIAPI\r |
| 111 | Dhcp4ServiceBindingCreateChild (\r |
| 112 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r |
| 113 | IN EFI_HANDLE *ChildHandle\r |
| 114 | );\r |
| 115 | \r |
| 7bce0c5a |
116 | /**\r |
| 117 | Destroys a child handle with a set of I/O services.\r |
| 118 | \r |
| 119 | @param This Protocol instance pointer.\r |
| 120 | @param ChildHandle Handle of the child to destroy.\r |
| 121 | \r |
| 122 | @retval EFI_SUCCES The I/O services were removed from the child\r |
| 123 | handle.\r |
| 124 | @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r |
| 125 | that are being removed.\r |
| 126 | @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r |
| 127 | @retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r |
| 128 | its I/O services are being used.\r |
| 129 | @retval other The child handle was not destroyed.\r |
| 130 | \r |
| 131 | **/\r |
| 83cbd279 |
132 | EFI_STATUS\r |
| 133 | EFIAPI\r |
| 134 | Dhcp4ServiceBindingDestroyChild (\r |
| 135 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r |
| 136 | IN EFI_HANDLE ChildHandle\r |
| 137 | );\r |
| 138 | \r |
| 139 | #endif\r |
projects / mirror_edk2.git / blame