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