Merge remote-tracking branch 'upstream/master'
[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
e30c654b 63
64// For low-frequency tags
3ebf4b3d 65#define CMD_READ_TI_TYPE 0x0202
66#define CMD_WRITE_TI_TYPE 0x0203
67#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204
68#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205
69#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206
70#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207
71#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208
72#define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209
73#define CMD_SIMULATE_TAG_125K 0x020A
74#define CMD_HID_DEMOD_FSK 0x020B
75#define CMD_HID_SIM_TAG 0x020C
76#define CMD_SET_LF_DIVISOR 0x020D
77#define CMD_LF_SIMULATE_BIDIR 0x020E
78#define CMD_SET_ADC_MUX 0x020F
79#define CMD_HID_CLONE_TAG 0x0210
80#define CMD_EM410X_WRITE_TAG 0x0211
81#define CMD_INDALA_CLONE_TAG 0x0212
82// for 224 bits UID
83#define CMD_INDALA_CLONE_TAG_L 0x0213
54a942b0 84#define CMD_T55XX_READ_BLOCK 0x0214
85#define CMD_T55XX_WRITE_BLOCK 0x0215
86#define CMD_T55XX_READ_TRACE 0x0216
87#define CMD_PCF7931_READ 0x0217
88#define CMD_EM4X_READ_WORD 0x0218
89#define CMD_EM4X_WRITE_WORD 0x0219
a1f3bb12 90#define CMD_IO_DEMOD_FSK 0x021A
91#define CMD_IO_CLONE_TAG 0x021B
abd6112f 92#define CMD_EM410X_DEMOD 0x021c
31abe49f
MHS
93// Sampling configuration for LF reader/snooper
94#define CMD_SET_LF_SAMPLING_CONFIG 0x021d
abd6112f 95#define CMD_FSK_SIM_TAG 0x021E
96#define CMD_ASK_SIM_TAG 0x021F
872e3d4d 97#define CMD_PSK_SIM_TAG 0x0220
66707a3b 98
e30c654b 99/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
100
101// For the 13.56 MHz tags
3ebf4b3d 102#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300
3ebf4b3d 103#define CMD_READ_SRI512_TAG 0x0303
104#define CMD_READ_SRIX4K_TAG 0x0304
7cf3ef20 105#define CMD_ISO_14443B_COMMAND 0x0305
3ebf4b3d 106#define CMD_READER_ISO_15693 0x0310
107#define CMD_SIMTAG_ISO_15693 0x0311
108#define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 0x0312
109#define CMD_ISO_15693_COMMAND 0x0313
110#define CMD_ISO_15693_COMMAND_DONE 0x0314
111#define CMD_ISO_15693_FIND_AFI 0x0315
112#define CMD_ISO_15693_DEBUG 0x0316
b014c96d 113#define CMD_LF_SNOOP_RAW_ADC_SAMPLES 0x0317
d19929cb 114
115// For Hitag2 transponders
116#define CMD_SNOOP_HITAG 0x0370
117#define CMD_SIMULATE_HITAG 0x0371
118#define CMD_READER_HITAG 0x0372
119
132a0217 120#define CMD_SIMULATE_TAG_ISO_14443B 0x0381
121#define CMD_SNOOP_ISO_14443B 0x0382
3ebf4b3d 122#define CMD_SNOOP_ISO_14443a 0x0383
123#define CMD_SIMULATE_TAG_ISO_14443a 0x0384
124#define CMD_READER_ISO_14443a 0x0385
125#define CMD_SIMULATE_TAG_LEGIC_RF 0x0387
126#define CMD_READER_LEGIC_RF 0x0388
127#define CMD_WRITER_LEGIC_RF 0x0389
5acd09bd 128#define CMD_EPA_PACE_COLLECT_NONCE 0x038A
3bb07d96 129#define CMD_EPA_PACE_REPLAY 0x038B
3ebf4b3d 130
131#define CMD_SNOOP_ICLASS 0x0392
132#define CMD_SIMULATE_TAG_ICLASS 0x0393
133#define CMD_READER_ICLASS 0x0394
f168b263 134#define CMD_READER_ICLASS_REPLAY 0x0395
135#define CMD_ICLASS_ISO14443A_WRITE 0x0397
7781a656 136#define CMD_ICLASS_EML_MEMSET 0x0398
e30c654b 137
138// For measurements of the antenna tuning
3ebf4b3d 139#define CMD_MEASURE_ANTENNA_TUNING 0x0400
140#define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401
141#define CMD_MEASURED_ANTENNA_TUNING 0x0410
142#define CMD_LISTEN_READER_FIELD 0x0420
e30c654b 143
144// For direct FPGA control
3ebf4b3d 145#define CMD_FPGA_MAJOR_MODE_OFF 0x0500
9ca155ba
M
146
147// For mifare commands
3ebf4b3d 148#define CMD_MIFARE_SET_DBGMODE 0x0600
149#define CMD_MIFARE_EML_MEMCLR 0x0601
150#define CMD_MIFARE_EML_MEMSET 0x0602
151#define CMD_MIFARE_EML_MEMGET 0x0603
152#define CMD_MIFARE_EML_CARDLOAD 0x0604
3fe4ff4f 153
154// magic chinese card commands
155#define CMD_MIFARE_CSETBLOCK 0x0605
156#define CMD_MIFARE_CGETBLOCK 0x0606
157#define CMD_MIFARE_CIDENT 0x0607
9ca155ba 158
3ebf4b3d 159#define CMD_SIMULATE_MIFARE_CARD 0x0610
9ca155ba 160
3ebf4b3d 161#define CMD_READER_MIFARE 0x0611
162#define CMD_MIFARE_NESTED 0x0612
9ca155ba 163
3ebf4b3d 164#define CMD_MIFARE_READBL 0x0620
f168b263 165#define CMD_MIFAREU_READBL 0x0720
3ebf4b3d 166#define CMD_MIFARE_READSC 0x0621
f168b263 167#define CMD_MIFAREU_READCARD 0x0721
3ebf4b3d 168#define CMD_MIFARE_WRITEBL 0x0622
f168b263 169#define CMD_MIFAREU_WRITEBL 0x0722
170#define CMD_MIFAREU_WRITEBL_COMPAT 0x0723
3fe4ff4f 171
3ebf4b3d 172#define CMD_MIFARE_CHKKEYS 0x0623
e30c654b 173
3ebf4b3d 174#define CMD_MIFARE_SNIFFER 0x0630
3fe4ff4f 175//ultralightC
9d87eb66 176#define CMD_MIFAREUC_AUTH 0x0724
177//0x0725 and 0x0726 no longer used
f168b263 178#define CMD_MIFAREUC_SETPWD 0x0727
179
3fe4ff4f 180
181// mifare desfire
182#define CMD_MIFARE_DESFIRE_READBL 0x0728
183#define CMD_MIFARE_DESFIRE_WRITEBL 0x0729
184#define CMD_MIFARE_DESFIRE_AUTH1 0x072a
185#define CMD_MIFARE_DESFIRE_AUTH2 0x072b
186#define CMD_MIFARE_DES_READER 0x072c
187#define CMD_MIFARE_DESFIRE_INFO 0x072d
188#define CMD_MIFARE_DESFIRE 0x072e
b62a5a84 189
3ebf4b3d 190#define CMD_UNKNOWN 0xFFFF
e30c654b 191
d2f487af 192
193//Mifare simulation flags
194#define FLAG_INTERACTIVE 0x01
195#define FLAG_4B_UID_IN_DATA 0x02
196#define FLAG_7B_UID_IN_DATA 0x04
197#define FLAG_NR_AR_ATTACK 0x08
198
199
aa41c605 200//Iclass reader flags
c8dd9b09 201#define FLAG_ICLASS_READER_ONLY_ONCE 0x01
6ce0e538 202#define FLAG_ICLASS_READER_CC 0x02
203#define FLAG_ICLASS_READER_CSN 0x04
204#define FLAG_ICLASS_READER_CONF 0x08
205#define FLAG_ICLASS_READER_AA 0x10
206#define FLAG_ICLASS_READER_ONE_TRY 0x20
caaf9618 207
d2f487af 208
31abe49f 209
e30c654b 210// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
211/* Whether a bootloader that understands the common_area is present */
212#define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)
213
214/* Whether a osimage that understands the common_area is present */
215#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)
216
217/* Set if the bootloader is currently executing */
218#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)
219
220/* Set if the OS is currently executing */
221#define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)
222
223/* Set if this device understands the extend start flash command */
224#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)
225
226/* CMD_START_FLASH may have three arguments: start of area to flash,
227 end of area to flash, optional magic.
228 The bootrom will not allow to overwrite itself unless this magic
229 is given as third parameter */
230
231#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
232
233#endif
Impressum, Datenschutz