[proxmark3-svn] / common / protocols.h

#ifndef PROTOCOLS_H
#define PROTOCOLS_H

#include <string.h>
#include <stdint.h>
#include <stdarg.h>


//The following data is taken from http://www.proxmark.org/forum/viewtopic.php?pid=13501#p13501
/*
ISO14443A (usually NFC tags)
	26 (7bits) = REQA
	30 = Read (usage: 30+1byte block number+2bytes ISO14443A-CRC - answer: 16bytes)
	A2 = Write (usage: A2+1byte block number+4bytes data+2bytes ISO14443A-CRC - answer: 0A [ACK] or 00 [NAK])
	52 (7bits) = WUPA (usage: 52(7bits) - answer: 2bytes ATQA)
	93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
	93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
	95 20 = Anticollision of cascade level2
	95 70 = Select of cascade level2
	50 00 = Halt (usage: 5000+2bytes ISO14443A-CRC - no answer from card)
Mifare
	60 = Authenticate with KeyA
	61 = Authenticate with KeyB
	40 (7bits) = Used to put Chinese Changeable UID cards in special mode (must be followed by 43 (8bits) - answer: 0A)
	C0 = Decrement
	C1 = Increment
	C2 = Restore
	B0 = Transfer
Ultralight C
	A0 = Compatibility Write (to accomodate MIFARE commands)
	1A = Step1 Authenticate
	AF = Step2 Authenticate


ISO14443B
	05 = REQB
	1D = ATTRIB
	50 = HALT
	
	BA = PING (reader -> tag)
	AB = PONG (tag -> reader)
SRIX4K (tag does not respond to 05)
	06 00 = INITIATE
	0E xx = SELECT ID (xx = Chip-ID)
	0B = Get UID
	08 yy = Read Block (yy = block number)
	09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
	0C = Reset to Inventory
	0F = Completion
	0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)


ISO15693
	MANDATORY COMMANDS (all ISO15693 tags must support those)
		01 = Inventory (usage: 260100+2bytes ISO15693-CRC - answer: 12bytes)
		02 = Stay Quiet
	OPTIONAL COMMANDS (not all tags support them)
		20 = Read Block (usage: 0220+1byte block number+2bytes ISO15693-CRC - answer: 4bytes)
		21 = Write Block (usage: 0221+1byte block number+4bytes data+2bytes ISO15693-CRC - answer: 4bytes)
		22 = Lock Block
		23 = Read Multiple Blocks (usage: 0223+1byte 1st block to read+1byte last block to read+2bytes ISO15693-CRC)
		25 = Select
		26 = Reset to Ready
		27 = Write AFI
		28 = Lock AFI
		29 = Write DSFID
		2A = Lock DSFID
		2B = Get_System_Info (usage: 022B+2bytes ISO15693-CRC - answer: 14 or more bytes)
		2C = Read Multiple Block Security Status (usage: 022C+1byte 1st block security to read+1byte last block security to read+2bytes ISO15693-CRC)

EM Microelectronic CUSTOM COMMANDS
	A5 = Active EAS (followed by 1byte IC Manufacturer code+1byte EAS type)
	A7 = Write EAS ID (followed by 1byte IC Manufacturer code+2bytes EAS value)
	B8 = Get Protection Status for a specific block (followed by 1byte IC Manufacturer code+1byte block number+1byte of how many blocks after the previous is needed the info)
	E4 = Login (followed by 1byte IC Manufacturer code+4bytes password)
NXP/Philips CUSTOM COMMANDS
	A0 = Inventory Read
	A1 = Fast Inventory Read
	A2 = Set EAS
	A3 = Reset EAS
	A4 = Lock EAS
	A5 = EAS Alarm
	A6 = Password Protect EAS
	A7 = Write EAS ID
	A8 = Read EPC
	B0 = Inventory Page Read
	B1 = Fast Inventory Page Read
	B2 = Get Random Number
	B3 = Set Password
	B4 = Write Password
	B5 = Lock Password
	B6 = Bit Password Protection
	B7 = Lock Page Protection Condition
	B8 = Get Multiple Block Protection Status
	B9 = Destroy SLI
	BA = Enable Privacy
	BB = 64bit Password Protection
	40 = Long Range CMD (Standard ISO/TR7003:1990)

ISO 7816-4 Basic interindustry commands. For command APDU's.
	B0 = READ BINARY
	D0 = WRITE BINARY
	D6 = UPDATE BINARY
	0E = ERASE BINARY
	B2 = READ RECORDS
	D2 = WRITE RECORDS
	E2 = APPEND RECORD
	DC = UPDATE RECORD
	CA = GET DATA
	DA = PUT DATA
	A4 = SELECT FILE
	20 = VERIFY
	88 = INTERNAL AUTHENTICATION
	82 = EXTERNAL AUTHENTICATION
	B4 = GET CHALLENGE
	70 = MANAGE CHANNEL

	For response APDU's
	90 00 = OK
	6x xx = ERROR
*/

#define ICLASS_CMD_ACTALL           0x0A
#define ICLASS_CMD_READ_OR_IDENTIFY 0x0C
#define ICLASS_CMD_SELECT           0x81
#define ICLASS_CMD_PAGESEL          0x84
#define ICLASS_CMD_READCHECK_KD     0x88
#define ICLASS_CMD_READCHECK_KC     0x18
#define ICLASS_CMD_CHECK            0x05
#define ICLASS_CMD_DETECT           0x0F
#define ICLASS_CMD_HALT             0x00
#define ICLASS_CMD_UPDATE			0x87
#define ICLASS_CMD_ACT              0x8E
#define ICLASS_CMD_READ4            0x06


