diff options
| author | Pierre Gondois <Pierre.Gondois@arm.com> | 2021-04-27 11:12:11 +0100 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2021-04-28 12:03:51 +0000 |
| commit | ecfe47968e7848c3d88707aa3530ca4c22a7a787 (patch) | |
| tree | 7e46fe49846a2d215eb350768c0910f99d3ef74d | |
| parent | d03f71dd8be62ffbd3d1665576ffd721210b7e00 (diff) | |
| download | edk2-ecfe47968e7848c3d88707aa3530ca4c22a7a787.tar.gz edk2-ecfe47968e7848c3d88707aa3530ca4c22a7a787.tar.bz2 edk2-ecfe47968e7848c3d88707aa3530ca4c22a7a787.zip | |
ArmPlatformPkg: Document libraries in ArmPlatformPkg.dec
This patch documents the libraries advertised in ArmPlatformPkg.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>
| -rw-r--r-- | ArmPlatformPkg/ArmPlatformPkg.dec | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/ArmPlatformPkg/ArmPlatformPkg.dec b/ArmPlatformPkg/ArmPlatformPkg.dec index 696d636aac..3a25ddcdc8 100644 --- a/ArmPlatformPkg/ArmPlatformPkg.dec +++ b/ArmPlatformPkg/ArmPlatformPkg.dec @@ -1,6 +1,6 @@ #/** @file
#
-# Copyright (c) 2011-2018, ARM Limited. All rights reserved.
+# Copyright (c) 2011-2021, ARM Limited. All rights reserved.
# Copyright (c) 2015, Intel Corporation. All rights reserved.
#
# SPDX-License-Identifier: BSD-2-Clause-Patent
@@ -26,11 +26,28 @@ Include # Root include for the package
[LibraryClasses]
+ ## @libraryclass Provides an interface to query platform information.
+ #
ArmPlatformLib|Include/Library/ArmPlatformLib.h
+
+ ## @libraryclass Provides an interface to initialize/shutdown a LCD screen.
+ #
LcdHwLib|Include/Library/LcdHwLib.h
+
+ ## @libraryclass Provides an interface to configure a LCD screen.
+ #
LcdPlatformLib|Include/Library/LcdPlatformLib.h
+
+ ## @libraryclass Provides a Nor flash interface.
+ #
NorFlashPlatformLib|Include/Library/NorFlashPlatformLib.h
+
+ ## @libraryclass Provides an interface to the clock of a PL011 device.
+ #
PL011UartClockLib|Include/Library/PL011UartClockLib.h
+
+ ## @libraryclass Provides an interface to a PL011 uart.
+ #
PL011UartLib|Include/Library/PL011UartLib.h
[Guids.common]
|