[PATCH] cmd: Make use of U_BOOT_LONGHELP when missing

Michal Simek monstr at monstr.eu
Wed Jun 19 08:15:04 CEST 2024


út 18. 6. 2024 v 19:45 odesílatel Tom Rini <trini at konsulko.com> napsal:
>
> After adding the U_BOOT_LONGHELP macro some new commands came in still
> that were not making use if it. Switch these cases over and in a few
> places add missing newlines as well.
>
> Signed-off-by: Tom Rini <trini at konsulko.com>
> ---
>  arch/arm/mach-imx/cmd_dek.c                |  4 ++--
>  arch/arm/mach-imx/cmd_mfgprot.c            |  4 ++--
>  arch/arm/mach-imx/imx8/snvs_security_sc.c  | 16 ++++++++--------
>  arch/arm/mach-stm32mp/cmd_stm32key.c       |  4 ++--
>  board/freescale/common/cmd_esbc_validate.c |  4 ++--
>  board/kontron/sl28/cmds.c                  |  4 ++--
>  cmd/adc.c                                  |  4 ++--
>  cmd/arm/exception.c                        |  5 ++---
>  cmd/arm/exception64.c                      |  5 ++---
>  cmd/blob.c                                 |  4 ++--
>  cmd/riscv/exception.c                      |  5 ++---
>  cmd/scmi.c                                 |  5 ++---
>  cmd/x86/exception.c                        |  5 ++---
>  13 files changed, 32 insertions(+), 37 deletions(-)
>
> diff --git a/arch/arm/mach-imx/cmd_dek.c b/arch/arm/mach-imx/cmd_dek.c
> index c7962ead2d54..56e1a8f8be76 100644
> --- a/arch/arm/mach-imx/cmd_dek.c
> +++ b/arch/arm/mach-imx/cmd_dek.c
> @@ -395,10 +395,10 @@ static int do_dek_blob(struct cmd_tbl *cmdtp, int flag, int argc,
>  }
>
>  /***************************************************/
> -static char dek_blob_help_text[] =
> +U_BOOT_LONGHELP(dek_blob,
>         "src dst len            - Encapsulate and create blob of data\n"
>         "                         $len bits long at address $src and\n"
> -       "                         store the result at address $dst.\n";
> +       "                         store the result at address $dst.\n");
>
>  U_BOOT_CMD(
>         dek_blob, 4, 1, do_dek_blob,
> diff --git a/arch/arm/mach-imx/cmd_mfgprot.c b/arch/arm/mach-imx/cmd_mfgprot.c
> index 9925c9922687..9f37e611a1e7 100644
> --- a/arch/arm/mach-imx/cmd_mfgprot.c
> +++ b/arch/arm/mach-imx/cmd_mfgprot.c
> @@ -134,12 +134,12 @@ free_m:
>  }
>
>  /***************************************************/
> -static char mfgprot_help_text[] =
> +U_BOOT_LONGHELP(mfgprot,
>         "Usage:\n"
>          "Print the public key for Manufacturing Protection\n"
>          "\tmfgprot pubk\n"
>          "Generates a Manufacturing Protection signature\n"
> -        "\tmfgprot sign <data_addr> <size>";
> +        "\tmfgprot sign <data_addr> <size>\n");
>
>  U_BOOT_CMD(
>         mfgprot, 4, 1, do_mfgprot,
> diff --git a/arch/arm/mach-imx/imx8/snvs_security_sc.c b/arch/arm/mach-imx/imx8/snvs_security_sc.c
> index f13dfc155165..ed0ddba73b32 100644
> --- a/arch/arm/mach-imx/imx8/snvs_security_sc.c
> +++ b/arch/arm/mach-imx/imx8/snvs_security_sc.c
> @@ -597,7 +597,7 @@ exit:
>  }
>  #endif /* CONFIG_IMX_SNVS_SEC_SC_AUTO */
>
> -static char snvs_cfg_help_text[] =
> +U_BOOT_LONGHELP(snvs_cfg,
>         "snvs_cfg\n"
>         "\thp.lock\n"
>         "\thp.secvio_ctl\n"
> @@ -618,7 +618,7 @@ static char snvs_cfg_help_text[] =
>         "\tlp.act_tamper_routing_ctl1\n"
>         "\tlp.act_tamper_routing_ctl2\n"
>         "\n"
> -       "ALL values should be in hexadecimal format";
> +       "ALL values should be in hexadecimal format\n");
>
>  #define NB_REGISTERS 18
>  static int do_snvs_cfg(struct cmd_tbl *cmdtp, int flag, int argc,
> @@ -662,7 +662,7 @@ U_BOOT_CMD(snvs_cfg,
>            snvs_cfg_help_text
>  );
>
> -static char snvs_dgo_cfg_help_text[] =
> +U_BOOT_LONGHELP(snvs_dgo_cfg,
>         "snvs_dgo_cfg\n"
>         "\ttamper_offset_ctl\n"
>         "\ttamper_pull_ctl\n"
> @@ -671,7 +671,7 @@ static char snvs_dgo_cfg_help_text[] =
>         "\ttamper_misc_ctl\n"
>         "\ttamper_core_volt_mon_ctl\n"
>         "\n"
> -       "ALL values should be in hexadecimal format";
> +       "ALL values should be in hexadecimal format\n");
>
>  static int do_snvs_dgo_cfg(struct cmd_tbl *cmdtp, int flag, int argc,
>                            char *const argv[])
> @@ -702,12 +702,12 @@ U_BOOT_CMD(snvs_dgo_cfg,
>            snvs_dgo_cfg_help_text
>  );
>
> -static char tamper_pin_cfg_help_text[] =
> +U_BOOT_LONGHELP(tamper_pin_cfg,
>         "snvs_dgo_cfg\n"
>         "\tpad\n"
>         "\tvalue\n"
>         "\n"
> -       "ALL values should be in hexadecimal format";
> +       "ALL values should be in hexadecimal format\n");
>
>  static int do_tamper_pin_cfg(struct cmd_tbl *cmdtp, int flag, int argc,
>                              char *const argv[])
> @@ -734,7 +734,7 @@ U_BOOT_CMD(tamper_pin_cfg,
>            tamper_pin_cfg_help_text
>  );
>
> -static char snvs_clear_status_help_text[] =
> +U_BOOT_LONGHELP(snvs_clear_status,
>         "snvs_clear_status\n"
>         "\tHPSR\n"
>         "\tHPSVSR\n"
> @@ -742,7 +742,7 @@ static char snvs_clear_status_help_text[] =
>         "\tLPTDSR\n"
>         "\n"
>         "Write the status registers with the value provided,"
> -       " clearing the status";
> +       " clearing the status\n");
>
>  static int do_snvs_clear_status(struct cmd_tbl *cmdtp, int flag, int argc,
>                                 char *const argv[])
> diff --git a/arch/arm/mach-stm32mp/cmd_stm32key.c b/arch/arm/mach-stm32mp/cmd_stm32key.c
> index 0cb3c7a9fa44..040a70f581cb 100644
> --- a/arch/arm/mach-stm32mp/cmd_stm32key.c
> +++ b/arch/arm/mach-stm32mp/cmd_stm32key.c
> @@ -419,12 +419,12 @@ static int do_stm32key_close(struct cmd_tbl *cmdtp, int flag, int argc, char *co
>         return CMD_RET_SUCCESS;
>  }
>
> -static char stm32key_help_text[] =
> +U_BOOT_LONGHELP(stm32key,
>         "list : list the supported key with description\n"
>         "stm32key select [<key>] : Select the key identified by <key> or display the key used for read/fuse command\n"
>         "stm32key read [<addr> | -a ] : Read the curent key at <addr> or current / all (-a) key in OTP\n"
>         "stm32key fuse [-y] <addr> : Fuse the current key at addr in OTP\n"
> -       "stm32key close [-y] : Close the device\n";
> +       "stm32key close [-y] : Close the device\n");
>
>  U_BOOT_CMD_WITH_SUBCMDS(stm32key, "Manage key on STM32", stm32key_help_text,
>         U_BOOT_SUBCMD_MKENT(list, 1, 0, do_stm32key_list),
> diff --git a/board/freescale/common/cmd_esbc_validate.c b/board/freescale/common/cmd_esbc_validate.c
> index d4192e5ab521..3344653ba2da 100644
> --- a/board/freescale/common/cmd_esbc_validate.c
> +++ b/board/freescale/common/cmd_esbc_validate.c
> @@ -63,14 +63,14 @@ static int do_esbc_validate(struct cmd_tbl *cmdtp, int flag, int argc,
>  }
>
>  /***************************************************/
> -static char esbc_validate_help_text[] =
> +U_BOOT_LONGHELP(esbc_validate,
>         "esbc_validate hdr_addr <hash_val> - Validates signature using\n"
>         "                          RSA verification\n"
>         "                          $hdr_addr Address of header of the image\n"
>         "                          to be validated.\n"
>         "                          $hash_val -Optional\n"
>         "                          It provides Hash of public/srk key to be\n"
> -       "                          used to verify signature.\n";
> +       "                          used to verify signature.\n");
>
>  U_BOOT_CMD(
>         esbc_validate,  3,      0,      do_esbc_validate,
> diff --git a/board/kontron/sl28/cmds.c b/board/kontron/sl28/cmds.c
> index 7851361c48cc..07514778753f 100644
> --- a/board/kontron/sl28/cmds.c
> +++ b/board/kontron/sl28/cmds.c
> @@ -172,8 +172,8 @@ out:
>         return CMD_RET_FAILURE;
>  }
>
> -static char sl28_help_text[] =
> -       "nvm [<hex>] - display/set the 16 non-volatile bits\n";
> +U_BOOT_LONGHELP(sl28,
> +       "nvm [<hex>] - display/set the 16 non-volatile bits\n");
>
>  U_BOOT_CMD_WITH_SUBCMDS(sl28, "SMARC-sAL28 specific", sl28_help_text,
>                         U_BOOT_SUBCMD_MKENT(nvm, 2, 1, do_sl28_nvm));
> diff --git a/cmd/adc.c b/cmd/adc.c
> index f87f9785a114..4d3b5b61f6f0 100644
> --- a/cmd/adc.c
> +++ b/cmd/adc.c
> @@ -152,11 +152,11 @@ static int do_adc_scan(struct cmd_tbl *cmdtp, int flag, int argc,
>         return CMD_RET_SUCCESS;
>  }
>
> -static char adc_help_text[] =
> +U_BOOT_LONGHELP(adc,
>         "list - list ADC devices\n"
>         "adc info <name> - Get ADC device info\n"
>         "adc single <name> <channel> [varname] - Get Single data of ADC device channel\n"
> -       "adc scan <name> [channel mask] - Scan all [or masked] ADC channels";
> +       "adc scan <name> [channel mask] - Scan all [or masked] ADC channels\n");
>
>  U_BOOT_CMD_WITH_SUBCMDS(adc, "ADC sub-system", adc_help_text,
>         U_BOOT_SUBCMD_MKENT(list, 1, 1, do_adc_list),
> diff --git a/cmd/arm/exception.c b/cmd/arm/exception.c
> index 98a9795b68c8..8857f1216049 100644
> --- a/cmd/arm/exception.c
> +++ b/cmd/arm/exception.c
> @@ -49,12 +49,11 @@ static struct cmd_tbl cmd_sub[] = {
>                          "", ""),
>  };
>
> -static char exception_help_text[] =
> +U_BOOT_LONGHELP(exception,
>         "<ex>\n"
>         "  The following exceptions are available:\n"
>         "  breakpoint - prefetch abort\n"
>         "  unaligned  - data abort\n"
> -       "  undefined  - undefined instruction\n"
> -       ;
> +       "  undefined  - undefined instruction\n");
>
>  #include <exception.h>
> diff --git a/cmd/arm/exception64.c b/cmd/arm/exception64.c
> index 73d6c20ccace..4c5b953168cb 100644
> --- a/cmd/arm/exception64.c
> +++ b/cmd/arm/exception64.c
> @@ -77,12 +77,11 @@ static struct cmd_tbl cmd_sub[] = {
>                          "", ""),
>  };
>
> -static char exception_help_text[] =
> +U_BOOT_LONGHELP(exception,
>         "<ex>\n"
>         "  The following exceptions are available:\n"
>         "  breakpoint - breakpoint instruction exception\n"
>         "  unaligned  - unaligned LDAR data abort\n"
> -       "  undefined  - undefined instruction exception\n"
> -       ;
> +       "  undefined  - undefined instruction exception\n");
>
>  #include <exception.h>
> diff --git a/cmd/blob.c b/cmd/blob.c
> index a3c1dc49224d..b1c72e3f4406 100644
> --- a/cmd/blob.c
> +++ b/cmd/blob.c
> @@ -99,7 +99,7 @@ static int do_blob(struct cmd_tbl *cmdtp, int flag, int argc,
>  }
>
>  /***************************************************/
> -static char blob_help_text[] =
> +U_BOOT_LONGHELP(blob,
>         "enc src dst len km - Encapsulate and create blob of data\n"
>         "                          $len bytes long at address $src and\n"
>         "                          store the result at address $dst.\n"
> @@ -115,7 +115,7 @@ static char blob_help_text[] =
>         "                          modifier is stored.\n"
>         "                          The modifier is required for generation\n"
>         "                          /use as key for cryptographic operation.\n"
> -       "                          Key modifier should be 16 byte long.\n";
> +       "                          Key modifier should be 16 byte long.\n");
>
>  U_BOOT_CMD(
>         blob, 6, 1, do_blob,
> diff --git a/cmd/riscv/exception.c b/cmd/riscv/exception.c
> index 14ad6c440a56..2b58b1c449c0 100644
> --- a/cmd/riscv/exception.c
> +++ b/cmd/riscv/exception.c
> @@ -68,14 +68,13 @@ static struct cmd_tbl cmd_sub[] = {
>                          "", ""),
>  };
>
> -static char exception_help_text[] =
> +U_BOOT_LONGHELP(exception,
>         "<ex>\n"
>         "  The following exceptions are available:\n"
>         "  compressed - compressed instruction\n"
>         "  ebreak     - breakpoint\n"
>         "  ialign16   - 16 bit aligned instruction\n"
>         "  undefined  - illegal instruction\n"
> -       "  unaligned  - load address misaligned\n"
> -       ;
> +       "  unaligned  - load address misaligned\n");
>
>  #include <exception.h>
> diff --git a/cmd/scmi.c b/cmd/scmi.c
> index 664062c4eff5..cfbca63e1644 100644
> --- a/cmd/scmi.c
> +++ b/cmd/scmi.c
> @@ -369,7 +369,7 @@ static int do_scmi(struct cmd_tbl *cmdtp, int flag,
>         return cp->cmd(cmdtp, flag, argc, argv);
>  }
>
> -static char scmi_help_text[] =
> +U_BOOT_LONGHELP(scmi,
>         " - SCMI utility\n"
>         " info - get the info of SCMI services\n"
>         " perm_dev <agent-id in hex> <device-id in hex> <flags in hex>\n"
> @@ -377,8 +377,7 @@ static char scmi_help_text[] =
>         " perm_proto <agent-id in hex> <device-id in hex> <protocol-id in hex> <flags in hex>\n"
>         "   - set protocol permission to device\n"
>         " reset <agent-id in hex> <flags in hex>\n"
> -       "   - reset platform resource settings\n"
> -       "";
> +       "   - reset platform resource settings\n");
>
>  U_BOOT_CMD(scmi, CONFIG_SYS_MAXARGS, 0, do_scmi, "SCMI utility",
>            scmi_help_text);
> diff --git a/cmd/x86/exception.c b/cmd/x86/exception.c
> index 14b6bd6f4932..02735494a3c6 100644
> --- a/cmd/x86/exception.c
> +++ b/cmd/x86/exception.c
> @@ -19,10 +19,9 @@ static struct cmd_tbl cmd_sub[] = {
>                          "", ""),
>  };
>
> -static char exception_help_text[] =
> +U_BOOT_LONGHELP(exception,
>         "<ex>\n"
>         "  The following exceptions are available:\n"
> -       "  undefined  - undefined instruction\n"
> -       ;
> +       "  undefined  - undefined instruction\n");
>
>  #include <exception.h>
> --
> 2.34.1
>

