Received: by 2002:a25:4158:0:0:0:0:0 with SMTP id o85csp871822yba; Wed, 24 Apr 2019 10:58:31 -0700 (PDT) X-Google-Smtp-Source: APXvYqxexnAOW/5sTv43Mgi1urhLPh3NEKAW7nwhBSMjhHhIRsb6gkbVw3YXz6356hou3rBwfPSI X-Received: by 2002:a63:20f:: with SMTP id 15mr30926994pgc.90.1556128710855; Wed, 24 Apr 2019 10:58:30 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1556128710; cv=none; d=google.com; s=arc-20160816; b=YWQcxVNKR86H73/BWpjze7eJcI+CaIFW+3lnd/IdT04nD7zAimJj7b6Urnr0VyKBAC 3NCFaf4C/9PgGwNisFmsVQACmo45+x4tGkkL358CJN0WxdhFEXPyUP6fRQf56QUN1wPl 7JtG16FPgtPvgPQVcC6YRCI180XKR3rfNEGR62sjilV1LT792wmsPtNGJAJqN5oXY4Nz zeWUbuq5o1VkkATQub2d24LPU0qiVGfRrj6aMtbP250rMNjIDBD3QPHRP5SZkTFE1I2D JKFrYafE9IWF+LTryDIe3/SY49eXPm98xCC7SeddlpCoJYZPMuc05HyPtEdLhuscpm2g AETw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=5a/6MPsR4urKp6yQEMyiUcAMrF2FenVOvePurxnpdZ8=; b=Ad5mxM+Y7px3V/l6IVGqbLRaSpL7fs3Kq6i+RIy7IaGs/tHMxVF00YX8/vqsnGObwd p8FBH52V+OkCqNhTtDa98J7ZCHcCemcEbe6pwtqwR8v4GYf0wir2y4sAof04zU/ztcTw mOy3dv9K6FZcErDxqFHCNrKooIyV5fDNDayqSC81etgpWPE06YyJAfUp5gAQrtQLGC2P 94q6pOQ8t7lJlG/6B63hC/dihFfu1WcjtEQtlF2IAI7pHtMsI9nszjDM8uocLx1ADDqF BXFQJYXBb1SbSaJK2cvUJOqO8+iIHI+xBbne3qRCvFkjD1T3nJ8sT1xFO0Ij7mDcVBM/ ka5g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=fHsSa2Hb; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id a2si647621plm.162.2019.04.24.10.58.15; Wed, 24 Apr 2019 10:58:30 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=fHsSa2Hb; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2392357AbfDXR4X (ORCPT + 99 others); Wed, 24 Apr 2019 13:56:23 -0400 Received: from mail-pg1-f196.google.com ([209.85.215.196]:33346 "EHLO mail-pg1-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2390316AbfDXR4T (ORCPT ); Wed, 24 Apr 2019 13:56:19 -0400 Received: by mail-pg1-f196.google.com with SMTP id k19so9752560pgh.0; Wed, 24 Apr 2019 10:56:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=5a/6MPsR4urKp6yQEMyiUcAMrF2FenVOvePurxnpdZ8=; b=fHsSa2HbsgDt5R9Pt5buJ5laHzRdvCq1gBdvWrnaRN9guUkb/VBFzGPAy82XhrTbbP CRmBZpA8k3nxUu6yfWZoxHJxKKbzURhcprsAgwyMn/17aDxbcGb5JiuWkbTAcX7lnMz3 Y5Sq0FpBGeGPDMz/saeUJMJYbUHTC0Rkt76YRv4P6+ofK7TD7VKX096iRAKrcVSeNvFc FOr13R8IX5f52dsHpKtbm+TeVgpKXm+7FZDwdx/9TxUsV3h6bZMXXnMnB128bqPws3QN PlitJslpDQKTHaIUgk3tOle2GsxtJw+EZypA3LwzgrI9BYAEU3sgieYkA+TJOaW9yfrs 8ERw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=5a/6MPsR4urKp6yQEMyiUcAMrF2FenVOvePurxnpdZ8=; b=FKtNqDcY5n3v8Mv/xrFNuWApF8et5Qmtw0GSKOVfUyWZjqvXSS61nwMgWnosb8vmCx fLaVc4VTEn/wmmxIjH7T1RdULd6zk1/uyUBs8K8p0koPJDCQVgCi4O3Rhi+Es3WViS8O deseWHyt/veQ1b/r0/Z6kITtR4MH64x1bnEyMKgbDMXrenLZ6vSVgvqphdx8zuPTIDp1 98PS1AKm+ZadBGU5m3+pntkxJgMQMnZH1ze48+HwEe3xV+BzKm+tULHPNUlipup25qx1 rlTw1ufPw8U4gIryf/wEmDqpW09fZXHxQN4TjhsvB/Vnf5n3YuIVgvz5vdY5WWcwgxTm PULw== X-Gm-Message-State: APjAAAXk1SptslsGZI1z7F0LEJoLauyL4SLmvIIfu9V7wRxUvZPtmrzA G+f7DOi84CjBO+kzP1JeV0BoCv6d X-Received: by 2002:a62:ac02:: with SMTP id v2mr16189198pfe.163.1556128577869; Wed, 24 Apr 2019 10:56:17 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id 6sm29275630pfp.143.2019.04.24.10.56.11 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Apr 2019 10:56:17 -0700 (PDT) From: Changbin Du To: rjw@rjwysocki.net, Jonathan Corbet Cc: Bjorn Helgaas , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org, linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org, mchehab+samsung@kernel.org, Changbin Du Subject: [PATCH v5 18/23] Documentation: ACPI: move apei/output_format.txt to firmware-guide/acpi and convert to reST Date: Thu, 25 Apr 2019 01:53:01 +0800 Message-Id: <20190424175306.25880-19-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190424175306.25880-1-changbin.du@gmail.com> References: <20190424175306.25880-1-changbin.du@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du Reviewed-by: Mauro Carvalho Chehab --- Documentation/acpi/apei/output_format.txt | 147 ----------------- .../acpi/apei/output_format.rst | 150 ++++++++++++++++++ Documentation/firmware-guide/acpi/index.rst | 1 + 3 files changed, 151 insertions(+), 147 deletions(-) delete mode 100644 Documentation/acpi/apei/output_format.txt create mode 100644 Documentation/firmware-guide/acpi/apei/output_format.rst diff --git a/Documentation/acpi/apei/output_format.txt b/Documentation/acpi/apei/output_format.txt deleted file mode 100644 index 0c49c197c47a..000000000000 --- a/Documentation/acpi/apei/output_format.txt +++ /dev/null @@ -1,147 +0,0 @@ - APEI output format - ~~~~~~~~~~~~~~~~~~ - -APEI uses printk as hardware error reporting interface, the output -format is as follow. - - := -APEI generic hardware error status -severity: , -section: , severity: , -flags: -
-fru_id: -fru_text: -section_type:
-
- -* := recoverable | fatal | corrected | info - -
# := -[primary][, containment warning][, reset][, threshold exceeded]\ -[, resource not accessible][, latent error] - -
:= generic processor error | memory error | \ -PCIe error | unknown, - -
:= - | | \ - | - - := -[processor_type: , ] -[processor_isa: , ] -[error_type: -] -[operation: , ] -[flags: -] -[level: ] -[version_info: ] -[processor_id: ] -[target_address: ] -[requestor_id: ] -[responder_id: ] -[IP: ] - -* := IA32/X64 | IA64 - -* := IA32 | IA64 | X64 - -# := -[cache error][, TLB error][, bus error][, micro-architectural error] - -* := unknown or generic | data read | data write | \ -instruction execution - -# := -[restartable][, precise IP][, overflow][, corrected] - - := -[error_status: ] -[physical_address: ] -[physical_address_mask: ] -[node: ] -[card: ] -[module: ] -[bank: ] -[device: ] -[row: ] -[column: ] -[bit_position: ] -[requestor_id: ] -[responder_id: ] -[target_id: ] -[error_type: , ] - -* := -unknown | no error | single-bit ECC | multi-bit ECC | \ -single-symbol chipkill ECC | multi-symbol chipkill ECC | master abort | \ -target abort | parity error | watchdog timeout | invalid address | \ -mirror Broken | memory sparing | scrub corrected error | \ -scrub uncorrected error - - := -[port_type: , ] -[version: .] -[command: , status: ] -[device_id: ::. -slot: -secondary_bus: -vendor_id: , device_id: -class_code: ] -[serial number: , ] -[bridge: secondary_status: , control: ] -[aer_status: , aer_mask: - -[aer_uncor_severity: ] -aer_layer=, aer_agent= -aer_tlp_header: ] - -* := PCIe end point | legacy PCI end point | \ -unknown | unknown | root port | upstream switch port | \ -downstream switch port | PCIe to PCI/PCI-X bridge | \ -PCI/PCI-X to PCIe bridge | root complex integrated endpoint device | \ -root complex event collector - -if section severity is fatal or recoverable -# := -unknown | unknown | unknown | unknown | Data Link Protocol | \ -unknown | unknown | unknown | unknown | unknown | unknown | unknown | \ -Poisoned TLP | Flow Control Protocol | Completion Timeout | \ -Completer Abort | Unexpected Completion | Receiver Overflow | \ -Malformed TLP | ECRC | Unsupported Request -else -# := -Receiver Error | unknown | unknown | unknown | unknown | unknown | \ -Bad TLP | Bad DLLP | RELAY_NUM Rollover | unknown | unknown | unknown | \ -Replay Timer Timeout | Advisory Non-Fatal -fi - - := -Physical Layer | Data Link Layer | Transaction Layer - - := -Receiver ID | Requester ID | Completer ID | Transmitter ID - -Where, [] designate corresponding content is optional - -All description with * has the following format: - -field: , - -Where value of should be the position of "string" in description. Otherwise, will be "unknown". - -All description with # has the following format: - -field: - - -Where each string in corresponding to one set bit of -. The bit position is the position of "string" in description. - -For more detailed explanation of every field, please refer to UEFI -specification version 2.3 or later, section Appendix N: Common -Platform Error Record. diff --git a/Documentation/firmware-guide/acpi/apei/output_format.rst b/Documentation/firmware-guide/acpi/apei/output_format.rst new file mode 100644 index 000000000000..c2e7ebddb529 --- /dev/null +++ b/Documentation/firmware-guide/acpi/apei/output_format.rst @@ -0,0 +1,150 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================== +APEI output format +================== + +APEI uses printk as hardware error reporting interface, the output +format is as follow:: + + := + APEI generic hardware error status + severity: , + section: , severity: , + flags: +
+ fru_id: + fru_text: + section_type:
+
+ + * := recoverable | fatal | corrected | info + +
# := + [primary][, containment warning][, reset][, threshold exceeded]\ + [, resource not accessible][, latent error] + +
:= generic processor error | memory error | \ + PCIe error | unknown, + +
:= + | | \ + | + + := + [processor_type: , ] + [processor_isa: , ] + [error_type: + ] + [operation: , ] + [flags: + ] + [level: ] + [version_info: ] + [processor_id: ] + [target_address: ] + [requestor_id: ] + [responder_id: ] + [IP: ] + + * := IA32/X64 | IA64 + + * := IA32 | IA64 | X64 + + # := + [cache error][, TLB error][, bus error][, micro-architectural error] + + * := unknown or generic | data read | data write | \ + instruction execution + + # := + [restartable][, precise IP][, overflow][, corrected] + + := + [error_status: ] + [physical_address: ] + [physical_address_mask: ] + [node: ] + [card: ] + [module: ] + [bank: ] + [device: ] + [row: ] + [column: ] + [bit_position: ] + [requestor_id: ] + [responder_id: ] + [target_id: ] + [error_type: , ] + + * := + unknown | no error | single-bit ECC | multi-bit ECC | \ + single-symbol chipkill ECC | multi-symbol chipkill ECC | master abort | \ + target abort | parity error | watchdog timeout | invalid address | \ + mirror Broken | memory sparing | scrub corrected error | \ + scrub uncorrected error + + := + [port_type: , ] + [version: .] + [command: , status: ] + [device_id: ::. + slot: + secondary_bus: + vendor_id: , device_id: + class_code: ] + [serial number: , ] + [bridge: secondary_status: , control: ] + [aer_status: , aer_mask: + + [aer_uncor_severity: ] + aer_layer=, aer_agent= + aer_tlp_header: ] + + * := PCIe end point | legacy PCI end point | \ + unknown | unknown | root port | upstream switch port | \ + downstream switch port | PCIe to PCI/PCI-X bridge | \ + PCI/PCI-X to PCIe bridge | root complex integrated endpoint device | \ + root complex event collector + + if section severity is fatal or recoverable + # := + unknown | unknown | unknown | unknown | Data Link Protocol | \ + unknown | unknown | unknown | unknown | unknown | unknown | unknown | \ + Poisoned TLP | Flow Control Protocol | Completion Timeout | \ + Completer Abort | Unexpected Completion | Receiver Overflow | \ + Malformed TLP | ECRC | Unsupported Request + else + # := + Receiver Error | unknown | unknown | unknown | unknown | unknown | \ + Bad TLP | Bad DLLP | RELAY_NUM Rollover | unknown | unknown | unknown | \ + Replay Timer Timeout | Advisory Non-Fatal + fi + + := + Physical Layer | Data Link Layer | Transaction Layer + + := + Receiver ID | Requester ID | Completer ID | Transmitter ID + +Where, [] designate corresponding content is optional + +All description with * has the following format:: + + field: , + +Where value of should be the position of "string" in description. Otherwise, will be "unknown". + +All description with # has the following format:: + + field: + + +Where each string in corresponding to one set bit of +. The bit position is the position of "string" in description. + +For more detailed explanation of every field, please refer to UEFI +specification version 2.3 or later, section Appendix N: Common +Platform Error Record. diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index e9f253d54897..869badba6d7a 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst @@ -17,6 +17,7 @@ ACPI Support DSD-properties-rules debug aml-debugger + apei/output_format gpio-properties i2c-muxes acpi-lid -- 2.20.1