#define ISO14443A_CMD_REQA       0x26
#define ISO14443A_CMD_READBLOCK  0x30
#define ISO14443A_CMD_WUPA       0x52
#define ISO14443A_CMD_ANTICOLL_OR_SELECT     0x93
#define ISO14443A_CMD_ANTICOLL_OR_SELECT_2   0x95
#define ISO14443A_CMD_ANTICOLL_OR_SELECT_3   0x97
#define ISO14443A_CMD_WRITEBLOCK 0xA0
#define ISO14443A_CMD_HALT       0x50
#define ISO14443A_CMD_RATS       0xE0

#define MIFARE_AUTH_KEYA	    0x60
#define MIFARE_AUTH_KEYB	    0x61
#define MIFARE_MAGICWUPC1	    0x40
#define MIFARE_MAGICWUPC2		0x43
#define MIFARE_MAGICWIPEC		0x41
#define MIFARE_CMD_INC          0xC0
#define MIFARE_CMD_DEC          0xC1
#define MIFARE_CMD_RESTORE      0xC2
#define MIFARE_CMD_TRANSFER     0xB0

#define MIFARE_EV1_PERSONAL_UID 0x40
#define MIFARE_EV1_SETMODE		0x43

#define MIFARE_ULC_WRITE        0xA2
//#define MIFARE_ULC__COMP_WRITE  0xA0
#define MIFARE_ULC_AUTH_1       0x1A
#define MIFARE_ULC_AUTH_2       0xAF

#define MIFARE_ULEV1_AUTH		0x1B
#define MIFARE_ULEV1_VERSION	0x60
#define MIFARE_ULEV1_FASTREAD	0x3A
#define MIFARE_ULEV1_READ_CNT	0x39
#define MIFARE_ULEV1_INCR_CNT	0xA5
#define MIFARE_ULEV1_READSIG	0x3C
#define MIFARE_ULEV1_CHECKTEAR	0x3E
#define MIFARE_ULEV1_VCSL		0x4B

// mifare 4bit card answers
#define CARD_ACK      0x0A  // 1010 - ACK
#define CARD_NACK_NA  0x04  // 0100 - NACK, not allowed (command not allowed)
#define CARD_NACK_TR  0x05  // 0101 - NACK, transmission error


// Magic Generation 1, parameter "work flags"
// bit 0 - need get UID
// bit 1 - send wupC (wakeup chinese)
// bit 2 - send HALT cmd after sequence
// bit 3 - turn on FPGA
// bit 4 - turn off FPGA
// bit 5 - set datain instead of issuing USB reply (called via ARM for StandAloneMode14a)
#define MAGIC_UID 			0x01
#define MAGIC_WUPC			0x02
#define MAGIC_HALT			0x04
#define MAGIC_INIT			0x08
#define MAGIC_OFF			0x10
#define MAGIC_DATAIN		0x20
#define MAGIC_WIPE			0x40
#define MAGIC_SINGLE		(MAGIC_WUPC | MAGIC_HALT | MAGIC_INIT | MAGIC_OFF) //0x1E

/**
06 00 = INITIATE
0E xx = SELECT ID (xx = Chip-ID)
0B = Get UID
08 yy = Read Block (yy = block number)
09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
0C = Reset to Inventory
0F = Completion
0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
**/

#define ISO14443B_REQB         0x05
#define ISO14443B_ATTRIB       0x1D
#define ISO14443B_HALT         0x50
#define ISO14443B_INITIATE     0x06
#define ISO14443B_SELECT       0x0E
#define ISO14443B_GET_UID      0x0B
#define ISO14443B_READ_BLK     0x08
#define ISO14443B_WRITE_BLK    0x09
#define ISO14443B_RESET        0x0C
#define ISO14443B_COMPLETION   0x0F
#define ISO14443B_AUTHENTICATE 0x0A
#define ISO14443B_PING		   0xBA
#define ISO14443B_PONG		   0xAB

//First byte is 26
#define ISO15693_INVENTORY     0x01
#define ISO15693_STAYQUIET     0x02
//First byte is 02
#define ISO15693_READBLOCK            0x20
#define ISO15693_WRITEBLOCK           0x21
#define ISO15693_LOCKBLOCK            0x22
#define ISO15693_READ_MULTI_BLOCK     0x23
#define ISO15693_SELECT               0x25
#define ISO15693_RESET_TO_READY       0x26
#define ISO15693_WRITE_AFI            0x27
#define ISO15693_LOCK_AFI             0x28
#define ISO15693_WRITE_DSFID          0x29
#define ISO15693_LOCK_DSFID           0x2A
#define ISO15693_GET_SYSTEM_INFO      0x2B
#define ISO15693_READ_MULTI_SECSTATUS 0x2C


// Topaz command set:
#define	TOPAZ_REQA						0x26	// Request
#define	TOPAZ_WUPA						0x52	// WakeUp
#define	TOPAZ_RID						0x78	// Read ID
#define	TOPAZ_RALL						0x00	// Read All (all bytes)
#define	TOPAZ_READ						0x01	// Read (a single byte)
#define	TOPAZ_WRITE_E					0x53	// Write-with-erase (a single byte)
#define	TOPAZ_WRITE_NE					0x1a	// Write-no-erase (a single byte)
// additional commands for Dynamic Memory Model
#define TOPAZ_RSEG						0x10	// Read segment
#define TOPAZ_READ8						0x02	// Read (eight bytes)
#define TOPAZ_WRITE_E8					0x54	// Write-with-erase (eight bytes)
#define TOPAZ_WRITE_NE8					0x1B	// Write-no-erase (eight bytes)


