38f8617a84c14c2c23e152c8b45b1742aa025738
[proxmark3-svn] / include / usb_cmd.h
1 //-----------------------------------------------------------------------------
2 // Jonathan Westhues, Mar 2006
3 // Edits by Gerhard de Koning Gans, Sep 2007
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 for all the types of commands that may be sent over USB; our
10 // own protocol.
11 //-----------------------------------------------------------------------------
12
13 #ifndef __USB_CMD_H
14 #define __USB_CMD_H
15 #ifdef _MSC_VER
16 typedef DWORD uint32_t;
17 typedef BYTE uint8_t;
18 #define PACKED
19 // stuff
20 #else
21 #include <stdint.h>
22 #include <stdbool.h>
23 #define PACKED __attribute__((packed))
24 #endif
25
26 #define USB_CMD_DATA_SIZE 512
27
28 typedef struct {
29 uint64_t cmd;
30 uint64_t arg[3];
31 union {
32 uint8_t asBytes[USB_CMD_DATA_SIZE];
33 uint32_t asDwords[USB_CMD_DATA_SIZE/4];
34 } d;
35 } PACKED UsbCommand;
36 // A struct used to send sample-configs over USB
37 typedef struct{
38 uint8_t decimation;
39 uint8_t bits_per_sample;
40 bool averaging;
41 int divisor;
42 int trigger_threshold;
43 } sample_config;
44
45 // For the bootloader
46 #define CMD_DEVICE_INFO 0x0000
47 #define CMD_SETUP_WRITE 0x0001
48 #define CMD_FINISH_WRITE 0x0003
49 #define CMD_HARDWARE_RESET 0x0004
50 #define CMD_START_FLASH 0x0005
51 #define CMD_NACK 0x00fe
52 #define CMD_ACK 0x00ff
53
54 // For general mucking around
55 #define CMD_DEBUG_PRINT_STRING 0x0100
56 #define CMD_DEBUG_PRINT_INTEGERS 0x0101
57 #define CMD_DEBUG_PRINT_BYTES 0x0102
58 #define CMD_LCD_RESET 0x0103
59 #define CMD_LCD 0x0104
60 #define CMD_BUFF_CLEAR 0x0105
61 #define CMD_READ_MEM 0x0106
62 #define CMD_VERSION 0x0107
63 #define CMD_STATUS 0x0108
64 #define CMD_PING 0x0109
65
66 // For low-frequency tags
67 #define CMD_READ_TI_TYPE 0x0202
68 #define CMD_WRITE_TI_TYPE 0x0203
69 #define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204
70 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205
71 #define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206
72 #define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207
73 #define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208
74 #define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209
75 #define CMD_SIMULATE_TAG_125K 0x020A
76 #define CMD_HID_DEMOD_FSK 0x020B
77 #define CMD_HID_SIM_TAG 0x020C
78 #define CMD_SET_LF_DIVISOR 0x020D
79 #define CMD_LF_SIMULATE_BIDIR 0x020E
80 #define CMD_SET_ADC_MUX 0x020F
81 #define CMD_HID_CLONE_TAG 0x0210
82 #define CMD_EM410X_WRITE_TAG 0x0211
83 #define CMD_INDALA_CLONE_TAG 0x0212
84 // for 224 bits UID
85 #define CMD_INDALA_CLONE_TAG_L 0x0213
86 #define CMD_T55XX_READ_BLOCK 0x0214
87 #define CMD_T55XX_WRITE_BLOCK 0x0215
88 #define CMD_T55XX_RESET_READ 0x0216
89 #define CMD_PCF7931_READ 0x0217
90 #define CMD_PCF7931_WRITE 0x0222
91 #define CMD_EM4X_READ_WORD 0x0218
92 #define CMD_EM4X_WRITE_WORD 0x0219
93 #define CMD_IO_DEMOD_FSK 0x021A
94 #define CMD_IO_CLONE_TAG 0x021B
95 #define CMD_EM410X_DEMOD 0x021c
96 // Sampling configuration for LF reader/snooper
97 #define CMD_SET_LF_SAMPLING_CONFIG 0x021d
98 #define CMD_FSK_SIM_TAG 0x021E
99 #define CMD_ASK_SIM_TAG 0x021F
100 #define CMD_PSK_SIM_TAG 0x0220
101 #define CMD_AWID_DEMOD_FSK 0x0221
102 #define CMD_VIKING_CLONE_TAG 0x0223
103 #define CMD_T55XX_WAKEUP 0x0224
104
105
106 /* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
107
108 // For the 13.56 MHz tags
109 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300
110 #define CMD_READ_SRI512_TAG 0x0303
111 #define CMD_READ_SRIX4K_TAG 0x0304
112 #define CMD_ISO_14443B_COMMAND 0x0305
113 #define CMD_READER_ISO_15693 0x0310
114 #define CMD_SIMTAG_ISO_15693 0x0311
115 #define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 0x0312
116 #define CMD_ISO_15693_COMMAND 0x0313
117 #define CMD_ISO_15693_COMMAND_DONE 0x0314
118 #define CMD_ISO_15693_FIND_AFI 0x0315
119 #define CMD_ISO_15693_DEBUG 0x0316
120 #define CMD_LF_SNOOP_RAW_ADC_SAMPLES 0x0317
121
122 // For Hitag2 transponders
123 #define CMD_SNOOP_HITAG 0x0370
124 #define CMD_SIMULATE_HITAG 0x0371
125 #define CMD_READER_HITAG 0x0372
126
127 #define CMD_SIMULATE_TAG_ISO_14443B 0x0381
128 #define CMD_SNOOP_ISO_14443B 0x0382
129 #define CMD_SNOOP_ISO_14443a 0x0383
130 #define CMD_SIMULATE_TAG_ISO_14443a 0x0384
131 #define CMD_READER_ISO_14443a 0x0385
132 #define CMD_SIMULATE_TAG_LEGIC_RF 0x0387
133 #define CMD_READER_LEGIC_RF 0x0388
134 #define CMD_WRITER_LEGIC_RF 0x0389
135 #define CMD_EPA_PACE_COLLECT_NONCE 0x038A
136 #define CMD_EPA_PACE_REPLAY 0x038B
137
138 #define CMD_ICLASS_READCHECK 0x038F
139 #define CMD_ICLASS_CLONE 0x0390
140 #define CMD_ICLASS_DUMP 0x0391
141 #define CMD_SNOOP_ICLASS 0x0392
142 #define CMD_SIMULATE_TAG_ICLASS 0x0393
143 #define CMD_READER_ICLASS 0x0394
144 #define CMD_READER_ICLASS_REPLAY 0x0395
145 #define CMD_ICLASS_READBLOCK 0x0396
146 #define CMD_ICLASS_WRITEBLOCK 0x0397
147 #define CMD_ICLASS_EML_MEMSET 0x0398
148 #define CMD_ICLASS_AUTHENTICATION 0x0399
149
150 // For measurements of the antenna tuning
151 #define CMD_MEASURE_ANTENNA_TUNING 0x0400
152 #define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401
153 #define CMD_MEASURED_ANTENNA_TUNING 0x0410
154 #define CMD_LISTEN_READER_FIELD 0x0420
155
156 // For direct FPGA control
157 #define CMD_FPGA_MAJOR_MODE_OFF 0x0500
158
159 // For mifare commands
160 #define CMD_MIFARE_SET_DBGMODE 0x0600
161 #define CMD_MIFARE_EML_MEMCLR 0x0601
162 #define CMD_MIFARE_EML_MEMSET 0x0602
163 #define CMD_MIFARE_EML_MEMGET 0x0603
164 #define CMD_MIFARE_EML_CARDLOAD 0x0604
165
166 // magic chinese card commands
167 #define CMD_MIFARE_CSETBLOCK 0x0605
168 #define CMD_MIFARE_CGETBLOCK 0x0606
169 #define CMD_MIFARE_CIDENT 0x0607
170
171 #define CMD_SIMULATE_MIFARE_CARD 0x0610
172
173 #define CMD_READER_MIFARE 0x0611
174 #define CMD_MIFARE_NESTED 0x0612
175
176 #define CMD_MIFARE_READBL 0x0620
177 #define CMD_MIFAREU_READBL 0x0720
178 #define CMD_MIFARE_READSC 0x0621
179 #define CMD_MIFAREU_READCARD 0x0721
180 #define CMD_MIFARE_WRITEBL 0x0622
181 #define CMD_MIFAREU_WRITEBL 0x0722
182 #define CMD_MIFAREU_WRITEBL_COMPAT 0x0723
183
184 #define CMD_MIFARE_CHKKEYS 0x0623
185
186 #define CMD_MIFARE_SNIFFER 0x0630
187 //ultralightC
188 #define CMD_MIFAREUC_AUTH 0x0724
189 //0x0725 and 0x0726 no longer used
190 #define CMD_MIFAREUC_SETPWD 0x0727
191
192
193 // mifare desfire
194 #define CMD_MIFARE_DESFIRE_READBL 0x0728
195 #define CMD_MIFARE_DESFIRE_WRITEBL 0x0729
196 #define CMD_MIFARE_DESFIRE_AUTH1 0x072a
197 #define CMD_MIFARE_DESFIRE_AUTH2 0x072b
198 #define CMD_MIFARE_DES_READER 0x072c
199 #define CMD_MIFARE_DESFIRE_INFO 0x072d
200 #define CMD_MIFARE_DESFIRE 0x072e
201
202 #define CMD_HF_SNIFFER 0x0800
203
204 #define CMD_UNKNOWN 0xFFFF
205
206
207 //Mifare simulation flags
208 #define FLAG_INTERACTIVE 0x01
209 #define FLAG_4B_UID_IN_DATA 0x02
210 #define FLAG_7B_UID_IN_DATA 0x04
211 #define FLAG_NR_AR_ATTACK 0x08
212
213
214 //Iclass reader flags
215 #define FLAG_ICLASS_READER_ONLY_ONCE 0x01
216 #define FLAG_ICLASS_READER_CC 0x02
217 #define FLAG_ICLASS_READER_CSN 0x04
218 #define FLAG_ICLASS_READER_CONF 0x08
219 #define FLAG_ICLASS_READER_AA 0x10
220 #define FLAG_ICLASS_READER_ONE_TRY 0x20
221 #define FLAG_ICLASS_READER_CEDITKEY 0x40
222
223
224
225 // CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
226 /* Whether a bootloader that understands the common_area is present */
227 #define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)
228
229 /* Whether a osimage that understands the common_area is present */
230 #define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)
231
232 /* Set if the bootloader is currently executing */
233 #define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)
234
235 /* Set if the OS is currently executing */
236 #define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)
237
238 /* Set if this device understands the extend start flash command */
239 #define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)
240
241 /* CMD_START_FLASH may have three arguments: start of area to flash,
242 end of area to flash, optional magic.
243 The bootrom will not allow to overwrite itself unless this magic
244 is given as third parameter */
245
246 #define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
247
248 #endif
Impressum, Datenschutz