util/nvramtool/cli/opts.c

   1 /*****************************************************************************\
   2  * opts.c
   3  *****************************************************************************
   4  *  Copyright (C) 2002-2005 The Regents of the University of California.
   5  *  Produced at the Lawrence Livermore National Laboratory.
   6  *  Written by Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>.
   7  *  UCRL-CODE-2003-012
   8  *  All rights reserved.
   9  *
  10  *  This file is part of nvramtool, a utility for reading/writing coreboot
  11  *  parameters and displaying information from the coreboot table.
  12  *  For details, see http://coreboot.org/nvramtool.
  13  *
  14  *  Please also read the file DISCLAIMER which is included in this software
  15  *  distribution.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify it
  18  *  under the terms of the GNU General Public License (as published by the
  19  *  Free Software Foundation) version 2, dated June 1991.
  20  *
  21  *  This program is distributed in the hope that it will be useful, but
  22  *  WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the terms and
  24  *  conditions of the GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License along
  27  *  with this program; if not, write to the Free Software Foundation, Inc.,
  28  *  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  29 \*****************************************************************************/
  30
  31 #include "common.h"
  32 #include "opts.h"
  33
  34 nvramtool_op_info_t nvramtool_op;
  35
  36 nvramtool_op_modifier_info_t nvramtool_op_modifiers[NVRAMTOOL_NUM_OP_MODIFIERS];
  37
  38 static char *handle_optional_arg(int argc, char *argv[]);
  39 static void register_op(int *op_found, nvramtool_op_t op, char op_param[]);
  40 static void register_op_modifier(nvramtool_op_modifier_t mod, char mod_param[]);
  41 static void resolve_op_modifiers(void);
  42 static void sanity_check_args(void);
  43
  44 static const char getopt_string[] = "-ab:B:c::C:dD:e:hil::np:r:tvw:xX:y:Y";
  45
  46 /****************************************************************************
  47  * parse_nvramtool_args
  48  *
  49  * Parse command line arguments.
  50  ****************************************************************************/
  51 void parse_nvramtool_args(int argc, char *argv[])
  52 {
  53         nvramtool_op_modifier_info_t *mod_info;
  54         int i, op_found;
  55         char c;
  56
  57         for (i = 0, mod_info = nvramtool_op_modifiers;
  58              i < NVRAMTOOL_NUM_OP_MODIFIERS; i++, mod_info++) {
  59                 mod_info->found = FALSE;
  60                 mod_info->found_seq = 0;
  61                 mod_info->param = NULL;
  62         }
  63
  64         op_found = FALSE;
  65         opterr = 0;
  66
  67         do {
  68                 switch (c = getopt(argc, argv, getopt_string)) {
  69                 case 'a':
  70                         register_op(&op_found,
  71                                     NVRAMTOOL_OP_CMOS_SHOW_ALL_PARAMS, NULL);
  72                         break;
  73                 case 'b':
  74                         register_op(&op_found, NVRAMTOOL_OP_WRITE_CMOS_DUMP,
  75                                     optarg);
  76                         break;
  77                 case 'B':
  78                         register_op(&op_found, NVRAMTOOL_OP_READ_CMOS_DUMP,
  79                                     optarg);
  80                         break;
  81                 case 'c':
  82                         register_op(&op_found, NVRAMTOOL_OP_CMOS_CHECKSUM,
  83                                     handle_optional_arg(argc, argv));
  84                         break;
  85                 case 'C':
  86                         register_op_modifier(NVRAMTOOL_MOD_USE_CBFS_FILE,
  87                                              optarg);
  88                         break;
  89                 case 'd':
  90                         register_op(&op_found, NVRAMTOOL_OP_LBTABLE_DUMP, NULL);
  91                         break;
  92                 case 'D':
  93                         register_op_modifier(NVRAMTOOL_MOD_USE_CMOS_FILE,
  94                                              optarg);
  95                         break;
  96                 case 'e':
  97                         register_op(&op_found, NVRAMTOOL_OP_SHOW_PARAM_VALUES,
  98                                     optarg);
  99                         break;
 100                 case 'h':
 101                         register_op(&op_found, NVRAMTOOL_OP_SHOW_USAGE, NULL);
 102                         break;
 103                 case 'i':
 104                         register_op(&op_found,
 105                                     NVRAMTOOL_OP_CMOS_SET_PARAMS_STDIN, NULL);
 106                         break;
 107                 case 'l':
 108                         register_op(&op_found, NVRAMTOOL_OP_LBTABLE_SHOW_INFO,
 109                                     handle_optional_arg(argc, argv));
 110                         break;
 111                 case 'n':
 112                         register_op_modifier(NVRAMTOOL_MOD_SHOW_VALUE_ONLY,
 113                                              NULL);
 114                         break;
 115                 case 'p':
 116                         register_op(&op_found,
 117                                     NVRAMTOOL_OP_CMOS_SET_PARAMS_FILE, optarg);
 118                         break;
 119                 case 'r':
 120                         register_op(&op_found, NVRAMTOOL_OP_CMOS_SHOW_ONE_PARAM,
 121                                     optarg);
 122                         break;
 123                 case 't':
 124                         register_op_modifier(NVRAMTOOL_MOD_USE_CMOS_OPT_TABLE,
 125                                              NULL);
 126                         break;
 127                 case 'v':
 128                         register_op(&op_found, NVRAMTOOL_OP_SHOW_VERSION, NULL);
 129                         break;
 130                 case 'w':
 131                         register_op(&op_found, NVRAMTOOL_OP_CMOS_SET_ONE_PARAM,
 132                                     optarg);
 133                         break;
 134                 case 'x':
 135                         register_op(&op_found, NVRAMTOOL_OP_SHOW_CMOS_HEX_DUMP,
 136                                     NULL);
 137                         break;
 138                 case 'X':
 139                         register_op(&op_found, NVRAMTOOL_OP_SHOW_CMOS_DUMPFILE,
 140                                     optarg);
 141                         break;
 142                 case 'y':
 143                         register_op_modifier(NVRAMTOOL_MOD_USE_CMOS_LAYOUT_FILE,
 144                                              optarg);
 145                         break;
 146                 case 'Y':
 147                         register_op(&op_found, NVRAMTOOL_OP_SHOW_LAYOUT, NULL);
 148                         break;
 149                 case -1:        /* no more command line args */
 150                         break;
 151                 case '?':       /* unknown option found */
 152                 case 1: /* nonoption command line arg found */
 153                 default:
 154                         usage(stderr);
 155                         break;
 156                 }
 157         } while (c != -1);
 158
 159         if (!op_found)
 160                 usage(stderr);
 161
 162         resolve_op_modifiers();
 163         sanity_check_args();
 164 }
 165
 166 /****************************************************************************
 167  * handle_optional_arg
 168  *
 169  * Handle a command line option with an optional argument.
 170  ****************************************************************************/
 171 static char *handle_optional_arg(int argc, char *argv[])
 172 {
 173         char *arg;
 174
 175         if (optarg != NULL) {
 176                 /* optional arg is present and arg was specified as
 177                  * "-zarg" (with no whitespace between "z" and "arg"),
 178                  * where -z is the option and "arg" is the value of the
 179                  * optional arg
 180                  */
 181                 return optarg;
 182         }
 183
 184         if ((argv[optind] == NULL) || (argv[optind][0] == '-'))
 185                 return NULL;
 186
 187         arg = argv[optind];     /* optional arg is present */
 188
 189         /* This call to getopt yields the optional arg we just found,
 190          * which we want to skip.
 191          */
 192         getopt(argc, argv, getopt_string);
 193
 194         return arg;
 195 }
 196
 197 /****************************************************************************
 198  * register_op
 199  *
 200  * Store the user's selection of which operation this program should perform.
 201  ****************************************************************************/
 202 static void register_op(int *op_found, nvramtool_op_t op, char op_param[])
 203 {
 204         if (*op_found && (op != nvramtool_op.op))
 205                 usage(stderr);
 206
 207         *op_found = TRUE;
 208         nvramtool_op.op = op;
 209         nvramtool_op.param = op_param;
 210 }
 211
 212 /****************************************************************************
 213  * register_op_modifier
 214  *
 215  * Store information regarding an optional argument specified in addition to
 216  * the user's selection of which operation this program should perform.
 217  ****************************************************************************/
 218 static void register_op_modifier(nvramtool_op_modifier_t mod, char mod_param[])
 219 {
 220         static int found_seq = 0;
 221         nvramtool_op_modifier_info_t *mod_info;
 222
 223         mod_info = &nvramtool_op_modifiers[mod];
 224         mod_info->found = TRUE;
 225         mod_info->found_seq = ++found_seq;
 226         mod_info->param = mod_param;
 227 }
 228
 229 /****************************************************************************
 230  * resolve_op_modifiers
 231  *
 232  * If the user specifies multiple arguments that conflict with each other,
 233  * the last specified argument overrides previous conflicting arguments.
 234  ****************************************************************************/
 235 static void resolve_op_modifiers(void)
 236 {
 237         if (nvramtool_op_modifiers[NVRAMTOOL_MOD_USE_CMOS_LAYOUT_FILE].found &&
 238             nvramtool_op_modifiers[NVRAMTOOL_MOD_USE_CMOS_OPT_TABLE].found) {
 239                 if (nvramtool_op_modifiers[NVRAMTOOL_MOD_USE_CMOS_LAYOUT_FILE].found_seq >
 240                     nvramtool_op_modifiers[NVRAMTOOL_MOD_USE_CMOS_OPT_TABLE].found_seq)
 241                         nvramtool_op_modifiers
 242                             [NVRAMTOOL_MOD_USE_CMOS_OPT_TABLE].found = FALSE;
 243                 else
 244                         nvramtool_op_modifiers
 245                             [NVRAMTOOL_MOD_USE_CMOS_LAYOUT_FILE].found = FALSE;
 246         }
 247 }
 248
 249 /****************************************************************************
 250  * sanity_check_args
 251  *
 252  * Perform sanity checking on command line arguments.
 253  ****************************************************************************/
 254 static void sanity_check_args(void)
 255 {
 256         if ((nvramtool_op_modifiers[NVRAMTOOL_MOD_SHOW_VALUE_ONLY].found) &&
 257             (nvramtool_op.op != NVRAMTOOL_OP_CMOS_SHOW_ONE_PARAM))
 258                 usage(stderr);
 259 }