From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from walk.intel-email.com (walk.intel-email.com [101.227.64.242]) by mx.groups.io with SMTP id smtpd.web10.19854.1675247244814921309 for ; Wed, 01 Feb 2023 02:27:26 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@byosoft.com.cn header.s=cloud-union header.b=NMRaaVN4; spf=pass (domain: byosoft.com.cn, ip: 101.227.64.242, mailfrom: xueshengfeng@byosoft.com.cn) Received: from walk.intel-email.com (localhost [127.0.0.1]) by walk.intel-email.com (Postfix) with ESMTP id ABCB9CD1FB51 for ; Wed, 1 Feb 2023 18:01:56 +0800 (CST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=byosoft.com.cn; s=cloud-union; t=1675245716; bh=iJLHdm8I/WTyxerqO699p1D/ni260v767Ykzt5oBMRY=; h=From:To:Cc:Subject:Date; b=NMRaaVN4iR0RqL3xLoRCuTEqMctc8yrnx+5ih6tA2oARFgkd85m67RF2/UpFXaVnh QWpfFp5les+43yr1dSoZZRiTVnXtu1UK3ShIpNvA2NnIiNMeDMYJo5OaxoTol7R4Um cYtBXxX5AO0xLUzf/KqFD2fDUdg4OudT8Glx7GzA= Received: from localhost (localhost [127.0.0.1]) by walk.intel-email.com (Postfix) with ESMTP id A7034CD1FB50 for ; Wed, 1 Feb 2023 18:01:56 +0800 (CST) Received: from walk.intel-email.com (localhost [127.0.0.1]) by walk.intel-email.com (Postfix) with ESMTP id 73F34CD1FB4F for ; Wed, 1 Feb 2023 18:01:56 +0800 (CST) Authentication-Results: walk.intel-email.com; none Received: from mail.byosoft.com.cn (mail.byosoft.com.cn [58.240.74.242]) by walk.intel-email.com (Postfix) with SMTP id 74ACACD1FB40 for ; Wed, 1 Feb 2023 18:01:53 +0800 (CST) Received: from localhost.localdomain ([112.86.218.122]) (envelope-sender ) by 192.168.6.13 with ESMTP for ; Wed, 01 Feb 2023 18:01:45 +0800 X-WM-Sender: xueshengfeng@byosoft.com.cn X-Originating-IP: 112.86.218.122 X-WM-AuthFlag: YES X-WM-AuthUser: xueshengfeng@byosoft.com.cn From: xueshengfeng To: devel@edk2.groups.io, jian.j.wang@intel.com, gaoliming@byosoft.com.cn Cc: heinrich.schuchardt@canonical.com, edhaya.chandran@arm.com, samer.el-haj-mahmoud@arm.com, lijun10x , Sunny Wang Subject: =?UTF-8?B?W1BBVENIXSBSRUbvvJogaHR0cHM6Ly9idWd6aWxsYS50aWFub2NvcmUub3JnL3Nob3dfYnVnLmNnaT9pZD00MzMx?= Date: Wed, 1 Feb 2023 18:01:36 +0800 Message-Id: <43b8335a00e024f0fd399b73d91073ad74cc8851.1675238268.git.junx1.li@intel.com> X-Mailer: git-send-email 2.31.1.windows.1 MIME-Version: 1.0 Sender: xueshengfeng Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable From: lijun10x Some platforms don't support S3 with PcdAcpiS3Enable set as False. Debug mode bios will ASSERT at this time as Follows. ASSERT_RETURN_ERROR (Status =3D Out of Resources) DXE_ASSERT!: Edk2\MdePkg\Library\BaseS3PciSegmentLib\S3PciSegmentLib.c (6= 1): !(((INTN)(RETURN_STATUS)(Status)) < 0) Steps to reproduce the issue:- 1.Set PcdAcpiS3Enable to FALSE. 2.Build the bios in debug mode. 3.Power on and Check the serial log. Note: Prerequisite is that S3PciSegmentLib is Called and the caller's cod= e is run. Root Cause: S3PciSegmentLib call S3BootScriptLib which controlled by PcdAcpiS3Enable. If PcdAcpiS3Enable set as false, S3BootScriptLib will return error status= (Out of Resources). S3PciSegmentLib will ASSERT if S3BootScriptLib return error. Solution: Make S3BootScriptLib return success if PcdAcpiS3Enable was disabled, which behave as a null S3BootScriptLib instance which just return success= for no action is required to do. Signed-off-by: junx1.li@intel.com Cc: Liming Gao Cc: Sunny Wang Cc: Heinrich Schuchardt Cc: G Edhaya Chandran Cc: Samer El-Haj-Mahmoud --- .../PiDxeS3BootScriptLib/BootScriptSave.c | 132 ++++++++++++++---- 1 file changed, 108 insertions(+), 24 deletions(-) diff --git a/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c b= /MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c index f8d4983d81..b9b8562f14 100644 --- a/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c +++ b/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c @@ -1004,7 +1004,7 @@ S3BootScriptCloseTable ( @param Buffer The source buffer from which to write data. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1021,6 +1021,10 @@ S3BootScriptSaveIoWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_IO_WRITE ScriptIoWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); =20 // @@ -1064,7 +1068,7 @@ S3BootScriptSaveIoWrite ( @param DataMask A pointer to the data mask to be AND-ed with the data= read from the register =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1080,6 +1084,10 @@ S3BootScriptSaveIoReadWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_IO_READ_WRITE ScriptIoReadWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + (Widt= hInByte * 2)); =20 @@ -1114,7 +1122,7 @@ S3BootScriptSaveIoReadWrite ( @param Buffer The source buffer from which to write the data. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1130,6 +1138,10 @@ S3BootScriptSaveMemWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_MEM_WRITE ScriptMemWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); =20 // @@ -1174,7 +1186,7 @@ S3BootScriptSaveMemWrite ( @param DataMask A pointer to the data mask to be AND-ed with the data= read from the register. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1190,6 +1202,10 @@ S3BootScriptSaveMemReadWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_MEM_READ_WRITE ScriptMemReadWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + (Wid= thInByte * 2)); =20 @@ -1224,7 +1240,7 @@ S3BootScriptSaveMemReadWrite ( @param Buffer The source buffer from which to write the data. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -1242,6 +1258,10 @@ S3BootScriptSavePciCfgWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE ScriptPciWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -1293,7 +1313,7 @@ S3BootScriptSavePciCfgWrite ( @param DataMask A pointer to the data mask to be AND-ed. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN__SUCCESS Opcode is added. + @retval RETURN__SUCCESS Opcode is added or no action is requ= ired as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -1311,6 +1331,10 @@ S3BootScriptSavePciCfgReadWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE ScriptPciReadWrite; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -1357,7 +1381,7 @@ S3BootScriptSavePciCfgReadWrite ( @param Buffer The source buffer from which to write the data. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -1376,6 +1400,10 @@ S3BootScriptSavePciCfg2Write ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE ScriptPciWrite2; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -1429,7 +1457,7 @@ S3BootScriptSavePciCfg2Write ( @param DataMask A pointer to the data mask to be AND-ed. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -1448,6 +1476,10 @@ S3BootScriptSavePciCfg2ReadWrite ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE ScriptPciReadWrite2; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -1601,7 +1633,7 @@ CheckParameters ( @param Buffer Contains the value of data to execute to the SMB= US slave device. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1618,6 +1650,10 @@ S3BootScriptSaveSmbusExecute ( UINT8 *Script; EFI_BOOT_SCRIPT_SMBUS_EXECUTE ScriptSmbusExecute; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if (Length =3D=3D NULL) { BufferLength =3D 0; } else { @@ -1670,7 +1706,7 @@ S3BootScriptSaveSmbusExecute ( @param Duration Duration in microseconds of the stall =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1682,6 +1718,10 @@ S3BootScriptSaveStall ( UINT8 *Script; EFI_BOOT_SCRIPT_STALL ScriptStall; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_STALL)); =20 Script =3D S3BootScriptGetEntryAddAddress (Length); @@ -1710,7 +1750,7 @@ S3BootScriptSaveStall ( @param Context Argument to be passed into the EntryPoint of the c= ode to be dispatched. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1723,6 +1763,10 @@ S3BootScriptSaveDispatch2 ( UINT8 *Script; EFI_BOOT_SCRIPT_DISPATCH_2 ScriptDispatch2; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH_2)); =20 Script =3D S3BootScriptGetEntryAddAddress (Length); @@ -1762,7 +1806,7 @@ S3BootScriptSaveDispatch2 ( @param LoopTimes The times of the register polling. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. =20 **/ RETURN_STATUS @@ -1781,6 +1825,10 @@ S3BootScriptSaveMemPoll ( UINT8 WidthInByte; EFI_BOOT_SCRIPT_MEM_POLL ScriptMemPoll; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); =20 Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + (WidthInByte * = 2)); @@ -1817,7 +1865,7 @@ S3BootScriptSaveMemPoll ( @param Information Information to be logged in the boot scrpit =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. =20 **/ RETURN_STATUS @@ -1831,6 +1879,10 @@ S3BootScriptSaveInformation ( UINT8 *Script; EFI_BOOT_SCRIPT_INFORMATION ScriptInformation; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + // // Truncation check // @@ -1868,7 +1920,7 @@ S3BootScriptSaveInformation ( @param String The string to save to boot script table =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. =20 **/ RETURN_STATUS @@ -1889,7 +1941,7 @@ S3BootScriptSaveInformationAsciiString ( @param EntryPoint Entry point of the code to be dispatched. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -1901,6 +1953,10 @@ S3BootScriptSaveDispatch ( UINT8 *Script; EFI_BOOT_SCRIPT_DISPATCH ScriptDispatch; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH)); =20 Script =3D S3BootScriptGetEntryAddAddress (Length); @@ -1935,7 +1991,7 @@ S3BootScriptSaveDispatch ( granularity so the delay may be longer. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do ope= ration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is require= d as ACPI S3 was disabled. =20 **/ RETURN_STATUS @@ -1953,6 +2009,10 @@ S3BootScriptSaveIoPoll ( UINT8 Length; EFI_BOOT_SCRIPT_IO_POLL ScriptIoPoll; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + WidthInByte =3D (UINT8)(0x01 << (Width & 0x03)); Length =3D (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByt= e * 2)); =20 @@ -1992,7 +2052,7 @@ S3BootScriptSaveIoPoll ( granularity so the delay may be longer. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do ope= ration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requir= ed as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -2011,6 +2071,10 @@ S3BootScriptSavePciPoll ( UINT8 Length; EFI_BOOT_SCRIPT_PCI_CONFIG_POLL ScriptPciPoll; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -2058,7 +2122,7 @@ S3BootScriptSavePciPoll ( granularity so the delay may be longer. =20 @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do ope= ration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requir= ed as ACPI S3 was disabled. @note A known Limitations in the implementation which is 64bits opera= tions are not supported. =20 **/ @@ -2078,6 +2142,10 @@ S3BootScriptSavePci2Poll ( UINT8 Length; EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL ScriptPci2Poll; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if ((Width =3D=3D S3BootScriptWidthUint64) || (Width =3D=3D S3BootScriptWidthFifoUint64) || (Width =3D=3D S3BootScriptWidthFillUint64)) @@ -2192,7 +2260,7 @@ S3BootScriptCalculateInsertAddress ( =20 @retval RETURN_OUT_OF_RESOURCES The table is not available. @retval RETURN_INVALID_PARAMETER The Position is not a valid position = in the boot script table. - @retval RETURN_SUCCESS Opcode is inserted. + @retval RETURN_SUCCESS Opcode is inserted no action is requi= red as ACPI S3 was disabled. **/ RETURN_STATUS EFIAPI @@ -2210,6 +2278,10 @@ S3BootScriptMoveLastOpcode ( UINT8 *LastOpcode; UINT8 TempBootScriptEntry[BOOT_SCRIPT_NODE_MA= X_LENGTH]; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + ValidatePosition =3D FALSE; TempPosition =3D (Position =3D=3D NULL) ? NULL : (*Position); =20 @@ -2297,7 +2369,7 @@ S3BootScriptMoveLastOpcode ( =20 @retval RETURN_INVALID_PARAMETER The Position is not a valid position = in the boot script table. @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do op= eration. - @retval RETURN_SUCCESS Opcode is added. + @retval RETURN_SUCCESS Opcode is added or no action is requi= red as ACPI S3 was disabled. =20 **/ RETURN_STATUS @@ -2313,6 +2385,10 @@ S3BootScriptLabelInternal ( UINT8 *Script; EFI_BOOT_SCRIPT_INFORMATION ScriptInformation; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + // // Truncation check // @@ -2357,8 +2433,8 @@ S3BootScriptLabelInternal ( of the inserted opcode in the boot scrip= t table. @param Label Points to the label which will be insert= ed in the boot script table. =20 - @retval EFI_SUCCESS The operation succeeded. A record was ad= ded into the - specified script table. + @retval EFI_SUCCESS The operation succeeded or no action is = required.=20 + A record was added into the specified sc= ript table if ACPI S3 was enabled. @retval EFI_INVALID_PARAMETER The parameter is illegal or the given bo= ot script is not supported. If the opcode is unknow or not supported= because of the PCD Feature Flags. @@ -2381,6 +2457,10 @@ S3BootScriptLabel ( EFI_BOOT_SCRIPT_TABLE_HEADER TableHeader; UINT32 LabelLength; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + // // Check NULL Label // @@ -2443,8 +2523,8 @@ S3BootScriptLabel ( @param Position2 The positions in the boot script table t= o compare @param RelativePosition On return, points to the result of the c= omparison =20 - @retval EFI_SUCCESS The operation succeeded. A record was ad= ded into the - specified script table. + @retval EFI_SUCCESS The operation succeeded or no action is = required.=20 + A record was added into the specified sc= ript table if ACPI S3 was enabled. @retval EFI_INVALID_PARAMETER The parameter is illegal or the given bo= ot script is not supported. If the opcode is unknow or not supported= because of the PCD Feature Flags. @@ -2462,6 +2542,10 @@ S3BootScriptCompare ( UINT8 *Script; UINT32 TableLength; =20 + if (!mS3BootScriptAcpiS3Enable) { + return RETURN_SUCCESS; + } + if (RelativePosition =3D=3D NULL) { return EFI_INVALID_PARAMETER; } --=20 2.26.2.windows.1