drivers/imx_gpio: fix usage messages
authorAntonio Borneo <borneo.antonio@gmail.com>
Fri, 4 Jan 2019 20:07:36 +0000 (21:07 +0100)
committerTomas Vanek <vanekt@fbl.cz>
Sun, 7 Apr 2019 07:17:48 +0000 (08:17 +0100)
The notation "(tck tms tdi tdo)* " is incorrect, because it means the
quadruple of gpio can be repeated on the command-line.
The correct syntax of the command requires instead to provide either
all the four gpio numbers (in order to set the values) or to pass an
empty command-line (to dump the values previously set).

Change the .usage field to "[tck tms tdi tdo]".
Change similarly the corresponding .usage field for SWD command.
Add the .usage field for the commands that individually set each gpio
or gpio property.
Dump the previously set values when commands imx_gpio_speed_coeffs or
imx_gpio_peripheral_base are executed with empty command-line.

Change-Id: Id56a68622817101bd0a46fed1fead6d2cd2b6ec6
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5018
Tested-by: jenkins
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
src/jtag/drivers/imx_gpio.c

index f42692c38d3d373b4d5f7acca24564ac564f399f..8f172c26ceb9be1576f8cede84cf40f22747f99c 100644 (file)
@@ -322,6 +322,9 @@ COMMAND_HANDLER(imx_gpio_handle_speed_coeffs)
                COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], speed_coeff);
                COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], speed_offset);
        }
+
+       command_print(CMD_CTX, "imx_gpio: speed_coeffs = %d, speed_offset = %d",
+                                 speed_coeff, speed_offset);
        return ERROR_OK;
 }
 
@@ -329,6 +332,9 @@ COMMAND_HANDLER(imx_gpio_handle_peripheral_base)
 {
        if (CMD_ARGC == 1)
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], imx_gpio_peri_base);
+
+       command_print(CMD_CTX, "imx_gpio: peripheral_base = 0x%08x",
+                                 imx_gpio_peri_base);
        return ERROR_OK;
 }
 
@@ -338,74 +344,84 @@ static const struct command_registration imx_gpio_command_handlers[] = {
                .handler = &imx_gpio_handle_jtag_gpionums,
                .mode = COMMAND_CONFIG,
                .help = "gpio numbers for tck, tms, tdi, tdo. (in that order)",
-               .usage = "(tck tms tdi tdo)* ",
+               .usage = "[tck tms tdi tdo]",
        },
        {
                .name = "imx_gpio_tck_num",
                .handler = &imx_gpio_handle_jtag_gpionum_tck,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tck.",
+               .usage = "[tck]",
        },
        {
                .name = "imx_gpio_tms_num",
                .handler = &imx_gpio_handle_jtag_gpionum_tms,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tms.",
+               .usage = "[tms]",
        },
        {
                .name = "imx_gpio_tdo_num",
                .handler = &imx_gpio_handle_jtag_gpionum_tdo,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tdo.",
+               .usage = "[tdo]",
        },
        {
                .name = "imx_gpio_tdi_num",
                .handler = &imx_gpio_handle_jtag_gpionum_tdi,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for tdi.",
+               .usage = "[tdi]",
        },
        {
                .name = "imx_gpio_swd_nums",
                .handler = &imx_gpio_handle_swd_gpionums,
                .mode = COMMAND_CONFIG,
                .help = "gpio numbers for swclk, swdio. (in that order)",
-               .usage = "(swclk swdio)* ",
+               .usage = "[swclk swdio]",
        },
        {
                .name = "imx_gpio_swclk_num",
                .handler = &imx_gpio_handle_swd_gpionum_swclk,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for swclk.",
+               .usage = "[swclk]",
        },
        {
                .name = "imx_gpio_swdio_num",
                .handler = &imx_gpio_handle_swd_gpionum_swdio,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for swdio.",
+               .usage = "[swdio]",
        },
        {
                .name = "imx_gpio_srst_num",
                .handler = &imx_gpio_handle_jtag_gpionum_srst,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for srst.",
+               .usage = "[srst]",
        },
        {
                .name = "imx_gpio_trst_num",
                .handler = &imx_gpio_handle_jtag_gpionum_trst,
                .mode = COMMAND_CONFIG,
                .help = "gpio number for trst.",
+               .usage = "[trst]",
        },
        {
                .name = "imx_gpio_speed_coeffs",
                .handler = &imx_gpio_handle_speed_coeffs,
                .mode = COMMAND_CONFIG,
                .help = "SPEED_COEFF and SPEED_OFFSET for delay calculations.",
+               .usage = "[SPEED_COEFF SPEED_OFFSET]",
        },
        {
                .name = "imx_gpio_peripheral_base",
                .handler = &imx_gpio_handle_peripheral_base,
                .mode = COMMAND_CONFIG,
                .help = "peripheral base to access GPIOs (0x0209c000 for most IMX).",
+               .usage = "[base]",
        },
 
        COMMAND_REGISTRATION_DONE