These protocols are used to collect configuration information for the EFI IPv4 Protocol\r
drivers and to provide DHCPv4 server and PXE boot server discovery services.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+http://opensource.org/licenses/bsd-license.php.\r
+\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
- @par Revision Reference: \r
+ @par Revision Reference:\r
This Protocol was introduced in UEFI Specification 2.0.\r
\r
**/\r
///\r
UINT32 Size;\r
///\r
- /// Length of the EFI_DHCP4_PACKET from the first byte of the Header field \r
+ /// Length of the EFI_DHCP4_PACKET from the first byte of the Header field\r
/// to the last byte of the Option[] field.\r
///\r
UINT32 Length;\r
///\r
Dhcp4BoundCompleted = 0x08,\r
///\r
- /// It is time to enter the Dhcp4Renewing state and to contact the server \r
+ /// It is time to enter the Dhcp4Renewing state and to contact the server\r
/// that originally issued the network address. No packet is associated with this event.\r
///\r
Dhcp4EnterRenewing = 0x09,\r
///\r
- /// It is time to enter the Dhcp4Rebinding state and to contact any server. \r
+ /// It is time to enter the Dhcp4Rebinding state and to contact any server.\r
/// No packet is associated with this event.\r
///\r
Dhcp4EnterRebinding = 0x0a,\r
///\r
- /// The configured IP address was lost either because the lease has expired, \r
- /// the user released the configuration, or a DHCPNAK packet was received in \r
+ /// The configured IP address was lost either because the lease has expired,\r
+ /// the user released the configuration, or a DHCPNAK packet was received in\r
/// the Dhcp4Renewing or Dhcp4Rebinding state. No packet is associated with this event.\r
///\r
Dhcp4AddressLost = 0x0b,\r
///\r
- /// The DHCP process failed because a DHCPNAK packet was received or the user \r
- /// aborted the DHCP process at a time when the configuration was not available yet. \r
+ /// The DHCP process failed because a DHCPNAK packet was received or the user\r
+ /// aborted the DHCP process at a time when the configuration was not available yet.\r
/// No packet is associated with this event.\r
///\r
Dhcp4Fail = 0x0c\r
\r
/**\r
Callback routine.\r
- \r
+\r
EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r
to intercept events that occurred in the configuration process. This structure\r
provides advanced control of each state transition of the DHCP process. The\r
///\r
UINT32 DiscoverTryCount;\r
///\r
- /// The maximum amount of time (in seconds) to wait for returned packets in each \r
- /// of the retries. Timeout values of zero will default to a timeout value \r
+ /// The maximum amount of time (in seconds) to wait for returned packets in each\r
+ /// of the retries. Timeout values of zero will default to a timeout value\r
/// of one second. Set to NULL to use default timeout values.\r
///\r
UINT32 *DiscoverTimeout;\r
///\r
UINT32 RequestTryCount;\r
///\r
- /// The maximum amount of time (in seconds) to wait for return packets in each of the retries. \r
- /// Timeout values of zero will default to a timeout value of one second. \r
+ /// The maximum amount of time (in seconds) to wait for return packets in each of the retries.\r
+ /// Timeout values of zero will default to a timeout value of one second.\r
/// Set to NULL to use default timeout values.\r
///\r
UINT32 *RequestTimeout;\r
///\r
/// For a DHCPDISCOVER, setting this parameter to the previously allocated IP\r
- /// address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state. \r
+ /// address will cause the EFI DHCPv4 Protocol driver to enter the Dhcp4InitReboot state.\r
/// And set this field to 0.0.0.0 to enter the Dhcp4Init state.\r
/// For a DHCPINFORM this parameter should be set to the client network address\r
/// which was assigned to the client during a DHCPDISCOVER.\r
///\r
EFI_IPv4_ADDRESS ClientAddress;\r
///\r
- /// The callback function to intercept various events that occurred in \r
+ /// The callback function to intercept various events that occurred in\r
/// the DHCP configuration process. Set to NULL to ignore all those events.\r
///\r
EFI_DHCP4_CALLBACK Dhcp4Callback;\r
\r
typedef struct {\r
///\r
- /// The EFI DHCPv4 Protocol driver operating state. \r
+ /// The EFI DHCPv4 Protocol driver operating state.\r
///\r
EFI_DHCP4_STATE State;\r
///\r
///\r
EFI_IPv4_ADDRESS ServerAddress;\r
///\r
- /// The router IP address that was acquired from the DHCP server. \r
+ /// The router IP address that was acquired from the DHCP server.\r
/// May be zero if the server does not offer this address.\r
///\r
EFI_IPv4_ADDRESS RouterAddress;\r
///\r
EFI_IPv4_ADDRESS SubnetMask;\r
///\r
- /// The lease time (in 1-second units) of the configured IP address. \r
- /// The value 0xFFFFFFFF means that the lease time is infinite. \r
+ /// The lease time (in 1-second units) of the configured IP address.\r
+ /// The value 0xFFFFFFFF means that the lease time is infinite.\r
/// A default lease of 7 days is used if the DHCP server does not provide a value.\r
///\r
UINT32 LeaseTime;\r
///\r
EFI_IPv4_ADDRESS ListenAddress;\r
///\r
- /// The subnet mask of above listening unicast/broadcast IP address. \r
+ /// The subnet mask of above listening unicast/broadcast IP address.\r
/// Ignored if ListenAddress is a multicast address.\r
///\r
EFI_IPv4_ADDRESS SubnetMask;\r
///\r
- /// Alternate station source (or listening) port number. \r
+ /// Alternate station source (or listening) port number.\r
/// If zero, then the default station port number (68) will be used.\r
///\r
UINT16 ListenPort;\r
///\r
EFI_STATUS Status;\r
///\r
- /// If not NULL, the event that will be signaled when the collection process \r
+ /// If not NULL, the event that will be signaled when the collection process\r
/// completes. If NULL, this function will busy-wait until the collection process competes.\r
///\r
EFI_EVENT CompletionEvent;\r
///\r
UINT32 ListenPointCount;\r
///\r
- /// An array of station address and port number pairs that are used as receiving filters. \r
+ /// An array of station address and port number pairs that are used as receiving filters.\r
/// The first entry is also used as the source address and source port of the outgoing packet.\r
///\r
EFI_DHCP4_LISTEN_POINT *ListenPoints;\r
\r
/**\r
Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.\r
- \r
+\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
time when each event occurs in this process, the callback function that was set\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
- \r
+\r
@param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param CompletionEvent If not NULL, it indicates the event that will be signaled when the\r
EFI DHCPv4 Protocol driver is transferred into the\r
\r
/**\r
Extends the lease time by sending a request packet.\r
- \r
+\r
The RenewRebind() function is used to manually extend the lease time when the\r
EFI DHCPv4 Protocol driver is in the Dhcp4Bound state, and the lease time has\r
not expired yet. This function will send a request packet to the previously\r
\r
/**\r
Stops the current address configuration.\r
- \r
+\r
The Stop() function is used to stop the DHCP configuration process. After this\r
function is called successfully, the EFI DHCPv4 Protocol driver is transferred\r
into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called\r
\r
/**\r
Transmits a DHCP formatted packet and optionally waits for responses.\r
- \r
+\r
The TransmitReceive() function is used to transmit a DHCP packet and optionally\r
wait for the response from servers. This function does not change the state of\r
the EFI DHCPv4 Protocol driver. It can be used at any time because of this.\r
\r
/**\r
Parses the packed DHCP option data.\r
- \r
+\r
The Parse() function is used to retrieve the option list from a DHCP packet.\r
If *OptionCount isn't zero, and there is enough space for all the DHCP options\r
in the Packet, each element of PacketOptionList is set to point to somewhere in\r
projects / mirror_edk2.git / blobdiff