1 //-----------------------------------------------------------------------------
2 // Jonathan Westhues, Mar 2006
3 // Edits by Gerhard de Koning Gans, Sep 2007
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
8 //-----------------------------------------------------------------------------
9 // Definitions for all the types of commands that may be sent over USB; our
11 //-----------------------------------------------------------------------------
16 typedef DWORD
uint32_t;
23 #define PACKED __attribute__((packed))
31 uint32_t asDwords
[12];
36 #define CMD_DEVICE_INFO 0x0000
37 #define CMD_SETUP_WRITE 0x0001
38 #define CMD_FINISH_WRITE 0x0003
39 #define CMD_HARDWARE_RESET 0x0004
40 #define CMD_START_FLASH 0x0005
41 #define CMD_NACK 0x00fe
42 #define CMD_ACK 0x00ff
44 // For general mucking around
45 #define CMD_DEBUG_PRINT_STRING 0x0100
46 #define CMD_DEBUG_PRINT_INTEGERS 0x0101
47 #define CMD_DEBUG_PRINT_BYTES 0x0102
48 #define CMD_LCD_RESET 0x0103
49 #define CMD_LCD 0x0104
50 #define CMD_BUFF_CLEAR 0x0105
51 #define CMD_READ_MEM 0x0106
52 #define CMD_VERSION 0x0107
54 // For low-frequency tags
55 #define CMD_READ_TI_TYPE 0x0202
56 #define CMD_WRITE_TI_TYPE 0x0203
57 #define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204
58 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205
59 #define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206
60 #define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207
61 #define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208
62 #define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209
63 #define CMD_SIMULATE_TAG_125K 0x020A
64 #define CMD_HID_DEMOD_FSK 0x020B
65 #define CMD_HID_SIM_TAG 0x020C
66 #define CMD_SET_LF_DIVISOR 0x020D
67 #define CMD_LF_SIMULATE_BIDIR 0x020E
68 #define CMD_SET_ADC_MUX 0x020F
69 #define CMD_HID_CLONE_TAG 0x0210
70 #define CMD_EM410X_WRITE_TAG 0x0211
71 #define CMD_INDALA_CLONE_TAG 0x0212
73 #define CMD_INDALA_CLONE_TAG_L 0x0213
74 #define CMD_T55XX_READ_BLOCK 0x0214
75 #define CMD_T55XX_WRITE_BLOCK 0x0215
76 #define CMD_T55XX_RESET_READ 0x0216
77 #define CMD_PCF7931_READ 0x0217
78 #define CMD_EM4X_READ_WORD 0x0218
79 #define CMD_EM4X_WRITE_WORD 0x0219
80 #define CMD_IO_DEMOD_FSK 0x021A
81 #define CMD_IO_CLONE_TAG 0x021B
82 #define CMD_EM410X_DEMOD 0x021c
83 #define CMD_SET_LF_SAMPLING_CONFIG 0x021d
84 #define CMD_FSK_SIM_TAG 0x021E
85 #define CMD_ASK_SIM_TAG 0x021F
86 #define CMD_PSK_SIM_TAG 0x0220
87 #define CMD_AWID_DEMOD_FSK 0x0221
88 #define CMD_VIKING_CLONE_TAG 0x0223
89 #define CMD_T55XX_WAKEUP 0x0224
91 /* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
93 // For the 13.56 MHz tags
94 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300
95 #define CMD_READ_SRI512_TAG 0x0303
96 #define CMD_READ_SRIX4K_TAG 0x0304
97 #define CMD_READER_ISO_15693 0x0310
98 #define CMD_SIMTAG_ISO_15693 0x0311
99 #define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 0x0312
100 #define CMD_ISO_15693_COMMAND 0x0313
101 #define CMD_ISO_15693_COMMAND_DONE 0x0314
102 #define CMD_ISO_15693_FIND_AFI 0x0315
103 #define CMD_ISO_15693_DEBUG 0x0316
105 // For Hitag2 transponders
106 #define CMD_SNOOP_HITAG 0x0370
107 #define CMD_SIMULATE_HITAG 0x0371
108 #define CMD_READER_HITAG 0x0372
110 #define CMD_SIMULATE_TAG_ISO_14443B 0x0381
111 #define CMD_SNOOP_ISO_14443B 0x0382
112 #define CMD_SNOOP_ISO_14443a 0x0383
113 #define CMD_SIMULATE_TAG_ISO_14443a 0x0384
114 #define CMD_READER_ISO_14443a 0x0385
115 #define CMD_SIMULATE_TAG_LEGIC_RF 0x0387
116 #define CMD_READER_LEGIC_RF 0x0388
117 #define CMD_WRITER_LEGIC_RF 0x0389
118 #define CMD_EPA_PACE_COLLECT_NONCE 0x038A
120 #define CMD_ICLASS_READCHECK 0x038F
121 #define CMD_ICLASS_CLONE 0x0390
122 #define CMD_ICLASS_DUMP 0x0391
123 #define CMD_SNOOP_ICLASS 0x0392
124 #define CMD_SIMULATE_TAG_ICLASS 0x0393
125 #define CMD_READER_ICLASS 0x0394
126 #define CMD_READER_ICLASS_REPLAY 0x0395
127 #define CMD_ICLASS_READBLOCK 0x0396
128 #define CMD_ICLASS_WRITEBLOCK 0x0397
129 #define CMD_ICLASS_EML_MEMSET 0x0398
130 #define CMD_ICLASS_AUTHENTICATION 0x0399
132 // For measurements of the antenna tuning
133 #define CMD_MEASURE_ANTENNA_TUNING 0x0400
134 #define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401
135 #define CMD_MEASURED_ANTENNA_TUNING 0x0410
136 #define CMD_LISTEN_READER_FIELD 0x0420
138 // For direct FPGA control
139 #define CMD_FPGA_MAJOR_MODE_OFF 0x0500
141 // For mifare commands
142 #define CMD_MIFARE_SET_DBGMODE 0x0600
143 #define CMD_MIFARE_EML_MEMCLR 0x0601
144 #define CMD_MIFARE_EML_MEMSET 0x0602
145 #define CMD_MIFARE_EML_MEMGET 0x0603
146 #define CMD_MIFARE_EML_CARDLOAD 0x0604
147 #define CMD_MIFARE_EML_CSETBLOCK 0x0605
148 #define CMD_MIFARE_EML_CGETBLOCK 0x0606
150 #define CMD_SIMULATE_MIFARE_CARD 0x0610
152 #define CMD_READER_MIFARE 0x0611
153 #define CMD_MIFARE_NESTED 0x0612
155 #define CMD_MIFARE_READBL 0x0620
156 #define CMD_MIFARE_READSC 0x0621
157 #define CMD_MIFARE_WRITEBL 0x0622
158 #define CMD_MIFARE_CHKKEYS 0x0623
160 #define CMD_MIFARE_SNIFFER 0x0630
162 #define CMD_UNKNOWN 0xFFFF
164 // CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
165 /* Whether a bootloader that understands the common_area is present */
166 #define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)
168 /* Whether a osimage that understands the common_area is present */
169 #define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)
171 /* Set if the bootloader is currently executing */
172 #define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)
174 /* Set if the OS is currently executing */
175 #define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)
177 /* Set if this device understands the extend start flash command */
178 #define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)
180 /* CMD_START_FLASH may have three arguments: start of area to flash,
181 end of area to flash, optional magic.
182 The bootrom will not allow to overwrite itself unless this magic
183 is given as third parameter */
185 #define START_FLASH_MAGIC 0x54494f44 // 'DOIT'