X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Foptions.c;h=d0a4a70e209c73eb5e6700f820d3df280afae3b1;hp=89bf1f9b24e32530f839a1af29c0337d78d33aaa;hb=8e4c80c17d6abea8754ab29aa5285ae10e6e273b;hpb=3d6bcf07921753141a3905ee5619724573460cb3 diff --git a/src/helper/options.c b/src/helper/options.c index 89bf1f9b24..d0a4a70e20 100644 --- a/src/helper/options.c +++ b/src/helper/options.c @@ -2,6 +2,9 @@ * Copyright (C) 2004, 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007-2010 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * * 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 * * the Free Software Foundation; either version 2 of the License, or * @@ -15,139 +18,197 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * ***************************************************************************/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif -#include "types.h" -#include "command.h" #include "configuration.h" -#include "log.h" +/* @todo the inclusion of server.h here is a layering violation */ +#include -#include -#include #include -#include - -static int help_flag; - -static struct option long_options[] = -{ - {"help", no_argument, &help_flag, 1}, - - {"debug", optional_argument, 0, 'd'}, - {"file", required_argument, 0, 'f'}, - {"search", required_argument, 0, 's'}, - {"log_output", required_argument, 0, 'l'}, - {"command", required_argument, 0, 'c'}, - +static int help_flag, version_flag; + +static const struct option long_options[] = { + {"help", no_argument, &help_flag, 1}, + {"version", no_argument, &version_flag, 1}, + {"debug", optional_argument, 0, 'd'}, + {"file", required_argument, 0, 'f'}, + {"search", required_argument, 0, 's'}, + {"log_output", required_argument, 0, 'l'}, + {"command", required_argument, 0, 'c'}, + {"pipe", no_argument, 0, 'p'}, {0, 0, 0, 0} }; - - -int configuration_output_handler(struct command_context_s *context, char* line) +int configuration_output_handler(struct command_context *context, const char *line) { - INFO(line); + LOG_USER_N("%s", line); return ERROR_OK; } +static void add_default_dirs(void) +{ +#ifdef _WIN32 + char strExePath[MAX_PATH]; + char *path; + GetModuleFileName(NULL, strExePath, MAX_PATH); + + /* Strip executable file name, leaving path */ + *strrchr(strExePath, '\\') = '\0'; + + /* Convert path separators to UNIX style, should work on Windows also. */ + for (char *p = strExePath; *p; p++) { + if (*p == '\\') + *p = '/'; + } + + /* Add the parent of the directory where openocd.exe resides to the + * config script search path. + * + * bin/openocd.exe + * interface/dummy.cfg + * target/at91eb40a.cfg + */ + path = alloc_printf("%s%s", strExePath, "/.."); + if (path) { + add_script_search_dir(path); + free(path); + } + /* Add support for the directory layout resulting from a 'make install'. + * + * bin/openocd.exe + * share/openocd/scripts/interface/dummy.cfg + * share/openocd/scripts/target/at91eb40a.cfg + */ + path = alloc_printf("%s%s", strExePath, "/../share/" PACKAGE "/scripts"); + if (path) { + add_script_search_dir(path); + free(path); + } + /* Add single "scripts" folder to search path for Windows OpenOCD builds that don't use cygwin + * + * bin/openocd.exe + * scripts/interface/dummy.cfg + * scripts/target/at91eb40a.cfg + */ + path = alloc_printf("%s%s", strExePath, "/../scripts"); + if (path) { + add_script_search_dir(path); + free(path); + } +#else + /* + * The directory containing OpenOCD-supplied scripts should be + * listed last in the built-in search order, so the user can + * override these scripts with site-specific customizations. + */ + + const char *home = getenv("HOME"); -int parse_cmdline_args(struct command_context_s *cmd_ctx, int argc, char *argv[]) + if (home) { + char *path; + + path = alloc_printf("%s/.openocd", home); + + if (path) { + add_script_search_dir(path); + free(path); + } + } + + add_script_search_dir(PKGDATADIR "/site"); + add_script_search_dir(PKGDATADIR "/scripts"); +#endif +} + +int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[]) { int c; char command_buffer[128]; - while (1) - { + while (1) { /* getopt_long stores the option index here. */ int option_index = 0; - - c = getopt_long(argc, argv, "hd::l:f:s:c:", long_options, &option_index); - + + c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index); + /* Detect the end of the options. */ if (c == -1) break; - - switch (c) - { + + switch (c) { case 0: break; - case 'h': /* --help | -h */ + case 'h': /* --help | -h */ help_flag = 1; break; - case 'f': /* --file | -f */ - snprintf(command_buffer, 128, "script %s", optarg); - add_config_file_name(command_buffer); + case 'v': /* --version | -v */ + version_flag = 1; + break; + case 'f': /* --file | -f */ + { + snprintf(command_buffer, 128, "script {%s}", optarg); + add_config_command(command_buffer); break; - case 's': /* --search | -s */ + } + case 's': /* --search | -s */ add_script_search_dir(optarg); break; - case 'd': /* --debug | -d */ + case 'd': /* --debug | -d */ if (optarg) snprintf(command_buffer, 128, "debug_level %s", optarg); else snprintf(command_buffer, 128, "debug_level 3"); command_run_line(cmd_ctx, command_buffer); break; - case 'l': /* --log_output | -l */ - if (optarg) - { + case 'l': /* --log_output | -l */ + if (optarg) { snprintf(command_buffer, 128, "log_output %s", optarg); command_run_line(cmd_ctx, command_buffer); - } + } break; - case 'c': /* --command | -c */ + case 'c': /* --command | -c */ if (optarg) - { - add_config_file_name(optarg); - } + add_config_command(optarg); + break; + case 'p': + /* to replicate the old syntax this needs to be synchronous + * otherwise the gdb stdin will overflow with the warning message */ + command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log"); + LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; " + "log_output openocd.log\"' instead."); break; - } } - if (help_flag) - { - OUTPUT("Open On-Chip Debugger\n(c) 2005 by Dominic Rath\n\n"); - OUTPUT("--help | -h\tdisplay this help\n"); - OUTPUT("--file | -f\tuse configuration file \n"); - OUTPUT("--search | -s\tdir to search for config files and scripts.\n"); - OUTPUT("--debug | -d\tset debug level <0-3>\n"); - OUTPUT("--log_output | -l\tredirect log output to file \n"); - OUTPUT("--command | -c\trun \n"); + if (help_flag) { + LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n"); + LOG_OUTPUT("--help | -h\tdisplay this help\n"); + LOG_OUTPUT("--version | -v\tdisplay OpenOCD version\n"); + LOG_OUTPUT("--file | -f\tuse configuration file \n"); + LOG_OUTPUT("--search | -s\tdir to search for config files and scripts\n"); + LOG_OUTPUT("--debug | -d\tset debug level <0-3>\n"); + LOG_OUTPUT("--log_output | -l\tredirect log output to file \n"); + LOG_OUTPUT("--command | -c\trun \n"); exit(-1); - } + } -#ifdef _WIN32 - /* Add the parent of the directory where openocd.exe resides to the - * config script search path. - * Directory layout: - * bin\openocd.exe - * lib\openocd - * event\at91eb40a_reset.cfg - * target\at91eb40a.cfg - */ - { - char strExePath [MAX_PATH]; - GetModuleFileName (NULL, strExePath, MAX_PATH); - /* Either this code will *always* work or it will SEGFAULT giving - * excellent information on the culprit. - */ - *strrchr(strExePath, '\\')=0; - strcat(strExePath, "\\.."); - add_script_search_dir(strExePath); + if (version_flag) { + /* Nothing to do, version gets printed automatically. */ + /* It is not an error to request the VERSION number. */ + exit(0); } -#else - /* Add dir for openocd supplied scripts last so that user can over - ride those scripts if desired. */ - add_script_search_dir(PKGDATADIR); - add_script_search_dir(PKGLIBDIR); -#endif + + /* paths specified on the command line take precedence over these + * built-in paths + */ + add_default_dirs(); return ERROR_OK; }