UEFI Dynamic Host Configuration Protocol 6 Definition, which is used to get IPv6\r
addresses and other configuration parameters from DHCPv6 servers.\r
\r
- Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
- 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
-\r
- @par Revision Reference: \r
+ Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ 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
+\r
+ @par Revision Reference:\r
This Protocol is introduced in UEFI Specification 2.2\r
\r
**/\r
\r
typedef struct _EFI_DHCP6_PROTOCOL EFI_DHCP6_PROTOCOL;\r
\r
-typedef enum { \r
+typedef enum {\r
///\r
- /// The EFI DHCPv6 Protocol instance is configured, and start() needs \r
+ /// The EFI DHCPv6 Protocol instance is configured, and start() needs\r
/// to be called\r
///\r
Dhcp6Init = 0x0,\r
///\r
Dhcp6Selecting = 0x1,\r
///\r
- /// A Request is sent out to the DHCPv6 server, and the EFI DHCPv6 \r
+ /// A Request is sent out to the DHCPv6 server, and the EFI DHCPv6\r
/// Protocol instance is waiting for Reply packet.\r
///\r
Dhcp6Requesting = 0x2,\r
///\r
Dhcp6Declining = 0x3,\r
///\r
- /// A Confirm packet is sent out to confirm the IPv6 addresses of the \r
+ /// A Confirm packet is sent out to confirm the IPv6 addresses of the\r
/// configured IA, and the EFI DHCPv6 Protocol instance is waiting for Reply packet.\r
///\r
Dhcp6Confirming = 0x4,\r
} EFI_DHCP6_STATE;\r
\r
typedef enum {\r
- /// \r
+ ///\r
/// A Solicit packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6SendSolicit = 0x0,\r
- /// \r
+ ///\r
/// An Advertise packet is received and will be passed to Dhcp6Callback.\r
///\r
Dhcp6RcvdAdvertise = 0x1,\r
- /// \r
+ ///\r
/// It is time for Dhcp6Callback to determine whether select the default Advertise\r
/// packet by RFC 3315 policy, or overwrite it by specific user policy.\r
///\r
Dhcp6SelectAdvertise = 0x2,\r
- /// \r
+ ///\r
/// A Request packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6SendRequest = 0x3,\r
- /// \r
+ ///\r
/// A Reply packet is received and will be passed to Dhcp6Callback.\r
///\r
Dhcp6RcvdReply = 0x4,\r
- /// \r
+ ///\r
/// A Reconfigure packet is received and will be passed to Dhcp6Callback.\r
///\r
Dhcp6RcvdReconfigure = 0x5,\r
- /// \r
+ ///\r
/// A Decline packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6SendDecline = 0x6,\r
- /// \r
+ ///\r
/// A Confirm packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6SendConfirm = 0x7,\r
- /// \r
+ ///\r
/// A Release packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6SendRelease = 0x8,\r
- /// \r
+ ///\r
/// A Renew packet is about to be sent. The packet is passed to Dhcp6Callback and\r
- /// can be modified or replaced in Dhcp6Callback. \r
+ /// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6EnterRenewing = 0x9,\r
- /// \r
- /// A Rebind packet is about to be sent. The packet is passed to Dhcp6Callback and \r
+ ///\r
+ /// A Rebind packet is about to be sent. The packet is passed to Dhcp6Callback and\r
/// can be modified or replaced in Dhcp6Callback.\r
///\r
Dhcp6EnterRebinding = 0xa\r
///\r
/// EFI_DHCP6_PACKET_OPTION\r
/// defines the format of the DHCPv6 option, See RFC 3315 for more information.\r
-/// This data structure is used to reference option data that is packed in the DHCPv6 packet. \r
+/// This data structure is used to reference option data that is packed in the DHCPv6 packet.\r
///\r
typedef struct {\r
///\r
\r
///\r
/// EFI_DHCP6_HEADER\r
-/// defines the format of the DHCPv6 header. See RFC 3315 for more information. \r
+/// defines the format of the DHCPv6 header. See RFC 3315 for more information.\r
///\r
typedef struct{\r
///\r
} EFI_DHCP6_HEADER;\r
\r
///\r
-/// EFI_DHCP6_PACKET \r
+/// EFI_DHCP6_PACKET\r
/// defines the format of the DHCPv6 packet. See RFC 3315 for more information.\r
///\r
typedef struct {\r
///\r
UINT32 Irt;\r
///\r
- /// Maximum retransmission count for one packet. If Mrc is zero, there's no upper limit \r
+ /// Maximum retransmission count for one packet. If Mrc is zero, there's no upper limit\r
/// for retransmission count.\r
///\r
UINT32 Mrc;\r
///\r
- /// Maximum retransmission timeout for each retry. It's the upper bound of the number of \r
- /// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission \r
+ /// Maximum retransmission timeout for each retry. It's the upper bound of the number of\r
+ /// retransmission timeout. If Mrt is zero, there is no upper limit for retransmission\r
/// timeout.\r
///\r
UINT32 Mrt;\r
///\r
- /// Maximum retransmission duration for one packet. It's the upper bound of the numbers \r
- /// the client may retransmit a message. If Mrd is zero, there's no upper limit for \r
+ /// Maximum retransmission duration for one packet. It's the upper bound of the numbers\r
+ /// the client may retransmit a message. If Mrd is zero, there's no upper limit for\r
/// retransmission duration.\r
///\r
UINT32 Mrd;\r
///\r
UINT32 IaAddressCount;\r
///\r
- /// List of the IPv6 addresses of the configured IA. When the state of the configured IA is \r
+ /// List of the IPv6 addresses of the configured IA. When the state of the configured IA is\r
/// in Dhcp6Bound, Dhcp6Renewing and Dhcp6Rebinding, the IPv6 addresses are usable.\r
///\r
EFI_DHCP6_IA_ADDRESS IaAddress[1];\r
} EFI_DHCP6_MODE_DATA;\r
\r
/**\r
- EFI_DHCP6_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol instance to \r
+ EFI_DHCP6_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol instance to\r
intercept events that occurs in the DHCPv6 S.A.R.R process.\r
\r
- @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this \r
+ @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this\r
callback function.\r
@param[in] Context Pointer to the context that is initialized by EFI_DHCP6_PROTOCOL.Configure().\r
@param[in] CurrentState The current state of the configured IA.\r
@param[in] Dhcp6Event The event that occurs in the current state, which usually means a state transition.\r
@param[in] Packet Pointer to the DHCPv6 packet that is about to be sent or has been received.\r
- The EFI DHCPv6 Protocol instance is responsible for freeing the buffer. \r
- @param[out] NewPacket Pointer to the new DHCPv6 packet to overwrite the Packet. NewPacket can not \r
- share the buffer with Packet. If *NewPacket is not NULL, the EFI DHCPv6 \r
+ The EFI DHCPv6 Protocol instance is responsible for freeing the buffer.\r
+ @param[out] NewPacket Pointer to the new DHCPv6 packet to overwrite the Packet. NewPacket can not\r
+ share the buffer with Packet. If *NewPacket is not NULL, the EFI DHCPv6\r
Protocol instance is responsible for freeing the buffer.\r
\r
@retval EFI_SUCCESS Tell the EFI DHCPv6 Protocol instance to continue the DHCPv6 S.A.R.R process.\r
- @retval EFI_ABORTED Tell the EFI DHCPv6 Protocol instance to abort the DHCPv6 S.A.R.R process, \r
+ @retval EFI_ABORTED Tell the EFI DHCPv6 Protocol instance to abort the DHCPv6 S.A.R.R process,\r
and the state of the configured IA will be transferred to Dhcp6Init.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_DHCP6_CALLBACK)(\r
IN EFI_DHCP6_PROTOCOL *This,\r
IN VOID *Context,\r
IN EFI_DHCP6_STATE CurrentState,\r
IN EFI_DHCP6_EVENT Dhcp6Event,\r
- IN EFI_DHCP6_PACKET *Packet, \r
+ IN EFI_DHCP6_PACKET *Packet,\r
OUT EFI_DHCP6_PACKET **NewPacket OPTIONAL\r
);\r
\r
typedef struct {\r
///\r
- /// The callback function is to intercept various events that occur in the DHCPv6 S.A.R.R \r
+ /// The callback function is to intercept various events that occur in the DHCPv6 S.A.R.R\r
/// process. Set to NULL to ignore all those events.\r
///\r
EFI_DHCP6_CALLBACK Dhcp6Callback;\r
///\r
UINT32 OptionCount;\r
///\r
- /// List of the DHCPv6 options to be included in Solicit and Request packet. The buffer \r
- /// can be freed after EFI_DHCP6_PROTOCOL.Configure() returns. Ignored if \r
- /// OptionCount is zero. OptionList should not contain Client Identifier option \r
- /// and any IA option, which will be appended by EFI DHCPv6 Protocol instance \r
- /// automatically. \r
+ /// List of the DHCPv6 options to be included in Solicit and Request packet. The buffer\r
+ /// can be freed after EFI_DHCP6_PROTOCOL.Configure() returns. Ignored if\r
+ /// OptionCount is zero. OptionList should not contain Client Identifier option\r
+ /// and any IA option, which will be appended by EFI DHCPv6 Protocol instance\r
+ /// automatically.\r
///\r
EFI_DHCP6_PACKET_OPTION **OptionList;\r
///\r
///\r
EFI_DHCP6_IA_DESCRIPTOR IaDescriptor;\r
///\r
- /// If not NULL, the event will be signaled when any IPv6 address information of the \r
- /// configured IA is updated, including IPv6 address, preferred lifetime and valid \r
- /// lifetime, or the DHCPv6 S.A.R.R process fails. Otherwise, Start(), \r
- /// renewrebind(), decline(), release() and stop() will be blocking \r
+ /// If not NULL, the event will be signaled when any IPv6 address information of the\r
+ /// configured IA is updated, including IPv6 address, preferred lifetime and valid\r
+ /// lifetime, or the DHCPv6 S.A.R.R process fails. Otherwise, Start(),\r
+ /// renewrebind(), decline(), release() and stop() will be blocking\r
/// operations, and they will wait for the exchange process completion or failure.\r
///\r
EFI_EVENT IaInfoEvent;\r
///\r
- /// If TRUE, the EFI DHCPv6 Protocol instance is willing to accept Reconfigure packet. \r
- /// Otherwise, it will ignore it. Reconfigure Accept option can not be specified through \r
+ /// If TRUE, the EFI DHCPv6 Protocol instance is willing to accept Reconfigure packet.\r
+ /// Otherwise, it will ignore it. Reconfigure Accept option can not be specified through\r
/// OptionList parameter.\r
///\r
BOOLEAN ReconfigureAccept;\r
///\r
- /// If TRUE, the EFI DHCPv6 Protocol instance will send Solicit packet with Rapid \r
- /// Commit option. Otherwise, Rapid Commit option will not be included in Solicit \r
+ /// If TRUE, the EFI DHCPv6 Protocol instance will send Solicit packet with Rapid\r
+ /// Commit option. Otherwise, Rapid Commit option will not be included in Solicit\r
/// packet. Rapid Commit option can not be specified through OptionList parameter.\r
///\r
BOOLEAN RapidCommit;\r
///\r
- /// Parameter to control Solicit packet retransmission behavior. The \r
+ /// Parameter to control Solicit packet retransmission behavior. The\r
/// buffer can be freed after EFI_DHCP6_PROTOCOL.Configure() returns.\r
///\r
EFI_DHCP6_RETRANSMISSION *SolicitRetransmission;\r
} EFI_DHCP6_CONFIG_DATA;\r
\r
/**\r
- EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol \r
+ EFI_DHCP6_INFO_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol\r
instance to intercept events that occurs in the DHCPv6 Information Request exchange process.\r
\r
- @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this \r
+ @param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance that is used to configure this\r
callback function.\r
@param[in] Context Pointer to the context that is initialized in the EFI_DHCP6_PROTOCOL.InfoRequest().\r
- @param[in] Packet Pointer to Reply packet that has been received. The EFI DHCPv6 Protocol instance is \r
+ @param[in] Packet Pointer to Reply packet that has been received. The EFI DHCPv6 Protocol instance is\r
responsible for freeing the buffer.\r
\r
@retval EFI_SUCCESS Tell the EFI DHCPv6 Protocol instance to finish Information Request exchange process.\r
Retrieve the current operating mode data and configuration data for the EFI DHCPv6 Protocol instance.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
- @param[out] Dhcp6ModeData Pointer to the DHCPv6 mode data structure. The caller is responsible for freeing this \r
+ @param[out] Dhcp6ModeData Pointer to the DHCPv6 mode data structure. The caller is responsible for freeing this\r
structure and each reference buffer.\r
- @param[out] Dhcp6ConfigData Pointer to the DHCPv6 configuration data structure. The caller is responsible for \r
+ @param[out] Dhcp6ConfigData Pointer to the DHCPv6 configuration data structure. The caller is responsible for\r
freeing this structure and each reference buffer.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has not been configured when Dhcp6ConfigData is not NULL.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
- - This is NULL. \r
+ - This is NULL.\r
- Both Dhcp6ConfigData and Dhcp6ModeData are NULL.\r
\r
**/\r
-typedef \r
-EFI_STATUS \r
+typedef\r
+EFI_STATUS\r
(EFIAPI *EFI_DHCP6_GET_MODE_DATA)(\r
IN EFI_DHCP6_PROTOCOL *This,\r
OUT EFI_DHCP6_MODE_DATA *Dhcp6ModeData OPTIONAL,\r
/**\r
Initialize or clean up the configuration data for the EFI DHCPv6 Protocol instance.\r
\r
- The Configure() function is used to initialize or clean up the configuration data of the EFI \r
+ The Configure() function is used to initialize or clean up the configuration data of the EFI\r
DHCPv6 Protocol instance.\r
- - When Dhcp6CfgData is not NULL and Configure() is called successfully, the \r
- configuration data will be initialized in the EFI DHCPv6 Protocol instance and the state of the \r
+ - When Dhcp6CfgData is not NULL and Configure() is called successfully, the\r
+ configuration data will be initialized in the EFI DHCPv6 Protocol instance and the state of the\r
configured IA will be transferred into Dhcp6Init.\r
- - When Dhcp6CfgData is NULL and Configure() is called successfully, the configuration \r
+ - When Dhcp6CfgData is NULL and Configure() is called successfully, the configuration\r
data will be cleaned up and no IA will be associated with the EFI DHCPv6 Protocol instance.\r
\r
- To update the configuration data for an EFI DCHPv6 Protocol instance, the original data must be \r
+ To update the configuration data for an EFI DCHPv6 Protocol instance, the original data must be\r
cleaned up before setting the new configuration data.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE\r
- - This is NULL. \r
+ - This is NULL.\r
- OptionCount > 0 and OptionList is NULL.\r
- OptionList is not NULL, and Client Id option, Reconfigure Accept option,\r
Rapid Commit option or any IA option is specified in the OptionList.\r
- IaDescriptor.Type is neither EFI_DHCP6_IA_TYPE_NA nor EFI_DHCP6_IA_TYPE_NA.\r
- IaDescriptor is not unique.\r
- Both IaInfoEvent and SolicitRetransimssion are NULL.\r
- - SolicitRetransmission is not NULL, and both SolicitRetransimssion->Mrc and \r
+ - SolicitRetransmission is not NULL, and both SolicitRetransimssion->Mrc and\r
SolicitRetransmission->Mrd are zero.\r
- @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has been already configured \r
+ @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has been already configured\r
when Dhcp6CfgData is not NULL.\r
- The EFI DHCPv6 Protocol instance has already started the \r
+ The EFI DHCPv6 Protocol instance has already started the\r
DHCPv6 S.A.R.R when Dhcp6CfgData is NULL.\r
@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DHCP6_CONFIGURE)(\r
IN EFI_DHCP6_PROTOCOL *This,\r
/**\r
Start the DHCPv6 S.A.R.R process.\r
\r
- The Start() function starts the DHCPv6 S.A.R.R process. This function can be called only when \r
+ The Start() function starts the DHCPv6 S.A.R.R process. This function can be called only when\r
the state of the configured IA is in the Dhcp6Init state. If the DHCPv6 S.A.R.R process completes\r
- successfully, the state of the configured IA will be transferred through Dhcp6Selecting and \r
- Dhcp6Requesting to Dhcp6Bound state. The update of the IPv6 addresses will be notified through \r
- EFI_DHCP6_CONFIG_DATA.IaInfoEvent. At the time when each event occurs in this process, the \r
- callback function set by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take \r
- this opportunity to control the process. If EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the \r
+ successfully, the state of the configured IA will be transferred through Dhcp6Selecting and\r
+ Dhcp6Requesting to Dhcp6Bound state. The update of the IPv6 addresses will be notified through\r
+ EFI_DHCP6_CONFIG_DATA.IaInfoEvent. At the time when each event occurs in this process, the\r
+ callback function set by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take\r
+ this opportunity to control the process. If EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the\r
Start() function call is a blocking operation. It will return after the DHCPv6 S.A.R.R process\r
completes or aborted by users. If the process is aborted by system or network error, the state of\r
the configured IA will be transferred to Dhcp6Init. The Start() function can be called again to\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
\r
- @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 \r
- address has been bound to the configured IA when \r
- EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. \r
- The DHCPv6 S.A.R.R process is started when \r
+ @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6\r
+ address has been bound to the configured IA when\r
+ EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.\r
+ The DHCPv6 S.A.R.R process is started when\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
@retval EFI_ALREADY_STARTED The DHCPv6 S.A.R.R process has already started.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.\r
@retval EFI_NO_RESPONSE The DHCPv6 S.A.R.R process failed because of no response.\r
- @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the \r
+ @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the\r
DHCPv6 S.A.R.R process.\r
@retval EFI_ABORTED The DHCPv6 S.A.R.R process aborted by user.\r
@retval EFI_NO_MEDIA There was a media error.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DHCP6_START)(\r
IN EFI_DHCP6_PROTOCOL *This\r
Request configuration information without the assignment of any IA addresses of the client.\r
\r
The InfoRequest() function is used to request configuration information without the assignment\r
- of any IPv6 address of the client. Client sends out Information Request packet to obtain \r
- the required configuration information, and DHCPv6 server responds with Reply packet containing \r
- the information for the client. The received Reply packet will be passed to the user by \r
+ of any IPv6 address of the client. Client sends out Information Request packet to obtain\r
+ the required configuration information, and DHCPv6 server responds with Reply packet containing\r
+ the information for the client. The received Reply packet will be passed to the user by\r
ReplyCallback function. If user returns EFI_NOT_READY from ReplyCallback, the EFI DHCPv6\r
- Protocol instance will continue to receive other Reply packets unless timeout according to \r
- the Retransmission parameter. Otherwise, the Information Request exchange process will be \r
+ Protocol instance will continue to receive other Reply packets unless timeout according to\r
+ the Retransmission parameter. Otherwise, the Information Request exchange process will be\r
finished successfully if user returns EFI_SUCCESS from ReplyCallback.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
@param[in] SendClientId If TRUE, the EFI DHCPv6 Protocol instance will build Client\r
Identifier option and include it into Information Request\r
packet. If FALSE, Client Identifier option will not be included.\r
- Client Identifier option can not be specified through OptionList \r
+ Client Identifier option can not be specified through OptionList\r
parameter.\r
@param[in] OptionRequest Pointer to the Option Request option in the Information Request\r
packet. Option Request option can not be specified through\r
returns.\r
@param[in] TimeoutEvent If not NULL, this event is signaled when the information request\r
exchange aborted because of no response. If NULL, the function\r
- call is a blocking operation; and it will return after the \r
+ call is a blocking operation; and it will return after the\r
information-request exchange process finish or aborted by users.\r
@param[in] ReplyCallback The callback function is to intercept various events that occur\r
in the Information Request exchange process. It should not be\r
set to NULL.\r
@param[in] CallbackContext Pointer to the context that will be passed to ReplyCallback.\r
\r
- @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6 \r
- @retval EFI_SUCCESS The DHCPv6 information request exchange process completed \r
+ @retval EFI_SUCCESS The DHCPv6 S.A.R.R process is completed and at least one IPv6\r
+ @retval EFI_SUCCESS The DHCPv6 information request exchange process completed\r
when TimeoutEvent is NULL. Information Request packet has been\r
sent to DHCPv6 server when TimeoutEvent is not NULL.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
- - This is NULL. \r
+ - This is NULL.\r
- OptionRequest is NULL or OptionRequest->OpCode is invalid.\r
- OptionCount > 0 and OptionList is NULL.\r
- - OptionList is not NULL, and Client Identify option or \r
+ - OptionList is not NULL, and Client Identify option or\r
Option Request option is specified in the OptionList.\r
- Retransimssion is NULL.\r
- Both Retransimssion->Mrc and Retransmission->Mrd are zero.\r
- ReplyCallback is NULL.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.\r
- @retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed \r
- because of no response, or not all requested-options are \r
+ @retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed\r
+ because of no response, or not all requested-options are\r
responded by DHCPv6 servers when Timeout happened.\r
@retval EFI_ABORTED The DHCPv6 information request exchange process aborted by user.\r
\r
IN EFI_DHCP6_PACKET_OPTION *OptionRequest,\r
IN UINT32 OptionCount,\r
IN EFI_DHCP6_PACKET_OPTION *OptionList[] OPTIONAL,\r
- IN EFI_DHCP6_RETRANSMISSION *Retransmission, \r
+ IN EFI_DHCP6_RETRANSMISSION *Retransmission,\r
IN EFI_EVENT TimeoutEvent OPTIONAL,\r
IN EFI_DHCP6_INFO_CALLBACK ReplyCallback,\r
IN VOID *CallbackContext OPTIONAL\r
Manually extend the valid and preferred lifetimes for the IPv6 addresses of the configured\r
IA and update other configuration parameters by sending Renew or Rebind packet.\r
\r
- The RenewRebind() function is used to manually extend the valid and preferred lifetimes for the \r
- IPv6 addresses of the configured IA and update other configuration parameters by sending Renew or \r
- Rebind packet. \r
- - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound, it \r
- will send Renew packet to the previously DHCPv6 server and transfer the state of the configured \r
- IA to Dhcp6Renewing. If valid Reply packet received, the state transfers to Dhcp6Bound \r
- and the valid and preferred timer restarts. If fails, the state transfers to Dhcp6Bound but the \r
- timer continues. \r
- - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will \r
- send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the \r
+ The RenewRebind() function is used to manually extend the valid and preferred lifetimes for the\r
+ IPv6 addresses of the configured IA and update other configuration parameters by sending Renew or\r
+ Rebind packet.\r
+ - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound, it\r
+ will send Renew packet to the previously DHCPv6 server and transfer the state of the configured\r
+ IA to Dhcp6Renewing. If valid Reply packet received, the state transfers to Dhcp6Bound\r
+ and the valid and preferred timer restarts. If fails, the state transfers to Dhcp6Bound but the\r
+ timer continues.\r
+ - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound, it will\r
+ send Rebind packet. If valid Reply packet received, the state transfers to Dhcp6Bound and the\r
valid and preferred timer restarts. If fails, the state transfers to Dhcp6Init and the IA can't\r
be used.\r
\r
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param[in] RebindRequest If TRUE, it will send Rebind packet and enter the Dhcp6Rebinding state. \r
+ @param[in] RebindRequest If TRUE, it will send Rebind packet and enter the Dhcp6Rebinding state.\r
Otherwise, it will send Renew packet and enter the Dhcp6Renewing state.\r
\r
- @retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process has completed and at \r
+ @retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process has completed and at\r
least one IPv6 address of the configured IA has been bound again\r
- when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL. \r
- The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet \r
+ when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.\r
+ The EFI DHCPv6 Protocol instance has sent Renew or Rebind packet\r
when EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the state\r
of the configured IA is not in Dhcp6Bound.\r
- @retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing \r
- when RebindRequest is FALSE. \r
- The state of the configured IA has already entered Dhcp6Rebinding \r
+ @retval EFI_ALREADY_STARTED The state of the configured IA has already entered Dhcp6Renewing\r
+ when RebindRequest is FALSE.\r
+ The state of the configured IA has already entered Dhcp6Rebinding\r
when RebindRequest is TRUE.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
@retval EFI_DEVICE_ERROR An unexpected system or system error occurred.\r
@retval EFI_NO_RESPONSE The DHCPv6 renew/rebind exchange process failed because of no response.\r
- @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the DHCPv6 \r
+ @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured IA after the DHCPv6\r
renew/rebind exchange process.\r
@retval EFI_ABORTED The DHCPv6 renew/rebind exchange process aborted by user.\r
\r
Inform that one or more IPv6 addresses assigned by a server are already in use by\r
another node.\r
\r
- The Decline() function is used to manually decline the assignment of IPv6 addresses, which \r
- have been already used by another node. If all IPv6 addresses of the configured IA are declined \r
- through this function, the state of the IA will switch through Dhcp6Declining to Dhcp6Init, \r
- otherwise, the state of the IA will restore to Dhcp6Bound after the declining process. The \r
- Decline() can only be called when the IA is in Dhcp6Bound state. If the \r
- EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, this function is a blocking operation. It \r
+ The Decline() function is used to manually decline the assignment of IPv6 addresses, which\r
+ have been already used by another node. If all IPv6 addresses of the configured IA are declined\r
+ through this function, the state of the IA will switch through Dhcp6Declining to Dhcp6Init,\r
+ otherwise, the state of the IA will restore to Dhcp6Bound after the declining process. The\r
+ Decline() can only be called when the IA is in Dhcp6Bound state. If the\r
+ EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, this function is a blocking operation. It\r
will return after the declining process finishes, or aborted by user.\r
\r
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param[in] AddressCount Number of declining IPv6 addresses. \r
+ @param[in] AddressCount Number of declining IPv6 addresses.\r
@param[in] Addresses Pointer to the buffer stored all the declining IPv6 addresses.\r
\r
- @retval EFI_SUCCESS The DHCPv6 decline exchange process has completed when \r
+ @retval EFI_SUCCESS The DHCPv6 decline exchange process has completed when\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.\r
- The EFI DHCPv6 Protocol instance has sent Decline packet when \r
+ The EFI DHCPv6 Protocol instance has sent Decline packet when\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE\r
- - This is NULL. \r
+ - This is NULL.\r
- AddressCount is zero or Addresses is NULL.\r
- @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA \r
+ @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured IA\r
for this instance.\r
- @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the \r
+ @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the\r
state of the configured IA is not in Dhcp6Bound.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.\r
@retval EFI_ABORTED The DHCPv6 decline exchange process aborted by user.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DHCP6_DECLINE)(\r
IN EFI_DHCP6_PROTOCOL *This,\r
\r
The Release() function is used to manually release the one or more IPv6 address. If AddressCount\r
is zero, it will release all IPv6 addresses of the configured IA. If all IPv6 addresses of the IA\r
- are released through this function, the state of the IA will switch through Dhcp6Releasing to \r
+ are released through this function, the state of the IA will switch through Dhcp6Releasing to\r
Dhcp6Init, otherwise, the state of the IA will restore to Dhcp6Bound after the releasing process.\r
The Release() can only be called when the IA is in Dhcp6Bound state. If the\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the function is a blocking operation. It will return\r
- after the releasing process finishes, or aborted by user. \r
+ after the releasing process finishes, or aborted by user.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
- @param[in] AddressCount Number of releasing IPv6 addresses. \r
+ @param[in] AddressCount Number of releasing IPv6 addresses.\r
@param[in] Addresses Pointer to the buffer stored all the releasing IPv6 addresses.\r
Ignored if AddressCount is zero.\r
- @retval EFI_SUCCESS The DHCPv6 release exchange process has completed when \r
+ @retval EFI_SUCCESS The DHCPv6 release exchange process has completed when\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL.\r
- The EFI DHCPv6 Protocol instance has sent Release packet when \r
+ The EFI DHCPv6 Protocol instance has sent Release packet when\r
EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE\r
- - This is NULL. \r
+ - This is NULL.\r
- AddressCount is not zero or Addresses is NULL.\r
@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with the configured\r
IA for this instance.\r
- @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the \r
+ @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured, or the\r
state of the configured IA is not in Dhcp6Bound.\r
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred.\r
- @retval EFI_ABORTED The DHCPv6 release exchange process aborted by user. \r
+ @retval EFI_ABORTED The DHCPv6 release exchange process aborted by user.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DHCP6_RELEASE)(\r
IN EFI_DHCP6_PROTOCOL *This,\r
\r
The Stop() function is used to stop the DHCPv6 S.A.R.R process. If this function is called\r
successfully, all the IPv6 addresses of the configured IA will be released and the state of\r
- the configured IA will be transferred to Dhcp6Init. \r
+ the configured IA will be transferred to Dhcp6Init.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
\r
**/\r
-typedef \r
+typedef\r
EFI_STATUS\r
(EFIAPI *EFI_DHCP6_STOP)(\r
IN EFI_DHCP6_PROTOCOL *This\r
/**\r
Parse the option data in the DHCPv6 packet.\r
\r
- The Parse() function is used to retrieve the option list in the DHCPv6 packet. \r
+ The Parse() function is used to retrieve the option list in the DHCPv6 packet.\r
\r
@param[in] This Pointer to the EFI_DHCP6_PROTOCOL instance.\r
\r
- Packet is not a well-formed DHCPv6 packet.\r
- OptionCount is NULL.\r
- *OptionCount is not zero and PacketOptionList is NULL.\r
- @retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options that were \r
+ @retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options that were\r
found in the Packet.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff