NetworkPkg: comments clean up.

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

/** @file\r
  Dhcp6 support functions declaration.\r
\r
  Copyright (c) 2009 - 2011, 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_UTILITY_H__\r
#define __EFI_DHCP6_UTILITY_H__\r
\r
\r
#define  DHCP6_10_BIT_MASK     0x3ff\r
\r
/**\r
  Generate client Duid in the format of Duid-llt.\r
\r
  @param[in]  Mode          The pointer to the mode of SNP.\r
\r
  @retval     NULL          if failed to generate client Id.\r
  @retval     Others        The pointer to the new client id.\r
\r
**/\r
EFI_DHCP6_DUID *\r
Dhcp6GenerateClientId (\r
  IN EFI_SIMPLE_NETWORK_MODE    *Mode\r
  );\r
\r
/**\r
  Copy the Dhcp6 configure data.\r
\r
  @param[in]  DstCfg        The pointer to the destination configure data.\r
  @param[in]  SorCfg        The pointer to the source configure data.\r
\r
  @retval EFI_SUCCESS           Copy the content from SorCfg from DstCfg successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
\r
**/\r
EFI_STATUS\r
Dhcp6CopyConfigData (\r
  IN EFI_DHCP6_CONFIG_DATA     *DstCfg,\r
  IN EFI_DHCP6_CONFIG_DATA     *SorCfg\r
  );\r
\r
/**\r
  Clean up the configure data.\r
\r
  @param[in, out]  CfgData       The pointer to the configure data.\r
\r
**/\r
VOID\r
Dhcp6CleanupConfigData (\r
  IN OUT EFI_DHCP6_CONFIG_DATA       *CfgData\r
  );\r
\r
/**\r
  Clean up the mode data.\r
\r
  @param[in, out]  ModeData      The pointer to the mode data.\r
\r
**/\r
VOID\r
Dhcp6CleanupModeData (\r
  IN OUT EFI_DHCP6_MODE_DATA        *ModeData\r
  );\r
\r
/**\r
  Calculate the expire time by the algorithm defined in rfc.\r
\r
  @param[in]  Base          The base value of the time.\r
  @param[in]  IsFirstRt     If TRUE, it is the first time to calculate expire time.\r
  @param[in]  NeedSigned    If TRUE, the the signed factor is needed.\r
\r
  @return     Expire        The calculated result for the new expire time.\r
\r
**/\r
UINT32\r
Dhcp6CalculateExpireTime (\r
  IN UINT32                    Base,\r
  IN BOOLEAN                   IsFirstRt,\r
  IN BOOLEAN                   NeedSigned\r
  );\r
\r
/**\r
  Calculate the lease time by the algorithm defined in rfc.\r
\r
  @param[in]  IaCb          The pointer to the Ia control block.\r
\r
**/\r
VOID\r
Dhcp6CalculateLeaseTime (\r
  IN DHCP6_IA_CB               *IaCb\r
  );\r
\r
/**\r
  Check whether the addresses are all included by the configured Ia.\r
\r
  @param[in]  Ia            The pointer to the Ia.\r
  @param[in]  AddressCount  The number of addresses.\r
  @param[in]  Addresses     The pointer to the addresses buffer.\r
\r
  @retval EFI_SUCCESS         The addresses are all included by the configured IA.\r
  @retval EFI_NOT_FOUND       The addresses are not included by the configured IA.\r
\r
**/\r
EFI_STATUS\r
Dhcp6CheckAddress (\r
  IN EFI_DHCP6_IA              *Ia,\r
  IN UINT32                    AddressCount,\r
  IN EFI_IPv6_ADDRESS          *Addresses\r
  );\r
\r
/**\r
  Deprive the addresses from current Ia, and generate another eliminated Ia.\r
\r
  @param[in]  Ia            The pointer to the Ia.\r
  @param[in]  AddressCount  The number of addresses.\r
  @param[in]  Addresses     The pointer to the addresses buffer.\r
\r
  @retval     NULL          If failed to generate the deprived Ia.\r
  @retval     others        The pointer to the deprived Ia.\r
\r
**/\r
EFI_DHCP6_IA *\r
Dhcp6DepriveAddress (\r
  IN EFI_DHCP6_IA              *Ia,\r
  IN UINT32                    AddressCount,\r
  IN EFI_IPv6_ADDRESS          *Addresses\r
  );\r
\r
/**\r
  The dummy ext buffer free callback routine.\r
\r
  @param[in]  Arg           The pointer to the parameter.\r
\r
**/\r
VOID\r
EFIAPI\r
Dhcp6DummyExtFree (\r
  IN VOID                      *Arg\r
  );\r
\r
/**\r
  The callback routine once message transmitted.\r
\r
  @param[in]  Wrap          The pointer to the received net buffer.\r
  @param[in]  EndPoint      The pointer to the udp end point.\r
  @param[in]  IoStatus      The return status from udp io.\r
  @param[in]  Context       The opaque parameter to the function.\r
\r
**/\r
VOID\r
EFIAPI\r
Dhcp6OnTransmitted (\r
  IN NET_BUF                   *Wrap,\r
  IN UDP_END_POINT             *EndPoint,\r
  IN EFI_STATUS                IoStatus,\r
  IN VOID                      *Context\r
  );\r
\r
/**\r
  Append the appointed option to the buf, and move the buf to the end.\r
\r
  @param[in, out] Buf           The pointer to buffer.\r
  @param[in]      OptType       The option type.\r
  @param[in]      OptLen        The lenght of option content.s\r
  @param[in]      Data          The pointer to the option content.\r
\r
  @return         Buf           The position to append the next option.\r
\r
**/\r
UINT8 *\r
Dhcp6AppendOption (\r
  IN OUT UINT8                 *Buf,\r
  IN     UINT16                OptType,\r
  IN     UINT16                OptLen,\r
  IN     UINT8                 *Data\r
  );\r
