Update the copyright notice format

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

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h
index 8e644464616f63b4f7e9c6a30eab130098c45f30..e833352c1b104c2d72f416c95ce4fb747b352793 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h
@@ -1,7 +1,7 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2006, 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
@@ -9,13 +9,6 @@ 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
-  Ip4Output.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_IP4_OUTPUT_H__\r
@@ -33,8 +26,6 @@ Abstract:
                                for reference.\r
   @param  Context              The context provided by us\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 Ip4SysPacketSent (\r
@@ -51,24 +42,24 @@ Ip4SysPacketSent (
   (IpInstance == NULL). It will route the packet, fragment it,\r
   then transmit all the fragments through some interface.\r
 \r
-  @param  IpSb                 The IP4 service instance to transmit the packet\r
-  @param  IpInstance           The IP4 child that issues the transmission.  It is\r
+  @param[in]  IpSb             The IP4 service instance to transmit the packet\r
+  @param[in]  IpInstance       The IP4 child that issues the transmission.  It is\r
                                NULL if the packet is from the system.\r
-  @param  Packet               The user data to send, excluding the IP header.\r
-  @param  Head                 The caller supplied header. The caller should set\r
+  @param[in]  Packet           The user data to send, excluding the IP header.\r
+  @param[in]  Head             The caller supplied header. The caller should set\r
                                the following header fields: Tos, TotalLen, Id, tl,\r
                                Fragment, Protocol, Src and Dst. All the fields are\r
                                in host byte  order. This function will fill in the\r
                                Ver, HeadLen,  Fragment, and checksum. The Fragment\r
                                only need to include the DF flag. Ip4Output will\r
                                compute the MF and offset for  you.\r
-  @param  Option               The original option to append to the IP headers\r
-  @param  OptLen               The length of the option\r
-  @param  GateWay              The next hop address to transmit packet to.\r
+  @param[in]  Option           The original option to append to the IP headers\r
+  @param[in]  OptLen           The length of the option\r
+  @param[in]  GateWay          The next hop address to transmit packet to.\r
                                255.255.255.255 means broadcast.\r
-  @param  Callback             The callback function to issue when transmission\r
+  @param[in]  Callback         The callback function to issue when transmission\r
                                completed.\r
-  @param  Context              The opaque context for the callback\r
+  @param[in]  Context          The opaque context for the callback\r
 \r
   @retval EFI_NO_MAPPING       There is no interface to the destination.\r
   @retval EFI_NOT_FOUND        There is no route to the destination\r
@@ -79,7 +70,7 @@ Ip4SysPacketSent (
 EFI_STATUS\r
 Ip4Output (\r
   IN IP4_SERVICE            *IpSb,\r
-  IN IP4_PROTOCOL           *IpInstance, OPTIONAL\r
+  IN IP4_PROTOCOL           *IpInstance  OPTIONAL,\r
   IN NET_BUF                *Packet,\r
   IN IP4_HEAD               *Head,\r
   IN UINT8                  *Option,\r
@@ -96,8 +87,6 @@ Ip4Output (
   @param  Packet               The Packet to cancel\r
   @param  IoStatus             The status returns to the sender.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 Ip4CancelPacket (\r
@@ -106,5 +95,32 @@ Ip4CancelPacket (
   IN EFI_STATUS       IoStatus\r
   );\r
 \r
+/**\r
+  Prepend an IP4 head to the Packet. It will copy the options and\r
+  build the IP4 header fields. Used for IP4 fragmentation.\r
+\r
+  @param  Packet           The packet to prepend IP4 header to\r
+  @param  Head             The caller supplied header. The caller should set\r
+                           the following header fields: Tos, TotalLen, Id,\r
+                           Fragment, Ttl, Protocol, Src and Dst. All the fields\r
+                           are in host byte order. This function will fill in\r
+                           the Ver, HeadLen, and checksum.\r
+  @param  Option           The orginal IP4 option to copy from\r
+  @param  OptLen           The length of the IP4 option\r
+\r
+  @retval EFI_BAD_BUFFER_SIZE  There is no enought room in the head space of\r
+                               Packet.\r
+  @retval EFI_SUCCESS          The IP4 header is successfully added to the packet.\r
+\r
+**/\r
+EFI_STATUS\r
+Ip4PrependHead (\r
+  IN OUT NET_BUF                *Packet,\r
+  IN     IP4_HEAD               *Head,\r
+  IN     UINT8                  *Option,\r
+  IN     UINT32                 OptLen\r
+  );\r
+\r
 extern UINT16  mIp4Id;\r
+\r
 #endif\r