NetworkPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Dhcp6 internal data structure and definition declaration.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\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
#include <Guid/ZeroGuid.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 DHCP_CHECK_MEDIA_WAITING_TIME    EFI_TIMER_PERIOD_SECONDS(20)\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_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