Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <e0278166-0762-2f33-9d86-d268638358b7@os.amperecomputing.com>
Date:   Thu, 6 Oct 2022 14:45:38 +0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0)
 Gecko/20100101 Thunderbird/102.3.0
Subject: Re: [PATCH v9 6/9] docs: misc-devices: (smpro-misc) Add documentation
Content-Language: en-CA
To:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc:     macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
        Bagas Sanjaya <bagasdotme@gmail.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.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>,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
        OpenBMC Maillist <openbmc@lists.ozlabs.org>,
        Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        thang@os.amperecomputing.com
References: <20220929094321.770125-1-quan@os.amperecomputing.com>
 <20220929094321.770125-7-quan@os.amperecomputing.com>
 <YzVrwo5oUTx/0cxl@kroah.com>
From:   Quan Nguyen <quan@os.amperecomputing.com>
In-Reply-To: <YzVrwo5oUTx/0cxl@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?ZmRMYzBiMTVqMHdHYzQ1UkhHS2ZKYUlNT2FTUm5JclZzRWxyLzArcWN2UUc4?=
 =?utf-8?B?ZVZWVW9DV2Z1cU8rK2lscll1MzRGZHdpcEFXUE1ZMCtvbk92VkZXVkZnM1Uy?=
 =?utf-8?B?eFliczFLdGhGSk5PZmJNVWdLeXhPVGxQREd0K1RvR2ZoVEVqa29uSkh1dUdH?=
 =?utf-8?B?Y1o0dGZlOTFkRzgzVGMwTW0xOWRYaDM0aVBWK1NVNzNyQlpaV1FvQVV1YlRN?=
 =?utf-8?B?K0JSbloycjdPa1l5dzFHUGYxR2RNMHYwVU8wNGlIQjQ2RU9BSzNxeDQ5QVlS?=
 =?utf-8?B?SXdMRHl1NkhPTUtQM29CaXM1cXI5VFg1QnZlQ3pUWnFBRVJuVWFGczRDSTIv?=
 =?utf-8?B?cWVVbE1aOFlKMGd1MDFOYUJ5QUdmU3hqNmVkcllFZkl4R0lEYy8wNVAwaVg0?=
 =?utf-8?B?dVY0VXJ4akV3WGNzU1hmQjlFYUIrYzFJVEZmaWV2OWlnS1A0RFlHbFd0TytE?=
 =?utf-8?B?cms1ckdKM0hjazRrci9iN2RQQ1VDSDUrK1VXK1VocG1EWStVbCtKeHZrdWFW?=
 =?utf-8?B?bU9yejdJQmJOckFsYUN6VXNGamhMa0R0MUk5aThSazRjQmwyOGRzWDdidUIr?=
 =?utf-8?B?cGtaK2hZVjdUMjIyN0FkT3ZCVkpobDVsUkZDK3ppTzhSQk9RSGVaYkJrcDA0?=
 =?utf-8?B?SVJFSkhaRk5DNTVpUkpjNHB4ME5xYWdtUXJRdkRTZzJxdXByQ0pRR2Y4L2Jx?=
 =?utf-8?B?cVhza28rZHN1aHp2S0JsbUM2cHBNTndoQzZQU0pOUmhBOVpMVGtLRTl1b3Ns?=
 =?utf-8?B?elVkay9PbXRwckpRdkpSY1p0bTcwc2ViblVXS09pRyt3VVQ4NW1jZ2RMbHd6?=
 =?utf-8?B?UytCSVROaHdVSi9BUm5DRW9pU3Eyc0IweHEyU0FsRHc1SFFHY25pU0hJUENC?=
 =?utf-8?B?VHRoMFZ1cENvTkNPeDNJOHlZSzYrdFBpSGRkK1BoaG82cDRHN2Q2VFNEOEZR?=
 =?utf-8?B?RHlYRmgrL2daeFB2aWtJTmY3aEJlQit5dGF1SURRWjVLUXFiRmpuODJDaVR6?=
 =?utf-8?B?anUya2VaRUZMUDh2QUp3cWk3RnZaMkJ1YnhSejJIemN3UnU3SlZjeUxzM0Yy?=
 =?utf-8?B?SE9qUXl0WmNVMnpOcng1d1lxVW1TOXJXWEFoOUkvSlpRUVhLajBrdmRnRFRl?=
 =?utf-8?B?bTZiTGpNSVR6dDhDcVJrNVVDWGI5bEJzS29HUmFvbmUxNVVBZnRvT2hBcnhF?=
 =?utf-8?B?M1RLRGxCdENPSTVDQ0ZYTE1FWS8xbVZKZS91RHF0NFFTMEVVVWdMVnB1ZHVy?=
 =?utf-8?B?a0hsZG9hanNKc2M3blNrTjBkVkRmVTJ5Q0ZrWUxZcFUzVDIxQXprcVpGV0JX?=
 =?utf-8?B?SG1pb2FRUnNuWXBqS21sbkJWRmNYQVppQU40TDQ4SmpuTUEwUE55NGxIVGxw?=
 =?utf-8?B?NlhOVFF5WVRZaFIrR0dCY1JhQVZtSE1GcG8xOGg5Q2xtWGpQV1JxcHBVSjFK?=
 =?utf-8?B?dlc1WVpUaGQ2R1dSUHFIRVZZV2FlVGhqVHFDbUF6NUdoZWlyT1ZjTHkwUWF2?=
 =?utf-8?B?bThFaWZQdStsV0NjVmVrNFNoZWZnazhiaWIwcVNRVWtyam9wV2JXbVhmaUJT?=
 =?utf-8?B?cWdzUm10UnVNdjRJKzRQZjlxZFRHVjJnVDZZZ09acWpJaTgrYXEwUncxSzZv?=
 =?utf-8?B?U2l4YkE3TXpxL1hOUGZKUG01WTlVR2ZhU0loVHZXZXQ5WVBWeWovMUJSTjlM?=
 =?utf-8?B?Vi9DL2JTQjlmNk1EV3FhRXMwcy9CVEM0T0lqR1VMNTE2TEFyQ1JKTlR5bklk?=
 =?utf-8?B?MjEycE1OR2xFQWg0c1Y2cnJpV0dMSUdQWDFEOFRlZEJIVi9vc2phSC9rVmRs?=
 =?utf-8?B?anZrNmNmZmtlS2ZDWi92U2FhMmtOSUFYUVpnU0RZV1AzbnlqcnFsNTZ6NlBE?=
 =?utf-8?B?NDNwaDAwcnFEaW4zdjZST2RFKzVDOVZzVWswZWlRYmtoWWRhRS8yZWJXeEw3?=
 =?utf-8?B?V2thaUpGSmtCdkQxMnR0ZkdmZGl5cnFEWVI5NldtYmRJRktxYzJYOFFDb3Rm?=
 =?utf-8?B?RWJoZU5VUjUra3N5a0lZSGhMTjB4MEdWQ0J0MnA1Q3p5TTFHemV3WXNNTjB4?=
 =?utf-8?B?NTBLeDFlWit4cHBRYjlVSzJ4bFhVR01vM0Z6VkJwZFZmVWNTUmplcVNGTWxs?=
 =?utf-8?B?SUw0UDc2cTZ0RjdQMFUrZGhDMHZWYXljSkJ2dkdUdTYxNWNjS2dsbWdldm1I?=
 =?utf-8?Q?gpCNzM/E0DYa3sPkP4paux8=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 76de7116-d101-4c4b-69a4-08daa76eca10
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Oct 2022 07:45:50.8097
 (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: 686KyH69KKEf7/v0XKqPxQXBQLLXHRxRCKcIMg6o0qggjRohksF9L/WIbOrWtyqn6dKRw73+/4Tcvn5fUj/8hqSgGthgNZlGHAgSEC3t5Mo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY5PR01MB5796
X-Spam-Status: No, score=-3.4 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        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 29/09/2022 16:56, Greg Kroah-Hartman wrote:
> On Thu, Sep 29, 2022 at 04:43:18PM +0700, Quan Nguyen wrote:
>> Adds documentation for the Ampere(R)'s Altra(R) SMpro misc driver.
>>
>> Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
>> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
>> ---
>> Changes in v9:
>>    + Update SPDX licence                          [Greg]
>>
>> Changes in v8:
>>    + Update to reflect single value per sysfs     [Quan]
>>
>> Changes in v7:
>>    + None
>>
>> Changes in v6:
>>    + First introduced in v6 [Quan]
>>
>>   Documentation/misc-devices/index.rst      |  1 +
>>   Documentation/misc-devices/smpro-misc.rst | 82 +++++++++++++++++++++++
>>   2 files changed, 83 insertions(+)
>>   create mode 100644 Documentation/misc-devices/smpro-misc.rst
>>
>> diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
>> index b74b3b34a235..b40cd1b402f7 100644
>> --- a/Documentation/misc-devices/index.rst
>> +++ b/Documentation/misc-devices/index.rst
>> @@ -28,6 +28,7 @@ fit into other categories.
>>      oxsemi-tornado
>>      pci-endpoint-test
>>      smpro-errmon
>> +   smpro-misc
>>      spear-pcie-gadget
>>      uacce
>>      xilinx_sdfec
>> diff --git a/Documentation/misc-devices/smpro-misc.rst b/Documentation/misc-devices/smpro-misc.rst
>> new file mode 100644
>> index 000000000000..d21be4a09e69
>> --- /dev/null
>> +++ b/Documentation/misc-devices/smpro-misc.rst
>> @@ -0,0 +1,82 @@
>> +.. SPDX-License-Identifier: GPL-2.0-only
>> +
>> +Kernel driver Ampere(R) Altra(R) SMpro miscellaneous
>> +====================================================
>> +
>> +Supported chips:
>> +
>> +  * Ampere(R) Altra(R)
>> +
>> +    Prefix: 'smpro'
>> +
>> +    Reference: Altra SoC BMC Interface Specification
>> +
>> +Author: Thu Nguyen <thu@os.amperecomputing.com>
>> +
>> +Description
>> +-----------
>> +
>> +This driver support the monitoring and configuration of various miscellaneous
>> +data provided by Ampere(R) Altra(R) SMpro processor.
>> +At this time, these include:
>> +
>> +  * Reading Boot Progress information
>> +  * Configuring SoC Power Limit
>> +
>> +Sysfs entries
>> +-------------
>> +
>> +1) Boot progress
>> +
>> +SMpro misc driver creates the sysfs files ``boot_progress``.
>> +The format of ``boot_progress`` file is as below::
>> +
>> +<boot stage><boot status><boot progress>
>> +
>> +Where:
>> +
>> +* Boot stage::
>> +
>> +    0: SMpro firmware booting.
>> +    1: PMpro firmware booting.
>> +    2: ATF BL1 firmware booting.
>> +    3: DDR initialization.
>> +    4: DDR training report status.
>> +    5: ATF BL2 firmware booting.
>> +    6: ATF BL31 firmware booting.
>> +    7: ATF BL32 firmware booting.
>> +    8: UEFI firmware booting.
>> +    9: OS booting.
>> +
>> +* Boot status::
>> +
>> +    0: Not started.
>> +    1: Started.
>> +    2: Complete without error.
>> +    3: Failure.
>> +
>> +* boot progress: 32 bits boot progress code
>> +
>> +The sysfs ``boot_progress`` only reports the boot state when the host is booting.
>> +If the host is already booted, it returns latest state.
>> +
>> +Example::
>> +
>> +    #cat boot_progress
>> +    0102808454A8
>> +
>> +2) SoC Power Limit
>> +
>> +SMpro misc driver creates the sysfs file ``soc_power_limit`` to get/set the SoC Power Limit.
>> +
>> +Reading this sysfs return the current setting of SoC Power Limit (W) in decimal string.
>> +Writing the desired value in decimal string to set the SoC Power Limit in Watt (W).
>> +The range of SoC Power Limit is 90-500(W) and will be ignored if out of range.
>> +
>> +Example::
>> +
>> +    #cat soc_power_limit
>> +    90
>> +    #echo 95 > soc_power_limit
>> +    #cat soc_power_limit
>> +    95
>> -- 
>> 2.35.1
>>
> 
> Why is this file needed at all if you have the correct
> Documentation/ABI/ entries instead?
> 

Will drop this file and add document to both the code and 
Documentation/ABI entries in next version.

-Quan