4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6 internal data structure and definition declaration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DHCP6_SERVICE_SIGNATURE SIGNATURE_32 ('D', 'H', '6', 'S')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DHCP6_INSTANCE_SIGNATURE SIGNATURE_32 ('D', 'H', '6', 'I')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of solicit message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of request message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of confirm message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of renew message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of rebind message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of information request message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of release message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Transmit parameters of decline message, refers to section-5.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DHCP6_INSTANCE_FROM_THIS(Instance) CR ((Instance), DHCP6_INSTANCE, Dhcp6, DHCP6_INSTANCE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define DHCP6_SERVICE_FROM_THIS(Service) CR ((Service), DHCP6_SERVICE, ServiceBinding, DHCP6_SERVICE_SIGNATURE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_IPv6_ADDRESS mAllDhcpRelayAndServersAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Enumeration of Dhcp6 message type, refers to section-5.3 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Enumeration of option code in Dhcp6 packet, refers to section-24.3 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Enumeration of status code recorded by IANA, refers to section-24.4 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Enumeration of Duid type recorded by IANA, refers to section-24.5 of rfc-3315.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Control block for each IA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Control block for each transmitted message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Control block for each info-request message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Control block for Dhcp6 instance, it's per configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Control block for Dhcp6 service, it's per Nic handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starts the DHCPv6 standard S.A.R.R. process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Start() function starts the DHCPv6 standard process. This function can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be called only when the state of Dhcp6 instance is in the Dhcp6Init state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the DHCP process completes successfully, the state of the Dhcp6 instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be transferred through Dhcp6Selecting and Dhcp6Requesting to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6Bound state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Refer to rfc-3315 for precise state transitions during this process. At the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync time when each event occurs in this process, the callback function that was set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync opportunity to control the process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DHCPv6 standard process has started, or it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed when CompletionEvent was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The DHCPv6 configuration process failed because no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync response was received from the server within the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified timeout value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The user aborted the DHCPv6 process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED Some other Dhcp6 instance already started the DHCPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync standard process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Stops the DHCPv6 standard S.A.R.R. process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Stop() function is used to stop the DHCPv6 standard process. After this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function is called successfully, the state of Dhcp6 instance is transferred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync into the Dhcp6Init. EFI_DHCP6_PROTOCOL.Configure() needs to be called
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync before DHCPv6 standard process can be started again. This function can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync called when the Dhcp6 instance is in any state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Dhcp6 instance is now in the Dhcp6Init state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current operating mode data for the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetModeData() function returns the current operating mode and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cached data packet for the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Dhcp6ModeData The pointer to the Dhcp6 mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Dhcp6ConfigData The pointer to the Dhcp6 configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The mode data was returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync been configured when Dhcp6ConfigData is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_DHCP6_CONFIG_DATA *Dhcp6ConfigData OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initializes, changes, or resets the operational settings for the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Configure() function is used to initialize or clean up the configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data of the Dhcp6 instance:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When Dhcp6CfgData is not NULL and Configure() is called successfully, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data will be initialized in the Dhcp6 instance and the state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the configured IA will be transferred into Dhcp6Init.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When Dhcp6CfgData is NULL and Configure() is called successfully, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data will be cleaned up and no IA will be associated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the Dhcp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To update the configuration data for an Dhcp6 instance, the original data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be cleaned up before setting the new configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Dhcp6CfgData The pointer to the EFI_DHCP6_CONFIG_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Dhcp6 is configured successfully with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6Init state, or cleaned up the original
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Dhcp6 instance has been already configured
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when Dhcp6CfgData is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Dhcp6 instance has already started the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DHCPv6 S.A.R.R when Dhcp6CfgData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some of the parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request configuration information without the assignment of any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ia addresses of the client.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The InfoRequest() function is used to request configuration information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync without the assignment of any IPv6 address of the client. Client sends
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync out Information Request packet to obtain the required configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information, and DHCPv6 server responds with Reply packet containing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the information for the client. The received Reply packet will be passed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the user by ReplyCallback function. If user returns EFI_NOT_READY from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReplyCallback, the Dhcp6 instance will continue to receive other Reply
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packets unless timeout according to the Retransmission parameter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, the Information Request exchange process will be finished
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully if user returns EFI_SUCCESS from ReplyCallback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SendClientId If TRUE, the DHCPv6 protocol instance will build Client
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Identifier option and include it into Information Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packet. Otherwise, Client Identifier option will not be included.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptionRequest The pointer to the buffer of option request options.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptionCount The option number in the OptionList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptionList The list of appended options.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Retransmission The pointer to the retransmission of the message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TimeoutEvent The event of timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ReplyCallback The callback function when a reply was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] CallbackContext The pointer to the parameter passed to the callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DHCPv6 information request exchange process
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed when TimeoutEvent is NULL. Information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Request packet has been sent to DHCPv6 server when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TimeoutEvent is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync because of no response, or not all requested-options
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are responded to by DHCPv6 servers when Timeout happened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The DHCPv6 information request exchange process was aborted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Manually extend the valid and preferred lifetimes for the IPv6 addresses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the configured IA and update other configuration parameters by sending
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Renew or Rebind packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The RenewRebind() function is used to manually extend the valid and preferred
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync lifetimes for the IPv6 addresses of the configured IA and update other
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration parameters by sending a Renew or Rebind packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will send Renew packet to the previously DHCPv6 server and transfer the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync state of the configured IA to Dhcp6Renewing. If valid Reply packet received,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the state transfers to Dhcp6Bound and the valid and preferred timer restarts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If fails, the state transfers to Dhcp6Bound but the timer continues.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will send a Rebind packet. If a valid Reply packet is received, the state transfers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to Dhcp6Bound, and the valid and preferred timer restarts. If it fails, the state
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transfers to Dhcp6Init, and the IA can't be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RebindRequest If TRUE, Rebind packet will be sent and enter Dhcp6Rebinding state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, Renew packet will be sent and enter Dhcp6Renewing state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed and at least one IPv6 address of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured IA was bound again when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI DHCPv6 Protocol instance has sent Renew
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or Rebind packet when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync state of the configured IA is not in Dhcp6Bound.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The state of the configured IA has already entered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6Renewing when RebindRequest is FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The state of the configured IA has already entered
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6Rebinding when RebindRequest is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The DHCPv6 renew/rebind exchange process aborted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_RESPONSE The DHCPv6 renew/rebind exchange process failed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync because of no response.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING No IPv6 address has been bound to the configured
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IA after the DHCPv6 renew/rebind exchange process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Inform that one or more addresses assigned by a server are already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in use by another node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Decline() function is used to manually decline the assignment of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv6 addresses, which have been already used by another node. If all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv6 addresses of the configured IA are declined through this function,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the state of the IA will switch through Dhcp6Declining to Dhcp6Init.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, the state of the IA will restore to Dhcp6Bound after the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync declining process. The Decline() can only be called when the IA is in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp6Bound state. If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function is a blocking operation. It will return after the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync declining process finishes, or aborted by user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AddressCount The number of declining addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Addresses The pointer to the buffer stored the declining
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DHCPv6 decline exchange process completed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Dhcp6 instance has sent Decline packet when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync state of the configured IA is not in Dhcp6Bound.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The DHCPv6 decline exchange process was aborted by the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the configured IA for this instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Release one or more addresses associated with the configured Ia
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for the current instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Release() function is used to manually release the one or more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv6 address. If AddressCount is zero, it will release all IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses of the configured IA. If all IPv6 addresses of the IA are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync released through this function, the state of the IA will switch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync through Dhcp6Releasing to Dhcp6Init, otherwise, the state of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IA will restore to Dhcp6Bound after the releasing process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Release() can only be called when the IA is in a Dhcp6Bound state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the function is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a blocking operation. It will return after the releasing process
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync finishes, or aborted by user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] AddressCount The number of releasing addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Addresses The pointer to the buffer stored the releasing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The DHCPv6 release exchange process has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completed when EFI_DHCP6_CONFIG_DATA.IaInfoEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL. The Dhcp6 instance has sent Release
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync state of the configured IA is not in Dhcp6Bound.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The DHCPv6 release exchange process was aborted by the user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the configured IA for this instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parse the option data in the Dhcp6 packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Parse() function is used to retrieve the option list in the DHCPv6 packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The pointer to the Dhcp6 protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet The pointer to the Dhcp6 packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] OptionCount The number of option in the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] PacketOptionList The array of pointers to the each option in the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The packet was successfully parsed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Some parameter is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that were found in the Packet.