Some documentation
[proxmark3-svn] / armsrc / apps.h
CommitLineData
15c4dc5a 1//-----------------------------------------------------------------------------
15c4dc5a 2// Jonathan Westhues, Aug 2005
cee5a30d 3// Gerhard de Koning Gans, April 2008, May 2011
bd20f8f4 4//
5// This code is licensed to you under the terms of the GNU GPL, version 2 or,
6// at your option, any later version. See the LICENSE.txt file for the text of
7// the license.
8//-----------------------------------------------------------------------------
9// Definitions internal to the app source.
15c4dc5a 10//-----------------------------------------------------------------------------
11
12#ifndef __APPS_H
13#define __APPS_H
14
f7e3ed82 15#include <stdint.h>
16#include <stddef.h>
d19929cb 17#include "common.h"
18#include "hitag2.h"
902cb3c0 19#include "mifare.h"
15c4dc5a 20
21// The large multi-purpose buffer, typically used to hold A/D samples,
22// maybe processed in some way.
6a1f2d82 23#define BIGBUF_SIZE 40000
24uint32_t BigBuf[BIGBUF_SIZE / sizeof(uint32_t)];
25#define TRACE_OFFSET 0
26#define TRACE_SIZE 3000
27#define RECV_CMD_OFFSET (TRACE_OFFSET + TRACE_SIZE)
28#define MAX_FRAME_SIZE 256
29#define MAX_PARITY_SIZE ((MAX_FRAME_SIZE + 1)/ 8)
30#define RECV_CMD_PAR_OFFSET (RECV_CMD_OFFSET + MAX_FRAME_SIZE)
31#define RECV_RESP_OFFSET (RECV_CMD_PAR_OFFSET + MAX_PARITY_SIZE)
32#define RECV_RESP_PAR_OFFSET (RECV_RESP_OFFSET + MAX_FRAME_SIZE)
33#define CARD_MEMORY_OFFSET (RECV_RESP_PAR_OFFSET + MAX_PARITY_SIZE)
34#define CARD_MEMORY_SIZE 4096
35#define DMA_BUFFER_OFFSET CARD_MEMORY_OFFSET
36#define DMA_BUFFER_SIZE CARD_MEMORY_SIZE
37#define FREE_BUFFER_OFFSET (CARD_MEMORY_OFFSET + CARD_MEMORY_SIZE)
38#define FREE_BUFFER_SIZE (BIGBUF_SIZE - FREE_BUFFER_OFFSET - 1)
81cd0474 39
55eaed8f
MHS
40/*
41The statements above translates into this :
42BIGBUF_SIZE = 40000
43TRACE_OFFSET = 0
44TRACE_SIZE = 3000
45RECV_CMD_OFFSET = 3000
46MAX_FRAME_SIZE = 256
47MAX_PARITY_SIZE = 32
48RECV_CMD_PAR_OFFSET = 3256
49RECV_RESP_OFFSET = 3288
50RECV_RESP_PAR_OFFSET= 3544
51CARD_MEMORY_OFFSET = 3576
52CARD_MEMORY_SIZE = 4096
53DMA_BUFFER_OFFSET = 3576
54DMA_BUFFER_SIZE = 4096
55FREE_BUFFER_OFFSET = 7672
56FREE_BUFFER_SIZE = 32327
57 */
58
1e262141 59extern const uint8_t OddByteParity[256];
60extern uint8_t *trace; // = (uint8_t *) BigBuf;
61extern int traceLen; // = 0;
62extern int rsamples; // = 0;
63extern int tracing; // = TRUE;
64extern uint8_t trigger;
15c4dc5a 65
6c1e2d95 66// This may be used (sparingly) to declare a function to be copied to
67// and executed from RAM
68#define RAMFUNC __attribute((long_call, section(".ramfunc")))
69
15c4dc5a 70/// appmain.h
71void ReadMem(int addr);
72void __attribute__((noreturn)) AppMain(void);
73void SamyRun(void);
74//void DbpIntegers(int a, int b, int c);
75void DbpString(char *str);
76void Dbprintf(const char *fmt, ...);
d19929cb 77void Dbhexdump(int len, uint8_t *d, bool bAsci);
15c4dc5a 78
9ca155ba
M
79int AvgAdc(int ch);
80
15c4dc5a 81void ToSendStuffBit(int b);
82void ToSendReset(void);
83void ListenReaderField(int limit);
f7e3ed82 84void AcquireRawAdcSamples125k(int at134khz);
b014c96d 85void SnoopLFRawAdcSamples(int divisor, int trigger_threshold);
86void DoAcquisition125k(int trigger_threshold);
15c4dc5a 87extern int ToSendMax;
f7e3ed82 88extern uint8_t ToSend[];
89extern uint32_t BigBuf[];
15c4dc5a 90
91/// fpga.h
f7e3ed82 92void FpgaSendCommand(uint16_t cmd, uint16_t v);
93void FpgaWriteConfWord(uint8_t v);
7cc204bf 94void FpgaDownloadAndGo(int bitstream_version);
95int FpgaGatherBitstreamVersion();
15c4dc5a 96void FpgaGatherVersion(char *dst, int len);
97void FpgaSetupSsc(void);
98void SetupSpi(int mode);
d19929cb 99bool FpgaSetupSscDma(uint8_t *buf, int len);
100#define FpgaDisableSscDma(void) AT91C_BASE_PDC_SSC->PDC_PTCR = AT91C_PDC_RXTDIS;
101#define FpgaEnableSscDma(void) AT91C_BASE_PDC_SSC->PDC_PTCR = AT91C_PDC_RXTEN;
f7e3ed82 102void SetAdcMuxFor(uint32_t whichGpio);
15c4dc5a 103
104// Definitions for the FPGA commands.
7cc204bf 105#define FPGA_CMD_SET_CONFREG (1<<12)
106#define FPGA_CMD_SET_DIVISOR (2<<12)
3b2fee43 107#define FPGA_CMD_SET_USER_BYTE1 (3<<12)
15c4dc5a 108// Definitions for the FPGA configuration word.
7cc204bf 109// LF
b014c96d 110#define FPGA_MAJOR_MODE_LF_ADC (0<<5)
111#define FPGA_MAJOR_MODE_LF_EDGE_DETECT (1<<5)
7cc204bf 112#define FPGA_MAJOR_MODE_LF_PASSTHRU (2<<5)
113// HF
114#define FPGA_MAJOR_MODE_HF_READER_TX (0<<5)
115#define FPGA_MAJOR_MODE_HF_READER_RX_XCORR (1<<5)
116#define FPGA_MAJOR_MODE_HF_SIMULATOR (2<<5)
117#define FPGA_MAJOR_MODE_HF_ISO14443A (3<<5)
118// BOTH
119#define FPGA_MAJOR_MODE_OFF (7<<5)
b014c96d 120// Options for LF_ADC
121#define FPGA_LF_ADC_READER_FIELD (1<<0)
d19929cb 122// Options for LF_EDGE_DETECT
3b2fee43 123#define FPGA_CMD_SET_EDGE_DETECT_THRESHOLD FPGA_CMD_SET_USER_BYTE1
d19929cb 124#define FPGA_LF_EDGE_DETECT_READER_FIELD (1<<0)
3b2fee43 125#define FPGA_LF_EDGE_DETECT_TOGGLE_MODE (1<<1)
15c4dc5a 126// Options for the HF reader, tx to tag
127#define FPGA_HF_READER_TX_SHALLOW_MOD (1<<0)
128// Options for the HF reader, correlating against rx from tag
129#define FPGA_HF_READER_RX_XCORR_848_KHZ (1<<0)
130#define FPGA_HF_READER_RX_XCORR_SNOOP (1<<1)
7cc204bf 131#define FPGA_HF_READER_RX_XCORR_QUARTER_FREQ (1<<2)
15c4dc5a 132// Options for the HF simulated tag, how to modulate
133#define FPGA_HF_SIMULATOR_NO_MODULATION (0<<0)
134#define FPGA_HF_SIMULATOR_MODULATE_BPSK (1<<0)
135#define FPGA_HF_SIMULATOR_MODULATE_212K (2<<0)
83fd67ba 136#define FPGA_HF_SIMULATOR_MODULATE_424K (4<<0)
645c960f
MHS
137#define FPGA_HF_SIMULATOR_MODULATE_424K_8BIT 0x5//101
138
15c4dc5a 139// Options for ISO14443A
7cc204bf 140#define FPGA_HF_ISO14443A_SNIFFER (0<<0)
15c4dc5a 141#define FPGA_HF_ISO14443A_TAGSIM_LISTEN (1<<0)
142#define FPGA_HF_ISO14443A_TAGSIM_MOD (2<<0)
143#define FPGA_HF_ISO14443A_READER_LISTEN (3<<0)
144#define FPGA_HF_ISO14443A_READER_MOD (4<<0)
145
146/// lfops.h
bf7163bd 147void AcquireRawAdcSamples125k(int divisor);
f7e3ed82 148void ModThenAcquireRawAdcSamples125k(int delay_off,int period_0,int period_1,uint8_t *command);
15c4dc5a 149void ReadTItag(void);
f7e3ed82 150void WriteTItag(uint32_t idhi, uint32_t idlo, uint16_t crc);
15c4dc5a 151void AcquireTiType(void);
152void AcquireRawBitsTI(void);
153void SimulateTagLowFrequency(int period, int gap, int ledcontrol);
154void CmdHIDsimTAG(int hi, int lo, int ledcontrol);
155void CmdHIDdemodFSK(int findone, int *high, int *low, int ledcontrol);
66707a3b 156void CmdEM410xdemod(int findone, int *high, int *low, int ledcontrol);
a1f3bb12 157void CmdIOdemodFSK(int findone, int *high, int *low, int ledcontrol);
158void CopyIOtoT55x7(uint32_t hi, uint32_t lo, uint8_t longFMT); // Clone an ioProx card to T5557/T5567
15c4dc5a 159void SimulateTagLowFrequencyBidir(int divisor, int max_bitlen);
54a942b0 160void CopyHIDtoT55x7(uint32_t hi2, uint32_t hi, uint32_t lo, uint8_t longFMT); // Clone an HID card to T5557/T5567
2d4eae76 161void WriteEM410x(uint32_t card, uint32_t id_hi, uint32_t id_lo);
2414f978 162void CopyIndala64toT55x7(int hi, int lo); // Clone Indala 64-bit tag by UID to T55x7
163void CopyIndala224toT55x7(int uid1, int uid2, int uid3, int uid4, int uid5, int uid6, int uid7); // Clone Indala 224-bit tag by UID to T55x7
54a942b0 164void T55xxWriteBlock(uint32_t Data, uint32_t Block, uint32_t Pwd, uint8_t PwdMode);
165void T55xxReadBlock(uint32_t Block, uint32_t Pwd, uint8_t PwdMode );
166void T55xxReadTrace(void);
167int DemodPCF7931(uint8_t **outBlocks);
168int IsBlock0PCF7931(uint8_t *Block);
169int IsBlock1PCF7931(uint8_t *Block);
170void ReadPCF7931();
171void EM4xReadWord(uint8_t Address, uint32_t Pwd, uint8_t PwdMode);
172void EM4xWriteWord(uint32_t Data, uint8_t Address, uint32_t Pwd, uint8_t PwdMode);
15c4dc5a 173
174/// iso14443.h
175void SimulateIso14443Tag(void);
f7e3ed82 176void AcquireRawAdcSamplesIso14443(uint32_t parameter);
7cf3ef20 177void ReadSTMemoryIso14443(uint32_t);
0f7f9edc 178void RAMFUNC SnoopIso14443(void);
7cf3ef20 179void SendRawCommand14443B(uint32_t, uint32_t, uint8_t, uint8_t[]);
15c4dc5a 180
181/// iso14443a.h
5cd9ec01 182void RAMFUNC SnoopIso14443a(uint8_t param);
28afbd2b 183void SimulateIso14443aTag(int tagType, int uid_1st, int uid_2nd, byte_t* data);
902cb3c0 184void ReaderIso14443a(UsbCommand * c);
1e262141 185// Also used in iclass.c
6a1f2d82 186bool RAMFUNC LogTrace(const uint8_t *btBytes, uint16_t len, uint32_t timestamp_start, uint32_t timestamp_end, uint8_t *parity, bool readerToTag);
187void GetParity(const uint8_t *pbtCmd, uint16_t len, uint8_t *parity);
902cb3c0 188void iso14a_set_trigger(bool enable);
189void iso14a_clear_trace();
190void iso14a_set_tracing(bool enable);
5cd9ec01 191void RAMFUNC SniffMifare(uint8_t param);
8556b852 192
5acd09bd 193/// epa.h
902cb3c0 194void EPA_PACE_Collect_Nonce(UsbCommand * c);
5acd09bd 195
8556b852 196// mifarecmd.h
1c611bbd 197void ReaderMifare(bool first_try);
9492e0b0 198int32_t dist_nt(uint32_t nt1, uint32_t nt2);
20f9a2a1 199void MifareReadBlock(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *data);
981bd429 200void MifareUReadBlock(uint8_t arg0,uint8_t *datain);
31d1caa5 201void MifareUReadCard(uint8_t arg0, int arg1, uint8_t *datain);
20f9a2a1
M
202void MifareReadSector(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
203void MifareWriteBlock(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
981bd429 204void MifareUWriteBlock(uint8_t arg0,uint8_t *datain);
205void MifareUWriteBlock_Special(uint8_t arg0,uint8_t *datain);
f397b5cc
M
206void MifareNested(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
207void MifareChkKeys(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
20f9a2a1 208void Mifare1ksim(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
8556b852
M
209void MifareSetDbgLvl(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
210void MifareEMemClr(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
211void MifareEMemSet(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
212void MifareEMemGet(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
213void MifareECardLoad(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
0675f200 214void MifareCSetBlock(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain); // Work with "magic Chinese" card
545a1f38 215void MifareCGetBlock(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
3fe4ff4f 216void MifareCIdent(); // is "magic chinese" card?
15c4dc5a 217
218/// iso15693.h
9455b51c 219void RecordRawAdcSamplesIso15693(void);
15c4dc5a 220void AcquireRawAdcSamplesIso15693(void);
f7e3ed82 221void ReaderIso15693(uint32_t parameter); // Simulate an ISO15693 reader - greg
3fe4ff4f 222void SimTagIso15693(uint32_t parameter, uint8_t *uid); // simulate an ISO15693 tag - greg
9455b51c 223void BruteforceIso15693Afi(uint32_t speed); // find an AFI of a tag - atrox
224void DirectTag15693Command(uint32_t datalen,uint32_t speed, uint32_t recv, uint8_t data[]); // send arbitrary commands from CLI - atrox
225void SetDebugIso15693(uint32_t flag);
15c4dc5a 226
cee5a30d 227/// iclass.h
228void RAMFUNC SnoopIClass(void);
ff7bb4ef 229void SimulateIClass(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
1e262141 230void ReaderIClass(uint8_t arg0);
c3963755 231void ReaderIClass_Replay(uint8_t arg0,uint8_t *MAC);
fecd8202 232void IClass_iso14443A_GetPublic(uint8_t arg0);
cee5a30d 233
d19929cb 234// hitag2.h
235void SnoopHitag(uint32_t type);
236void SimulateHitagTag(bool tag_mem_supplied, byte_t* data);
237void ReaderHitag(hitag_function htf, hitag_data* htd);
238
6e82300d 239// cmd.h
240bool cmd_receive(UsbCommand* cmd);
79a73ab2 241bool cmd_send(uint32_t cmd, uint32_t arg0, uint32_t arg1, uint32_t arg2, void* data, size_t len);
6e82300d 242
15c4dc5a 243/// util.h
15c4dc5a 244
245#endif
Impressum, Datenschutz