[PATCH v1 1/1] ArmPkg: Update SCMI Base Protocol version to 0x20000

[PATCH v1 1/1] ArmPkg: Update SCMI Base Protocol version to 0x20000

[PierreGondois]

From: Nicola Mazzucato <nicola.mazzucato@arm.com>

The SCP-firmware has moved to full support for SCMIv2 which means that
the base protocol can be either compliant with SCMI v1 or v2.

Allow any version between SCMI v1.0 and SCMI v2.0 to be compatible
with the current implementation.

Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com>
---
The changes can be seen at: https://github.com/PierreARM/edk2/tree/1732_Update_SCMI_version_v1

 ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c           | 10 ++++++----
 ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h | 10 +++++-----
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
index d5890a7633a2..fb4e79aa3610 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
@@ -4,9 +4,9 @@
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
-  System Control and Management Interface V1.0
-    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
-    DEN0056A_System_Control_and_Management_Interface.pdf
+  @par Specification Reference:
+  - Arm System Control and Management Interface - Platform Design Document
+    (https://developer.arm.com/documentation/den0056/)
 **/
 
 #include <Base.h>
@@ -86,7 +86,9 @@ ArmScmiDxeEntryPoint (
     return Status;
   }
 
-  if (Version != BASE_PROTOCOL_VERSION) {
+  // Accept any version between SCMI v1.0 and SCMI v2.0
+  if ((Version < BASE_PROTOCOL_VERSION_V1) ||
+    (Version > BASE_PROTOCOL_VERSION_V2)) {
     ASSERT (FALSE);
     return EFI_UNSUPPORTED;
   }
diff --git a/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h b/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
index 73ad3e32a2f5..c4b81c0f56d3 100644
--- a/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
+++ b/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
@@ -4,9 +4,9 @@
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
-  System Control and Management Interface V1.0
-    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
-    DEN0056A_System_Control_and_Management_Interface.pdf
+  @par Specification Reference:
+  - Arm System Control and Management Interface - Platform Design Document
+    (https://developer.arm.com/documentation/den0056/)
 **/
 
 #ifndef ARM_SCMI_BASE_PROTOCOL_H_
@@ -14,7 +14,8 @@
 
 #include <Protocol/ArmScmi.h>
 
-#define BASE_PROTOCOL_VERSION  0x10000
+#define BASE_PROTOCOL_VERSION_V1  0x10000
+#define BASE_PROTOCOL_VERSION_V2  0x20000
 
 #define NUM_PROTOCOL_MASK      0xFFU
 #define NUM_AGENT_MASK         0xFFU
@@ -165,4 +166,3 @@ typedef enum {
 } SCMI_MESSAGE_ID_BASE;
 
 #endif /* ARM_SCMI_BASE_PROTOCOL_H_ */
-
-- 
2.17.1

Re: [PATCH v1 1/1] ArmPkg: Update SCMI Base Protocol version to 0x20000

[Ard Biesheuvel]

Hello Pierre,

On Thu, 6 May 2021 at 12:43, <Pierre.Gondois@arm.com> wrote:
>
> From: Nicola Mazzucato <nicola.mazzucato@arm.com>
>
> The SCP-firmware has moved to full support for SCMIv2 which means that
> the base protocol can be either compliant with SCMI v1 or v2.
>
> Allow any version between SCMI v1.0 and SCMI v2.0 to be compatible
> with the current implementation.
>
> Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com>

SOB is not an attribution of authorship, it is a statement made by the
person contributing the patch asserting that the contribution complies
with the license.

IOW, you can keep the From: line, but please change the SOB to your
name and email.

Thanks,
Ard.

> ---
> The changes can be seen at: https://github.com/PierreARM/edk2/tree/1732_Update_SCMI_version_v1
>
>  ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c           | 10 ++++++----
>  ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h | 10 +++++-----
>  2 files changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
> index d5890a7633a2..fb4e79aa3610 100644
> --- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
> +++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
> @@ -4,9 +4,9 @@
>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
>
> -  System Control and Management Interface V1.0
> -    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
> -    DEN0056A_System_Control_and_Management_Interface.pdf
> +  @par Specification Reference:
> +  - Arm System Control and Management Interface - Platform Design Document
> +    (https://developer.arm.com/documentation/den0056/)
>  **/
>
>  #include <Base.h>
> @@ -86,7 +86,9 @@ ArmScmiDxeEntryPoint (
>      return Status;
>    }
>
> -  if (Version != BASE_PROTOCOL_VERSION) {
> +  // Accept any version between SCMI v1.0 and SCMI v2.0
> +  if ((Version < BASE_PROTOCOL_VERSION_V1) ||
> +    (Version > BASE_PROTOCOL_VERSION_V2)) {
>      ASSERT (FALSE);
>      return EFI_UNSUPPORTED;
>    }
> diff --git a/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h b/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
> index 73ad3e32a2f5..c4b81c0f56d3 100644
> --- a/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
> +++ b/ArmPkg/Include/Protocol/ArmScmiBaseProtocol.h
> @@ -4,9 +4,9 @@
>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
>
> -  System Control and Management Interface V1.0
> -    http://infocenter.arm.com/help/topic/com.arm.doc.den0056a/
> -    DEN0056A_System_Control_and_Management_Interface.pdf
> +  @par Specification Reference:
> +  - Arm System Control and Management Interface - Platform Design Document
> +    (https://developer.arm.com/documentation/den0056/)
>  **/
>
>  #ifndef ARM_SCMI_BASE_PROTOCOL_H_
> @@ -14,7 +14,8 @@
>
>  #include <Protocol/ArmScmi.h>
>
> -#define BASE_PROTOCOL_VERSION  0x10000
> +#define BASE_PROTOCOL_VERSION_V1  0x10000
> +#define BASE_PROTOCOL_VERSION_V2  0x20000
>
>  #define NUM_PROTOCOL_MASK      0xFFU
>  #define NUM_AGENT_MASK         0xFFU
> @@ -165,4 +166,3 @@ typedef enum {
>  } SCMI_MESSAGE_ID_BASE;
>
>  #endif /* ARM_SCMI_BASE_PROTOCOL_H_ */
> -
> --
> 2.17.1
>

Re: [PATCH v1 1/1] ArmPkg: Update SCMI Base Protocol version to 0x20000

[PierreGondois]

Hi Ard,

On 5/7/21 6:33 PM, Ard Biesheuvel wrote:
> Hello Pierre,
>
> On Thu, 6 May 2021 at 12:43, <Pierre.Gondois@arm.com> wrote:
>> From: Nicola Mazzucato <nicola.mazzucato@arm.com>
>>
>> The SCP-firmware has moved to full support for SCMIv2 which means that
>> the base protocol can be either compliant with SCMI v1 or v2.
>>
>> Allow any version between SCMI v1.0 and SCMI v2.0 to be compatible
>> with the current implementation.
>>
>> Signed-off-by: Nicola Mazzucato <nicola.mazzucato@arm.com>
> SOB is not an attribution of authorship, it is a statement made by the
> person contributing the patch asserting that the contribution complies
> with the license.
>
> IOW, you can keep the From: line, but please change the SOB to your
> name and email.
>
> Thanks,
> Ard.
>
Ok, I re-sent the patch with my SOB added. I kept Nicola's one as
for (a) of the certificate of origin:

"The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file"

Regards,
Pierre