[MTD] UBI: Adaptations to new driver, reworked frontend

1 files changed, 246 insertions, 159 deletions

diff --git a/ubi-utils/src/ubimkvol.c b/ubi-utils/src/ubimkvol.c
index 30c569c..d35d2f3 100644
--- a/ubi-utils/src/ubimkvol.c
+++ b/ubi-utils/src/ubimkvol.c
@@ -19,13 +19,16 @@
 /*
  * An utility to create UBI volumes.
  *
- * Author: Artem B. Bityutskiy <dedekind@oktetlabs.ru>
+ * Author: Artem B. Bityutskiy <dedekind@linutronix.de>
+ *         Frank Haverkamp <haver@vnet.ibm.com>
  *
  * 1.0 Initial release
  * 1.1 Does not support erase blocks anymore. This is replaced by
  *     the number of bytes.
+ * 1.2 Reworked the user-interface to use argp.
  */
 
+#include <argp.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <getopt.h>
@@ -33,178 +36,229 @@
 #include <string.h>
 #include <errno.h>
 
-#include "config.h"
+#include <config.h>
 #include <libubi.h>
 
-static void usage(void);
-static int param_sanity_check(ubi_lib_t lib);
-static int parse_options(int argc, char * const argv[]);
+#define VERSION "1.2"
 
 /*
- * The variables below  are set by command line arguments.
+ * The variables below	are set by command line arguments.
  */
-static int vol_type = UBI_DYNAMIC_VOLUME;
-static int devn = -1;
-static long long bytes = 0;
-static int alignment = 1;
-static int vol_id = UBI_VOL_NUM_AUTO;
-static char *name = NULL;
-static int nlen = 0;
+struct args {
+	int devn;
+	int vol_id;
+	int vol_type;
+	long long bytes;
+	int alignment;
+	char *name;
+	int nlen;
 
-int main(int argc, char * const argv[])
-{
-	int err;
-	ubi_lib_t lib;
+	/* special stuff needed to get additional arguments */
+	char *arg1;
+	char **options;		/* [STRING...] */
+};
 
-	err = parse_options(argc, argv);
-	if (err) {
-		fprintf(stderr, "Wrong options ...\n");
-		return err == 1 ? 0 : -1;
-	}
+static struct args myargs = {
+	.vol_type = UBI_DYNAMIC_VOLUME,
+	.devn = -1,
+	.bytes = 0,
+	.alignment = 1,
+	.vol_id = UBI_VOL_NUM_AUTO,
+	.name = NULL,
+	.nlen = 0,
+};
 
-	if (devn == -1) {
-		fprintf(stderr, "Device number was not specified\n");
-		fprintf(stderr, "Use -h option for help\n");
-		return -1;
-	}
+static int param_sanity_check(struct args *args, ubi_lib_t lib);
+static error_t parse_opt(int key, char *optarg, struct argp_state *state);
+const char *argp_program_bug_address = PACKAGE_BUGREPORT;
 
-	err = ubi_open(&lib);
-	if (err) {
-		perror("Cannot open libubi");
-		return -1;
-	}
+static char doc[] = "\nVersion: " VERSION "\n\t"
+	BUILD_OS" "BUILD_CPU" at "__DATE__" "__TIME__"\n"
+	"\nMake UBI Volume.\n";
 
-	err = param_sanity_check(lib);
-	if (err) {
-		perror("Input parameters check");
-		fprintf(stderr, "Use -h option for help\n");
-		goto out_libubi;
-	}
+static struct argp_option options[] = {
+	{ .name = "devn",
+	  .key = 'd',
+	  .arg = "<devn>",
+	  .flags = 0,
+	  .doc = "UBI device",
+	  .group = OPTION_ARG_OPTIONAL },
 
-	err = ubi_mkvol(lib, devn, vol_id, vol_type, bytes, alignment, name);
-	if (err < 0) {
-		perror("Cannot create volume");
-		fprintf(stderr, "  err=%d\n", err);
-		goto out_libubi;
-	}
+	{ .name = "vol_id",
+	  .key = 'n',
+	  .arg = "<volume id>",
+	  .flags = 0,
+	  .doc = "UBI volume id, if not specified, the volume ID will be "
+		 "assigned automatically",
+	  .group = OPTION_ARG_OPTIONAL },
 
-	/* printf("Created volume %d, %lld bytes, type %s, name %s\n",
-	   vol_id, bytes, vol_type == UBI_DYNAMIC_VOLUME ?
-	   "dynamic" : "static", name); */
+	{ .name = "type",
+	  .key = 't',
+	  .arg = "<static|dynamic>",
+	  .flags = 0,
+	  .doc = "volume type (dynamic, static), default is dynamic",
+	  .group = OPTION_ARG_OPTIONAL },
 
-	vol_id = err;
-	ubi_close(&lib);
-	return 0;
+	{ .name = "size",
+	  .key = 's',
+	  .arg = "<bytes>",
+	  .flags = 0,
+	  .doc = "volume size volume size in bytes, "
+	  "kilobytes (KiB) or megabytes (MiB)",
+	  .group = OPTION_ARG_OPTIONAL },
 
-out_libubi:
-	ubi_close(&lib);
-	return -1;
-}
+	{ .name = "name",
+	  .key = 'N',
+	  .arg = "<name>",
+	  .flags = 0,
+	  .doc = "volume name",
+	  .group = OPTION_ARG_OPTIONAL },
+
+	{ .name = "alignment",
+	  .key = 'a',
+	  .arg = "<alignment>",
+	  .flags = 0,
+	  .doc = "volume alignment (default is 1)",
+	  .group = OPTION_ARG_OPTIONAL },
 
-/* 'getopt()' option string */
-static const char *optstring = "ht:s:n:N:d:a:";
+	{ .name = NULL, .key = 0, .arg = NULL, .flags = 0,
+	  .doc = NULL, .group = 0 },
+};
 