// Definetions of which protocol annotations there are available
#define ISO_14443A	0
#define ICLASS		1
#define ISO_14443B	2
#define TOPAZ		3
#define ISO_7816_4  4
#define MFDES		5
#define LEGIC		6

//-- Picopass fuses
#define FUSE_FPERS   0x80
#define FUSE_CODING1 0x40
#define FUSE_CODING0 0x20
#define FUSE_CRYPT1  0x10
#define FUSE_CRYPT0  0x08
#define FUSE_FPROD1  0x04
#define FUSE_FPROD0  0x02
#define FUSE_RA      0x01

// ISO 7816-4 Basic interindustry commands. For command APDU's.
#define ISO7816_READ_BINARY				0xB0
#define ISO7816_WRITE_BINARY			0xD0
#define ISO7816_UPDATE_BINARY 			0xD6
#define ISO7816_ERASE_BINARY 			0x0E
#define ISO7816_READ_RECORDS 			0xB2
#define ISO7816_WRITE_RECORDS 			0xD2
#define ISO7816_APPEND_RECORD 			0xE2
#define ISO7816_UPDATE_RECORD 			0xDC
#define ISO7816_GET_DATA 				0xCA
#define ISO7816_PUT_DATA 				0xDA
#define ISO7816_SELECT_FILE 			0xA4
#define ISO7816_VERIFY 					0x20
#define ISO7816_INTERNAL_AUTHENTICATION 0x88
#define ISO7816_EXTERNAL_AUTHENTICATION 0x82
#define ISO7816_GET_CHALLENGE 			0xB4
#define ISO7816_MANAGE_CHANNEL 			0x70

// ISO7816-4	For response APDU's
#define ISO7816_OK						0x9000
//	6x xx = ERROR
	
// MIFARE DESFire command set:
#define  MFDES_CREATE_APPLICATION 			 0xca
#define  MFDES_DELETE_APPLICATION 			 0xda
#define  MFDES_GET_APPLICATION_IDS 			 0x6a
#define      MFDES_SELECT_APPLICATION 		 0x5a
#define      MFDES_FORMAT_PICC 				 0xfc
#define      MFDES_GET_VERSION 				 0x60
#define      MFDES_READ_DATA 				 0xbd
#define      MFDES_WRITE_DATA				 0x3d
#define      MFDES_GET_VALUE 				 0x6c
#define      MFDES_CREDIT 					 0x0c
#define      MFDES_DEBIT 					 0xdc
#define      MFDES_LIMITED_CREDIT 			 0x1c
#define      MFDES_WRITE_RECORD 			 0x3b
#define      MFDES_READ_RECORDS 			 0xbb
#define     MFDES_CLEAR_RECORD_FILE 		 0xeb
#define      MFDES_COMMIT_TRANSACTION 		 0xc7
#define      MFDES_ABORT_TRANSACTION 		 0xa7
#define      MFDES_GET_FREE_MEMORY           0x6e
#define  	MFDES_GET_FILE_IDS 				 0x6f
#define  	MFDES_GET_ISOFILE_IDS 			 0x61
#define     MFDES_GET_FILE_SETTINGS 		 0xf5
#define     MFDES_CHANGE_FILE_SETTINGS 		 0x5f
#define     MFDES_CREATE_STD_DATA_FILE 		 0xcd
#define     MFDES_CREATE_BACKUP_DATA_FILE 	 0xcb
#define     MFDES_CREATE_VALUE_FILE 		 0xcc
#define     MFDES_CREATE_LINEAR_RECORD_FILE	 0xc1
#define     MFDES_CREATE_CYCLIC_RECORD_FILE	 0xc0
#define     MFDES_DELETE_FILE 				 0xdf
#define     MFDES_AUTHENTICATE	 			 0x0a  // AUTHENTICATE_NATIVE
#define  	MFDES_AUTHENTICATE_ISO 			 0x1a  // AUTHENTICATE_STANDARD
#define  	MFDES_AUTHENTICATE_AES 			 0xaa
#define     MFDES_CHANGE_KEY_SETTINGS 		 0x54
#define     MFDES_GET_KEY_SETTINGS 			 0x45
#define     MFDES_CHANGE_KEY 				 0xc4
#define     MFDES_GET_KEY_VERSION 			 0x64
#define     MFDES_AUTHENTICATION_FRAME 		 0xAF

// LEGIC Commands
#define		LEGIC_MIM_22	0x0D
#define		LEGIC_MIM_256	0x1D
#define		LEGIC_MIM_1024	0x3D
#define 	LEGIC_ACK_22	0x19
#define 	LEGIC_ACK_256	0x39
#define		LEGIC_READ		0x01
#define 	LEGIC_WRITE		0x00

void printIclassDumpInfo(uint8_t* iclass_dump);
void getMemConfig(uint8_t mem_cfg, uint8_t chip_cfg, uint8_t *max_blk, uint8_t *app_areas, uint8_t *kb);

