Update the copyright notice format

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Option.c

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
index 322166f657a0ce833269c3414629031c6d5c8524..023733b8d5715d2c1f181b1a933ff746699b1da5 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
@@ -1,7 +1,8 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+  IP4 option support functions.\r
+  \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,15 +10,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
-  Ip4Option.c\r
-\r
-Abstract:\r
-\r
-  IP4 option support functions\r
-\r
-\r
 **/\r
 \r
 #include "Ip4Impl.h"\r
@@ -28,13 +20,13 @@ Abstract:
   and will transmit. It will compute the ICMP error message fields\r
   if the option is mal-formated. But this information isn't used.\r
 \r
-  @param  Option                The first byte of the option\r
-  @param  OptionLen             The length of the whole option\r
-  @param  Rcvd                  The option is from the packet we received if TRUE,\r
+  @param[in]  Option            The first byte of the option\r
+  @param[in]  OptionLen         The length of the whole option\r
+  @param[in]  Rcvd              The option is from the packet we received if TRUE,\r
                                 otherwise the option we wants to transmit.\r
 \r
-  @return TRUE:  The option is properly formated\r
-  @return FALSE: The option is mal-formated\r
+  @retval TRUE     The option is properly formatted\r
+  @retval FALSE    The option is mal-formated\r
 \r
 **/\r
 BOOLEAN\r
@@ -74,7 +66,7 @@ Ip4OptionIsValid (
       Point = Option[Cur + 2];\r
 \r
       //\r
-      // SRR/RR options are formated as |Type|Len|Point|Ip1|Ip2|...\r
+      // SRR/RR options are formatted as |Type|Len|Point|Ip1|Ip2|...\r
       //\r
       if ((OptionLen - Cur < Len) || (Len < 3) || ((Len - 3) % 4 != 0)) {\r
         IcmpPoint = Cur + 1;\r
@@ -124,25 +116,25 @@ Ip4OptionIsValid (
   Copy the option from the original option to buffer. It\r
   handles the details such as:\r
   1. whether copy the single IP4 option to the first/non-first\r
-  fragments.\r
-  2. Pad the options copied over to aligened to 4 bytes.\r
+     fragments.\r
+  2. Pad the options copied over to aligned to 4 bytes.\r
 \r
-  @param  Option                The original option to copy from\r
-  @param  OptionLen             The length of the original option\r
-  @param  FirstFragment         Whether it is the first fragment\r
-  @param  Buf                   The buffer to copy options to\r
-  @param  BufLen                The length of the buffer\r
+  @param[in]       Option            The original option to copy from\r
+  @param[in]       OptionLen         The length of the original option\r
+  @param[in]       FirstFragment     Whether it is the first fragment\r
+  @param[in, out]  Buf               The buffer to copy options to. NULL \r
+  @param[in, out]  BufLen            The length of the buffer\r
 \r
   @retval EFI_SUCCESS           The options are copied over\r
-  @retval EFI_BUFFER_TOO_SMALL  The buffer caller provided is too small.\r
+  @retval EFI_BUFFER_TOO_SMALL  Buf is NULL or BufLen provided is too small.\r
 \r
 **/\r
 EFI_STATUS\r
 Ip4CopyOption (\r
-  IN UINT8                  *Option,\r
-  IN UINT32                 OptionLen,\r
-  IN BOOLEAN                FirstFragment,\r
-  IN UINT8                  *Buf,           OPTIONAL\r
+  IN     UINT8              *Option,\r
+  IN     UINT32             OptionLen,\r
+  IN     BOOLEAN            FirstFragment,\r
+  IN OUT UINT8              *Buf,           OPTIONAL\r
   IN OUT UINT32             *BufLen\r
   )\r
 {\r
@@ -180,8 +172,8 @@ Ip4CopyOption (
       //\r
       // don't copy options that is only valid for the first fragment\r
       //\r
-      if (FirstFragment || (Type & IP4_OPTION_COPY_MASK)) {\r
-        NetCopyMem (OptBuf + Next, Option + Cur, Len);\r
+      if (FirstFragment || (Type & IP4_OPTION_COPY_MASK) != 0) {\r
+        CopyMem (OptBuf + Next, Option + Cur, Len);\r
         Next += Len;\r
       }\r
 \r
@@ -224,8 +216,8 @@ Ip4CopyOption (
   // Copy the option to the Buf, zero the buffer first to pad\r
   // the options with NOP to align to 4 bytes.\r
   //\r
-  NetZeroMem (Buf, Len);\r
-  NetCopyMem (Buf, OptBuf, Next);\r
+  ZeroMem (Buf, Len);\r
+  CopyMem (Buf, OptBuf, Next);\r
   *BufLen = Len;\r
   return EFI_SUCCESS;\r
 }\r