BaseTools: Refactor hash tracking after checking for Sources section

[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6Icmp.h

/** @file\r
  Header file for ICMPv6 protocol.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EFI_IP6_ICMP_H__\r
#define __EFI_IP6_ICMP_H__\r
\r
#define ICMP_V6_DEFAULT_CODE          0\r
\r
#define ICMP_V6_ERROR_MAX             127\r
\r
//\r
// ICMPv6 message classes, each class of ICMPv6 message shares\r
// a common message format. INVALID_MESSAGE is only a flag.\r
//\r
#define ICMP_V6_INVALID_MESSAGE       0\r
#define ICMP_V6_ERROR_MESSAGE         1\r
#define ICMP_V6_INFORMATION_MESSAGE   2\r
\r
\r
extern EFI_IP6_ICMP_TYPE  mIp6SupportedIcmp[];\r
\r
/**\r
  Handle the ICMPv6 packet. First validate the message format,\r
  then, according to the message types, process it as an informational packet or\r
  an error packet.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  Head               The IP head of the ICMPv6 packet.\r
  @param[in]  Packet             The content of the ICMPv6 packet with IP head\r
                                 removed.\r
\r
  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
  @retval EFI_SUCCESS            The ICMPv6 message successfully processed.\r
  @retval Others                 Failed to handle the ICMPv6 packet.\r
\r
**/\r
EFI_STATUS\r
Ip6IcmpHandle (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IP6_HEADER         *Head,\r
  IN NET_BUF                *Packet\r
  );\r
\r
/**\r
  Check whether the DestinationAddress is an anycast address.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  DestinationAddress Points to the Destination Address of the packet.\r
\r
  @retval TRUE                   The DestinationAddress is anycast address.\r
  @retval FALSE                  The DestinationAddress is not anycast address.\r
\r
**/\r
BOOLEAN\r
Ip6IsAnycast (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IPv6_ADDRESS       *DestinationAddress\r
  );\r
\r
/**\r
  Generate ICMPv6 error message and send it out to DestinationAddress. Currently\r
  Destination Unreachable message, Time Exceeded message and Parameter Problem\r
  message are supported.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  Packet             The packet which invoking ICMPv6 error.\r
  @param[in]  SourceAddress      If not NULL, points to the SourceAddress.\r
                                 Otherwise, the IP layer will select a source address\r
                                 according to the DestinationAddress.\r
  @param[in]  DestinationAddress Points to the Destination Address of the ICMPv6\r
                                 error message.\r
  @param[in]  Type               The type of the ICMPv6 message.\r
  @param[in]  Code               The additional level of the ICMPv6 message.\r
  @param[in]  Pointer            If not NULL, identifies the octet offset within\r
                                 the invoking packet where the error was detected.\r
\r
  @retval EFI_INVALID_PARAMETER  The packet is malformated.\r
  @retval EFI_OUT_OF_RESOURCES   There is no sufficient resource to complete the\r
                                 operation.\r
  @retval EFI_SUCCESS            The ICMPv6 message was successfully sent out.\r
  @retval Others                 Failed to generate the ICMPv6 packet.\r
\r
**/\r
EFI_STATUS\r
Ip6SendIcmpError (\r
  IN IP6_SERVICE            *IpSb,\r
  IN NET_BUF                *Packet,\r
  IN EFI_IPv6_ADDRESS       *SourceAddress       OPTIONAL,\r
  IN EFI_IPv6_ADDRESS       *DestinationAddress,\r
  IN UINT8                  Type,\r
  IN UINT8                  Code,\r
  IN UINT32                 *Pointer             OPTIONAL\r
  );\r
\r
#endif\r
\r