Merge pull request #1372 from ii8/usage

Rewrite commandline usage text for st-flash tool
stlink-org · Feb 18, 2024 · 95862cc · 95862cc
2 parents 710e1d3 + 2d483db
commit 95862cc
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 20 deletions.
diff --git a/src/st-flash/flash.c b/src/st-flash/flash.c
@@ -44,40 +44,59 @@ static void cleanup(int32_t signum) {
 }
 
 static void usage(void) {
-    puts("command line:   ./st-flash [--debug] [--reset] [--connect-under-reset] [--hot-plug] [--opt] [--serial <serial>] [--format <format>] [--flash=<fsize>] [--freq=<kHz>] [--area=<area>] {read|write} [path] [addr] [size]");
-    puts("command line:   ./st-flash [--debug] [--connect-under-reset] [--hot-plug] [--freq=<kHz>] [--serial <serial>] erase [addr] [size]");
-    puts("command line:   ./st-flash [--debug] [--freq=<kHz>] [--serial <serial>] reset");
-    puts("   <addr>, <serial> and <size>: Use hex format.");
-    puts("   <fsize>: Use decimal, octal or hex (prefix 0xXXX) format, optionally followed by k=KB, or m=MB (eg. --flash=128k)");
-    puts("   <format>: Can be 'binary' (default) or 'ihex', although <addr> must be specified for binary format only.");
-    puts("   <area>: Can be 'main' (default), 'system', 'otp', 'optcr', 'optcr1', 'option' or 'option_boot_add'");
-    puts("print tool version info:   ./st-flash [--version]");
-    puts("example read option byte: ./st-flash --area=option read [path] [size]");
-    puts("example write option byte: ./st-flash --area=option write 0xXXXXXXXX");
-    puts("On selected targets:");
-    puts("example read boot_add option byte:  ./st-flash --area=option_boot_add read");
-    puts("example write boot_add option byte: ./st-flash --area=option_boot_add write 0xXXXXXXXX");
-    puts("example read option control register byte:  ./st-flash --area=optcr read");
-    puts("example write option control register1 byte:  ./st-flash --area=optcr write 0xXXXXXXXX");
-    puts("example read option control register1 byte:  ./st-flash --area=optcr1 read");
-    puts("example write option control register1 byte:  ./st-flash --area=optcr1 write 0xXXXXXXXX");
-    puts("example read OTP area:  ./st-flash --area=otp read [path]");
-    puts("example write OTP area: ./st-flash --area=otp write [path] 0xXXXXXXXX");
+    puts("usage: st-flash [options] read [file] [addr] [size]");
+    puts("       st-flash [options] write <file> [addr] [size]");
+    puts("       st-flash [options] write <value>");
+    puts("       st-flash [options] erase <addr> <size>");
+    puts("       st-flash [options] reset");
+    puts("");
+    puts("options:");
+    puts("  --freq <kHz>           Frequency of JTAG/SWD, default 1800kHz.");
+    puts("  --serial <serial>      STLink device to use.");
+    puts("  --connect-under-reset  Pull reset low while connecting.");
+    puts("  --hot-plug             Connect without reset.");
+    puts("  --reset                Reset after writing.");
+    puts("  --format {binary|ihex} Format of file to read or write. When writing");
+    puts("                         with ihex specifying addr is not needed.");
+    puts("  --flash <size>         Specify size of flash, e.g. 128k, 1M.");
+    puts("  --area <area>          Area to access, one of: main(default), system,");
+    puts("                         otp, option, option_boot_add, optcr, optcr1.");
+    puts("  --opt                  Skip writing empty bytes at the tail end.");
+    puts("  --debug                Output extra debug information.");
+    puts("  --version              Print version information.");
+    puts("  --help                 Show this help.");
+    puts("");
+    puts("examples:");
+    puts("  st-flash --area=option read [file] [size]");
+    puts("  st-flash --area=option write 0xXXXXXXXX");
+    puts("  st-flash --area=option_boot_add read");
+    puts("  st-flash --area=option_boot_add write 0xXXXXXXXX");
+    puts("  st-flash --area=optcr read");
+    puts("  st-flash --area=optcr write 0xXXXXXXXX");
+    puts("  st-flash --area=optcr1 read");
+    puts("  st-flash --area=optcr1 write 0xXXXXXXXX");
+    puts("  st-flash --area=otp read <file>");
+    puts("  st-flash --area=otp write <file> 0xXXXXXXXX");
 }
 
 int32_t main(int32_t ac, char** av) {
     stlink_t* sl = NULL;
     struct flash_opts o;
     int32_t err = -1;
     uint8_t * mem = NULL;
+    int32_t getopt_ret;
 
     o.size = 0;
     o.connect = CONNECT_NORMAL;
 
-    if (flash_get_opts(&o, ac - 1, av + 1) == -1) {
+    getopt_ret = flash_get_opts(&o, ac - 1, av + 1);
+    if (getopt_ret  == -1) {
         printf("invalid command line\n");
         usage();
         return (-1);
+    } else if (getopt_ret == 1) {
+        usage();
+        return 0;
     }
 
     printf("st-flash %s\n", STLINK_VERSION);

diff --git a/src/st-flash/flash_opts.c b/src/st-flash/flash_opts.c
@@ -98,6 +98,8 @@ int32_t flash_get_opts(struct flash_opts* o, int32_t ac, char** av) {
         if (strcmp(av[0], "--version") == 0) {
             printf("v%s\n", STLINK_VERSION);
             exit(EXIT_SUCCESS);
+        } else if (strcmp(av[0], "--help") == 0 || strcmp(av[0], "-h") == 0) {
+            return 1;
         } else if (strcmp(av[0], "--debug") == 0) {
             o->log_level = DEBUG_LOG_LEVEL;
         } else if (strcmp(av[0], "--opt") == 0) {