Skip to content

Commit

Permalink
Updated a target resetting documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ant-ON
Ant-ON committed Mar 19, 2021
1 parent 125cb2d commit d9726fa
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/man/st-flash.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Print version information
TODO
.TP
--reset
TODO
Trigger a reset both before and after flashing
.TP
--opt
Enable ignore ending empty bytes optimization
Expand Down
2 changes: 1 addition & 1 deletion doc/man/st-flash.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ reset
: TODO

\--reset
: TODO
: Trigger a reset both before and after flashing

\--opt
: Enable ignore ending empty bytes optimization
Expand Down
19 changes: 10 additions & 9 deletions doc/tutorial.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

## Available tools and options

| Option | Tool | Description | Available<br />since |
| --------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| --flash=n[k][m] | st-flash | One can specify `--flash=128k` for example, to override the default value of 64k<br />for the STM32F103C8T6 to assume 128k of flash being present. This option accepts<br />decimal (128k), octal 0200k, or hex 0x80k values. Leaving the multiplier out is<br />equally valid, e.g.: `--flash=0x20000`. The size may be followed by an optional "k"<br />or "m" to multiply the given value by 1k (1024) or 1M respectively. | v1.4.0 |
| --freq=n[k][m] | st-flash | The frequency of the SWD/JTAG interface can be specified, to override the default<br />1800 kHz configuration. This option solely accepts decimal values (5K or 1.8M) with<br />the unit `Hz` being left out. Valid frequencies are: `5K, 15K, 25K, 50K, 100K,`<br />`125K, 240K, 480K, 950K, 1200K(1.2M), 1800K(1.8M), 4000K(4M)`. | v1.6.1 |
| --opt | st-flash | Optimisation can be enabled in order to skip flashing empty (0x00 or 0xff) bytes at<br />the end of binary file. This may cause some garbage data left after a flash operation.<br />This option was enabled by default in earlier releases. | v1.6.1 |
| --reset | st-flash | Trigger a reset both before and after flashing. | v1.0.0 |
| --version | st-info,<br />st-flash,<br />st-util | Print version information. | |
| --help | st-flash,<br />st-util | Print list of available commands. _(To be added to this table.)_ | |
| Option | Tool | Description | Available<br />since |
| --------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| --flash=n[k][m] | st-flash | One can specify `--flash=128k` for example, to override the default value of 64k<br />for the STM32F103C8T6 to assume 128k of flash being present. This option accepts<br />decimal (128k), octal 0200k, or hex 0x80k values. Leaving the multiplier out is<br />equally valid, e.g.: `--flash=0x20000`. The size may be followed by an optional "k"<br />or "m" to multiply the given value by 1k (1024) or 1M respectively. | v1.4.0 |
| --freq=n[k][m] | st-flash | The frequency of the SWD/JTAG interface can be specified, to override the default<br />1800 kHz configuration. This option solely accepts decimal values (5K or 1.8M) with<br />the unit `Hz` being left out. Valid frequencies are: `5K, 15K, 25K, 50K, 100K,`<br />`125K, 240K, 480K, 950K, 1200K(1.2M), 1800K(1.8M), 4000K(4M)`. | v1.6.1 |
| --opt | st-flash | Optimisation can be enabled in order to skip flashing empty (0x00 or 0xff) bytes at<br />the end of binary file. This may cause some garbage data left after a flash operation.<br />This option was enabled by default in earlier releases. | v1.6.1 |
| --reset | st-flash | Trigger a reset both before and after flashing. The default use the hardware reset<br />through `NRST` pin. The software system reset is used if the hardware reset failed <br />(`NRST` pin not connected). | v1.0.0 |
| --connect-under-reset | st-flash | Connect under reset. Option makes it possible to connect to the device before code<br />executing. This is useful when the target contains a code that go device to sleep, <br />disables of debug pins or other special code. | v1.6.1 |
| --version | st-info<br />st-flash<br />st-util | Print version information. | |
| --help | st-flash<br />st-util | Print list of available commands. _(To be added to this table.)_ | |

### st-flash: Checksum for binary files

Expand Down Expand Up @@ -272,7 +273,7 @@ In order to continue, one can use 'monitor reset' to reset the MCU.
Remember that you can shorten the commands. `tar ext :4242` is good enough
for GDB.

If you need to send a hard reset signal through `NRST` pin, you can use the following command:
If you need to send a reset signal, you can use the following command:

```
(gdb) monitor jtag_reset
Expand Down
4 changes: 2 additions & 2 deletions src/st-flash/flash.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ static void cleanup(int signum) {
}

static void usage(void) {
puts("command line: ./st-flash [--debug] [--reset] [--opt] [--serial <serial>] [--format <format>] [--flash=<fsize>] [--freq=<Hz>] [--area=<area>] {read|write} [path] [addr] [size]");
puts("command line: ./st-flash [--debug] [--freq=<Hz>] [--serial <serial>] erase");
puts("command line: ./st-flash [--debug] [--reset] [--connect-under-reset] [--opt] [--serial <serial>] [--format <format>] [--flash=<fsize>] [--freq=<Hz>] [--area=<area>] {read|write} [path] [addr] [size]");
puts("command line: ./st-flash [--debug] [--connect-under-reset] [--freq=<Hz>] [--serial <serial>] erase");
puts("command line: ./st-flash [--debug] [--freq=<Hz>] [--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)");
Expand Down

0 comments on commit d9726fa

Please sign in to comment.