From patchwork Mon Nov 4 12:14:54 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Xiang Zheng X-Patchwork-Id: 11225715 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 6D1AA1390 for ; Mon, 4 Nov 2019 12:21:04 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 4D8B72053B for ; Mon, 4 Nov 2019 12:21:04 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4D8B72053B Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=huawei.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Received: from localhost ([::1]:60124 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iRbLz-0004CY-Bv for patchwork-qemu-devel@patchwork.kernel.org; Mon, 04 Nov 2019 07:21:03 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:40272) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iRbHs-00078V-8m for qemu-devel@nongnu.org; Mon, 04 Nov 2019 07:16:49 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iRbHp-000503-QT for qemu-devel@nongnu.org; Mon, 04 Nov 2019 07:16:47 -0500 Received: from szxga04-in.huawei.com ([45.249.212.190]:2187 helo=huawei.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iRbHi-0004qx-H3; Mon, 04 Nov 2019 07:16:39 -0500 Received: from DGGEMS403-HUB.china.huawei.com (unknown [172.30.72.59]) by Forcepoint Email with ESMTP id A0FF2817C3B0AA90D2E1; Mon, 4 Nov 2019 20:16:30 +0800 (CST) Received: from HGHY4Z004218071.china.huawei.com (10.133.224.57) by DGGEMS403-HUB.china.huawei.com (10.3.19.203) with Microsoft SMTP Server id 14.3.439.0; Mon, 4 Nov 2019 20:16:22 +0800 From: Xiang Zheng To: , , , , , , , , , , , , , , , , Subject: [PATCH v21 2/6] docs: APEI GHES generation and CPER record description Date: Mon, 4 Nov 2019 20:14:54 +0800 Message-ID: <20191104121458.29208-3-zhengxiang9@huawei.com> X-Mailer: git-send-email 2.15.1.windows.2 In-Reply-To: <20191104121458.29208-1-zhengxiang9@huawei.com> References: <20191104121458.29208-1-zhengxiang9@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.133.224.57] X-CFilter-Loop: Reflected X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 45.249.212.190 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: wanghaibin.wang@huawei.com, zhengxiang9@huawei.com Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" From: Dongjiu Geng Add APEI/GHES detailed design document Signed-off-by: Dongjiu Geng Signed-off-by: Xiang Zheng --- docs/specs/acpi_hest_ghes.rst | 95 +++++++++++++++++++++++++++++++++++ docs/specs/index.rst | 1 + 2 files changed, 96 insertions(+) create mode 100644 docs/specs/acpi_hest_ghes.rst diff --git a/docs/specs/acpi_hest_ghes.rst b/docs/specs/acpi_hest_ghes.rst new file mode 100644 index 0000000000..348825f9d3 --- /dev/null +++ b/docs/specs/acpi_hest_ghes.rst @@ -0,0 +1,95 @@ +APEI tables generating and CPER record +====================================== + +.. + Copyright (c) 2019 HUAWEI TECHNOLOGIES CO., LTD. + + This work is licensed under the terms of the GNU GPL, version 2 or later. + See the COPYING file in the top-level directory. + +Design Details +-------------- + +:: + + etc/acpi/tables etc/hardware_errors + ==================== ========================================== + + +--------------------------+ +-----------------------+ + | | HEST | | address | +--------------+ + | +--------------------------+ | registers | | Error Status | + | | GHES1 | | +---------------------+ | Data Block 1 | + | +--------------------------+ +--------->| |error_block_address1 |----------->| +------------+ + | | ................. | | | +---------------------+ | | CPER | + | | error_status_address-----+-+ +------->| |error_block_address2 |--------+ | | CPER | + | | ................. | | | +---------------------+ | | | .... | + | | read_ack_register--------+-+ | | | .............. | | | | CPER | + | | read_ack_preserve | | | +-----------------------+ | | +------------+ + | | read_ack_write | | | +----->| |error_block_addressN |------+ | | Error Status | + + +--------------------------+ | | | | +---------------------+ | | | Data Block 2 | + | | GHES2 | +-+-+----->| |read_ack_register1 | | +-->| +------------+ + + +--------------------------+ | | | +---------------------+ | | | CPER | + | | ................. | | | +--->| |read_ack_register2 | | | | CPER | + | | error_status_address-----+---+ | | | +---------------------+ | | | .... | + | | ................. | | | | | ............. | | | | CPER | + | | read_ack_register--------+-----+-+ | +---------------------+ | +-+------------+ + | | read_ack_preserve | | +->| |read_ack_registerN | | | |.......... | + | | read_ack_write | | | | +---------------------+ | | +------------+ + + +--------------------------| | | | | Error Status | + | | ............... | | | | | Data Block N | + + +--------------------------+ | | +---->| +------------+ + | | GHESN | | | | | CPER | + + +--------------------------+ | | | | CPER | + | | ................. | | | | | .... | + | | error_status_address-----+-----+ | | | CPER | + | | ................. | | +-+------------+ + | | read_ack_register--------+---------+ + | | read_ack_preserve | + | | read_ack_write | + + +--------------------------+ + +(1) QEMU generates the ACPI HEST table. This table goes in the current + "etc/acpi/tables" fw_cfg blob. Each error source has different + notification types. + +(2) A new fw_cfg blob called "etc/hardware_errors" is introduced. QEMU + also needs to populate this blob. The "etc/hardware_errors" fw_cfg blob + contains an address registers table and an Error Status Data Block table. + +(3) The address registers table contains N Error Block Address entries + and N Read Ack Register entries. The size for each entry is 8-byte. + The Error Status Data Block table contains N Error Status Data Block + entries. The size for each entry is 4096(0x1000) bytes. The total size + for the "etc/hardware_errors" fw_cfg blob is (N * 8 * 2 + N * 4096) bytes. + N is the number of the kinds of hardware error sources. + +(4) QEMU generates the ACPI linker/loader script for the firmware. The + firmware pre-allocates memory for "etc/acpi/tables", "etc/hardware_errors" + and copies blob contents there. + +(5) QEMU generates N ADD_POINTER commands, which patch addresses in the + "error_status_address" fields of the HEST table with a pointer to the + corresponding "address registers" in the "etc/hardware_errors" blob. + +(6) QEMU generates N ADD_POINTER commands, which patch addresses in the + "read_ack_register" fields of the HEST table with a pointer to the + corresponding "address registers" in the "etc/hardware_errors" blob. + +(7) QEMU generates N ADD_POINTER commands for the firmware, which patch + addresses in the "error_block_address" fields with a pointer to the + respective "Error Status Data Block" in the "etc/hardware_errors" blob. + +(8) QEMU defines a third and write-only fw_cfg blob which is called + "etc/hardware_errors_addr". Through that blob, the firmware can send back + the guest-side allocation addresses to QEMU. The "etc/hardware_errors_addr" + blob contains a 8-byte entry. QEMU generates a single WRITE_POINTER command + for the firmware. The firmware will write back the start address of + "etc/hardware_errors" blob to the fw_cfg file "etc/hardware_errors_addr". + +(9) When QEMU gets a SIGBUS from the kernel, QEMU formats the CPER right into + guest memory, and then injects platform specific interrupt (in case of + arm/virt machine it's Synchronous External Abort) as a notification which + is necessary for notifying the guest. + +(10) This notification (in virtual hardware) will be handled by the guest + kernel, guest APEI driver will read the CPER which is recorded by QEMU and + do the recovery. diff --git a/docs/specs/index.rst b/docs/specs/index.rst index 984ba44029..3019b9c976 100644 --- a/docs/specs/index.rst +++ b/docs/specs/index.rst @@ -13,3 +13,4 @@ Contents: ppc-xive ppc-spapr-xive acpi_hw_reduced_hotplug + acpi_hest_ghes