Clarify the UEFI/EFI specification version in file header comments.

[mirror_edk2.git] / MdePkg / Include / Protocol / Ip4.h

diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h
index ab598484af3d95234aa55e4e1e10cdd275518364..246104dcc57a725bc3ed6af6ff520ea8060e46a3 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4.h
+++ b/MdePkg/Include/Protocol/Ip4.h
@@ -1,24 +1,26 @@
 /** @file\r
-  \r
   This file defines the EFI IPv4 (Internet Protocol version 4)\r
   Protocol interface. It is split into the following three main\r
   sections:\r
   - EFI IPv4 Service Binding Protocol\r
   - EFI IPv4 Variable\r
-  - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic\r
-    network IPv4 packet I/O services, which includes support for\r
-    a subset of the Internet Control Message Protocol (ICMP) and\r
-    may include support for the Internet Group Management\r
-    Protocol (IGMP).\r
+  - EFI IPv4 Protocol\r
+  The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,\r
+  which includes support foR a subset of the Internet Control Message \r
+  Protocol (ICMP) and may include support for the Internet Group Management\r
+  Protocol (IGMP).\r
   \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2009, Intel Corporation                                                         \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
   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
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  \r
+\r
+  @par Revision Reference:          \r
+  This Protocol is introduced in UEFI Specification 2.0        \r
 \r
 **/\r
 \r
@@ -312,6 +314,9 @@ EFI_STATUS
   @retval EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+                                This is NULL.\r
+                                IpConfigData.StationAddress is not a unicast IPv4 address.\r
+                                IpConfigData.SubnetMask is not a valid IPv4 subnet \r
   @retval EFI_UNSUPPORTED       One or more of the following conditions is TRUE:\r
                                 A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
                                 not be located when clients choose to use the default IPv4\r
@@ -350,7 +355,7 @@ EFI_STATUS
                                 - This is NULL.\r
                                 - JoinFlag is TRUE and GroupAddress is NULL.\r
                                 - GroupAddress is not NULL and *GroupAddress is\r
-                                not a multicast IPv4 address.\r
+                                  not a multicast IPv4 address.\r
   @retval EFI_NOT_STARTED       This instance has not been started.\r
   @retval EFI_NO_MAPPING        When using the default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
@@ -417,7 +422,7 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES   Could not add the entry to the routing table.\r
   @retval EFI_NOT_FOUND          This route is not in the routing table (when DeleteRoute is TRUE).\r
   @retval EFI_ACCESS_DENIED      The route is already defined in the routing table (when\r
-                                  DeleteRoute is FALSE).\r
+                                 DeleteRoute is FALSE).\r
                                  \r
 **/\r
 typedef \r
@@ -492,7 +497,7 @@ EFI_STATUS
                                 resources (usually memory).\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
                                 The EFI IPv4 Protocol instance has been reset to startup defaults.\r
-                                EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
+  @retval EFI_ACCESS_DENIED     The receive completion token with the same Token.Event was already\r
                                 in the receive queue.\r
   @retval EFI_NOT_READY         The receive request could not be queued because the receive queue is full.\r
   @retval EFI_ICMP_ERROR        An ICMP error packet was received.\r
@@ -523,7 +528,7 @@ EFI_STATUS
                 defined in EFI_IP4_PROTOCOL.Transmit().\r
 \r
   @retval EFI_SUCCESS           The asynchronous I/O request was aborted and\r
-                                Token.->Event was signaled. When Token is NULL, all\r
+                                Token->Event was signaled. When Token is NULL, all\r
                                 pending requests were aborted and their events were signaled.\r
   @retval EFI_INVALID_PARAMETER This is NULL.\r
   @retval EFI_NOT_STARTED       This instance has not been started.\r