diff options
| author | Pierre Gondois <Pierre.Gondois@arm.com> | 2021-04-27 11:13:49 +0100 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2021-04-28 12:03:51 +0000 |
| commit | 3093c95de813110032a307f1a142216dd3ce611c (patch) | |
| tree | b351d48ae5fb1de8e9c9626dd851c20f86a3efee | |
| parent | ecfe47968e7848c3d88707aa3530ca4c22a7a787 (diff) | |
| download | edk2-3093c95de813110032a307f1a142216dd3ce611c.tar.gz edk2-3093c95de813110032a307f1a142216dd3ce611c.tar.bz2 edk2-3093c95de813110032a307f1a142216dd3ce611c.zip | |
ArmPkg: Document libraries in ArmPkg.dec
This patch documents the libraries advertised in ArmPkg.dec.
Cc: Bret Barkelew <bret.barkelew@microsoft.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
| -rw-r--r-- | ArmPkg/ArmPkg.dec | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec index 496f588bd0..151626039b 100644 --- a/ArmPkg/ArmPkg.dec +++ b/ArmPkg/ArmPkg.dec @@ -27,20 +27,67 @@ Include # Root include for the package
[LibraryClasses.common]
+ ## @libraryclass Provides an interface to Arm registers.
+ #
ArmLib|Include/Library/ArmLib.h
+
+ ## @libraryclass Provides a Mmu interface.
+ #
ArmMmuLib|Include/Library/ArmMmuLib.h
+
+ ## @libraryclass Provides a semihosting interface.
+ #
SemihostLib|Include/Library/SemihostLib.h
+
+ ## @libraryclass Provides a default exception handler.
+ #
DefaultExceptionHandlerLib|Include/Library/DefaultExceptionHandlerLib.h
+
+ ## @libraryclass Convert Arm instructions to a human readable format.
+ #
ArmDisassemblerLib|Include/Library/ArmDisassemblerLib.h
+
+ ## @libraryclass Provides an interface to initialize a
+ # Generic Interrupt Controller (GIC).
+ #
ArmGicArchLib|Include/Library/ArmGicArchLib.h
+
+ ## @libraryclass Provides a Mailbox Transport Layer (MTL) interface
+ # for the System Control and Management Interface (SCMI).
+ #
ArmMtlLib|Include/Library/ArmMtlLib.h
+
+ ## @libraryclass Provides a SuperVisor Call (SVC) interface.
+ #
ArmSvcLib|Include/Library/ArmSvcLib.h
+
+ ## @libraryclass Provides an OpTee interface.
+ #
OpteeLib|Include/Library/OpteeLib.h
+
+ ## @libraryclass Provides an interface to a StandaloneMm Mmu.
+ #
StandaloneMmMmuLib|Include/Library/StandaloneMmMmuLib.h
+
+ ## @libraryclass Provides an interface to Arm generic counters.
+ #
ArmGenericTimerCounterLib|Include/Library/ArmGenericTimerCounterLib.h
+
+ ## @libraryclass Provides a Generic Interrupt Controller (GIC)
+ # configuration interface.
ArmGicLib|Include/Library/ArmGicLib.h
+
+ ## @libraryclass Provides a HyperVisor Call (HVC) interface.
+ #
ArmHvcLib|Include/Library/ArmHvcLib.h
+
+ ## @libraryclass Provides an interface to query miscellaneous OEM
+ # information.
+ #
OemMiscLib|Include/Library/OemMiscLib.h
+
+ ## @libraryclass Provides a System Monitor Call (SMC) interface.
+ #
ArmSmcLib|Include/Library/ArmSmcLib.h
|