public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "PierreGondois" <pierre.gondois@arm.com>
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 v2 05/15] ArmPkg: Document libraries in ArmPkg.dec
Date: Tue, 27 Apr 2021 16:32:41 +0100	[thread overview]
Message-ID: <20210427153251.11576-6-Pierre.Gondois@arm.com> (raw)
In-Reply-To: <20210427153251.11576-1-Pierre.Gondois@arm.com>

From: Pierre Gondois <Pierre.Gondois@arm.com>

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>
---

Notes:
    V2:
     - Add documentation to the advertised libraries.
       This is a new patch. [Bret]

 ArmPkg/ArmPkg.dec | 50 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec
index 496f588bd0ca..dcd43a0f14f6 100644
--- a/ArmPkg/ArmPkg.dec
+++ b/ArmPkg/ArmPkg.dec
@@ -27,20 +27,70 @@ [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 an interface to initialize a
+  #   Generic Interrupt Controller (GIC).
+  #
   SemihostLib|Include/Library/SemihostLib.h
+
+  ##  @libraryclass  Provides a Generic Interrupt Controller (GIC)
+  #   configuration interface.
+  #
   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 query miscellaneous OEM
+  #   information.
+  #
   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


  parent reply	other threads:[~2021-04-27 15:33 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-27 15:32 [PATCH v2 00/15] ArmPkg/ArmPlatformPkg CI enablement PierreGondois
2021-04-27 15:32 ` [PATCH v2 01/15] ArmPkg: Fix Ecc error 8003 PierreGondois
2021-04-27 15:32 ` [PATCH v2 02/15] ArmPkg: Fix Ecc error 3002 in StandaloneMmMmuLib PierreGondois
2021-04-27 15:32 ` [PATCH v2 03/15] ArmPkg: Add missing library headers to ArmPkg.dec PierreGondois
2021-04-27 15:32 ` [PATCH v2 04/15] ArmPlatformPkg: Document libraries in ArmPlatformPkg.dec PierreGondois
2021-04-27 17:26   ` [edk2-devel] " Sami Mujawar
2021-04-27 15:32 ` PierreGondois [this message]
2021-04-27 17:25   ` [edk2-devel] [PATCH v2 05/15] ArmPkg: Document libraries in ArmPkg.dec Sami Mujawar
2021-04-27 17:41   ` Sami Mujawar
2021-04-28 10:22     ` PierreGondois
2021-04-27 15:32 ` [PATCH v2 06/15] ArmPkg: Re-order " PierreGondois
2021-04-27 17:36   ` [edk2-devel] " Sami Mujawar
2021-04-27 15:32 ` [PATCH v2 07/15] ArmPkg: Add OemMiscLibNull library to ArmPkg.dsc PierreGondois
2021-04-27 15:32 ` [PATCH v2 08/15] ArmPkg: Correct small typos PierreGondois
2021-04-27 15:32 ` [PATCH v2 09/15] ArmPkg: Add ArmPkg.ci.yaml PierreGondois
2021-04-27 15:32 ` [PATCH v2 10/15] ArmPlatformPkg: Add ArmPlatformPkg.ci.yaml PierreGondois
2021-04-27 15:32 ` [PATCH v2 11/15] .pytool: Enable CI for ArmPkg PierreGondois
2021-04-27 15:32 ` [PATCH v2 12/15] .pytool: Enable CI for ArmPlatformPkg PierreGondois
2021-04-27 15:32 ` [PATCH v2 13/15] .pytool: Document LicenseCheck and EccCheck PierreGondois
2021-04-27 15:32 ` [PATCH v2 14/15] AzurePipelines: Add support for ArmPkg PierreGondois
2021-04-27 15:32 ` [PATCH v2 15/15] AzurePipelines: Add support for ArmPlatformPkg PierreGondois

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210427153251.11576-6-Pierre.Gondois@arm.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox