[proxmark3-svn] / client / lualibs / commands.lua

--[[
These are command definitions. This file should correspond exactly to usb_cmd.h. 
--]]
--// For the bootloader
local _commands = {
	CMD_DEVICE_INFO =                                                    0x0000,
	CMD_SETUP_WRITE =                                                    0x0001,
	CMD_FINISH_WRITE =                                                   0x0003,
	CMD_HARDWARE_RESET =                                                 0x0004,
	CMD_START_FLASH =                                                    0x0005,
	CMD_NACK =                                                           0x00fe,
	CMD_ACK =                                                            0x00ff,

	--// For general mucking around
	CMD_DEBUG_PRINT_STRING =                                             0x0100,
	CMD_DEBUG_PRINT_INTEGERS =                                           0x0101,
	CMD_DEBUG_PRINT_BYTES =                                              0x0102,
	CMD_LCD_RESET =                                                      0x0103,
	CMD_LCD =                                                            0x0104,
	CMD_BUFF_CLEAR =                                                     0x0105,
	CMD_READ_MEM =                                                       0x0106,
	CMD_VERSION =                                                        0x0107,
	CMD_STATUS =                                                         0x0108,
	CMD_PING =                                                           0x0109,
	--// For low-frequency tags
	CMD_READ_TI_TYPE =                                                   0x0202,
	CMD_WRITE_TI_TYPE =                                                  0x0203,
	CMD_DOWNLOADED_RAW_BITS_TI_TYPE =                                    0x0204,
	CMD_ACQUIRE_RAW_ADC_SAMPLES_125K =                                   0x0205,
	CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K =                          0x0206,
	CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K =                                  0x0207,
	CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K =                                0x0208,
	CMD_DOWNLOADED_SIM_SAMPLES_125K =                                    0x0209,
	CMD_SIMULATE_TAG_125K =                                              0x020A,
	CMD_HID_DEMOD_FSK =                                                  0x020B,
	CMD_HID_SIM_TAG =                                                    0x020C,
	CMD_SET_LF_DIVISOR =                                                 0x020D,
	CMD_LF_SIMULATE_BIDIR =                                              0x020E,
	CMD_SET_ADC_MUX =                                                    0x020F,
	CMD_HID_CLONE_TAG =                                                  0x0210,
	CMD_EM410X_WRITE_TAG =                                               0x0211,
	CMD_INDALA_CLONE_TAG =                                               0x0212,
	--// for 224 bits UID
	CMD_INDALA_CLONE_TAG_L =                                             0x0213,
	CMD_T55XX_READ_BLOCK =                                               0x0214,
	CMD_T55XX_WRITE_BLOCK =                                              0x0215,
	CMD_T55XX_RESET_READ =                                               0x0216,
	CMD_PCF7931_READ =                                                   0x0217,
	CMD_EM4X_READ_WORD =                                                 0x0218,
	CMD_EM4X_WRITE_WORD =                                                0x0219,
	CMD_IO_DEMOD_FSK =                                                   0x021A,
	CMD_IO_CLONE_TAG =                                                   0x021B,
	CMD_EM410X_DEMOD =                                                   0x021c,
	CMD_SET_LF_SAMPLING_CONFIG =                                         0x021d,
	CMD_FSK_SIM_TAG =                                                    0x021E,
	CMD_ASK_SIM_TAG =                                                    0x021F,
	CMD_PSK_SIM_TAG =                                                    0x0220,
	CMD_AWID_DEMOD_FSK =                                                 0x0221,
	CMD_VIKING_CLONE_TAG =                                               0x0223,
	CMD_T55XX_WAKEUP =                                                   0x0224,
	CMD_COTAG =                                                          0x0225,
	--/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */

	--// For the 13.56 MHz tags
	CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 =                              0x0300,
	CMD_READ_SRI512_TAG =                                                0x0303,
	CMD_READ_SRIX4K_TAG =                                                0x0304,
	CMD_READER_ISO_15693 =                                               0x0310,
	CMD_SIMTAG_ISO_15693 =                                               0x0311,
	CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 =                               0x0312,
	CMD_ISO_15693_COMMAND =                                              0x0313,
	CMD_ISO_15693_COMMAND_DONE =                                         0x0314,
	CMD_ISO_15693_FIND_AFI =                                             0x0315,
	CMD_ISO_15693_DEBUG =                                                0x0316,
	CMD_LF_SNOOP_RAW_ADC_SAMPLES =                                       0x0317,

	--// For Hitag2 transponders
	CMD_SNOOP_HITAG =                                                    0x0370,
	CMD_SIMULATE_HITAG =                                                 0x0371,
	CMD_READER_HITAG =                                                   0x0372,

	CMD_SIMULATE_TAG_ISO_14443B =                                        0x0381,
	CMD_SNOOP_ISO_14443B =                                               0x0382,
	CMD_SNOOP_ISO_14443a =                                               0x0383,
	CMD_SIMULATE_TAG_ISO_14443a =                                        0x0384,
	CMD_READER_ISO_14443a =                                              0x0385,
	CMD_SIMULATE_TAG_LEGIC_RF =                                          0x0387,
	CMD_READER_LEGIC_RF =                                                0x0388,
	CMD_WRITER_LEGIC_RF =                                                0x0389,
	CMD_EPA_PACE_COLLECT_NONCE =                                         0x038A,
	--//CMD_EPA_ =                                                         0x038B,

	CMD_ICLASS_READCHECK =                                               0x038F,
	CMD_ICLASS_CLONE =                                                   0x0390,
	CMD_ICLASS_DUMP =                                                    0x0391,
	CMD_SNOOP_ICLASS =                                                   0x0392,
	CMD_SIMULATE_TAG_ICLASS =                                            0x0393,
	CMD_READER_ICLASS =                                                  0x0394,
	CMD_READER_ICLASS_REPLAY =                                           0x0395,
	CMD_ICLASS_READBLOCK =                                               0x0396,
	CMD_ICLASS_WRITEBLOCK =                                              0x0397,
	CMD_ICLASS_EML_MEMSET =                                              0x0398,
	CMD_ICLASS_AUTHENTICATION =                                          0x0399,

	--// For measurements of the antenna tuning
	CMD_MEASURE_ANTENNA_TUNING =                                         0x0400,
	CMD_MEASURE_ANTENNA_TUNING_HF =                                      0x0401,
	CMD_MEASURED_ANTENNA_TUNING =                                        0x0410,
	CMD_LISTEN_READER_FIELD =                                            0x0420,

	--// For direct FPGA control
	CMD_FPGA_MAJOR_MODE_OFF =                                            0x0500,

	--// For mifare commands
	CMD_MIFARE_SET_DBGMODE =                                             0x0600,
	CMD_MIFARE_EML_MEMCLR =                                              0x0601,
	CMD_MIFARE_EML_MEMSET =                                              0x0602,
	CMD_MIFARE_EML_MEMGET =                                              0x0603,
	CMD_MIFARE_EML_CARDLOAD =                                            0x0604,
	
	--// magic chinese card commands
	CMD_MIFARE_CSETBLOCK =                                               0x0605,
	CMD_MIFARE_CGETBLOCK =                                               0x0606,
	CMD_MIFARE_CIDENT =                                                  0x0607,

	CMD_SIMULATE_MIFARE_CARD =                                           0x0610,

	CMD_READER_MIFARE =                                                  0x0611,
	CMD_MIFARE_NESTED =                                                  0x0612,

	CMD_MIFARE_READBL =                                                  0x0620,
	CMD_MIFAREU_READBL =                                                 0x0720,
	
	CMD_MIFARE_READSC =                                                  0x0621,
	CMD_MIFAREU_READCARD =                                               0x0721,
	
	CMD_MIFARE_WRITEBL =                                                 0x0622,
	CMD_MIFAREU_WRITEBL =                                                0x0722,
	CMD_MIFAREU_WRITEBL_COMPAT =                                         0x0723,
	
	CMD_MIFARE_CHKKEYS =                                                 0x0623,

	CMD_MIFARE_SNIFFER =                                                 0x0630,

	--//ultralightC
	CMD_MIFAREUC_AUTH =                                                  0x0724,
	CMD_MIFAREUC_SETPWD =                                                0x0727,
	CMD_MIFAREU_SETUID =                                                 0x0728,

	--// mifare desfire
	CMD_MIFARE_DESFIRE_READBL =                                          0x0728,
	CMD_MIFARE_DESFIRE_WRITEBL =                                         0x0729,
	CMD_MIFARE_DESFIRE_AUTH1 =                                           0x072a,
	CMD_MIFARE_DESFIRE_AUTH2 =                                           0x072b,
	CMD_MIFARE_DES_READER =                                              0x072c,
	CMD_MIFARE_DESFIRE_INFO =                                            0x072d,
	CMD_MIFARE_DESFIRE =                                                 0x072e,
	
	CMD_UNKNOWN =                                                        0xFFFF,
}


