MdeModulePkg/Library: PcdAcpiS3Enable set FALSE cause Assert

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 = Out of Resources)
DXE_ASSERT!: Edk2\MdePkg\Library\BaseS3PciSegmentLib\S3PciSegmentLib.c
(61): !(((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 code is run.

Root Cause:
S3PciSegmentLib call S3BootScriptLib 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 <junx1.li@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Sunny Wang <sunny.wang@arm.com>
Cc: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Cc: G Edhaya Chandran <edhaya.chandran@arm.com>
Cc: Samer El-Haj-Mahmoud <samer.el-haj-mahmoud@arm.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

diff --git a/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c b/MdeModulePkg/Library/PiDxeS3BootScriptLib/BootScriptSave.c
index f8d4983d81e68bfcf43f0293cd58ce761b5b80f9..8c7b58b2f960e5609045eff250199ca4fb4f146c 100644 (file)
--- 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.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1021,6 +1021,10 @@ S3BootScriptSaveIoWrite (
   UINT8                     WidthInByte;\r
   EFI_BOOT_SCRIPT_IO_WRITE  ScriptIoWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
 \r
   //\r
@@ -1064,7 +1068,7 @@ S3BootScriptSaveIoWrite (
   @param DataMask  A pointer to the data mask to be AND-ed with the data read from the register\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1080,6 +1084,10 @@ S3BootScriptSaveIoReadWrite (
   UINT8                          WidthInByte;\r
   EFI_BOOT_SCRIPT_IO_READ_WRITE  ScriptIoReadWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
   Length      = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + (WidthInByte * 2));\r
 \r
@@ -1114,7 +1122,7 @@ S3BootScriptSaveIoReadWrite (
   @param Buffer  The source buffer from which to write the data.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1130,6 +1138,10 @@ S3BootScriptSaveMemWrite (
   UINT8                      WidthInByte;\r
   EFI_BOOT_SCRIPT_MEM_WRITE  ScriptMemWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
 \r
   //\r
@@ -1174,7 +1186,7 @@ S3BootScriptSaveMemWrite (
   @param DataMask  A pointer to the data mask to be AND-ed with the data read from the register.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1190,6 +1202,10 @@ S3BootScriptSaveMemReadWrite (
   UINT8                           WidthInByte;\r
   EFI_BOOT_SCRIPT_MEM_READ_WRITE  ScriptMemReadWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
   Length      = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + (WidthInByte * 2));\r
 \r
@@ -1224,7 +1240,7 @@ S3BootScriptSaveMemReadWrite (
   @param Buffer    The source buffer from which to write the data.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -1242,6 +1258,10 @@ S3BootScriptSavePciCfgWrite (
   UINT8                             WidthInByte;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE  ScriptPciWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -1293,7 +1313,7 @@ S3BootScriptSavePciCfgWrite (
   @param DataMask    A pointer to the data mask to be AND-ed.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN__SUCCESS           Opcode is added.\r
+  @retval RETURN__SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -1311,6 +1331,10 @@ S3BootScriptSavePciCfgReadWrite (
   UINT8                                  WidthInByte;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE  ScriptPciReadWrite;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -1357,7 +1381,7 @@ S3BootScriptSavePciCfgReadWrite (
   @param Buffer    The source buffer from which to write the data.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -1376,6 +1400,10 @@ S3BootScriptSavePciCfg2Write (
   UINT8                              WidthInByte;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE  ScriptPciWrite2;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -1429,7 +1457,7 @@ S3BootScriptSavePciCfg2Write (
   @param DataMask    A pointer to the data mask to be AND-ed.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -1448,6 +1476,10 @@ S3BootScriptSavePciCfg2ReadWrite (
   UINT8                                   WidthInByte;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE  ScriptPciReadWrite2;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -1601,7 +1633,7 @@ CheckParameters (
   @param Buffer         Contains the value of data to execute to the SMBUS slave device.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1618,6 +1650,10 @@ S3BootScriptSaveSmbusExecute (
   UINT8                          *Script;\r
   EFI_BOOT_SCRIPT_SMBUS_EXECUTE  ScriptSmbusExecute;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if (Length == NULL) {\r
     BufferLength = 0;\r
   } else {\r
@@ -1670,7 +1706,7 @@ S3BootScriptSaveSmbusExecute (
   @param Duration   Duration in microseconds of the stall\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1682,6 +1718,10 @@ S3BootScriptSaveStall (
   UINT8                  *Script;\r
   EFI_BOOT_SCRIPT_STALL  ScriptStall;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_STALL));\r
 \r
   Script = S3BootScriptGetEntryAddAddress (Length);\r
@@ -1710,7 +1750,7 @@ S3BootScriptSaveStall (
   @param Context      Argument to be passed into the EntryPoint of the code to be dispatched.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1723,6 +1763,10 @@ S3BootScriptSaveDispatch2 (
   UINT8                       *Script;\r
   EFI_BOOT_SCRIPT_DISPATCH_2  ScriptDispatch2;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));\r
 \r
   Script = S3BootScriptGetEntryAddAddress (Length);\r
@@ -1762,7 +1806,7 @@ S3BootScriptSaveDispatch2 (
   @param LoopTimes The times of the register polling.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -1781,6 +1825,10 @@ S3BootScriptSaveMemPoll (
   UINT8                     WidthInByte;\r
   EFI_BOOT_SCRIPT_MEM_POLL  ScriptMemPoll;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
 \r
   Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + (WidthInByte * 2));\r
@@ -1817,7 +1865,7 @@ S3BootScriptSaveMemPoll (
   @param Information       Information to be logged in the boot scrpit\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -1831,6 +1879,10 @@ S3BootScriptSaveInformation (
   UINT8                        *Script;\r
   EFI_BOOT_SCRIPT_INFORMATION  ScriptInformation;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   //\r
   // Truncation check\r
   //\r
@@ -1868,7 +1920,7 @@ S3BootScriptSaveInformation (
   @param String            The string to save to boot script table\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -1889,7 +1941,7 @@ S3BootScriptSaveInformationAsciiString (
   @param EntryPoint   Entry point of the code to be dispatched.\r
 \r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -1901,6 +1953,10 @@ S3BootScriptSaveDispatch (
   UINT8                     *Script;\r
   EFI_BOOT_SCRIPT_DISPATCH  ScriptDispatch;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH));\r
 \r
   Script = S3BootScriptGetEntryAddAddress (Length);\r
@@ -1935,7 +1991,7 @@ S3BootScriptSaveDispatch (
                                 granularity so the delay may be longer.\r
 \r
  @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
- @retval RETURN_SUCCESS          Opcode is added.\r
+ @retval RETURN_SUCCESS          Opcode is added or no action is required as ACPI S3 was disabled.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -1953,6 +2009,10 @@ S3BootScriptSaveIoPoll (
   UINT8                    Length;\r
   EFI_BOOT_SCRIPT_IO_POLL  ScriptIoPoll;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
   Length      = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByte * 2));\r
 \r
@@ -1992,7 +2052,7 @@ S3BootScriptSaveIoPoll (
                                 granularity so the delay may be longer.\r
 \r
  @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
- @retval RETURN_SUCCESS           Opcode is added.\r
+ @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -2011,6 +2071,10 @@ S3BootScriptSavePciPoll (
   UINT8                            Length;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG_POLL  ScriptPciPoll;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -2058,7 +2122,7 @@ S3BootScriptSavePciPoll (
                                 granularity so the delay may be longer.\r
 \r
  @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
- @retval RETURN_SUCCESS           Opcode is added.\r
+ @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
   @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
 \r
 **/\r
@@ -2078,6 +2142,10 @@ S3BootScriptSavePci2Poll (
   UINT8                             Length;\r
   EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL  ScriptPci2Poll;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if ((Width == S3BootScriptWidthUint64) ||\r
       (Width == S3BootScriptWidthFifoUint64) ||\r
       (Width == S3BootScriptWidthFillUint64))\r
@@ -2192,7 +2260,7 @@ S3BootScriptCalculateInsertAddress (
 \r
   @retval RETURN_OUT_OF_RESOURCES  The table is not available.\r
   @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.\r
-  @retval RETURN_SUCCESS           Opcode is inserted.\r
+  @retval RETURN_SUCCESS           Opcode is inserted no action is required as ACPI S3 was disabled.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -2210,6 +2278,10 @@ S3BootScriptMoveLastOpcode (
   UINT8                          *LastOpcode;\r
   UINT8                          TempBootScriptEntry[BOOT_SCRIPT_NODE_MAX_LENGTH];\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   ValidatePosition = FALSE;\r
   TempPosition     = (Position == NULL) ? NULL : (*Position);\r
 \r
@@ -2297,7 +2369,7 @@ S3BootScriptMoveLastOpcode (
 \r
   @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.\r
   @retval RETURN_OUT_OF_RESOURCES  Not enough memory for the table do operation.\r
-  @retval RETURN_SUCCESS           Opcode is added.\r
+  @retval RETURN_SUCCESS           Opcode is added or no action is required as ACPI S3 was disabled.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -2313,6 +2385,10 @@ S3BootScriptLabelInternal (
   UINT8                        *Script;\r
   EFI_BOOT_SCRIPT_INFORMATION  ScriptInformation;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   //\r
   // Truncation check\r
   //\r
@@ -2357,8 +2433,8 @@ S3BootScriptLabelInternal (
                                 of the inserted opcode in the boot script table.\r
   @param  Label                 Points to the label which will be inserted in the boot script table.\r
 \r
-  @retval EFI_SUCCESS           The operation succeeded. A record was added into the\r
-                                specified script table.\r
+  @retval EFI_SUCCESS           The operation succeeded or no action is required.\r
+                                A record was added into the specified script table if ACPI S3 was enabled.\r
   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
                                 If the opcode is unknow or not supported because of the PCD\r
                                 Feature Flags.\r
@@ -2381,6 +2457,10 @@ S3BootScriptLabel (
   EFI_BOOT_SCRIPT_TABLE_HEADER   TableHeader;\r
   UINT32                         LabelLength;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   //\r
   // Check NULL Label\r
   //\r
@@ -2443,8 +2523,8 @@ S3BootScriptLabel (
   @param  Position2             The positions in the boot script table to compare\r
   @param  RelativePosition      On return, points to the result of the comparison\r
 \r
-  @retval EFI_SUCCESS           The operation succeeded. A record was added into the\r
-                                specified script table.\r
+  @retval EFI_SUCCESS           The operation succeeded or no action is required.\r
+                                A record was added into the specified script table if ACPI S3 was enabled.\r
   @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.\r
                                 If the opcode is unknow or not supported because of the PCD\r
                                 Feature Flags.\r
@@ -2462,6 +2542,10 @@ S3BootScriptCompare (
   UINT8   *Script;\r
   UINT32  TableLength;\r
 \r
+  if (!mS3BootScriptAcpiS3Enable) {\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
   if (RelativePosition == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r