changeset 51:0299c16f2ab1

README: update for current state
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 21 Mar 2021 08:25:48 +0000
parents d73fddc64485
children 0fec41a10131
files README
diffstat 1 files changed, 16 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/README	Sun Mar 21 06:42:29 2021 +0000
+++ b/README	Sun Mar 21 08:25:48 2021 +0000
@@ -3,15 +3,8 @@
 previously maintained in freecalypso-hwlab and fc-pcsc-tools Hg repositories
 are now deprecated and no longer maintained.
 
-The present version has been refactored to allow other card communication back
-ends besides libpcsclite: the tools can now operate on SIM cards that sit inside
-Calypso phones or development boards (the necessary simagent back end lives in
-the freecalypso-tools Hg repository), and it would be easy to add support for
-Phoenix-style serial SIM readers if someone were to either send me one or point
-me to a place where I can buy one.  All libpcsclite compile-time dependencies
-have been factored out into the pcsc back end; if you don't have a pcsc-lite
-based reader and don't need that support, you can exclude this back end from
-your build and thus eliminate that compile-time dependency.
+What are the tools?
+===================
 
 fc-simtool is the utility of primary interest.  It speaks the classic GSM 11.11
 SIM protocol to the card (as opposed to the unwanted-innovation UICC protocol),
@@ -20,9 +13,10 @@
 manipulating PINs and phonebooks; low-level commands allow you to SELECT any
 arbitrary file (MF/DF/EF) and to perform READ and UPDATE commands on any EF
 (BINARY or RECORD as appropriate) as the card will allow, given your access
-level.  We (FreeCalypso core team) are also doing some experiments with
-programmable SIM cards, hoping to some day be able to issue our own SIMs, but
-this work is currently very experimental and not ready for consumption.
+level.  As the next level up in advanced functionality, if you are working with
+a programmable SIM (supported card models are our own FCSIM1 and Sysmocom
+webshop cards sysmoUSIM-SJS1 and sysmoISIM-SJA2), fc-simtool provides the
+necessary support for fully programming these SIMs.
 
 fc-uicc-tool is currently a very minimal tool for a few narrow use cases.  It
 implements a small subset of fc-simtool commands (basic low-level ones), but
@@ -33,3 +27,13 @@
 manually exploring the file system under ADF.USIM or ADF.ISIM which cannot be
 accessed in any other way.  fc-uicc-tool does NOT currently replicate any of
 the high-level end-user-oriented functionality of fc-simtool!
+
+Supported card access methods
+=============================
+
+fc-simtool and fc-uicc-tool are high-level protocol tools: they form command
+APDUs to be sent to the card, but they don't contain any hardware interfacing
+code - instead the job of actually accessing the card and exchanging APDUs with
+it is deferred to back end programs.  Three card access back ends are included
+in the FC SIM tools package: one for pcsc-lite, one for serial SIM readers, and
+one for SIM cards inside Calypso GSM devices.