annotate README @ 46:43f678895a3a

simtrace3-sniff-rx: add some annotations to output
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 31 Aug 2023 10:01:40 +0000
parents 510bef2b2000
children f8c27c2bde0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
1 Welcome to FreeCalypso SIMtrace3
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
2 ================================
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
4 FC SIMtrace3 (aka SIMtrace-ice) is an alternative implementation of Osmocom
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
5 SIMtrace principal idea, using an iCE40 FPGA instead of AT91SAMx MCU as the ISO
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
6 7816-3 sniffing receiver. Aside from this change from an MCU to an FPGA and
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
7 thus from firmware to gateware, the other principal difference is that SIMtrace3
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
8 is electrically clean and proper:
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
10 * The sniffing apparatus makes a strictly Hi-Z connection to the SIM bus being
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
11 sniffed;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
13 * The SIM bus itself is solidly connected from the phone's SIM socket to the
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
14 physical SIM without any switches or pull-ups or other Heisenbug-inducing
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
15 artifacts;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
17 * The sniffing apparatus supports all 3 voltage classes that can be put out by
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
18 the ME or other interface device: 1.8V, 3V and 5V are all good.
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
20 The hardware setup of SIMtrace3 consists of:
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
22 * The same SIMtrace FPC cables (going from a SIM socket to the 6-pin FPC
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
23 connector) that were originally developed for SIMtrace1/2 and are sold by
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
24 Sysmocom;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
26 * An off-the-shelf Lattice Icestick FPGA board;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
28 * A little bit of custom hardware: two very simple boards in the initial
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
29 version, intending to consolidate them into one board in the final version,
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
30 see doc/Sniffing-hw-setup for the details.
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
32 This source repository contains:
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
34 boards Design files for little adapter boards
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
35 fpga Gateware for the iCE40HX1K FPGA on the Icestick board
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
36 sw Host software tools