[mirror_edk2.git] / NetworkPkg / Dhcp6Dxe / Dhcp6Impl.h

/** @file\r
  Dhcp6 internal data structure and definition declaration.\r
\r
  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
\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
**/\r
\r
#ifndef __EFI_DHCP6_IMPL_H__\r
#define __EFI_DHCP6_IMPL_H__\r
\r
\r
#include <Uefi.h>\r
\r
#include <IndustryStandard/Dhcp.h>\r
\r
#include <Protocol/Dhcp6.h>\r
#include <Protocol/Udp6.h>\r
#include <Protocol/Ip6Config.h>\r
#include <Protocol/ServiceBinding.h>\r
#include <Protocol/DriverBinding.h>\r
\r
#include <Library/UdpIoLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/PrintLib.h>\r
\r
\r
typedef struct _DHCP6_IA_CB    DHCP6_IA_CB;\r
typedef struct _DHCP6_INF_CB   DHCP6_INF_CB;\r
typedef struct _DHCP6_TX_CB    DHCP6_TX_CB;\r
typedef struct _DHCP6_SERVICE  DHCP6_SERVICE;\r
typedef struct _DHCP6_INSTANCE DHCP6_INSTANCE;\r
\r
#include "Dhcp6Utility.h"\r
#include "Dhcp6Io.h"\r
#include "Dhcp6Driver.h"\r
\r
#define DHCP6_SERVICE_SIGNATURE   SIGNATURE_32 ('D', 'H', '6', 'S')\r
#define DHCP6_INSTANCE_SIGNATURE  SIGNATURE_32 ('D', 'H', '6', 'I')\r
\r
#define DHCP6_PACKET_ALL          0\r
#define DHCP6_PACKET_STATEFUL     1\r
#define DHCP6_PACKET_STATELESS    2\r
\r
#define DHCP6_BASE_PACKET_SIZE    1024\r
\r
#define DHCP6_PORT_CLIENT         546\r
#define DHCP6_PORT_SERVER         547\r
\r
#define DHCP6_INSTANCE_FROM_THIS(Instance) CR ((Instance), DHCP6_INSTANCE, Dhcp6, DHCP6_INSTANCE_SIGNATURE)\r
#define DHCP6_SERVICE_FROM_THIS(Service)   CR ((Service), DHCP6_SERVICE, ServiceBinding, DHCP6_SERVICE_SIGNATURE)\r
\r
extern EFI_IPv6_ADDRESS           mAllDhcpRelayAndServersAddress;\r
extern EFI_IPv6_ADDRESS           mAllDhcpServersAddress;\r
extern EFI_DHCP6_PROTOCOL         gDhcp6ProtocolTemplate;\r
\r
//\r
// Control block for each IA.\r
//\r
struct _DHCP6_IA_CB {\r
  EFI_DHCP6_IA                  *Ia;\r
  UINT32                        T1;\r
  UINT32                        T2;\r
  UINT32                        AllExpireTime;\r
  UINT32                        LeaseTime;\r
};\r
\r
//\r
// Control block for each transmitted message.\r
//\r
struct _DHCP6_TX_CB {\r
  LIST_ENTRY                    Link;\r
  UINT32                        Xid;\r
  EFI_DHCP6_PACKET              *TxPacket;\r
  EFI_DHCP6_RETRANSMISSION      RetryCtl;\r
  UINT32                        RetryCnt;\r
  UINT32                        RetryExp;\r
  UINT32                        RetryLos;\r
  UINT32                        TickTime;\r
  UINT16                        *Elapsed;\r
  BOOLEAN                       SolicitRetry;\r
};\r
\r
//\r
// Control block for each info-request message.\r
//\r
struct _DHCP6_INF_CB {\r
  LIST_ENTRY                    Link;\r
  UINT32                        Xid;\r
  EFI_DHCP6_INFO_CALLBACK       ReplyCallback;\r
  VOID                          *CallbackContext;\r
  EFI_EVENT                     TimeoutEvent;\r
};\r
\r
//\r
// Control block for Dhcp6 instance, it's per configuration data.\r
//\r
struct _DHCP6_INSTANCE {\r
  UINT32                        Signature;\r
  EFI_HANDLE                    Handle;\r
  DHCP6_SERVICE                 *Service;\r
  LIST_ENTRY                    Link;\r
  EFI_DHCP6_PROTOCOL            Dhcp6;\r
  EFI_EVENT                     Timer;\r
  EFI_DHCP6_CONFIG_DATA         *Config;\r
  EFI_DHCP6_IA                  *CacheIa;\r
  DHCP6_IA_CB                   IaCb;\r
  LIST_ENTRY                    TxList;\r
  LIST_ENTRY                    InfList;\r
  EFI_DHCP6_PACKET              *AdSelect;\r
  UINT8                         AdPref;\r
  EFI_IPv6_ADDRESS              *Unicast;\r
  volatile EFI_STATUS           UdpSts;\r
  BOOLEAN                       InDestroy;\r
  BOOLEAN                       MediaPresent;\r
  //\r
  // StartTime is used to calculate the 'elapsed-time' option. Refer to RFC3315,\r
  // the elapsed-time is amount of time since the client began its current DHCP transaction. \r
  //\r
  UINT64                        StartTime;\r
};\r
\r
//\r
// Control block for Dhcp6 service, it's per Nic handle.\r
//\r
struct _DHCP6_SERVICE {\r
  UINT32                        Signature;\r
  EFI_HANDLE                    Controller;\r
  EFI_HANDLE                    Image;\r
  EFI_SERVICE_BINDING_PROTOCOL  ServiceBinding;\r
  EFI_SIMPLE_NETWORK_PROTOCOL   *Snp;\r
  EFI_IP6_CONFIG_PROTOCOL       *Ip6Cfg;\r
  EFI_DHCP6_DUID                *ClientId;\r
  UDP_IO                        *UdpIo;\r
  UINT32                        Xid;\r
  LIST_ENTRY                    Child;\r
  UINTN                         NumOfChild;\r
};\r
\r
/**\r
  Starts the DHCPv6 standard S.A.R.R. process.\r
\r
  The Start() function starts the DHCPv6 standard process. This function can\r
  be called only when the state of Dhcp6 instance is in the Dhcp6Init state.\r
  If the DHCP process completes successfully, the state of the Dhcp6 instance\r
  will be transferred through Dhcp6Selecting and Dhcp6Requesting to the\r
  Dhcp6Bound state.\r
  Refer to rfc-3315 for precise state transitions during this process. At the\r
  time when each event occurs in this process, the callback function that was set\r
  by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take this\r
  opportunity to control the process.\r
\r
  @param[in]  This              The pointer to Dhcp6 protocol.\r
\r
  @retval EFI_SUCCESS           The DHCPv6 standard process has started, or it\r
                                completed when CompletionEvent was 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_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
  @retval EFI_TIMEOUT           The DHCPv6 configuration process failed because no\r
                                response was received from the server within the\r
                                specified timeout value.\r
  @retval EFI_ABORTED           The user aborted the DHCPv6 process.\r
  @retval EFI_ALREADY_STARTED   Some other Dhcp6 instance already started the DHCPv6\r
                                standard process.\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Start (\r
  IN EFI_DHCP6_PROTOCOL        *This\r
  );\r
\r
/**\r
  Stops the DHCPv6 standard S.A.R.R. process.\r
\r
  The Stop() function is used to stop the DHCPv6 standard process. After this\r
  function is called successfully, the state of Dhcp6 instance is transferred\r
  into the Dhcp6Init. EFI_DHCP6_PROTOCOL.Configure() needs to be called\r
  before DHCPv6 standard process can be started again. This function can be\r
  called when the Dhcp6 instance is in any state.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
\r
  @retval EFI_SUCCESS           The Dhcp6 instance is now in the Dhcp6Init state.\r
  @retval EFI_INVALID_PARAMETER This is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Stop (\r
  IN EFI_DHCP6_PROTOCOL        *This\r
  );\r
\r
/**\r
  Returns the current operating mode data for the Dhcp6 instance.\r
\r
  The GetModeData() function returns the current operating mode and\r
  cached data packet for the Dhcp6 instance.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
  @param[out] Dhcp6ModeData     The pointer to the Dhcp6 mode data.\r
  @param[out] Dhcp6ConfigData   The pointer to the Dhcp6 configure data.\r
\r
  @retval EFI_SUCCESS           The mode data was returned.\r
  @retval EFI_INVALID_PARAMETER This is NULL.\r
  @retval EFI_ACCESS_DENIED     The EFI DHCPv6 Protocol instance has not\r
                                been configured when Dhcp6ConfigData is\r
                                not NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6GetModeData (\r
  IN  EFI_DHCP6_PROTOCOL       *This,\r
  OUT EFI_DHCP6_MODE_DATA      *Dhcp6ModeData      OPTIONAL,\r
  OUT EFI_DHCP6_CONFIG_DATA    *Dhcp6ConfigData    OPTIONAL\r
  );\r
\r
/**\r
  Initializes, changes, or resets the operational settings for the Dhcp6 instance.\r
\r
  The Configure() function is used to initialize or clean up the configuration\r
  data of the Dhcp6 instance:\r
  - When Dhcp6CfgData is not NULL and Configure() is called successfully, the\r
    configuration data will be initialized in the Dhcp6 instance and the state\r
    of the configured IA will be transferred into Dhcp6Init.\r
  - When Dhcp6CfgData is NULL and Configure() is called successfully, the\r
    configuration data will be cleaned up and no IA will be associated with\r
    the Dhcp6 instance.\r
  To update the configuration data for an Dhcp6 instance, the original data\r
  must be cleaned up before setting the new configuration data.\r
\r
  @param[in]  This                   The pointer to the Dhcp6 protocol\r
  @param[in]  Dhcp6CfgData           The pointer to the EFI_DHCP6_CONFIG_DATA.\r
\r
  @retval EFI_SUCCESS           The Dhcp6 is configured successfully with the\r
                                Dhcp6Init state, or cleaned up the original\r
                                configuration setting.\r
  @retval EFI_ACCESS_DENIED     The Dhcp6 instance has been already configured\r
                                when Dhcp6CfgData is not NULL.\r
                                The Dhcp6 instance has already started the\r
                                DHCPv6 S.A.R.R when Dhcp6CfgData is NULL.\r
  @retval EFI_INVALID_PARAMETER Some of the parameter is invalid.\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
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Configure (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN EFI_DHCP6_CONFIG_DATA     *Dhcp6CfgData    OPTIONAL\r
  );\r
\r
/**\r
  Request configuration information without the assignment of any\r
  Ia addresses of the client.\r
\r
  The InfoRequest() function is used to request configuration information\r
  without the assignment of any IPv6 address of the client. Client sends\r
  out Information Request packet to obtain the required configuration\r
  information, and DHCPv6 server responds with Reply packet containing\r
  the information for the client. The received Reply packet will be passed\r
  to the user by ReplyCallback function. If user returns EFI_NOT_READY from\r
  ReplyCallback, the Dhcp6 instance will continue to receive other Reply\r
  packets unless timeout according to the Retransmission parameter.\r
  Otherwise, the Information Request exchange process will be finished\r
  successfully if user returns EFI_SUCCESS from ReplyCallback.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
  @param[in]  SendClientId      If TRUE, the DHCPv6 protocol instance will build Client\r
                                Identifier option and include it into Information Request\r
                                packet. Otherwise, Client Identifier option will not be included.\r
  @param[in]  OptionRequest     The pointer to the buffer of option request options.\r
  @param[in]  OptionCount       The option number in the OptionList.\r
  @param[in]  OptionList        The list of appended options.\r
  @param[in]  Retransmission    The pointer to the retransmission of the message.\r
  @param[in]  TimeoutEvent      The event of timeout.\r
  @param[in]  ReplyCallback     The callback function when a reply was received.\r
  @param[in]  CallbackContext   The pointer to the parameter passed to the callback.\r
\r
  @retval EFI_SUCCESS           The DHCPv6 information request exchange process\r
                                completed when TimeoutEvent is NULL. Information\r
                                Request packet has been sent to DHCPv6 server when\r
                                TimeoutEvent is not NULL.\r
  @retval EFI_NO_RESPONSE       The DHCPv6 information request exchange process failed\r
                                because of no response, or not all requested-options\r
                                are responded to by DHCPv6 servers when Timeout happened.\r
  @retval EFI_ABORTED           The DHCPv6 information request exchange process was aborted\r
                                by the user.\r
  @retval EFI_INVALID_PARAMETER Some parameter 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
EFI_STATUS\r
EFIAPI\r
EfiDhcp6InfoRequest (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN BOOLEAN                   SendClientId,\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_EVENT                 TimeoutEvent     OPTIONAL,\r
  IN EFI_DHCP6_INFO_CALLBACK   ReplyCallback,\r
  IN VOID                      *CallbackContext OPTIONAL\r
  );\r
\r
/**\r
  Manually extend the valid and preferred lifetimes for the IPv6 addresses\r
  of the configured IA and update other configuration parameters by sending\r
  Renew or Rebind packet.\r
\r
  The RenewRebind() function is used to manually extend the valid and preferred\r
  lifetimes for the IPv6 addresses of the configured IA and update other\r
  configuration parameters by sending a Renew or Rebind packet.\r
  - When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound,\r
    it will send Renew packet to the previously DHCPv6 server and transfer the\r
    state of the configured IA to Dhcp6Renewing. If valid Reply packet received,\r
    the state transfers to Dhcp6Bound and the valid and preferred timer restarts.\r
    If fails, the state transfers to Dhcp6Bound but the timer continues.\r
  - When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound,\r
    it will send a Rebind packet. If a valid Reply packet is received, the state transfers\r
    to Dhcp6Bound, and the valid and preferred timer restarts. If it fails, the state\r
    transfers to Dhcp6Init, and the IA can't be used.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
  @param[in]  RebindRequest     If TRUE, Rebind packet will be sent and enter Dhcp6Rebinding state.\r
                                Otherwise, Renew packet will be sent and enter Dhcp6Renewing state.\r
\r
  @retval EFI_SUCCESS           The DHCPv6 renew/rebind exchange process\r
                                completed and at least one IPv6 address of the\r
                                configured IA was bound again when\r
                                EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.\r
                                The EFI DHCPv6 Protocol instance has sent Renew\r
                                or Rebind packet when\r
                                EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
  @retval EFI_ACCESS_DENIED     The Dhcp6 instance hasn't been configured, or the\r
                                state of the configured IA is not in Dhcp6Bound.\r
  @retval EFI_ALREADY_STARTED   The state of the configured IA has already entered\r
                                Dhcp6Renewing when RebindRequest is FALSE.\r
                                The state of the configured IA has already entered\r
                                Dhcp6Rebinding when RebindRequest is TRUE.\r
  @retval EFI_ABORTED           The DHCPv6 renew/rebind exchange process aborted\r
                                by user.\r
  @retval EFI_NO_RESPONSE       The DHCPv6 renew/rebind exchange process failed\r
                                because of no response.\r
  @retval EFI_NO_MAPPING        No IPv6 address has been bound to the configured\r
                                IA after the DHCPv6 renew/rebind exchange process.\r
  @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6RenewRebind (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN BOOLEAN                   RebindRequest\r
  );\r
\r
/**\r
  Inform that one or more addresses assigned by a server are already\r
  in use by another node.\r
\r
  The Decline() function is used to manually decline the assignment of\r
  IPv6 addresses, which have been already used by another node. If all\r
  IPv6 addresses of the configured IA are declined through this function,\r
  the state of the IA will switch through Dhcp6Declining to Dhcp6Init.\r
  Otherwise, the state of the IA will restore to Dhcp6Bound after the\r
  declining process. The Decline() can only be called when the IA is in\r
  Dhcp6Bound state. If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL,\r
  this function is a blocking operation. It will return after the\r
  declining process finishes, or aborted by user.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
  @param[in]  AddressCount      The number of declining addresses.\r
  @param[in]  Addresses         The pointer to the buffer stored the declining\r
                                addresses.\r
\r
  @retval EFI_SUCCESS           The DHCPv6 decline exchange process completed\r
                                when EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.\r
                                The Dhcp6 instance has sent Decline packet when\r
                                EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
  @retval EFI_ACCESS_DENIED     The Dhcp6 instance hasn't been configured, or the\r
                                state of the configured IA is not in Dhcp6Bound.\r
  @retval EFI_ABORTED           The DHCPv6 decline exchange process was aborted by the user.\r
  @retval EFI_NOT_FOUND         Any specified IPv6 address is not correlated with\r
                                the configured IA for this instance.\r
  @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Decline (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN UINT32                    AddressCount,\r
  IN EFI_IPv6_ADDRESS          *Addresses\r
  );\r
\r
/**\r
  Release one or more addresses associated with the configured Ia\r
  for the current instance.\r
\r
  The Release() function is used to manually release the one or more\r
  IPv6 address. If AddressCount is zero, it will release all IPv6\r
  addresses of the configured IA. If all IPv6 addresses of the IA are\r
  released through this function, the state of the IA will switch\r
  through Dhcp6Releasing to Dhcp6Init, otherwise, the state of the\r
  IA will restore to Dhcp6Bound after the releasing process.\r
  The Release() can only be called when the IA is in a Dhcp6Bound state.\r
  If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the function is\r
  a blocking operation. It will return after the releasing process\r
  finishes, or aborted by user.\r
\r
  @param[in]  This              The pointer to the Dhcp6 protocol.\r
  @param[in]  AddressCount      The number of releasing addresses.\r
  @param[in]  Addresses         The pointer to the buffer stored the releasing\r
                                addresses.\r
  @retval EFI_SUCCESS           The DHCPv6 release exchange process has\r
                                completed when EFI_DHCP6_CONFIG_DATA.IaInfoEvent\r
                                is NULL. The Dhcp6 instance has sent Release\r
                                packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent\r
                                is not NULL.\r
  @retval EFI_ACCESS_DENIED     The Dhcp6 instance hasn't been configured, or the\r
                                state of the configured IA is not in Dhcp6Bound.\r
  @retval EFI_ABORTED           The DHCPv6 release exchange process was aborted by the user.\r
  @retval EFI_NOT_FOUND         Any specified IPv6 address is not correlated with\r
                                the configured IA for this instance.\r
  @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
  @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Release (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN UINT32                    AddressCount,\r
  IN EFI_IPv6_ADDRESS          *Addresses\r
  );\r
\r
/**\r
  Parse the option data in the Dhcp6 packet.\r
\r
  The Parse() function is used to retrieve the option list in the DHCPv6 packet.\r
\r
  @param[in]      This              The pointer to the Dhcp6 protocol.\r
  @param[in]      Packet            The pointer to the Dhcp6 packet.\r
  @param[in, out] OptionCount       The number of option in the packet.\r
  @param[out]     PacketOptionList  The array of pointers to the each option in the packet.\r
\r
  @retval EFI_SUCCESS           The packet was successfully parsed.\r
  @retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
  @retval EFI_BUFFER_TOO_SMALL  *OptionCount is smaller than the number of options\r
                                that were found in the Packet.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiDhcp6Parse (\r
  IN EFI_DHCP6_PROTOCOL        *This,\r
  IN EFI_DHCP6_PACKET          *Packet,\r
  IN OUT UINT32                *OptionCount,\r
  OUT EFI_DHCP6_PACKET_OPTION  *PacketOptionList[]  OPTIONAL\r
  );\r
\r
#endif\r
Commit	Line	Data
a3bcde70 HT	1	/** @file\r
	2	Dhcp6 internal data structure and definition declaration.\r
	3	\r
142c00c3	4	Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
a3bcde70 HT	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __EFI_DHCP6_IMPL_H__\r
	17	#define __EFI_DHCP6_IMPL_H__\r
	18	\r
	19	\r
	20	#include <Uefi.h>\r
	21	\r
142c00c3 ZL	22	#include <IndustryStandard/Dhcp.h>\r
142c00c3 ZL	23	\r
a3bcde70 HT	24	#include <Protocol/Dhcp6.h>\r
a3bcde70 HT	25	#include <Protocol/Udp6.h>\r
cc658224	26	#include <Protocol/Ip6Config.h>\r
a3bcde70 HT	27	#include <Protocol/ServiceBinding.h>\r
	28	#include <Protocol/DriverBinding.h>\r
	29	\r
	30	#include <Library/UdpIoLib.h>\r
	31	#include <Library/DebugLib.h>\r
	32	#include <Library/BaseMemoryLib.h>\r
	33	#include <Library/MemoryAllocationLib.h>\r
	34	#include <Library/UefiBootServicesTableLib.h>\r
	35	#include <Library/UefiRuntimeServicesTableLib.h>\r
	36	#include <Library/UefiLib.h>\r
	37	#include <Library/BaseLib.h>\r
	38	#include <Library/NetLib.h>\r
216f7970	39	#include <Library/PrintLib.h>\r
a3bcde70 HT	40	\r
	41	\r
	42	typedef struct _DHCP6_IA_CB DHCP6_IA_CB;\r
	43	typedef struct _DHCP6_INF_CB DHCP6_INF_CB;\r
	44	typedef struct _DHCP6_TX_CB DHCP6_TX_CB;\r
	45	typedef struct _DHCP6_SERVICE DHCP6_SERVICE;\r
	46	typedef struct _DHCP6_INSTANCE DHCP6_INSTANCE;\r
	47	\r
	48	#include "Dhcp6Utility.h"\r
	49	#include "Dhcp6Io.h"\r
	50	#include "Dhcp6Driver.h"\r
	51	\r
	52	#define DHCP6_SERVICE_SIGNATURE SIGNATURE_32 ('D', 'H', '6', 'S')\r
	53	#define DHCP6_INSTANCE_SIGNATURE SIGNATURE_32 ('D', 'H', '6', 'I')\r
	54	\r
a3bcde70 HT	55	#define DHCP6_PACKET_ALL 0\r
	56	#define DHCP6_PACKET_STATEFUL 1\r
	57	#define DHCP6_PACKET_STATELESS 2\r
	58	\r
	59	#define DHCP6_BASE_PACKET_SIZE 1024\r
	60	\r
	61	#define DHCP6_PORT_CLIENT 546\r
	62	#define DHCP6_PORT_SERVER 547\r
	63	\r
	64	#define DHCP6_INSTANCE_FROM_THIS(Instance) CR ((Instance), DHCP6_INSTANCE, Dhcp6, DHCP6_INSTANCE_SIGNATURE)\r
	65	#define DHCP6_SERVICE_FROM_THIS(Service) CR ((Service), DHCP6_SERVICE, ServiceBinding, DHCP6_SERVICE_SIGNATURE)\r
	66	\r
	67	extern EFI_IPv6_ADDRESS mAllDhcpRelayAndServersAddress;\r
	68	extern EFI_IPv6_ADDRESS mAllDhcpServersAddress;\r
	69	extern EFI_DHCP6_PROTOCOL gDhcp6ProtocolTemplate;\r
	70	\r
a3bcde70 HT	71	//\r
	72	// Control block for each IA.\r
	73	//\r
	74	struct _DHCP6_IA_CB {\r
	75	EFI_DHCP6_IA *Ia;\r
	76	UINT32 T1;\r
	77	UINT32 T2;\r
	78	UINT32 AllExpireTime;\r
	79	UINT32 LeaseTime;\r
	80	};\r
	81	\r
	82	//\r
	83	// Control block for each transmitted message.\r
	84	//\r
	85	struct _DHCP6_TX_CB {\r
	86	LIST_ENTRY Link;\r
	87	UINT32 Xid;\r
	88	EFI_DHCP6_PACKET *TxPacket;\r
	89	EFI_DHCP6_RETRANSMISSION RetryCtl;\r
	90	UINT32 RetryCnt;\r
	91	UINT32 RetryExp;\r
	92	UINT32 RetryLos;\r
	93	UINT32 TickTime;\r
	94	UINT16 *Elapsed;\r
129b8b09	95	BOOLEAN SolicitRetry;\r
a3bcde70 HT	96	};\r
	97	\r
	98	//\r
	99	// Control block for each info-request message.\r
	100	//\r
	101	struct _DHCP6_INF_CB {\r
	102	LIST_ENTRY Link;\r
	103	UINT32 Xid;\r
	104	EFI_DHCP6_INFO_CALLBACK ReplyCallback;\r
	105	VOID *CallbackContext;\r
	106	EFI_EVENT TimeoutEvent;\r
	107	};\r
	108	\r
	109	//\r
	110	// Control block for Dhcp6 instance, it's per configuration data.\r
	111	//\r
	112	struct _DHCP6_INSTANCE {\r
	113	UINT32 Signature;\r
	114	EFI_HANDLE Handle;\r
	115	DHCP6_SERVICE *Service;\r
	116	LIST_ENTRY Link;\r
	117	EFI_DHCP6_PROTOCOL Dhcp6;\r
	118	EFI_EVENT Timer;\r
	119	EFI_DHCP6_CONFIG_DATA *Config;\r
	120	EFI_DHCP6_IA *CacheIa;\r
	121	DHCP6_IA_CB IaCb;\r
	122	LIST_ENTRY TxList;\r
	123	LIST_ENTRY InfList;\r
	124	EFI_DHCP6_PACKET *AdSelect;\r
	125	UINT8 AdPref;\r
	126	EFI_IPv6_ADDRESS *Unicast;\r
216f7970	127	volatile EFI_STATUS UdpSts;\r
75dce340	128	BOOLEAN InDestroy;\r
a3bcde70	129	BOOLEAN MediaPresent;\r
685e44a5	130	//\r
	131	// StartTime is used to calculate the 'elapsed-time' option. Refer to RFC3315,\r
	132	// the elapsed-time is amount of time since the client began its current DHCP transaction. \r
	133	//\r
a3bcde70 HT	134	UINT64 StartTime;\r
	135	};\r
	136	\r
	137	//\r
	138	// Control block for Dhcp6 service, it's per Nic handle.\r
	139	//\r
	140	struct _DHCP6_SERVICE {\r
	141	UINT32 Signature;\r
	142	EFI_HANDLE Controller;\r
	143	EFI_HANDLE Image;\r
	144	EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r
	145	EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
cc658224	146	EFI_IP6_CONFIG_PROTOCOL *Ip6Cfg;\r
a3bcde70 HT	147	EFI_DHCP6_DUID *ClientId;\r
	148	UDP_IO *UdpIo;\r
	149	UINT32 Xid;\r
	150	LIST_ENTRY Child;\r
	151	UINTN NumOfChild;\r
a3bcde70 HT	152	};\r
	153	\r
	154	/**\r
	155	Starts the DHCPv6 standard S.A.R.R. process.\r
	156	\r
	157	The Start() function starts the DHCPv6 standard process. This function can\r
	158	be called only when the state of Dhcp6 instance is in the Dhcp6Init state.\r
	159	If the DHCP process completes successfully, the state of the Dhcp6 instance\r
	160	will be transferred through Dhcp6Selecting and Dhcp6Requesting to the\r
	161	Dhcp6Bound state.\r
	162	Refer to rfc-3315 for precise state transitions during this process. At the\r
	163	time when each event occurs in this process, the callback function that was set\r
	164	by EFI_DHCP6_PROTOCOL.Configure() will be called and the user can take this\r
	165	opportunity to control the process.\r
	166	\r
	167	@param[in] This The pointer to Dhcp6 protocol.\r
	168	\r
	169	@retval EFI_SUCCESS The DHCPv6 standard process has started, or it\r
	170	completed when CompletionEvent was NULL.\r
	171	@retval EFI_ACCESS_DENIED The EFI DHCPv6 Child instance hasn't been configured.\r
	172	@retval EFI_INVALID_PARAMETER This is NULL.\r
	173	@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
	174	@retval EFI_TIMEOUT The DHCPv6 configuration process failed because no\r
	175	response was received from the server within the\r
	176	specified timeout value.\r
	177	@retval EFI_ABORTED The user aborted the DHCPv6 process.\r
	178	@retval EFI_ALREADY_STARTED Some other Dhcp6 instance already started the DHCPv6\r
	179	standard process.\r
	180	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
	181	\r
	182	**/\r
	183	EFI_STATUS\r
	184	EFIAPI\r
	185	EfiDhcp6Start (\r
	186	IN EFI_DHCP6_PROTOCOL *This\r
	187	);\r
	188	\r
	189	/**\r
	190	Stops the DHCPv6 standard S.A.R.R. process.\r
	191	\r
	192	The Stop() function is used to stop the DHCPv6 standard process. After this\r
	193	function is called successfully, the state of Dhcp6 instance is transferred\r
	194	into the Dhcp6Init. EFI_DHCP6_PROTOCOL.Configure() needs to be called\r
	195	before DHCPv6 standard process can be started again. This function can be\r
	196	called when the Dhcp6 instance is in any state.\r
	197	\r
	198	@param[in] This The pointer to the Dhcp6 protocol.\r
	199	\r
	200	@retval EFI_SUCCESS The Dhcp6 instance is now in the Dhcp6Init state.\r
	201	@retval EFI_INVALID_PARAMETER This is NULL.\r
	202	\r
	203	**/\r
	204	EFI_STATUS\r
	205	EFIAPI\r
	206	EfiDhcp6Stop (\r
	207	IN EFI_DHCP6_PROTOCOL *This\r
	208	);\r
	209	\r
	210	/**\r
	211	Returns the current operating mode data for the Dhcp6 instance.\r
	212	\r
	213	The GetModeData() function returns the current operating mode and\r
	214	cached data packet for the Dhcp6 instance.\r
	215	\r
216	@param[in] This The pointer to the Dhcp6 protocol.\r
217	@param[out] Dhcp6ModeData The pointer to the Dhcp6 mode data.\r
218	@param[out] Dhcp6ConfigData The pointer to the Dhcp6 configure data.\r
219	\r
220	@retval EFI_SUCCESS The mode data was returned.\r
221	@retval EFI_INVALID_PARAMETER This is NULL.\r
222	@retval EFI_ACCESS_DENIED The EFI DHCPv6 Protocol instance has not\r
223	been configured when Dhcp6ConfigData is\r
224	not NULL.\r
225	**/\r
226	EFI_STATUS\r
227	EFIAPI\r
228	EfiDhcp6GetModeData (\r
229	IN EFI_DHCP6_PROTOCOL *This,\r
230	OUT EFI_DHCP6_MODE_DATA *Dhcp6ModeData OPTIONAL,\r
231	OUT EFI_DHCP6_CONFIG_DATA *Dhcp6ConfigData OPTIONAL\r
232	);\r
233	\r
234	/**\r
235	Initializes, changes, or resets the operational settings for the Dhcp6 instance.\r
236	\r
237	The Configure() function is used to initialize or clean up the configuration\r
238	data of the Dhcp6 instance:\r
239	- When Dhcp6CfgData is not NULL and Configure() is called successfully, the\r
240	configuration data will be initialized in the Dhcp6 instance and the state\r
241	of the configured IA will be transferred into Dhcp6Init.\r
242	- When Dhcp6CfgData is NULL and Configure() is called successfully, the\r
243	configuration data will be cleaned up and no IA will be associated with\r
244	the Dhcp6 instance.\r
245	To update the configuration data for an Dhcp6 instance, the original data\r
246	must be cleaned up before setting the new configuration data.\r
247	\r
248	@param[in] This The pointer to the Dhcp6 protocol\r
249	@param[in] Dhcp6CfgData The pointer to the EFI_DHCP6_CONFIG_DATA.\r
250	\r
251	@retval EFI_SUCCESS The Dhcp6 is configured successfully with the\r
252	Dhcp6Init state, or cleaned up the original\r
253	configuration setting.\r
254	@retval EFI_ACCESS_DENIED The Dhcp6 instance has been already configured\r
255	when Dhcp6CfgData is not NULL.\r
256	The Dhcp6 instance has already started the\r
257	DHCPv6 S.A.R.R when Dhcp6CfgData is NULL.\r
258	@retval EFI_INVALID_PARAMETER Some of the parameter is invalid.\r
259	@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
260	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
261	\r
262	**/\r
263	EFI_STATUS\r
264	EFIAPI\r
265	EfiDhcp6Configure (\r
266	IN EFI_DHCP6_PROTOCOL *This,\r
267	IN EFI_DHCP6_CONFIG_DATA *Dhcp6CfgData OPTIONAL\r
268	);\r
269	\r
270	/**\r
271	Request configuration information without the assignment of any\r
272	Ia addresses of the client.\r
273	\r
274	The InfoRequest() function is used to request configuration information\r
275	without the assignment of any IPv6 address of the client. Client sends\r
276	out Information Request packet to obtain the required configuration\r
277	information, and DHCPv6 server responds with Reply packet containing\r
278	the information for the client. The received Reply packet will be passed\r
279	to the user by ReplyCallback function. If user returns EFI_NOT_READY from\r
280	ReplyCallback, the Dhcp6 instance will continue to receive other Reply\r
281	packets unless timeout according to the Retransmission parameter.\r
282	Otherwise, the Information Request exchange process will be finished\r
283	successfully if user returns EFI_SUCCESS from ReplyCallback.\r
284	\r
285	@param[in] This The pointer to the Dhcp6 protocol.\r
286	@param[in] SendClientId If TRUE, the DHCPv6 protocol instance will build Client\r
287	Identifier option and include it into Information Request\r
288	packet. Otherwise, Client Identifier option will not be included.\r
289	@param[in] OptionRequest The pointer to the buffer of option request options.\r
290	@param[in] OptionCount The option number in the OptionList.\r
291	@param[in] OptionList The list of appended options.\r
292	@param[in] Retransmission The pointer to the retransmission of the message.\r
293	@param[in] TimeoutEvent The event of timeout.\r
294	@param[in] ReplyCallback The callback function when a reply was received.\r
295	@param[in] CallbackContext The pointer to the parameter passed to the callback.\r
296	\r
297	@retval EFI_SUCCESS The DHCPv6 information request exchange process\r
298	completed when TimeoutEvent is NULL. Information\r
299	Request packet has been sent to DHCPv6 server when\r
300	TimeoutEvent is not NULL.\r
301	@retval EFI_NO_RESPONSE The DHCPv6 information request exchange process failed\r
302	because of no response, or not all requested-options\r
303	are responded to by DHCPv6 servers when Timeout happened.\r
304	@retval EFI_ABORTED The DHCPv6 information request exchange process was aborted\r
305	by the user.\r
306	@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
307	@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
308	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
309	\r
310	**/\r
311	EFI_STATUS\r
312	EFIAPI\r
313	EfiDhcp6InfoRequest (\r
314	IN EFI_DHCP6_PROTOCOL *This,\r
315	IN BOOLEAN SendClientId,\r
316	IN EFI_DHCP6_PACKET_OPTION *OptionRequest,\r
317	IN UINT32 OptionCount,\r
318	IN EFI_DHCP6_PACKET_OPTION *OptionList[] OPTIONAL,\r
319	IN EFI_DHCP6_RETRANSMISSION *Retransmission,\r
320	IN EFI_EVENT TimeoutEvent OPTIONAL,\r
321	IN EFI_DHCP6_INFO_CALLBACK ReplyCallback,\r
322	IN VOID *CallbackContext OPTIONAL\r
323	);\r
324	\r
325	/**\r
326	Manually extend the valid and preferred lifetimes for the IPv6 addresses\r
327	of the configured IA and update other configuration parameters by sending\r
328	Renew or Rebind packet.\r
329	\r
330	The RenewRebind() function is used to manually extend the valid and preferred\r
331	lifetimes for the IPv6 addresses of the configured IA and update other\r
332	configuration parameters by sending a Renew or Rebind packet.\r
333	- When RebindRequest is FALSE and the state of the configured IA is Dhcp6Bound,\r
334	it will send Renew packet to the previously DHCPv6 server and transfer the\r
335	state of the configured IA to Dhcp6Renewing. If valid Reply packet received,\r
336	the state transfers to Dhcp6Bound and the valid and preferred timer restarts.\r
337	If fails, the state transfers to Dhcp6Bound but the timer continues.\r
338	- When RebindRequest is TRUE and the state of the configured IA is Dhcp6Bound,\r
339	it will send a Rebind packet. If a valid Reply packet is received, the state transfers\r
340	to Dhcp6Bound, and the valid and preferred timer restarts. If it fails, the state\r
341	transfers to Dhcp6Init, and the IA can't be used.\r
342	\r
343	@param[in] This The pointer to the Dhcp6 protocol.\r
344	@param[in] RebindRequest If TRUE, Rebind packet will be sent and enter Dhcp6Rebinding state.\r
345	Otherwise, Renew packet will be sent and enter Dhcp6Renewing state.\r
346	\r
347	@retval EFI_SUCCESS The DHCPv6 renew/rebind exchange process\r
348	completed and at least one IPv6 address of the\r
349	configured IA was bound again when\r
350	EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.\r
351	The EFI DHCPv6 Protocol instance has sent Renew\r
352	or Rebind packet when\r
353	EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
354	@retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the\r
355	state of the configured IA is not in Dhcp6Bound.\r
356	@retval EFI_ALREADY_STARTED The state of the configured IA has already entered\r
357	Dhcp6Renewing when RebindRequest is FALSE.\r
358	The state of the configured IA has already entered\r
359	Dhcp6Rebinding when RebindRequest is TRUE.\r
360	@retval EFI_ABORTED The DHCPv6 renew/rebind exchange process aborted\r
361	by user.\r
362	@retval EFI_NO_RESPONSE The DHCPv6 renew/rebind exchange process failed\r
363	because of no response.\r
364	@retval EFI_NO_MAPPING No IPv6 address has been bound to the configured\r
365	IA after the DHCPv6 renew/rebind exchange process.\r
366	@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
367	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
368	\r
369	**/\r
370	EFI_STATUS\r
371	EFIAPI\r
372	EfiDhcp6RenewRebind (\r
373	IN EFI_DHCP6_PROTOCOL *This,\r
374	IN BOOLEAN RebindRequest\r
375	);\r
376	\r
377	/**\r
378	Inform that one or more addresses assigned by a server are already\r
379	in use by another node.\r
380	\r
381	The Decline() function is used to manually decline the assignment of\r
382	IPv6 addresses, which have been already used by another node. If all\r
383	IPv6 addresses of the configured IA are declined through this function,\r
384	the state of the IA will switch through Dhcp6Declining to Dhcp6Init.\r
385	Otherwise, the state of the IA will restore to Dhcp6Bound after the\r
386	declining process. The Decline() can only be called when the IA is in\r
387	Dhcp6Bound state. If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL,\r
388	this function is a blocking operation. It will return after the\r
389	declining process finishes, or aborted by user.\r
390	\r
391	@param[in] This The pointer to the Dhcp6 protocol.\r
392	@param[in] AddressCount The number of declining addresses.\r
393	@param[in] Addresses The pointer to the buffer stored the declining\r
394	addresses.\r
395	\r
396	@retval EFI_SUCCESS The DHCPv6 decline exchange process completed\r
397	when EFI_DHCP6_CONFIG_DATA.IaInfoEvent was NULL.\r
398	The Dhcp6 instance has sent Decline packet when\r
399	EFI_DHCP6_CONFIG_DATA.IaInfoEvent is not NULL.\r
400	@retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the\r
401	state of the configured IA is not in Dhcp6Bound.\r
402	@retval EFI_ABORTED The DHCPv6 decline exchange process was aborted by the user.\r
403	@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with\r
404	the configured IA for this instance.\r
405	@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
406	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
407	\r
408	**/\r
409	EFI_STATUS\r
410	EFIAPI\r
411	EfiDhcp6Decline (\r
412	IN EFI_DHCP6_PROTOCOL *This,\r
413	IN UINT32 AddressCount,\r
414	IN EFI_IPv6_ADDRESS *Addresses\r
415	);\r
416	\r
417	/**\r
418	Release one or more addresses associated with the configured Ia\r
419	for the current instance.\r
420	\r
421	The Release() function is used to manually release the one or more\r
422	IPv6 address. If AddressCount is zero, it will release all IPv6\r
423	addresses of the configured IA. If all IPv6 addresses of the IA are\r
424	released through this function, the state of the IA will switch\r
425	through Dhcp6Releasing to Dhcp6Init, otherwise, the state of the\r
426	IA will restore to Dhcp6Bound after the releasing process.\r
427	The Release() can only be called when the IA is in a Dhcp6Bound state.\r
428	If the EFI_DHCP6_CONFIG_DATA.IaInfoEvent is NULL, the function is\r
429	a blocking operation. It will return after the releasing process\r
430	finishes, or aborted by user.\r
431	\r
432	@param[in] This The pointer to the Dhcp6 protocol.\r
433	@param[in] AddressCount The number of releasing addresses.\r
434	@param[in] Addresses The pointer to the buffer stored the releasing\r
435	addresses.\r
436	@retval EFI_SUCCESS The DHCPv6 release exchange process has\r
437	completed when EFI_DHCP6_CONFIG_DATA.IaInfoEvent\r
438	is NULL. The Dhcp6 instance has sent Release\r
439	packet when EFI_DHCP6_CONFIG_DATA.IaInfoEvent\r
440	is not NULL.\r
441	@retval EFI_ACCESS_DENIED The Dhcp6 instance hasn't been configured, or the\r
442	state of the configured IA is not in Dhcp6Bound.\r
443	@retval EFI_ABORTED The DHCPv6 release exchange process was aborted by the user.\r
444	@retval EFI_NOT_FOUND Any specified IPv6 address is not correlated with\r
445	the configured IA for this instance.\r
446	@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
447	@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
448	\r
449	**/\r
450	EFI_STATUS\r
451	EFIAPI\r
452	EfiDhcp6Release (\r
453	IN EFI_DHCP6_PROTOCOL *This,\r
454	IN UINT32 AddressCount,\r
455	IN EFI_IPv6_ADDRESS *Addresses\r
456	);\r
457	\r
458	/**\r
459	Parse the option data in the Dhcp6 packet.\r
460	\r
461	The Parse() function is used to retrieve the option list in the DHCPv6 packet.\r
462	\r
463	@param[in] This The pointer to the Dhcp6 protocol.\r
464	@param[in] Packet The pointer to the Dhcp6 packet.\r
465	@param[in, out] OptionCount The number of option in the packet.\r
466	@param[out] PacketOptionList The array of pointers to the each option in the packet.\r
467	\r
468	@retval EFI_SUCCESS The packet was successfully parsed.\r
469	@retval EFI_INVALID_PARAMETER Some parameter is NULL.\r
470	@retval EFI_BUFFER_TOO_SMALL *OptionCount is smaller than the number of options\r
471	that were found in the Packet.\r
472	\r
473	**/\r
474	EFI_STATUS\r
475	EFIAPI\r
476	EfiDhcp6Parse (\r
477	IN EFI_DHCP6_PROTOCOL *This,\r
478	IN EFI_DHCP6_PACKET *Packet,\r
479	IN OUT UINT32 *OptionCount,\r
480	OUT EFI_DHCP6_PACKET_OPTION *PacketOptionList[] OPTIONAL\r
481	);\r
482	\r
483	#endif\r