src/helper/options.c

   1 /***************************************************************************
   2  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 #include "configuration.h"
  29 /* @todo the inclusion of server.h here is a layering violation */
  30 #include <server/server.h>
  31
  32 #include <getopt.h>
  33
  34 static int help_flag, version_flag;
  35
  36 static const struct option long_options[] = {
  37         {"help",                no_argument,                    &help_flag,             1},
  38         {"version",             no_argument,                    &version_flag,  1},
  39         {"debug",               optional_argument,              0,                              'd'},
  40         {"file",                required_argument,              0,                              'f'},
  41         {"search",              required_argument,              0,                              's'},
  42         {"log_output",  required_argument,              0,                              'l'},
  43         {"command",             required_argument,              0,                              'c'},
  44         {"pipe",                no_argument,                    0,                              'p'},
  45         {0, 0, 0, 0}
  46 };
  47
  48 int configuration_output_handler(struct command_context *context, const char *line)
  49 {
  50         LOG_USER_N("%s", line);
  51
  52         return ERROR_OK;
  53 }
  54
  55 static void add_default_dirs(void)
  56 {
  57 #ifdef _WIN32
  58         /* Add the parent of the directory where openocd.exe resides to the
  59          * config script search path.
  60          * Directory layout:
  61          * bin\openocd.exe
  62          * lib\openocd
  63          * event\at91eb40a_reset.cfg
  64          * target\at91eb40a.cfg
  65          */
  66         {
  67                 char strExePath[MAX_PATH];
  68                 GetModuleFileName(NULL, strExePath, MAX_PATH);
  69                 /* Either this code will *always* work or it will SEGFAULT giving
  70                  * excellent information on the culprit.
  71                  */
  72                 *strrchr(strExePath, '\\') = 0;
  73                 strcat(strExePath, "\\..");
  74                 add_script_search_dir(strExePath);
  75         }
  76         /*
  77          * Add support for the default (as of 20091118) layout when
  78          * using autotools and cygwin/MinGW to build native binary.
  79          * Path separator is converted to UNIX style so that MinGW is
  80          * pleased.
  81          *
  82          * bin/openocd.exe
  83          * share/openocd/scripts/interface/dummy.cfg
  84          * share/openocd/scripts/target/at91eb40a.cfg
  85          */
  86         {
  87                 char strExePath[MAX_PATH];
  88                 char *p;
  89                 GetModuleFileName(NULL, strExePath, MAX_PATH);
  90                 *strrchr(strExePath, '\\') = 0;
  91                 strcat(strExePath, "/../share/"PACKAGE "/scripts");
  92                 for (p = strExePath; *p; p++) {
  93                         if (*p == '\\')
  94                                 *p = '/';
  95                 }
  96                 add_script_search_dir(strExePath);
  97         }
  98 #else
  99         /*
 100          * The directory containing OpenOCD-supplied scripts should be
 101          * listed last in the built-in search order, so the user can
 102          * override these scripts with site-specific customizations.
 103          */
 104
 105         const char *home = getenv("HOME");
 106
 107         if (home) {
 108                 char *path;
 109
 110                 path = alloc_printf("%s/.openocd", home);
 111
 112                 if (path) {
 113                         add_script_search_dir(path);
 114                         free(path);
 115                 }
 116         }
 117
 118         add_script_search_dir(PKGDATADIR "/site");
 119         add_script_search_dir(PKGDATADIR "/scripts");
 120 #endif
 121 }
 122
 123 int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
 124 {
 125         int c;
 126         char command_buffer[128];
 127
 128         while (1) {
 129                 /* getopt_long stores the option index here. */
 130                 int option_index = 0;
 131
 132                 c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
 133
 134                 /* Detect the end of the options. */
 135                 if (c == -1)
 136                         break;
 137
 138                 switch (c) {
 139                         case 0:
 140                                 break;
 141                         case 'h':               /* --help | -h */
 142                                 help_flag = 1;
 143                                 break;
 144                         case 'v':               /* --version | -v */
 145                                 version_flag = 1;
 146                                 break;
 147                         case 'f':               /* --file | -f */
 148                         {
 149                                 snprintf(command_buffer, 128, "script {%s}", optarg);
 150                                 add_config_command(command_buffer);
 151                                 break;
 152                         }
 153                         case 's':               /* --search | -s */
 154                                 add_script_search_dir(optarg);
 155                                 break;
 156                         case 'd':               /* --debug | -d */
 157                                 if (optarg)
 158                                         snprintf(command_buffer, 128, "debug_level %s", optarg);
 159                                 else
 160                                         snprintf(command_buffer, 128, "debug_level 3");
 161                                 command_run_line(cmd_ctx, command_buffer);
 162                                 break;
 163                         case 'l':               /* --log_output | -l */
 164                                 if (optarg) {
 165                                         snprintf(command_buffer, 128, "log_output %s", optarg);
 166                                         command_run_line(cmd_ctx, command_buffer);
 167                                 }
 168                                 break;
 169                         case 'c':               /* --command | -c */
 170                                 if (optarg)
 171                                     add_config_command(optarg);
 172                                 break;
 173                         case 'p':
 174                                 /* to replicate the old syntax this needs to be synchronous
 175                                  * otherwise the gdb stdin will overflow with the warning message */
 176                                 command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log");
 177                                 LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; "
 178                                                 "log_output openocd.log\"' instead.");
 179                                 break;
 180                 }
 181         }
 182
 183         if (help_flag) {
 184                 LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n");
 185                 LOG_OUTPUT("--help       | -h\tdisplay this help\n");
 186                 LOG_OUTPUT("--version    | -v\tdisplay OpenOCD version\n");
 187                 LOG_OUTPUT("--file       | -f\tuse configuration file <name>\n");
 188                 LOG_OUTPUT("--search     | -s\tdir to search for config files and scripts\n");
 189                 LOG_OUTPUT("--debug      | -d\tset debug level <0-3>\n");
 190                 LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
 191                 LOG_OUTPUT("--command    | -c\trun <command>\n");
 192                 exit(-1);
 193         }
 194
 195         if (version_flag) {
 196                 /* Nothing to do, version gets printed automatically. */
 197                 /* It is not an error to request the VERSION number. */
 198                 exit(0);
 199         }
 200
 201         /* paths specified on the command line take precedence over these
 202          * built-in paths
 203          */
 204         add_default_dirs();
 205
 206         return ERROR_OK;
 207 }