-static int parse_options(int argc, char * const argv[])
+static struct argp argp = {
+	.options = options,
+	.parser = parse_opt,
+	.args_doc = 0,
+	.doc =	doc,
+	.children = NULL,
+	.help_filter = NULL,
+	.argp_domain = NULL,
+};
+
+/*
+ * @brief Parse the arguments passed into the test case.
+ *
+ * @param key		 The parameter.
+ * @param arg		 Argument passed to parameter.
+ * @param state		 Location to put information on parameters.
+ *
+ * @return error
+ *
+ * Get the `input' argument from `argp_parse', which we know is a
+ * pointer to our arguments structure.
+ */
+static error_t
+parse_opt(int key, char *optarg, struct argp_state *state)
 {
-	int opt = 0;
-
-	while (opt != -1) {
-		char *endp;
-
-		opt = getopt(argc, argv, optstring);
-
-		switch (opt) {
-		case 'h':
-			usage();
-			return 1;
-		case 't':
-			if (!strcmp(optarg, "dynamic"))
-				vol_type = UBI_DYNAMIC_VOLUME;
-			else if (!strcmp(optarg, "static"))
-				vol_type = UBI_STATIC_VOLUME;
-			else {
-				fprintf(stderr, "Bad volume type: \"%s\"\n",
-					optarg);
-				goto out;
-			}
-			break;
-		case 's':
-			bytes = strtoull(optarg, &endp, 0);
-			if (endp == optarg || bytes < 0) {
-				fprintf(stderr, "Bad volume size: \"%s\"\n",
-					optarg);
-				goto out;
-			}
-			if (endp != '\0') {
-				if (strcmp(endp, "KiB") == 0)
-					bytes *= 1024;
-				else if (strcmp(endp, "MiB") == 0)
-					bytes *= 1024*1024;
-			}
-			break;
-		case 'a':
-			alignment = strtoul(optarg, &endp, 0);
-			if (*endp != '\0' || endp == optarg ||
-			    alignment <= 0) {
-				fprintf(stderr, "Bad volume alignment: "
-					"\"%s\"\n", optarg);
-				goto out;
-			}
-			break;
-		case 'd':
-			devn = strtoul(optarg, &endp, 0);
-			if (*endp != '\0' || endp == optarg || devn < 0) {
-				fprintf(stderr, "Bad UBI device number: "
-					"\"%s\"\n", optarg);
-				goto out;
-			}
-			break;
-		case 'n':
-			vol_id = strtoul(optarg, &endp, 0);
-			if (*endp != '\0' || endp == optarg ||
-			    (vol_id < 0 && vol_id != UBI_DYNAMIC_VOLUME)) {
-				fprintf(stderr, "Bad volume ID: "
-					"\"%s\"\n", optarg);
-				goto out;
-			}
-			break;
-		case 'N':
-			name = optarg;
-			nlen = strlen(name);
-			break;
-
-		case ':':
-			fprintf(stderr, "Parameter is missing\n");
+	char *endp;
+	struct args *args = state->input;
+
+	switch (key) {
+	case 't':
+		if (!strcmp(optarg, "dynamic"))
+			args->vol_type = UBI_DYNAMIC_VOLUME;
+		else if (!strcmp(optarg, "static"))
+			args->vol_type = UBI_STATIC_VOLUME;
+		else {
+			fprintf(stderr, "Bad volume type: \"%s\"\n",
+				optarg);
 			goto out;
-		case '?':
-			fprintf(stderr, "Unknown parameter\n");
+		}
+		break;
+	case 's':
+		args->bytes = strtoull(optarg, &endp, 0);
+		if (endp == optarg || args->bytes < 0) {
+			fprintf(stderr, "Bad volume size: \"%s\"\n",
+				optarg);
 			goto out;
-		case -1:
-			break;
-		default:
-			fprintf(stderr, "Internal error\n");
+		}
+		if (endp != '\0') {
+			if (strcmp(endp, "KiB") == 0)
+				args->bytes *= 1024;
+			else if (strcmp(endp, "MiB") == 0)
+				args->bytes *= 1024*1024;
+		}
+		break;
+	case 'a':
+		args->alignment = strtoul(optarg, &endp, 0);
+		if (*endp != '\0' || endp == optarg ||
+		    args->alignment <= 0) {
+			fprintf(stderr, "Bad volume alignment: "
+				"\"%s\"\n", optarg);
 			goto out;
 		}
+		break;
+	case 'd': /* --devn=<device number> */
+		args->devn = strtoul(optarg, &endp, 0);
+		if (*endp != '\0' || endp == optarg || args->devn < 0) {
+			fprintf(stderr, "Bad UBI device number: "
+				"\"%s\"\n", optarg);
+			goto out;
+		}
+		break;
+	case 'n': /* --volid=<volume id> */
+		args->vol_id = strtoul(optarg, &endp, 0);
+		if (*endp != '\0' || endp == optarg ||
+		    (args->vol_id < 0 && args->vol_id != UBI_DYNAMIC_VOLUME)) {
+			fprintf(stderr, "Bad volume ID: "
+				"\"%s\"\n", optarg);
+			goto out;
+		}
+		break;
+	case 'N':
+		args->name = optarg;
+		args->nlen = strlen(args->name);
+		break;
+
+	case ':':
+		fprintf(stderr, "Parameter is missing\n");
+		goto out;
+
+	case ARGP_KEY_NO_ARGS:
+		/* argp_usage(state); */
+		break;
+
+	case ARGP_KEY_ARG:
+		args->arg1 = optarg;
+		/* Now we consume all the rest of the arguments.
+		   `state->next' is the index in `state->argv' of the
+		   next argument to be parsed, which is the first STRING
+		   we're interested in, so we can just use
+		   `&state->argv[state->next]' as the value for
+		   arguments->strings.
+
+		   _In addition_, by setting `state->next' to the end
+		   of the arguments, we can force argp to stop parsing
+		   here and return. */
+
+		args->options = &state->argv[state->next];
+		state->next = state->argc;
+		break;
+
+	case ARGP_KEY_END:
+		/* argp_usage(state); */
+		break;
+
+	default:
+		return(ARGP_ERR_UNKNOWN);
 	}
 
 	return 0;
-
  out:
-	errno = EINVAL;
-	return -1;
+	return(ARGP_ERR_UNKNOWN);
 }
 
-static int param_sanity_check(ubi_lib_t lib)
+static int param_sanity_check(struct args *args, ubi_lib_t lib)
 {
 	int err, len;
 	struct ubi_info ubi;
 
-	if (bytes == 0) {
+	if (args->bytes == 0) {
 		fprintf(stderr, "Volume size was not specified\n");
 		goto out;
 	}
 
-	if (name == NULL) {
+	if (args->name == NULL) {
 		fprintf(stderr, "Volume name was not specified\n");
 		goto out;
 	}
@@ -213,39 +267,72 @@ static int param_sanity_check(ubi_lib_t lib)
 	if (err)
 		return -1;
 
-	if (devn >= (int)ubi.dev_count) {
-		fprintf(stderr, "Device %d does not exist\n", devn);
+	if (args->devn >= (int)ubi.dev_count) {
+		fprintf(stderr, "Device %d does not exist\n", args->devn);
 		goto out;
 	}
 
-	len = strlen(name);
-	if (len > (int)ubi.nlen_max) {
+	len = strlen(args->name);
+	if (len > UBI_MAX_VOLUME_NAME) {
 		fprintf(stderr, "Too long name (%d symbols), max is %d\n",
-			len, ubi.nlen_max);
+			len, UBI_MAX_VOLUME_NAME);
 		goto out;
 	}
 
 	return 0;
-
 out:
 	errno = EINVAL;
 	return -1;
 }
 
-static void usage(void)
+int main(int argc, char * const argv[])
 {
-	printf("Usage: ubi_mkvol OPTIONS\n"
-	       "Version: " PACKAGE_VERSION "\n"
-	       "The command line options:\n"
-	       "\t-h - this help message\n"
-	       "\t-d - UBI device number\n"
-	       "\t-t TYPE  - volume type (dynamic, static) "
-	       "(default is dynamic)\n"
-	       "\t-n VOLID - volume ID to assign to the new volume. If not"
-	       "specified, \n"
-	       "\t           the volume ID will be assigned automatically\n"
-	       "\t-s BYTES - volume size in bytes, "
-	       "kilobytes (KiB) or megabytes (MiB)\n"
-	       "\t-N NAME  - volume name\n"
-	       "\t-a ALIGNMENT - volume alignment (default is 1)\n");
+	int err;
+	ubi_lib_t lib;
+
+	err = argp_parse(&argp, argc, (char **)argv, ARGP_IN_ORDER, 0,
+			 &myargs);
+	if (err) {
+		fprintf(stderr, "Wrong options ...\n");
+		return err == 1 ? 0 : -1;
+	}
+
+	if (myargs.devn == -1) {
+		fprintf(stderr, "Device number was not specified\n");
+		fprintf(stderr, "Use -h option for help\n");
+		return -1;
+	}
+
+	err = ubi_open(&lib);
+	if (err) {
+		perror("Cannot open libubi");
+		return -1;
+	}
+
+	err = param_sanity_check(&myargs, lib);
+	if (err) {
+		perror("Input parameters check");
+		fprintf(stderr, "Use -h option for help\n");
+		goto out_libubi;
+	}
+
+	err = ubi_mkvol(lib, myargs.devn, myargs.vol_id, myargs.vol_type,
+			myargs.bytes, myargs.alignment, myargs.name);
+	if (err < 0) {
+		perror("Cannot create volume");
+		fprintf(stderr, "  err=%d\n", err);
+		goto out_libubi;
+	}
+
+	/* printf("Created volume %d, %lld bytes, type %s, name %s\n",
+	   vol_id, bytes, vol_type == UBI_DYNAMIC_VOLUME ?
+	   "dynamic" : "static", name); */
+
+	myargs.vol_id = err;
+	ubi_close(&lib);
+	return 0;
+
+out_libubi:
+	ubi_close(&lib);
+	return -1;
 }