local _reverse_lookup,k,v = {}
	for k, v in pairs(_commands) do
		_reverse_lookup[v] =  k
	end
	_commands.tostring = function(command)
	if(type(command) == 'number') then
		return ("%s (%d)"):format(_reverse_lookup[command]or "ERROR UNDEFINED!", command) 
	end
	return ("Error, numeric argument expected, got : %s"):format(tostring(command))
end

Command = {

	new = function(self, o)

		local o = o or {}   -- create object if user does not provide one
		setmetatable(o, self) -- DIY inheritance a'la javascript
		self.__index = self

		o.cmd = o.cmd or _commands.CMD_UNKNOWN
		--o.arg1 = "test"
		o.arg1 = o.arg1 or 0
		o.arg2 = o.arg2 or 0
		o.arg3 = o.arg3 or 0 
		local data = o.data or "0"

		if(type(data) == 'string') then
			-- We need to check if it is correct length, otherwise pad it
			local len = string.len(data)
			if(len < 1024) then  
				--Should be 1024 hex characters to represent 512 bytes of data 
				data = data .. string.rep("0",1024 - len ) 
			end
			if(len > 1024) then
				-- OOps, a bit too much data here
				print( ( "WARNING: data size too large, was %s chars, will be truncated "):format(len) )
				--
				data = data:sub(1,1024)
			end
		else 
			print(("WARNING; data was NOT a (hex-) string, but was %s"):format(type(data)))
		end
		o.data = data
		
		return o
	end,
	parse = function (packet)
		local count,cmd,arg1,arg2,arg3,data = bin.unpack('LLLLH512',packet)
		return Command:new{cmd = cmd, arg1 = arg1, arg2 = arg2, arg3 = arg3, data = data}
	end,
}
function Command:__tostring()
	local output = ("%s\r\nargs : (%s, %s, %s)\r\ndata:\r\n%s\r\n"):format(
		_commands.tostring(self.cmd),
		tostring(self.arg1),
	 	tostring(self.arg2),
	 	tostring(self.arg3),
	 	tostring(self.data))
	return output
