Driver Binding functions and Service Binding functions declaration for Dhcp6 Driver.
Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file Dhcp6Driver.h.
Start this driver on ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Start(), it must also follow these calling restrictions.
- Parameters
-
[in] | This | Protocol instance pointer. |
[in] | ControllerHandle | Handle of device to bind driver to. |
[in] | RemainingDevicePath | Optional parameter use to pick a specific child device to start. |
- Return values
-
EFI_SUCCESS | This driver is added to ControllerHandle. |
EFI_ALREADY_STARTED | This driver is already running on ControllerHandle. |
other | This driver does not support this device. |
Start this driver on ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Start() it must also follow these calling restrictions.
- Parameters
-
[in] | This | The pointer to the driver binding protocol. |
[in] | ControllerHandle | The handle of device to be started. |
[in] | RemainingDevicePath | Optional parameter use to pick a specific child device to be started. |
- Return values
-
EFI_SUCCESS | This driver is installed to ControllerHandle. |
EFI_ALREADY_STARTED | This driver is already running on ControllerHandle. |
other | This driver does not support this device. |
Definition at line 438 of file Dhcp6Driver.c.
Stop this driver on ControllerHandle. This service is called by the EFI boot service DisconnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. DisconnectController() must follow these calling restrictions. If any other agent wishes to call Stop() it must also follow these calling restrictions.
- Parameters
-
[in] | This | Protocol instance pointer. |
[in] | ControllerHandle | Handle of device to stop driver on. |
[in] | NumberOfChildren | Number of Handles in ChildHandleBuffer. If the number of children is zero, stop the entire bus driver. |
[in] | ChildHandleBuffer | List of Child Handles to Stop. |
- Return values
-
EFI_SUCCESS | This driver is removed ControllerHandle. |
other | This driver was not removed from this device. |
Stop this driver on ControllerHandle. This service is called by the EFI boot service DisconnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. DisconnectController() must follow these calling restrictions. If any other agent wishes to call Stop() it must also follow these calling restrictions.
- Parameters
-
[in] | This | Protocol instance pointer. |
[in] | ControllerHandle | Handle of device to stop driver on |
[in] | NumberOfChildren | Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver. |
[in] | ChildHandleBuffer | List of Child Handles to Stop. |
- Return values
-
EFI_SUCCESS | This driver is removed ControllerHandle |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. |
other | This driver was not removed from this device |
Definition at line 514 of file Dhcp6Driver.c.
Test to see if this driver supports ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported(), it must also follow these calling restrictions.
- Parameters
-
[in] | This | Protocol instance pointer. |
[in] | ControllerHandle | Handle of device to test. |
[in] | RemainingDevicePath | Optional parameter use to pick a specific child device to start. |
- Return values
-
EFI_SUCCESS | This driver supports this device. |
EFI_ALREADY_STARTED | This driver is already running on this device. |
other | This driver does not support this device. |
Test to see if this driver supports ControllerHandle. This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported() it must also follow these calling restrictions.
- Parameters
-
[in] | This | The pointer to the driver binding protocol. |
[in] | ControllerHandle | The handle of device to be tested. |
[in] | RemainingDevicePath | Optional parameter use to pick a specific child device to be started. |
- Return values
-
EFI_SUCCESS | This driver supports this device. |
Others | This driver does not support this device. |
Definition at line 402 of file Dhcp6Driver.c.
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- Parameters
-
This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
ChildHandle | Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. |
- Return values
-
EFI_SUCCESS | The protocol was added to ChildHandle. |
EFI_INVALID_PARAMETER | ChildHandle is NULL. |
EFI_OUT_OF_RESOURCES | There are not enough resources available to create the child. |
other | The child handle was not created. |
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle. If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
- Parameters
-
[in] | This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
[in,out] | ChildHandle | Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is a pointer to an existing UEFI handle, then the protocol is added to the existing UEFI handle. |
- Return values
-
EFI_SUCCESS | The protocol was added to ChildHandle. |
EFI_INVALID_PARAMETER | ChildHandle is NULL. |
other | The child handle was not created. |
Definition at line 611 of file Dhcp6Driver.c.
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
- Parameters
-
This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
ChildHandle | Handle of the child to destroy. |
- Return values
-
EFI_SUCCESS | The protocol was removed from ChildHandle. |
EFI_UNSUPPORTED | ChildHandle does not support the protocol that is being removed. |
EFI_INVALID_PARAMETER | Child handle is NULL. |
EFI_ACCESS_DENIED | The protocol could not be removed from the ChildHandle because its services are being used. |
other | The child handle was not destroyed |
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol that was installed by CreateChild() from ChildHandle. If the removed protocol is the last protocol on ChildHandle, then ChildHandle is destroyed.
- Parameters
-
[in] | This | Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. |
[in] | ChildHandle | Handle of the child to destroy |
- Return values
-
EFI_SUCCESS | The protocol was removed from ChildHandle. |
EFI_UNSUPPORTED | ChildHandle does not support the protocol that is being removed. |
EFI_INVALID_PARAMETER | Child handle is NULL. |
EFI_ACCESS_DENIED | The protocol could not be removed from the ChildHandle because its services are being used. |
other | The child handle was not destroyed |
Definition at line 724 of file Dhcp6Driver.c.