/* T55x7 configuration register definitions */
#define T55x7_POR_DELAY				0x00000001
#define T55x7_ST_TERMINATOR			0x00000008
#define T55x7_PWD					0x00000010
#define T55x7_MAXBLOCK_SHIFT		5
#define T55x7_AOR					0x00000200
#define T55x7_PSKCF_RF_2			0
#define T55x7_PSKCF_RF_4			0x00000400
#define T55x7_PSKCF_RF_8			0x00000800
#define T55x7_MODULATION_DIRECT		0
#define T55x7_MODULATION_PSK1		0x00001000
#define T55x7_MODULATION_PSK2		0x00002000
#define T55x7_MODULATION_PSK3		0x00003000
#define T55x7_MODULATION_FSK1		0x00004000
#define T55x7_MODULATION_FSK2		0x00005000
#define T55x7_MODULATION_FSK1a		0x00006000
#define T55x7_MODULATION_FSK2a		0x00007000
#define T55x7_MODULATION_MANCHESTER	0x00008000
#define T55x7_MODULATION_BIPHASE	0x00010000
#define T55x7_MODULATION_DIPHASE	0x00018000
#define T55x7_BITRATE_RF_8			0
#define T55x7_BITRATE_RF_16			0x00040000
#define T55x7_BITRATE_RF_32			0x00080000
#define T55x7_BITRATE_RF_40			0x000C0000
#define T55x7_BITRATE_RF_50			0x00100000
#define T55x7_BITRATE_RF_64			0x00140000
#define T55x7_BITRATE_RF_100		0x00180000
#define T55x7_BITRATE_RF_128		0x001C0000

/* T5555 (Q5) configuration register definitions */
#define T5555_ST_TERMINATOR			0x00000001
#define T5555_MAXBLOCK_SHIFT		0x00000001
#define T5555_MODULATION_MANCHESTER	0
#define T5555_MODULATION_PSK1		0x00000010
#define T5555_MODULATION_PSK2		0x00000020
#define T5555_MODULATION_PSK3		0x00000030
#define T5555_MODULATION_FSK1		0x00000040
#define T5555_MODULATION_FSK2		0x00000050
#define T5555_MODULATION_BIPHASE	0x00000060
#define T5555_MODULATION_DIRECT		0x00000070
#define T5555_INVERT_OUTPUT			0x00000080
#define T5555_PSK_RF_2				0
#define T5555_PSK_RF_4				0x00000100
#define T5555_PSK_RF_8				0x00000200
#define T5555_USE_PWD				0x00000400
#define T5555_USE_AOR				0x00000800
#define T5555_BITRATE_SHIFT         12 //(RF=2n+2)   ie 64=2*0x1F+2   or n = (RF-2)/2
#define T5555_FAST_WRITE			0x00004000
#define T5555_PAGE_SELECT			0x00008000

uint32_t GetT55xxClockBit(uint32_t clock);

// iclass / picopass chip config structures and shared routines
typedef struct {
	uint8_t app_limit;      //[8]
	uint8_t otp[2];         //[9-10]
	uint8_t block_writelock;//[11]
	uint8_t chip_config;    //[12]
	uint8_t mem_config;     //[13]
	uint8_t eas;            //[14]
	uint8_t fuses;          //[15]
} picopass_conf_block;


typedef struct {
	uint8_t csn[8];
	picopass_conf_block conf;
	uint8_t epurse[8];
	uint8_t key_d[8];
	uint8_t key_c[8];
	uint8_t app_issuer_area[8];
} picopass_hdr;


#endif 
// PROTOCOLS_H
Commit	Line	Data
b67f7ec3 MHS	1	#ifndef PROTOCOLS_H
	2	#define PROTOCOLS_H
	3
1b75698c	4	#include <string.h>
	5	#include <stdint.h>
	6	#include <stdarg.h>
	7
	8
