diff doc/Host-tools-overview @ 23:10b71f01f4ff

doc/Host-tools-overview updated for the current state of the tools
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 22 Oct 2016 17:16:21 +0000
parents e7502631a0f9
children 3c446058b5a6
line wrap: on
line diff
--- a/doc/Host-tools-overview	Sat Oct 22 16:21:22 2016 +0000
+++ b/doc/Host-tools-overview	Sat Oct 22 17:16:21 2016 +0000
@@ -56,14 +56,10 @@
 		and pirffs are convenience wrappers for the common FFS
 		configurations from Openmoko and Pirelli.
 
-fc-getpirimei	This utility retrieves the factory-programmed IMEI of a Pirelli
-		DP-L10 phone by quering its running firmware over the RVTMUX
-		interface.
-
 fc-serterm	This tool is a trivial serial terminal program.  Its special
-		feature is that any output coming the serial port that isn't
-		printable ASCII is displayed as by cat -v.  It is useful for
-		talking to serially-interfaced devices that mix ASCII with
+		feature is that any output coming from the serial port that
+		isn't printable ASCII is displayed as by cat -v.  It is useful
+		for talking to serially-interfaced devices that mix ASCII with
 		binary in their serial talk.
 
 The following tools are really just for developers:
@@ -98,7 +94,8 @@
 
 fc-olddump	This tool captures a memory dump from a GSM device whose
 		firmware implements the old non-enhanced Test Mode memory read
-		command.  It works with Mot C1xx original firmwares.
+		command.  It works with TCS211-based firmwares including
+		FreeCalypso Magnetite, as well as Mot C1xx original firmwares.
 
 fc-rgbconv	A simple aid for phone UI development that converts RGB color
 		values between human-intuitive 8:8:8 format and the 5:6:5 format
@@ -119,7 +116,14 @@
 		this fc-lcdemu utility is a plug-in for rvinterf that actually
 		displays these LCD blits in an X11 window.
 
-fc-pirhackinit	This fc-pirhackinit utility is highly specific to the
-		TCS211-on-Pirelli exercise.  DO NOT run it against Pirelli's
-		stock firmware, nor is it needed when using our full-source
-		FreeCalypso firmware.
+fc-fr2tch	This hack-utility converts a GSM 06.10 speech sample from the
+		de facto standard libgsm format (which can be recorded with
+		standard tools like SoX) into an uplink play file that can be
+		played with the tch play command in fc-shell; see the
+		TCH-bit-access article for more information.
+
+fc-tch2fr	This hack-utility takes a TCH downlink recording produced with
+		the tch record command in fc-shell and converts it to a playable
+		libgsm file which will most likely contain some garbage by
+		disregarding the non-understood DSP status words; see the
+		TCH-bit-access article for more information.