git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk@10288 6f19259b-4bc3...
authorrsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Mar 2010 06:55:58 +0000 (06:55 +0000)
committerrsun3 <rsun3@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 19 Mar 2010 06:55:58 +0000 (06:55 +0000)
edk2/MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
edk2/MdeModulePkg/Include/Library/IpIoLib.h
edk2/MdeModulePkg/Include/Library/NetLib.h
edk2/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c
edk2/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c
edk2/MdeModulePkg/Library/DxeNetLib/NetBuffer.c

index d2b01ce..68e41cd 100644 (file)
@@ -27,8 +27,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 extern EFI_GUID gLoadFixedAddressConfigurationTableGuid;\r
 \r
 typedef struct {\r
-  EFI_PHYSICAL_ADDRESS    DxeCodeTopAddress;             ///< The top address below which the Dxe runtime code and below which the Dxe runtime/boot code and PEI code.\r
-  EFI_PHYSICAL_ADDRESS    SmramBase;                      ///< SMM RAME base. build tool will assigned an offset relative to SMRAM base for SMM driver.\r
+  EFI_PHYSICAL_ADDRESS    DxeCodeTopAddress;   ///< The top address below which the Dxe runtime code and below which the Dxe runtime/boot code and PEI code.\r
+  EFI_PHYSICAL_ADDRESS    SmramBase;           ///< SMRAM base address. The build tool assigns an offset relative to the SMRAM base for a SMM driver.\r
 } EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE;\r
 \r
 #endif\r
index 09ff2c1..b1cbacb 100644 (file)
@@ -529,10 +529,9 @@ IpIoFindSender (
 \r
   @param[in]   IcmpError             IcmpError Type.\r
   @param[in]   IpVersion             The version of the IP protocol to use,\r
-                                     either IPv4 or IPv6.\r
-  \r
-  @param[out]  IsHard                Whether it is a hard error.\r
-  @param[out]  Notify                Whether it need to notify SockError.\r
+                                     either IPv4 or IPv6. \r
+  @param[out]  IsHard                If TRUE, indicates that it is a hard error.\r
+  @param[out]  Notify                If TRUE, SockError needs to be notified.\r
 \r
   @return The ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r
 \r
index a011bf7..71680a4 100644 (file)
@@ -507,7 +507,7 @@ NetGetUint32 (
   byte stream.\r
 \r
   @param[in, out]  Buf          The buffer in which to put the UINT32.\r
-  @param[in]      Data          The data to put.\r
+  @param[in]       Data         The data to be converted and put into the byte stream.\r
 \r
 **/\r
 VOID\r
@@ -1097,17 +1097,18 @@ NetLibGetMacString (
 \r
   The underlying UNDI driver may or may not support reporting media status from\r
   GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r
-  will try to invoke Snp->GetStatus() to get the media status. Iif media is already\r
-  present, it returns directly. If media  isnot present, it will stop SNP and then\r
-  restart SNP to get the latest media status.  This provides an opportunity to get \r
+  will try to invoke Snp->GetStatus() to get the media status. If media is already\r
+  present, it returns directly. If media is not present, it will stop SNP and then\r
+  restart SNP to get the latest media status. This provides an opportunity to get \r
   the correct media status for old UNDI driver, which doesn't support reporting \r
   media status from GET_STATUS command.\r
   Note: there are two limitations for the current algorithm:\r
   1) For UNDI with this capability, when the cable is not attached, there will\r
      be an redundant Stop/Start() process.\r
-  2) For UNDI without this capability, when the cable is attached, the UNDI\r
-     initializes while unattached. Later, NetLibDetectMedia() will report\r
-     MediaPresent as TRUE, causing upper layer apps to wait for timeout time.\r
+  2) for UNDI without this capability, in case that network cable is attached when\r
+     Snp->Initialize() is invoked while network cable is unattached later,\r
+     NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r
+     apps to wait for timeout time.\r
 \r
   @param[in]   ServiceHandle    The handle where network service binding protocols are\r
                                 installed.\r
@@ -1868,8 +1869,8 @@ NetbufQueCopy (
   );\r
 \r
 /**\r
-  Trim Len bytes of data from the queue header and release any net buffer\r
-  that is trimmed wholely.\r
+  Trim Len bytes of data from the buffer queue and free any net buffer\r
+  that is completely trimmed.\r
 \r
   The trimming operation is the same as NetbufTrim but applies to the net buffer\r
   queue instead of the net buffer.\r
index 9ed7b8d..d5fddb6 100644 (file)
@@ -2012,10 +2012,9 @@ IpIoFindSender (
 \r
   @param[in]   IcmpError             IcmpError Type.\r
   @param[in]   IpVersion             The version of the IP protocol to use,\r
-                                     either IPv4 or IPv6.\r
-  \r
-  @param[out]  IsHard                Whether it is a hard error.\r
-  @param[out]  Notify                Whether it need to notify SockError.\r
+                                     either IPv4 or IPv6. \r
+  @param[out]  IsHard                If TRUE, indicates that it is a hard error.\r
+  @param[out]  Notify                If TRUE, SockError needs to be notified.\r
 \r
   @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE.\r
 \r
index 5037243..034031d 100644 (file)
@@ -901,7 +901,7 @@ NetGetUint32 (
   byte stream.\r
 \r
   @param[in, out]  Buf          The buffer to put the UINT32.\r
-  @param[in]      Data          The data to put.\r
+  @param[in]       Data         The data to be converted and put into the byte stream.\r
 \r
 **/\r
 VOID\r
@@ -2158,9 +2158,10 @@ NetLibGetMacString (
   Note: there will be two limitations for current algorithm:\r
   1) for UNDI with this capability, in case of cable is not attached, there will\r
      be an redundant Stop/Start() process;\r
-  2) for UNDI without this capability, in case cable is attached in UNDI\r
-     initialize while unattached latter, NetLibDetectMedia() will report\r
-     MediaPresent as TRUE, this cause upper layer apps wait for timeout time.\r
+  2) for UNDI without this capability, in case that network cable is attached when\r
+     Snp->Initialize() is invoked while network cable is unattached later,\r
+     NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer\r
+     apps to wait for timeout time.\r
 \r
   @param[in]   ServiceHandle    The handle where network service binding protocols are\r
                                 installed on.\r
index 76b6510..139735e 100644 (file)
@@ -1556,8 +1556,8 @@ NetbufQueCopy (
 \r
 \r
 /**\r
-  Trim Len bytes of data from the queue header, release any of the net buffer\r
-  whom is trimmed wholely.\r
+  Trim Len bytes of data from the buffer queue and free any net buffer\r
+  that is completely trimmed.\r
 \r
   The trimming operation is the same as NetbufTrim but applies to the net buffer\r
   queue instead of the net buffer.\r