-#/** @file\r
+## @file MdeModulePkg.dec\r
+#\r
# Mde Module Package Reference Implementations\r
#\r
# This module provides headers and libraries that conform to EFI/PI Industry standards.\r
# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved.\r
-# This program and the accompanying materials are licensed and made available under\r
-# the terms and conditions of the BSD License which accompanies this distribution.\r
-# The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
+# This program and the accompanying materials are licensed and made available under\r
+# the terms and conditions of the BSD License which accompanies this distribution.\r
+# 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
+# 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
-#**/\r
+##\r
\r
\r
[Defines]\r
\r
\r
[LibraryClasses.common]\r
- ## IpIo layer upon EFI IP4 Protocol.\r
+ ## @libraryclass IpIo layer upon EFI IP4 Protocol.\r
IpIoLib|Include/Library/IpIoLib.h\r
\r
- ## Basic function for UEFI network stack.\r
+ ## @libraryclass Basic function for UEFI network stack.\r
NetLib|Include/Library/NetLib.h\r
\r
- ## Defines a set of methods to reset whole system.\r
+ ## @libraryclass Defines a set of methods to reset whole system.\r
ResetSystemLib|Include/Library/ResetSystemLib.h\r
\r
- ## The helper routines to access UDP service.\r
+ ## @libraryclass The helper routines to access UDP service.\r
UdpIoLib|Include/Library/UdpIoLib.h\r
\r
- ## Defines a set of methods related do S3 mode.\r
+ ## @libraryclass Defines a set of methods related do S3 mode.\r
S3Lib|Include/Library/S3Lib.h\r
\r
- ## Defines a set of methods related recovery mode.\r
+ ## @libraryclass Defines a set of methods related recovery mode.\r
RecoveryLib|Include/Library/RecoveryLib.h\r
\r
- ## Basic platform driver override functions.\r
+ ## @libraryclass Basic platform driver override functions.\r
PlatDriOverLib|Include/Library/PlatDriOverLib.h\r
\r
- ## Includes two extended HII functions to create and destory Hii Package \r
- # by create the virtual Driver Handle.\r
+ ## @libraryclass Includes two extended HII functions to create and destory Hii Package \r
+ # by create the virtual Driver Handle.\r
+ ##\r
ExtendedHiiLib|Include/Library/ExtendedHiiLib.h\r
\r
- ## Defines APIs that is related to IFR operations but specific to EDK II implementation.\r
+ ## @libraryclass Defines APIs that is related to IFR operations but specific to EDK II\r
+ # implementation.\r
+ ##\r
ExtendedIfrSupportLib|Include/Library/ExtendedIfrSupportLib.h\r
\r
- ## Defines a set of interfaces on how to process capusle image update.\r
+ ## @libraryclass Defines a set of interfaces on how to process capusle image update.\r
CapsuleLib|Include/Library/CapsuleLib.h\r
\r
- ## Platform BDS library definition about platform specific behavior.\r
+ ## @libraryclass Platform BDS library definition about platform specific behavior.\r
PlatformBdsLib|Include/Library/PlatformBdsLib.h\r
\r
- ## Generic BDS library definition, include the data structure and function.\r
+ ## @libraryclass Generic BDS library definition, include the data structure and function.\r
GenericBdsLib|Include/Library/GenericBdsLib.h\r
\r
- ## Library for Deferred Procedure Calls.\r
+ ## @libraryclass Library for Deferred Procedure Calls.\r
DpcLib|Include/Library/DpcLib.h\r
\r
[Guids.common]\r
-#/** @file\r
+## @file MdePkg.dec\r
#\r
# This Package provides headers and libraries that conform to EFI/PI Industry standards.\r
# Copyright (c) 2007 - 2008, Intel Corporation.\r
#\r
# All rights reserved.\r
-# This program and the accompanying materials are licensed and made available under\r
-# the terms and conditions of the BSD License which accompanies this distribution.\r
-# The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
+# This program and the accompanying materials are licensed and made available under\r
+# the terms and conditions of the BSD License which accompanies this distribution.\r
+# 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
#\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
-#\r
-#**/\r
+##\r
\r
\r
[Defines]\r
Include/Ebc\r
\r
[LibraryClasses.common]\r
+ ## @libraryclass Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec \r
+ # and the standard requests defined in Usb 1.1 spec.\r
+ ##\r
UsbLib|Include/Library/UsbLib.h\r
+\r
+ ## @libraryclass Provides a service to retrieve a pointer to the EFI Runtime Services Table.\r
UefiRuntimeServicesTableLib|Include/Library/UefiRuntimeServicesTableLib.h\r
+\r
+ ## @libraryclass Provides library functions for each of the UEFI Runtime Services.\r
UefiRuntimeLib|Include/Library/UefiRuntimeLib.h\r
+\r
+ ## @libraryclass Provides library functions for common UEFI operations.\r
+ # Only available to DXE and UEFI module types.\r
+ ##\r
UefiLib|Include/Library/UefiLib.h\r
+\r
+ ## @libraryclass Module entry point library for UEFI drivers, DXE Drivers and DXE Runtime Drivers\r
UefiDriverEntryPoint|Include/Library/UefiDriverEntryPoint.h\r
- ## UEFI Decompress Library Functions defintion for UEFI compress algorithm\r
+\r
+ ## @libraryclass UEFI Decompress Library Functions defintion for UEFI compress algorithm\r
UefiDecompressLib|Include/Library/UefiDecompressLib.h\r
+\r
+ ## @libraryclass Provides a service to retrieve a pointer to the EFI Boot Services Table.\r
UefiBootServicesTableLib|Include/Library/UefiBootServicesTableLib.h\r
+\r
+ ## @libraryclass Module entry point library for UEFI Applications.\r
UefiApplicationEntryPoint|Include/Library/UefiApplicationEntryPoint.h\r
+\r
+ ## @libraryclass Provides calibrated delay and performance counter services.\r
TimerLib|Include/Library/TimerLib.h\r
+\r
+ ## @libraryclass Provides library functions to access SMBUS devices.\r
SmbusLib|Include/Library/SmbusLib.h\r
+\r
+ ## @libraryclass Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device.\r
ScsiLib|Include/Library/ScsiLib.h\r
+\r
+ ## @libraryclass Provides a service to publish discovered system resources.\r
ResourcePublicationLib|Include/Library/ResourcePublicationLib.h\r
+\r
+ ## @libraryclass Provides services to log status code records.\r
ReportStatusCodeLib|Include/Library/ReportStatusCodeLib.h\r
+\r
+ ## @libraryclass Provides services to print a formatted string to a buffer.\r
+ # All combinations of Unicode and ASCII strings are supported.\r
+ ##\r
PrintLib|Include/Library/PrintLib.h\r
+\r
+ ## @libraryclass Provides services to send progress/error codes to a POST card.\r
PostCodeLib|Include/Library/PostCodeLib.h\r
+\r
+ ## @libraryclass Provides services to log the execution times and retrieve them later.\r
PerformanceLib|Include/Library/PerformanceLib.h\r
+\r
+ ## @libraryclass Provides a service to retrieve a pointer to the PEI Services Table.\r
PeiServicesTablePointerLib|Include/Library/PeiServicesTablePointerLib.h\r
+\r
+ ## @libraryclass Provides library functions for all PEI Services.\r
PeiServicesLib|Include/Library/PeiServicesLib.h\r
+\r
+ ## @libraryclass Module entry point library for PEIM.\r
PeimEntryPoint|Include/Library/PeimEntryPoint.h\r
+\r
+ ## @libraryclass Module entry point library for PEI core.\r
PeiCoreEntryPoint|Include/Library/PeiCoreEntryPoint.h\r
+\r
+ ## @libraryclass Provides services to load and relocate a PE/COFF image.\r
PeCoffLib|Include/Library/PeCoffLib.h\r
+\r
+ ## @libraryclass Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.\r
PeCoffGetEntryPointLib|Include/Library/PeCoffGetEntryPointLib.h\r
+\r
+ ## @libraryclass Provides services to access PCI Configuration Space on a platform with multiple PCI segments.\r
PciSegmentLib|Include/Library/PciSegmentLib.h\r
+\r
+ ## @libraryclass Provides services to access PCI Configuration Space.\r
PciLib|Include/Library/PciLib.h\r
+\r
+ ## @libraryclass Provides services to access PCI Configuration Space using the MMIO PCI Express window.\r
PciExpressLib|Include/Library/PciExpressLib.h\r
+\r
+ ## @libraryclass Provides services to access PCI Configuration Space using the I/O ports 0xCF8 and 0xCFC.\r
PciCf8Lib|Include/Library/PciCf8Lib.h\r
+\r
+ ## @libraryclass Provides library services to get and set Platform Configuration Database entries.\r
PcdLib|Include/Library/PcdLib.h\r
+\r
+ ## @libraryclass Provides services to allocate and free memory buffers of various memory types and alignments.\r
MemoryAllocationLib|Include/Library/MemoryAllocationLib.h\r
+\r
+ ## @libraryclass Provide services to access I/O Ports and MMIO registers.\r
IoLib|Include/Library/IoLib.h\r
- IfrSupportLib|Include/Library/IfrSupportLib.h\r
+\r
+ ## @libraryclass Provides services to create and parse HOBs.\r
HobLib|Include/Library/HobLib.h\r
+\r
+ ## @libraryclass Provides HII related functions.\r
HiiLib|Include/Library/HiiLib.h\r
+\r
+ ## @libraryclass Provides all FVB runtime services defined in PI specification FVB protocol to provide\r
+ # low level control interfaces over block-oriented firmware devices.\r
+ ##\r
FvbServiceLib|Include/Library/FvbServiceLib.h\r
+\r
+ ## @libraryclass Module entry point library for DXE SMM Driver.\r
DxeSmmDriverEntryPoint|Include/Library/DxeSmmDriverEntryPoint.h\r
+\r
+ ## @libraryclass Provides a service to retrieve a pointer to the DXE Services Table.\r
+ # Only available to DXE module types.\r
+ ##\r
DxeServicesTableLib|Include/Library/DxeServicesTableLib.h\r
+\r
+ ## @libraryclass Module entry point library for DXE core.\r
DxeCoreEntryPoint|Include/Library/DxeCoreEntryPoint.h\r
+\r
+ ## @libraryclass Provides library functions to construct and parse UEFI Device Paths.\r
DevicePathLib|Include/Library/DevicePathLib.h\r
+\r
+ ## @libraryclass Provides services to print debug and assert messages to a debug output device.\r
DebugLib|Include/Library/DebugLib.h\r
+\r
+ ## @libraryclass Provides CPU architecture specific functions that can not be defined in the Base Library\r
+ # due to dependencies on the PAL Library\r
+ ##\r
CpuLib|Include/Library/CpuLib.h\r
+\r
+ ## @libraryclass Provides services to maintain instruction and data caches.\r
CacheMaintenanceLib|Include/Library/CacheMaintenanceLib.h\r
+\r
+ ## @libraryclass Provides copy memory, fill memory, zero memory, and GUID functions. \r
BaseMemoryLib|Include/Library/BaseMemoryLib.h\r
+\r
+ ## @libraryclass Provides string functions, linked list functions, math functions, synchronization functions\r
+ # and CPU architecture specific functions.\r
+ ##\r
BaseLib|Include/Library/BaseLib.h\r
- BasePeCoffLib|Include/Library/PeCoffLib.h\r
+\r
+ ## @libraryclass supports displaying graphical splash screen, locking of keyboard input and\r
+ # printing character on screen.\r
+ ##\r
GraphicsLib|Include/Library/GraphicsLib.h\r
- ## Extract Guided Section Library class defintions that provides many handlers for the different guided section data.\r
+\r
+ ## @libraryclass Extract Guided Section Library class defintions that provides many handlers\r
+ # for the different guided section data.\r
+ ##\r
ExtractGuidedSectionLib|Include/Library/ExtractGuidedSectionLib.h\r
+\r
+ ## @libraryclass Provides a set of interfaces to do IFR opcode creation and interact with a UEFI Form Browser.\r
IfrSupportLib|Include/Library/IfrSupportLib.h\r
+\r
+ ## @libraryclass Provides a set of PI library functions and macros for PEI phase.\r
PeiPiLib|Include/Library/PeiPiLib.h\r
- ## Serial I/O Port library functions definition.\r
+\r
+ ## @libraryclass Defines a set of Serial Port I/O interfaces.\r
SerialPortLib|Include/Library/SerialPortLib.h\r
+\r
+ ## @libraryclass Provides a set of PI library functions and macros for DXE phase.\r
DxePiLib|Include/Library/DxePiLib.h\r
\r
[LibraryClasses.IPF]\r
+ ## @libraryclass The SAL Library provides a service to make a SAL CALL.\r
SalLib|Include/Library/SalLib.h\r
+\r
+ ## @libraryclass The PAL Library provides a service to make a PAL CALL.\r
PalCallLib|Include/Library/PalCallLib.h\r
\r
[Guids.common]\r
projects / mirror_edk2.git / commitdiff