usb communication (device side) housekeeping

[proxmark3-svn] / include / usb_cmd.h

diff --git a/include/usb_cmd.h b/include/usb_cmd.h
index 0ab9730ed10ae09c4942c79cc129ca2e81c03840..082b7d50175eaff5a98c19c1a0d947d003520c46 100644 (file)
--- a/include/usb_cmd.h
+++ b/include/usb_cmd.h
@@ -10,13 +10,13 @@
 // own protocol.
 //-----------------------------------------------------------------------------
 
 // own protocol.
 //-----------------------------------------------------------------------------
 

-#ifndef __USB_CMD_H
-#define __USB_CMD_H
+#ifndef USB_CMD_H__
+#define USB_CMD_H__
+

 #ifdef _MSC_VER
 typedef DWORD uint32_t;
 typedef BYTE uint8_t;
 #define PACKED
 #ifdef _MSC_VER
 typedef DWORD uint32_t;
 typedef BYTE uint8_t;
 #define PACKED

-// stuff

 #else
 #include <stdint.h>
 #include <stdbool.h>
 #else
 #include <stdint.h>
 #include <stdbool.h>


@@ -26,22 +26,26 @@ typedef BYTE uint8_t;
 #define USB_CMD_DATA_SIZE 512
 
 typedef struct {
 #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;
+       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;
 } PACKED UsbCommand;

+
+

 // A struct used to send sample-configs over USB
 // A struct used to send sample-configs over USB

-typedef struct{
+typedef struct {

        uint8_t decimation;
        uint8_t bits_per_sample;
        bool averaging;
        int divisor;
        int trigger_threshold;
        uint8_t decimation;
        uint8_t bits_per_sample;
        bool averaging;
        int divisor;
        int trigger_threshold;

+       int samples_to_skip;

 } sample_config;
 
 } sample_config;
 

+

 // For the bootloader
 #define CMD_DEVICE_INFO                                                   0x0000
 #define CMD_SETUP_WRITE                                                   0x0001
 // For the bootloader
 #define CMD_DEVICE_INFO                                                   0x0000
 #define CMD_SETUP_WRITE                                                   0x0001