end
function Command:getBytes()
	--If a hex-string has been used
	local data  = self.data
	local cmd = self.cmd 
	local arg1, arg2, arg3 = self.arg1, self.arg2, self.arg3
	return bin.pack("LLLLH",cmd, arg1, arg2, arg3, data);
end
return _commands
Commit	Line	Data
21452811	1	--[[
	2	These are command definitions. This file should correspond exactly to usb_cmd.h.
	3	--]]
	4	--// For the bootloader
	5	local _commands = {
	6	CMD_DEVICE_INFO = 0x0000,
	7	CMD_SETUP_WRITE = 0x0001,
	8	CMD_FINISH_WRITE = 0x0003,
	9	CMD_HARDWARE_RESET = 0x0004,
	10	CMD_START_FLASH = 0x0005,
	11	CMD_NACK = 0x00fe,
	12	CMD_ACK = 0x00ff,
	13
	14	--// For general mucking around
	15	CMD_DEBUG_PRINT_STRING = 0x0100,
	16	CMD_DEBUG_PRINT_INTEGERS = 0x0101,
	17	CMD_DEBUG_PRINT_BYTES = 0x0102,
	18	CMD_LCD_RESET = 0x0103,
	19	CMD_LCD = 0x0104,
	20	CMD_BUFF_CLEAR = 0x0105,
	21	CMD_READ_MEM = 0x0106,
	22	CMD_VERSION = 0x0107,
e2012d1b MHS	23	CMD_STATUS = 0x0108,
e2012d1b MHS	24	CMD_PING = 0x0109,
21452811	25	--// For low-frequency tags
	26	CMD_READ_TI_TYPE = 0x0202,
	27	CMD_WRITE_TI_TYPE = 0x0203,
	28	CMD_DOWNLOADED_RAW_BITS_TI_TYPE = 0x0204,
	29	CMD_ACQUIRE_RAW_ADC_SAMPLES_125K = 0x0205,
	30	CMD_MOD_THEN_ACQUIRE_RAW_ADC_SAMPLES_125K = 0x0206,
	31	CMD_DOWNLOAD_RAW_ADC_SAMPLES_125K = 0x0207,
	32	CMD_DOWNLOADED_RAW_ADC_SAMPLES_125K = 0x0208,
	33	CMD_DOWNLOADED_SIM_SAMPLES_125K = 0x0209,
	34	CMD_SIMULATE_TAG_125K = 0x020A,
	35	CMD_HID_DEMOD_FSK = 0x020B,
	36	CMD_HID_SIM_TAG = 0x020C,
	37	CMD_SET_LF_DIVISOR = 0x020D,
	38	CMD_LF_SIMULATE_BIDIR = 0x020E,
	39	CMD_SET_ADC_MUX = 0x020F,
	40	CMD_HID_CLONE_TAG = 0x0210,
	41	CMD_EM410X_WRITE_TAG = 0x0211,
	42	CMD_INDALA_CLONE_TAG = 0x0212,
	43	--// for 224 bits UID
	44	CMD_INDALA_CLONE_TAG_L = 0x0213,
	45	CMD_T55XX_READ_BLOCK = 0x0214,
	46	CMD_T55XX_WRITE_BLOCK = 0x0215,
66837a03	47	CMD_T55XX_RESET_READ = 0x0216,
21452811	48	CMD_PCF7931_READ = 0x0217,
	49	CMD_EM4X_READ_WORD = 0x0218,
	50	CMD_EM4X_WRITE_WORD = 0x0219,
66707a3b	51	CMD_IO_DEMOD_FSK = 0x021A,
abd6112f	52	CMD_IO_CLONE_TAG = 0x021B,
	53	CMD_EM410X_DEMOD = 0x021c,
	54	CMD_SET_LF_SAMPLING_CONFIG = 0x021d,
	55	CMD_FSK_SIM_TAG = 0x021E,
	56	CMD_ASK_SIM_TAG = 0x021F,
872e3d4d	57	CMD_PSK_SIM_TAG = 0x0220,
c0c35f9b	58	CMD_AWID_DEMOD_FSK = 0x0221,
709665b5	59	CMD_VIKING_CLONE_TAG = 0x0223,
be2d41b7	60	CMD_T55XX_WAKEUP = 0x0224,
e04475c4	61	CMD_COTAG = 0x0225,
21452811	62	--/* CMD_SET_ADC_MUX: ext1 is 0 for lopkd, 1 for loraw, 2 for hipkd, 3 for hiraw */
	63
	64	--// For the 13.56 MHz tags
	65	CMD_ACQUIRE_RAW_ADC_SAMPLES_ISO_15693 = 0x0300,
21452811	66	CMD_READ_SRI512_TAG = 0x0303,
	67	CMD_READ_SRIX4K_TAG = 0x0304,
	68	CMD_READER_ISO_15693 = 0x0310,
	69	CMD_SIMTAG_ISO_15693 = 0x0311,
	70	CMD_RECORD_RAW_ADC_SAMPLES_ISO_15693 = 0x0312,
	71	CMD_ISO_15693_COMMAND = 0x0313,
	72	CMD_ISO_15693_COMMAND_DONE = 0x0314,
	73	CMD_ISO_15693_FIND_AFI = 0x0315,
	74	CMD_ISO_15693_DEBUG = 0x0316,
3af373f3	75	CMD_LF_SNOOP_RAW_ADC_SAMPLES = 0x0317,
21452811	76
	77	--// For Hitag2 transponders
	78	CMD_SNOOP_HITAG = 0x0370,
	79	CMD_SIMULATE_HITAG = 0x0371,
	80	CMD_READER_HITAG = 0x0372,
	81
132a0217	82	CMD_SIMULATE_TAG_ISO_14443B = 0x0381,
132a0217	83	CMD_SNOOP_ISO_14443B = 0x0382,
21452811	84	CMD_SNOOP_ISO_14443a = 0x0383,
	85	CMD_SIMULATE_TAG_ISO_14443a = 0x0384,
	86	CMD_READER_ISO_14443a = 0x0385,
	87	CMD_SIMULATE_TAG_LEGIC_RF = 0x0387,
	88	CMD_READER_LEGIC_RF = 0x0388,
	89	CMD_WRITER_LEGIC_RF = 0x0389,
	90	CMD_EPA_PACE_COLLECT_NONCE = 0x038A,
3af373f3	91	--//CMD_EPA_ = 0x038B,
21452811	92
3ac22ee1	93	CMD_ICLASS_READCHECK = 0x038F,
aa53efc3	94	CMD_ICLASS_CLONE = 0x0390,
aa53efc3	95	CMD_ICLASS_DUMP = 0x0391,
21452811	96	CMD_SNOOP_ICLASS = 0x0392,
	97	CMD_SIMULATE_TAG_ICLASS = 0x0393,
	98	CMD_READER_ICLASS = 0x0394,
aa53efc3	99	CMD_READER_ICLASS_REPLAY = 0x0395,
	100	CMD_ICLASS_READBLOCK = 0x0396,
	101	CMD_ICLASS_WRITEBLOCK = 0x0397,
	102	CMD_ICLASS_EML_MEMSET = 0x0398,
	103	CMD_ICLASS_AUTHENTICATION = 0x0399,
21452811	104
	105	--// For measurements of the antenna tuning
	106	CMD_MEASURE_ANTENNA_TUNING = 0x0400,
	107	CMD_MEASURE_ANTENNA_TUNING_HF = 0x0401,
	108	CMD_MEASURED_ANTENNA_TUNING = 0x0410,
	109	CMD_LISTEN_READER_FIELD = 0x0420,
	110
	111	--// For direct FPGA control
	112	CMD_FPGA_MAJOR_MODE_OFF = 0x0500,
	113
	114	--// For mifare commands
	115	CMD_MIFARE_SET_DBGMODE = 0x0600,
	116	CMD_MIFARE_EML_MEMCLR = 0x0601,
	117	CMD_MIFARE_EML_MEMSET = 0x0602,
	118	CMD_MIFARE_EML_MEMGET = 0x0603,
	119	CMD_MIFARE_EML_CARDLOAD = 0x0604,
b915fda3	120
	121	--// magic chinese card commands
	122	CMD_MIFARE_CSETBLOCK = 0x0605,
	123	CMD_MIFARE_CGETBLOCK = 0x0606,
	124	CMD_MIFARE_CIDENT = 0x0607,
21452811	125
	126	CMD_SIMULATE_MIFARE_CARD = 0x0610,
	127
	128	CMD_READER_MIFARE = 0x0611,
	129	CMD_MIFARE_NESTED = 0x0612,
	130
	131	CMD_MIFARE_READBL = 0x0620,
3af373f3	132	CMD_MIFAREU_READBL = 0x0720,
3af373f3	133
21452811	134	CMD_MIFARE_READSC = 0x0621,
3af373f3	135	CMD_MIFAREU_READCARD = 0x0721,
3af373f3	136
21452811	137	CMD_MIFARE_WRITEBL = 0x0622,
3af373f3	138	CMD_MIFAREU_WRITEBL = 0x0722,
	139	CMD_MIFAREU_WRITEBL_COMPAT = 0x0723,
	140
21452811	141	CMD_MIFARE_CHKKEYS = 0x0623,
	142
	143	CMD_MIFARE_SNIFFER = 0x0630,
	144
3af373f3	145	--//ultralightC
9d87eb66	146	CMD_MIFAREUC_AUTH = 0x0724,
	147	CMD_MIFAREUC_SETPWD = 0x0727,
	148	CMD_MIFAREU_SETUID = 0x0728,
3af373f3	149
	150	--// mifare desfire
	151	CMD_MIFARE_DESFIRE_READBL = 0x0728,
	152	CMD_MIFARE_DESFIRE_WRITEBL = 0x0729,
	153	CMD_MIFARE_DESFIRE_AUTH1 = 0x072a,
	154	CMD_MIFARE_DESFIRE_AUTH2 = 0x072b,
	155	CMD_MIFARE_DES_READER = 0x072c,
	156	CMD_MIFARE_DESFIRE_INFO = 0x072d,
	157	CMD_MIFARE_DESFIRE = 0x072e,
	158
21452811	159	CMD_UNKNOWN = 0xFFFF,
	160	}
	161
	162
	163	local _reverse_lookup,k,v = {}
