Re: [U-Boot][PATCH 1/2] fpga: fix alignment on fpga cmd usage info

[Michal Simek <michal.simek@amd.com>]

On 1/8/25 15:03, Ibai Erkiaga wrote:
> The current implementation generates some alignment issues as well as
> some overlapping when all the fpga command options are enabled. The fix
> is intended to improve readability of the usage info.
> 
> Signed-off-by: Ibai Erkiaga <ibai.erkiaga-elorza@amd.com>
> 
> ---
> 
> The current output looks like this:
>    loadbp        [dev] [address] [size]  Load device from bitstream buffer with partial bitstream(Xilinx only)
> Load device from filesystem (FAT by default) (Xilinx only)
>    loadfs [dev] [address] [image size] [blocksize] <interface>
>          [<dev[:part]>] <filename>
>    loadmk [dev] [address]        Load device generated with mkimage
>          For loadmk operating on FIT format uImage address must include
>          subimage unit name in the form of addr:<subimg_uname>Load encrypted bitstream (Xilinx only)
>    loads [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]
>          [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]
> Loads the secure bistreams(authenticated/encrypted/both
> 
> The new output lools like this:
> loadb  [dev] [address] [size]  Load device from bitstream buffer (Xilinx only)
>   loadbp [dev] [address] [size]  Load device from bitstream buffer with partial bitstream (Xilinx only)
>   loadfs [dev] [address] [size] [blocksize] <interface> [<dev[:part]>] <filename>
>          Load device from filesystem (FAT by default) (Xilinx only)
>   loadmk [dev] [address]         Load device generated with mkimage
>          NOTE: loadmk operating on FIT format uImage address must include
>          subimage unit name in the form of addr:<subimg_uname>
>   loads  [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]
>          [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]
>          Loads the secure bistreams(authenticated/encrypted/both

this is not the full look. Full log looks like this.
You can see that some of that lines are longer then 80 that's why they are on 
the next line. I think you should stay inside 80 chars per line.
Second loadp is in front of loadb which looks weird.

There should be description about meaning of [] or <> in help message

[ ] should means optional parameter
< > should means required parameter

Below all of them are optional which is not truth. It is correct in fpga info 
but not in fpga dump. It means I think when you are on this descriptions should 
be also fixed.

Also line
fpga [operation type] [device number] [image address] [image size]
is not covering all commands. It means you should consider if make sense to have 
this line.


Usage:
fpga [operation type] [device number] [image address] [image size]
fpga operations:
  dump	[dev] [address] [size]	Load device to memory buffer
  info	[dev]			List known device information
  load	[dev] [address] [size]	Load device from memory buffer
  loadp	[dev] [address] [size]	Load device from memory buffer with partial bitstream
  loadb	[dev] [address] [size]	Load device from bitstream buffer (Xilinx only)
  loadbp	[dev] [address] [size]	Load device from bitstream buffer with partial 
bitstream (Xilinx only)
  loadfs	[dev] [address] [size] [blocksize] <interface> [<dev[:part]>] <filename>
	Load device from filesystem (FAT by default) (Xilinx only)
  loadmk	[dev] [address]		Load device generated with mkimage
	NOTE: loadmk operating on FIT format uImage address must include
	subimage unit name in the form of addr:<subimg_uname>
  loads	[dev] [address] [size] [authflag] [encflag] [Userkey address]
	Load device from memory buffer with secure bistream 
(authenticated/encrypted/both)(Xilinx only)
	 -authflag: 0 for OCM, 1 for DDR, 2 for no authentication (specifies where to 
perform authentication)
	 -encflag: 0 for device key, 1 for user key, 2 for no encryption
	 -Userkey address: specifies the address where user key is stored when user key 
is selected
	NOTE: the secure bitstream has to be created using Xilinx bootgen tool only.

Thanks,
Michal