# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1591464973 0
# Node ID e78c7ab3b0e69514d6a5d299eb25c4914fc49900
# Parent  cf7bd5e705edcd6bb848f14c9a1ee182efcafe8d
loadtool.help: flash prot-reg and flash compal-imei additions documented

diff -r cf7bd5e705ed -r e78c7ab3b0e6 loadtools/loadtool.help
--- a/loadtools/loadtool.help	Fri Jun 05 07:54:33 2020 +0000
+++ b/loadtools/loadtool.help	Sat Jun 06 17:36:13 2020 +0000
@@ -163,14 +163,16 @@
 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 prot-reg		Read Intel flash OTP protection register
 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
 flash status		Intel-style flash only: read Status Register
 flash unlock		Intel-style flash only: unlock flash sectors
 
-Additional operation for Compal targets only:
+Additional operations for Compal targets only:
 
+flash compal-imei		Read IMEI from OTP protection register
 flash erase-program-boot	Erase and reprogram the boot sector
 
 Substitute flash2 instead of flash when operating on the 2nd flash chip select
@@ -185,6 +187,17 @@
 Reports whether the checked region is blank or not.  Flash must be blank (FF in
 all bytes) before it can be programmed.
 
+=== flash:compal-imei
+flash compal-imei		Display the Compal phone's IMEI
+flash compal-imei <filename>	Display the Compal phone's IMEI, and also
+				save it in the named file
+
+Compal phones have their factory IMEI stored in the flash chip's OTP protection
+register.  This command reads the Intel flash protection register, checks its
+content for an IMEI formatted in Compal's particular way, and if a valid-looking
+IMEI is found, it is displayed on the terminal.  The extracted IMEI can also be
+saved into a text file.
+
 === flash:dump2bin
 flash[2] dump2bin outfile [offset [length]]
 
@@ -332,6 +345,12 @@
 TI's *.m0 files.  This command is provided only for the sake of symmetry - no
 practical use case is envisioned.
 
+=== flash:prot-reg
+This command is only applicable to Intel-style flash chips.  These flash chips
+have an OTP (one time programmable, then physically immutable afterward) area
+called "protection register"; this command reads the flash chip's protection
+register and displays its content as in lock word, factory words and user words.
+
 === flash:quickprog
 flash[2] quickprog hex-offset hex-data-string