# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1598594173 0
# Node ID d89b72f2181b2d760125cef958e26b9aeee2761f
# Parent  6ae3ad8865f45befa5b2442c39cc885644b2859e
doc/TIFFS-IVA-usage: new decode facility documented

diff -r 6ae3ad8865f4 -r d89b72f2181b doc/TIFFS-IVA-usage
--- a/doc/TIFFS-IVA-usage	Fri Aug 28 05:30:01 2020 +0000
+++ b/doc/TIFFS-IVA-usage	Fri Aug 28 05:56:13 2020 +0000
@@ -127,6 +127,32 @@
 file system.  The sole argument is the local directory into which the root of
 the GSM device FFS should be extracted.
 
+tiffs <...> decode file-keyword [band]
+
+For some files in TIFFS doing a hex dump with tiffs cat -h (see above) is
+sufficient for easily understanding the content of the file, but for other files
+such as RF parameter tables further developer-friendly decoding is greatly
+desirable.  The generic solution is to extract the complete FFS content with
+tiffs xtr and then apply further tools for analysis, but this fully generic
+solution involves a lot of clutter.  For some TIFFS files which often need to be
+looked at and for which tiffs cat -h is insufficient, tiffs decode offers a
+shorthand.  The following files can be decoded in this way:
+
+Command					File being decoded
+----------------------------------------------------------
+tiffs <...> decode adccal		/sys/adccal
+tiffs <...> decode afcdac		/gsm/rf/afcdac
+tiffs <...> decode afcparams		/gsm/rf/afcparams
+tiffs <...> decode stdmap		/gsm/rf/stdmap
+tiffs <...> decode tx-ramps <band>	/gsm/rf/tx/ramps.<band>
+tiffs <...> decode tx-levels <band>	/gsm/rf/tx/levels.<band>
+tiffs <...> decode tx-calchan <band>	/gsm/rf/tx/calchan.<band>
+tiffs <...> decode tx-caltemp <band>	/gsm/rf/tx/caltemp.<band>
+tiffs <...> decode rx-calchan <band>	/gsm/rf/rx/calchan.<band>
+tiffs <...> decode rx-caltemp <band>	/gsm/rf/rx/caltemp.<band>
+tiffs <...> decode rx-agcparams <band>	/gsm/rf/rx/agcparams.<band>
+tiffs <...> decode pcm-IMEI		/pcm/IMEI
+
 Forensic analysis commands
 ==========================