[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

typedef struct {
	uint32_t	cmd;
	uint32_t	arg[3];
	union {
		uint8_t		asBytes[48];
		uint32_t	asDwords[12];
	} 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
/* 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
#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_MIFARE_CARD			0x0386
#define CMD_SIMULATE_TAG_LEGIC_RF			0x0387
#define CMD_READER_LEGIC_RF				0x0388
#define CMD_WRITER_LEGIC_RF				0x0399
#define CMD_READER_MIFARE				0x0389
#define CMD_SNOOP_ICLASS				0x0392

// 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

#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
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
	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 UsbCommand;
	34
	35	// For the bootloader
	36	#define CMD_DEVICE_INFO 0x0000
	37	#define CMD_SETUP_WRITE 0x0001
	38	#define CMD_FINISH_WRITE 0x0003
	39	#define CMD_HARDWARE_RESET 0x0004
	40	#define CMD_START_FLASH 0x0005
	41	#define CMD_NACK 0x00fe
	42	#define CMD_ACK 0x00ff
	43
	44	// For general mucking around
	45	#define CMD_DEBUG_PRINT_STRING 0x0100
	46	#define CMD_DEBUG_PRINT_INTEGERS 0x0101
	47	#define CMD_DEBUG_PRINT_BYTES 0x0102
	48	#define CMD_LCD_RESET 0x0103
	49	#define CMD_LCD 0x0104
	50	#define CMD_BUFF_CLEAR 0x0105
	51	#define CMD_READ_MEM 0x0106
	52	#define CMD_VERSION 0x0107
	53
	54	// For low-frequency tags
	55	#define CMD_READ_TI_TYPE 0x0202
	56	#define CMD_WRITE_TI_TYPE 0x0203
	57	#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204
	58	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205
	59	#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206
	60	#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207
	61	#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208
	62	#define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209
	63	#define CMD_SIMULATE_TAG_125K 0x020A
	64	#define CMD_HID_DEMOD_FSK 0x020B
	65	#define CMD_HID_SIM_TAG 0x020C
	66	#define CMD_SET_LF_DIVISOR 0x020D
	67	#define CMD_LF_SIMULATE_BIDIR 0x020E
	68	#define CMD_SET_ADC_MUX 0x020F
	69	/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
	70
	71	// For the 13.56 MHz tags
	72	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300
	73	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443 0x0301
	74	#define CMD_READ_SRI512_TAG 0x0303
75	#define CMD_READ_SRIX4K_TAG 0x0304
76	#define CMD_READER_ISO_15693 0x0310
77	#define CMD_SIMTAG_ISO_15693 0x0311
9455b51c	78	#define CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 0x0312
	79	#define CMD_ISO_15693_COMMAND 0x0313
	80	#define CMD_ISO_15693_COMMAND_DONE 0x0314
	81	#define CMD_ISO_15693_FIND_AFI 0x0315
	82	#define CMD_ISO_15693_DEBUG 0x0316
e30c654b	83	#define CMD_SIMULATE_TAG_HF_LISTEN 0x0380
	84	#define CMD_SIMULATE_TAG_ISO_14443 0x0381
	85	#define CMD_SNOOP_ISO_14443 0x0382
	86	#define CMD_SNOOP_ISO_14443a 0x0383
	87	#define CMD_SIMULATE_TAG_ISO_14443a 0x0384
	88	#define CMD_READER_ISO_14443a 0x0385
	89	#define CMD_SIMULATE_MIFARE_CARD 0x0386
	90	#define CMD_SIMULATE_TAG_LEGIC_RF 0x0387
	91	#define CMD_READER_LEGIC_RF 0x0388
3612a8a8	92	#define CMD_WRITER_LEGIC_RF 0x0399
e30c654b	93	#define CMD_READER_MIFARE 0x0389
cee5a30d	94	#define CMD_SNOOP_ICLASS 0x0392
e30c654b	95
	96	// For measurements of the antenna tuning
	97	#define CMD_MEASURE_ANTENNA_TUNING 0x0400
	98	#define CMD_MEASURE_ANTENNA_TUNING_HF 0x0401
	99	#define CMD_MEASURED_ANTENNA_TUNING 0x0410
	100	#define CMD_LISTEN_READER_FIELD 0x0420
	101
	102	// For direct FPGA control
	103	#define CMD_FPGA_MAJOR_MODE_OFF 0x0500
	104
	105	#define CMD_UNKNOWN 0xFFFF
	106
	107	// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:
	108	/* Whether a bootloader that understands the common_area is present */
	109	#define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)
	110
	111	/* Whether a osimage that understands the common_area is present */
	112	#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)
	113
	114	/* Set if the bootloader is currently executing */
	115	#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)
	116
	117	/* Set if the OS is currently executing */
	118	#define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)
	119
	120	/* Set if this device understands the extend start flash command */
	121	#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)
	122
	123	/* CMD_START_FLASH may have three arguments: start of area to flash,
	124	end of area to flash, optional magic.
	125	The bootrom will not allow to overwrite itself unless this magic
	126	is given as third parameter */
	127
	128	#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'
	129
	130	#endif