[proxmark3-svn] / include / usb_cmd.h

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