b67f7ec3 MHS	9	//The following data is taken from http://www.proxmark.org/forum/viewtopic.php?pid=13501#p13501
	10	/*
	11	ISO14443A (usually NFC tags)
	12	26 (7bits) = REQA
	13	30 = Read (usage: 30+1byte block number+2bytes ISO14443A-CRC - answer: 16bytes)
	14	A2 = Write (usage: A2+1byte block number+4bytes data+2bytes ISO14443A-CRC - answer: 0A [ACK] or 00 [NAK])
	15	52 (7bits) = WUPA (usage: 52(7bits) - answer: 2bytes ATQA)
	16	93 20 = Anticollision (usage: 9320 - answer: 4bytes UID+1byte UID-bytes-xor)
	17	93 70 = Select (usage: 9370+5bytes 9320 answer - answer: 1byte SAK)
	18	95 20 = Anticollision of cascade level2
	19	95 70 = Select of cascade level2
	20	50 00 = Halt (usage: 5000+2bytes ISO14443A-CRC - no answer from card)
	21	Mifare
	22	60 = Authenticate with KeyA
	23	61 = Authenticate with KeyB
	24	40 (7bits) = Used to put Chinese Changeable UID cards in special mode (must be followed by 43 (8bits) - answer: 0A)
	25	C0 = Decrement
	26	C1 = Increment
	27	C2 = Restore
	28	B0 = Transfer
	29	Ultralight C
	30	A0 = Compatibility Write (to accomodate MIFARE commands)
	31	1A = Step1 Authenticate
	32	AF = Step2 Authenticate
	33
	34
	35	ISO14443B
	36	05 = REQB
	37	1D = ATTRIB
	38	50 = HALT
c5f8c67a	39
	40	BA = PING (reader -> tag)
	41	AB = PONG (tag -> reader)
b67f7ec3 MHS	42	SRIX4K (tag does not respond to 05)
	43	06 00 = INITIATE
	44	0E xx = SELECT ID (xx = Chip-ID)
	45	0B = Get UID
	46	08 yy = Read Block (yy = block number)
	47	09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
	48	0C = Reset to Inventory
	49	0F = Completion
	50	0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
	51
	52
	53	ISO15693
	54	MANDATORY COMMANDS (all ISO15693 tags must support those)
	55	01 = Inventory (usage: 260100+2bytes ISO15693-CRC - answer: 12bytes)
	56	02 = Stay Quiet
	57	OPTIONAL COMMANDS (not all tags support them)
	58	20 = Read Block (usage: 0220+1byte block number+2bytes ISO15693-CRC - answer: 4bytes)
	59	21 = Write Block (usage: 0221+1byte block number+4bytes data+2bytes ISO15693-CRC - answer: 4bytes)
	60	22 = Lock Block
	61	23 = Read Multiple Blocks (usage: 0223+1byte 1st block to read+1byte last block to read+2bytes ISO15693-CRC)
	62	25 = Select
	63	26 = Reset to Ready
	64	27 = Write AFI
	65	28 = Lock AFI
	66	29 = Write DSFID
	67	2A = Lock DSFID
	68	2B = Get_System_Info (usage: 022B+2bytes ISO15693-CRC - answer: 14 or more bytes)
	69	2C = Read Multiple Block Security Status (usage: 022C+1byte 1st block security to read+1byte last block security to read+2bytes ISO15693-CRC)
	70
	71	EM Microelectronic CUSTOM COMMANDS
	72	A5 = Active EAS (followed by 1byte IC Manufacturer code+1byte EAS type)
	73	A7 = Write EAS ID (followed by 1byte IC Manufacturer code+2bytes EAS value)
	74	B8 = Get Protection Status for a specific block (followed by 1byte IC Manufacturer code+1byte block number+1byte of how many blocks after the previous is needed the info)
	75	E4 = Login (followed by 1byte IC Manufacturer code+4bytes password)
	76	NXP/Philips CUSTOM COMMANDS
	77	A0 = Inventory Read
	78	A1 = Fast Inventory Read
	79	A2 = Set EAS
	80	A3 = Reset EAS
	81	A4 = Lock EAS
	82	A5 = EAS Alarm
	83	A6 = Password Protect EAS
	84	A7 = Write EAS ID
	85	A8 = Read EPC
	86	B0 = Inventory Page Read
	87	B1 = Fast Inventory Page Read
	88	B2 = Get Random Number
	89	B3 = Set Password
	90	B4 = Write Password
	91	B5 = Lock Password
	92	B6 = Bit Password Protection
	93	B7 = Lock Page Protection Condition
	94	B8 = Get Multiple Block Protection Status
	95	B9 = Destroy SLI
	96	BA = Enable Privacy
	97	BB = 64bit Password Protection
	98	40 = Long Range CMD (Standard ISO/TR7003:1990)
c5f8c67a	99
	100	ISO 7816-4 Basic interindustry commands. For command APDU's.
	101	B0 = READ BINARY
	102	D0 = WRITE BINARY
	103	D6 = UPDATE BINARY
	104	0E = ERASE BINARY
	105	B2 = READ RECORDS
	106	D2 = WRITE RECORDS
	107	E2 = APPEND RECORD
	108	DC = UPDATE RECORD
	109	CA = GET DATA
	110	DA = PUT DATA
	111	A4 = SELECT FILE
	112	20 = VERIFY
	113	88 = INTERNAL AUTHENTICATION
	114	82 = EXTERNAL AUTHENTICATION
	115	B4 = GET CHALLENGE
	116	70 = MANAGE CHANNEL
	117
	118	For response APDU's
	119	90 00 = OK
	120	6x xx = ERROR
	121	*/
b67f7ec3 MHS	122
	123	#define ICLASS_CMD_ACTALL 0x0A
	124	#define ICLASS_CMD_READ_OR_IDENTIFY 0x0C
	125	#define ICLASS_CMD_SELECT 0x81
	126	#define ICLASS_CMD_PAGESEL 0x84
	127	#define ICLASS_CMD_READCHECK_KD 0x88
	128	#define ICLASS_CMD_READCHECK_KC 0x18
	129	#define ICLASS_CMD_CHECK 0x05
	130	#define ICLASS_CMD_DETECT 0x0F
	131	#define ICLASS_CMD_HALT 0x00
	132	#define ICLASS_CMD_UPDATE 0x87
	133	#define ICLASS_CMD_ACT 0x8E
	134	#define ICLASS_CMD_READ4 0x06
	135
	136
	137	#define ISO14443A_CMD_REQA 0x26
	138	#define ISO14443A_CMD_READBLOCK 0x30
	139	#define ISO14443A_CMD_WUPA 0x52
	140	#define ISO14443A_CMD_ANTICOLL_OR_SELECT 0x93
	141	#define ISO14443A_CMD_ANTICOLL_OR_SELECT_2 0x95
9358e496	142	#define ISO14443A_CMD_ANTICOLL_OR_SELECT_3 0x97
2c39c25c	143	#define ISO14443A_CMD_WRITEBLOCK 0xA0
b67f7ec3 MHS	144	#define ISO14443A_CMD_HALT 0x50
	145	#define ISO14443A_CMD_RATS 0xE0
	146
	147	#define MIFARE_AUTH_KEYA 0x60
	148	#define MIFARE_AUTH_KEYB 0x61
