Add terminal save documentation

This commit is contained in:
Stefan Rueger
2023-06-12 18:21:13 +01:00
parent 48f1fc75e9
commit bea3d099f8
2 changed files with 28 additions and 4 deletions

View File

@@ -962,7 +962,7 @@ The
.Ar addr
and
.Ar len
parameters of the dump, read, write and erase commands can be
parameters of the dump, read, write, save and erase commands can be
negative with the same syntax as substring computations in perl or python.
The table below details their meaning with respect to an example memory of size
sz=0x800.
@@ -1077,6 +1077,19 @@ and, if necessary, pads the remaining space by repeating the last
.Ar data
item. The fill write command does not write beyond the specified memory area
even if more data than needed were given.
.It Ar save memory {addr len} file[:format]
Save one or more memory segments to a file in a format specified by the
:format letter. The default is :r for raw binary. Each memory segment is
described by an address and length pair. In absence of any memory segments
the entire memory is saved to the file. Only Motorola S-Record (:s) and
Intel Hex (:i or :I) formats store address information with the saved
data.
.Nm Avrdude
cannot currently save ELF file formats. All the other file formats lose
the address information and concatenate the chosen memory segments into
the output file. If the file name is - then
.Nm
writes to stdout.
.It Ar erase
Perform a chip erase and discard all pending writes to EEPROM and flash.
Note that EEPROM will be preserved if the EESAVE fuse bit is set.

View File

@@ -1959,7 +1959,7 @@ abbreviated to the shortest unambiguous form. Terminal mode provides a
command history using readline(3), so previously entered command lines can be
recalled and edited.
The @var{addr} and @var{len} parameters of the dump, read, write, and erase
The @var{addr} and @var{len} parameters of the dump, read, write, save and erase
commands can be negative with the same syntax as substring computations in
perl or python. The table below details their meaning with respect to an
example memory of size @code{sz=0x800}.
@@ -2058,7 +2058,7 @@ Read all bytes from the specified memory, and display them (deprecated: use @cod
@item read
Can be used as an alias for dump.
@item write @var{memtype} @var{addr} @var{data[,]} @{@var{data[,]}@}
@item write @var{memtype} @var{addr} @var{data[,]} @var{@{data[,]@}}
Manually program the respective memory cells, starting at address
@var{addr}, using the data items provided. The terminal implements
reading from and writing to flash and EEPROM type memories normally
@@ -2182,12 +2182,23 @@ and paste of lists.
The start address @code{addr} may be omitted if the size of the memory
being written to is 1 byte in size.
@item write @var{memtype} @var{addr} @var{len} @var{data[,]} @{@var{data[,]}@} @dots{}
@item write @var{memtype} @var{addr} @var{len} @var{data[,]} @var{@{data[,]@}} @dots{}
The ellipsis @dots{} form writes the data to the entire memory intervall
addressed by @var{addr len} and, if necessary, pads the remaining space by
repeating the last data item. The fill write command does not write beyond
the specified memory area even if more data than needed were given.
@item save @var{memory} @var{@{addr len@}} @var{file[:format]}
Save one or more memory segments to a file in a format specified by the
@code{:}format letter. The default is @code{:r} for raw binary. Each
memory segment is described by an address and length pair. In absence of
any memory segments the entire memory is saved to the file. Only Motorola
S-Record (@code{:s}) and Intel Hex (@code{:i} or @code{:I}) formats store
address information with the saved data. Avrdude cannot currently save
ELF file formats. All the other file formats lose the address information
and concatenate the chosen memory segments into the output file. If the
file name is - then avrdude writes to stdout.
@item erase
Perform a chip erase and discard all pending writes to EEPROM and flash.
Note that EEPROM will be preserved if the EESAVE fuse bit is set.