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

[Alexander Dahl <ada@thorsis.com>]

Hello,

Am Wed, Jan 08, 2025 at 02:03:50PM +0000 schrieb Ibai Erkiaga:
> 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.

Alignment could indeed improved.  One question: the \t is dependent on
the terminal, right?  Would it be better to use spaces instead?  That
would also make the code more readable.

Greets
Alex

> 
> 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
> 
> ---
>  cmd/fpga.c | 51 ++++++++++++++++++++++++---------------------------
>  1 file changed, 24 insertions(+), 27 deletions(-)
> 
> diff --git a/cmd/fpga.c b/cmd/fpga.c
> index 93f14098ccb..cba38662958 100644
> --- a/cmd/fpga.c
> +++ b/cmd/fpga.c
> @@ -411,46 +411,43 @@ U_BOOT_CMD(fpga, 6, 1, do_fpga_wrapper,
>  	   "loadable FPGA image support",
>  	   "[operation type] [device number] [image address] [image size]\n"
>  	   "fpga operations:\n"
> -	   "  dump\t[dev] [address] [size]\tLoad device to memory buffer\n"
> -	   "  info\t[dev]\t\t\tlist known device information\n"
> -	   "  load\t[dev] [address] [size]\tLoad device from memory buffer\n"
> +	   " dump\t[dev] [address] [size]\tLoad device to memory buffer\n"
> +	   " info\t[dev]\t\t\tList known device information\n"
> +	   " load\t[dev] [address] [size]\tLoad device from memory buffer\n"
>  #if defined(CONFIG_CMD_FPGA_LOADP)
> -	   "  loadp\t[dev] [address] [size]\t"
> +	   " loadp\t[dev] [address] [size]\t"
>  	   "Load device from memory buffer with partial bitstream\n"
>  #endif
> -	   "  loadb\t[dev] [address] [size]\t"
> +	   " loadb\t[dev] [address] [size]\t"
>  	   "Load device from bitstream buffer (Xilinx only)\n"
>  #if defined(CONFIG_CMD_FPGA_LOADBP)
> -	   "  loadbp\t[dev] [address] [size]\t"
> -	   "Load device from bitstream buffer with partial bitstream"
> +	   " loadbp\t[dev] [address] [size]\t"
> +	   "Load device from bitstream buffer with partial bitstream "
>  	   "(Xilinx only)\n"
>  #endif
>  #if defined(CONFIG_CMD_FPGA_LOADFS)
> -	   "Load device from filesystem (FAT by default) (Xilinx only)\n"
> -	   "  loadfs [dev] [address] [image size] [blocksize] <interface>\n"
> -	   "        [<dev[:part]>] <filename>\n"
> +	   " loadfs\t[dev] [address] [size] [blocksize] <interface> [<dev[:part]>] <filename>\n"
> +	   "\tLoad device from filesystem (FAT by default) (Xilinx only)\n"
>  #endif
>  #if defined(CONFIG_CMD_FPGA_LOADMK)
> -	   "  loadmk [dev] [address]\tLoad device generated with mkimage"
> +	   " loadmk\t[dev] [address]\t\tLoad device generated with mkimage\n"
>  #if defined(CONFIG_FIT)
> -	   "\n"
> -	   "\tFor loadmk operating on FIT format uImage address must include\n"
> -	   "\tsubimage unit name in the form of addr:<subimg_uname>"
> +	   "\tNOTE: loadmk operating on FIT format uImage address must include\n"
> +	   "\tsubimage unit name in the form of addr:<subimg_uname>\n"
>  #endif
>  #endif
>  #if defined(CONFIG_CMD_FPGA_LOAD_SECURE)
> -	   "Load encrypted bitstream (Xilinx only)\n"
> -	   "  loads [dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]\n"
> -	   "        [enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]\n"
> -	   "Loads the secure bistreams(authenticated/encrypted/both\n"
> -	   "authenticated and encrypted) of [size] from [address].\n"
> -	   "The auth-OCM/DDR flag specifies to perform authentication\n"
> -	   "in OCM or in DDR. 0 for OCM, 1 for DDR, 2 for no authentication.\n"
> -	   "The enc flag specifies which key to be used for decryption\n"
> -	   "0-device key, 1-user key, 2-no encryption.\n"
> -	   "The optional Userkey address specifies from which address key\n"
> -	   "has to be used for decryption if user key is selected.\n"
> -	   "NOTE: the secure bitstream has to be created using Xilinx\n"
> -	   "bootgen tool only.\n"
> +	   " loads\t[dev] [address] [size] [auth-OCM-0/DDR-1/noauth-2]\n"
> +	   "\t[enc-devkey(0)/userkey(1)/nenc(2) [Userkey address]\n"
> +	   "\tLoads the secure bistreams(authenticated/encrypted/both\n"
> +	   "\tauthenticated and encrypted) of [size] from [address] (Xilinx only)\n"
> +	   "\t -The auth-OCM/DDR flag specifies to perform authentication\n"
> +	   "\tin OCM or in DDR. 0 for OCM, 1 for DDR, 2 for no authentication.\n"
> +	   "\t -The enc flag specifies which key to be used for decryption\n"
> +	   "\t0-device key, 1-user key, 2-no encryption.\n"
> +	   "\t -The optional Userkey address specifies from which address key\n"
> +	   "\thas to be used for decryption if user key is selected.\n"
> +	   "\tNOTE: the secure bitstream has to be created using Xilinx\n"
> +	   "\tbootgen tool only.\n"
>  #endif
>  );
> -- 
> 2.42.0.325.g3a06386e31
>