16a95d76	149	#define MIFARE_MAGICWUPC1 0x40
	150	#define MIFARE_MAGICWUPC2 0x43
	151	#define MIFARE_MAGICWIPEC 0x41
b67f7ec3 MHS	152	#define MIFARE_CMD_INC 0xC0
	153	#define MIFARE_CMD_DEC 0xC1
	154	#define MIFARE_CMD_RESTORE 0xC2
	155	#define MIFARE_CMD_TRANSFER 0xB0
	156
e98572a1	157	#define MIFARE_EV1_PERSONAL_UID 0x40
	158	#define MIFARE_EV1_SETMODE 0x43
	159
a98b05b7	160	#define MIFARE_ULC_WRITE 0xA2
a98b05b7	161	//#define MIFARE_ULC__COMP_WRITE 0xA0
b67f7ec3	162	#define MIFARE_ULC_AUTH_1 0x1A
11b1e2e5	163	#define MIFARE_ULC_AUTH_2 0xAF
7d010c49	164
11b1e2e5	165	#define MIFARE_ULEV1_AUTH 0x1B
7d010c49	166	#define MIFARE_ULEV1_VERSION 0x60
11b1e2e5	167	#define MIFARE_ULEV1_FASTREAD 0x3A
11b1e2e5	168	#define MIFARE_ULEV1_READ_CNT 0x39
	169	#define MIFARE_ULEV1_INCR_CNT 0xA5
	170	#define MIFARE_ULEV1_READSIG 0x3C
	171	#define MIFARE_ULEV1_CHECKTEAR 0x3E
	172	#define MIFARE_ULEV1_VCSL 0x4B
b67f7ec3	173
9358e496	174	// mifare 4bit card answers
	175	#define CARD_ACK 0x0A // 1010 - ACK
	176	#define CARD_NACK_NA 0x04 // 0100 - NACK, not allowed (command not allowed)
	177	#define CARD_NACK_TR 0x05 // 0101 - NACK, transmission error
	178
e98572a1	179
c2731f37	180	// Magic Generation 1, parameter "work flags"
	181	// bit 0 - need get UID
	182	// bit 1 - send wupC (wakeup chinese)
	183	// bit 2 - send HALT cmd after sequence
	184	// bit 3 - turn on FPGA
	185	// bit 4 - turn off FPGA
	186	// bit 5 - set datain instead of issuing USB reply (called via ARM for StandAloneMode14a)
	187	#define MAGIC_UID 0x01
	188	#define MAGIC_WUPC 0x02
	189	#define MAGIC_HALT 0x04
	190	#define MAGIC_INIT 0x08
	191	#define MAGIC_OFF 0x10
	192	#define MAGIC_DATAIN 0x20
	193	#define MAGIC_WIPE 0x40
	194	#define MAGIC_SINGLE (MAGIC_WUPC \| MAGIC_HALT \| MAGIC_INIT \| MAGIC_OFF) //0x1E
e98572a1	195
b67f7ec3 MHS	196	/**
	197	06 00 = INITIATE
	198	0E xx = SELECT ID (xx = Chip-ID)
	199	0B = Get UID
	200	08 yy = Read Block (yy = block number)
	201	09 yy dd dd dd dd = Write Block (yy = block number; dd dd dd dd = data to be written)
	202	0C = Reset to Inventory
	203	0F = Completion
	204	0A 11 22 33 44 55 66 = Authenticate (11 22 33 44 55 66 = data to authenticate)
	205	**/
	206
	207	#define ISO14443B_REQB 0x05
	208	#define ISO14443B_ATTRIB 0x1D
	209	#define ISO14443B_HALT 0x50
	210	#define ISO14443B_INITIATE 0x06
	211	#define ISO14443B_SELECT 0x0E
	212	#define ISO14443B_GET_UID 0x0B
	213	#define ISO14443B_READ_BLK 0x08
	214	#define ISO14443B_WRITE_BLK 0x09
	215	#define ISO14443B_RESET 0x0C
	216	#define ISO14443B_COMPLETION 0x0F
	217	#define ISO14443B_AUTHENTICATE 0x0A
c5f8c67a	218	#define ISO14443B_PING 0xBA
c5f8c67a	219	#define ISO14443B_PONG 0xAB
b67f7ec3 MHS	220
	221	//First byte is 26
	222	#define ISO15693_INVENTORY 0x01
	223	#define ISO15693_STAYQUIET 0x02
	224	//First byte is 02
	225	#define ISO15693_READBLOCK 0x20
	226	#define ISO15693_WRITEBLOCK 0x21
	227	#define ISO15693_LOCKBLOCK 0x22
	228	#define ISO15693_READ_MULTI_BLOCK 0x23
	229	#define ISO15693_SELECT 0x25
	230	#define ISO15693_RESET_TO_READY 0x26
	231	#define ISO15693_WRITE_AFI 0x27
	232	#define ISO15693_LOCK_AFI 0x28
	233	#define ISO15693_WRITE_DSFID 0x29
	234	#define ISO15693_LOCK_DSFID 0x2A
	235	#define ISO15693_GET_SYSTEM_INFO 0x2B
	236	#define ISO15693_READ_MULTI_SECSTATUS 0x2C
	237
	238
