From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by mx.groups.io with SMTP id smtpd.web11.763.1641517399300503964 for ; Thu, 06 Jan 2022 17:03:19 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=LsEAl/+8; spf=pass (domain: gmail.com, ip: 209.85.214.172, mailfrom: kuqin12@gmail.com) Received: by mail-pl1-f172.google.com with SMTP id c3so3694536pls.5 for ; Thu, 06 Jan 2022 17:03:19 -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=9H4425tTxxU2A7DMF0TsCSuaWzPq1niJTiTQfvmplCw=; b=LsEAl/+8dKmc2nVDcfZgVEXq7yhomjGx+TvwLXxU8SDyHKz8ZGJHCkwI74E1Bk/4oq 5mdDGXlTT20JUyrjgG5wKJrCOgVdbhpfNXLjMoKU7RQLjh7FtgGoOZDeqcmhoQXeH16l XnIudl8nRza5NCATjJQDfp4wQwCO+BPSy8CK5XN8CUpqApdnMU/hassf8qXhLTVw1D+6 8xsNlhfKVcev5cKUJhPTNYSiVP5zXFmo9ytUye+BmKTX4A0hJnh8y4xTph/sioyTfnpj VQh9G51yqrEiYb8B7JWebZj9uD4PYDZttbRpi5St4BzLfosnjjodCz1aAIIzMnUkO4F+ q+XA== 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=9H4425tTxxU2A7DMF0TsCSuaWzPq1niJTiTQfvmplCw=; b=OLoPtVzLLnkFY4av+wviiYgZQjn7wSIM15MMuKVrWWEu1pWdsIdyDSgyNJg7UyOEJS 5BLG1zeweT5riPk1ha0yn9NrP+ysi3HdPTSmIrtZQHt1VzWGE/4YWRfmyJyZ6H3G15rr 67aXjyXSBlyrsaZ21nNR/JscUH8L/gfRr6YMK+rWTpmU6QVxKtwZYaYFFfyad/qIEja+ DQYgBrELVailbAeBwP7Ee73pQETvr0q5kZm1nQu0PT0RIHwbxFAU+VJ01FdFSsrM098P BPcIRVoOnJdivz15NpK8T1z3uWoCz4UepNZkhrgF2nAkkBlf877LmePNkb1nwLdtyk1J dQbw== X-Gm-Message-State: AOAM531MbXmK00y1iYykVurzC7Z+KvcqsSGP/DyvRJ+bngJIGRPoDaCy HGFyl6pHUf54f4lPKke0WKuMyzW2zXo= X-Google-Smtp-Source: ABdhPJwOHcoyiTGty1WrpZpGIAiYGu0oxTm7Qo5z9LUMeBWqUPzHYrQniS8qppBypeeZgn2E1l9R4g== X-Received: by 2002:a17:902:f68f:b0:14a:76c:c55a with SMTP id l15-20020a170902f68f00b0014a076cc55amr402202plg.106.1641517398692; Thu, 06 Jan 2022 17:03:18 -0800 (PST) Return-Path: Received: from localhost.localdomain ([50.35.74.198]) by smtp.gmail.com with ESMTPSA id n14sm2907385pgd.80.2022.01.06.17.03.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Jan 2022 17:03:18 -0800 (PST) From: "Kun Qin" To: devel@edk2.groups.io Cc: Andrew Fish , Leif Lindholm , Michael D Kinney , Liming Gao , Zhiguang Liu Subject: [PATCH v1 1/2] EDK2 Code First: PI Specification: New error codes of Host Software class Date: Thu, 6 Jan 2022 17:03:05 -0800 Message-Id: <20220107010306.1253-2-kuqin12@gmail.com> X-Mailer: git-send-email 2.34.1.windows.1 In-Reply-To: <20220107010306.1253-1-kuqin12@gmail.com> References: <20220107010306.1253-1-kuqin12@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 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 --- CodeFirst/BZ3794-SpecChange.md | 60 ++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/CodeFirst/BZ3794-SpecChange.md b/CodeFirst/BZ3794-SpecChange.md new file mode 100644 index 000000000000..bbb526896795 --- /dev/null +++ b/CodeFirst/BZ3794-SpecChange.md @@ -0,0 +1,60 @@ +# Title: Introduction of `EFI_MM_COMMUNICATE_HEADER_V3` and `MM_COMMUNICATE3_*` interface + +## 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 + +Introduce `EFI_SW_EC_MEMORY_TYPE_INFORMATION_CHANGE` and `EFI_SW_EC_RELEASE_ASSERT` 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, there are a few critical instances where the software could trigger system reboots while the corresponding case was not covered by the already defined status codes: + +1. Memory type information change triggered system reboot; +2. Assert triggered reboot on systems that did not enable system halts; + +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 2 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 2 new rows below `EFI_SW_EC_FV_CORRUPTED` definition: + + | Operation | Description | Extended Data | + | --- | --- | --- | + | EFI_SW_EC_MEMORY_TYPE_INFORMATION_CHANGE | System will reboot due to memory type information changes | None | + | EFI_SW_EC_RELEASE_ASSERT | System software asserted | 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 | + | --- | --- | --- | + | 0x0016–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 2 new definitions below `EFI_SW_EC_FV_CORRUPTED` definition: + + ```c + #define EFI_SW_EC_MEMORY_TYPE_INFORMATION_CHANGE 0x00000014 + #define EFI_SW_EC_RELEASE_ASSERT 0x00000015 + ``` + +### Code Changes + +1. Add macro definitions in `MdePkg/Include/Pi/PiStatusCode.h` to match new specification. -- 2.34.1.windows.1