Scrubbed more.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Igmp.h

/** @file\r
\r
Copyright (c) 2005 - 2006, Intel Corporation\r
All rights reserved. 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
Module Name:\r
\r
  Ip4Igmp.h\r
\r
Abstract:\r
\r
\r
**/\r
\r
#ifndef __EFI_IP4_IGMP_H__\r
#define __EFI_IP4_IGMP_H__\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8                   Type;\r
  UINT8                   MaxRespTime;\r
  UINT16                  Checksum;\r
  IP4_ADDR                Group;\r
} IGMP_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 non-zero\r
/// DelayTime is in "delaying member" state. otherwise, it is in\r
/// "idle member" state.\r
///\r
typedef struct {\r
  LIST_ENTRY              Link;\r
  INTN                    RefCnt;\r
  IP4_ADDR                Address;\r
  INTN                    DelayTime;\r
  BOOLEAN                 ReportByUs;\r
  EFI_MAC_ADDRESS         Mac;\r
} IGMP_GROUP;\r
\r
///\r
/// The IGMP status. Each IP4 service instance has a IGMP_SERVICE_DATA\r
/// attached. The Igmpv1QuerySeen remember whether the server on this\r
/// connected network is v1 or v2.\r
///\r
typedef struct {\r
  INTN                    Igmpv1QuerySeen;\r
  LIST_ENTRY              Groups;\r
} IGMP_SERVICE_DATA;\r
\r
typedef enum {\r
  //\r
  // IGMP message type\r
  //\r
  IGMP_MEMBERSHIP_QUERY     = 0x11,\r
  IGMP_V1_MEMBERSHIP_REPORT = 0x12,\r
  IGMP_V2_MEMBERSHIP_REPORT = 0x16,\r
  IGMP_LEAVE_GROUP          = 0x17,\r
\r
  IGMP_V1ROUTER_PRESENT     = 400,\r
  IGMP_UNSOLICIATED_REPORT  = 10\r
} IGMP_ENUM_TYPES;\r
\r
EFI_STATUS\r
Ip4InitIgmp (\r
  IN IP4_SERVICE          *IpService\r
  );\r
\r
EFI_STATUS\r
Ip4JoinGroup (\r
  IN IP4_PROTOCOL         *IpInstance,\r
  IN IP4_ADDR             Address\r
  );\r
\r
EFI_STATUS\r
Ip4LeaveGroup (\r
  IN IP4_PROTOCOL         *IpInstance,\r
  IN IP4_ADDR             Address\r
  );\r
\r
EFI_STATUS\r
Ip4IgmpHandle (\r
  IN IP4_SERVICE          *IpService,\r
  IN IP4_HEAD             *Head,\r
  IN NET_BUF              *Packet\r
  );\r
\r
VOID\r
Ip4IgmpTicking (\r
  IN IP4_SERVICE          *IpService\r
  );\r
\r
IP4_ADDR *\r
Ip4CombineGroups (\r
  IN  IP4_ADDR            *SourceGroups,\r
  IN  UINT32              Count,\r
  IN  IP4_ADDR            Addr\r
  );\r
\r
INTN\r
Ip4RemoveGroupAddr (\r
  IN IP4_ADDR             *Group,\r
  IN UINT32               GroupCnt,\r
  IN IP4_ADDR             Addr\r
  );\r
\r
IGMP_GROUP *\r
Ip4FindGroup (\r
  IN IGMP_SERVICE_DATA    *IgmpCtrl,\r
  IN IP4_ADDR             Address\r
  );\r
#endif\r