0ec548dc	239	// Topaz command set:
	240	#define TOPAZ_REQA 0x26 // Request
	241	#define TOPAZ_WUPA 0x52 // WakeUp
	242	#define TOPAZ_RID 0x78 // Read ID
	243	#define TOPAZ_RALL 0x00 // Read All (all bytes)
	244	#define TOPAZ_READ 0x01 // Read (a single byte)
	245	#define TOPAZ_WRITE_E 0x53 // Write-with-erase (a single byte)
	246	#define TOPAZ_WRITE_NE 0x1a // Write-no-erase (a single byte)
	247	// additional commands for Dynamic Memory Model
	248	#define TOPAZ_RSEG 0x10 // Read segment
	249	#define TOPAZ_READ8 0x02 // Read (eight bytes)
	250	#define TOPAZ_WRITE_E8 0x54 // Write-with-erase (eight bytes)
	251	#define TOPAZ_WRITE_NE8 0x1B // Write-no-erase (eight bytes)
	252
	253
c71c5ee1	254	// Definetions of which protocol annotations there are available
c5f8c67a	255	#define ISO_14443A 0
	256	#define ICLASS 1
	257	#define ISO_14443B 2
0ec548dc	258	#define TOPAZ 3
c5f8c67a	259	#define ISO_7816_4 4
7e08450d	260	#define MFDES 5
c71c5ee1	261	#define LEGIC 6
b67f7ec3	262
1defcf60 MHS	263	//-- Picopass fuses
	264	#define FUSE_FPERS 0x80
	265	#define FUSE_CODING1 0x40
	266	#define FUSE_CODING0 0x20
	267	#define FUSE_CRYPT1 0x10
	268	#define FUSE_CRYPT0 0x08
	269	#define FUSE_FPROD1 0x04
	270	#define FUSE_FPROD0 0x02
	271	#define FUSE_RA 0x01
	272
c5f8c67a	273	// ISO 7816-4 Basic interindustry commands. For command APDU's.
f3782960	274	#define ISO7816_READ_BINARY 0xB0
	275	#define ISO7816_WRITE_BINARY 0xD0
	276	#define ISO7816_UPDATE_BINARY 0xD6
	277	#define ISO7816_ERASE_BINARY 0x0E
	278	#define ISO7816_READ_RECORDS 0xB2
	279	#define ISO7816_WRITE_RECORDS 0xD2
	280	#define ISO7816_APPEND_RECORD 0xE2
	281	#define ISO7816_UPDATE_RECORD 0xDC
	282	#define ISO7816_GET_DATA 0xCA
	283	#define ISO7816_PUT_DATA 0xDA
	284	#define ISO7816_SELECT_FILE 0xA4
	285	#define ISO7816_VERIFY 0x20
c5f8c67a	286	#define ISO7816_INTERNAL_AUTHENTICATION 0x88
c5f8c67a	287	#define ISO7816_EXTERNAL_AUTHENTICATION 0x82
f3782960	288	#define ISO7816_GET_CHALLENGE 0xB4
f3782960	289	#define ISO7816_MANAGE_CHANNEL 0x70
1defcf60	290
c5f8c67a	291	// ISO7816-4 For response APDU's
f3782960	292	#define ISO7816_OK 0x9000
c5f8c67a	293	// 6x xx = ERROR
c5f8c67a	294
7e08450d	295	// MIFARE DESFire command set:
	296	#define MFDES_CREATE_APPLICATION 0xca
	297	#define MFDES_DELETE_APPLICATION 0xda
	298	#define MFDES_GET_APPLICATION_IDS 0x6a
	299	#define MFDES_SELECT_APPLICATION 0x5a
	300	#define MFDES_FORMAT_PICC 0xfc
	301	#define MFDES_GET_VERSION 0x60
	302	#define MFDES_READ_DATA 0xbd
	303	#define MFDES_WRITE_DATA 0x3d
	304	#define MFDES_GET_VALUE 0x6c
	305	#define MFDES_CREDIT 0x0c
	306	#define MFDES_DEBIT 0xdc
	307	#define MFDES_LIMITED_CREDIT 0x1c
	308	#define MFDES_WRITE_RECORD 0x3b
	309	#define MFDES_READ_RECORDS 0xbb
	310	#define MFDES_CLEAR_RECORD_FILE 0xeb
	311	#define MFDES_COMMIT_TRANSACTION 0xc7
	312	#define MFDES_ABORT_TRANSACTION 0xa7
	313	#define MFDES_GET_FREE_MEMORY 0x6e
	314	#define MFDES_GET_FILE_IDS 0x6f
	315	#define MFDES_GET_ISOFILE_IDS 0x61
	316	#define MFDES_GET_FILE_SETTINGS 0xf5
	317	#define MFDES_CHANGE_FILE_SETTINGS 0x5f
	318	#define MFDES_CREATE_STD_DATA_FILE 0xcd
	319	#define MFDES_CREATE_BACKUP_DATA_FILE 0xcb
	320	#define MFDES_CREATE_VALUE_FILE 0xcc
	321	#define MFDES_CREATE_LINEAR_RECORD_FILE 0xc1
	322	#define MFDES_CREATE_CYCLIC_RECORD_FILE 0xc0
	323	#define MFDES_DELETE_FILE 0xdf
	324	#define MFDES_AUTHENTICATE 0x0a // AUTHENTICATE_NATIVE
	325	#define MFDES_AUTHENTICATE_ISO 0x1a // AUTHENTICATE_STANDARD
	326	#define MFDES_AUTHENTICATE_AES 0xaa
	327	#define MFDES_CHANGE_KEY_SETTINGS 0x54
	328	#define MFDES_GET_KEY_SETTINGS 0x45
	329	#define MFDES_CHANGE_KEY 0xc4
	330	#define MFDES_GET_KEY_VERSION 0x64
	331	#define MFDES_AUTHENTICATION_FRAME 0xAF
