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

[Alexander Dahl]

Hello,

Am Fri, Jan 17, 2025 at 11:25:48AM +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.
> 
> Signed-off-by: Ibai Erkiaga <ibai.erkiaga-elorza at amd.com>
> ---
> 
> Changes in v3:
> - Split 3rd patch into two, resorting commands and Kconfig changes
> 
> Changes in v2:
> - Tabs replaced by spaces
> - fpga command added on each option similar to other commands like sf
> - Dependencies to Xilinx only commands added in Kconfig
> 
>  cmd/fpga.c | 61 +++++++++++++++++++++++++-----------------------------
>  1 file changed, 28 insertions(+), 33 deletions(-)
> 
> diff --git a/cmd/fpga.c b/cmd/fpga.c
> index 93f14098ccb..ae85ff201b8 100644
> --- a/cmd/fpga.c
> +++ b/cmd/fpga.c
> @@ -408,49 +408,44 @@ U_BOOT_CMD(fpga, 9, 1, do_fpga_wrapper,
>  #else
>  U_BOOT_CMD(fpga, 6, 1, do_fpga_wrapper,
>  #endif
> -	   "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"
> +	 "loadable FPGA image support",
> +	 "info   [dev]                  List known device information\n"
> +	 "fpga dump   <dev> <address> <size> Load device to memory buffer\n"
> +	 "fpga load   <dev> <address> <size> Load device from memory buffer\n"
>  #if defined(CONFIG_CMD_FPGA_LOADP)
> -	   "  loadp\t[dev] [address] [size]\t"
> -	   "Load device from memory buffer with partial bitstream\n"
> +	 "fpga loadp  <dev> <address> <size> Load device from memory buffer\n"
> +	 "            with partial bitstream\n"
>  #endif
> -	   "  loadb\t[dev] [address] [size]\t"
> -	   "Load device from bitstream buffer (Xilinx only)\n"
> +	 "fpga loadb  <dev> <address> <size> Load device from bitstream buffer\n"
> +	 "            (Xilinx only)\n"

I would have aligned the second line below "Load", but since that line
is removed in patch 4 anyways:

Acked-by: Alexander Dahl <ada at thorsis.com>

Greets
Alex

>  #if defined(CONFIG_CMD_FPGA_LOADBP)
> -	   "  loadbp\t[dev] [address] [size]\t"
> -	   "Load device from bitstream buffer with partial bitstream"
> -	   "(Xilinx only)\n"
> +	 "fpga loadbp <dev> <address> <size> Load device from bitstream buffer\n"
> +	 "             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"
> +	 "fpga loadfs <dev> <address> <size> <blocksize> <interface> [<dev[:part]>] <filename>\n"
> +	 "            Load device from filesystem (FAT by default) (Xilinx only)\n"
>  #endif
>  #if defined(CONFIG_CMD_FPGA_LOADMK)
> -	   "  loadmk [dev] [address]\tLoad device generated with mkimage"
> +	 "fpga loadmk <dev> <address>        Load 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>"
> +	 "            NOTE: loadmk operating on FIT must include subimage unit\n"
> +	 "            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"
> +	 "fpga 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"
> +	 "            (Xilinx only)\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"
>  #endif
>  );
> -- 
> 2.42.0.325.g3a06386e31
>