cmd: add missing usage vars
[fw/openocd] / src / flash / mflash.c
index 49dc432f36eb002c7a41c5b384264a1a5c15f23b..4a3f8fe21fade48d580813959235ac2ac3c07d40 100644 (file)
 #endif
 
 #include "mflash.h"
-#include "target.h"
-#include "time_support.h"
-#include "fileio.h"
-#include "log.h"
+#include <target/target.h>
+#include <helper/time_support.h>
+#include <helper/fileio.h>
+#include <helper/log.h>
 
 
 static int s3c2440_set_gpio_to_output (struct mflash_gpio_num gpio);
@@ -33,8 +33,6 @@ static int s3c2440_set_gpio_output_val (struct mflash_gpio_num gpio, uint8_t val
 static int pxa270_set_gpio_to_output (struct mflash_gpio_num gpio);
 static int pxa270_set_gpio_output_val (struct mflash_gpio_num gpio, uint8_t val);
 
-static struct command *mflash_cmd;
-
 static struct mflash_bank *mflash_bank;
 
 static struct mflash_gpio_drv pxa270_gpio = {
@@ -143,7 +141,7 @@ static int s3c2440_set_gpio_to_output (struct mflash_gpio_num gpio)
                gpio_con = S3C2440_GPJCON;
        } else {
                LOG_ERROR("mflash: invalid port %d%s", gpio.num, gpio.port);
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        ret = target_read_u32(target, gpio_con, &data);
@@ -175,7 +173,7 @@ static int s3c2440_set_gpio_output_val (struct mflash_gpio_num gpio, uint8_t val
                gpio_dat = S3C2440_GPJDAT;
        } else {
                LOG_ERROR("mflash: invalid port %d%s", gpio.num, gpio.port);
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        ret = target_read_u32(target, gpio_dat, &data);
@@ -211,7 +209,7 @@ static int mg_init_gpio (void)
        return ret;
 }
 
-static int mg_dsk_wait(mg_io_type_wait wait, uint32_t time)
+static int mg_dsk_wait(mg_io_type_wait wait_local, uint32_t time_var)
 {
        uint8_t status, error;
        struct target *target = mflash_bank->target;
@@ -222,7 +220,7 @@ static int mg_dsk_wait(mg_io_type_wait wait, uint32_t time)
        struct duration bench;
        duration_start(&bench);
 
-       while (time) {
+       while (time_var) {
 
                ret = target_read_u8(target, mg_task_reg + MG_REG_STATUS, &status);
                if (ret != ERROR_OK)
@@ -230,10 +228,10 @@ static int mg_dsk_wait(mg_io_type_wait wait, uint32_t time)
 
                if (status & mg_io_rbit_status_busy)
                {
-                       if (wait == mg_io_wait_bsy)
+                       if (wait_local == mg_io_wait_bsy)
                                return ERROR_OK;
                } else {
-                       switch (wait)
+                       switch (wait_local)
                        {
                                case mg_io_wait_not_bsy:
                                        return ERROR_OK;
@@ -261,7 +259,7 @@ static int mg_dsk_wait(mg_io_type_wait wait, uint32_t time)
                                return ERROR_MG_IO;
                        }
 
-                       switch (wait)
+                       switch (wait_local)
                        {
                                case mg_io_wait_rdy:
                                        if (status & mg_io_rbit_status_ready)
@@ -282,7 +280,7 @@ static int mg_dsk_wait(mg_io_type_wait wait, uint32_t time)
                else
                        LOG_ERROR("mflash: duration measurement failed: %d", ret);
 
-               if (t > time)
+               if (t > time_var)
                        break;
        }
 
@@ -344,7 +342,8 @@ static int mg_dsk_drv_info(void)
        if ((ret =  mg_dsk_io_cmd(0, 1, mg_io_cmd_identify)) != ERROR_OK)
                return ret;
 
-       if ((ret = mg_dsk_wait(mg_io_wait_drq, MG_OEM_DISK_WAIT_TIME_NORMAL)) != ERROR_OK)
+       ret = mg_dsk_wait(mg_io_wait_drq, MG_OEM_DISK_WAIT_TIME_NORMAL);
+       if (ret != ERROR_OK)
                return ret;
 
        LOG_INFO("mflash: read drive info");
@@ -352,7 +351,8 @@ static int mg_dsk_drv_info(void)
        if (! mflash_bank->drv_info)
                mflash_bank->drv_info = malloc(sizeof(struct mg_drv_info));
 
-       target_read_memory(target, mg_buff, 2, sizeof(mg_io_type_drv_info) >> 1,
+       ret = target_read_memory(target, mg_buff, 2,
+                       sizeof(mg_io_type_drv_info) >> 1,
                        (uint8_t *)&mflash_bank->drv_info->drv_id);
        if (ret != ERROR_OK)
                return ret;
@@ -416,7 +416,7 @@ COMMAND_HANDLER(mg_probe_cmd)
        ret = mg_mflash_probe();
 
        if (ret == ERROR_OK) {
-               command_print(cmd_ctx, "mflash (total %" PRIu32 " sectors) found at 0x%8.8" PRIx32 "",
+               command_print(CMD_CTX, "mflash (total %" PRIu32 " sectors) found at 0x%8.8" PRIx32 "",
                                mflash_bank->drv_info->tot_sects, mflash_bank->base);
        }
 
@@ -705,33 +705,40 @@ static int mg_mflash_write(uint32_t addr, uint8_t *buff, uint32_t len)
 
 COMMAND_HANDLER(mg_write_cmd)
 {
-       uint32_t address, buf_cnt, cnt, res, i;
+       uint32_t address, cnt, res, i;
        uint8_t *buffer;
        struct fileio fileio;
        int ret;
 
-       if (argc != 3) {
+       if (CMD_ARGC != 3) {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       COMMAND_PARSE_NUMBER(u32, args[2], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], address);
 
-       ret = fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY);
+       ret = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
        if (ret != ERROR_OK)
                return ret;
 
+       int filesize;
        buffer = malloc(MG_FILEIO_CHUNK);
        if (!buffer) {
                fileio_close(&fileio);
                return ERROR_FAIL;
        }
+       int retval = fileio_size(&fileio, &filesize);
+       if (retval != ERROR_OK) {
+               fileio_close(&fileio);
+               return retval;
+       }
 
-       cnt = fileio.size / MG_FILEIO_CHUNK;
-       res = fileio.size % MG_FILEIO_CHUNK;
+       cnt = filesize / MG_FILEIO_CHUNK;
+       res = filesize % MG_FILEIO_CHUNK;
 
        struct duration bench;
        duration_start(&bench);
 
+       size_t buf_cnt;
        for (i = 0; i < cnt; i++) {
                if ((ret = fileio_read(&fileio, MG_FILEIO_CHUNK, buffer, &buf_cnt)) !=
                                ERROR_OK)
@@ -750,9 +757,9 @@ COMMAND_HANDLER(mg_write_cmd)
 
        if (duration_measure(&bench) == ERROR_OK)
        {
-               command_print(cmd_ctx, "wrote %lli byte from file %s "
-                               "in %fs (%0.3f kB/s)", fileio.size, args[1],
-                               duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
+               command_print(CMD_CTX, "wrote %ld bytes from file %s "
+                               "in %fs (%0.3f kB/s)", (long)filesize, CMD_ARGV[1],
+                               duration_elapsed(&bench), duration_kbps(&bench, filesize));
        }
 
        free(buffer);
@@ -761,7 +768,7 @@ COMMAND_HANDLER(mg_write_cmd)
        return ERROR_OK;
 
 mg_write_cmd_err:
-       free(buffer);
+       free(buffer);
        fileio_close(&fileio);
 
        return ret;
@@ -769,19 +776,19 @@ mg_write_cmd_err:
 
 COMMAND_HANDLER(mg_dump_cmd)
 {
-       uint32_t address, size_written, size, cnt, res, i;
+       uint32_t address, size, cnt, res, i;
        uint8_t *buffer;
        struct fileio fileio;
        int ret;
 
-       if (argc != 4) {
+       if (CMD_ARGC != 4) {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       COMMAND_PARSE_NUMBER(u32, args[2], address);
-       COMMAND_PARSE_NUMBER(u32, args[3], size);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], size);
 
-       ret = fileio_open(&fileio, args[1], FILEIO_WRITE, FILEIO_BINARY);
+       ret = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
        if (ret != ERROR_OK)
                return ret;
 
@@ -797,6 +804,7 @@ COMMAND_HANDLER(mg_dump_cmd)
        struct duration bench;
        duration_start(&bench);
 
+       size_t size_written;
        for (i = 0; i < cnt; i++) {
                if ((ret = mg_mflash_read(address, buffer, MG_FILEIO_CHUNK)) != ERROR_OK)
                        goto mg_dump_cmd_err;
@@ -815,9 +823,9 @@ COMMAND_HANDLER(mg_dump_cmd)
 
        if (duration_measure(&bench) == ERROR_OK)
        {
-               command_print(cmd_ctx, "dump image (address 0x%8.8" PRIx32 " "
+               command_print(CMD_CTX, "dump image (address 0x%8.8" PRIx32 " "
                                "size %" PRIu32 ") to file %s in %fs (%0.3f kB/s)",
-                               address, size, args[1],
+                               address, size, CMD_ARGV[1],
                                duration_elapsed(&bench), duration_kbps(&bench, size));
        }
 
@@ -827,7 +835,7 @@ COMMAND_HANDLER(mg_dump_cmd)
        return ERROR_OK;
 
 mg_dump_cmd_err:
-       free(buffer);
+       free(buffer);
        fileio_close(&fileio);
 
        return ret;
@@ -1119,7 +1127,7 @@ static int mg_storage_config(void)
                        != ERROR_OK)
                return ret;
 
-       mg_gen_ataid((mg_io_type_drv_info *)buff);
+       mg_gen_ataid((mg_io_type_drv_info *)(void *)buff);
 
        if ((ret = mg_mflash_do_write_sects(buff, 0, 1, mg_vcmd_update_stgdrvinfo))
                        != ERROR_OK)
@@ -1147,7 +1155,7 @@ static int mg_boot_config(void)
        buff[0] = mg_op_mode_snd;               /* operation mode */
        buff[1] = MG_UNLOCK_OTP_AREA;
        buff[2] = 4;                            /* boot size */
-       *((uint32_t *)(buff + 4)) = 0;          /* XIP size */
+       *((uint32_t *)(void *)(buff + 4)) = 0;          /* XIP size */
 
        if ((ret = mg_mflash_do_write_sects(buff, 0, 1, mg_vcmd_update_xipinfo))
                        != ERROR_OK)
@@ -1221,19 +1229,19 @@ COMMAND_HANDLER(mg_config_cmd)
        if ((ret = mg_mflash_rst()) != ERROR_OK)
                return ret;
 
-       switch (argc) {
+       switch (CMD_ARGC) {
                case 2:
-                       if (!strcmp(args[1], "boot"))
+                       if (!strcmp(CMD_ARGV[1], "boot"))
                                return mg_boot_config();
-                       else if (!strcmp(args[1], "storage"))
+                       else if (!strcmp(CMD_ARGV[1], "storage"))
                                return mg_storage_config();
                        else
                                return ERROR_COMMAND_NOTFOUND;
                        break;
                case 3:
-                       if (!strcmp(args[1], "pll")) {
+                       if (!strcmp(CMD_ARGV[1], "pll")) {
                                unsigned long freq;
-                               COMMAND_PARSE_NUMBER(ulong, args[2], freq);
+                               COMMAND_PARSE_NUMBER(ulong, CMD_ARGV[2], freq);
                                fin = freq;
 
                                if (fin > MG_PLL_CLK_OUT) {
@@ -1266,19 +1274,62 @@ COMMAND_HANDLER(mg_config_cmd)
        }
 }
 
-int mflash_init_drivers(struct command_context *cmd_ctx)
+static const struct command_registration mflash_exec_command_handlers[] = {
+       {
+               .name = "probe",
+               .handler = mg_probe_cmd,
+               .mode = COMMAND_EXEC,
+               .help = "Detect bank configuration information",
+       },
+       {
+               .name = "write",
+               .handler = mg_write_cmd,
+               .mode = COMMAND_EXEC,
+               /* FIXME bank_num is unused */
+               .usage = "bank_num filename address",
+               .help = "Write binary file at the specified address.",
+       },
+       {
+               .name = "dump",
+               .handler = mg_dump_cmd,
+               .mode = COMMAND_EXEC,
+               /* FIXME bank_num is unused */
+               .usage = "bank_num filename address size",
+               .help = "Write specified number of bytes from a binary file "
+                       "to the specified, address.",
+       },
+       {
+               .name = "config",
+               .handler = mg_config_cmd,
+               .mode = COMMAND_EXEC,
+               .help = "Configure MFLASH options.",
+               .usage = "('boot'|'storage'|'pll' frequency)",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static int mflash_init_drivers(struct command_context *cmd_ctx)
 {
-       if (mflash_bank) {
-               register_command(cmd_ctx, mflash_cmd, "probe", mg_probe_cmd, COMMAND_EXEC, NULL);
-               register_command(cmd_ctx, mflash_cmd, "write", mg_write_cmd, COMMAND_EXEC,
-                               "mflash write <num> <file> <address>");
-               register_command(cmd_ctx, mflash_cmd, "dump", mg_dump_cmd, COMMAND_EXEC,
-                                               "mflash dump <num> <file> <address> <size>");
-               register_command(cmd_ctx, mflash_cmd, "config", mg_config_cmd,
-                               COMMAND_EXEC, "mflash config <num> <stage>");
+       if (!mflash_bank)
+               return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, mflash_exec_command_handlers);
+}
+
+COMMAND_HANDLER(handle_mflash_init_command)
+{
+       if (CMD_ARGC != 0)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       static bool mflash_initialized = false;
+       if (mflash_initialized)
+       {
+               LOG_INFO("'mflash init' has already been called");
+               return ERROR_OK;
        }
+       mflash_initialized = true;
 
-       return ERROR_OK;
+       LOG_DEBUG("Initializing mflash devices...");
+       return mflash_init_drivers(CMD_CTX);
 }
 
 COMMAND_HANDLER(mg_bank_cmd)
@@ -1286,45 +1337,70 @@ COMMAND_HANDLER(mg_bank_cmd)
        struct target *target;
        int i;
 
-       if (argc < 4)
+       if (CMD_ARGC < 4)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       if ((target = get_target(args[3])) == NULL)
+       if ((target = get_target(CMD_ARGV[3])) == NULL)
        {
-               LOG_ERROR("target '%s' not defined", args[3]);
+               LOG_ERROR("target '%s' not defined", CMD_ARGV[3]);
                return ERROR_FAIL;
        }
 
        mflash_bank = calloc(sizeof(struct mflash_bank), 1);
-       COMMAND_PARSE_NUMBER(u32, args[1], mflash_bank->base);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], mflash_bank->base);
        /// @todo Verify how this parsing should work, then document it.
        char *str;
-       mflash_bank->rst_pin.num = strtoul(args[2], &str, 0);
+       mflash_bank->rst_pin.num = strtoul(CMD_ARGV[2], &str, 0);
        if (*str)
-               mflash_bank->rst_pin.port[0] = (uint16_t)tolower(str[0]);
+               mflash_bank->rst_pin.port[0] = (uint16_t)
+                               tolower((unsigned)str[0]);
 
        mflash_bank->target = target;
 
        for (i = 0; mflash_gpio[i] ; i++) {
-               if (! strcmp(mflash_gpio[i]->name, args[0])) {
+               if (! strcmp(mflash_gpio[i]->name, CMD_ARGV[0])) {
                        mflash_bank->gpio_drv = mflash_gpio[i];
                }
        }
 
        if (! mflash_bank->gpio_drv) {
-               LOG_ERROR("%s is unsupported soc", args[0]);
+               LOG_ERROR("%s is unsupported soc", CMD_ARGV[0]);
                return ERROR_MG_UNSUPPORTED_SOC;
        }
 
        return ERROR_OK;
 }
 
+static const struct command_registration mflash_config_command_handlers[] = {
+       {
+               .name = "bank",
+               .handler = mg_bank_cmd,
+               .mode = COMMAND_CONFIG,
+               .help = "configure a mflash device bank",
+               .usage = "soc_type base_addr pin_id target",
+       },
+       {
+               .name = "init",
+               .mode = COMMAND_CONFIG,
+               .handler = handle_mflash_init_command,
+               .help = "initialize mflash devices",
+               .usage = ""
+       },
+       COMMAND_REGISTRATION_DONE
+};
+static const struct command_registration mflash_command_handler[] = {
+       {
+               .name = "mflash",
+               .mode = COMMAND_ANY,
+               .help = "mflash command group",
+               .usage = "",
+               .chain = mflash_config_command_handlers,
+       },
+       COMMAND_REGISTRATION_DONE
+};
 int mflash_register_commands(struct command_context *cmd_ctx)
 {
-       mflash_cmd = register_command(cmd_ctx, NULL, "mflash", NULL, COMMAND_ANY, NULL);
-       register_command(cmd_ctx, mflash_cmd, "bank", mg_bank_cmd, COMMAND_CONFIG,
-                       "mflash bank <soc> <base> <RST pin> <target #>");
-       return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, mflash_command_handler);
 }