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