Change return value on error.
[fw/openocd] / src / helper / ioutil.c
index 52ecb9f26fdd06ac4d6c5c46b33fb7491a95c0f9..8dc70312afcd8876e78738e9b155245e23994e9d 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2007-2008 by Øyvind Harboe                              *
+ *   Copyright (C) 2007-2010 by Øyvind Harboe                              *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -38,9 +38,6 @@
 #ifdef HAVE_NET_IF_H
 #include <net/if.h>
 #endif
-//#ifdef HAVE_NETINET_TCP_H
-//#include <netinet/tcp.h>
-//#endif
 #ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
 #endif
 
 
-COMMAND_HANDLER(handle_rm_command)
-{
-       if (CMD_ARGC != 1)
-       {
-               command_print(CMD_CTX, "rm <filename>");
-               return ERROR_INVALID_ARGUMENTS;
-       }
-
-       if (unlink(CMD_ARGV[0]) != 0)
-       {
-               command_print(CMD_CTX, "failed: %d", errno);
-       }
-
-       return ERROR_OK;
-}
-
-
 /* loads a file and returns a pointer to it in memory. The file contains
  * a 0 byte(sentinel) after len bytes - the length of the file. */
 int loadFile(const char *fileName, void **data, size_t *len)
@@ -85,19 +65,19 @@ int loadFile(const char *fileName, void **data, size_t *len)
        pFile = fopen(fileName,"rb");
        if (pFile == NULL)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                return ERROR_FAIL;
        }
        if (fseek(pFile, 0, SEEK_END) != 0)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
        long fsize = ftell(pFile);
        if (fsize == -1)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
@@ -105,14 +85,14 @@ int loadFile(const char *fileName, void **data, size_t *len)
 
        if (fseek(pFile, 0, SEEK_SET) != 0)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
        *data = malloc(*len + 1);
        if (*data == NULL)
        {
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                fclose(pFile);
                return ERROR_FAIL;
        }
@@ -121,7 +101,7 @@ int loadFile(const char *fileName, void **data, size_t *len)
        {
                fclose(pFile);
                free(*data);
-               LOG_ERROR("Can't open %s\n", fileName);
+               LOG_ERROR("Can't open %s", fileName);
                return ERROR_FAIL;
        }
        fclose(pFile);
