git.zerfleddert.de Git - proxmark3-svn/blob - include/usb_cmd.h

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