1. Patchew
  2. EDK2
  3. [edk2-devel] [PATCH v1 00/12] ArmPkg/ArmPlatformPkg CI enablement
  4. View patch

[edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec

PierreGondois posted 12 patches 4 years, 9 months ago
There is a newer version of this series
[edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
Posted by PierreGondois 4 years, 9 months ago 
From: Pierre Gondois <Pierre.Gondois@arm.com>

Some library headers are missing/incorrect in ArmPkg.dec.
This makes the 'LibraryClassCheck' CI test fail. This patch
adds/corrects them.

According to .pytool/Readme about the 'LibraryClassCheck' test:
This test scans at all library header files found in the
`Library` folders in all of the package's declared include
directories and ensures that all files have a matching
LibraryClass declaration in the DEC file for the package.

Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=3254
Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=3258
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
 ArmPkg/ArmPkg.dec | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec
index a8a22c649ff8..496f588bd0ca 100644
--- a/ArmPkg/ArmPkg.dec
+++ b/ArmPkg/ArmPkg.dec
@@ -2,7 +2,7 @@
 # ARM processor package.
 #
 # Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>
-# Copyright (c) 2011 - 2018, ARM Limited. All rights reserved.
+# Copyright (c) 2011 - 2021, ARM Limited. All rights reserved.
 #
 #    SPDX-License-Identifier: BSD-2-Clause-Patent
 #
@@ -29,14 +29,20 @@ [Includes.common]
 [LibraryClasses.common]
   ArmLib|Include/Library/ArmLib.h
   ArmMmuLib|Include/Library/ArmMmuLib.h
-  SemihostLib|Include/Library/Semihosting.h
+  SemihostLib|Include/Library/SemihostLib.h
   DefaultExceptionHandlerLib|Include/Library/DefaultExceptionHandlerLib.h
   ArmDisassemblerLib|Include/Library/ArmDisassemblerLib.h
   ArmGicArchLib|Include/Library/ArmGicArchLib.h
-  ArmMtlLib|ArmPlatformPkg/Include/Library/ArmMtlLib.h
+  ArmMtlLib|Include/Library/ArmMtlLib.h
   ArmSvcLib|Include/Library/ArmSvcLib.h
   OpteeLib|Include/Library/OpteeLib.h
   StandaloneMmMmuLib|Include/Library/StandaloneMmMmuLib.h
+  ArmGenericTimerCounterLib|Include/Library/ArmGenericTimerCounterLib.h
+  ArmGicLib|Include/Library/ArmGicLib.h
+  ArmHvcLib|Include/Library/ArmHvcLib.h
+  OemMiscLib|Include/Library/OemMiscLib.h
+  ArmSmcLib|Include/Library/ArmSmcLib.h
+
 
 [Guids.common]
   gArmTokenSpaceGuid       = { 0xBB11ECFE, 0x820F, 0x4968, { 0xBB, 0xA6, 0xF7, 0x6A, 0xFE, 0x30, 0x25, 0x96 } }
-- 
2.17.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74323): https://edk2.groups.io/g/devel/message/74323
Mute This Topic: https://groups.io/mt/82258504/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
Posted by brbarkel via groups.io 4 years, 9 months ago 
1) To expedite the required reviews, you may want to add CC to the package maintainers for ArmPkg to this commit message and email. I know a lot of people filter based on direct mention vs mailing list.

2) Generally, other packages have a brief description of the lib in the DEC, as well. Example:
https://github.com/tianocore/edk2/blob/d3b0d007a135284981fa750612a47234b83976f9/MdeModulePkg/MdeModulePkg.dec#L55
However, I see that this has not historically been maintained in this package, so I'm not going to make a big deal of it.

Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74340): https://edk2.groups.io/g/devel/message/74340
Mute This Topic: https://groups.io/mt/82258504/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
Posted by PierreGondois 4 years, 9 months ago 
Hi Bret,
Ok I will do that in a V2.

