[cmdline] Add "params" and "param" commands to manage form parameter …

…lists Signed-off-by: Michael Brown <mcb30@ipxe.org>
ipxe · Aug 19, 2013 · 430c3fb · 430c3fb
1 parent 564419c
commit 430c3fb
Show file tree

Hide file tree

Showing 4 changed files with 167 additions and 0 deletions.
diff --git a/src/config/config.c b/src/config/config.c
@@ -263,6 +263,9 @@ REQUIRE_OBJECT ( nslookup_cmd );
 #ifdef PCI_CMD
 REQUIRE_OBJECT ( pci_cmd );
 #endif
+#ifdef PARAM_CMD
+REQUIRE_OBJECT ( param_cmd );
+#endif
 
 /*
  * Drag in miscellaneous objects

diff --git a/src/config/general.h b/src/config/general.h
@@ -130,6 +130,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 //#define POWEROFF_CMD		/* Power off command */
 //#define IMAGE_TRUST_CMD	/* Image trust management commands */
 //#define PCI_CMD		/* PCI commands */
+//#define PARAM_CMD		/* Form parameter commands */
 
 /*
  * ROM-specific options

diff --git a/src/hci/commands/param_cmd.c b/src/hci/commands/param_cmd.c
@@ -0,0 +1,162 @@
+/*
+ * Copyright (C) 2013 Michael Brown <mbrown@fensystems.co.uk>.
+ *
+ * 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 any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+/** @file
+ *
+ * Form parameter commands
+ *
+ */
+
+#include <stdlib.h>
+#include <errno.h>
+#include <getopt.h>
+#include <ipxe/params.h>
+#include <ipxe/parseopt.h>
+#include <ipxe/command.h>
+
+/** "params" options */
+struct params_options {
+	/** Name */
+	char *name;
+	/** Delete */
+	int delete;
+};
+
+/** "params" option list */
+static struct option_descriptor params_opts[] = {
+	OPTION_DESC ( "name", 'n', required_argument,
+		      struct params_options, name, parse_string ),
+	OPTION_DESC ( "delete", 'd', no_argument,
+		      struct params_options, delete, parse_flag ),
+};
+
+/** "params" command descriptor */
+static struct command_descriptor params_cmd =
+	COMMAND_DESC ( struct params_options, params_opts, 0, 0,
+		       "[--name <name>] [--delete]" );
+
+/**
+ * The "params" command
+ *
+ * @v argc		Argument count
+ * @v argv		Argument list
+ * @ret rc		Return status code
+ */
+static int params_exec ( int argc, char **argv ) {
+	struct params_options opts;
+	struct parameters *params;
+	int rc;
+
+	/* Parse options */
+	if ( ( rc = parse_options ( argc, argv, &params_cmd, &opts ) ) != 0)
+		return rc;
+
+	/* Create parameter list */
+	params = create_parameters ( opts.name );
+	if ( ! params )
+		return -ENOMEM;
+
+	/* Destroy parameter list, if applicable */
+	if ( opts.delete )
+		destroy_parameters ( params );
+
+	return 0;
+}
+
+/** "param" options */
+struct param_options {
+	/** Parameter list name */
+	char *params;
+};
+
+/** "param" option list */
+static struct option_descriptor param_opts[] = {
+	OPTION_DESC ( "params", 'p', required_argument,
+		      struct param_options, params, parse_string ),
+};
+
+/** "param" command descriptor */
+static struct command_descriptor param_cmd =
+	COMMAND_DESC ( struct param_options, param_opts, 1, MAX_ARGUMENTS,
+		       "[--params <params>] <key> [<value>]" );
+
+/**
+ * The "param" command
+ *
+ * @v argc		Argument count
+ * @v argv		Argument list
+ * @ret rc		Return status code
+ */
+static int param_exec ( int argc, char **argv ) {
+	struct param_options opts;
+	char *key;
+	char *value;
+	struct parameters *params;
+	struct parameter *param;
+	int rc;
+
+	/* Parse options */
+	if ( ( rc = parse_options ( argc, argv, &param_cmd, &opts ) ) != 0 )
+		goto err_parse_options;
+
+	/* Parse key */
+	key = argv[optind];
+
+	/* Parse value */
+	value = concat_args ( &argv[ optind + 1 ] );
+	if ( ! value ) {
+		rc = -ENOMEM;
+		goto err_parse_value;
+	}
+
+	/* Identify parameter list */
+	if ( ( rc = parse_parameters ( opts.params, &params ) ) != 0 )
+		goto err_parse_parameters;
+
+	/* Add parameter */
+	param = add_parameter ( params, key, value );
+	if ( ! param ) {
+		rc = -ENOMEM;
+		goto err_add_parameter;
+	}
+
+	/* Success */
+	rc = 0;
+
+ err_add_parameter:
+ err_parse_parameters:
+	free ( value );
+ err_parse_value:
+ err_parse_options:
+	return rc;
+}
+
+/** Form parameter commands */
+struct command param_commands[] __command = {
+	{
+		.name = "params",
+		.exec = params_exec,
+	},
+	{
+		.name = "param",
+		.exec = param_exec,
+	},
+};
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
@@ -286,6 +286,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define ERRFILE_pci_settings	      ( ERRFILE_OTHER | 0x003d0000 )
 #define ERRFILE_efi_reboot	      ( ERRFILE_OTHER | 0x003e0000 )
 #define ERRFILE_memmap_settings	      ( ERRFILE_OTHER | 0x003f0000 )
+#define ERRFILE_param_cmd	      ( ERRFILE_OTHER | 0x00400000 )
 
 /** @} */