fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-11-03 20:51:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

hardfault_log: add documentation

Browse Source
This commit is contained in:
Beat Küng
2017-07-14 11:57:11 +02:00
parent 488bc9d7f3
commit b32b0d9b17
1 changed files with 32 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/systemcmds/hardfault_log/hardfault_log.c
+32 -4
View File
@@ -37,6 +37,7 @@
****************************************************************************/ ****************************************************************************/
#include <px4_config.h> #include <px4_config.h>
#include <px4_module.h>
#include <nuttx/compiler.h> #include <nuttx/compiler.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
@@ -1122,6 +1123,28 @@ __EXPORT int hardfault_write(char *caller, int fd, int format, bool rearm)
return ret; return ret;
} }
static void print_usage(void)
{
PRINT_MODULE_DESCRIPTION("Hardfault utility\n"
"\n"
"Used in startup scripts to handle hardfaults\n"
);
PRINT_MODULE_USAGE_NAME("hardfault_log", "command");
PRINT_MODULE_USAGE_COMMAND_DESCR("check", "Check if there's an uncommited hardfault");
PRINT_MODULE_USAGE_COMMAND_DESCR("rearm", "Drop an uncommited hardfault");
PRINT_MODULE_USAGE_COMMAND_DESCR("fault", "Generate a hardfault (this command crashes the system :)");
PRINT_MODULE_USAGE_ARG("0|1", "Hardfault type: 0=divide by 0, 1=Assertion (default=0)", true);
PRINT_MODULE_USAGE_COMMAND_DESCR("commit",
"Write uncommited hardfault to /fs/microsd/fault_%i.txt (and rearm, but don't reset)");
PRINT_MODULE_USAGE_COMMAND_DESCR("count",
"Read the reboot counter, counts the number of reboots of an uncommited hardfault (returned as the exit code of the program)");
PRINT_MODULE_USAGE_COMMAND_DESCR("reset", "Reset the reboot counter");
}
/**************************************************************************** /****************************************************************************
* Name: hardfault_log_main * Name: hardfault_log_main
****************************************************************************/ ****************************************************************************/
@@ -1129,6 +1152,11 @@ __EXPORT int hardfault_log_main(int argc, char *argv[])
{ {
char *self = "hardfault_log"; char *self = "hardfault_log";
if (argc <= 1) {
print_usage();
return 1;
}
if (!strcmp(argv[1], "check")) { if (!strcmp(argv[1], "check")) {
return hardfault_check_status(self); return hardfault_check_status(self);
@@ -1147,20 +1175,20 @@ __EXPORT int hardfault_log_main(int argc, char *argv[])
return genfault(fault); return genfault(fault);
} else if (!strcmp(argv[1], "commit")) { } else if (!strcmp(argv[1], "commit")) {
return hardfault_commit(self); return hardfault_commit(self);
} else if (!strcmp(argv[1], "count")) { } else if (!strcmp(argv[1], "count")) {
return hardfault_increment_reboot(self, false); return hardfault_increment_reboot(self, false);
} else if (!strcmp(argv[1], "reset")) { } else if (!strcmp(argv[1], "reset")) {
return hardfault_increment_reboot(self, true); return hardfault_increment_reboot(self, true);
} }
fprintf(stderr, "unrecognised command, try 'check' ,'rearm' , 'fault', 'count', 'reset' or 'commit'\n"); print_usage();
return -EINVAL; return -EINVAL;
} }