From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=217.140.96.140; helo=cam-smtp0.cambridge.arm.com; envelope-from=girish.pathak@arm.com; receiver=edk2-devel@lists.01.org Received: from cam-smtp0.cambridge.arm.com (fw-tnat.cambridge.arm.com [217.140.96.140]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C426F21155D2C for ; Tue, 19 Jun 2018 06:54:02 -0700 (PDT) Received: from E107875.Emea.Arm.com (E107875.Emea.Arm.com [10.1.206.50]) by cam-smtp0.cambridge.arm.com (8.13.8/8.13.8) with ESMTP id w5JDrxq2026015; Tue, 19 Jun 2018 14:53:59 +0100 From: Girish Pathak To: edk2-devel@lists.01.org Cc: ard.biesheuvel@linaro.org, leif.lindholm@linaro.org, Matteo.Carlini@arm.com, Stephanie.Hughes-Fitt@arm.com, Sudeep.Holla@arm.com, nd@arm.com Date: Tue, 19 Jun 2018 14:53:52 +0100 Message-Id: <20180619135353.40176-2-girish.pathak@arm.com> X-Mailer: git-send-email 2.13.3.windows.1 In-Reply-To: <20180619135353.40176-1-girish.pathak@arm.com> References: <20180619135353.40176-1-girish.pathak@arm.com> Subject: [PATCH v2 1/2] ArmPkg/ArmScmiDxe: Fix ASSERT error in SCMI DXE X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Jun 2018 13:54:03 -0000 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 Tested-by: Sudeep Holla --- 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)'