Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
Message-ID: <ed4e33ea-9fbd-dfef-2747-6a60f4327a1d@os.amperecomputing.com>
Date:   Fri, 25 Mar 2022 14:14:37 +0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0)
 Gecko/20100101 Thunderbird/91.6.0
Subject: Re: [PATCH v7 9/9] docs: ABI: testing: Document the Ampere Altra
 Family's SMpro sysfs interfaces
Content-Language: en-US
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>
References: <20220321081355.6802-1-quan@os.amperecomputing.com>
 <20220321081355.6802-10-quan@os.amperecomputing.com>
 <Yjg2AkYOCTi2CXc1@kroah.com>
 <8f01a63d-0d10-81ee-7398-b69e496964f8@os.amperecomputing.com>
 <YjhNbUDFUXsNkL+/@kroah.com>
From:   Quan Nguyen <quan@os.amperecomputing.com>
In-Reply-To: <YjhNbUDFUXsNkL+/@kroah.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Z2dzNEkyWDhjenVzakxXLzNhbGdTMFJNZHFTQ2hPVXROT0VaTWZmd1FENUdt?=
 =?utf-8?B?OUpRZElVUi9FNWMyaFBsUmZZNkNQTHovS3RRWXVldVlVR2o4SXBMYWhmWWxF?=
 =?utf-8?B?ek1Gb1NTQTk0RGYrMVRlazFjSjNwbytKeWIrc3gzNU1ScWsreDJtQXFSbDJW?=
 =?utf-8?B?d3ZpUGgyQWJuZE1EVXZKZHBUR3lib2xCRFVHcVhlTU1FTEhBVGxFcWZYRTcv?=
 =?utf-8?B?Z2Y2Sk95TkJERmtvenNGMHBMOVNvd3BWR1ZGaHhzUEYxN1A4OUlXeE1ybVht?=
 =?utf-8?B?YmhrNi9PYndKaTNDc2YwS0tNSTVWa0F5QlZjWFJFMEorbWEzQTU3aDJXSTBt?=
 =?utf-8?B?SmJBVnRGbGFsVnpBRGFwTWZYdjNQbFllMWFhVXVtWVpVYWJwd3A2emErcEVK?=
 =?utf-8?B?aXpQMGpGUkxPdWRucWFRQlh2RWdhbFNBaG9kbEc0SlFsbGcyMzNXOGNKd2JM?=
 =?utf-8?B?Z1ZaNGpCUkZEbmJOLzkwMS9SZ1g1UmdES2hMWWtpUU5NOEp4cVd5Z1VMSW1s?=
 =?utf-8?B?dklPK2l0MlEyYW9xOGd6bzBKbVduMUlKZzUxZUpkZFNXb0lhS0FTd0ZYd3kz?=
 =?utf-8?B?akpMRHFyaTVkTDV4RUlWd3hadjBhY0lwZlB3WlZYUG9FMWZZbVYwNGNsdzdY?=
 =?utf-8?B?WVJXdXBwejAzZDEwY1lseDhaaUZFdU5NTE9zMm5sUWVTM0VIbEgvVmJoMUJn?=
 =?utf-8?B?ckZCU3Fkb0VSN09nYk5RNUV0WCtjQ00rVUxYck9qVDZjWHlWMi9IT3FrWHZP?=
 =?utf-8?B?b2tuck1zVS94T09ZRFRNOW9sSGJBY1U4bVVBZDRNa0c4cjZocGpuY3NnVWR1?=
 =?utf-8?B?YlZTSThuWUhZeVBNOU5HNWltN1BDckJDZ0IwcVBnZTh0MVVwUTJZd05hWm45?=
 =?utf-8?B?SzlJekx0b28rdTg5am1pQ0RJYlB2RlhMVC91dUJpbXhscm9vK2JMQllObm1z?=
 =?utf-8?B?VWZjV1BjQ1Z1Tmlzc0lEUGl0T08rTzZMOUtWU0NEM0tjQkZQcG9MWG1ycmFt?=
 =?utf-8?B?eWRnR0pYWmhJcWdXVUFVRWh6U2dxUmpOdnRaTi94cmYrZmlyTElBZi9Kak9G?=
 =?utf-8?B?YTZEdVdYQ0h0WUE1NVR2SVU4UlZ4OWxCRTJ6UWVnVmNkNzZLY0FDc2gzb3Bh?=
 =?utf-8?B?a0wxdlB4ZzB6dG1TTDlZYVJYRXY5OWhKYnp6cXFKNFRpWW5sY3pHWHJYMHd2?=
 =?utf-8?B?UDkyWjRjbzBrUUtKQ3V4STErTnN5RWdnUW9FTG9vT0VKblJXZlhIcWRSWWxk?=
 =?utf-8?B?aUE4TnoweTBodGdaVmxBTXY0a2VUMm56eld3RXB0MlhiSldFSVdsU1o4aGFR?=
 =?utf-8?B?ZVZRWHhWakgyamxTNE9HNEF3YTRHd2pJQi9oa1NNMnpzWnh0czgreFppMnds?=
 =?utf-8?B?SFNHUVo2ZFVGdFN2V2ZIU3lBRlNNVkMyakhmVVYweDg2YTBBLzQ2clY2cnNv?=
 =?utf-8?B?ZnJNdmlpRUZDVkFjLzh4VW5ZZFhGbzlPMHB1T2FNcDJzbW4xNEJranFxYXB4?=
 =?utf-8?B?anQvVVhOemlsWEhXbnlNVTlQU1Bhc1kwSENleTA1ZnBCS1p2Q29OZ3BJVHov?=
 =?utf-8?B?SWFISGU4dnQvSVVEQnAwTHNFdjlFejN0MDdmSldHS0hYV1VzbkhhdSt0aDRv?=
 =?utf-8?B?aFUra01yTm1URVlSYSt6S0VFSjJlNStHeW05cEcrZ081c25mTW96MFhCdGpG?=
 =?utf-8?B?UThMblAxeEFCVDVWeFdjbUdzSS9EWW1rUDQ4MEh6SjJDaHl0NHFvYWNUc2lQ?=
 =?utf-8?B?RmowK09UbmV5YlRiTk1mZUhwRG5CUm0vUUo1SjVyck5GZGkwYlZYVWZmcGFs?=
 =?utf-8?B?MkZRTjdmYWs4d1FTdTl4WU1JUTFyOWU0QUlEMkEyZXlFbENHblBFK05pekIx?=
 =?utf-8?B?eXFKcFBnT0VqallDTHV5ZHB2QWZHNXpuaFFQMnRJSlFhazZzeTNaaWpYYWgy?=
 =?utf-8?B?enFQZVNYdGNQd2gvc0JwN3Y4dGduR2g0WkI4ckE5TnRGTGVzL3k3NVl5Y2Rk?=
 =?utf-8?Q?VQ7oxZZqJOYWqpff0QS5Z55ZLF/Eyk=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 562e3a41-5384-416c-0103-08da0e2f26a1
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Mar 2022 07:14:50.4577
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: Tmo+Se+cJ5FNBqgTYoliKOn8CRQBCQAIOy6XqalJ0sflEIFTzJNaI43eKSxuC64+Zpx5Ibx8vzqMEYCsmx8xW5N2Bn2K2kcmQn56dPBrW38=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW2PR0102MB3465
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,RDNS_NONE,SPF_HELO_NONE,
	T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
	lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 21/03/2022 17:03, Greg Kroah-Hartman wrote:
> On Mon, Mar 21, 2022 at 04:46:36PM +0700, Quan Nguyen wrote:
>>
>>
>> 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/
> 
> Just export the 48 byte hex value and make userspace split it up if it
> wants to do so.  Don't do things in the kernel that can be done in
> userspace.
> 

Thanks Greg for the suggestion,
Will do this in my next version.

Thanks,
- Quan