Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg\Include\Library.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6544 6f19259b-4bc3-4df7-8a09-765794883524
2025-07-28 08:04:07 +02:00 · 2008-11-14 03:45:34 +00:00 · 2008-11-14 03:45:34 +00:00 · 50a64e5b0b
commit 50a64e5b0b
parent 7077edb331
42 changed files with 335 additions and 322 deletions
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@ -1,5 +1,6 @@
 /** @file
-  Memory-only library functions with no library constructor/destructor
+  Provides string functions, linked list functions, math functions, synchronization
  functions, and CPU architecture specific functions.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/BaseMemoryLib.h
+++ b/MdePkg/Include/Library/BaseMemoryLib.h
@ -1,7 +1,7 @@
 /** @file
-  Memory-only library functions with no library constructor/destructor
+  Provides copy memory, fill memory, zero memory, and GUID functions. 
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/CacheMaintenanceLib.h
+++ b/MdePkg/Include/Library/CacheMaintenanceLib.h
@ -1,7 +1,7 @@
 /** @file
-  Cache Maintenance Functions
+  Provides services to maintain instruction and data caches.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/CpuLib.h
+++ b/MdePkg/Include/Library/CpuLib.h
@ -1,5 +1,6 @@
 /** @file
-  Library that provides processor specific library services
+  Provides CPU architecture specific functions that can not be defined
  in the Base Library due to dependencies on the PAL Library
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@ -1,5 +1,5 @@
 /** @file
-  Public include file for the Debug Library
+  Provides services to print debug and assert messages to a debug output device.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/DevicePathLib.h
+++ b/MdePkg/Include/Library/DevicePathLib.h
@ -1,7 +1,7 @@
 /** @file
-  Device Path services.
+  Provides library functions to construct and parse UEFI Device Paths.
-  Copyright (c) 2006, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/DxeCoreEntryPoint.h
+++ b/MdePkg/Include/Library/DxeCoreEntryPoint.h
@ -1,7 +1,7 @@
 /** @file
-  Entry point to the DXE Core
+  Module entry point library for DXE core.
-  Copyright (c) 2006, Intel Corporation<BR>
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/DxeServicesTableLib.h
+++ b/MdePkg/Include/Library/DxeServicesTableLib.h
@ -1,7 +1,8 @@
 /** @file
-  Library that provides a global pointer to the DXE Services Table
+  Provides a service to retrieve a pointer to the DXE Services Table.
  Only available to DXE module types.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/ExtractGuidedSectionLib.h
+++ b/MdePkg/Include/Library/ExtractGuidedSectionLib.h
@ -1,8 +1,7 @@
 /** @file
-  Extract Guided Section Library class defintions, 
+  This library provides common functions to process the different guided section data. 
  which can provide many handlers for the different guided section data.
-  Copyright (c) 2007 - 2008, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/HobLib.h
+++ b/MdePkg/Include/Library/HobLib.h
@ -1,7 +1,8 @@
 /** @file
-  Public include file for the HOB Library
+  Provides services to create and parse HOBs. Only available for PEI
  and DXE module types.
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/IoLib.h
+++ b/MdePkg/Include/Library/IoLib.h
@ -1,7 +1,7 @@
 /** @file
-  I/O and MMIO Library Services
+  Provide services to access I/O Ports and MMIO registers.
-  Copyright (c) 2006 - 2007, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/MemoryAllocationLib.h
+++ b/MdePkg/Include/Library/MemoryAllocationLib.h
@ -1,7 +1,7 @@
 /** @file
-  Memory Allocation Library Services
+  Provides services to allocate and free memory buffers of various memory types and alignments.
-  Copyright (c) 2006, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/PalLib.h
+++ b/MdePkg/Include/Library/PalLib.h
@ -1,5 +1,5 @@
 /** @file
-  PAL Call Services
+  Provides library services to make PAL Calls.
 Copyright (c) 2006 -2008, Intel Corporation All rights
 reserved. This program and the accompanying materials are
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@ -1,15 +1,15 @@
 /** @file
-PCD Library Class provides PCD usage macro interface for all PCD types. It should be 
+  Provides library services to get and set Platform Configuration Database entries.
 included at any module who use PCD. 
-If module use dynamic/dynamicex PCD, module should be linked to PEIM/DXE library 
+  PCD Library Class provides PCD usage macro interface for all PCD types.
-instance to access that PCD.
+  It should be included at any module who use PCD. If module use dynamic/dynamicex
-If module uses PatchableInModule type PCD, also need library instance produce LibPatchPcdSetPtr()
+  PCD, module should be linked to PEIM/DXE library instance to access that PCD.
-interface.
+  If module uses PatchableInModule type PCD, also need library instance produce
-For FeatureFlag/Fixed PCD, macro interface is translated to an variable or macro
+  LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is
-which is auto-generated by build tool in module's autogen.h/autogen.c
+  translated to an variable or macro which is auto-generated by build tool in
  module's autogen.h/autogen.c.
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/PciCf8Lib.h
+++ b/MdePkg/Include/Library/PciCf8Lib.h
@ -1,5 +1,5 @@
 /** @file
-  PCI CF8 Library Services for PCI Segment #0
+  Provides services to access PCI Configuration Space using the I/O ports 0xCF8 and 0xCFC.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/PciExpressLib.h
+++ b/MdePkg/Include/Library/PciExpressLib.h
@ -1,5 +1,5 @@
 /** @file
-  Pci Express Library Services for PCI Segment #0
+  Provides services to access PCI Configuration Space using the MMIO PCI Express window.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/PciLib.h
+++ b/MdePkg/Include/Library/PciLib.h
@ -1,5 +1,5 @@
 /** @file
-  PCI Library Services for PCI Segment #0
+  Provides services to access PCI Configuration Space.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/PciSegmentLib.h
+++ b/MdePkg/Include/Library/PciSegmentLib.h
@ -1,7 +1,7 @@
 /** @file
-  Functions accessing PCI configuration registers on any supported PCI segment
+  Provides services to access PCI Configuration Space on a platform with multiple PCI segments.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/PeCoffGetEntryPointLib.h
+++ b/MdePkg/Include/Library/PeCoffGetEntryPointLib.h
@ -1,5 +1,5 @@
 /** @file
-  Memory Only PE COFF loader
+  Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.
 Copyright (c) 2006, Intel Corporation                                                         
 All rights reserved. This program and the accompanying materials                          
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@ -1,5 +1,5 @@
 /** @file
-  Memory Only PE COFF loader. 
+  Provides services to load and relocate a PE/COFF image.
 Copyright (c) 2006 - 2007, Intel Corporation                                                         
 All rights reserved. This program and the accompanying materials                          
--- a/MdePkg/Include/Library/PeiCoreEntryPoint.h
+++ b/MdePkg/Include/Library/PeiCoreEntryPoint.h
@ -1,7 +1,7 @@
 /** @file
-  Entry point to the PEI Core
+  Module entry point library for PEI core.
-Copyright (c) 2006, Intel Corporation<BR>
+Copyright (c) 2006 - 2008, 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
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@ -1,7 +1,7 @@
 /** @file
-  Header file for PEI Services Library.
+  Provides library functions for all PEI Services.
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h
+++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
@ -1,5 +1,5 @@
 /** @file
-  PEI Services Table Pointer Library services
+  Provides a service to retrieve a pointer to the PEI Services Table.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/PeimEntryPoint.h
+++ b/MdePkg/Include/Library/PeimEntryPoint.h
@ -1,7 +1,7 @@
 /** @file
-  Entry point to a PEIM
+  Module entry point library for PEIM.
-Copyright (c) 2006, Intel Corporation<BR>
+Copyright (c) 2006 - 2008 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
--- a/MdePkg/Include/Library/PerformanceLib.h
+++ b/MdePkg/Include/Library/PerformanceLib.h
@ -1,7 +1,7 @@
 /** @file
-  Library that provides services to measure module execution performance
+  Provides services to log the execution times and retrieve them later.
-  Copyright (c) 2006, Intel Corporation.
+Copyright (c) 2006 - 2008 Intel Corporation.
 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
--- a/MdePkg/Include/Library/PostCodeLib.h
+++ b/MdePkg/Include/Library/PostCodeLib.h
@ -1,5 +1,5 @@
 /** @file
-  Post Code Library functions defintion.
+  Provides services to send progress/error codes to a POST card.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/PrintLib.h
+++ b/MdePkg/Include/Library/PrintLib.h
@ -1,5 +1,6 @@
 /** @file
-  Library header file that defines print services
+  Provides services to print a formatted string to a buffer. All combinations of
  Unicode and ASCII strings are supported.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/ReportStatusCodeLib.h
+++ b/MdePkg/Include/Library/ReportStatusCodeLib.h
@ -1,7 +1,7 @@
 /** @file
-  Report Status Code Library public .h file
+  Provides services to log status code records.
-  Copyright (c) 2006, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/ResourcePublicationLib.h
+++ b/MdePkg/Include/Library/ResourcePublicationLib.h
@ -1,7 +1,7 @@
 /** @file
-  Declare presence of resources in the platform
+  Provides a service to publish discovered system resources.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/SalLib.h
+++ b/MdePkg/Include/Library/SalLib.h
@ -1,7 +1,7 @@
 /** @file
-  SAL Library Functions
+  Provides library services to make SAL Calls.
-  Copyright (c) 2007, Intel Corporation
+Copyright (c) 2007 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@ -1,5 +1,5 @@
 /** @file
-  Serial I/O Port library functions definition.
+  Provides three common serial I/O port functions.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/SmbusLib.h
+++ b/MdePkg/Include/Library/SmbusLib.h
@ -1,7 +1,8 @@
 /** @file
-  SMBUS Functions
+  Provides library functions to access SMBUS devices. Libraries of this class
  must be ported to a specific SMBUS controller.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/TimerLib.h
+++ b/MdePkg/Include/Library/TimerLib.h
@ -1,5 +1,5 @@
 /** @file
-  Timer Library Functions.
+  Provides calibrated delay and performance counter services.
 Copyright (c) 2006 - 2008, Intel Corporation
 All rights reserved. This program and the accompanying materials
--- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h
+++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
@ -1,7 +1,7 @@
 /** @file
-  Entry point to a UEFI Application.
+  Module entry point library for UEFI Applications.
-Copyright (c) 2007, Intel Corporation<BR>
+Copyright (c) 2007 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/UefiBootServicesTableLib.h
+++ b/MdePkg/Include/Library/UefiBootServicesTableLib.h
@ -1,7 +1,8 @@
 /** @file
-  Library that provides a global pointer to the UEFI Boot Services Tables
+  Provides a service to retrieve a pointer to the EFI Boot Services Table.
  Only available to DXE and UEFI module types.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/UefiDecompressLib.h
+++ b/MdePkg/Include/Library/UefiDecompressLib.h
@ -1,5 +1,5 @@
 /** @file
-  UEFI Decompress Library Functions defintion
+  Provides services to decompress a buffer using the UEFI Decompress algorithm.
  The UEFI Decompress Library enables the decompression of objects that 
  were compressed using the UEFI compression scheme. The UEFI Decompress 
--- a/MdePkg/Include/Library/UefiDriverEntryPoint.h
+++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h
@ -1,7 +1,8 @@
 /** @file
-  Entry point to a DXE Boot Services Driver
+  Module entry point library for UEFI drivers, DXE Drivers, DXE Runtime Drivers,
  and DXE SMM Drivers.
-Copyright (c) 2006, Intel Corporation<BR>
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@ -1,11 +1,14 @@
 /** @file
  Provides library functions for common UEFI operations. Only available to DXE
  and UEFI module types.
  The UEFI Library provides functions and macros that simplify the development of 
  UEFI Drivers and UEFI Applications.  These functions and macros help manage EFI 
  events, build simple locks utilizing EFI Task Priority Levels (TPLs), install 
  EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers, 
  and print messages on the console output and standard error devices.
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@ -1,7 +1,8 @@
 /** @file
-  Library to abstract runtime services
+  Provides library functions for each of the UEFI Runtime Services.
  Only available to DXE and UEFI module types.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
@ -9,7 +10,6 @@
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 **/
 #ifndef __UEFI_RUNTIME_LIB__
--- a/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
@ -1,7 +1,8 @@
 /** @file
-  Library that provides a global pointer to the UEFI Runtime Services Tables
+  Provides a service to retrieve a pointer to the EFI Runtime Services Table.
  Only available to DXE and UEFI module types.
-  Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2008, Intel Corporation
 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
--- a/MdePkg/Include/Library/UefiScsiLib.h
+++ b/MdePkg/Include/Library/UefiScsiLib.h
@ -1,7 +1,8 @@
 /** @file
  Common Libarary for SCSI
-  Copyright (c) 2006 - 2007, Intel Corporation
+  Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device.
 Copyright (c) 2006 - 2008, Intel Corporation
 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        
--- a/MdePkg/Include/Library/UefiUsbLib.h
+++ b/MdePkg/Include/Library/UefiUsbLib.h
@ -1,5 +1,6 @@
 /** @file
-  Common Dxe Libarary  for USB.
+  Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec
  and the standard requests defined in Usb 1.1 spec.
 Copyright (c) 2006 - 2008, Intel Corporation<BR>
 All rights reserved. This program and the accompanying materials