/** @file\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-\r
-Module Name:\r
-\r
- Dhcp4Driver.c\r
-\r
-Abstract:\r
-\r
-\r
**/\r
\r
#include "Dhcp4Impl.h"\r
\r
Entry point of the DHCP driver to install various protocols.\r
\r
- @param ImageHandle The firmware allocated handle for the UEFI image.\r
- @param SystemTable A pointer to the EFI System Table.\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
follow these calling restrictions. If any other agent wishes to call\r
Supported() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver supports this device\r
@retval EFI_ALREADY_STARTED This driver is already running on this device\r
Configure the default UDP child to receive all the DHCP traffics\r
on this network interface.\r
\r
- @param UdpIo The UDP IO port to configure\r
- @param Context The context to the function\r
+ @param[in] UdpIo The UDP IO port to configure\r
+ @param[in] Context The context to the function\r
\r
@retval EFI_SUCCESS The UDP IO port is successfully configured.\r
@retval Others Failed to configure the UDP child.\r
or partly destroyed. If a resource is destroyed, it is marked as so in\r
case the destroy failed and being called again later.\r
\r
- @param DhcpSb The DHCP service instance to destory.\r
+ @param[in] DhcpSb The DHCP service instance to destory.\r
\r
@retval EFI_SUCCESS Always return success.\r
\r
/**\r
Create a new DHCP service binding instance for the controller.\r
\r
- @param Controller The controller to install DHCP service binding\r
- protocol onto\r
- @param ImageHandle The driver's image handle\r
- @param Service The variable to receive the created DHCP service\r
- instance.\r
+ @param[in] Controller The controller to install DHCP service binding\r
+ protocol onto\r
+ @param[in] ImageHandle The driver's image handle\r
+ @param[out] Service The variable to receive the created DHCP service\r
+ instance.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource .\r
@retval EFI_SUCCESS The DHCP service instance is created.\r
calling restrictions. If any other agent wishes to call Start() it\r
must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
\r
@retval EFI_SUCCESS This driver is added to ControllerHandle\r
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
must follow these calling restrictions. If any other agent wishes\r
to call Stop() it must also follow these calling restrictions.\r
\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
- children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
\r
@retval EFI_SUCCESS This driver is removed ControllerHandle\r
@retval other This driver was not removed from this device\r
@param DhcpSb The dhcp service instance\r
@param Instance The dhcp instance to initialize\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpInitProtocol (\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
+ \r
+ The CreateChild() function installs a protocol on ChildHandle. \r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. \r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is not NULL, then the\r
- I/O services are added to the existing child handle.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle, \r
+ then the protocol is added to the existing UEFI handle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
the child\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+ \r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed.\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
- I/O services are being used.\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
@retval other The child handle was not destroyed\r
\r
**/\r
projects / mirror_edk2.git / blobdiff