| 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 | typedef struct { |
| 27 | uint32_t cmd; |
| 28 | uint32_t arg[3]; |
| 29 | union { |
| 30 | uint8_t asBytes[48]; |
| 31 | uint32_t asDwords[12]; |
| 32 | } d; |
| 33 | } PACKED UsbCommand; |
| 34 | |
| 35 | // For the bootloader |
| 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 |
| 43 | |
| 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 |
| 53 | #define CMD_STATUS 0x0108 |
| 54 | #define CMD_PING 0x0109 |
| 55 | |
| 56 | #define CMD_DOWNLOAD_EML_BIGBUF 0x0110 |
| 57 | #define CMD_DOWNLOADED_EML_BIGBUF 0x0111 |
| 58 | |
| 59 | // For low-frequency tags |
| 60 | #define CMD_READ_TI_TYPE 0x0202 |
| 61 | #define CMD_WRITE_TI_TYPE 0x0203 |
| 62 | #define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204 |
| 63 | #define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205 |
| 64 | #define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206 |
| 65 | #define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207 |
| 66 | #define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208 |
| 67 | #define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209 |
| 68 | #define CMD_SIMULATE_TAG_125K 0x020A |
| 69 | #define CMD_HID_DEMOD_FSK 0x020B |
| 70 | #define CMD_HID_SIM_TAG 0x020C |
| 71 | #define CMD_SET_LF_DIVISOR 0x020D |
| 72 | #define CMD_LF_SIMULATE_BIDIR 0x020E |
| 73 | #define CMD_SET_ADC_MUX 0x020F |
| 74 | #define CMD_HID_CLONE_TAG 0x0210 |
| 75 | #define CMD_EM410X_WRITE_TAG 0x0211 |
| 76 | #define CMD_INDALA_CLONE_TAG 0x0212 |
| 77 | // for 224 bits UID |
| 78 | #define CMD_INDALA_CLONE_TAG_L 0x0213 |
| 79 | #define CMD_T55XX_READ_BLOCK 0x0214 |
| 80 | #define CMD_T55XX_WRITE_BLOCK 0x0215 |
| 81 | #define CMD_T55XX_RESET_READ 0x0216 |
| 82 | #define CMD_T55XX_WAKEUP 0x0224 |
| 83 | |
| 84 | #define CMD_PCF7931_READ 0x0217 |
| 85 | #define CMD_PCF7931_WRITE 0x0223 |
| 86 | #define CMD_EM4X_READ_WORD 0x0218 |
| 87 | #define CMD_EM4X_WRITE_WORD 0x0219 |
| 88 | #define CMD_IO_DEMOD_FSK 0x021A |
| 89 | #define CMD_IO_CLONE_TAG 0x021B |
| 90 | #define CMD_EM410X_DEMOD 0x021c |
| 91 | // Sampling configuration for LF reader/snooper |
| 92 | #define CMD_SET_LF_SAMPLING_CONFIG 0x021d |
| 93 | #define CMD_FSK_SIM_TAG 0x021E |
| 94 | #define CMD_ASK_SIM_TAG 0x021F |
| 95 | #define CMD_PSK_SIM_TAG 0x0220 |
| 96 | #define CMD_AWID_DEMOD_FSK 0x0221 |
| 97 | #define CMD_VIKING_CLONE_TAG 0x0222 |
| 98 | |
| 99 | |
| 100 | /* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */ |
| 101 | |
| 102 | // For the 13.56 MHz tags |
| 103 | #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300 |
| 104 | #define CMD_READ_SRI_TAG 0x0303 |
| 105 | #define CMD_ISO_14443B_COMMAND 0x0305 |
| 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 |
| 113 | #define CMD_LF_SNOOP_RAW_ADC_SAMPLES 0x0317 |
| 114 | |
| 115 | // For Hitag2 transponders |
| 116 | #define CMD_SNOOP_HITAG 0x0370 |
| 117 | #define CMD_SIMULATE_HITAG 0x0371 |
| 118 | #define CMD_READER_HITAG 0x0372 |
| 119 | |
| 120 | // For HitagS |
| 121 | #define CMD_SIMULATE_HITAG_S 0x0368 |
| 122 | #define CMD_TEST_HITAGS_TRACES 0x0367 |
| 123 | #define CMD_READ_HITAG_S 0x0373 |
| 124 | #define CMD_WR_HITAG_S 0x0375 |
| 125 | #define CMD_EMU_HITAG_S 0x0376 |
| 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_SNOOP_ICLASS 0x0392 |
| 139 | #define CMD_SIMULATE_TAG_ICLASS 0x0393 |
| 140 | #define CMD_READER_ICLASS 0x0394 |
| 141 | #define CMD_READER_ICLASS_REPLAY 0x0395 |
| 142 | #define CMD_ICLASS_ISO14443A_WRITE 0x0397 |
| 143 | #define CMD_ICLASS_EML_MEMSET 0x0398 |
| 144 | |
| 145 | // For measurements of the antenna tuning |
| 146 | #define CMD_MEASURE_ANTENNA_TUNING 0x0400 |
| 147 | #define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401 |
| 148 | #define CMD_MEASURED_ANTENNA_TUNING 0x0410 |
| 149 | #define CMD_LISTEN_READER_FIELD 0x0420 |
| 150 | |
| 151 | // For direct FPGA control |
| 152 | #define CMD_FPGA_MAJOR_MODE_OFF 0x0500 |
| 153 | |
| 154 | // For mifare commands |
| 155 | #define CMD_MIFARE_SET_DBGMODE 0x0600 |
| 156 | #define CMD_MIFARE_EML_MEMCLR 0x0601 |
| 157 | #define CMD_MIFARE_EML_MEMSET 0x0602 |
| 158 | #define CMD_MIFARE_EML_MEMGET 0x0603 |
| 159 | #define CMD_MIFARE_EML_CARDLOAD 0x0604 |
| 160 | |
| 161 | // magic chinese card commands |
| 162 | #define CMD_MIFARE_CSETBLOCK 0x0605 |
| 163 | #define CMD_MIFARE_CGETBLOCK 0x0606 |
| 164 | #define CMD_MIFARE_CIDENT 0x0607 |
| 165 | |
| 166 | #define CMD_SIMULATE_MIFARE_CARD 0x0610 |
| 167 | |
| 168 | #define CMD_READER_MIFARE 0x0611 |
| 169 | #define CMD_MIFARE_NESTED 0x0612 |
| 170 | #define CMD_MIFARE_ACQUIRE_ENCRYPTED_NONCES 0x0613 |
| 171 | |
| 172 | |
| 173 | #define CMD_MIFARE_READBL 0x0620 |
| 174 | #define CMD_MIFAREU_READBL 0x0720 |
| 175 | #define CMD_MIFARE_READSC 0x0621 |
| 176 | #define CMD_MIFAREU_READCARD 0x0721 |
| 177 | #define CMD_MIFARE_WRITEBL 0x0622 |
| 178 | #define CMD_MIFAREU_WRITEBL 0x0722 |
| 179 | #define CMD_MIFAREU_WRITEBL_COMPAT 0x0723 |
| 180 | |
| 181 | #define CMD_MIFARE_CHKKEYS 0x0623 |
| 182 | |
| 183 | #define CMD_MIFARE_SNIFFER 0x0630 |
| 184 | //ultralightC |
| 185 | #define CMD_MIFAREUC_AUTH 0x0724 |
| 186 | //0x0725 and 0x0726 no longer used |
| 187 | #define CMD_MIFAREUC_SETPWD 0x0727 |
| 188 | |
| 189 | |
| 190 | // mifare desfire |
| 191 | #define CMD_MIFARE_DESFIRE_READBL 0x0728 |
| 192 | #define CMD_MIFARE_DESFIRE_WRITEBL 0x0729 |
| 193 | #define CMD_MIFARE_DESFIRE_AUTH1 0x072a |
| 194 | #define CMD_MIFARE_DESFIRE_AUTH2 0x072b |
| 195 | #define CMD_MIFARE_DES_READER 0x072c |
| 196 | #define CMD_MIFARE_DESFIRE_INFO 0x072d |
| 197 | #define CMD_MIFARE_DESFIRE 0x072e |
| 198 | |
| 199 | #define CMD_MIFARE_COLLECT_NONCES 0x072f |
| 200 | |
| 201 | #define CMD_HF_SNIFFER 0x0800 |
| 202 | |
| 203 | #define CMD_UNKNOWN 0xFFFF |
| 204 | |
| 205 | |
| 206 | //Mifare simulation flags |
| 207 | #define FLAG_INTERACTIVE 0x01 |
| 208 | #define FLAG_4B_UID_IN_DATA 0x02 |
| 209 | #define FLAG_7B_UID_IN_DATA 0x04 |
| 210 | #define FLAG_10B_UID_IN_DATA 0x08 |
| 211 | #define FLAG_UID_IN_EMUL 0x10 |
| 212 | #define FLAG_NR_AR_ATTACK 0x20 |
| 213 | |
| 214 | |
| 215 | //Iclass reader flags |
| 216 | #define FLAG_ICLASS_READER_ONLY_ONCE 0x01 |
| 217 | #define FLAG_ICLASS_READER_CC 0x02 |
| 218 | #define FLAG_ICLASS_READER_CSN 0x04 |
| 219 | #define FLAG_ICLASS_READER_CONF 0x08 |
| 220 | #define FLAG_ICLASS_READER_AA 0x10 |
| 221 | #define FLAG_ICLASS_READER_ONE_TRY 0x20 |
| 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 |