* [PATCH v2 1/2] ArmPkg/ArmScmiDxe: Fix ASSERT error in SCMI DXE
2018-06-19 13:53 [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware Girish Pathak
@ 2018-06-19 13:53 ` Girish Pathak
2018-06-19 13:53 ` [PATCH v2 2/2] ArmPkg/ArmScmiDxe: Dynamically allocate buffer for protocol ids Girish Pathak
2018-06-22 6:23 ` [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware Ard Biesheuvel
2 siblings, 0 replies; 4+ messages in thread
From: Girish Pathak @ 2018-06-19 13:53 UTC (permalink / raw)
To: edk2-devel
Cc: ard.biesheuvel, leif.lindholm, Matteo.Carlini,
Stephanie.Hughes-Fitt, Sudeep.Holla, nd
This change fixes a bug in the SCMI DXE which is observed with the
upcoming release of the SCP firmware.
The PROTOCOL_ID_MASK (0xF) which is used to generate an index in
the ProtocolInitFxns is wrong because protocol ids can be
anywhere in 0x10 - 15 or 0x80 - FF range. This mask generates
the same index for two different protocols e.g. for protocol ids
0x10 and 0x90, which causes duplicate initialization of a protocol
resulting in a failure.
This change removes the use of PROTOCOL_ID_MASK and instead
uses a list of protocol ids and their initialization functions
to identify a supported protocol and initialize it.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Girish Pathak <girish.pathak@arm.com>
Tested-by: Sudeep Holla <sudeep.holla@arm.com>
---
Notes:
v2:
- We don't permit initialized automatic variables. [Ard]
Fixed. [Girish]
- Just use Protocols[0].Id. [Ard]
Done. [Girish]
- Call ScmiBaseProtocolInit() here. [Ard]
Done. [Girish]
- Please use a for () loop instead of while [Ard]
Fixed. [Girish]
- Replace ASSERT (FALSE) with ASSERT_EFI_ERROR () [Ard]
Fixed. [Girish]
- Rename InitFxn to InitFn [Ard]
Fixed. [Girish]
ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 36 ++++++++++----------
ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h | 8 +++--
2 files changed, 23 insertions(+), 21 deletions(-)
diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
index 2920c6f6f33c5bb8ac00c903a0b199ba5f06f4de..a56c7b21d5f09d41a110826b7b9db14ac34451de 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
@@ -29,13 +29,10 @@
#include "ScmiDxe.h"
#include "ScmiPrivate.h"
-STATIC CONST SCMI_PROTOCOL_INIT_TABLE ProtocolInitFxns[MAX_PROTOCOLS] = {
- { ScmiBaseProtocolInit },
- { NULL },
- { NULL },
- { ScmiPerformanceProtocolInit },
- { ScmiClockProtocolInit },
- { NULL }
+STATIC CONST SCMI_PROTOCOL_ENTRY Protocols[] = {
+ { SCMI_PROTOCOL_ID_BASE, ScmiBaseProtocolInit },
+ { SCMI_PROTOCOL_ID_PERFORMANCE, ScmiPerformanceProtocolInit },
+ { SCMI_PROTOCOL_ID_CLOCK, ScmiClockProtocolInit }
};
/** ARM SCMI driver entry point function.
@@ -65,14 +62,14 @@ ArmScmiDxeEntryPoint (
UINT32 Version;
UINT32 Index;
UINT32 NumProtocols;
- UINT32 ProtocolNo;
+ UINT32 ProtocolIndex;
UINT8 SupportedList[MAX_PROTOCOLS];
UINT32 SupportedListSize = sizeof (SupportedList);
- ProtocolNo = SCMI_PROTOCOL_ID_BASE & PROTOCOL_ID_MASK;
-
// Every SCMI implementation must implement the base protocol.
- Status = ProtocolInitFxns[ProtocolNo].Init (&ImageHandle);
+ ASSERT (Protocols[0].Id == SCMI_PROTOCOL_ID_BASE);
+
+ Status = ScmiBaseProtocolInit (&ImageHandle);
if (EFI_ERROR (Status)) {
ASSERT (FALSE);
return Status;
@@ -123,13 +120,16 @@ ArmScmiDxeEntryPoint (
}
// Install supported protocol on ImageHandle.
- for (Index = 0; Index < NumProtocols; Index++) {
- ProtocolNo = SupportedList[Index] & PROTOCOL_ID_MASK;
- if (ProtocolInitFxns[ProtocolNo].Init != NULL) {
- Status = ProtocolInitFxns[ProtocolNo].Init (&ImageHandle);
- if (EFI_ERROR (Status)) {
- ASSERT (FALSE);
- return Status;
+ for (ProtocolIndex = 1; ProtocolIndex < ARRAY_SIZE (Protocols);
+ ProtocolIndex++) {
+ for (Index = 0; Index < NumProtocols; Index++) {
+ if (Protocols[ProtocolIndex].Id == SupportedList[Index]) {
+ Status = Protocols[ProtocolIndex].InitFn (&ImageHandle);
+ if (EFI_ERROR (Status)) {
+ ASSERT_EFI_ERROR (Status);
+ return Status;
+ }
+ break;
}
}
}
diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
index 29cdde173659c701116b021a3c437a92b473e4e5..222e54f4dca558d9b1fedddf3f96fd977898c7b2 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
@@ -17,8 +17,9 @@
#ifndef SCMI_DXE_H_
#define SCMI_DXE_H_
+#include "ScmiPrivate.h"
+
#define MAX_PROTOCOLS 6
-#define PROTOCOL_ID_MASK 0xF
#define MAX_VENDOR_LEN SCMI_MAX_STR_LEN
/** Pointer to protocol initialization function.
@@ -35,7 +36,8 @@ EFI_STATUS
);
typedef struct {
- SCMI_PROTOCOL_INIT_FXN Init;
-} SCMI_PROTOCOL_INIT_TABLE;
+ SCMI_PROTOCOL_ID Id; // Protocol Id.
+ SCMI_PROTOCOL_INIT_FXN InitFn; // Protocol init function.
+} SCMI_PROTOCOL_ENTRY;
#endif /* SCMI_DXE_H_ */
--
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
^ permalink raw reply related [flat|nested] 4+ messages in thread* [PATCH v2 2/2] ArmPkg/ArmScmiDxe: Dynamically allocate buffer for protocol ids
2018-06-19 13:53 [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware Girish Pathak
2018-06-19 13:53 ` [PATCH v2 1/2] ArmPkg/ArmScmiDxe: Fix ASSERT error in SCMI DXE Girish Pathak
@ 2018-06-19 13:53 ` Girish Pathak
2018-06-22 6:23 ` [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware Ard Biesheuvel
2 siblings, 0 replies; 4+ messages in thread
From: Girish Pathak @ 2018-06-19 13:53 UTC (permalink / raw)
To: edk2-devel
Cc: ard.biesheuvel, leif.lindholm, Matteo.Carlini,
Stephanie.Hughes-Fitt, Sudeep.Holla, nd
Dynamically allocate the buffer to receive the SCMI protocol list.
This makes MAX_PROTOCOLS redundant, so it is removed.
It also fixes one minor code alignment issue and removes an unused
macro PROTOCOL_MASK.
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Girish Pathak <girish.pathak@arm.com>
Tested-by: Sudeep Holla <sudeep.holla@arm.com>
---
Notes:
v2:
- Remove change-id [Ard]
Done [Girish]
ArmPkg/Drivers/ArmScmiDxe/Scmi.c | 5 ----
ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 27 +++++++++++++++-----
ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h | 1 -
3 files changed, 21 insertions(+), 12 deletions(-)
diff --git a/ArmPkg/Drivers/ArmScmiDxe/Scmi.c b/ArmPkg/Drivers/ArmScmiDxe/Scmi.c
index 1e279f69cf615428dbb6477b8ac7de3258628df3..d247d3a932fe9f197460a95e9afa88681742e4b4 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/Scmi.c
+++ b/ArmPkg/Drivers/ArmScmiDxe/Scmi.c
@@ -22,11 +22,6 @@
#include "ScmiPrivate.h"
-// SCMI Specification 1.0
-#define MAX_PROTOCOLS 6
-
-#define PROTOCOL_MASK 0xF
-
// Arbitrary timeout value 20ms.
#define RESPONSE_TIMEOUT 20000
diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
index a56c7b21d5f09d41a110826b7b9db14ac34451de..0400799b5c521dcfa2ce866b0ffd48530e8cf0d1 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
@@ -63,8 +63,8 @@ ArmScmiDxeEntryPoint (
UINT32 Index;
UINT32 NumProtocols;
UINT32 ProtocolIndex;
- UINT8 SupportedList[MAX_PROTOCOLS];
- UINT32 SupportedListSize = sizeof (SupportedList);
+ UINT8 *SupportedList;
+ UINT32 SupportedListSize;
// Every SCMI implementation must implement the base protocol.
ASSERT (Protocols[0].Id == SCMI_PROTOCOL_ID_BASE);
@@ -108,13 +108,26 @@ ArmScmiDxeEntryPoint (
ASSERT (NumProtocols != 0);
+ SupportedListSize = (NumProtocols * sizeof (*SupportedList));
+
+ Status = gBS->AllocatePool (
+ EfiBootServicesData,
+ SupportedListSize,
+ (VOID**)&SupportedList
+ );
+ if (EFI_ERROR (Status)) {
+ ASSERT (FALSE);
+ return Status;
+ }
+
// Get the list of protocols supported by SCP firmware on the platform.
Status = BaseProtocol->DiscoverListProtocols (
- BaseProtocol,
- &SupportedListSize,
- SupportedList
- );
+ BaseProtocol,
+ &SupportedListSize,
+ SupportedList
+ );
if (EFI_ERROR (Status)) {
+ gBS->FreePool (SupportedList);
ASSERT (FALSE);
return Status;
}
@@ -134,5 +147,7 @@ ArmScmiDxeEntryPoint (
}
}
+ gBS->FreePool (SupportedList);
+
return EFI_SUCCESS;
}
diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
index 222e54f4dca558d9b1fedddf3f96fd977898c7b2..c9a9072579e32c06cc231d388fb3f2fe8d37eb21 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h
@@ -19,7 +19,6 @@
#include "ScmiPrivate.h"
-#define MAX_PROTOCOLS 6
#define MAX_VENDOR_LEN SCMI_MAX_STR_LEN
/** Pointer to protocol initialization function.
--
'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware
2018-06-19 13:53 [PATCH v2 0/2] ArmPkg/ArmScmiDxe: Fix a bug uncovered with the new SCP firmware Girish Pathak
2018-06-19 13:53 ` [PATCH v2 1/2] ArmPkg/ArmScmiDxe: Fix ASSERT error in SCMI DXE Girish Pathak
2018-06-19 13:53 ` [PATCH v2 2/2] ArmPkg/ArmScmiDxe: Dynamically allocate buffer for protocol ids Girish Pathak
@ 2018-06-22 6:23 ` Ard Biesheuvel
2 siblings, 0 replies; 4+ messages in thread
From: Ard Biesheuvel @ 2018-06-22 6:23 UTC (permalink / raw)
To: Girish Pathak
Cc: edk2-devel@lists.01.org, Leif Lindholm, Matteo Carlini,
Stephanie Hughes-Fitt, Sudeep Holla, nd
On 19 June 2018 at 15:53, Girish Pathak <girish.pathak@arm.com> wrote:
> This patch series addresses comments on the original
> https://github.com/girishpathak/edk2/tree/281_scmi_fix_v1
>
> This series fixes a bug in the ArmScmiDxe which was revealed while
> testing with the new SCP firmware.
>
> The changes can be seen at https://github.com/girishpathak/edk2/tree/281_scmi_fix_v2
>
> Girish Pathak (2):
> ArmPkg/ArmScmiDxe: Fix ASSERT error in SCMI DXE
> ArmPkg/ArmScmiDxe: Dynamically allocate buffer for protocol ids
>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Pushed as 09ef8e92580c..3b03b5e990f8
Thanks
> ArmPkg/Drivers/ArmScmiDxe/Scmi.c | 5 --
> ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 63 ++++++++++++--------
> ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.h | 9 +--
> 3 files changed, 44 insertions(+), 33 deletions(-)
>
> --
> 'Guid(CE165669-3EF3-493F-B85D-6190EE5B9759)'
>
>
^ permalink raw reply [flat|nested] 4+ messages in thread