aboutsummaryrefslogtreecommitdiff
path: root/HelpMessage.txt
blob: 8ecb927b068a69c4d2ffdce8755811c8f7453b53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Usage: %ARG% OPERATION OPARGS

       OPERATION   Can be one of these: help, version, speeds, ident, erase,
                   read, write.

       OPARGS      Are arguments for selected operation. Note that the same
                   argument can have a different meaning when used with
                   different OPERATION.

Common options:
      -p PORTNAME  Name of a serial port device to use.

      -s SPEED     Serial line communication speed in Bd. Note that the
                   SPEED is a number without 'Bd' suffix. Default SPEED
                   is 19200.

      -v           Be more verbose.

      -f FREQ      CPU frequency in MHz. Real number with dot as a decimal
                   separator. This is used only by ST10F168 MCU and is
                   mandatory for it.

      -g           Print progress for read and write operations.

Operations:
    help
          Print this help message.

    version
          Print name and version information of this program.

    speeds
          Print list of serial line speeds available.

    ident
          Print name of supported MCU connected.

    erase [-b n[,n]...]
      -b n[,n]...  Numbers of sectors to erase. Without this option whole
                   FLASH memory is erased.

    read [-n COUNT] FILE
      -n COUNT     Read only COUNT bytes from address 0 instead of whole memory.

      FILE         Name of a file where to write content of memory.

    write [-e,-c] FILE
      -e           Erase whole FLASH memory before writing data. Without this
                   option only blocks which are going to be programmed are
                   erased.

      -c           Check written data by reading it back and comparing with FILE
                   data. Without this option result of write operation is
                   checked only by MCU FLASH memory controller.

      FILE         Name of a file containing data to write to MCU FLASH memory.