Grammatical and disclaimer changes (does not follow internal C coding stds.)

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 67 insertions, 43 deletions

diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h
index abfdde6d62..d1dd8fffd0 100644
--- a/MdePkg/Include/Library/DxeServicesLib.h
+++ b/MdePkg/Include/Library/DxeServicesLib.h
@@ -2,14 +2,14 @@
   MDE DXE Services Library provides functions that simplify the development of DXE Drivers.  

   These functions help access data from sections of FFS files or from file path.

 

-  Copyright (c) 2008 - 2010, Intel Corporation<BR>                                                         

-  All rights reserved. This program and the accompanying materials                          

-  are licensed and made available under the terms and conditions of the BSD License         

-  which accompanies this distribution.  The full text of the license may be found at        

-  http://opensource.org/licenses/bsd-license.php                                            

+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>

+This program and the accompanying materials are licensed and made available under 

+the terms and conditions of the BSD License that accompanies this distribution.  

+The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php.                                           

 

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

 **/

 

@@ -37,20 +37,27 @@
   If Size is NULL, then ASSERT().

 

 

-  @param  NameGuid             A pointer to to the FFS filename GUID to search for within 

-                               any of the firmware volumes in the platform. 

-  @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.

-  @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.

-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               It is the caller's responsibility to free this buffer using FreePool().

+  @param  NameGuid             A pointer to to the FFS filename GUID to search for  

+                               within any of the firmware volumes in the platform. 

+  @param  SectionType          Indicates the FFS section type to search for within 

+                               the FFS file specified by NameGuid.

+  @param  SectionInstance      Indicates which section instance within the FFS file 

+                               specified by NameGuid to retrieve.

+  @param  Buffer               On output, a pointer to a callee-allocated buffer 

+                               containing the FFS file section that was found.  

+                               It is the caller's responsibility to free this 

+                               buffer using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

-                                contains the matching FFS section does not allow reads.

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve 

+                                the matching FFS section.

+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a 

+                                device error.

+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the 

+                                firmware volume that contains the matching FFS 

+                                section does not allow reads.

 **/

 EFI_STATUS

 EFIAPI

@@ -83,21 +90,29 @@ GetSectionFromAnyFv  (
   If Buffer is NULL, then ASSERT().

   If Size is NULL, then ASSERT().

 

-  @param  NameGuid             A pointer to to the FFS filename GUID to search for within 

-                               the firmware volumes that the currently executing module was loaded from.

-  @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.

-  @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.

-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               It is the caller's responsibility to free this buffer using FreePool().

+  @param  NameGuid             A pointer to to the FFS filename GUID to search for  

+                               within the firmware volumes that the currently 

+                               executing module was loaded from.

+  @param  SectionType          Indicates the FFS section type to search for within 

+                               the FFS file specified by NameGuid.

+  @param  SectionInstance      Indicates which section instance within the FFS 

+                               file specified by NameGuid to retrieve.

+  @param  Buffer               On output, a pointer to a callee allocated buffer 

+                               containing the FFS file section that was found.  

+                               It is the caller's responsibility to free this buffer 

+                               using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

-                                contains the matching FFS section does not allow reads.  

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve 

+                                the matching FFS section.

+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a 

+                                device error.

+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the 

+                                firmware volume that contains the matching FFS 

+                                section does not allow reads.  

 **/

 EFI_STATUS

 EFIAPI

@@ -129,20 +144,27 @@ GetSectionFromFv (
   If Size is NULL, then ASSERT().

 

 

-  @param  SectionType          Indicates the FFS section type to search for within the FFS file 

-                               that the currently executing module was loaded from.

-  @param  SectionInstance      Indicates which section instance to retrieve within the FFS file 

-                               that the currently executing module was loaded from.

-  @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  

-                               It is the caller's responsibility to free this buffer using FreePool().

+  @param  SectionType          Indicates the FFS section type to search for within  

+                               the FFS file that the currently executing module 

+                               was loaded from.

+  @param  SectionInstance      Indicates which section instance to retrieve within 

+                               the FFS file that the currently executing module 

+                               was loaded from.

+  @param  Buffer               On output, a pointer to a callee allocated buffer 

+                               containing the FFS file section that was found.  

+                               It is the caller's responsibility to free this buffer 

+                               using FreePool().

   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.

 

   @retval  EFI_SUCCESS          The specified FFS section was returned.

   @retval  EFI_NOT_FOUND        The specified FFS section could not be found.

-  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.

-  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a device error.

-  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the firmware volume that 

-                                contains the matching FFS section does not allow reads.  

+  @retval  EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve 

+                                the matching FFS section.

+  @retval  EFI_DEVICE_ERROR     The FFS section could not be retrieves due to a 

+                                device error.

+  @retval  EFI_ACCESS_DENIED    The FFS section could not be retrieves because the 

+                                firmware volume that contains the matching FFS 

+                                section does not allow reads.  

   

 **/

 EFI_STATUS

@@ -167,17 +189,19 @@ GetSectionFromFfs (
   If FileSize is NULL, then NULL is returned.

   If AuthenticationStatus is NULL, then NULL is returned.

 

-  @param[in]       BootPolicy           Policy for Open Image File.If TRUE, indicates that the request 

-                                        originates from the boot manager, and that the boot manager is

-                                        attempting to load FilePath as a boot selection. If FALSE, 

-                                        then FilePath must match an exact file to be loaded.

-  @param[in]       FilePath             Pointer to the device path of the file that is absracted to

+  @param[in]       BootPolicy           The policy for Open Image File.If TRUE, 

+                                        indicates that the request originates from 

+                                        the boot manager, and that the boot manager is

+                                        attempting to load FilePath as a boot selection. 

+                                        If FALSE, then FilePath must match an exact 

+                                        file to be loaded.

+  @param[in]       FilePath             Pointer to the device path of the file that is abstracted to

                                         the file buffer.

   @param[out]      FileSize             Pointer to the size of the abstracted file buffer.

   @param[out]      AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication

                                         status is returned.

 

-  @retval NULL   File is NULL, or FileSize is NULL. Or the file can't be found.

+  @retval NULL   File is NULL, or FileSize is NULL, or the file can't be found.

   @retval other  The abstracted file buffer. The caller is responsible to free memory.

 **/

 VOID *