Welcome to FreeCalypso SIMtrace3
================================

FC SIMtrace3 (aka SIMtrace-ice) is an alternative implementation of Osmocom
SIMtrace principal idea, using an iCE40 FPGA instead of AT91SAMx MCU as the ISO
7816-3 sniffing receiver.  Aside from this change from an MCU to an FPGA and
thus from firmware to gateware, the other principal difference is that SIMtrace3
is electrically clean and proper:

* The sniffing apparatus makes a strictly Hi-Z connection to the SIM bus being
  sniffed;

* The SIM bus itself is solidly connected from the phone's SIM socket to the
  physical SIM without any switches or pull-ups or other Heisenbug-inducing
  artifacts;

* The sniffing apparatus supports all 3 voltage classes that can be put out by
  the ME or other interface device: 1.8V, 3V and 5V are all good.

The hardware setup of SIMtrace3 consists of:

* The same SIMtrace FPC cables (going from a SIM socket to the 6-pin FPC
  connector) that were originally developed for SIMtrace1/2 and are sold by
  Sysmocom;

* An off-the-shelf Lattice Icestick FPGA board;

* A little bit of custom hardware: two very simple boards in the initial
  version, intending to consolidate them into one board in the final version,
  see doc/Sniffing-hw-setup for the details.

This source repository contains:

boards		Design files for little adapter boards
fpga		Gateware for the iCE40HX1K FPGA on the Icestick board
sw		Host software tools