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: <53807596-4e18-2d64-121c-64716982fcb2@os.amperecomputing.com>
Date:   Thu, 6 Oct 2022 14:47:17 +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:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     macro@orcam.me.uk, Lee Jones <lee@kernel.org>,
        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>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        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>
 <Yze98CgmGuNA0uGr@debian.me>
From:   Quan Nguyen <quan@os.amperecomputing.com>
In-Reply-To: <Yze98CgmGuNA0uGr@debian.me>
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?WXVZV2txTnV5cTcwMFZPbGllOVVQQ09CbGVzNUF6RUt3RmFwdndBQVQwRm9l?=
 =?utf-8?B?RmxROWxIWlNHMkdreUxxRVR0alZsOFJka2RBdFBWMmlwdmVhTVlGMnZSUlRx?=
 =?utf-8?B?L1gwVWNjZEh3c2JZK0lBeWtmRVl0eFpMdk5PdFZheHdMTHlseTFyNU9yTFQ1?=
 =?utf-8?B?MUhZS283VmxWZW82RzIxb2E3aS9TLzNya1RpRTJHQ3ozYXlnSW01TXJDdWhK?=
 =?utf-8?B?ZmZiWWVPR1NOUGtpNDhFMHBFOVdUUlpGTlpGSkZVZHZMdDlTc2pCMktIYy9L?=
 =?utf-8?B?U3dxL3NlTXgrUXB0ZUJOZ2hVVzkzVE1tbkJRWnhUTmFmMm9iS1c3RG1hVUlI?=
 =?utf-8?B?N0dsa3JZZ2RjaklGTXdMd1h0NTJGclZWZ2Z1ZTFIN0tGMGNsbmdYZnB2amlO?=
 =?utf-8?B?aGJMYjF5WnJqaU9qVXVsTHRsMkdmM0dLWjh5eDVtNnFRTUkyalNGUW5hUTNN?=
 =?utf-8?B?K3N2OEVjd1VHRkd1VmtlV1hoejNEc21OWjJmWVlXWjFGUnFyb3kvZUx2dVVj?=
 =?utf-8?B?TjlTVCtQclRWQ0RqRjFDaHAyTjBJckFyOHlRQXJEdVk3Ly9OcGtzS0lhM3J4?=
 =?utf-8?B?QkxCM0dNWkFoQ1k1MHhMUjFRejRmN1RLMWc2OVNTMnBiYkNuSmZGUVNlQ2U2?=
 =?utf-8?B?cndZK2dBcWJGUTVrZkxMRkR5Nm9wekhCb1Rwc1lpcTBsQUhlYnZtSVAwaklT?=
 =?utf-8?B?cllIR2ZhY2hvZlpYbFc5NWJ0R2sxT1VXWkx4cE9mYUc3cUszNENFZHJUVFJI?=
 =?utf-8?B?K25UNlM3ZWU3SThsK1pkRVNaTmJFR3FrZDRWUEROaCtKQ3A5TERwRFpYVXVs?=
 =?utf-8?B?WS9xa2ZmYUZHT2VSdXMycUFQanlyWEFZaUZ6bENQVTZJV0Q5WWhXNzBpR29k?=
 =?utf-8?B?SVpNSlA2RUxpclJENHdOcGlVMEFnRnZwUGM5SzloQXlqSVNyZmNUSTU3TDVQ?=
 =?utf-8?B?dFZUbUhLa0g0bGNkY2VXZWJsWG5RYUFWNjVXcW9QZEcyTjBuV2VmTVliT1ZF?=
 =?utf-8?B?UmRyd1B5ajV4bWk0QXFBdkJEaDBjREh5b1doNE1uWGhEaXFrVzVtL1QrOEtm?=
 =?utf-8?B?Z24wZGgzeHBGL2NkdXZpTTRnUUlsV05ic3FrWHREeCtldnNYcGxBYm40VWZZ?=
 =?utf-8?B?MHI0WjdWMVFnbi9IK2c4dWU1cWlJUUVLbTRmU3BkWkNIQURyd285djhsUXYr?=
 =?utf-8?B?Yi9CcE53MVNSSTNPTXZmdHlpcForR3E5WVZ5RFVoZXNNeGRGUXd0VFgrSlpY?=
 =?utf-8?B?RUp2NnhWcGN4cFVWMHVZdDhOMXpCL0d4NDlFbnlrVDh6d0M0N2JHdnR1YkNI?=
 =?utf-8?B?N3IyeE13ck9MZW5jcTlDZzRxeWM2WmlpWldCcnlLSGt0MURyaHk3cUM2SmNk?=
 =?utf-8?B?V1Y0OWN5V2lkcEZZWHlnUW5UVVVXTE9QNldIVlFMcjluR3IyWVV2R1AwNnFD?=
 =?utf-8?B?eWkxL01BUkdoTFBvS1UyU1lobFQ3cmJOVDVxTkVKNSs4S1RSUzQvWXlSL2dK?=
 =?utf-8?B?azZhS2NYUDY4VVlMdm1FVDlwd09tREg0cG1kbTVJTFI5UHBtZWZvZGNJc1h4?=
 =?utf-8?B?dUhQN2psb0dsbTcwc0VIalpXYVNvY1hOUFFFY0M2ZitaakRIWE9QMXRkWmtk?=
 =?utf-8?B?WTVvanl5OFROUUsvaEY0UGVRRFdZNUFWVGE5RUlDeUVabS9RaTN4NFgzYlFG?=
 =?utf-8?B?ZnZmZW1Ma004cVI2MTNzb1RUQnZTWCtubnBVRWh1bzdOdmZHUzJrc2ZUcTlO?=
 =?utf-8?B?SHpIa0Q0MTgxU0E2TE12c2xOaDFIRENIWlJPaDlmeWNBVnN6cTE0OXhZYmIy?=
 =?utf-8?B?NlN1Z0F4NkUwc29TemZQQ2lrK0d1RGk5UFRjZ3FJaExkbE5TUUR6NHhXNWhn?=
 =?utf-8?B?V21ZbGJMZU1jN1c2S290REZ1Z1RlcmU2WjlHZ3RXRENZencyZm93R2ppYnlq?=
 =?utf-8?B?eFhSU0s5c3hIcWprQjZWcTlCSkROUXFMU0ZCODdncHdBNndGNmhxdHFsd2No?=
 =?utf-8?B?R3lvR0s5bE50bGlGWWdkbUtseTZlMUJ0YVoyb1VnV1Y5V0Z0Qk54eXZ0NDk4?=
 =?utf-8?B?bGRzR0xFMmFiMG1oMFhyaE9SdHFBaTNHeUtseTRvTVJaSE5VMWNPZWtWcW51?=
 =?utf-8?B?dWM1SkN6cENxTEVqNUJDWTlBaktPNjF1K3FNaTlQWUhicFlqcWs1U2Jzc09C?=
 =?utf-8?Q?sz9OniHKEEAwgYt9yjzK82Y=3D?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 6311a72f-1683-496d-d18d-08daa76f03e9
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Oct 2022 07:47:27.8803
 (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: wRUBAq5MYf/ri/OYpS5ILjuupoCv7qC0iCkIk/mjigKdj1DWco7/much82KdlOh1z1Rhli/aU6gyFjnBbZIqlEFW6/yZ2gTk7JczL6xVXtU=
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 01/10/2022 11:11, Bagas Sanjaya 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.
>>
> 
> s/Adds/Add/
> 
>> Signed-off-by: Thu Nguyen <thu@os.amperecomputing.com>
>> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
> 
> Does this patch originally authored by Thu? If so, add From: line before
> the patch description.
> 
>> 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
> 
> The documentation above can be improved (both grammatical and
> formatting):
> 
> ---- >8 ----
> 
> diff --git a/Documentation/misc-devices/smpro-misc.rst b/Documentation/misc-devices/smpro-misc.rst
> index d21be4a09e69c4..f33466152ac402 100644
> --- a/Documentation/misc-devices/smpro-misc.rst
> +++ b/Documentation/misc-devices/smpro-misc.rst
> @@ -7,76 +7,77 @@ Supported chips:
>   
>     * Ampere(R) Altra(R)
>   
> -    Prefix: 'smpro'
> +    Prefix: ``smpro``
>   
> -    Reference: Altra SoC BMC Interface Specification
> +    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:
> +The smpro-misc driver supports monitoring and configuration of various
> +miscellaneous data provided by Ampere(R) Altra(R) SMpro processor.
> +Currently, the driver supports:
>   
> -  * Reading Boot Progress information
> -  * Configuring SoC Power Limit
> +  * 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::
> +   The driver creates ``boot_progress`` sysfs file. Its format is described
> +   as::
>   
> -<boot stage><boot status><boot progress>
> +     <boot stage><boot status><boot progress>
>   
> -Where:
> +   where:
>   
> -* Boot stage::
> +   * ``<boot stage>`` can be:
>   
> -    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.
> +     * 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::
> +  * ``<boot status>`` can be:
>   
> -    0: Not started.
> -    1: Started.
> -    2: Complete without error.
> -    3: Failure.
> +     * 0: Not started.
> +     * 1: Started.
> +     * 2: Complete without error.
> +     * 3: Failure.
>   
> -* boot progress: 32 bits boot progress code
> +  * ``<boot progress>``: 32-bit 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.
> +  The sysfs file  only reports the boot state when the host is booting. If
> +  the host is already booted, it returns the latest state.
>   
> -Example::
> +  Example::
>   
>       #cat boot_progress
>       0102808454A8
>   
> -2) SoC Power Limit
> +2) SoC power limit
>   
> -SMpro misc driver creates the sysfs file ``soc_power_limit`` to get/set the SoC Power Limit.
> +   The driver creates ``soc_power_limit`` sysfs file 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.
> +   Reading the file returns the current limit. Write the desired value in
> +   decimal to set the limit (in watts).  The valid limit range is 90-500 W.
> +   If the value is out of range, it will be ignored.
>   
> -Example::
> +   Example::
>   
> -    #cat soc_power_limit
> -    90
> -    #echo 95 > soc_power_limit
> -    #cat soc_power_limit
> -    95
> +     #cat soc_power_limit
> +     90
> +     #echo 95 > soc_power_limit
> +     #cat soc_power_limit
> +     95
> 
Thank you Bagas but as per Greg's comment, this file might be dropped 
and move to Documentation/ABI in next version.

Thanks a lot for the detail change.
- Quan