[PATCH] doc: usage: cmd: reset: specify when the -edl option is available

[Quentin Schulz]

Hi Heinrich,

On 5/1/26 11:18 AM, Heinrich Schuchardt wrote:
> On 4/28/26 12:26, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz at cherry.de>
>>
>> The option is only available when CONFIG_SYSRESET_QCOM_PSCI is enabled,
>> so let's make that explicit in the boot cmd documentation.
>>
>> Fixes: ef06c5d76ff4 ("cmd: boot: Add '-edl' option to reset command 
>> documentation")
>> Signed-off-by: Quentin Schulz <quentin.schulz at cherry.de>
>> ---
>>   doc/usage/cmd/reset.rst | 3 ++-
>>   1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/doc/usage/cmd/reset.rst b/doc/usage/cmd/reset.rst
>> index 366b17eea16..54767fea241 100644
>> --- a/doc/usage/cmd/reset.rst
>> +++ b/doc/usage/cmd/reset.rst
>> @@ -23,7 +23,8 @@ DDR and peripherals, on some boards also resets 
>> external PMIC.
>>       Do warm WARM, reset CPU but keep peripheral/DDR/PMIC active.
>>   -edl
> 
> All available arguments need to be specified in the synopsis section.
> 
> The parameters -w and -edl are exclusive as both only work if they are 
> the first argument. So maybe:
> 
>      reset [-w|-edl]
> 

I'll follow the same syntax as in U_BOOT_CMD and have a separate line 
for -edl.

> 
>> -    Boot to Emergency DownLoad mode on supported Qualcomm platforms.
>> +    Boot to Emergency DownLoad mode on supported Qualcomm platforms 
>> and only
>> +    when CONFIG_SYSRESET_QCOM_PSCI=y.
> 
> This information is incomplete. Without CONFIG_SYSRESET_CMD_RESET_ARGS=y 
> the -edl argument will not be parsed. A configuration section to this 
> document might be helpful.
> 

We should probably not make the -edl option available if this isn't set 
either then, no?

> Should we mention that a "PSCI SYSTEM_RESET2 not supported\n" message is 
> shown if the platform is not supported?
> 

I would be wary of documenting strings that may change. However, we can 
say that the command will fail if the device doesn't support it.

> Where will a user learn how he can use the emergency download mode? Can 
> we add a link here? Unfortunately the EDL information seems to be 
> dispersed over multiple documents in the U-Boot documentation:
> 
> doc/board/qualcomm/dragonwing.rst
> doc/board/qualcomm/iq8.rst
> doc/board/qualcomm/rdp.rst
> 
> Do we need a document doc/board/quallcomm/edl.rst?
> 

That would be a question for Varadarajan or Casey, I have never done 
anything with Qualcomm devices.

Cheers,
Quentin