annotate README @ 52:cbfcc480d61b

fpga build: migrate to yosys-tee wrapper
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 03 Oct 2023 18:17:58 +0000
parents f8c27c2bde0e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
1 Welcome to FreeCalypso SIMsniff
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
2 ===============================
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3
50
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
4 FreeCalypso SIMsniff is an alternative project to Osmocom SIMtrace, created in
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
5 response to technical limitations of the latter. Both tools seek to solve the
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
6 same problem (trace or sniff all communication between a phone, modem or other
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
7 interface device and a SIM card) and use some passive hardware components in
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
8 common (the FPC adapter cable that goes into the phone's SIM socket), but use
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
9 different active components: Osmocom SIMtrace uses an AT91SAMx MCU as the ISO
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
10 7816-3 sniffing receiver, whereas FC SIMsniff uses a voltage translating buffer
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
11 followed by an iCE40 FPGA instead.
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
12
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
13 The principal practical difference between the two tools is that FC SIMsniff is
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
14 electrically clean and proper:
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
16 * 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
17 sniffed;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
19 * 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
20 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
21 artifacts;
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
23 * 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
24 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
25
50
f8c27c2bde0e README: project rename
Mychaela Falconia <falcon@freecalypso.org>
parents: 40
diff changeset
26 The hardware setup of FC SIMsniff consists of:
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 * 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
29 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
30 Sysmocom;
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 * 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
33
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
34 * 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
35 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
36 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
37
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
38 This source repository contains:
0
fbbafa93b52b starting project with README and sim-fpc-pasv adapter
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39
40
510bef2b2000 new README, old stuff goes to doc/Motivation
Mychaela Falconia <falcon@freecalypso.org>
parents: 0
diff changeset
40 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
41 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
42 sw Host software tools