This patch does probably too much, but it's hard (and very cumbersome/time consuming) to break it out. What is does is this: * each command has one short description, e.g. "list MUX configuration" * made sure the short descriptions start lowercase * each command has one usage. That string contains just the options, e.g. "[-npn]". It's not part of the long help text. * that is, it doesn't say "[OPTIONS]" anymore, every usable option is listed by character in this (short) option string (the long description is in the long help text, as before) * help texts have been reworked, to make them - sometimes smaller - sometimes describe the options better - more often present themselves in a nicer format * all long help texts are now created with BUSYBOX_CMD_HELP_ macros, no more 'static const __maybe_unused char cmd_foobar_help[]' * made sure the long help texts starts uppercase * because cmdtp->name and cmdtp->opts together provide the new usage, all "Usage: foobar" texts have been removed from the long help texts * BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this is nicer in the source code * BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself * made sure no line gets longer than 77 characters * delibertely renamed cmdtp->usage, so that we can get compile-time errors (e.g. in out-of-tree modules that use register_command() * the 'help' command can now always emit the usage, even without compiled long help texts * 'help -v' gives a list of commands with their short description, this is similar like the old "help" command before my patchset * 'help -a' gives out help of all commands Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
70 lines
1.7 KiB
C
70 lines
1.7 KiB
C
/*
|
|
* (c) 2012 Juergen Beisert <kernel@pengutronix.de>
|
|
*
|
|
* 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
|
|
* (at your option) 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.
|
|
*/
|
|
|
|
#include <common.h>
|
|
#include <command.h>
|
|
#include <errno.h>
|
|
#include <linux/ctype.h>
|
|
#include <watchdog.h>
|
|
|
|
/* default timeout in [sec] */
|
|
static unsigned timeout = CONFIG_CMD_WD_DEFAULT_TIMOUT;
|
|
|
|
static int do_wd(int argc, char *argv[])
|
|
{
|
|
int rc;
|
|
|
|
if (argc > 1) {
|
|
if (isdigit(*argv[1])) {
|
|
timeout = simple_strtoul(argv[1], NULL, 0);
|
|
} else {
|
|
printf("numerical parameter expected\n");
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
rc = watchdog_set_timeout(timeout);
|
|
if (rc < 0) {
|
|
switch (rc) {
|
|
case -EINVAL:
|
|
printf("Timeout value out of range\n");
|
|
break;
|
|
case -ENOSYS:
|
|
printf("Watchdog cannot be disabled\n");
|
|
break;
|
|
default:
|
|
printf("Watchdog fails: '%s'\n", strerror(-rc));
|
|
break;
|
|
}
|
|
|
|
return 1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
BAREBOX_CMD_HELP_START(wd)
|
|
BAREBOX_CMD_HELP_TEXT("Enable the watchdog to bark in TIME seconds.")
|
|
BAREBOX_CMD_HELP_TEXT("When TIME is 0, the watchdog gets disabled,")
|
|
BAREBOX_CMD_HELP_TEXT("Without a parameter the watchdog will be re-triggered.")
|
|
BAREBOX_CMD_HELP_END
|
|
|
|
BAREBOX_CMD_START(wd)
|
|
.cmd = do_wd,
|
|
BAREBOX_CMD_DESC("enable/disable/trigger the watchdog")
|
|
BAREBOX_CMD_OPTS("[TIME]")
|
|
BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP)
|
|
BAREBOX_CMD_HELP(cmd_wd_help)
|
|
BAREBOX_CMD_END
|