]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h
BaseTools:Change the path of the file that Binary Cache
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Igmp.h
index a11a915f586338575b903a3a7248646977e29fda..0cc9445944415a0fbf041693d2fd1c4ee8a11c37 100644 (file)
@@ -1,13 +1,7 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2009, Intel Corporation. All rights reserved.<BR>\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
+Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -78,11 +72,11 @@ Ip4InitIgmp (
 /**\r
   Join the multicast group on behalf of this IP4 child\r
 \r
-  @param[in]  IpInstance         The IP4 child that wants to join the group\r
-  @param[in]  Address            The group to join\r
+  @param[in]  IpInstance         The IP4 child that wants to join the group.\r
+  @param[in]  Address            The group to join.\r
 \r
-  @retval EFI_SUCCESS            Successfully join the multicast group\r
-  @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources\r
+  @retval EFI_SUCCESS            Successfully join 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
@@ -96,10 +90,10 @@ Ip4JoinGroup (
   Leave the IP4 multicast group on behalf of IpInstance.\r
 \r
   @param[in]  IpInstance         The IP4 child that wants to leave the group\r
-                                 address\r
-  @param[in]  Address            The group address to leave\r
+                                 address.\r
+  @param[in]  Address            The group address to leave.\r
 \r
-  @retval EFI_NOT_FOUND          The IP4 service instance isn't in the group\r
+  @retval EFI_NOT_FOUND          The IP4 service instance isn't in the group.\r
   @retval EFI_SUCCESS            Successfully leave the multicast group.\r
   @retval Others                 Failed to leave the multicast group.\r
 \r
@@ -113,9 +107,9 @@ Ip4LeaveGroup (
 /**\r
   Handle the received IGMP message for the IP4 service instance.\r
 \r
-  @param[in]  IpSb               The IP4 service instance that received the message\r
-  @param[in]  Head               The IP4 header of the received message\r
-  @param[in]  Packet             The IGMP message, without IP4 header\r
+  @param[in]  IpSb               The IP4 service instance that received the message.\r
+  @param[in]  Head               The IP4 header of the received message.\r
+  @param[in]  Packet             The IGMP message, without IP4 header.\r
 \r
   @retval EFI_INVALID_PARAMETER  The IGMP message is malformated.\r
   @retval EFI_SUCCESS            The IGMP message is successfully processed.\r
@@ -136,7 +130,7 @@ Ip4IgmpHandle (
   2. Decrease the report timer for each IGMP group in "delaying\r
      member" state.\r
 \r
-  @param[in]  IpSb                   The IP4 service instance that is ticking\r
+  @param[in]  IpSb                   The IP4 service instance that is ticking.\r
 \r
 **/\r
 VOID\r
@@ -151,9 +145,9 @@ Ip4IgmpTicking (
   assume the byte order of the both Source and Addr, the\r
   network byte order is used by the caller.\r
 \r
-  @param[in]  Source                 The array of group addresses to add to\r
-  @param[in]  Count                  The number of group addresses in the Source\r
-  @param[in]  Addr                   The IP4 multicast address to add\r
+  @param[in]  Source                 The array of group addresses to add to.\r
+  @param[in]  Count                  The number of group addresses in the Source.\r
+  @param[in]  Addr                   The IP4 multicast address to add.\r
 \r
   @return NULL if failed to allocate memory for the new groups,\r
           otherwise the new combined group addresses.\r
@@ -172,9 +166,9 @@ Ip4CombineGroups (
   both Groups and Addr, the network byte order is used by\r
   the caller.\r
 \r
-  @param  Groups            The array of group addresses to remove from\r
-  @param  Count             The number of group addresses in the Groups\r
-  @param  Addr              The IP4 multicast address to remove\r
+  @param  Groups            The array of group addresses to remove from.\r
+  @param  Count             The number of group addresses in the Groups.\r
+  @param  Addr              The IP4 multicast address to remove.\r
 \r
   @return The nubmer of group addresses in the Groups after remove.\r
           It is Count if the Addr isn't in the Groups.\r
@@ -191,8 +185,8 @@ Ip4RemoveGroupAddr (
   Find the IGMP_GROUP structure which contains the status of multicast\r
   group Address in this IGMP control block\r
 \r
-  @param[in]  IgmpCtrl               The IGMP control block to search from\r
-  @param[in]  Address                The multicast address to search\r
+  @param[in]  IgmpCtrl               The IGMP control block to search from.\r
+  @param[in]  Address                The multicast address to search.\r
 \r
   @return NULL if the multicast address isn't in the IGMP control block. Otherwise\r
           the point to the IGMP_GROUP which contains the status of multicast group\r