# HG changeset patch
# User Mychaela Falconia <falcon@freecalypso.org>
# Date 1511326169 0
# Node ID 158fef5f4b8277e89b469370df9bef204163b522
# Parent  6a254cc6a7f326bbaced20ab40f5b12b09120c18
doc/RF_tables: updated for the newly implemented more complete support

diff -r 6a254cc6a7f3 -r 158fef5f4b82 doc/RF_tables
--- a/doc/RF_tables	Wed Nov 22 04:47:36 2017 +0000
+++ b/doc/RF_tables	Wed Nov 22 04:49:29 2017 +0000
@@ -45,16 +45,20 @@
   packets.  Our implementation of the rftw command takes the table data input
   in the form of ASCII text files in our format, and the tables read back from
   the fw via the rftr command can be written out into host files in the same
-  format.
+  format with the save-rf-table command.
 
 * RF tables that have been saved in the non-volatile FFS can be read out
   "in vivo" via fc-fsio or "in vitro" from a raw flash dump via tiffs.  They
   are in the firmware's native binary format.  Our fc-cal2text utility can be
   used to convert these binary files into our adopted text format for easier
-  analysis.  The conversion is lossless, but we do not currently have a utility
-  to perform the opposite conversion, as there does not appear to be a use case
-  for it.  If such a use case does arise, it will be easy to construct the
-  appropriate tool(s).
+  analysis.  The conversion is lossless.
+
+* Any RF table in our ASCII format can be converted back into the corresponding
+  native binary with our fc-cal2bin utility.
+
+* Each RF table type for which there is a directly corresponding file in FFS
+  can be uploaded into the FFS of a FreeCalypso GSM device directly from our
+  ASCII format with the fc-fsio utility's upload-rf-table command.
 
 In the case of two particular RF tables there is a slight difference between
 the way they are stored in FFS and the way they are read and written via Test
@@ -76,8 +80,14 @@
   dedicated TX_TEMPLATE_WRITE (ttw) and TX_TEMPLATE_READ (ttr) commands which
   write or read one 32-byte template at a time.
 
-The ASCII text file representation of the RF tables adopted in FreeCalypso
-follows the Test Mode protocol model where it deviates from the FFS model:
-fc-cal2text turns the /gsm/rf/tx/ramps.* file for each band into 16 individual
-ramp files, and if there is a /gsm/rf/rx/il2agc file, it will be turned into
-three separate il2agc-av, il2agc-max and il2agc-pwr table files.
+Our FreeCalypso ASCII RF table format includes support for a table of type
+tx-ramps; these ramps tables can be written by fc-cal2text, converted back to
+native binary with fc-cal2bin and uploaded with fc-fsio's upload-rf-table
+command, but cannot be uploaded with fc-tmsh's rftw command corresponding to
+the RF_TABLE_WRITE Test Mode command.  There is also an ASCII format for a
+single Tx ramp template that can be uploaded with the ttw command; templates
+read back via the ttr command can be saved in the same format with the
+save-tx-ramp command.
+
+In the case of the il2agc table, a FreeCalypso ASCII RF table of type il2agc is
+singular as in the Test Mode protocal, not triple as in FFS.