From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com [209.85.214.179]) by mx.groups.io with SMTP id smtpd.web08.2278.1643914996830185950 for ; Thu, 03 Feb 2022 11:03:16 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=piv/0qrL; spf=pass (domain: gmail.com, ip: 209.85.214.179, mailfrom: kuqin12@gmail.com) Received: by mail-pl1-f179.google.com with SMTP id t9so761529plg.13 for ; Thu, 03 Feb 2022 11:03:16 -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=9tDSTktnI3htCeVuswwqj9oHy/UoqR2DTNSOzWS83+k=; b=piv/0qrLV4vad9WHTXL1g6Zx+xkbGbCWk/pY9NX53nFK7WqGUcEIanW/4tWzofBR/2 GpZHdjawCpVEnyWWxRaHpFwrL1Fp7jKViUgH0sWMWk0a1/ED/Ys0kOgT/OkLpBstRZB4 OR+K2fRN0hCLw5fuwt8m2bL7SxmDCNNfEd7+YQ1eY3AT2m0YdHIlLy0g7m7DwVJz6lLJ KgmBMlYFcUHcXgK8rzJ+ASl0/z46UFyeHNNSiyidoGrY7FXMwDiAMYh9LmyzLpuzj7gs 9A0IpY1q2ie+EqogOoaqb9IkRtqziNMiBMbuxUq5J1B7kLAUakisqSGdOe9A7PwHndOC sXbA== 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=9tDSTktnI3htCeVuswwqj9oHy/UoqR2DTNSOzWS83+k=; b=aQLdAalvCbn4kLDKlrQRrzjvj4sH/XchpmusyZ1hKNM+0QmJHn2QPYMqQDiWWEZjxl OVH2EApu+hVb1PhYiOxv8hNzOggQL4KpkFQmozRLwW8kGpXIeTnNgYybiO12dCtxomgV Vlse/PFWUkGYp+OA5FPtIts7GfP4SuW/JyEDpjR9d9m4H1hjUE154vGaG6Yv93iB3WLm DShi554vTjoXDWTLHsyp7ytmMjzXvpLMrfTI7GvLpnFyYYsqrhMaUipbSog3Btv2pXu/ 6wxYhCpCI34Fr0KC3wSt06F/9sfbpkOFwJ4mLTRNMDnIaruBrYqTd/6TwMiKMMvYvzav b+Vw== X-Gm-Message-State: AOAM531P47NkZw/Hn5FBr0yUjuIEyVpmYXSz+iDF/iCvQ+B7O0+7q354 5BmWKmt+YIDAxKobW0J2wrKbSM1f6Vc= X-Google-Smtp-Source: ABdhPJxxnm6Mdtr5E1tHSsP/hDijWGYQn4l9xXKEDXqu/x/F0HBYNvUgdWmP4kTPXMDsm4F82AUjaA== X-Received: by 2002:a17:902:a9c5:: with SMTP id b5mr36951037plr.167.1643914996080; Thu, 03 Feb 2022 11:03:16 -0800 (PST) Return-Path: Received: from localhost.localdomain ([50.35.74.198]) by smtp.gmail.com with ESMTPSA id w8sm24175450pfu.128.2022.02.03.11.03.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 03 Feb 2022 11:03:15 -0800 (PST) From: "Kun Qin" To: devel@edk2.groups.io Cc: Andrew Fish , Leif Lindholm , Michael D Kinney , Liming Gao , Zhiguang Liu Subject: [PATCH v3 1/2] EDK2 Code First: PI Specification: New error codes of Host Software class Date: Thu, 3 Feb 2022 11:03:02 -0800 Message-Id: <20220203190303.2008-2-kuqin12@gmail.com> X-Mailer: git-send-email 2.34.1.windows.1 In-Reply-To: <20220203190303.2008-1-kuqin12@gmail.com> References: <20220203190303.2008-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] v3: - No review, no change 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