arch/arm/mach-imx/imx8/snvs_security_sc.c:781:static char
snvs_sec_status_help_text[] =
board/xilinx/versal-net/cmds.c:74:static char versalnet_help_text[] =

These two should also be part of this patch.

And this one is interesting.
cmd/cli.c:122:static char cli_help_text[] =

it is guarded by SYS_LONGHELP but I think it should be just removed
and macro should be used instead.

#if CONFIG_IS_ENABLED(SYS_LONGHELP)
static char cli_help_text[] =
        "get - print current cli\n"
        "set - set the current cli, possible value are: old, modern"
        ;
#endif

U_BOOT_CMD(cli, 3, 1, do_cli,
           "cli",
#if CONFIG_IS_ENABLED(SYS_LONGHELP)
           cli_help_text
#endif
);

Thanks,
Michal

-- 
Michal Simek, Ing. (M.Eng), OpenPGP -> KeyID: FE3D1F91
w: www.monstr.eu p: +42-0-721842854
Maintainer of Linux kernel - Xilinx Microblaze
Maintainer of Linux kernel - Xilinx Zynq ARM and ZynqMP ARM64 SoCs
U-Boot custodian - Xilinx Microblaze/Zynq/ZynqMP/Versal SoCs


More information about the U-Boot mailing list