[proxmark3-svn] / include / usb_cmd.h

//-----------------------------------------------------------------------------
// 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
#define CMD_IO_DEMOD_FSK                                                  0x021A
#define CMD_IO_CLONE_TAG                                                  0x021B
/* 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_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_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_MIFAREU_READBL						  0x0720
#define CMD_MIFARE_READSC                                                 0x0621
#define CMD_MIFAREU_READCARD						  0x0721
#define CMD_MIFARE_WRITEBL                                                0x0622
#define CMD_MIFAREU_WRITEBL_COMPAT					  0x0722
#define CMD_MIFAREU_WRITEBL						  0x0723
#define CMD_MIFARE_CHKKEYS                                                0x0623

#define CMD_MIFARE_SNIFFER                                                0x0630

#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_NR_AR_ATTACK 0x08


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