[Change summary]:

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

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h
index 43833af8c4edc8efd9f0cc1f01ccaa97a2321b22..cd1367b01251c97173f101956c918f557a949671 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+Copyright (c) 2005 - 2009, Intel Corporation.<BR>\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
@@ -9,26 +9,17 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  Ip4Input.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_IP4_INPUT_H__\r
 #define __EFI_IP4_INPUT_H__\r
 \r
-typedef enum {\r
-  IP4_MIN_HEADLEN       = 20,\r
-  IP4_MAX_HEADLEN       = 60,\r
+#define IP4_MIN_HEADLEN        20\r
+#define IP4_MAX_HEADLEN        60\r
 \r
-  IP4_ASSEMLE_HASH_SIZE = 31,\r
-  IP4_FRAGMENT_LIFE     = 120,\r
-  IP4_MAX_PACKET_SIZE   = 65535\r
-} IP4_INPUT_ENUM_TYPES;\r
+#define IP4_ASSEMLE_HASH_SIZE  31\r
+#define IP4_FRAGMENT_LIFE      120\r
+#define IP4_MAX_PACKET_SIZE    65535\r
 \r
 ///\r
 /// Per packet information for input process. LinkFlag specifies whether\r
@@ -95,9 +86,7 @@ typedef struct {
   Initialize an already allocated assemble table. This is generally\r
   the assemble table embedded in the IP4 service instance.\r
 \r
-  @param  Table                  The assemble table to initialize.\r
-\r
-  @return NONE\r
+  @param[in, out]  Table                  The assemble table to initialize.\r
 \r
 **/\r
 VOID\r
@@ -109,9 +98,7 @@ Ip4InitAssembleTable (
   Clean up the assemble table: remove all the fragments\r
   and assemble entries.\r
 \r
-  @param  Table                  The assemble table to clean up\r
-\r
-  @return None\r
+  @param[in]  Table                  The assemble table to clean up\r
 \r
 **/\r
 VOID\r
@@ -123,15 +110,13 @@ Ip4CleanAssembleTable (
   The IP4 input routine. It is called by the IP4_INTERFACE when a\r
   IP4 fragment is received from MNP.\r
 \r
-  @param  Ip4Instance            The IP4 child that request the receive, most like\r
+  @param[in]  Ip4Instance        The IP4 child that request the receive, most like\r
                                  it is NULL.\r
-  @param  Packet                 The IP4 packet received.\r
-  @param  IoStatus               The return status of receive request.\r
-  @param  Flag                   The link layer flag for the packet received, such\r
+  @param[in]  Packet             The IP4 packet received.\r
+  @param[in]  IoStatus           The return status of receive request.\r
+  @param[in]  Flag               The link layer flag for the packet received, such\r
                                  as multicast.\r
-  @param  Context                The IP4 service instance that own the MNP.\r
-\r
-  @return None\r
+  @param[in]  Context            The IP4 service instance that own the MNP.\r
 \r
 **/\r
 VOID\r
@@ -152,9 +137,9 @@ Ip4AccpetFrame (
   child wants to consume the packet because each IP child needs\r
   its own copy of the packet to make changes.\r
 \r
-  @param  IpSb                   The IP4 service instance that received the packet\r
-  @param  Head                   The header of the received packet\r
-  @param  Packet                 The data of the received packet\r
+  @param[in]  IpSb                   The IP4 service instance that received the packet\r
+  @param[in]  Head                   The header of the received packet\r
+  @param[in]  Packet                 The data of the received packet\r
 \r
   @retval EFI_NOT_FOUND          No IP child accepts the packet\r
   @retval EFI_SUCCESS            The packet is enqueued or delivered to some IP\r
@@ -172,10 +157,10 @@ Ip4Demultiplex (
   Enqueue a received packet to all the IP children that share\r
   the same interface.\r
 \r
-  @param  IpSb                   The IP4 service instance that receive the packet\r
-  @param  Head                   The header of the received packet\r
-  @param  Packet                 The data of the received packet\r
-  @param  IpIf                   The interface to enqueue the packet to\r
+  @param[in]  IpSb                   The IP4 service instance that receive the packet\r
+  @param[in]  Head                   The header of the received packet\r
+  @param[in]  Packet                 The data of the received packet\r
+  @param[in]  IpIf                   The interface to enqueue the packet to\r
 \r
   @return The number of the IP4 children that accepts the packet\r
 \r
@@ -194,7 +179,7 @@ Ip4InterfaceEnquePacket (
   duplicate it to a non-shared packet, release the shared packet, then\r
   deliver the non-shared packet up.\r
 \r
-  @param  IpInstance             The IP child to deliver the packet up.\r
+  @param[in]  IpInstance         The IP child to deliver the packet up.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources to deliver the\r
                                  packets.\r
@@ -210,9 +195,7 @@ Ip4InstanceDeliverPacket (
 /**\r
   Timeout the fragment and enqueued packets.\r
 \r
-  @param  IpSb                   The IP4 service instance to timeout\r
-\r
-  @return None\r
+  @param[in]  IpSb                   The IP4 service instance to timeout\r
 \r
 **/\r
 VOID\r