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.web11.9893.1619605260046976001 for ; Wed, 28 Apr 2021 03:21:00 -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 AF8D41FB; Wed, 28 Apr 2021 03:20:59 -0700 (PDT) Received: from e120189.arm.com (unknown [10.57.1.97]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 1616C3F70D; Wed, 28 Apr 2021 03:20:57 -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 05/15] ArmPkg: Document libraries in ArmPkg.dec Date: Wed, 28 Apr 2021 11:20:10 +0100 Message-Id: <20210428102020.2311-6-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 ArmPkg.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 Signed-off-by: Pierre Gondois --- Notes: V2: - Add documentation to the advertised libraries. This is a new patch. [Bret] V3: - Descriptions were shuffled during a rebase. Correctly assign the library descriptions to their library. [Sami] ArmPkg/ArmPkg.dec | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec index 496f588bd0ca..151626039b0c 100644 --- a/ArmPkg/ArmPkg.dec +++ b/ArmPkg/ArmPkg.dec @@ -27,20 +27,67 @@ [Includes.common] 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 -- 2.17.1