diff doc/Target-utils @ 787:ae237e4e8d9b

doc/Target-utils: simagent addition documented
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 13 Mar 2021 23:27:58 +0000
parents 72feb9763de4
children
line wrap: on
line diff
--- a/doc/Target-utils	Sat Mar 13 22:41:33 2021 +0000
+++ b/doc/Target-utils	Sat Mar 13 23:27:58 2021 +0000
@@ -22,7 +22,8 @@
 loadagent	Flash manipulation and XRAM loading agent
 lunadrv		Driver for FreeCalypso Luna LCD
 pirexplore	Pirelli DP-L10 hardware exploration program
-simtest		Low-level exerciser for the SIM interface hardware
+simagent	SIM interface agent to be used by fc-simint and fc-simtool
+simtest		Previous low-level exerciser for the SIM interface hardware
 
 Aside from c139explore which is built as a binary to be loaded via fc-compalram
 (Compal's bootloader protocol), all of the above programs are built as S-record
@@ -170,8 +171,8 @@
 debug operations, but once implemented, this same ABB SPI communication
 infrastructure is also used in model-specific hardware exploration utilities
 for functions like keypad backlight and vibrator control which are implemented
-via the ABB on some models, and it is used in simtest to control the part of
-the SIM interface that resides in the Iota ABB.
+via the ABB on some models, and it is used in simagent and simtest to control
+the part of the SIM interface that resides in the Iota ABB.
 
 Aside from specialized programs like c139explore that are specific to target
 devices known to use the Iota ABB, most target-utils programs do not execute
@@ -179,10 +180,10 @@
 one of the ABB commands: abbinit, abbr, abbw or poweroff.  This way if someone
 comes across a Calypso device that has a different ABB type or needs to debug a
 board with broken ABB communication, one can explore other functions without
-touching ABB commands.  (simtest is another exception: even though it is not
-specific to one particular target device like c139explore, its main function of
-exercising the SIM interface depends on the Iota ABB, thus it is restricted to
-Calypso+Iota targets.)
+touching ABB commands.  (simagent and simtest constitute another exception:
+even though these programs aren't specific to one particular target device like
+c139explore, their main function of exercising the SIM interface depends on the
+Iota ABB, thus they are restricted to Calypso+Iota targets.)
 
 The abb_init() function invoked by the abbinit command may be invoked multiple
 times: it maintains an internal flag remembering if the initialization steps