9ccfb3a8	164	for k, v in pairs(_commands) do
	165	_reverse_lookup[v] = k
	166	end
	167	_commands.tostring = function(command)
21452811	168	if(type(command) == 'number') then
	169	return ("%s (%d)"):format(_reverse_lookup[command]or "ERROR UNDEFINED!", command)
	170	end
	171	return ("Error, numeric argument expected, got : %s"):format(tostring(command))
	172	end
	173
	174	Command = {
	175
	176	new = function(self, o)
	177
	178	local o = o or {} -- create object if user does not provide one
	179	setmetatable(o, self) -- DIY inheritance a'la javascript
	180	self.__index = self
	181
	182	o.cmd = o.cmd or _commands.CMD_UNKNOWN
	183	--o.arg1 = "test"
	184	o.arg1 = o.arg1 or 0
	185	o.arg2 = o.arg2 or 0
	186	o.arg3 = o.arg3 or 0
	187	local data = o.data or "0"
	188
	189	if(type(data) == 'string') then
	190	-- We need to check if it is correct length, otherwise pad it
	191	local len = string.len(data)
	192	if(len < 1024) then
	193	--Should be 1024 hex characters to represent 512 bytes of data
	194	data = data .. string.rep("0",1024 - len )
	195	end
	196	if(len > 1024) then
	197	-- OOps, a bit too much data here
	198	print( ( "WARNING: data size too large, was %s chars, will be truncated "):format(len) )
	199	--
	200	data = data:sub(1,1024)
	201	end
	202	else
	203	print(("WARNING; data was NOT a (hex-) string, but was %s"):format(type(data)))
	204	end
	205	o.data = data
	206
	207	return o
	208	end,
4df3eb3f	209	parse = function (packet)
	210	local count,cmd,arg1,arg2,arg3,data = bin.unpack('LLLLH512',packet)
	211	return Command:new{cmd = cmd, arg1 = arg1, arg2 = arg2, arg3 = arg3, data = data}
	212	end,
21452811	213	}
	214	function Command:__tostring()
	215	local output = ("%s\r\nargs : (%s, %s, %s)\r\ndata:\r\n%s\r\n"):format(
	216	_commands.tostring(self.cmd),
	217	tostring(self.arg1),
	218	tostring(self.arg2),
	219	tostring(self.arg3),
	220	tostring(self.data))
	221	return output
	222	end
	223	function Command:getBytes()
	224	--If a hex-string has been used
	225	local data = self.data
	226	local cmd = self.cmd
	227	local arg1, arg2, arg3 = self.arg1, self.arg2, self.arg3
9ccfb3a8	228	return bin.pack("LLLLH",cmd, arg1, arg2, arg3, data);
21452811	229	end
abd6112f	230	return _commands