]> git.zerfleddert.de Git - proxmark3-svn/blob - armsrc/apps.h
Documentation to apps.h, documentation/renaming to iclass
[proxmark3-svn] / armsrc / apps.h
1 //-----------------------------------------------------------------------------
2 // Jonathan Westhues, Aug 2005
3 // Gerhard de Koning Gans, April 2008, May 2011
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.
10 //-----------------------------------------------------------------------------
11
12 #ifndef __APPS_H
13 #define __APPS_H
14
15 #include <stdint.h>
16 #include <stddef.h>
17 #include "common.h"
18 #include "hitag2.h"
19 #include "mifare.h"
20
21 // The large multi-purpose buffer, typically used to hold A/D samples,
22 // maybe processed in some way.
23 #define BIGBUF_SIZE 40000
24 uint32_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)
39
40 /*
41 The statements above translates into this :
42 BIGBUF_SIZE = 40000
43 TRACE_OFFSET = 0
44 TRACE_SIZE = 3000
45 RECV_CMD_OFFSET = 3000
46 MAX_FRAME_SIZE = 256
47 MAX_PARITY_SIZE = 32
48 RECV_CMD_PAR_OFFSET = 3256
49 RECV_RESP_OFFSET = 3288
50 RECV_RESP_PAR_OFFSET= 3544
51 CARD_MEMORY_OFFSET = 3576
52 CARD_MEMORY_SIZE = 4096
53 DMA_BUFFER_OFFSET = 3576
54 DMA_BUFFER_SIZE = 4096
55 FREE_BUFFER_OFFSET = 7672
56 FREE_BUFFER_SIZE = 32327
57 */
58
59 extern const uint8_t OddByteParity[256];
60 extern uint8_t *trace; // = (uint8_t *) BigBuf;
61 extern int traceLen; // = 0;
62 extern int rsamples; // = 0;
63 extern int tracing; // = TRUE;
64 extern uint8_t trigger;
65
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
70 /// appmain.h
71 void ReadMem(int addr);
72 void __attribute__((noreturn)) AppMain(void);
73 void SamyRun(void);
74 //void DbpIntegers(int a, int b, int c);
75 void DbpString(char *str);
76 void Dbprintf(const char *fmt, ...);
77 void Dbhexdump(int len, uint8_t *d, bool bAsci);
78
79 int AvgAdc(int ch);
80
81 void ToSendStuffBit(int b);
82 void ToSendReset(void);
83 void ListenReaderField(int limit);
84 void AcquireRawAdcSamples125k(int at134khz);
85 void SnoopLFRawAdcSamples(int divisor, int trigger_threshold);
86 void DoAcquisition125k(int trigger_threshold);
87 extern int ToSendMax;
88 extern uint8_t ToSend[];
89 extern uint32_t BigBuf[];
90
91 /// fpga.h
92 void FpgaSendCommand(uint16_t cmd, uint16_t v);
93 void FpgaWriteConfWord(uint8_t v);
94 void FpgaDownloadAndGo(int bitstream_version);
95 int FpgaGatherBitstreamVersion();
96 void FpgaGatherVersion(char *dst, int len);
97 void FpgaSetupSsc(void);
98 void SetupSpi(int mode);
99 bool 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;
102 void SetAdcMuxFor(uint32_t whichGpio);
103
104 // Definitions for the FPGA commands.
105 #define FPGA_CMD_SET_CONFREG (1<<12)
106 #define FPGA_CMD_SET_DIVISOR (2<<12)
107 #define FPGA_CMD_SET_USER_BYTE1 (3<<12)
108 // Definitions for the FPGA configuration word.
109 // LF
110 #define FPGA_MAJOR_MODE_LF_ADC (0<<5)
111 #define FPGA_MAJOR_MODE_LF_EDGE_DETECT (1<<5)
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)
120 // Options for LF_ADC
121 #define FPGA_LF_ADC_READER_FIELD (1<<0)
122 // Options for LF_EDGE_DETECT
123 #define FPGA_CMD_SET_EDGE_DETECT_THRESHOLD FPGA_CMD_SET_USER_BYTE1
124 #define FPGA_LF_EDGE_DETECT_READER_FIELD (1<<0)
125 #define FPGA_LF_EDGE_DETECT_TOGGLE_MODE (1<<1)
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)
131 #define FPGA_HF_READER_RX_XCORR_QUARTER_FREQ (1<<2)
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)
136 #define FPGA_HF_SIMULATOR_MODULATE_424K (4<<0)
137 // Options for ISO14443A
138 #define FPGA_HF_ISO14443A_SNIFFER (0<<0)
139 #define FPGA_HF_ISO14443A_TAGSIM_LISTEN (1<<0)
140 #define FPGA_HF_ISO14443A_TAGSIM_MOD (2<<0)
141 #define FPGA_HF_ISO14443A_READER_LISTEN (3<<0)
142 #define FPGA_HF_ISO14443A_READER_MOD (4<<0)
143
144 /// lfops.h
145 void AcquireRawAdcSamples125k(int divisor);
146 void ModThenAcquireRawAdcSamples125k(int delay_off,int period_0,int period_1,uint8_t *command);
147 void ReadTItag(void);
148 void WriteTItag(uint32_t idhi, uint32_t idlo, uint16_t crc);
149 void AcquireTiType(void);
150 void AcquireRawBitsTI(void);
151 void SimulateTagLowFrequency(int period, int gap, int ledcontrol);
152 void CmdHIDsimTAG(int hi, int lo, int ledcontrol);
153 void CmdHIDdemodFSK(int findone, int *high, int *low, int ledcontrol);
154 void CmdEM410xdemod(int findone, int *high, int *low, int ledcontrol);
155 void CmdIOdemodFSK(int findone, int *high, int *low, int ledcontrol);
156 void CopyIOtoT55x7(uint32_t hi, uint32_t lo, uint8_t longFMT); // Clone an ioProx card to T5557/T5567
157 void SimulateTagLowFrequencyBidir(int divisor, int max_bitlen);
158 void CopyHIDtoT55x7(uint32_t hi2, uint32_t hi, uint32_t lo, uint8_t longFMT); // Clone an HID card to T5557/T5567
159 void WriteEM410x(uint32_t card, uint32_t id_hi, uint32_t id_lo);
160 void CopyIndala64toT55x7(int hi, int lo); // Clone Indala 64-bit tag by UID to T55x7
161 void CopyIndala224toT55x7(int uid1, int uid2, int uid3, int uid4, int uid5, int uid6, int uid7); // Clone Indala 224-bit tag by UID to T55x7
162 void T55xxWriteBlock(uint32_t Data, uint32_t Block, uint32_t Pwd, uint8_t PwdMode);
163 void T55xxReadBlock(uint32_t Block, uint32_t Pwd, uint8_t PwdMode );
164 void T55xxReadTrace(void);
165 int DemodPCF7931(uint8_t **outBlocks);
166 int IsBlock0PCF7931(uint8_t *Block);
167 int IsBlock1PCF7931(uint8_t *Block);
168 void ReadPCF7931();
169 void EM4xReadWord(uint8_t Address, uint32_t Pwd, uint8_t PwdMode);
170 void EM4xWriteWord(uint32_t Data, uint8_t Address, uint32_t Pwd, uint8_t PwdMode);
171
172 /// iso14443.h
173 void SimulateIso14443Tag(void);
174 void AcquireRawAdcSamplesIso14443(uint32_t parameter);
175 void ReadSTMemoryIso14443(uint32_t);
176 void RAMFUNC SnoopIso14443(void);
177 void SendRawCommand14443B(uint32_t, uint32_t, uint8_t, uint8_t[]);
178
179 /// iso14443a.h
180 void RAMFUNC SnoopIso14443a(uint8_t param);
181 void SimulateIso14443aTag(int tagType, int uid_1st, int uid_2nd, byte_t* data);
182 void ReaderIso14443a(UsbCommand * c);
183 // Also used in iclass.c
184 bool RAMFUNC LogTrace(const uint8_t *btBytes, uint16_t len, uint32_t timestamp_start, uint32_t timestamp_end, uint8_t *parity, bool readerToTag);
185 void GetParity(const uint8_t *pbtCmd, uint16_t len, uint8_t *parity);
186 void iso14a_set_trigger(bool enable);
187 void iso14a_clear_trace();
188 void iso14a_set_tracing(bool enable);
189 void RAMFUNC SniffMifare(uint8_t param);
190
191 /// epa.h
192 void EPA_PACE_Collect_Nonce(UsbCommand * c);
193
194 // mifarecmd.h
195 void ReaderMifare(bool first_try);
196 int32_t dist_nt(uint32_t nt1, uint32_t nt2);
197 void MifareReadBlock(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *data);
198 void MifareUReadBlock(uint8_t arg0,uint8_t *datain);
199 void MifareUReadCard(uint8_t arg0,uint8_t *datain);
200 void MifareReadSector(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
201 void MifareWriteBlock(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
202 void MifareUWriteBlock(uint8_t arg0,uint8_t *datain);
203 void MifareUWriteBlock_Special(uint8_t arg0,uint8_t *datain);
204 void MifareNested(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
205 void MifareChkKeys(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
206 void Mifare1ksim(uint8_t arg0, uint8_t arg1, uint8_t arg2, uint8_t *datain);
207 void MifareSetDbgLvl(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
208 void MifareEMemClr(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
209 void MifareEMemSet(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
210 void MifareEMemGet(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
211 void MifareECardLoad(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
212 void MifareCSetBlock(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain); // Work with "magic Chinese" card
213 void MifareCGetBlock(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
214 void MifareCIdent(); // is "magic chinese" card?
215
216 /// iso15693.h
217 void RecordRawAdcSamplesIso15693(void);
218 void AcquireRawAdcSamplesIso15693(void);
219 void ReaderIso15693(uint32_t parameter); // Simulate an ISO15693 reader - greg
220 void SimTagIso15693(uint32_t parameter, uint8_t *uid); // simulate an ISO15693 tag - greg
221 void BruteforceIso15693Afi(uint32_t speed); // find an AFI of a tag - atrox
222 void DirectTag15693Command(uint32_t datalen,uint32_t speed, uint32_t recv, uint8_t data[]); // send arbitrary commands from CLI - atrox
223 void SetDebugIso15693(uint32_t flag);
224
225 /// iclass.h
226 void RAMFUNC SnoopIClass(void);
227 void SimulateIClass(uint32_t arg0, uint32_t arg1, uint32_t arg2, uint8_t *datain);
228 void ReaderIClass(uint8_t arg0);
229 void ReaderIClass_Replay(uint8_t arg0,uint8_t *MAC);
230 void IClass_iso14443A_GetPublic(uint8_t arg0);
231
232 // hitag2.h
233 void SnoopHitag(uint32_t type);
234 void SimulateHitagTag(bool tag_mem_supplied, byte_t* data);
235 void ReaderHitag(hitag_function htf, hitag_data* htd);
236
237 // cmd.h
238 bool cmd_receive(UsbCommand* cmd);
239 bool cmd_send(uint32_t cmd, uint32_t arg0, uint32_t arg1, uint32_t arg2, void* data, size_t len);
240
241 /// util.h
242
243 #endif
Impressum, Datenschutz