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\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
- 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
+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
+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
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0\r
+ This Protocol was introduced in UEFI Specification 2.0.\r
\r
**/\r
\r
UINT32 Xid;\r
UINT16 Seconds;\r
UINT16 Reserved;\r
- EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client\r
- EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server\r
- EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap\r
- EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address\r
- UINT8 ClientHwAddr[16]; ///< Client hardware address\r
+ EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client.\r
+ EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server.\r
+ EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap.\r
+ EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address.\r
+ UINT8 ClientHwAddr[16]; ///< Client hardware address.\r
CHAR8 ServerName[64];\r
CHAR8 BootFileName[128];\r
}EFI_DHCP4_HEADER;\r
\r
typedef enum {\r
///\r
- /// The EFI DHCPv4 Protocol driver is stopped\r
+ /// The EFI DHCPv4 Protocol driver is stopped.\r
///\r
Dhcp4Stopped = 0x0,\r
///\r
- /// The EFI DHCPv4 Protocol driver is inactive\r
+ /// The EFI DHCPv4 Protocol driver is inactive.\r
///\r
Dhcp4Init = 0x1,\r
///\r
///\r
Dhcp4Rebinding = 0x6,\r
///\r
- /// The EFI DHCPv4 Protocol driver is initialized with a previously\r
+ /// The EFI DHCPv4 Protocol driver was initialized with a previously\r
/// allocated or known IP address.\r
///\r
Dhcp4InitReboot = 0x7,\r
There are three possible returned values, which are described in the following\r
table.\r
\r
- @param This Pointer to the EFI DHCPv4 Protocol instance that is used to\r
+ @param This The pointer to the EFI DHCPv4 Protocol instance that is used to\r
configure this callback function.\r
- @param Context Pointer to the context that is initialized by\r
+ @param Context The pointer to the context that is initialized by\r
EFI_DHCP4_PROTOCOL.Configure().\r
@param CurrentState The current operational state of the EFI DHCPv4 Protocol\r
driver.\r
\r
typedef struct {\r
///\r
- /// Number of times to try sending a packet during the Dhcp4SendDiscover\r
+ /// The number of times to try sending a packet during the Dhcp4SendDiscover\r
/// event and waiting for a response during the Dhcp4RcvdOffer event.\r
/// Set to zero to use the default try counts and timeout values.\r
///\r
UINT32 DiscoverTryCount;\r
///\r
- /// Maximum amount of time (in seconds) to wait for returned packets in each \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
- /// Number of times to try sending a packet during the Dhcp4SendRequest event\r
+ /// The number of times to try sending a packet during the Dhcp4SendRequest event\r
/// and waiting for a response during the Dhcp4RcvdAck event before accepting\r
/// failure. Set to zero to use the default try counts and timeout values.\r
///\r
UINT32 RequestTryCount;\r
///\r
- /// Maximum amount of time (in seconds) to wait for return packets in each of the retries. \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
///\r
EFI_DHCP4_CALLBACK Dhcp4Callback;\r
///\r
- /// Pointer to the context that will be passed to Dhcp4Callback when it is called.\r
+ /// The pointer to the context that will be passed to Dhcp4Callback when it is called.\r
///\r
VOID *CallbackContext;\r
///\r
///\r
EFI_EVENT CompletionEvent;\r
///\r
- /// Pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.\r
+ /// The pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.\r
///\r
EFI_IPv4_ADDRESS RemoteAddress;\r
///\r
- /// Server listening port number. If zero, the default server listening port number (67) will be used.\r
+ /// The server listening port number. If zero, the default server listening port number (67) will be used.\r
///\r
UINT16 RemotePort;\r
///\r
- /// Pointer to the gateway address to override the existing setting.\r
+ /// The pointer to the gateway address to override the existing setting.\r
///\r
EFI_IPv4_ADDRESS GatewayAddress;\r
///\r
///\r
EFI_DHCP4_LISTEN_POINT *ListenPoints;\r
///\r
- /// Number of seconds to collect responses. Zero is invalid.\r
+ /// The number of seconds to collect responses. Zero is invalid.\r
///\r
UINT32 TimeoutValue;\r
///\r
- /// Pointer to the packet to be transmitted.\r
+ /// The pointer to the packet to be transmitted.\r
///\r
EFI_DHCP4_PACKET *Packet;\r
///\r
///\r
UINT32 ResponseCount;\r
///\r
- /// Pointer to the allocated list of received packets.\r
+ /// The pointer to the allocated list of received packets.\r
///\r
EFI_DHCP4_PACKET *ResponseList;\r
} EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN;\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Dhcp4ModeData The pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
When this driver is in the Dhcp4Stopped state, it can transfer into one of the\r
following two possible initial states:\r
* Dhcp4Init\r
- * Dhcp4InitReboot\r
+ * Dhcp4InitReboot.\r
The driver can transfer into these states by calling Configure() with a non-NULL\r
Dhcp4CfgData. The driver will transfer into the appropriate state based on the\r
supplied client network address in the ClientAddress parameter and DHCP options\r
wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r
driver, it must call this function with Dhcp4CfgData set to NULL.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Dhcp4CfgData The pointer to the EFI_DHCP4_CONFIG_DATA.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r
Dhcp4InitReboot state, if the original state of this driver\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param CompletionEvent If not NULL, indicates the event that will be signaled when the\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
Dhcp4Bound state or when the DHCP process is aborted.\r
EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
Extends the lease time by sending a request packet.\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
+ 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
found server (or to any server when RebindRequest is TRUE) and transfer the\r
state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is\r
If no response is received before the try count is exceeded (the RequestTryCount\r
field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that\r
was issued by the previous server expires, the driver will return to the Dhcp4Bound\r
- state and the previous configuration is restored. The outgoing and incoming packets\r
+ state, and the previous configuration is restored. The outgoing and incoming packets\r
can be captured by the EFI_DHCP4_CALLBACK function.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param RebindRequest If TRUE, this function broadcasts the request packets and enters\r
the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
request packet and enters the Dhcp4Renewing state.\r
EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in\r
Dhcp4InitReboot state\r
After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r
- to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r
+ to the Dhcp4Init state, and any subsequent incoming packets will be discarded silently.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
before DHCP configuration process can be started again. This function can be\r
called when the EFI DHCPv4 Protocol driver is in any state.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r
any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param SeedPacket Initial packet to be used as a base for building new packet.\r
@param DeleteCount Number of opcodes in the DeleteList.\r
@param DeleteList List of opcodes to be deleted from the seed packet.\r
Ignored if DeleteCount is zero.\r
@param AppendCount Number of entries in the OptionList.\r
- @param AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
+ @param AppendList The pointer to a DHCP option list to be appended to SeedPacket.\r
If SeedPacket also contains options in this list, they are\r
replaced by new options (except pad option). Ignored if\r
AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
- @param NewPacket Pointer to storage for the pointer to the new allocated packet.\r
+ @param NewPacket The pointer to storage for the pointer to the new allocated packet.\r
Use the EFI Boot Service FreePool() on the resulting pointer\r
when done with the packet.\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 and thus can be used at any time.\r
+ the EFI DHCPv4 Protocol driver. It can be used at any time because of this.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Token The pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
\r
@retval EFI_SUCCESS The packet was successfully queued for transmission.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
If *OptionCount is zero or there isn't enough space for all of them, the number\r
of DHCP options in the Packet is returned in OptionCount.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Packet Pointer to packet to be parsed.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Packet The pointer to packet to be parsed.\r
@param OptionCount On input, the number of entries in the PacketOptionList.\r
On output, the number of entries that were written into the\r
PacketOptionList.\r
- @param PacketOptionList List of packet option entries to be filled in. End option or pad\r
+ @param PacketOptionList A list of packet option entries to be filled in. End option or pad\r
options are not included.\r
\r
@retval EFI_SUCCESS The packet was successfully parsed.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
This is NULL.\r
- Packet is NULL.\r
- Packet is not a well-formed DHCP packet.\r
+ The packet is NULL.\r
+ The packet is not a well-formed DHCP packet.\r
OptionCount is NULL.\r
@retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:\r
1) *OptionCount is smaller than the number of options that\r
were found in the Packet.\r
2) PacketOptionList is NULL.\r
- @retval EFI_OUT_OF_RESOURCE The packet is failed to parse because of resource shortage.\r
+ @retval EFI_OUT_OF_RESOURCE The packet failed to parse because of a resource shortage.\r
\r
**/\r
typedef\r
projects / mirror_edk2.git / blobdiff