Added an important notice.
[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;
36
37// For the bootloader
3ebf4b3d 38#define CMD_DEVICE_INFO 0x0000
39#define CMD_SETUP_WRITE 0x0001
40#define CMD_FINISH_WRITE 0x0003
41#define CMD_HARDWARE_RESET 0x0004
42#define CMD_START_FLASH 0x0005
43#define CMD_NACK 0x00fe
44#define CMD_ACK 0x00ff
e30c654b 45
46// For general mucking around
3ebf4b3d 47#define CMD_DEBUG_PRINT_STRING 0x0100
48#define CMD_DEBUG_PRINT_INTEGERS 0x0101
49#define CMD_DEBUG_PRINT_BYTES 0x0102
50#define CMD_LCD_RESET 0x0103
51#define CMD_LCD 0x0104
52#define CMD_BUFF_CLEAR 0x0105
53#define CMD_READ_MEM 0x0106
54#define CMD_VERSION 0x0107
e30c654b 55
56// For low-frequency tags
3ebf4b3d 57#define CMD_READ_TI_TYPE 0x0202
58#define CMD_WRITE_TI_TYPE 0x0203
59#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204
60#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205
61#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206
62#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207
63#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208
64#define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209
65#define CMD_SIMULATE_TAG_125K 0x020A
66#define CMD_HID_DEMOD_FSK 0x020B
67#define CMD_HID_SIM_TAG 0x020C
68#define CMD_SET_LF_DIVISOR 0x020D
69#define CMD_LF_SIMULATE_BIDIR 0x020E
70#define CMD_SET_ADC_MUX 0x020F
71#define CMD_HID_CLONE_TAG 0x0210
72#define CMD_EM410X_WRITE_TAG 0x0211
73#define CMD_INDALA_CLONE_TAG 0x0212
74// for 224 bits UID
75#define CMD_INDALA_CLONE_TAG_L 0x0213
54a942b0 76#define CMD_T55XX_READ_BLOCK 0x0214
77#define CMD_T55XX_WRITE_BLOCK 0x0215
78#define CMD_T55XX_READ_TRACE 0x0216
79#define CMD_PCF7931_READ 0x0217
80#define CMD_EM4X_READ_WORD 0x0218
81#define CMD_EM4X_WRITE_WORD 0x0219
e30c654b 82/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
83
84// For the 13.56 MHz tags
3ebf4b3d 85#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300
86#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443 0x0301
87#define CMD_READ_SRI512_TAG 0x0303
88#define CMD_READ_SRIX4K_TAG 0x0304
7cf3ef20 89#define CMD_ISO_14443B_COMMAND 0x0305
3ebf4b3d 90#define CMD_READER_ISO_15693 0x0310
91#define CMD_SIMTAG_ISO_15693 0x0311
92#define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 0x0312
93#define CMD_ISO_15693_COMMAND 0x0313
94#define CMD_ISO_15693_COMMAND_DONE 0x0314
95#define CMD_ISO_15693_FIND_AFI 0x0315
96#define CMD_ISO_15693_DEBUG 0x0316
d19929cb 97
98// For Hitag2 transponders
99#define CMD_SNOOP_HITAG 0x0370
100#define CMD_SIMULATE_HITAG 0x0371
101#define CMD_READER_HITAG 0x0372
102
3ebf4b3d 103#define CMD_SIMULATE_TAG_HF_LISTEN 0x0380
104#define CMD_SIMULATE_TAG_ISO_14443 0x0381
105#define CMD_SNOOP_ISO_14443 0x0382
106#define CMD_SNOOP_ISO_14443a 0x0383
107#define CMD_SIMULATE_TAG_ISO_14443a 0x0384
108#define CMD_READER_ISO_14443a 0x0385
109#define CMD_SIMULATE_TAG_LEGIC_RF 0x0387
110#define CMD_READER_LEGIC_RF 0x0388
111#define CMD_WRITER_LEGIC_RF 0x0389
5acd09bd 112#define CMD_EPA_PACE_COLLECT_NONCE 0x038A
3ebf4b3d 113
114#define CMD_SNOOP_ICLASS 0x0392
115#define CMD_SIMULATE_TAG_ICLASS 0x0393
116#define CMD_READER_ICLASS 0x0394
e30c654b 117
118// For measurements of the antenna tuning
3ebf4b3d 119#define CMD_MEASURE_ANTENNA_TUNING 0x0400
120#define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401
121#define CMD_MEASURED_ANTENNA_TUNING 0x0410
122#define CMD_LISTEN_READER_FIELD 0x0420
e30c654b 123
124// For direct FPGA control
3ebf4b3d 125#define CMD_FPGA_MAJOR_MODE_OFF 0x0500
9ca155ba
M
126
127// For mifare commands
3ebf4b3d 128#define CMD_MIFARE_SET_DBGMODE 0x0600
129#define CMD_MIFARE_EML_MEMCLR 0x0601
130#define CMD_MIFARE_EML_MEMSET 0x0602
131#define CMD_MIFARE_EML_MEMGET 0x0603
132#define CMD_MIFARE_EML_CARDLOAD 0x0604
133#define CMD_MIFARE_EML_CSETBLOCK 0x0605
134#define CMD_MIFARE_EML_CGETBLOCK 0x0606
9ca155ba 135
3ebf4b3d 136#define CMD_SIMULATE_MIFARE_CARD 0x0610
9ca155ba 137
3ebf4b3d 138#define CMD_READER_MIFARE 0x0611
139#define CMD_MIFARE_NESTED 0x0612
9ca155ba 140
3ebf4b3d 141#define CMD_MIFARE_READBL 0x0620
981bd429 142#define CMD_MIFAREU_READBL 0x0720
3ebf4b3d 143#define CMD_MIFARE_READSC 0x0621
981bd429 144#define CMD_MIFAREU_READCARD 0x0721
3ebf4b3d 145#define CMD_MIFARE_WRITEBL 0x0622
981bd429 146#define CMD_MIFAREU_WRITEBL_COMPAT 0x0722
147#define CMD_MIFAREU_WRITEBL 0x0723
3ebf4b3d 148#define CMD_MIFARE_CHKKEYS 0x0623
e30c654b 149
3ebf4b3d 150#define CMD_MIFARE_SNIFFER 0x0630
b62a5a84 151
3ebf4b3d 152#define CMD_UNKNOWN 0xFFFF
e30c654b 153
d2f487af 154
155//Mifare simulation flags
156#define FLAG_INTERACTIVE 0x01
157#define FLAG_4B_UID_IN_DATA 0x02
158#define FLAG_7B_UID_IN_DATA 0x04
159#define FLAG_NR_AR_ATTACK 0x08
160
161
162
e30c654b 163// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
164/* Whether a bootloader that understands the common_area is present */
165#define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)
166
167/* Whether a osimage that understands the common_area is present */
168#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)
169
170/* Set if the bootloader is currently executing */
171#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)
172
173/* Set if the OS is currently executing */
174#define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)
175
176/* Set if this device understands the extend start flash command */
177#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)
178
179/* CMD_START_FLASH may have three arguments: start of area to flash,
180 end of area to flash, optional magic.
181 The bootrom will not allow to overwrite itself unless this magic
182 is given as third parameter */
183
184#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
185
186#endif
Impressum, Datenschutz