synced function header

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6595 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h

@@ -216,36 +216,112 @@ struct _IP4_SERVICE {
 
 extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete;
 
+/**
+  Config the MNP parameter used by IP. The IP driver use one MNP
+  child to transmit/receive frames. By default, it configures MNP
+  to receive unicast/multicast/broadcast. And it will enable/disable
+  the promiscous receive according to whether there is IP child
+  enable that or not. If Force is FALSE, it will iterate through
+  all the IP children to check whether the promiscuous receive
+  setting has been changed. If it hasn't been changed, it won't
+  reconfigure the MNP. If Force is TRUE, the MNP is configured no
+  matter whether that is changed or not.
+
+  @param  IpSb                   The IP4 service instance that is to be changed.
+  @param  Force                  Force the configuration or not.
+
+  @retval EFI_SUCCESS            The MNP is successfully configured/reconfigured.
+  @retval Others                 Configuration failed.
+
+**/
 EFI_STATUS
 Ip4ServiceConfigMnp (
   IN IP4_SERVICE            *IpSb,
   IN BOOLEAN                Force
   );
 
+/**
+  Intiialize the IP4_PROTOCOL structure to the unconfigured states.
+
+  @param  IpSb                   The IP4 service instance.
+  @param  IpInstance             The IP4 child instance.
+
+  @return None
+
+**/
 VOID
 Ip4InitProtocol (
-  IN IP4_SERVICE            *IpSb,
-  IN IP4_PROTOCOL           *IpInstance
+  IN     IP4_SERVICE            *IpSb,
+  IN OUT IP4_PROTOCOL           *IpInstance
   );
 
+/**
+  Clean up the IP4 child, release all the resources used by it.
+
+  @param  IpInstance             The IP4 child to clean up.
+
+  @retval EFI_SUCCESS            The IP4 child is cleaned up
+  @retval EFI_DEVICE_ERROR       Some resources failed to be released
+
+**/
 EFI_STATUS
 Ip4CleanProtocol (
   IN  IP4_PROTOCOL          *IpInstance
   );
 
+/**
+  Cancel the user's receive/transmit request.
+
+  @param  IpInstance             The IP4 child
+  @param  Token                  The token to cancel. If NULL, all token will be
+                                 cancelled.
+
+  @retval EFI_SUCCESS            The token is cancelled
+  @retval EFI_NOT_FOUND          The token isn't found on either the
+                                 transmit/receive queue
+  @retval EFI_DEVICE_ERROR       Not all token is cancelled when Token is NULL.
+
+**/
 EFI_STATUS
 Ip4Cancel (
   IN IP4_PROTOCOL             *IpInstance,
-  IN EFI_IP4_COMPLETION_TOKEN *Token
+  IN EFI_IP4_COMPLETION_TOKEN *Token          OPTIONAL
   );
 
+/**
+  Change the IP4 child's multicast setting. The caller
+  should make sure that the parameters is valid.
+
+  @param  IpInstance             The IP4 child to change the setting.
+  @param  JoinFlag               TRUE to join the group, otherwise leave it
+  @param  GroupAddress           The target group address
+
+  @retval EFI_ALREADY_STARTED    Want to join the group, but already a member of it
+  @retval EFI_OUT_OF_RESOURCES   Failed to allocate some resources.
+  @retval EFI_DEVICE_ERROR       Failed to set the group configuraton
+  @retval EFI_SUCCESS            Successfully updated the group setting.
+  @retval EFI_NOT_FOUND          Try to leave the group which it isn't a member.
+
+**/
 EFI_STATUS
 Ip4Groups (
   IN IP4_PROTOCOL           *IpInstance,
   IN BOOLEAN                JoinFlag,
-  IN EFI_IPv4_ADDRESS       *GroupAddress
+  IN EFI_IPv4_ADDRESS       *GroupAddress       OPTIONAL
   );
 
+/**
+  The heart beat timer of IP4 service instance. It times out
+  all of its IP4 children's received-but-not-delivered and
+  transmitted-but-not-recycle packets, and provides time input
+  for its IGMP protocol.
+
+  @param  Event                  The IP4 service instance's heart beat timer.
+  @param  Context                The IP4 service instance.
+
+  @return None
+
+**/
 VOID
 EFIAPI
 Ip4TimerTicking (
@@ -253,6 +329,20 @@ Ip4TimerTicking (
   IN VOID                   *Context
   );
 
+/**
+  Decrease the life of the transmitted packets. If it is
+  decreased to zero, cancel the packet. This function is
+  called by Ip4PacketTimerTicking which time out both the
+  received-but-not-delivered and transmitted-but-not-recycle
+  packets.
+
+  @param  Map                    The IP4 child's transmit map.
+  @param  Item                   Current transmitted packet
+  @param  Context                Not used.
+
+  @retval EFI_SUCCESS            Always returns EFI_SUCCESS
+
+**/
 EFI_STATUS
 Ip4SentPacketTicking (
   IN NET_MAP                *Map,