include/usb_cmd.h

   1 //-----------------------------------------------------------------------------
   2 // Definitions for all the types of commands that may be sent over USB; our
   3 // own protocol.
   4 // Jonathan Westhues, Mar 2006
   5 // Edits by Gerhard de Koning Gans, Sep 2007
   6 //-----------------------------------------------------------------------------
   7
   8 #ifndef __USB_CMD_H
   9 #define __USB_CMD_H
  10 #ifdef _MSC_VER
  11 typedef DWORD uint32_t;
  12 typedef BYTE uint8_t;
  13 #define PACKED
  14 // stuff
  15 #else
  16 #include <stdint.h>
  17 #include <stdbool.h>
  18 #define PACKED __attribute__((packed))
  19 #endif
  20
  21 typedef struct {
  22         uint32_t        cmd;
  23         uint32_t        arg[3];
  24         union {
  25                 uint8_t         asBytes[48];
  26                 uint32_t        asDwords[12];
  27         } d;
  28 } PACKED UsbCommand;
  29
  30 // For the bootloader
  31 #define CMD_DEVICE_INFO                                 0x0000
  32 #define CMD_SETUP_WRITE                                 0x0001
  33 #define CMD_FINISH_WRITE                                0x0003
  34 #define CMD_HARDWARE_RESET                              0x0004
  35 #define CMD_START_FLASH                                 0x0005
  36 #define CMD_NACK                                        0x00fe
  37 #define CMD_ACK                                         0x00ff
  38
  39 // For general mucking around
  40 #define CMD_DEBUG_PRINT_STRING                          0x0100
  41 #define CMD_DEBUG_PRINT_INTEGERS                        0x0101
  42 #define CMD_DEBUG_PRINT_BYTES                           0x0102
  43 #define CMD_LCD_RESET                                   0x0103
  44 #define CMD_LCD                                         0x0104
  45 #define CMD_BUFF_CLEAR                                  0x0105
  46 #define CMD_READ_MEM                                    0x0106
  47 #define CMD_VERSION                                     0x0107
  48
  49 // For low-frequency tags
  50 #define CMD_READ_TI_TYPE                                0x0202
  51 #define CMD_WRITE_TI_TYPE                               0x0203
  52 #define CMD_DOWNLOADED_RAW_BITS_TI_TYPE                 0x0204
  53 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K                0x0205
  54 #define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K       0x0206
  55 #define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K               0x0207
  56 #define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K             0x0208
  57 #define CMD_DOWNLOADED_SIM_SAMPLES_125K                 0x0209
  58 #define CMD_SIMULATE_TAG_125K                           0x020A
  59 #define CMD_HID_DEMOD_FSK                               0x020B
  60 #define CMD_HID_SIM_TAG                                 0x020C
  61 #define CMD_SET_LF_DIVISOR                              0x020D
  62 #define CMD_LF_SIMULATE_BIDIR                           0x020E
  63 #define CMD_SET_ADC_MUX                                 0x020F
  64 /* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
  65
  66 // For the 13.56 MHz tags
  67 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693           0x0300
  68 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443           0x0301
  69 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443_SIM       0x0302
  70 #define CMD_READ_SRI512_TAG                             0x0303
  71 #define CMD_READ_SRIX4K_TAG                             0x0304
  72 #define CMD_READER_ISO_15693                            0x0310
  73 #define CMD_SIMTAG_ISO_15693                            0x0311
  74 #define CMD_SIMULATE_TAG_HF_LISTEN                      0x0380
  75 #define CMD_SIMULATE_TAG_ISO_14443                      0x0381
  76 #define CMD_SNOOP_ISO_14443                             0x0382
  77 #define CMD_SNOOP_ISO_14443a                            0x0383
  78 #define CMD_SIMULATE_TAG_ISO_14443a                     0x0384
  79 #define CMD_READER_ISO_14443a                           0x0385
  80 #define CMD_SIMULATE_MIFARE_CARD                        0x0386
  81 #define CMD_SIMULATE_TAG_LEGIC_RF                       0x0387
  82 #define CMD_READER_LEGIC_RF                             0x0388
  83
  84 // For measurements of the antenna tuning
  85 #define CMD_MEASURE_ANTENNA_TUNING                      0x0400
  86 #define CMD_MEASURED_ANTENNA_TUNING                     0x0401
  87 #define CMD_LISTEN_READER_FIELD                         0x0402
  88
  89 // For direct FPGA control
  90 #define CMD_FPGA_MAJOR_MODE_OFF                         0x0500
  91
  92 #define CMD_UNKNOWN                                     0xFFFF
  93
  94 // CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
  95 /* Whether a bootloader that understands the common_area is present */
  96 #define DEVICE_INFO_FLAG_BOOTROM_PRESENT                (1<<0)
  97
  98 /* Whether a osimage that understands the common_area is present */
  99 #define DEVICE_INFO_FLAG_OSIMAGE_PRESENT                (1<<1)
 100
 101 /* Set if the bootloader is currently executing */
 102 #define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM           (1<<2)
 103
 104 /* Set if the OS is currently executing */
 105 #define DEVICE_INFO_FLAG_CURRENT_MODE_OS                (1<<3)
 106
 107 /* Set if this device understands the extend start flash command */
 108 #define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH        (1<<4)
 109
 110 /* CMD_START_FLASH may have three arguments: start of area to flash,
 111    end of area to flash, optional magic.
 112    The bootrom will not allow to overwrite itself unless this magic
 113    is given as third parameter */
 114
 115 #define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
 116
 117 #endif