NetworkPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Multicast Listener Discovery support routines.\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_MLD_H__\r
#define __EFI_IP6_MLD_H__\r
\r
#define IP6_UNSOLICITED_REPORT_INTERVAL 10\r
\r
#pragma pack(1)\r
typedef struct {\r
  IP6_ICMP_HEAD           Head;\r
  UINT16                  MaxRespDelay;\r
  UINT16                  Reserved;\r
  EFI_IPv6_ADDRESS        Group;\r
} IP6_MLD_HEAD;\r
#pragma pack()\r
\r
//\r
// The status of multicast group. It isn't necessary to maintain\r
// explicit state of host state diagram. A group with finity\r
// DelayTime (less than 0xffffffff) is in "delaying listener" state. otherwise, it is in\r
// "idle listener" state.\r
//\r
typedef struct {\r
  LIST_ENTRY              Link;\r
  INTN                    RefCnt;\r
  EFI_IPv6_ADDRESS        Address;\r
  UINT32                  DelayTimer;\r
  BOOLEAN                 SendByUs;\r
  EFI_MAC_ADDRESS         Mac;\r
} IP6_MLD_GROUP;\r
\r
//\r
// The MLD status. Each IP6 service instance has a MLD_SERVICE_DATA\r
// attached. The Mldv1QuerySeen remember whether the server on this\r
// connected network is v1 or v2.\r
//\r
typedef struct {\r
  INTN                    Mldv1QuerySeen;\r
  LIST_ENTRY              Groups;\r
} IP6_MLD_SERVICE_DATA;\r
\r
/**\r
  Search a IP6_MLD_GROUP list entry node from a list array.\r
\r
  @param[in]       IpSb          Points to an IP6 service binding instance.\r
  @param[in]       MulticastAddr The IPv6 multicast address to be searched.\r
\r
  @return The found IP6_ML_GROUP list entry or NULL.\r
\r
**/\r
IP6_MLD_GROUP *\r
Ip6FindMldEntry (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IPv6_ADDRESS       *MulticastAddr\r
  );\r
\r
/**\r
  Init the MLD data of the IP6 service instance, configure\r
  MNP to receive ALL SYSTEM multicasts.\r
\r
  @param[in]  IpSb              The IP6 service whose MLD is to be initialized.\r
\r
  @retval EFI_OUT_OF_RESOURCES  There are not sufficient resources to complete the\r
                                operation.\r
  @retval EFI_SUCCESS           The MLD module successfully initialized.\r
\r
**/\r
EFI_STATUS\r
Ip6InitMld (\r
  IN IP6_SERVICE            *IpSb\r
  );\r
\r
/**\r
  Join the multicast group on behalf of this IP6 service binding instance.\r
\r
  @param[in]  IpSb               The IP6 service binding instance.\r
  @param[in]  Interface          Points to an IP6_INTERFACE structure.\r
  @param[in]  Address            The group address to join.\r
\r
  @retval EFI_SUCCESS            Successfully joined the multicast group.\r
  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.\r
  @retval Others                 Failed to join the multicast group.\r
\r
**/\r
EFI_STATUS\r
Ip6JoinGroup (\r
  IN IP6_SERVICE            *IpSb,\r
  IN IP6_INTERFACE          *Interface,\r
  IN EFI_IPv6_ADDRESS       *Address\r
  );\r
\r
/**\r
  Leave the IP6 multicast group.\r
\r
  @param[in]  IpSb               The IP6 service binding instance.\r
  @param[in]  Address            The group address to leave.\r
\r
  @retval EFI_NOT_FOUND          The IP6 service instance isn't in the group.\r
  @retval EFI_SUCCESS            Successfully left the multicast group.\r
  @retval Others                 Failed to leave the multicast group.\r
\r
**/\r
EFI_STATUS\r
Ip6LeaveGroup (\r
 IN IP6_SERVICE            *IpSb,\r
 IN EFI_IPv6_ADDRESS       *Address\r
  );\r
\r
/**\r
  Worker function for EfiIp6Groups(). The caller\r
  should verify that the parameters are valid.\r
\r
  @param[in]  IpInstance        The IP6 child to change the setting.\r
  @param[in]  JoinFlag          TRUE to join the group, otherwise leave it.\r
  @param[in]  GroupAddress      The target group address. If NULL, leave all\r
                                the group addresses.\r
\r
  @retval EFI_ALREADY_STARTED   Wants to join the group, but is already a member of it.\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate some resources.\r
  @retval EFI_DEVICE_ERROR      Failed to set the group configuraton.\r
  @retval EFI_SUCCESS           Successfully updated the group setting.\r
  @retval EFI_NOT_FOUND         Tried to leave a group of whom it isn't a member.\r
\r
**/\r
EFI_STATUS\r
Ip6Groups (\r
  IN IP6_PROTOCOL           *IpInstance,\r
  IN BOOLEAN                JoinFlag,\r
  IN EFI_IPv6_ADDRESS       *GroupAddress       OPTIONAL\r
  );\r
\r
/**\r
  Process the Multicast Listener Query message.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  Head               The IP head of the MLD query packet.\r
  @param[in]  Packet             The content of the MLD query packet with IP head\r
                                 removed.\r
\r
  @retval EFI_SUCCESS            The MLD query packet processed successfully.\r
  @retval EFI_INVALID_PARAMETER  The packet is invalid.\r
  @retval Others                 Failed to process the packet.\r
\r
**/\r
EFI_STATUS\r
Ip6ProcessMldQuery (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IP6_HEADER         *Head,\r
  IN NET_BUF                *Packet\r
  );\r
\r
/**\r
  Process the Multicast Listener Report message.\r
\r
  @param[in]  IpSb               The IP service that received the packet.\r
  @param[in]  Head               The IP head of the MLD report packet.\r
  @param[in]  Packet             The content of the MLD report packet with IP head\r
                                 removed.\r
\r
  @retval EFI_SUCCESS            The MLD report packet processed successfully.\r
  @retval EFI_INVALID_PARAMETER  The packet is invalid.\r
\r
**/\r
EFI_STATUS\r
Ip6ProcessMldReport (\r
  IN IP6_SERVICE            *IpSb,\r
  IN EFI_IP6_HEADER         *Head,\r
  IN NET_BUF                *Packet\r
  );\r
\r
\r
/**\r
  The heartbeat timer of the MLD module. It sends out solicited MLD report when\r
  DelayTimer expires.\r
\r
  @param[in]  IpSb              The IP6 service binding instance.\r
\r
**/\r
VOID\r
Ip6MldTimerTicking (\r
  IN IP6_SERVICE            *IpSb\r
  );\r
\r
#endif\r
\r