From: Quan Nguyen <quan@os.amperecomputing.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Lee Jones <lee.jones@linaro.org>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzk+dt@kernel.org>,
Jean Delvare <jdelvare@suse.com>,
Guenter Roeck <linux@roeck-us.net>,
Jonathan Corbet <corbet@lwn.net>,
Derek Kiernan <derek.kiernan@xilinx.com>,
Dragan Cvetic <dragan.cvetic@xilinx.com>,
Arnd Bergmann <arnd@arndb.de>,
Thu Nguyen <thu@os.amperecomputing.com>,
Gustavo Pimentel <Gustavo.Pimentel@synopsys.com>,
open list <linux-kernel@vger.kernel.org>,
"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS"
<devicetree@vger.kernel.org>,
"open list:HARDWARE MONITORING" <linux-hwmon@vger.kernel.org>,
"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
OpenBMC Maillist <openbmc@lists.ozlabs.org>,
Open Source Submission <patches@amperecomputing.com>,
Phong Vo <phong@os.amperecomputing.com>,
"Thang Q . Nguyen" <thang@os.amperecomputing.com>
Subject: Re: [PATCH v7 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces
Date: Mon, 21 Mar 2022 16:46:36 +0700 [thread overview]
Message-ID: <8f01a63d-0d10-81ee-7398-b69e496964f8@os.amperecomputing.com> (raw)
In-Reply-To: <Yjg2AkYOCTi2CXc1@kroah.com>
On 21/03/2022 15:23, Greg Kroah-Hartman wrote:
> On Mon, Mar 21, 2022 at 03:13:55PM +0700, Quan Nguyen wrote:
>> Add documentation for the Ampere(R)'s Altra(R) SMpro sysfs interfaces
>>
>> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
>> ---
>> Changes in v7:
>> + First introduce in v7 [Greg]
>>
>> .../sysfs-bus-platform-devices-ampere-smpro | 133 ++++++++++++++++++
>> 1 file changed, 133 insertions(+)
>> create mode 100644 Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
>>
>> diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
>> new file mode 100644
>> index 000000000000..9bfd8d6d0f71
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-bus-platform-devices-ampere-smpro
>> @@ -0,0 +1,133 @@
>> +What: /sys/bus/platform/devices/smpro-errmon.*/errors_[core|mem|pcie|other]_[ce|ue]
>
> Please split this out as one entry per file.
>
These sysfs share same format of HW errors (the 48-byte Arm vendor
specific HW error record) but for separate HW domains: Core, PCIe,
Mem... etc
>> +KernelVersion: 5.14
>
> 5.14 is a long time ago.
>
>> +Contact: quan@os.amperecomputing.com
>> +Description:
>> + (RO) Contains the 48-byte Ampere (Vendor-Specific) Error Record, see [1]
>> + printed in hex format as below:
>> +
>> + AA BB CCCC DDDDDDDD DDDDDDDDDDDDDDDD DDDDDDDDDDDDDDDD \
>> + DDDDDDDDDDDDDDDD DDDDDDDDDDDDDDDD DDDDDDDDDDDDDDDD
>> + Where:
>> + AA : Error Type
>> + BB : Subtype
>> + CCCC : Instance
>> + DDD...DDD: Similar to the Arm RAS standard error record
>
> No, this is not a valid sysfs file, sorry. This should just be one
> value per file.
>
This 48-byte value is unable to separate into smaller values because it
contain all information necessary to indicate a single HW error as per
ARM RAS supplement document [1]. The format is to make it read-able
other than a single 48-byte hex value.
[1] https://developer.arm.com/documentation/ddi0587/latest/
>
>> +
>> + See [1] below for the format details.
>> +
>> + The detail of each sysfs entries is as below:
>> + +-------------+---------------------------------------------------------+
>> + | Error | Sysfs entry |
>> + +-------------+---------------------------------------------------------+
>> + | Core's CE | /sys/bus/platform/devices/smpro-errmon.*/errors_core_ce |
>> + | Core's UE | /sys/bus/platform/devices/smpro-errmon.*/errors_core_ue |
>> + | Memory's CE | /sys/bus/platform/devices/smpro-errmon.*/errors_mem_ce |
>> + | Memory's UE | /sys/bus/platform/devices/smpro-errmon.*/errors_mem_ue |
>> + | PCIe's CE | /sys/bus/platform/devices/smpro-errmon.*/errors_pcie_ce |
>> + | PCIe's UE | /sys/bus/platform/devices/smpro-errmon.*/errors_pcie_ue |
>> + | Other's CE | /sys/bus/platform/devices/smpro-errmon.*/errors_other_ce|
>> + | Other's UE | /sys/bus/platform/devices/smpro-errmon.*/errors_other_ue|
>> + +-------------+---------------------------------------------------------+
>> + UE: Uncorrect-able Error
>> + CE: Correct-able Error
>> +
>> + [1] Section 3.3 Ampere (Vendor-Specific) Error Record Formats,
>> + Altra Family RAS Supplement.
>> +
>> +
>> +What: /sys/bus/platform/devices/smpro-errmon.*/errors_[smpro|pmpro]
>> +KernelVersion: 5.14
>> +Contact: quan@os.amperecomputing.com
>> +Description:
>> + (RO) Contains the internal firmware error record printed as hex format
>> + as below:
>> +
>> + A BB C DD EEEE FFFFFFFF
>
> Again this isn't a good sysfs entry. You should never have to parse a
> sysfs file except for a single value.
>
> thanks,
>
> greg k-h
This error is also unable to separate further as well.
Thanks Greg for the review.
- Quan
next prev parent reply other threads:[~2022-03-21 9:46 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-21 8:13 [PATCH v7 0/9] Add Ampere's Altra SMPro MFD and its child drivers Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 1/9] hwmon: smpro: Add Ampere's Altra smpro-hwmon driver Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 2/9] docs: hwmon: (smpro-hwmon) Add documentation Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 3/9] misc: smpro-errmon: Add Ampere's SMpro error monitor driver Quan Nguyen
2022-03-21 14:24 ` kernel test robot
2022-03-21 8:13 ` [PATCH v7 4/9] docs: misc-devices: (smpro-errmon) Add documentation Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 5/9] misc: smpro-misc: Add Ampere's Altra SMpro misc driver Quan Nguyen
2022-03-21 8:21 ` Greg Kroah-Hartman
2022-03-21 9:46 ` Quan Nguyen
2022-03-21 10:02 ` Greg Kroah-Hartman
2022-03-25 7:14 ` Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 6/9] docs: misc-devices: (smpro-misc) Add documentation Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 7/9] dt-bindings: mfd: Add bindings for Ampere Altra SMPro MFD driver Quan Nguyen
2022-03-21 10:08 ` Krzysztof Kozlowski
2022-03-25 7:13 ` Quan Nguyen
2022-03-21 8:13 ` [PATCH v7 8/9] mfd: smpro-mfd: Adds Ampere's Altra SMpro " Quan Nguyen
2022-03-21 17:38 ` kernel test robot
2022-03-21 8:13 ` [PATCH v7 9/9] docs: ABI: testing: Document the Ampere Altra Family's SMpro sysfs interfaces Quan Nguyen
2022-03-21 8:23 ` Greg Kroah-Hartman
2022-03-21 9:46 ` Quan Nguyen [this message]
2022-03-21 10:03 ` Greg Kroah-Hartman
2022-03-25 7:14 ` Quan Nguyen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8f01a63d-0d10-81ee-7398-b69e496964f8@os.amperecomputing.com \
--to=quan@os.amperecomputing.com \
--cc=Gustavo.Pimentel@synopsys.com \
--cc=arnd@arndb.de \
--cc=corbet@lwn.net \
--cc=derek.kiernan@xilinx.com \
--cc=devicetree@vger.kernel.org \
--cc=dragan.cvetic@xilinx.com \
--cc=gregkh@linuxfoundation.org \
--cc=jdelvare@suse.com \
--cc=krzk+dt@kernel.org \
--cc=lee.jones@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=openbmc@lists.ozlabs.org \
--cc=patches@amperecomputing.com \
--cc=phong@os.amperecomputing.com \
--cc=robh+dt@kernel.org \
--cc=thang@os.amperecomputing.com \
--cc=thu@os.amperecomputing.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).