# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1686439244 0
# Node ID 2299f1ebbfd2d0ecdbef1c870301488b9a35ed20
# Parent  c8ad6188b9eda2d6e558944f8844c2792ec82907
c139-gen-fc-* shell scripts: add explanatory comments

diff -r c8ad6188b9ed -r 2299f1ebbfd2 sh/c139-gen-fc-ffs-img
--- a/sh/c139-gen-fc-ffs-img	Sat Jun 10 08:16:10 2023 +0000
+++ b/sh/c139-gen-fc-ffs-img	Sat Jun 10 23:20:44 2023 +0000
@@ -1,5 +1,13 @@
 #!/bin/sh
 
+# This shell script generates an fc-ffs.bin image specifically for FreeCalypso
+# on C139.  It contains hard-coded FFS geometry of 64x7 (correct for 4 MiB
+# flash only, FC Tourmaline), and it invokes c139-gen-fc-ffs-tree script to
+# populate the FFS content.  The latter script is intended to be C139-specific:
+# it uses aud-c139 audio mode config files, and in the future it will also
+# populate PWT buzzer melodies that aren't applicable to other C1xx targets
+# (too small FFS on C11x and no buzzer on C155).
+
 if [ $# != 2 ]
 then
 	echo "usage: $0 rfbin-dir imei-file" 1>&2
diff -r c8ad6188b9ed -r 2299f1ebbfd2 sh/c139-gen-fc-ffs-tree
--- a/sh/c139-gen-fc-ffs-tree	Sat Jun 10 08:16:10 2023 +0000
+++ b/sh/c139-gen-fc-ffs-tree	Sat Jun 10 23:20:44 2023 +0000
@@ -1,5 +1,10 @@
 #!/bin/sh
 
+# This shell script is officially intended to be C139-specific, but it is
+# currently used for all C1xx models.  This script uses aud-c139 audio mode
+# config files, but we don't have a different set of these files for other
+# C1xx models, and this aspect of the hw is likely to be the same anyway.
+
 if [ $# != 3 ]
 then
 	echo "usage: $0 rfbin-dir imei-file output-dir" 1>&2
diff -r c8ad6188b9ed -r 2299f1ebbfd2 sh/c139-gen-fc-script
--- a/sh/c139-gen-fc-script	Sat Jun 10 08:16:10 2023 +0000
+++ b/sh/c139-gen-fc-script	Sat Jun 10 23:20:44 2023 +0000
@@ -1,5 +1,12 @@
 #!/bin/sh
 
+# This shell script generates the set of files needed for reflashing a Motorola
+# C139/140 phone to FreeCalypso: it invokes c139-gen-fc-ffs-img to generate
+# fc-ffs.bin (customized FFS image containing IMEI and extracted factory RF
+# calibration values specific to your particular phone), and the present script
+# then generates a command script for fc-loadtool that flashes everything
+# in one go.
+
 if [ $# != 1 ]
 then
 	echo "usage: $0 fwimage.bin" 1>&2