From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pf1-f175.google.com (mail-pf1-f175.google.com [209.85.210.175]) by mx.groups.io with SMTP id smtpd.web08.1032.1641605575544748442 for ; Fri, 07 Jan 2022 17:32:55 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=QeKFEKFV; spf=pass (domain: gmail.com, ip: 209.85.210.175, mailfrom: kuqin12@gmail.com) Received: by mail-pf1-f175.google.com with SMTP id m1so6676621pfk.8 for ; Fri, 07 Jan 2022 17:32:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=pWvX8MPA+L6fQxldtbG/OS982bn0wUTeeK9P2UesPMI=; b=QeKFEKFV3oz4wVkWhepsCW5aSL4WQv7J5uHRzQROmu97gV6xCfpLUd8/YxTpCrN+pC 1XljCUgwXipfAfI0bwie87kImeMyC4fVoF1KpYNulqqSnNtEN7K2+e/ykOHjIodVilri 4rhWXyvNuK4ooT/3B03ObiCfbKzOICj5tvAB0CI2nx93SUPoB+wBx3j72qV2UJflCKYv 0Yy1xfMtDLyeOreEmz0TrXzU1TqroJuamx/OYGYcVgPAlt4KRmwzOyIIPMzo+00nWm7a xSfEpNz8PJwjZmfE5Lcel6irX+wzkBO0jiUT1F1hZS4RcIGxkqWnihPHvzR+QljUO+pC GHCw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pWvX8MPA+L6fQxldtbG/OS982bn0wUTeeK9P2UesPMI=; b=I/Zd1k72hCyxnrWUQmSP8wUBj0TL/KwATk7XLq9i13NnYVfjtzn33aQvS3hCV6gOTw yUori462eCmyuCOBuKleO4MF+lE7ipzmTmiZMDppeO/5U6EzlaOF0xrAnQKvLGNgnZRQ X4jIWzXf8Ba0bSi6imfqpVmsV8+h63yYEZ1t+ptFkbiVlUVMg6gaPKzN+3hdHwSm3l64 4VbloYK+I0oNZdg2mFTxqUGluE90mGzhSJnjOQcHjsO4BG2vWxBCSAvbWW/CSOScQOL0 42W4BvzaU2Hb7hnpwOj+IG5ADcDsH2qtD9S33phFCYgh+oB9pq3fTXrCMe7J6e1+tixk h87Q== X-Gm-Message-State: AOAM533v6uHx/mI2K7seEfIxeSiH7p99PVKhk8YRBxKLr8SYT1G7BjjW HF8vtma2Txg2xCbvGAmpR2v+iZmcMS4= X-Google-Smtp-Source: ABdhPJyyLoZWSSFqUBuBvGJbORQSrliyPKnbEvUNA3tCGjkHFCrw4wckvXD4+8PvnBfzGvgQJcVstA== X-Received: by 2002:a63:950b:: with SMTP id p11mr12889614pgd.475.1641605574943; Fri, 07 Jan 2022 17:32:54 -0800 (PST) Return-Path: Received: from localhost.localdomain ([50.35.74.198]) by smtp.gmail.com with ESMTPSA id h19sm151784pfh.112.2022.01.07.17.32.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 07 Jan 2022 17:32:54 -0800 (PST) From: "Kun Qin" To: devel@edk2.groups.io Cc: Andrew Fish , Leif Lindholm , Michael D Kinney , Liming Gao , Zhiguang Liu Subject: [PATCH v2 1/2] EDK2 Code First: PI Specification: New error codes of Host Software class Date: Fri, 7 Jan 2022 17:32:41 -0800 Message-Id: <20220108013242.2030-2-kuqin12@gmail.com> X-Mailer: git-send-email 2.34.1.windows.1 In-Reply-To: <20220108013242.2030-1-kuqin12@gmail.com> References: <20220108013242.2030-1-kuqin12@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3794 This change includes specification update markdown file that describes the proposed PI Specification v1.7 Errata A in detail and potential impact to the existing codebase. Cc: Andrew Fish Cc: Leif Lindholm Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Signed-off-by: Kun Qin --- Notes: v2: - Removed "RELEASE_ASSERT" definition - Removed reference to EDK2 based memory type info [Mike] CodeFirst/BZ3794-SpecChange.md | 55 ++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/CodeFirst/BZ3794-SpecChange.md b/CodeFirst/BZ3794-SpecChange.md new file mode 100644 index 000000000000..61a0be798d7f --- /dev/null +++ b/CodeFirst/BZ3794-SpecChange.md @@ -0,0 +1,55 @@ +# Title: Introduction of `EFI_SW_EC_FRAGMENTED_MEMORY_MAP` Status Code + +## Status: Draft + +## Document: UEFI Platform Initialization Specification Version 1.7 Errata A + +## License + +SPDX-License-Identifier: CC-BY-4.0 + +## Submitter: [TianoCore Community](https://www.tianocore.org) + +## Summary of the change + +Add `EFI_SW_EC_FRAGMENTED_MEMORY_MAP` into Status Codes definition. + +## Benefits of the change + +Current Status Codes covered various [software class error code definitions](https://github.com/tianocore/edk2/blob/master/MdePkg/Include/Pi/PiStatusCode.h). + +However, fragmented memory map from boot to boot would fail to meet certain OS ACPI requirements (i.e. S4 resume boot requires consistent memory maps) and trigger system reboots. Yet the corresponding case was not covered by the already defined status codes. + +The unexpected system reboots above could indicate decay of system health and reporting of such generic events would provide helpful information to OEMs to investigate/prevent system failures in general. + +The request of this change intends to expand definitions of `EFI_SW_EC_**` under Status Codes to cover more unexpected system reboot events, which could improve Status Code futility and readability. + +## Impact of the change + +Occupy a new macro definitions of Error Codes under Software class Status Codes. + +## Detailed description of the change [normative updates] + +### Specification Changes + +1. In PI Specification v1.7 Errata A: Vol. 3, Table 3-61: Error Code Operations: Host Software Class, add one new rows below `EFI_SW_EC_FV_CORRUPTED` definition: + + | Operation | Description | Extended Data | + | --- | --- | --- | + | EFI_SW_EC_FRAGMENTED_MEMORY_MAP | System will reboot due to fragmented memory maps | None | + +1. In PI Specification v1.7 Errata A: Vol. 3, Table 3-61: Error Code Operations: Host Software Class, replace the row of `0x0014-0x00FF` to: + + | Operation | Description | Extended Data | + | --- | --- | --- | + | 0x0015-0x00FF | Reserved for future use by this specification for Host Software class error codes. | None | + +1. In PI Specification v1.7 Errata A: Vol. 3, Section 6.7.4.3 Error Code Definitions: Prototype, add one new definitions below `EFI_SW_EC_FV_CORRUPTED` definition: + + ```c + #define EFI_SW_EC_FRAGMENTED_MEMORY_MAP 0x00000014 + ``` + +### Code Changes + +1. Add macro definitions in `MdePkg/Include/Pi/PiStatusCode.h` to match new specification. -- 2.34.1.windows.1