]> git.zerfleddert.de Git - proxmark3-svn/blobdiff - include/usb_cmd.h
Added 'core'-api, also added some error handling in scripts
[proxmark3-svn] / include / usb_cmd.h
index a0c2745ff0f97769a84be25bf9e20b477a67f3bc..eec849b8916310860fb074bc6c63c2023332a5e2 100644 (file)
-//-----------------------------------------------------------------------------\r
-// Definitions for all the types of commands that may be sent over USB; our\r
-// own protocol.\r
-// Jonathan Westhues, Mar 2006\r
-// Edits by Gerhard de Koning Gans, Sep 2007\r
-//-----------------------------------------------------------------------------\r
-\r
-#ifndef __USB_CMD_H\r
-#define __USB_CMD_H\r
-#ifdef _MSC_VER\r
-typedef DWORD uint32_t;\r
-typedef BYTE uint8_t;\r
-#define PACKED\r
-// stuff\r
-#else\r
-#include <stdint.h>\r
-#include <stdbool.h>\r
-#define PACKED __attribute__((packed))\r
-#endif\r
-\r
-typedef struct {\r
-       uint32_t        cmd;\r
-       uint32_t        arg[3];\r
-       union {\r
-               uint8_t         asBytes[48];\r
-               uint32_t        asDwords[12];\r
-       } d;\r
-} PACKED UsbCommand;\r
-\r
-// For the bootloader\r
-#define CMD_DEVICE_INFO                                        0x0000\r
-#define CMD_SETUP_WRITE                                        0x0001\r
-#define CMD_FINISH_WRITE                               0x0003\r
-#define CMD_HARDWARE_RESET                             0x0004\r
-#define CMD_START_FLASH                                        0x0005\r
-#define CMD_NACK                                       0x00fe\r
-#define CMD_ACK                                                0x00ff\r
-\r
-// For general mucking around\r
-#define CMD_DEBUG_PRINT_STRING                         0x0100\r
-#define CMD_DEBUG_PRINT_INTEGERS                       0x0101\r
-#define CMD_DEBUG_PRINT_BYTES                          0x0102\r
-#define CMD_LCD_RESET                                  0x0103\r
-#define CMD_LCD                                                0x0104\r
-#define CMD_BUFF_CLEAR                                 0x0105\r
-#define CMD_READ_MEM                                   0x0106\r
-#define CMD_VERSION                                    0x0107\r
-\r
-// For low-frequency tags\r
-#define CMD_READ_TI_TYPE                               0x0202\r
-#define CMD_WRITE_TI_TYPE                              0x0203\r
-#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE                        0x0204\r
-#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K               0x0205\r
-#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K      0x0206\r
-#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K              0x0207\r
-#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K            0x0208\r
-#define CMD_DOWNLOADED_SIM_SAMPLES_125K                        0x0209\r
-#define CMD_SIMULATE_TAG_125K                          0x020A\r
-#define CMD_HID_DEMOD_FSK                              0x020B\r
-#define CMD_HID_SIM_TAG                                        0x020C\r
-#define CMD_SET_LF_DIVISOR                             0x020D\r
-#define CMD_LF_SIMULATE_BIDIR                          0x020E\r
-#define CMD_SET_ADC_MUX                                        0x020F\r
-/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */\r
-\r
-// For the 13.56 MHz tags\r
-#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693          0x0300\r
-#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443          0x0301\r
-#define CMD_READ_SRI512_TAG                            0x0303\r
-#define CMD_READ_SRIX4K_TAG                            0x0304\r
-#define CMD_READER_ISO_15693                           0x0310\r
-#define CMD_SIMTAG_ISO_15693                           0x0311\r
-#define CMD_SIMULATE_TAG_HF_LISTEN                     0x0380\r
-#define CMD_SIMULATE_TAG_ISO_14443                     0x0381\r
-#define CMD_SNOOP_ISO_14443                            0x0382\r
-#define CMD_SNOOP_ISO_14443a                           0x0383\r
-#define CMD_SIMULATE_TAG_ISO_14443a                    0x0384\r
-#define CMD_READER_ISO_14443a                          0x0385\r
-#define CMD_SIMULATE_MIFARE_CARD                       0x0386\r
-#define CMD_SIMULATE_TAG_LEGIC_RF                      0x0387\r
-#define CMD_READER_LEGIC_RF                            0x0388\r
-#define CMD_READER_MIFARE                              0x0389\r
-\r
-// For measurements of the antenna tuning\r
-#define CMD_MEASURE_ANTENNA_TUNING                     0x0400\r
-#define CMD_MEASURE_ANTENNA_TUNING_HF                  0x0401\r
-#define CMD_MEASURED_ANTENNA_TUNING                    0x0410\r
-#define CMD_LISTEN_READER_FIELD                                0x0420\r
-\r
-// For direct FPGA control\r
-#define CMD_FPGA_MAJOR_MODE_OFF                                0x0500\r
-\r
-#define CMD_UNKNOWN                                    0xFFFF\r
-\r
-// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:\r
-/* Whether a bootloader that understands the common_area is present */ \r
-#define DEVICE_INFO_FLAG_BOOTROM_PRESENT               (1<<0)\r
-\r
-/* Whether a osimage that understands the common_area is present */\r
-#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT               (1<<1)\r
-\r
-/* Set if the bootloader is currently executing */\r
-#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM          (1<<2)\r
-\r
-/* Set if the OS is currently executing */\r
-#define DEVICE_INFO_FLAG_CURRENT_MODE_OS               (1<<3)\r
-\r
-/* Set if this device understands the extend start flash command */\r
-#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH       (1<<4)\r
-\r
-/* CMD_START_FLASH may have three arguments: start of area to flash, \r
-   end of area to flash, optional magic.\r
-   The bootrom will not allow to overwrite itself unless this magic\r
-   is given as third parameter */\r
-\r
-#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'\r
-\r
-#endif\r
+//-----------------------------------------------------------------------------
+// Jonathan Westhues, Mar 2006
+// Edits by Gerhard de Koning Gans, Sep 2007
+//
+// This code is licensed to you under the terms of the GNU GPL, version 2 or,
+// at your option, any later version. See the LICENSE.txt file for the text of
+// the license.
+//-----------------------------------------------------------------------------
+// Definitions for all the types of commands that may be sent over USB; our
+// own protocol.
+//-----------------------------------------------------------------------------
+
+#ifndef __USB_CMD_H
+#define __USB_CMD_H
+#ifdef _MSC_VER
+typedef DWORD uint32_t;
+typedef BYTE uint8_t;
+#define PACKED
+// stuff
+#else
+#include <stdint.h>
+#include <stdbool.h>
+#define PACKED __attribute__((packed))
+#endif
+
+#define USB_CMD_DATA_SIZE 512
+
+typedef struct {
+  uint64_t cmd;
+  uint64_t arg[3];
+  union {
+    uint8_t  asBytes[USB_CMD_DATA_SIZE];
+    uint32_t asDwords[USB_CMD_DATA_SIZE/4];
+  } d;
+} PACKED UsbCommand;
+
+// For the bootloader
+#define CMD_DEVICE_INFO                                                   0x0000
+#define CMD_SETUP_WRITE                                                   0x0001
+#define CMD_FINISH_WRITE                                                  0x0003
+#define CMD_HARDWARE_RESET                                                0x0004
+#define CMD_START_FLASH                                                   0x0005
+#define CMD_NACK                                                          0x00fe
+#define CMD_ACK                                                           0x00ff
+
+// For general mucking around
+#define CMD_DEBUG_PRINT_STRING                                            0x0100
+#define CMD_DEBUG_PRINT_INTEGERS                                          0x0101
+#define CMD_DEBUG_PRINT_BYTES                                             0x0102
+#define CMD_LCD_RESET                                                     0x0103
+#define CMD_LCD                                                           0x0104
+#define CMD_BUFF_CLEAR                                                    0x0105
+#define CMD_READ_MEM                                                      0x0106
+#define CMD_VERSION                                                       0x0107
+
+// For low-frequency tags
+#define CMD_READ_TI_TYPE                                                  0x0202
+#define CMD_WRITE_TI_TYPE                                                 0x0203
+#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE                                   0x0204
+#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K                                  0x0205
+#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K                         0x0206
+#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K                                 0x0207
+#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K                               0x0208
+#define CMD_DOWNLOADED_SIM_SAMPLES_125K                                   0x0209
+#define CMD_SIMULATE_TAG_125K                                             0x020A
+#define CMD_HID_DEMOD_FSK                                                 0x020B
+#define CMD_HID_SIM_TAG                                                   0x020C
+#define CMD_SET_LF_DIVISOR                                                0x020D
+#define CMD_LF_SIMULATE_BIDIR                                             0x020E
+#define CMD_SET_ADC_MUX                                                   0x020F
+#define CMD_HID_CLONE_TAG                                                 0x0210
+#define CMD_EM410X_WRITE_TAG                                              0x0211
+#define CMD_INDALA_CLONE_TAG                                              0x0212
+// for 224 bits UID
+#define CMD_INDALA_CLONE_TAG_L                                            0x0213
+#define CMD_T55XX_READ_BLOCK                                              0x0214
+#define CMD_T55XX_WRITE_BLOCK                                             0x0215
+#define CMD_T55XX_READ_TRACE                                              0x0216
+#define CMD_PCF7931_READ                                                  0x0217
+#define CMD_EM4X_READ_WORD                                                0x0218
+#define CMD_EM4X_WRITE_WORD                                               0x0219
+/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
+
+// For the 13.56 MHz tags
+#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693                             0x0300
+#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443                             0x0301
+#define CMD_READ_SRI512_TAG                                               0x0303
+#define CMD_READ_SRIX4K_TAG                                               0x0304
+#define CMD_READER_ISO_15693                                              0x0310
+#define CMD_SIMTAG_ISO_15693                                              0x0311
+#define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693                              0x0312
+#define CMD_ISO_15693_COMMAND                                             0x0313
+#define CMD_ISO_15693_COMMAND_DONE                                        0x0314
+#define CMD_ISO_15693_FIND_AFI                                            0x0315
+#define CMD_ISO_15693_DEBUG                                               0x0316
+
+// For Hitag2 transponders
+#define CMD_SNOOP_HITAG                                                   0x0370
+#define CMD_SIMULATE_HITAG                                                0x0371
+#define CMD_READER_HITAG                                                  0x0372
+
+#define CMD_SIMULATE_TAG_HF_LISTEN                                        0x0380
+#define CMD_SIMULATE_TAG_ISO_14443                                        0x0381
+#define CMD_SNOOP_ISO_14443                                               0x0382
+#define CMD_SNOOP_ISO_14443a                                              0x0383
+#define CMD_SIMULATE_TAG_ISO_14443a                                       0x0384
+#define CMD_READER_ISO_14443a                                             0x0385
+#define CMD_SIMULATE_TAG_LEGIC_RF                                         0x0387
+#define CMD_READER_LEGIC_RF                                               0x0388
+#define CMD_WRITER_LEGIC_RF                                               0x0389
+#define CMD_EPA_PACE_COLLECT_NONCE                                        0x038A
+
+#define CMD_SNOOP_ICLASS                                                  0x0392
+#define CMD_SIMULATE_TAG_ICLASS                                           0x0393
+#define CMD_READER_ICLASS                                                 0x0394
+
+// For measurements of the antenna tuning
+#define CMD_MEASURE_ANTENNA_TUNING                                        0x0400
+#define CMD_MEASURE_ANTENNA_TUNING_HF                                     0x0401
+#define CMD_MEASURED_ANTENNA_TUNING                                       0x0410
+#define CMD_LISTEN_READER_FIELD                                           0x0420
+
+// For direct FPGA control
+#define CMD_FPGA_MAJOR_MODE_OFF                                           0x0500
+
+// For mifare commands
+#define CMD_MIFARE_SET_DBGMODE                                            0x0600
+#define CMD_MIFARE_EML_MEMCLR                                             0x0601
+#define CMD_MIFARE_EML_MEMSET                                             0x0602
+#define CMD_MIFARE_EML_MEMGET                                             0x0603
+#define CMD_MIFARE_EML_CARDLOAD                                           0x0604
+#define CMD_MIFARE_EML_CSETBLOCK                                          0x0605
+#define CMD_MIFARE_EML_CGETBLOCK                                          0x0606
+
+#define CMD_SIMULATE_MIFARE_CARD                                          0x0610
+
+#define CMD_READER_MIFARE                                                 0x0611
+#define CMD_MIFARE_NESTED                                                 0x0612
+
+#define CMD_MIFARE_READBL                                                 0x0620
+#define CMD_MIFARE_READSC                                                 0x0621
+#define CMD_MIFARE_WRITEBL                                                0x0622
+#define CMD_MIFARE_CHKKEYS                                                0x0623
+
+#define CMD_MIFARE_SNIFFER                                                0x0630
+
+#define CMD_UNKNOWN                                                       0xFFFF
+
+// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
+/* Whether a bootloader that understands the common_area is present */
+#define DEVICE_INFO_FLAG_BOOTROM_PRESENT               (1<<0)
+
+/* Whether a osimage that understands the common_area is present */
+#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT               (1<<1)
+
+/* Set if the bootloader is currently executing */
+#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM          (1<<2)
+
+/* Set if the OS is currently executing */
+#define DEVICE_INFO_FLAG_CURRENT_MODE_OS               (1<<3)
+
+/* Set if this device understands the extend start flash command */
+#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH       (1<<4)
+
+/* CMD_START_FLASH may have three arguments: start of area to flash,
+   end of area to flash, optional magic.
+   The bootrom will not allow to overwrite itself unless this magic
+   is given as third parameter */
+
+#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
+
+#endif
Impressum, Datenschutz