Do these patches look ok to you ?

[PATCH v1 08/12] .pytool: Enable CI for ArmPkg
[PATCH v1 09/12] .pytool: Enable CI for ArmPlatformPkg
[PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck
[PATCH v1 11/12] AzurePipelines: Add support for ArmPkg
[PATCH v1 12/12] AzurePipelines: Add support for ArmPlatformPkg

Regards,
Pierre

On 4/21/21 8:13 PM, brbarkel via groups.io wrote:
>
> 1) To expedite the required reviews, you may want to add CC to the 
> package maintainers for ArmPkg to this commit message and email. I 
> know a lot of people filter based on direct mention vs mailing list.
>
> 2) Generally, other packages have a brief description of the lib in 
> the DEC, as well. Example:
> https://github.com/tianocore/edk2/blob/d3b0d007a135284981fa750612a47234b83976f9/MdeModulePkg/MdeModulePkg.dec#L55 
> <https://github.com/tianocore/edk2/blob/d3b0d007a135284981fa750612a47234b83976f9/MdeModulePkg/MdeModulePkg.dec#L55>
> However, I see that this has not historically been maintained in this 
> package, so I'm not going to make a big deal of it.
>
> Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
>
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74424): https://edk2.groups.io/g/devel/message/74424
Mute This Topic: https://groups.io/mt/82258504/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [EXTERNAL] Re: [edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
Posted by Bret Barkelew via groups.io 4 years, 9 months ago 
Those look good to me. Made one comment on 12/12. Also screwed up my hyphen on 8, 9, 10, and 12.

- Bret

From: Pierre Gondois<mailto:pierre.gondois@arm.com>
Sent: Monday, April 26, 2021 9:40 AM
To: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; Bret Barkelew<mailto:Bret.Barkelew@microsoft.com>
Subject: [EXTERNAL] Re: [edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec

Hi Bret,
Ok I will do that in a V2.

Do these patches look ok to you ?

[PATCH v1 08/12] .pytool: Enable CI for ArmPkg
[PATCH v1 09/12] .pytool: Enable CI for ArmPlatformPkg
[PATCH v1 10/12] .pytool: Document LicenseCheck and EccCheck
[PATCH v1 11/12] AzurePipelines: Add support for ArmPkg
[PATCH v1 12/12] AzurePipelines: Add support for ArmPlatformPkg

Regards,
Pierre

On 4/21/21 8:13 PM, brbarkel via groups.io wrote:
>
> 1) To expedite the required reviews, you may want to add CC to the
> package maintainers for ArmPkg to this commit message and email. I
> know a lot of people filter based on direct mention vs mailing list.
>
> 2) Generally, other packages have a brief description of the lib in
> the DEC, as well. Example:
> https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Ftianocore%2Fedk2%2Fblob%2Fd3b0d007a135284981fa750612a47234b83976f9%2FMdeModulePkg%2FMdeModulePkg.dec%23L55&amp;data=04%7C01%7CBret.Barkelew%40microsoft.com%7C11a94a7986c94a1dc9dd08d908d20f74%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637550520568164761%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=MsbriQVK47dxlgZxsTWgpiKS0XM8FOVwFY5askVkvAA%3D&amp;reserved=0
> <https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Ftianocore%2Fedk2%2Fblob%2Fd3b0d007a135284981fa750612a47234b83976f9%2FMdeModulePkg%2FMdeModulePkg.dec%23L55&amp;data=04%7C01%7CBret.Barkelew%40microsoft.com%7C11a94a7986c94a1dc9dd08d908d20f74%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637550520568164761%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&amp;sdata=MsbriQVK47dxlgZxsTWgpiKS0XM8FOVwFY5askVkvAA%3D&amp;reserved=0>
> However, I see that this has not historically been maintained in this
> package, so I'm not going to make a big deal of it.
>
> Reviewed-by: Bret Barkelew <bret.barkelew@microsoft.com>
>
> 



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74434): https://edk2.groups.io/g/devel/message/74434
Mute This Topic: https://groups.io/mt/82389102/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
Posted by Sami Mujawar 4 years, 9 months ago 
Hi Pierre,