c71c5ee1	332
c71c5ee1	333	// LEGIC Commands
7c91c8bf	334	#define LEGIC_MIM_22 0x0D
	335	#define LEGIC_MIM_256 0x1D
	336	#define LEGIC_MIM_1024 0x3D
	337	#define LEGIC_ACK_22 0x19
	338	#define LEGIC_ACK_256 0x39
ad5bc8cc	339	#define LEGIC_READ 0x01
ad5bc8cc	340	#define LEGIC_WRITE 0x00
c71c5ee1	341
1defcf60	342	void printIclassDumpInfo(uint8_t* iclass_dump);
e98572a1	343	void getMemConfig(uint8_t mem_cfg, uint8_t chip_cfg, uint8_t max_blk, uint8_t app_areas, uint8_t *kb);
b67f7ec3	344
1d0ccbe0	345	/* T55x7 configuration register definitions */
857bc2ff	346	#define T55x7_POR_DELAY 0x00000001
	347	#define T55x7_ST_TERMINATOR 0x00000008
	348	#define T55x7_PWD 0x00000010
1d0ccbe0	349	#define T55x7_MAXBLOCK_SHIFT 5
857bc2ff	350	#define T55x7_AOR 0x00000200
	351	#define T55x7_PSKCF_RF_2 0
	352	#define T55x7_PSKCF_RF_4 0x00000400
	353	#define T55x7_PSKCF_RF_8 0x00000800
1d0ccbe0	354	#define T55x7_MODULATION_DIRECT 0
	355	#define T55x7_MODULATION_PSK1 0x00001000
	356	#define T55x7_MODULATION_PSK2 0x00002000
	357	#define T55x7_MODULATION_PSK3 0x00003000
	358	#define T55x7_MODULATION_FSK1 0x00004000
	359	#define T55x7_MODULATION_FSK2 0x00005000
	360	#define T55x7_MODULATION_FSK1a 0x00006000
	361	#define T55x7_MODULATION_FSK2a 0x00007000
	362	#define T55x7_MODULATION_MANCHESTER 0x00008000
	363	#define T55x7_MODULATION_BIPHASE 0x00010000
	364	#define T55x7_MODULATION_DIPHASE 0x00018000
857bc2ff	365	#define T55x7_BITRATE_RF_8 0
	366	#define T55x7_BITRATE_RF_16 0x00040000
	367	#define T55x7_BITRATE_RF_32 0x00080000
	368	#define T55x7_BITRATE_RF_40 0x000C0000
	369	#define T55x7_BITRATE_RF_50 0x00100000
	370	#define T55x7_BITRATE_RF_64 0x00140000
1d0ccbe0	371	#define T55x7_BITRATE_RF_100 0x00180000
	372	#define T55x7_BITRATE_RF_128 0x001C0000
	373
	374	/* T5555 (Q5) configuration register definitions */
857bc2ff	375	#define T5555_ST_TERMINATOR 0x00000001
1d0ccbe0	376	#define T5555_MAXBLOCK_SHIFT 0x00000001
	377	#define T5555_MODULATION_MANCHESTER 0
	378	#define T5555_MODULATION_PSK1 0x00000010
	379	#define T5555_MODULATION_PSK2 0x00000020
	380	#define T5555_MODULATION_PSK3 0x00000030
	381	#define T5555_MODULATION_FSK1 0x00000040
	382	#define T5555_MODULATION_FSK2 0x00000050
	383	#define T5555_MODULATION_BIPHASE 0x00000060
	384	#define T5555_MODULATION_DIRECT 0x00000070
857bc2ff	385	#define T5555_INVERT_OUTPUT 0x00000080
	386	#define T5555_PSK_RF_2 0
	387	#define T5555_PSK_RF_4 0x00000100
	388	#define T5555_PSK_RF_8 0x00000200
	389	#define T5555_USE_PWD 0x00000400
	390	#define T5555_USE_AOR 0x00000800
c2731f37	391	#define T5555_BITRATE_SHIFT 12 //(RF=2n+2) ie 64=2*0x1F+2 or n = (RF-2)/2
857bc2ff	392	#define T5555_FAST_WRITE 0x00004000
857bc2ff	393	#define T5555_PAGE_SELECT 0x00008000
1d0ccbe0	394
	395	uint32_t GetT55xxClockBit(uint32_t clock);
	396
76c74bf9	397	// iclass / picopass chip config structures and shared routines
	398	typedef struct {
	399	uint8_t app_limit; //[8]
	400	uint8_t otp[2]; //[9-10]
	401	uint8_t block_writelock;//[11]
	402	uint8_t chip_config; //[12]
	403	uint8_t mem_config; //[13]
	404	uint8_t eas; //[14]
	405	uint8_t fuses; //[15]
	406	} picopass_conf_block;
	407
	408
	409	typedef struct {
	410	uint8_t csn[8];
	411	picopass_conf_block conf;
	412	uint8_t epurse[8];
	413	uint8_t key_d[8];
	414	uint8_t key_c[8];
	415	uint8_t app_issuer_area[8];
	416	} picopass_hdr;
	417
	418
1d0ccbe0	419	#endif
1d0ccbe0	420	// PROTOCOLS_H