\r
/**\r
  Append the Ia option to Buf, and move Buf to the end.\r
\r
  @param[in, out] Buf           The pointer to the position to append.\r
  @param[in]      Ia            The pointer to the Ia.\r
  @param[in]      T1            The time of T1.\r
  @param[in]      T2            The time of T2.\r
\r
  @return         Buf           The position to append the next Ia option.\r
\r
**/\r
UINT8 *\r
Dhcp6AppendIaOption (\r
  IN OUT UINT8                  *Buf,\r
  IN     EFI_DHCP6_IA           *Ia,\r
  IN     UINT32                 T1,\r
  IN     UINT32                 T2\r
  );\r
\r
/**\r
  Append the appointed Elapsed time option to Buf, and move Buf to the end.\r
\r
  @param[in, out] Buf           The pointer to the position to append.\r
  @param[in]      Instance      The pointer to the Dhcp6 instance.\r
  @param[out]     Elapsed       The pointer to the elapsed time value in\r
                                  the generated packet.\r
\r
  @return         Buf           The position to append the next Ia option.\r
\r
**/\r
UINT8 *\r
Dhcp6AppendETOption (\r
  IN OUT UINT8                  *Buf,\r
  IN     DHCP6_INSTANCE         *Instance,\r
  OUT    UINT16                 **Elapsed\r
  );\r
\r
/**\r
  Set the elapsed time based on the given instance and the pointer to the\r
  elapsed time option.\r
\r
  @param[in]      Elapsed       The pointer to the position to append.\r
  @param[in]      Instance      The pointer to the Dhcp6 instance.\r
**/\r
VOID\r
SetElapsedTime (\r
  IN     UINT16                 *Elapsed,\r
  IN     DHCP6_INSTANCE         *Instance\r
  );\r
\r
/**\r
  Seek the address of the first byte of the option header.\r
\r
  @param[in]  Buf           The pointer to buffer.\r
  @param[in]  SeekLen       The length to seek.\r
  @param[in]  OptType       The option type.\r
\r
  @retval     NULL          If failed to seek the option.\r
  @retval     others        The position to the option.\r
\r
**/\r
UINT8 *\r
Dhcp6SeekOption (\r
  IN UINT8                     *Buf,\r
  IN UINT32                    SeekLen,\r
  IN UINT16                    OptType\r
  );\r
\r
/**\r
  Seek the address of the first byte of the Ia option header.\r
\r
  @param[in]  Buf           The pointer to the buffer.\r
  @param[in]  SeekLen       The length to seek.\r
  @param[in]  IaDesc        The pointer to the Ia descriptor.\r
\r
  @retval     NULL          If failed to seek the Ia option.\r
  @retval     others        The position to the Ia option.\r
\r
**/\r
UINT8 *\r
Dhcp6SeekIaOption (\r
  IN UINT8                     *Buf,\r
  IN UINT32                    SeekLen,\r
  IN EFI_DHCP6_IA_DESCRIPTOR   *IaDesc\r
  );\r
\r
/**\r
  Parse the address option and update the address info.\r
\r
  @param[in]      IaInnerOpt    The pointer to the buffer.\r
  @param[in]      IaInnerLen    The length to parse.\r
  @param[out]     AddrNum       The number of addresses.\r
  @param[in, out] AddrBuf       The pointer to the address buffer.\r
\r
**/\r
VOID\r
Dhcp6ParseAddrOption (\r
  IN     UINT8                   *IaInnerOpt,\r
  IN     UINT16                  IaInnerLen,\r
     OUT UINT32                  *AddrNum,\r
  IN OUT EFI_DHCP6_IA_ADDRESS    *AddrBuf\r
  );\r
\r
/**\r
  Create a control blcok for the Ia according to the corresponding options.\r
\r
  @param[in]  Instance              The pointer to DHCP6 Instance.\r
  @param[in]  IaInnerOpt            The pointer to the inner options in the Ia option.\r
  @param[in]  IaInnerLen            The length of all the inner options in the Ia option.\r
  @param[in]  T1                    T1 time in the Ia option.\r
  @param[in]  T2                    T2 time in the Ia option.\r
\r
  @retval     EFI_NOT_FOUND         No valid IA option is found.\r
  @retval     EFI_SUCCESS           Create an IA control block successfully.\r
  @retval     EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
\r
**/\r
EFI_STATUS\r
Dhcp6GenerateIaCb (\r
  IN  DHCP6_INSTANCE           *Instance,\r
  IN  UINT8                    *IaInnerOpt,\r
  IN  UINT16                   IaInnerLen,\r
  IN  UINT32                   T1,\r
  IN  UINT32                   T2\r
  );\r
\r
\r
/**\r
  Cache the current IA configuration information.\r
\r
  @param[in] Instance           The pointer to DHCP6 Instance.\r
\r
  @retval EFI_SUCCESS           Cache the current IA successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Required system resources could not be allocated.\r
\r
**/\r
EFI_STATUS\r
Dhcp6CacheIa (\r
  IN DHCP6_INSTANCE           *Instance\r
  );\r
\r
\r
/**\r
  Append CacheIa to the currrent IA. Meanwhile, clear CacheIa.ValidLifetime to 0.\r
\r
  @param[in]  Instance            The pointer to DHCP6 instance.\r
\r
**/\r
VOID\r
Dhcp6AppendCacheIa (\r
  IN DHCP6_INSTANCE           *Instance\r
  );\r
\r
#endif\r