Thank you for this patch.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

From: Pierre.Gondois@arm.com <Pierre.Gondois@arm.com>
Date: Wednesday, 21 April 2021 at 13:21
To: devel@edk2.groups.io <devel@edk2.groups.io>, Sami Mujawar <Sami.Mujawar@arm.com>, leif@nuviainc.com <leif@nuviainc.com>, ardb+tianocore@kernel.org <ardb+tianocore@kernel.org>, sean.brogan@microsoft.com <sean.brogan@microsoft.com>, Bret.Barkelew@microsoft.com <Bret.Barkelew@microsoft.com>
Subject: [PATCH v1 03/12] ArmPkg: Add missing library headers to ArmPkg.dec
From: Pierre Gondois <Pierre.Gondois@arm.com>

Some library headers are missing/incorrect in ArmPkg.dec.
This makes the 'LibraryClassCheck' CI test fail. This patch
adds/corrects them.

According to .pytool/Readme about the 'LibraryClassCheck' test:
This test scans at all library header files found in the
`Library` folders in all of the package's declared include
directories and ensures that all files have a matching
LibraryClass declaration in the DEC file for the package.

Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=3254
Fixes: https://bugzilla.tianocore.org/show_bug.cgi?id=3258
Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com>
---
 ArmPkg/ArmPkg.dec | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/ArmPkg/ArmPkg.dec b/ArmPkg/ArmPkg.dec
index a8a22c649ff8..496f588bd0ca 100644
--- a/ArmPkg/ArmPkg.dec
+++ b/ArmPkg/ArmPkg.dec
@@ -2,7 +2,7 @@
 # ARM processor package.
 #
 # Copyright (c) 2009 - 2010, Apple Inc. All rights reserved.<BR>
-# Copyright (c) 2011 - 2018, ARM Limited. All rights reserved.
+# Copyright (c) 2011 - 2021, ARM Limited. All rights reserved.
 #
 #    SPDX-License-Identifier: BSD-2-Clause-Patent
 #
@@ -29,14 +29,20 @@ [Includes.common]
 [LibraryClasses.common]
   ArmLib|Include/Library/ArmLib.h
   ArmMmuLib|Include/Library/ArmMmuLib.h
-  SemihostLib|Include/Library/Semihosting.h
+  SemihostLib|Include/Library/SemihostLib.h
   DefaultExceptionHandlerLib|Include/Library/DefaultExceptionHandlerLib.h
   ArmDisassemblerLib|Include/Library/ArmDisassemblerLib.h
   ArmGicArchLib|Include/Library/ArmGicArchLib.h
-  ArmMtlLib|ArmPlatformPkg/Include/Library/ArmMtlLib.h
+  ArmMtlLib|Include/Library/ArmMtlLib.h
   ArmSvcLib|Include/Library/ArmSvcLib.h
   OpteeLib|Include/Library/OpteeLib.h
   StandaloneMmMmuLib|Include/Library/StandaloneMmMmuLib.h
+  ArmGenericTimerCounterLib|Include/Library/ArmGenericTimerCounterLib.h
+  ArmGicLib|Include/Library/ArmGicLib.h
+  ArmHvcLib|Include/Library/ArmHvcLib.h
+  OemMiscLib|Include/Library/OemMiscLib.h
+  ArmSmcLib|Include/Library/ArmSmcLib.h
+

 [Guids.common]
   gArmTokenSpaceGuid       = { 0xBB11ECFE, 0x820F, 0x4968, { 0xBB, 0xA6, 0xF7, 0x6A, 0xFE, 0x30, 0x25, 0x96 } }
--
2.17.1
IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#74355): https://edk2.groups.io/g/devel/message/74355
Mute This Topic: https://groups.io/mt/82258504/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.