code scrub fix
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7290 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
/** @file
|
||||
|
||||
Copyright (c) 2006 - 2008, Intel Corporation
|
||||
EFI DHCP protocol implementation.
|
||||
|
||||
Copyright (c) 2006 - 2008, Intel Corporation.<BR>
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
@@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
Module Name:
|
||||
|
||||
Dhcp4Io.c
|
||||
|
||||
Abstract:
|
||||
|
||||
EFI DHCP protocol implementation
|
||||
|
||||
|
||||
**/
|
||||
|
||||
|
||||
@@ -30,7 +22,7 @@ UINT32 mDhcp4DefaultTimeout[4] = { 4, 8, 16, 32 };
|
||||
Send an initial DISCOVER or REQUEST message according to the
|
||||
DHCP service's current state.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
|
||||
@retval EFI_SUCCESS The request has been sent
|
||||
@retval other Some error occurs when sending the request.
|
||||
@@ -73,10 +65,10 @@ DhcpInitRequest (
|
||||
proper return value is selected to let the caller continue the
|
||||
normal process.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Event The event as defined in the spec
|
||||
@param Packet The current packet trigger the event
|
||||
@param NewPacket The user's return new packet
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Event The event as defined in the spec
|
||||
@param[in] Packet The current packet trigger the event
|
||||
@param[out] NewPacket The user's return new packet
|
||||
|
||||
@retval EFI_NOT_READY Direct the caller to continue collecting the offer.
|
||||
@retval EFI_SUCCESS The user function returns success.
|
||||
@@ -143,8 +135,6 @@ DhcpCallUser (
|
||||
@param DhcpSb DHCP service instance
|
||||
@param Which Which notify function to signal
|
||||
|
||||
@return None
|
||||
|
||||
**/
|
||||
VOID
|
||||
DhcpNotifyUser (
|
||||
@@ -249,8 +239,6 @@ DhcpSetState (
|
||||
|
||||
@param DhcpSb The DHCP service instance.
|
||||
|
||||
@return None
|
||||
|
||||
**/
|
||||
VOID
|
||||
DhcpSetTransmitTimer (
|
||||
@@ -283,10 +271,7 @@ DhcpSetTransmitTimer (
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Para The DHCP parameter extracted from the server's
|
||||
response.
|
||||
|
||||
@return None
|
||||
|
||||
response.
|
||||
**/
|
||||
VOID
|
||||
DhcpComputeLease (
|
||||
@@ -319,8 +304,8 @@ DhcpComputeLease (
|
||||
DHCP driver needs this port to unicast packet to the server
|
||||
such as DHCP release.
|
||||
|
||||
@param UdpIo The UDP IO port to configure
|
||||
@param Context Dhcp service instance.
|
||||
@param[in] UdpIo The UDP IO port to configure
|
||||
@param[in] Context Dhcp service instance.
|
||||
|
||||
@retval EFI_SUCCESS The UDP IO port is successfully configured.
|
||||
@retval Others It failed to configure the port.
|
||||
@@ -448,8 +433,6 @@ DhcpLeaseAcquired (
|
||||
|
||||
@param DhcpSb The DHCP instance service.
|
||||
|
||||
@return None
|
||||
|
||||
**/
|
||||
VOID
|
||||
DhcpCleanLease (
|
||||
@@ -503,7 +486,7 @@ DhcpCleanLease (
|
||||
of BOOTP, the lease is recorded and user notified. If the offer is of
|
||||
DHCP, it will request the offer from the server.
|
||||
|
||||
@param DhcpSb The DHCP service instance.
|
||||
@param[in] DhcpSb The DHCP service instance.
|
||||
|
||||
@retval EFI_SUCCESS One of the offer is selected.
|
||||
|
||||
@@ -583,10 +566,8 @@ DhcpChooseOffer (
|
||||
to this is: only call DhcpEndSession at the highest level, such as
|
||||
DhcpInput, DhcpOnTimerTick...At the other level, just return error.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Status The result of the DHCP process.
|
||||
|
||||
@return None
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Status The result of the DHCP process.
|
||||
|
||||
**/
|
||||
VOID
|
||||
@@ -611,10 +592,10 @@ DhcpEndSession (
|
||||
/**
|
||||
Handle packets in DHCP select state.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Packet The DHCP packet received
|
||||
@param Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Packet The DHCP packet received
|
||||
@param[in] Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
|
||||
@retval EFI_SUCCESS The packet is successfully processed.
|
||||
@retval Others Some error occured.
|
||||
@@ -686,10 +667,10 @@ ON_EXIT:
|
||||
/**
|
||||
Handle packets in DHCP request state.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Packet The DHCP packet received
|
||||
@param Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Packet The DHCP packet received
|
||||
@param[in] Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
|
||||
@retval EFI_SUCCESS The packet is successfully processed.
|
||||
@retval Others Some error occured.
|
||||
@@ -779,10 +760,10 @@ ON_EXIT:
|
||||
/**
|
||||
Handle packets in DHCP renew/rebound state.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Packet The DHCP packet received
|
||||
@param Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Packet The DHCP packet received
|
||||
@param[in] Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
|
||||
@retval EFI_SUCCESS The packet is successfully processed.
|
||||
@retval Others Some error occured.
|
||||
@@ -863,10 +844,10 @@ ON_EXIT:
|
||||
/**
|
||||
Handle packets in DHCP reboot state.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Packet The DHCP packet received
|
||||
@param Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Packet The DHCP packet received
|
||||
@param[in] Para The DHCP parameter extracted from the packet. That
|
||||
is, all the option value that we care.
|
||||
|
||||
@retval EFI_SUCCESS The packet is successfully processed.
|
||||
@retval Others Some error occured.
|
||||
@@ -959,8 +940,6 @@ ON_EXIT:
|
||||
@param IoStatus The status of the UDP receive
|
||||
@param Context The opaque parameter to the function.
|
||||
|
||||
@return None
|
||||
|
||||
**/
|
||||
VOID
|
||||
DhcpInput (
|
||||
@@ -1111,9 +1090,7 @@ RESTART:
|
||||
/**
|
||||
Release the packet.
|
||||
|
||||
@param Arg The packet to release
|
||||
|
||||
@return None
|
||||
@param[in] Arg The packet to release
|
||||
|
||||
**/
|
||||
VOID
|
||||
@@ -1133,8 +1110,6 @@ DhcpReleasePacket (
|
||||
@param IoStatus The status of the UDP receive
|
||||
@param Context The opaque parameter to the function.
|
||||
|
||||
@return None
|
||||
|
||||
**/
|
||||
VOID
|
||||
DhcpOnPacketSent (
|
||||
@@ -1155,12 +1130,12 @@ DhcpOnPacketSent (
|
||||
the state (as defined in Figure 5. of the same RFC) before sending
|
||||
a DHCP message. The table is adjusted accordingly.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param Seed The seed packet which the new packet is based on
|
||||
@param Para The DHCP parameter of the Seed packet
|
||||
@param Type The message type to send
|
||||
@param Msg The human readable message to include in the packet
|
||||
sent.
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
@param[in] Seed The seed packet which the new packet is based on
|
||||
@param[in] Para The DHCP parameter of the Seed packet
|
||||
@param[in] Type The message type to send
|
||||
@param[in] Msg The human readable message to include in the packet
|
||||
sent.
|
||||
|
||||
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet
|
||||
@retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP
|
||||
@@ -1417,7 +1392,7 @@ DhcpSendMessage (
|
||||
Retransmit a saved packet. Only DISCOVER and REQUEST messages
|
||||
will be retransmitted.
|
||||
|
||||
@param DhcpSb The DHCP service instance
|
||||
@param[in] DhcpSb The DHCP service instance
|
||||
|
||||
@retval EFI_ACCESS_DENIED Failed to transmit packet through UDP port
|
||||
@retval EFI_SUCCESS The packet is retransmitted.
|
||||
@@ -1477,10 +1452,8 @@ DhcpRetransmit (
|
||||
and lease to determine the time to renew and rebind the lease.
|
||||
DhcpOnTimerTick will be called once every second.
|
||||
|
||||
@param Event The timer event
|
||||
@param Context The context, which is the DHCP service instance.
|
||||
|
||||
@return None
|
||||
@param[in] Event The timer event
|
||||
@param[in] Context The context, which is the DHCP service instance.
|
||||
|
||||
**/
|
||||
VOID
|
||||
|
Reference in New Issue
Block a user