From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web09.9791.1619605258218559602 for ; Wed, 28 Apr 2021 03:20:58 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: pierre.gondois@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id BD98F11B3; Wed, 28 Apr 2021 03:20:57 -0700 (PDT) Received: from e120189.arm.com (unknown [10.57.1.97]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 3EFE53F70D; Wed, 28 Apr 2021 03:20:56 -0700 (PDT) From: "PierreGondois" To: devel@edk2.groups.io, sami.mujawar@arm.com, leif@nuviainc.com, ardb+tianocore@kernel.org, sean.brogan@microsoft.com, Bret.Barkelew@microsoft.com Subject: [PATCH v3 04/15] ArmPlatformPkg: Document libraries in ArmPlatformPkg.dec Date: Wed, 28 Apr 2021 11:20:09 +0100 Message-Id: <20210428102020.2311-5-Pierre.Gondois@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210428102020.2311-1-Pierre.Gondois@arm.com> References: <20210428102020.2311-1-Pierre.Gondois@arm.com> From: Pierre Gondois This patch documents the libraries advertised in ArmPlatformPkg.dec. Cc: Bret Barkelew Cc: Sean Brogan Cc: Leif Lindholm Cc: Ard Biesheuvel Cc: Sami Mujawar Signed-off-by: Pierre Gondois Reviewed-by: Sami Mujawar --- Notes: V2: - Add documentation to the advertised libraries. This is a new patch. [Bret] ArmPlatformPkg/ArmPlatformPkg.dec | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/ArmPlatformPkg/ArmPlatformPkg.dec b/ArmPlatformPkg/ArmPlatformPkg.dec index 696d636aacee..3a25ddcdc8ca 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 @@ [Includes.common] 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] -- 2.17.1