# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1583646402 0
# Node ID 8b1e86dcc3ac79db59c8717153988b9bf25ccbc6
# Parent  135de08c5d7426c448de4dbadb6ef39f3a72c32e
loadtool.help: new flash e-program-* commands documented

diff -r 135de08c5d74 -r 8b1e86dcc3ac loadtools/loadtool.help
--- a/loadtools/loadtool.help	Sun Mar 08 04:18:30 2020 +0000
+++ b/loadtools/loadtool.help	Sun Mar 08 05:46:42 2020 +0000
@@ -160,6 +160,9 @@
 flash program-bin	Program flash with a binary file
 flash program-m0	Program flash with an image in TI's *.m0 format
 flash program-srec	Program flash with an image in standard S-record format
+flash e-program-bin	Combined erase and program-bin
+flash e-program-m0	Combined erase and program-m0
+flash e-program-srec	Combined erase and program-srec
 flash quickprog		Program a few flash words from the command line
 flash reset		Reset flash chip to read array mode
 flash sectors		Display the list of flash sector addresses and sizes
@@ -284,6 +287,9 @@
 Because each S-record contains an address, no addresses or offsets need to be
 specified in the flash[2] program-m0 command, only the image file.
 
+This command does NOT include a built-in flash erase step - see
+help flash e-program-m0 for the more complete version.
+
 === flash:program-srec
 flash[2] program-srec image.srec
 
@@ -296,6 +302,36 @@
 Because each S-record contains an address, no addresses or offsets need to be
 specified in the flash[2] program-srec command, only the image file.
 
+=== flash:e-program-bin
+flash[2] e-program-bin flash-offset binfile [file-offset [length]]
+
+This command is an extension of flash[2] program-bin: it first erases the range
+of sectors that contains the range of flash words to be programmed, then
+executes the program-bin operation.  All arguments are exactly the same as for
+flash[2] program-bin - see help flash program-bin.  The range of sectors that
+will be erased will be the minimal set that contains the area of flash to be
+programmed.  This command is intended for automated (no thinking required)
+flashing of firmware release images that are delivered in binary format; only
+flash-offset and binfile arguments will be given in this case.
+
+=== flash:e-program-m0
+flash[2] e-program-m0 image.m0
+
+This command reads in the specified S-record image in moko-style m0 format,
+builds a map of potentially discontiguous flash regions into which the image
+deposits bits, erases the set of flash sectors which need to be erased before
+programming these regions, then programs the new image bits into flash.  This
+command is intended for automated (no thinking required) flashing of firmware
+release images that are delivered in moko-style m0 format.
+
+=== flash:e-program-srec
+flash[2] e-program-srec image.srec
+
+This command works like flash[2] e-program-m0, but takes in an S-record image
+in little-endian byte order, which is the opposite byte order from that used by
+TI's *.m0 files.  This command is provided only for the sake of symmetry - no
+practical use case is envisioned.
+
 === flash:quickprog
 flash[2] quickprog hex-offset hex-data-string