[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
#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_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443_SIM	0x0302\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
\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
#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
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
3a8464f0	10	#ifdef _MSC_VER\r
	11	typedef DWORD uint32_t;\r
	12	typedef BYTE uint8_t;\r
	13	#define PACKED\r
	14	// stuff\r
	15	#else\r
	16	#include <stdint.h>\r
	17	#include <stdbool.h>\r
	18	#define PACKED __attribute__((packed))\r
	19	#endif\r
6658905f	20	\r
6658905f	21	typedef struct {\r
3a8464f0	22	uint32_t cmd;\r
3a8464f0	23	uint32_t arg[3];\r
6658905f	24	union {\r
3a8464f0	25	uint8_t asBytes[48];\r
3a8464f0	26	uint32_t asDwords[12];\r
6658905f	27	} d;\r
3a8464f0	28	} PACKED UsbCommand;\r
6658905f	29	\r
6658905f	30	// For the bootloader\r
3a8464f0	31	#define CMD_DEVICE_INFO 0x0000\r
	32	#define CMD_SETUP_WRITE 0x0001\r
	33	#define CMD_FINISH_WRITE 0x0003\r
	34	#define CMD_HARDWARE_RESET 0x0004\r
	35	#define CMD_START_FLASH 0x0005\r
	36	#define CMD_NACK 0x00fe\r
	37	#define CMD_ACK 0x00ff\r
6658905f	38	\r
6658905f	39	// For general mucking around\r
3a8464f0	40	#define CMD_DEBUG_PRINT_STRING 0x0100\r
	41	#define CMD_DEBUG_PRINT_INTEGERS 0x0101\r
	42	#define CMD_DEBUG_PRINT_BYTES 0x0102\r
	43	#define CMD_LCD_RESET 0x0103\r
	44	#define CMD_LCD 0x0104\r
	45	#define CMD_BUFF_CLEAR 0x0105\r
	46	#define CMD_READ_MEM 0x0106\r
	47	#define CMD_VERSION 0x0107\r
6658905f	48	\r
6658905f	49	// For low-frequency tags\r
3a8464f0	50	#define CMD_READ_TI_TYPE 0x0202\r
	51	#define CMD_WRITE_TI_TYPE 0x0203\r
	52	#define CMD_DOWNLOADED_RAW_BITS_TI_TYPE 0x0204\r
	53	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0205\r
	54	#define CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K 0x0206\r
	55	#define CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K 0x0207\r
	56	#define CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K 0x0208\r
	57	#define CMD_DOWNLOADED_SIM_SAMPLES_125K 0x0209\r
	58	#define CMD_SIMULATE_TAG_125K 0x020A\r
	59	#define CMD_HID_DEMOD_FSK 0x020B\r
	60	#define CMD_HID_SIM_TAG 0x020C\r
	61	#define CMD_SET_LF_DIVISOR 0x020D\r
	62	#define CMD_LF_SIMULATE_BIDIR 0x020E\r
	63	#define CMD_SET_ADC_MUX 0x020F\r
5fc8250f	64	/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */\r
6658905f	65	\r
6658905f	66	// For the 13.56 MHz tags\r
3a8464f0	67	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 0x0300\r
	68	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443 0x0301\r
	69	#define CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_14443_SIM 0x0302\r
	70	#define CMD_READ_SRI512_TAG 0x0303\r
	71	#define CMD_READ_SRIX4K_TAG 0x0304\r
	72	#define CMD_READER_ISO_15693 0x0310\r
	73	#define CMD_SIMTAG_ISO_15693 0x0311\r
	74	#define CMD_SIMULATE_TAG_HF_LISTEN 0x0380\r
	75	#define CMD_SIMULATE_TAG_ISO_14443 0x0381\r
	76	#define CMD_SNOOP_ISO_14443 0x0382\r
	77	#define CMD_SNOOP_ISO_14443a 0x0383\r
	78	#define CMD_SIMULATE_TAG_ISO_14443a 0x0384\r
	79	#define CMD_READER_ISO_14443a 0x0385\r
	80	#define CMD_SIMULATE_MIFARE_CARD 0x0386\r
	81	#define CMD_SIMULATE_TAG_LEGIC_RF 0x0387\r
	82	#define CMD_READER_LEGIC_RF 0x0388\r
6658905f	83	\r
6658905f	84	// For measurements of the antenna tuning\r
3a8464f0	85	#define CMD_MEASURE_ANTENNA_TUNING 0x0400\r
	86	#define CMD_MEASURED_ANTENNA_TUNING 0x0401\r
	87	#define CMD_LISTEN_READER_FIELD 0x0402\r
6658905f	88	\r
6658905f	89	// For direct FPGA control\r
3a8464f0	90	#define CMD_FPGA_MAJOR_MODE_OFF 0x0500\r
	91	\r
	92	#define CMD_UNKNOWN 0xFFFF\r
	93	\r
	94	// CMD_DEVICE_INFO response packet has flags in arg[0], flag definitions:\r
	95	/* Whether a bootloader that understands the common_area is present */ \r
	96	#define DEVICE_INFO_FLAG_BOOTROM_PRESENT (1<<0)\r
	97	\r
	98	/* Whether a osimage that understands the common_area is present */\r
	99	#define DEVICE_INFO_FLAG_OSIMAGE_PRESENT (1<<1)\r
	100	\r
	101	/* Set if the bootloader is currently executing */\r
	102	#define DEVICE_INFO_FLAG_CURRENT_MODE_BOOTROM (1<<2)\r
	103	\r
	104	/* Set if the OS is currently executing */\r
	105	#define DEVICE_INFO_FLAG_CURRENT_MODE_OS (1<<3)\r
	106	\r
	107	/* Set if this device understands the extend start flash command */\r
	108	#define DEVICE_INFO_FLAG_UNDERSTANDS_START_FLASH (1<<4)\r
6658905f	109	\r
3a8464f0	110	/* CMD_START_FLASH may have three arguments: start of area to flash, \r
	111	end of area to flash, optional magic.\r
	112	The bootrom will not allow to overwrite itself unless this magic\r
	113	is given as third parameter */\r
a5b1ba20	114	\r
3a8464f0	115	#define START_FLASH_MAGIC 0x54494f44 // 'DOIT'\r
a5b1ba20	116	\r
6658905f	117	#endif\r