@@ -60,8 +64,20 @@ typedef struct{
 #define CMD_BUFF_CLEAR                                                    0x0105
 #define CMD_READ_MEM                                                      0x0106
 #define CMD_VERSION                                                       0x0107
 #define CMD_BUFF_CLEAR                                                    0x0105
 #define CMD_READ_MEM                                                      0x0106
 #define CMD_VERSION                                                       0x0107

-#define CMD_STATUS                                                                                                               0x0108
-#define CMD_PING                                                                                                                 0x0109
+#define CMD_STATUS                                                        0x0108
+#define CMD_PING                                                          0x0109
+
+// controlling the ADC input multiplexer
+#define CMD_SET_ADC_MUX                                                   0x020F
+
+// RDV40,  Smart card operations
+#define CMD_SMART_RAW                                                     0x0140
+#define CMD_SMART_UPGRADE                                                 0x0141
+#define CMD_SMART_UPLOAD                                                  0x0142
+#define CMD_SMART_ATR                                                     0x0143
+// CMD_SMART_SETBAUD is unused for now
+#define CMD_SMART_SETBAUD                                                 0x0144
+#define CMD_SMART_SETCLOCK                                                0x0145

 
 // For low-frequency tags
 #define CMD_READ_TI_TYPE                                                  0x0202
 
 // For low-frequency tags
 #define CMD_READ_TI_TYPE                                                  0x0202


@@ -77,7 +93,6 @@ typedef struct{
 #define CMD_HID_SIM_TAG                                                   0x020C
 #define CMD_SET_LF_DIVISOR                                                0x020D
 #define CMD_LF_SIMULATE_BIDIR                                             0x020E
 #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
 #define CMD_HID_CLONE_TAG                                                 0x0210
 #define CMD_EM410X_WRITE_TAG                                              0x0211
 #define CMD_INDALA_CLONE_TAG                                              0x0212


@@ -88,6 +103,7 @@ typedef struct{
 #define CMD_T55XX_RESET_READ                                              0x0216
 #define CMD_PCF7931_READ                                                  0x0217
 #define CMD_PCF7931_WRITE                                                 0x0222
 #define CMD_T55XX_RESET_READ                                              0x0216
 #define CMD_PCF7931_READ                                                  0x0217
 #define CMD_PCF7931_WRITE                                                 0x0222

+#define CMD_PCF7931_BRUTEFORCE                                            0x0227

 #define CMD_EM4X_READ_WORD                                                0x0218
 #define CMD_EM4X_WRITE_WORD                                               0x0219
 #define CMD_IO_DEMOD_FSK                                                  0x021A
 #define CMD_EM4X_READ_WORD                                                0x0218
 #define CMD_EM4X_WRITE_WORD                                               0x0219
 #define CMD_IO_DEMOD_FSK                                                  0x021A


@@ -102,9 +118,8 @@ typedef struct{
 #define CMD_VIKING_CLONE_TAG                                              0x0223
 #define CMD_T55XX_WAKEUP                                                  0x0224
 #define CMD_COTAG                                                         0x0225
 #define CMD_VIKING_CLONE_TAG                                              0x0223
 #define CMD_T55XX_WAKEUP                                                  0x0224
 #define CMD_COTAG                                                         0x0225

-
-
-/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
+#define CMD_PARADOX_CLONE_TAG                                             0x0226
+#define CMD_EM4X_PROTECT                                                  0x0228

 
 // For the 13.56 MHz tags
 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693                             0x0300
 
 // For the 13.56 MHz tags
 #define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693                             0x0300


@@ -113,24 +128,24 @@ typedef struct{
 #define CMD_ISO_14443B_COMMAND                                            0x0305
 #define CMD_READER_ISO_15693                                              0x0310
 #define CMD_SIMTAG_ISO_15693                                              0x0311
 #define CMD_ISO_14443B_COMMAND                                            0x0305
 #define CMD_READER_ISO_15693                                              0x0310
 #define CMD_SIMTAG_ISO_15693                                              0x0311

-#define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693                              0x0312
+#define CMD_SNOOP_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
 #define CMD_LF_SNOOP_RAW_ADC_SAMPLES                                      0x0317
 #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
 #define CMD_LF_SNOOP_RAW_ADC_SAMPLES                                      0x0317

+#define CMD_CSETUID_ISO_15693                                             0x0318

 
 // For Hitag2 transponders
 #define CMD_SNOOP_HITAG                                                   0x0370
 #define CMD_SIMULATE_HITAG                                                0x0371
 #define CMD_READER_HITAG                                                  0x0372
 
 // For Hitag2 transponders
 #define CMD_SNOOP_HITAG                                                   0x0370
 #define CMD_SIMULATE_HITAG                                                0x0371
 #define CMD_READER_HITAG                                                  0x0372

-

 #define CMD_SIMULATE_HITAG_S                                              0x0368
 #define CMD_SIMULATE_HITAG_S                                              0x0368

-#define CMD_TEST_HITAGS_TRACES                                           0x0367
-#define CMD_READ_HITAG_S                                                 0x0373
-#define CMD_WR_HITAG_S                                                   0x0375
-#define CMD_EMU_HITAG_S                                                          0x0376
-
+#define CMD_TEST_HITAGS_TRACES                                            0x0367
+#define CMD_READ_HITAG_S                                                  0x0373
+#define CMD_READ_HITAG_S_BLK                                              0x0374
+#define CMD_WR_HITAG_S                                                    0x0375
+#define CMD_EMU_HITAG_S                                                   0x0376

 
 #define CMD_SIMULATE_TAG_ISO_14443B                                       0x0381
 #define CMD_SNOOP_ISO_14443B                                              0x0382
 
 #define CMD_SIMULATE_TAG_ISO_14443B                                       0x0381
 #define CMD_SNOOP_ISO_14443B                                              0x0382


@@ -143,17 +158,16 @@ typedef struct{
 #define CMD_EPA_PACE_COLLECT_NONCE                                        0x038A
 #define CMD_EPA_PACE_REPLAY                                               0x038B
 
 #define CMD_EPA_PACE_COLLECT_NONCE                                        0x038A
 #define CMD_EPA_PACE_REPLAY                                               0x038B
 

-#define CMD_ICLASS_READCHECK                                              0x038F

 #define CMD_ICLASS_CLONE                                                  0x0390
 #define CMD_ICLASS_DUMP                                                   0x0391
 #define CMD_SNOOP_ICLASS                                                  0x0392
 #define CMD_SIMULATE_TAG_ICLASS                                           0x0393
 #define CMD_READER_ICLASS                                                 0x0394
 #define CMD_ICLASS_CLONE                                                  0x0390
 #define CMD_ICLASS_DUMP                                                   0x0391
 #define CMD_SNOOP_ICLASS                                                  0x0392
 #define CMD_SIMULATE_TAG_ICLASS                                           0x0393
 #define CMD_READER_ICLASS                                                 0x0394

-#define CMD_READER_ICLASS_REPLAY                                          0x0395

 #define CMD_ICLASS_READBLOCK                                              0x0396
 #define CMD_ICLASS_WRITEBLOCK                                             0x0397
 #define CMD_ICLASS_EML_MEMSET                                             0x0398
 #define CMD_ICLASS_READBLOCK                                              0x0396
 #define CMD_ICLASS_WRITEBLOCK                                             0x0397
 #define CMD_ICLASS_EML_MEMSET                                             0x0398

-#define CMD_ICLASS_AUTHENTICATION                                         0x0399
+#define CMD_ICLASS_CHECK                                                  0x0399
+#define CMD_ICLASS_READCHECK                                              0x039A

 
 // For measurements of the antenna tuning
 #define CMD_MEASURE_ANTENNA_TUNING                                        0x0400
 
 // For measurements of the antenna tuning
 #define CMD_MEASURE_ANTENNA_TUNING                                        0x0400


@@ -175,6 +189,7 @@ typedef struct{
 #define CMD_MIFARE_CSETBLOCK                                              0x0605
 #define CMD_MIFARE_CGETBLOCK                                              0x0606
 #define CMD_MIFARE_CIDENT                                                 0x0607
 #define CMD_MIFARE_CSETBLOCK                                              0x0605
 #define CMD_MIFARE_CGETBLOCK                                              0x0606
 #define CMD_MIFARE_CIDENT                                                 0x0607

+#define CMD_MIFARE_CWIPE                                                  0x0608

 
 #define CMD_SIMULATE_MIFARE_CARD                                          0x0610
 
 
 #define CMD_SIMULATE_MIFARE_CARD                                          0x0610
 


@@ -183,19 +198,19 @@ typedef struct{
 #define CMD_MIFARE_ACQUIRE_ENCRYPTED_NONCES                               0x0613
 
 #define CMD_MIFARE_READBL                                                 0x0620
 #define CMD_MIFARE_ACQUIRE_ENCRYPTED_NONCES                               0x0613
 
 #define CMD_MIFARE_READBL                                                 0x0620

-#define CMD_MIFAREU_READBL                                                0x0720

 #define CMD_MIFARE_READSC                                                 0x0621
 #define CMD_MIFARE_READSC                                                 0x0621

-#define CMD_MIFAREU_READCARD                                              0x0721

 #define CMD_MIFARE_WRITEBL                                                0x0622
 #define CMD_MIFARE_WRITEBL                                                0x0622

-#define CMD_MIFAREU_WRITEBL                                               0x0722
-#define CMD_MIFAREU_WRITEBL_COMPAT                                        0x0723
-

 #define CMD_MIFARE_CHKKEYS                                                0x0623
 #define CMD_MIFARE_CHKKEYS                                                0x0623

-
+#define CMD_MIFARE_PERSONALIZE_UID                                        0x0624

 #define CMD_MIFARE_SNIFFER                                                0x0630
 #define CMD_MIFARE_SNIFFER                                                0x0630

+

 //ultralightC
 //ultralightC

+#define CMD_MIFAREU_READBL                                                0x0720
+#define CMD_MIFAREU_READCARD                                              0x0721
+#define CMD_MIFAREU_WRITEBL                                               0x0722
+#define CMD_MIFAREU_WRITEBL_COMPAT                                        0x0723

 #define CMD_MIFAREUC_AUTH                                                 0x0724
 #define CMD_MIFAREUC_AUTH                                                 0x0724

-//0x0725 and 0x0726 no longer used 
+//0x0725 and 0x0726 no longer used

 #define CMD_MIFAREUC_SETPWD                                               0x0727
 
 
 #define CMD_MIFAREUC_SETPWD                                               0x0727
 
 


@@ -209,50 +224,63 @@ typedef struct{
 #define CMD_MIFARE_DESFIRE                                                0x072e
 
 #define CMD_HF_SNIFFER                                                    0x0800
 #define CMD_MIFARE_DESFIRE                                                0x072e
 
 #define CMD_HF_SNIFFER                                                    0x0800

+#define CMD_HF_PLOT                                                       0x0801

 
 #define CMD_UNKNOWN                                                       0xFFFF
 
 
 
 #define CMD_UNKNOWN                                                       0xFFFF
 
 

-//Mifare simulation flags
-#define FLAG_INTERACTIVE      0x01
-#define FLAG_4B_UID_IN_DATA   0x02
-#define FLAG_7B_UID_IN_DATA   0x04
-#define FLAG_10B_UID_IN_DATA  0x08
-#define FLAG_NR_AR_ATTACK     0x10
-#define FLAG_RANDOM_NONCE     0x20
+// Mifare simulation flags
+#define FLAG_INTERACTIVE                 (1<<0)
+#define FLAG_4B_UID_IN_DATA              (1<<1)
+#define FLAG_7B_UID_IN_DATA              (1<<2)
+#define FLAG_NR_AR_ATTACK                (1<<4)
+#define FLAG_RANDOM_NONCE                (1<<5)

 
 
 
 

-//Iclass reader flags
-#define FLAG_ICLASS_READER_ONLY_ONCE    0x01
-#define FLAG_ICLASS_READER_CC           0x02
-#define FLAG_ICLASS_READER_CSN          0x04
-#define FLAG_ICLASS_READER_CONF         0x08
-#define FLAG_ICLASS_READER_AA           0x10
-#define FLAG_ICLASS_READER_ONE_TRY      0x20
-#define FLAG_ICLASS_READER_CEDITKEY     0x40
+// iCLASS reader flags
+#define FLAG_ICLASS_READER_INIT          (1<<0)
+#define FLAG_ICLASS_READER_CC            (1<<1)
+#define FLAG_ICLASS_READER_CSN           (1<<2)
+#define FLAG_ICLASS_READER_CONF          (1<<3)
+#define FLAG_ICLASS_READER_AA            (1<<4)
+#define FLAG_ICLASS_READER_CREDITKEY     (1<<5)
+#define FLAG_ICLASS_READER_CLEARTRACE    (1<<6)

 
 
 
 

-//hw tune args
+// iCLASS simulation modes
+#define ICLASS_SIM_MODE_CSN                   0
+#define ICLASS_SIM_MODE_CSN_DEFAULT           1
+#define ICLASS_SIM_MODE_READER_ATTACK         2
+#define ICLASS_SIM_MODE_FULL                  3
+#define ICLASS_SIM_MODE_READER_ATTACK_KEYROLL 4
+#define ICLASS_SIM_MODE_EXIT_AFTER_MAC        5  // note: device internal only
+
+
+// hw tune args

 #define FLAG_TUNE_LF   1
 #define FLAG_TUNE_HF   2
 #define FLAG_TUNE_ALL  3
 
 #define FLAG_TUNE_LF   1
 #define FLAG_TUNE_HF   2
 #define FLAG_TUNE_ALL  3
 

+// Hardware capabilities
+#define HAS_EXTRA_FLASH_MEM    (1 << 0)
+#define HAS_SMARTCARD_SLOT     (1 << 1)
+

 
 // CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
 /* Whether a bootloader that understands the common_area is present */
 
 // 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)
+#define DEVICE_INFO_FLAG_BOOTROM_PRESENT            (1<<0)

 
 /* Whether a osimage that understands the common_area is present */
 
 /* Whether a osimage that understands the common_area is present */

-#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT               (1<<1)
+#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT            (1<<1)

 
 /* Set if the bootloader is currently executing */
 
 /* Set if the bootloader is currently executing */

-#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM          (1<<2)
+#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM       (1<<2)

 
 /* Set if the OS is currently executing */
 
 /* Set if the OS is currently executing */

-#define DEVICE_INFO_FLAG_CURRENT_MODE_OS               (1<<3)
+#define DEVICE_INFO_FLAG_CURRENT_MODE_OS            (1<<3)

 
 /* Set if this device understands the extend start flash command */
 
 /* Set if this device understands the extend start flash command */

-#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH       (1<<4)
+#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.
 
 /* CMD_START_FLASH may have three arguments: start of area to flash,
    end of area to flash, optional magic.