/** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+ EFI DHCP protocol implementation.\r
+ \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
-Module Name:\r
-\r
- Dhcp4Io.c\r
-\r
-Abstract:\r
-\r
- EFI DHCP protocol implementation\r
-\r
-\r
**/\r
\r
\r
Send an initial DISCOVER or REQUEST message according to the\r
DHCP service's current state.\r
\r
- @param DhcpSb The DHCP service instance\r
+ @param[in] DhcpSb The DHCP service instance\r
\r
@retval EFI_SUCCESS The request has been sent\r
@retval other Some error occurs when sending the request.\r
proper return value is selected to let the caller continue the\r
normal process.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Event The event as defined in the spec\r
- @param Packet The current packet trigger the event\r
- @param NewPacket The user's return new packet\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Event The event as defined in the spec\r
+ @param[in] Packet The current packet trigger the event\r
+ @param[out] NewPacket The user's return new packet\r
\r
@retval EFI_NOT_READY Direct the caller to continue collecting the offer.\r
@retval EFI_SUCCESS The user function returns success.\r
@param DhcpSb DHCP service instance\r
@param Which Which notify function to signal\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpNotifyUser (\r
\r
@param DhcpSb The DHCP service instance.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpSetTransmitTimer (\r
\r
@param DhcpSb The DHCP service instance\r
@param Para The DHCP parameter extracted from the server's\r
- response.\r
-\r
- @return None\r
-\r
+ response. \r
**/\r
VOID\r
DhcpComputeLease (\r
DHCP driver needs this port to unicast packet to the server\r
such as DHCP release.\r
\r
- @param UdpIo The UDP IO port to configure\r
- @param Context Dhcp service instance.\r
+ @param[in] UdpIo The UDP IO port to configure\r
+ @param[in] Context Dhcp service instance.\r
\r
@retval EFI_SUCCESS The UDP IO port is successfully configured.\r
@retval Others It failed to configure the port.\r
\r
@param DhcpSb The DHCP instance service.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpCleanLease (\r
of BOOTP, the lease is recorded and user notified. If the offer is of\r
DHCP, it will request the offer from the server.\r
\r
- @param DhcpSb The DHCP service instance.\r
+ @param[in] DhcpSb The DHCP service instance.\r
\r
@retval EFI_SUCCESS One of the offer is selected.\r
\r
to this is: only call DhcpEndSession at the highest level, such as\r
DhcpInput, DhcpOnTimerTick...At the other level, just return error.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Status The result of the DHCP process.\r
-\r
- @return None\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Status The result of the DHCP process.\r
\r
**/\r
VOID\r
/**\r
Handle packets in DHCP select state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP request state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP renew/rebound state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
/**\r
Handle packets in DHCP reboot state.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Packet The DHCP packet received\r
- @param Para The DHCP parameter extracted from the packet. That\r
- is, all the option value that we care.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Packet The DHCP packet received\r
+ @param[in] Para The DHCP parameter extracted from the packet. That\r
+ is, all the option value that we care.\r
\r
@retval EFI_SUCCESS The packet is successfully processed.\r
@retval Others Some error occured.\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpInput (\r
/**\r
Release the packet.\r
\r
- @param Arg The packet to release\r
-\r
- @return None\r
+ @param[in] Arg The packet to release\r
\r
**/\r
VOID\r
@param IoStatus The status of the UDP receive\r
@param Context The opaque parameter to the function.\r
\r
- @return None\r
-\r
**/\r
VOID\r
DhcpOnPacketSent (\r
the state (as defined in Figure 5. of the same RFC) before sending\r
a DHCP message. The table is adjusted accordingly.\r
\r
- @param DhcpSb The DHCP service instance\r
- @param Seed The seed packet which the new packet is based on\r
- @param Para The DHCP parameter of the Seed packet\r
- @param Type The message type to send\r
- @param Msg The human readable message to include in the packet\r
- sent.\r
+ @param[in] DhcpSb The DHCP service instance\r
+ @param[in] Seed The seed packet which the new packet is based on\r
+ @param[in] Para The DHCP parameter of the Seed packet\r
+ @param[in] Type The message type to send\r
+ @param[in] Msg The human readable message to include in the packet\r
+ sent.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet\r
@retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP\r
Retransmit a saved packet. Only DISCOVER and REQUEST messages\r
will be retransmitted.\r
\r
- @param DhcpSb The DHCP service instance\r
+ @param[in] DhcpSb The DHCP service instance\r
\r
@retval EFI_ACCESS_DENIED Failed to transmit packet through UDP port\r
@retval EFI_SUCCESS The packet is retransmitted.\r
and lease to determine the time to renew and rebind the lease.\r
DhcpOnTimerTick will be called once every second.\r
\r
- @param Event The timer event\r
- @param Context The context, which is the DHCP service instance.\r
-\r
- @return None\r
+ @param[in] Event The timer event\r
+ @param[in] Context The context, which is the DHCP service instance.\r
\r
**/\r
VOID\r
projects / mirror_edk2.git / blobdiff