@@ -137,8 +117,7 @@ COMMAND_HANDLER(handle_cat_command)
 {
        if (CMD_ARGC != 1)
        {
-               command_print(CMD_CTX, "cat <filename>");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        // NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -153,7 +132,7 @@ COMMAND_HANDLER(handle_cat_command)
        }
        else
        {
-               command_print(CMD_CTX, "%s not found %d", CMD_ARGV[0], retval);
+               command_print(CMD_CTX, "%s not found", CMD_ARGV[0]);
        }
 
        return ERROR_OK;
@@ -163,8 +142,7 @@ COMMAND_HANDLER(handle_trunc_command)
 {
        if (CMD_ARGC != 1)
        {
-               command_print(CMD_CTX, "trunc <filename>");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        FILE *config_file = NULL;
@@ -182,8 +160,7 @@ COMMAND_HANDLER(handle_meminfo_command)
 
        if (CMD_ARGC != 0)
        {
-               command_print(CMD_CTX, "meminfo");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        info = mallinfo();
@@ -204,13 +181,12 @@ COMMAND_HANDLER(handle_append_command)
 {
        if (CMD_ARGC < 1)
        {
-               command_print(CMD_CTX,
-                               "append <filename> [<string1>, [<string2>, ...]]");
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        int retval = ERROR_FAIL;
        FILE *config_file = NULL;
+
        config_file = fopen(CMD_ARGV[0], "a");
        if (config_file != NULL)
        {
@@ -219,7 +195,8 @@ COMMAND_HANDLER(handle_append_command)
                unsigned i;
                for (i = 1; i < CMD_ARGC; i++)
                {
-                       if (fwrite(CMD_ARGV[i], 1, strlen(CMD_ARGV[i]), config_file) != strlen(CMD_ARGV[i]))
+                       if (fwrite(CMD_ARGV[i], 1, strlen(CMD_ARGV[i]),
+                                       config_file) != strlen(CMD_ARGV[i]))
                                break;
                        if (i != CMD_ARGC - 1)
                        {
@@ -228,9 +205,8 @@ COMMAND_HANDLER(handle_append_command)
                        }
                }
                if ((i == CMD_ARGC) && (fwrite("\n", 1, 1, config_file) == 1))
-               {
                        retval = ERROR_OK;
-               }
+
                fclose(config_file);
        }
 
@@ -243,7 +219,7 @@ COMMAND_HANDLER(handle_cp_command)
 {
        if (CMD_ARGC != 2)
        {
-               return ERROR_INVALID_ARGUMENTS;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        // NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -256,7 +232,7 @@ COMMAND_HANDLER(handle_cp_command)
 
        FILE *f = fopen(CMD_ARGV[1], "wb");
        if (f == NULL)
-               retval = ERROR_INVALID_ARGUMENTS;
+               retval = ERROR_COMMAND_SYNTAX_ERROR;
 
        size_t pos = 0;
        for (;;)
@@ -269,7 +245,7 @@ COMMAND_HANDLER(handle_cp_command)
                }
 
                if ((retval == ERROR_OK) && (fwrite(((char *)data) + pos, 1, chunk, f) != chunk))
-                       retval = ERROR_INVALID_ARGUMENTS;
+                       retval = ERROR_COMMAND_SYNTAX_ERROR;
 
                if (retval != ERROR_OK)
                {
@@ -289,7 +265,7 @@ COMMAND_HANDLER(handle_cp_command)
                command_print(CMD_CTX, "Copied %s to %s", CMD_ARGV[0], CMD_ARGV[1]);
        } else
        {
-               command_print(CMD_CTX, "Failed: %d", retval);
+               command_print(CMD_CTX, "copy failed");
        }
 
        if (data != NULL)
@@ -421,30 +397,23 @@ void copydir(char *name, char *destdir)
 
 
 
-static int
-zylinjtag_Jim_Command_rm(Jim_Interp *interp,
-                                   int argc,
-               Jim_Obj * const *argv)
+COMMAND_HANDLER(handle_rm_command)
 {
-       int del;
-       if (argc != 2)
-       {
-               Jim_WrongNumArgs(interp, 1, argv, "rm ?dirorfile?");
-               return JIM_ERR;
-       }
+       if (CMD_ARGC != 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
-       del = 0;
-       if (unlink(Jim_GetString(argv[1], NULL)) == 0)
-               del = 1;
-       if (rmdir(Jim_GetString(argv[1], NULL)) == 0)
-               del = 1;
+       bool del = false;
+       if (rmdir(CMD_ARGV[0]) == 0)
+               del = true;
+       else if (unlink(CMD_ARGV[0]) == 0)
+               del = true;
 
-       return del ? JIM_OK : JIM_ERR;
+       return del ? ERROR_OK : ERROR_FAIL;
 }
 
 
 static int
-zylinjtag_Jim_Command_ls(Jim_Interp *interp,
+ioutil_Jim_Command_ls(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -484,7 +453,7 @@ zylinjtag_Jim_Command_ls(Jim_Interp *interp,
 }
 
 static int
-zylinjtag_Jim_Command_peek(Jim_Interp *interp,
+ioutil_Jim_Command_peek(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -506,7 +475,7 @@ zylinjtag_Jim_Command_peek(Jim_Interp *interp,
 }
 
 static int
-zylinjtag_Jim_Command_poke(Jim_Interp *interp,
+ioutil_Jim_Command_poke(Jim_Interp *interp,
                                    int argc,
                Jim_Obj * const *argv)
 {
@@ -530,7 +499,7 @@ zylinjtag_Jim_Command_poke(Jim_Interp *interp,
 
 
 /* not so pretty code to fish out ip number*/
-static int zylinjtag_Jim_Command_ip(Jim_Interp *interp, int argc,
+static int ioutil_Jim_Command_ip(Jim_Interp *interp, int argc,
                Jim_Obj * const *argv)
 {
 #if !defined(__CYGWIN__)
@@ -577,7 +546,7 @@ static int zylinjtag_Jim_Command_ip(Jim_Interp *interp, int argc,
 }
 
 /* not so pretty code to fish out eth0 mac address */
-static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
+static int ioutil_Jim_Command_mac(Jim_Interp *interp, int argc,
                Jim_Obj * const *argv)
 {
 
@@ -643,41 +612,92 @@ static int zylinjtag_Jim_Command_mac(Jim_Interp *interp, int argc,
 
 }
 
-
+static const struct command_registration ioutil_command_handlers[] = {
+       {
+               .name = "cat",
+               .handler = handle_cat_command,
+               .mode = COMMAND_ANY,
+               .help = "display text file content",
+               .usage= "file_name",
+       },
+       {
+               .name = "trunc",
+               .handler = handle_trunc_command,
+               .mode = COMMAND_ANY,
+               .help = "truncate a file to zero length",
+               .usage= "file_name",
+       },
+       {
+               .name = "cp",
+               .handler = handle_cp_command,
+               .mode = COMMAND_ANY,
+               .help = "copy a file",
+               .usage = "src_file_name dst_file_name",
+       },
+       {
+               .name = "append_file",
+               .handler = handle_append_command,
+               .mode = COMMAND_ANY,
+               .help = "append a variable number of strings to a file",
+               .usage = "file_name [<string1>, [<string2>, ...]]",
+       },
+       {
+               .name = "meminfo",
+               .handler = handle_meminfo_command,
+               .mode = COMMAND_ANY,
+               .help = "display free heap space",
+       },
+       {
+               .name = "rm",
+               .mode = COMMAND_ANY,
+               .handler = handle_rm_command,
+               .help = "remove a directory or file",
+               .usage = "file_name",
+       },
+
+       /*
+        * Peek and poke are security holes -- they manipulate
+        * server-internal addresses.
+        */
+
+       // jim handlers
+       {
+               .name = "peek",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_peek,
+               .help = "peek at a memory address",
+               .usage = "address",
+       },
+       {
+               .name = "poke",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_poke,
+               .help = "poke at a memory address",
+               .usage = "address value",
+       },
+       {
+               .name = "ls",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_ls,
+               .help = "show a listing of files",
+               .usage = "dirname",
+       },
+       {
+               .name = "mac",
+               .mode = COMMAND_ANY,
+               .jim_handler = ioutil_Jim_Command_mac,
+               .help = "show MAC address",
+       },
+       {
+               .name = "ip",
+               .jim_handler = ioutil_Jim_Command_ip,
+               .mode = COMMAND_ANY,
+               .help = "show IP address",
+       },
+       COMMAND_REGISTRATION_DONE
+};
 
 int ioutil_init(struct command_context *cmd_ctx)
 {
-       COMMAND_REGISTER(cmd_ctx, NULL, "rm", handle_rm_command, COMMAND_ANY,
-                       "remove file");
-
-       COMMAND_REGISTER(cmd_ctx, NULL, "cat", handle_cat_command, COMMAND_ANY,
-                       "display file content");
-
-       COMMAND_REGISTER(cmd_ctx, NULL, "trunc", handle_trunc_command, COMMAND_ANY,
-                       "truncate a file to 0 size");
-
-       COMMAND_REGISTER(cmd_ctx, NULL, "cp", handle_cp_command,
-                                        COMMAND_ANY, "copy a file <from> <to>");
-
-       COMMAND_REGISTER(cmd_ctx, NULL, "append_file", handle_append_command,
-                       COMMAND_ANY, "append a variable number of strings to a file");
-
-       COMMAND_REGISTER(cmd_ctx, NULL, "meminfo", handle_meminfo_command,
-                       COMMAND_ANY, "display available ram memory");
-
-    Jim_CreateCommand(interp, "rm", zylinjtag_Jim_Command_rm, NULL, NULL);
-
-    Jim_CreateCommand(interp, "peek", zylinjtag_Jim_Command_peek, NULL, NULL);
-    Jim_CreateCommand(interp, "poke", zylinjtag_Jim_Command_poke, NULL, NULL);
-    Jim_CreateCommand(interp, "ls", zylinjtag_Jim_Command_ls, NULL, NULL);
-
-       Jim_CreateCommand(interp, "mac", zylinjtag_Jim_Command_mac,
-                       NULL, NULL);
-
-       Jim_CreateCommand(interp, "ip", zylinjtag_Jim_Command_ip,
-                       NULL, NULL);
-
-    return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, ioutil_command_handlers);
 }
-
-