Po -Chih Chen / RFID

ARM

MFRC522.h@0:f266ca250f98, 2017-10-14 (annotated)

Committer:
Toby_Chen
Date:
Sat Oct 14 12:58:38 2017 +0000
Revision:
0:f266ca250f98
TRAY+

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Toby_Chen 0:f266ca250f98 1 /**
Toby_Chen 0:f266ca250f98 2 * MFRC522.h - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI W AND R BY COOQROBOT.
Toby_Chen 0:f266ca250f98 3 * Based on code Dr.Leong ( WWW.B2CQSHOP.COM )
Toby_Chen 0:f266ca250f98 4 * Created by Miguel Balboa (circuitito.com), Jan, 2012.
Toby_Chen 0:f266ca250f98 5 * Rewritten by Soren Thing Andersen (access.thing.dk), fall of 2013 (Translation to English, refactored, comments, anti collision, cascade levels.)
Toby_Chen 0:f266ca250f98 6 * Ported to mbed by Martin Olejar, Dec, 2013
Toby_Chen 0:f266ca250f98 7 *
Toby_Chen 0:f266ca250f98 8 * Please read this file for an overview and then MFRC522.cpp for comments on the specific functions.
Toby_Chen 0:f266ca250f98 9 * Search for "mf-rc522" on ebay.com to purchase the MF-RC522 board.
Toby_Chen 0:f266ca250f98 10 *
Toby_Chen 0:f266ca250f98 11 * There are three hardware components involved:
Toby_Chen 0:f266ca250f98 12 * 1) The micro controller: An Arduino
Toby_Chen 0:f266ca250f98 13 * 2) The PCD (short for Proximity Coupling Device): NXP MFRC522 Contactless Reader IC
Toby_Chen 0:f266ca250f98 14 * 3) The PICC (short for Proximity Integrated Circuit Card): A card or tag using the ISO 14443A interface, eg Mifare or NTAG203.
Toby_Chen 0:f266ca250f98 15 *
Toby_Chen 0:f266ca250f98 16 * The microcontroller and card reader uses SPI for communication.
Toby_Chen 0:f266ca250f98 17 * The protocol is described in the MFRC522 datasheet: http://www.nxp.com/documents/data_sheet/MFRC522.pdf
Toby_Chen 0:f266ca250f98 18 *
Toby_Chen 0:f266ca250f98 19 * The card reader and the tags communicate using a 13.56MHz electromagnetic field.
Toby_Chen 0:f266ca250f98 20 * The protocol is defined in ISO/IEC 14443-3 Identification cards -- Contactless integrated circuit cards -- Proximity cards -- Part 3: Initialization and anticollision".
Toby_Chen 0:f266ca250f98 21 * A free version of the final draft can be found at http://wg8.de/wg8n1496_17n3613_Ballot_FCD14443-3.pdf
Toby_Chen 0:f266ca250f98 22 * Details are found in chapter 6, Type A: Initialization and anticollision.
Toby_Chen 0:f266ca250f98 23 *
Toby_Chen 0:f266ca250f98 24 * If only the PICC UID is wanted, the above documents has all the needed information.
Toby_Chen 0:f266ca250f98 25 * To read and write from MIFARE PICCs, the MIFARE protocol is used after the PICC has been selected.
Toby_Chen 0:f266ca250f98 26 * The MIFARE Classic chips and protocol is described in the datasheets:
Toby_Chen 0:f266ca250f98 27 * 1K: http://www.nxp.com/documents/data_sheet/MF1S503x.pdf
Toby_Chen 0:f266ca250f98 28 * 4K: http://www.nxp.com/documents/data_sheet/MF1S703x.pdf
Toby_Chen 0:f266ca250f98 29 * Mini: http://www.idcardmarket.com/download/mifare_S20_datasheet.pdf
Toby_Chen 0:f266ca250f98 30 * The MIFARE Ultralight chip and protocol is described in the datasheets:
Toby_Chen 0:f266ca250f98 31 * Ultralight: http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf
Toby_Chen 0:f266ca250f98 32 * Ultralight C: http://www.nxp.com/documents/short_data_sheet/MF0ICU2_SDS.pdf
Toby_Chen 0:f266ca250f98 33 *
Toby_Chen 0:f266ca250f98 34 * MIFARE Classic 1K (MF1S503x):
Toby_Chen 0:f266ca250f98 35 * Has 16 sectors * 4 blocks/sector * 16 bytes/block = 1024 bytes.
Toby_Chen 0:f266ca250f98 36 * The blocks are numbered 0-63.
Toby_Chen 0:f266ca250f98 37 * Block 3 in each sector is the Sector Trailer. See http://www.nxp.com/documents/data_sheet/MF1S503x.pdf sections 8.6 and 8.7:
Toby_Chen 0:f266ca250f98 38 * Bytes 0-5: Key A
Toby_Chen 0:f266ca250f98 39 * Bytes 6-8: Access Bits
Toby_Chen 0:f266ca250f98 40 * Bytes 9: User data
Toby_Chen 0:f266ca250f98 41 * Bytes 10-15: Key B (or user data)
Toby_Chen 0:f266ca250f98 42 * Block 0 is read only manufacturer data.
Toby_Chen 0:f266ca250f98 43 * To access a block, an authentication using a key from the block's sector must be performed first.
Toby_Chen 0:f266ca250f98 44 * Example: To read from block 10, first authenticate using a key from sector 3 (blocks 8-11).
Toby_Chen 0:f266ca250f98 45 * All keys are set to FFFFFFFFFFFFh at chip delivery.
Toby_Chen 0:f266ca250f98 46 * Warning: Please read section 8.7 "Memory Access". It includes this text: if the PICC detects a format violation the whole sector is irreversibly blocked.
Toby_Chen 0:f266ca250f98 47 * To use a block in "value block" mode (for Increment/Decrement operations) you need to change the sector trailer. Use PICC_SetAccessBits() to calculate the bit patterns.
Toby_Chen 0:f266ca250f98 48 * MIFARE Classic 4K (MF1S703x):
Toby_Chen 0:f266ca250f98 49 * Has (32 sectors * 4 blocks/sector + 8 sectors * 16 blocks/sector) * 16 bytes/block = 4096 bytes.
Toby_Chen 0:f266ca250f98 50 * The blocks are numbered 0-255.
Toby_Chen 0:f266ca250f98 51 * The last block in each sector is the Sector Trailer like above.
Toby_Chen 0:f266ca250f98 52 * MIFARE Classic Mini (MF1 IC S20):
Toby_Chen 0:f266ca250f98 53 * Has 5 sectors * 4 blocks/sector * 16 bytes/block = 320 bytes.
Toby_Chen 0:f266ca250f98 54 * The blocks are numbered 0-19.
Toby_Chen 0:f266ca250f98 55 * The last block in each sector is the Sector Trailer like above.
Toby_Chen 0:f266ca250f98 56 *
Toby_Chen 0:f266ca250f98 57 * MIFARE Ultralight (MF0ICU1):
Toby_Chen 0:f266ca250f98 58 * Has 16 pages of 4 bytes = 64 bytes.
Toby_Chen 0:f266ca250f98 59 * Pages 0 + 1 is used for the 7-byte UID.
Toby_Chen 0:f266ca250f98 60 * Page 2 contains the last chech digit for the UID, one byte manufacturer internal data, and the lock bytes (see http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf section 8.5.2)
Toby_Chen 0:f266ca250f98 61 * Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0.
Toby_Chen 0:f266ca250f98 62 * Pages 4-15 are read/write unless blocked by the lock bytes in page 2.
Toby_Chen 0:f266ca250f98 63 * MIFARE Ultralight C (MF0ICU2):
Toby_Chen 0:f266ca250f98 64 * Has 48 pages of 4 bytes = 64 bytes.
Toby_Chen 0:f266ca250f98 65 * Pages 0 + 1 is used for the 7-byte UID.
Toby_Chen 0:f266ca250f98 66 * Page 2 contains the last chech digit for the UID, one byte manufacturer internal data, and the lock bytes (see http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf section 8.5.2)
Toby_Chen 0:f266ca250f98 67 * Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0.
Toby_Chen 0:f266ca250f98 68 * Pages 4-39 are read/write unless blocked by the lock bytes in page 2.
Toby_Chen 0:f266ca250f98 69 * Page 40 Lock bytes
Toby_Chen 0:f266ca250f98 70 * Page 41 16 bit one way counter
Toby_Chen 0:f266ca250f98 71 * Pages 42-43 Authentication configuration
Toby_Chen 0:f266ca250f98 72 * Pages 44-47 Authentication key
Toby_Chen 0:f266ca250f98 73 */
Toby_Chen 0:f266ca250f98 74 #ifndef MFRC522_h
Toby_Chen 0:f266ca250f98 75 #define MFRC522_h
Toby_Chen 0:f266ca250f98 76
Toby_Chen 0:f266ca250f98 77 #include "mbed.h"
Toby_Chen 0:f266ca250f98 78
Toby_Chen 0:f266ca250f98 79 /**
Toby_Chen 0:f266ca250f98 80 * MFRC522 example
Toby_Chen 0:f266ca250f98 81 *
Toby_Chen 0:f266ca250f98 82 * @code
Toby_Chen 0:f266ca250f98 83 * #include "mbed.h"
Toby_Chen 0:f266ca250f98 84 * #include "MFRC522.h"
Toby_Chen 0:f266ca250f98 85 *
Toby_Chen 0:f266ca250f98 86 * //KL25Z Pins for MFRC522 SPI interface
Toby_Chen 0:f266ca250f98 87 * #define SPI_MOSI PTC6
Toby_Chen 0:f266ca250f98 88 * #define SPI_MISO PTC7
Toby_Chen 0:f266ca250f98 89 * #define SPI_SCLK PTC5
Toby_Chen 0:f266ca250f98 90 * #define SPI_CS PTC4
Toby_Chen 0:f266ca250f98 91 * // KL25Z Pin for MFRC522 reset
Toby_Chen 0:f266ca250f98 92 * #define MF_RESET PTC3
Toby_Chen 0:f266ca250f98 93 * // KL25Z Pins for Debug UART port
Toby_Chen 0:f266ca250f98 94 * #define UART_RX PTA1
Toby_Chen 0:f266ca250f98 95 * #define UART_TX PTA2
Toby_Chen 0:f266ca250f98 96 *
Toby_Chen 0:f266ca250f98 97 * DigitalOut LedRed (LED_RED);
Toby_Chen 0:f266ca250f98 98 * DigitalOut LedGreen (LED_GREEN);
Toby_Chen 0:f266ca250f98 99 *
Toby_Chen 0:f266ca250f98 100 * Serial DebugUART(UART_TX, UART_RX);
Toby_Chen 0:f266ca250f98 101 * MFRC522 RfChip (SPI_MOSI, SPI_MISO, SPI_SCLK, SPI_CS, MF_RESET);
Toby_Chen 0:f266ca250f98 102 *
Toby_Chen 0:f266ca250f98 103 * int main(void) {
Toby_Chen 0:f266ca250f98 104 * // Set debug UART speed
Toby_Chen 0:f266ca250f98 105 * DebugUART.baud(115200);
Toby_Chen 0:f266ca250f98 106 *
Toby_Chen 0:f266ca250f98 107 * // Init. RC522 Chip
Toby_Chen 0:f266ca250f98 108 * RfChip.PCD_Init();
Toby_Chen 0:f266ca250f98 109 *
Toby_Chen 0:f266ca250f98 110 * while (true) {
Toby_Chen 0:f266ca250f98 111 * LedRed = 1;
Toby_Chen 0:f266ca250f98 112 * LedGreen = 1;
Toby_Chen 0:f266ca250f98 113 *
Toby_Chen 0:f266ca250f98 114 * // Look for new cards
Toby_Chen 0:f266ca250f98 115 * if ( ! RfChip.PICC_IsNewCardPresent())
Toby_Chen 0:f266ca250f98 116 * {
Toby_Chen 0:f266ca250f98 117 * wait_ms(500);
Toby_Chen 0:f266ca250f98 118 * continue;
Toby_Chen 0:f266ca250f98 119 * }
Toby_Chen 0:f266ca250f98 120 *
Toby_Chen 0:f266ca250f98 121 * LedRed = 0;
Toby_Chen 0:f266ca250f98 122 *
Toby_Chen 0:f266ca250f98 123 * // Select one of the cards
Toby_Chen 0:f266ca250f98 124 * if ( ! RfChip.PICC_ReadCardSerial())
Toby_Chen 0:f266ca250f98 125 * {
Toby_Chen 0:f266ca250f98 126 * wait_ms(500);
Toby_Chen 0:f266ca250f98 127 * continue;
Toby_Chen 0:f266ca250f98 128 * }
Toby_Chen 0:f266ca250f98 129 *
Toby_Chen 0:f266ca250f98 130 * LedRed = 1;
Toby_Chen 0:f266ca250f98 131 * LedGreen = 0;
Toby_Chen 0:f266ca250f98 132 *
Toby_Chen 0:f266ca250f98 133 * // Print Card UID
Toby_Chen 0:f266ca250f98 134 * printf("Card UID: ");
Toby_Chen 0:f266ca250f98 135 * for (uint8_t i = 0; i < RfChip.uid.size; i++)
Toby_Chen 0:f266ca250f98 136 * {
Toby_Chen 0:f266ca250f98 137 * printf(" %X02", RfChip.uid.uidByte[i]);
Toby_Chen 0:f266ca250f98 138 * }
Toby_Chen 0:f266ca250f98 139 * printf("\n\r");
Toby_Chen 0:f266ca250f98 140 *
Toby_Chen 0:f266ca250f98 141 * // Print Card type
Toby_Chen 0:f266ca250f98 142 * uint8_t piccType = RfChip.PICC_GetType(RfChip.uid.sak);
Toby_Chen 0:f266ca250f98 143 * printf("PICC Type: %s \n\r", RfChip.PICC_GetTypeName(piccType));
Toby_Chen 0:f266ca250f98 144 * wait_ms(1000);
Toby_Chen 0:f266ca250f98 145 * }
Toby_Chen 0:f266ca250f98 146 * }
Toby_Chen 0:f266ca250f98 147 * @endcode
Toby_Chen 0:f266ca250f98 148 */
Toby_Chen 0:f266ca250f98 149
Toby_Chen 0:f266ca250f98 150 class MFRC522 {
Toby_Chen 0:f266ca250f98 151 public:
Toby_Chen 0:f266ca250f98 152
Toby_Chen 0:f266ca250f98 153 /**
Toby_Chen 0:f266ca250f98 154 * MFRC522 registers (described in chapter 9 of the datasheet).
Toby_Chen 0:f266ca250f98 155 * When using SPI all addresses are shifted one bit left in the "SPI address byte" (section 8.1.2.3)
Toby_Chen 0:f266ca250f98 156 */
Toby_Chen 0:f266ca250f98 157 enum PCD_Register {
Toby_Chen 0:f266ca250f98 158 // Page 0: Command and status
Toby_Chen 0:f266ca250f98 159 // 0x00 // reserved for future use
Toby_Chen 0:f266ca250f98 160 CommandReg = 0x01 << 1, // starts and stops command execution
Toby_Chen 0:f266ca250f98 161 ComIEnReg = 0x02 << 1, // enable and disable interrupt request control bits
Toby_Chen 0:f266ca250f98 162 DivIEnReg = 0x03 << 1, // enable and disable interrupt request control bits
Toby_Chen 0:f266ca250f98 163 ComIrqReg = 0x04 << 1, // interrupt request bits
Toby_Chen 0:f266ca250f98 164 DivIrqReg = 0x05 << 1, // interrupt request bits
Toby_Chen 0:f266ca250f98 165 ErrorReg = 0x06 << 1, // error bits showing the error status of the last command executed
Toby_Chen 0:f266ca250f98 166 Status1Reg = 0x07 << 1, // communication status bits
Toby_Chen 0:f266ca250f98 167 Status2Reg = 0x08 << 1, // receiver and transmitter status bits
Toby_Chen 0:f266ca250f98 168 FIFODataReg = 0x09 << 1, // input and output of 64 byte FIFO buffer
Toby_Chen 0:f266ca250f98 169 FIFOLevelReg = 0x0A << 1, // number of bytes stored in the FIFO buffer
Toby_Chen 0:f266ca250f98 170 WaterLevelReg = 0x0B << 1, // level for FIFO underflow and overflow warning
Toby_Chen 0:f266ca250f98 171 ControlReg = 0x0C << 1, // miscellaneous control registers
Toby_Chen 0:f266ca250f98 172 BitFramingReg = 0x0D << 1, // adjustments for bit-oriented frames
Toby_Chen 0:f266ca250f98 173 CollReg = 0x0E << 1, // bit position of the first bit-collision detected on the RF interface
Toby_Chen 0:f266ca250f98 174 // 0x0F // reserved for future use
Toby_Chen 0:f266ca250f98 175
Toby_Chen 0:f266ca250f98 176 // Page 1:Command
Toby_Chen 0:f266ca250f98 177 // 0x10 // reserved for future use
Toby_Chen 0:f266ca250f98 178 ModeReg = 0x11 << 1, // defines general modes for transmitting and receiving
Toby_Chen 0:f266ca250f98 179 TxModeReg = 0x12 << 1, // defines transmission data rate and framing
Toby_Chen 0:f266ca250f98 180 RxModeReg = 0x13 << 1, // defines reception data rate and framing
Toby_Chen 0:f266ca250f98 181 TxControlReg = 0x14 << 1, // controls the logical behavior of the antenna driver pins TX1 and TX2
Toby_Chen 0:f266ca250f98 182 TxASKReg = 0x15 << 1, // controls the setting of the transmission modulation
Toby_Chen 0:f266ca250f98 183 TxSelReg = 0x16 << 1, // selects the internal sources for the antenna driver
Toby_Chen 0:f266ca250f98 184 RxSelReg = 0x17 << 1, // selects internal receiver settings
Toby_Chen 0:f266ca250f98 185 RxThresholdReg = 0x18 << 1, // selects thresholds for the bit decoder
Toby_Chen 0:f266ca250f98 186 DemodReg = 0x19 << 1, // defines demodulator settings
Toby_Chen 0:f266ca250f98 187 // 0x1A // reserved for future use
Toby_Chen 0:f266ca250f98 188 // 0x1B // reserved for future use
Toby_Chen 0:f266ca250f98 189 MfTxReg = 0x1C << 1, // controls some MIFARE communication transmit parameters
Toby_Chen 0:f266ca250f98 190 MfRxReg = 0x1D << 1, // controls some MIFARE communication receive parameters
Toby_Chen 0:f266ca250f98 191 // 0x1E // reserved for future use
Toby_Chen 0:f266ca250f98 192 SerialSpeedReg = 0x1F << 1, // selects the speed of the serial UART interface
Toby_Chen 0:f266ca250f98 193
Toby_Chen 0:f266ca250f98 194 // Page 2: Configuration
Toby_Chen 0:f266ca250f98 195 // 0x20 // reserved for future use
Toby_Chen 0:f266ca250f98 196 CRCResultRegH = 0x21 << 1, // shows the MSB and LSB values of the CRC calculation
Toby_Chen 0:f266ca250f98 197 CRCResultRegL = 0x22 << 1,
Toby_Chen 0:f266ca250f98 198 // 0x23 // reserved for future use
Toby_Chen 0:f266ca250f98 199 ModWidthReg = 0x24 << 1, // controls the ModWidth setting?
Toby_Chen 0:f266ca250f98 200 // 0x25 // reserved for future use
Toby_Chen 0:f266ca250f98 201 RFCfgReg = 0x26 << 1, // configures the receiver gain
Toby_Chen 0:f266ca250f98 202 GsNReg = 0x27 << 1, // selects the conductance of the antenna driver pins TX1 and TX2 for modulation
Toby_Chen 0:f266ca250f98 203 CWGsPReg = 0x28 << 1, // defines the conductance of the p-driver output during periods of no modulation
Toby_Chen 0:f266ca250f98 204 ModGsPReg = 0x29 << 1, // defines the conductance of the p-driver output during periods of modulation
Toby_Chen 0:f266ca250f98 205 TModeReg = 0x2A << 1, // defines settings for the internal timer
Toby_Chen 0:f266ca250f98 206 TPrescalerReg = 0x2B << 1, // the lower 8 bits of the TPrescaler value. The 4 high bits are in TModeReg.
Toby_Chen 0:f266ca250f98 207 TReloadRegH = 0x2C << 1, // defines the 16-bit timer reload value
Toby_Chen 0:f266ca250f98 208 TReloadRegL = 0x2D << 1,
Toby_Chen 0:f266ca250f98 209 TCntValueRegH = 0x2E << 1, // shows the 16-bit timer value
Toby_Chen 0:f266ca250f98 210 TCntValueRegL = 0x2F << 1,
Toby_Chen 0:f266ca250f98 211
Toby_Chen 0:f266ca250f98 212 // Page 3:Test Registers
Toby_Chen 0:f266ca250f98 213 // 0x30 // reserved for future use
Toby_Chen 0:f266ca250f98 214 TestSel1Reg = 0x31 << 1, // general test signal configuration
Toby_Chen 0:f266ca250f98 215 TestSel2Reg = 0x32 << 1, // general test signal configuration
Toby_Chen 0:f266ca250f98 216 TestPinEnReg = 0x33 << 1, // enables pin output driver on pins D1 to D7
Toby_Chen 0:f266ca250f98 217 TestPinValueReg = 0x34 << 1, // defines the values for D1 to D7 when it is used as an I/O bus
Toby_Chen 0:f266ca250f98 218 TestBusReg = 0x35 << 1, // shows the status of the internal test bus
Toby_Chen 0:f266ca250f98 219 AutoTestReg = 0x36 << 1, // controls the digital self test
Toby_Chen 0:f266ca250f98 220 VersionReg = 0x37 << 1, // shows the software version
Toby_Chen 0:f266ca250f98 221 AnalogTestReg = 0x38 << 1, // controls the pins AUX1 and AUX2
Toby_Chen 0:f266ca250f98 222 TestDAC1Reg = 0x39 << 1, // defines the test value for TestDAC1
Toby_Chen 0:f266ca250f98 223 TestDAC2Reg = 0x3A << 1, // defines the test value for TestDAC2
Toby_Chen 0:f266ca250f98 224 TestADCReg = 0x3B << 1 // shows the value of ADC I and Q channels
Toby_Chen 0:f266ca250f98 225 // 0x3C // reserved for production tests
Toby_Chen 0:f266ca250f98 226 // 0x3D // reserved for production tests
Toby_Chen 0:f266ca250f98 227 // 0x3E // reserved for production tests
Toby_Chen 0:f266ca250f98 228 // 0x3F // reserved for production tests
Toby_Chen 0:f266ca250f98 229 };
Toby_Chen 0:f266ca250f98 230
Toby_Chen 0:f266ca250f98 231 // MFRC522 commands Described in chapter 10 of the datasheet.
Toby_Chen 0:f266ca250f98 232 enum PCD_Command {
Toby_Chen 0:f266ca250f98 233 PCD_Idle = 0x00, // no action, cancels current command execution
Toby_Chen 0:f266ca250f98 234 PCD_Mem = 0x01, // stores 25 bytes into the internal buffer
Toby_Chen 0:f266ca250f98 235 PCD_GenerateRandomID = 0x02, // generates a 10-byte random ID number
Toby_Chen 0:f266ca250f98 236 PCD_CalcCRC = 0x03, // activates the CRC coprocessor or performs a self test
Toby_Chen 0:f266ca250f98 237 PCD_Transmit = 0x04, // transmits data from the FIFO buffer
Toby_Chen 0:f266ca250f98 238 PCD_NoCmdChange = 0x07, // no command change, can be used to modify the CommandReg register bits without affecting the command, for example, the PowerDown bit
Toby_Chen 0:f266ca250f98 239 PCD_Receive = 0x08, // activates the receiver circuits
Toby_Chen 0:f266ca250f98 240 PCD_Transceive = 0x0C, // transmits data from FIFO buffer to antenna and automatically activates the receiver after transmission
Toby_Chen 0:f266ca250f98 241 PCD_MFAuthent = 0x0E, // performs the MIFARE standard authentication as a reader
Toby_Chen 0:f266ca250f98 242 PCD_SoftReset = 0x0F // resets the MFRC522
Toby_Chen 0:f266ca250f98 243 };
Toby_Chen 0:f266ca250f98 244
Toby_Chen 0:f266ca250f98 245 // Commands sent to the PICC.
Toby_Chen 0:f266ca250f98 246 enum PICC_Command {
Toby_Chen 0:f266ca250f98 247 // The commands used by the PCD to manage communication with several PICCs (ISO 14443-3, Type A, section 6.4)
Toby_Chen 0:f266ca250f98 248 PICC_CMD_REQA = 0x26, // REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame.
Toby_Chen 0:f266ca250f98 249 PICC_CMD_WUPA = 0x52, // Wake-UP command, Type A. Invites PICCs in state IDLE and HALT to go to READY(*) and prepare for anticollision or selection. 7 bit frame.
Toby_Chen 0:f266ca250f98 250 PICC_CMD_CT = 0x88, // Cascade Tag. Not really a command, but used during anti collision.
Toby_Chen 0:f266ca250f98 251 PICC_CMD_SEL_CL1 = 0x93, // Anti collision/Select, Cascade Level 1
Toby_Chen 0:f266ca250f98 252 PICC_CMD_SEL_CL2 = 0x95, // Anti collision/Select, Cascade Level 1
Toby_Chen 0:f266ca250f98 253 PICC_CMD_SEL_CL3 = 0x97, // Anti collision/Select, Cascade Level 1
Toby_Chen 0:f266ca250f98 254 PICC_CMD_HLTA = 0x50, // HaLT command, Type A. Instructs an ACTIVE PICC to go to state HALT.
Toby_Chen 0:f266ca250f98 255
Toby_Chen 0:f266ca250f98 256 // The commands used for MIFARE Classic (from http://www.nxp.com/documents/data_sheet/MF1S503x.pdf, Section 9)
Toby_Chen 0:f266ca250f98 257 // Use PCD_MFAuthent to authenticate access to a sector, then use these commands to read/write/modify the blocks on the sector.
Toby_Chen 0:f266ca250f98 258 // The read/write commands can also be used for MIFARE Ultralight.
Toby_Chen 0:f266ca250f98 259 PICC_CMD_MF_AUTH_KEY_A = 0x60, // Perform authentication with Key A
Toby_Chen 0:f266ca250f98 260 PICC_CMD_MF_AUTH_KEY_B = 0x61, // Perform authentication with Key B
Toby_Chen 0:f266ca250f98 261 PICC_CMD_MF_READ = 0x30, // Reads one 16 byte block from the authenticated sector of the PICC. Also used for MIFARE Ultralight.
Toby_Chen 0:f266ca250f98 262 PICC_CMD_MF_WRITE = 0xA0, // Writes one 16 byte block to the authenticated sector of the PICC. Called "COMPATIBILITY WRITE" for MIFARE Ultralight.
Toby_Chen 0:f266ca250f98 263 PICC_CMD_MF_DECREMENT = 0xC0, // Decrements the contents of a block and stores the result in the internal data register.
Toby_Chen 0:f266ca250f98 264 PICC_CMD_MF_INCREMENT = 0xC1, // Increments the contents of a block and stores the result in the internal data register.
Toby_Chen 0:f266ca250f98 265 PICC_CMD_MF_RESTORE = 0xC2, // Reads the contents of a block into the internal data register.
Toby_Chen 0:f266ca250f98 266 PICC_CMD_MF_TRANSFER = 0xB0, // Writes the contents of the internal data register to a block.
Toby_Chen 0:f266ca250f98 267
Toby_Chen 0:f266ca250f98 268 // The commands used for MIFARE Ultralight (from http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf, Section 8.6)
Toby_Chen 0:f266ca250f98 269 // The PICC_CMD_MF_READ and PICC_CMD_MF_WRITE can also be used for MIFARE Ultralight.
Toby_Chen 0:f266ca250f98 270 PICC_CMD_UL_WRITE = 0xA2 // Writes one 4 byte page to the PICC.
Toby_Chen 0:f266ca250f98 271 };
Toby_Chen 0:f266ca250f98 272
Toby_Chen 0:f266ca250f98 273 // MIFARE constants that does not fit anywhere else
Toby_Chen 0:f266ca250f98 274 enum MIFARE_Misc {
Toby_Chen 0:f266ca250f98 275 MF_ACK = 0xA, // The MIFARE Classic uses a 4 bit ACK/NAK. Any other value than 0xA is NAK.
Toby_Chen 0:f266ca250f98 276 MF_KEY_SIZE = 6 // A Mifare Crypto1 key is 6 bytes.
Toby_Chen 0:f266ca250f98 277 };
Toby_Chen 0:f266ca250f98 278
Toby_Chen 0:f266ca250f98 279 // PICC types we can detect. Remember to update PICC_GetTypeName() if you add more.
Toby_Chen 0:f266ca250f98 280 enum PICC_Type {
Toby_Chen 0:f266ca250f98 281 PICC_TYPE_UNKNOWN = 0,
Toby_Chen 0:f266ca250f98 282 PICC_TYPE_ISO_14443_4 = 1, // PICC compliant with ISO/IEC 14443-4
Toby_Chen 0:f266ca250f98 283 PICC_TYPE_ISO_18092 = 2, // PICC compliant with ISO/IEC 18092 (NFC)
Toby_Chen 0:f266ca250f98 284 PICC_TYPE_MIFARE_MINI = 3, // MIFARE Classic protocol, 320 bytes
Toby_Chen 0:f266ca250f98 285 PICC_TYPE_MIFARE_1K = 4, // MIFARE Classic protocol, 1KB
Toby_Chen 0:f266ca250f98 286 PICC_TYPE_MIFARE_4K = 5, // MIFARE Classic protocol, 4KB
Toby_Chen 0:f266ca250f98 287 PICC_TYPE_MIFARE_UL = 6, // MIFARE Ultralight or Ultralight C
Toby_Chen 0:f266ca250f98 288 PICC_TYPE_MIFARE_PLUS = 7, // MIFARE Plus
Toby_Chen 0:f266ca250f98 289 PICC_TYPE_TNP3XXX = 8, // Only mentioned in NXP AN 10833 MIFARE Type Identification Procedure
Toby_Chen 0:f266ca250f98 290 PICC_TYPE_NOT_COMPLETE = 255 // SAK indicates UID is not complete.
Toby_Chen 0:f266ca250f98 291 };
Toby_Chen 0:f266ca250f98 292
Toby_Chen 0:f266ca250f98 293 // Return codes from the functions in this class. Remember to update GetStatusCodeName() if you add more.
Toby_Chen 0:f266ca250f98 294 enum StatusCode {
Toby_Chen 0:f266ca250f98 295 STATUS_OK = 1, // Success
Toby_Chen 0:f266ca250f98 296 STATUS_ERROR = 2, // Error in communication
Toby_Chen 0:f266ca250f98 297 STATUS_COLLISION = 3, // Collision detected
Toby_Chen 0:f266ca250f98 298 STATUS_TIMEOUT = 4, // Timeout in communication.
Toby_Chen 0:f266ca250f98 299 STATUS_NO_ROOM = 5, // A buffer is not big enough.
Toby_Chen 0:f266ca250f98 300 STATUS_INTERNAL_ERROR = 6, // Internal error in the code. Should not happen ;-)
Toby_Chen 0:f266ca250f98 301 STATUS_INVALID = 7, // Invalid argument.
Toby_Chen 0:f266ca250f98 302 STATUS_CRC_WRONG = 8, // The CRC_A does not match
Toby_Chen 0:f266ca250f98 303 STATUS_MIFARE_NACK = 9 // A MIFARE PICC responded with NAK.
Toby_Chen 0:f266ca250f98 304 };
Toby_Chen 0:f266ca250f98 305
Toby_Chen 0:f266ca250f98 306 // A struct used for passing the UID of a PICC.
Toby_Chen 0:f266ca250f98 307 typedef struct {
Toby_Chen 0:f266ca250f98 308 uint8_t size; // Number of bytes in the UID. 4, 7 or 10.
Toby_Chen 0:f266ca250f98 309 uint8_t uidByte[10];
Toby_Chen 0:f266ca250f98 310 uint8_t sak; // The SAK (Select acknowledge) byte returned from the PICC after successful selection.
Toby_Chen 0:f266ca250f98 311 } Uid;
Toby_Chen 0:f266ca250f98 312
Toby_Chen 0:f266ca250f98 313 // A struct used for passing a MIFARE Crypto1 key
Toby_Chen 0:f266ca250f98 314 typedef struct {
Toby_Chen 0:f266ca250f98 315 uint8_t keyByte[MF_KEY_SIZE];
Toby_Chen 0:f266ca250f98 316 } MIFARE_Key;
Toby_Chen 0:f266ca250f98 317
Toby_Chen 0:f266ca250f98 318 // Member variables
Toby_Chen 0:f266ca250f98 319 Uid uid; // Used by PICC_ReadCardSerial().
Toby_Chen 0:f266ca250f98 320
Toby_Chen 0:f266ca250f98 321 // Size of the MFRC522 FIFO
Toby_Chen 0:f266ca250f98 322 static const uint8_t FIFO_SIZE = 64; // The FIFO is 64 bytes.
Toby_Chen 0:f266ca250f98 323
Toby_Chen 0:f266ca250f98 324 /**
Toby_Chen 0:f266ca250f98 325 * MFRC522 constructor
Toby_Chen 0:f266ca250f98 326 *
Toby_Chen 0:f266ca250f98 327 * @param mosi SPI MOSI pin
Toby_Chen 0:f266ca250f98 328 * @param miso SPI MISO pin
Toby_Chen 0:f266ca250f98 329 * @param sclk SPI SCLK pin
Toby_Chen 0:f266ca250f98 330 * @param cs SPI CS pin
Toby_Chen 0:f266ca250f98 331 * @param reset Reset pin
Toby_Chen 0:f266ca250f98 332 */
Toby_Chen 0:f266ca250f98 333 MFRC522(PinName mosi, PinName miso, PinName sclk, PinName cs, PinName reset);
Toby_Chen 0:f266ca250f98 334
Toby_Chen 0:f266ca250f98 335 /**
Toby_Chen 0:f266ca250f98 336 * MFRC522 destructor
Toby_Chen 0:f266ca250f98 337 */
Toby_Chen 0:f266ca250f98 338 ~MFRC522();
Toby_Chen 0:f266ca250f98 339
Toby_Chen 0:f266ca250f98 340
Toby_Chen 0:f266ca250f98 341 // ************************************************************************************
Toby_Chen 0:f266ca250f98 342 //! @name Functions for manipulating the MFRC522
Toby_Chen 0:f266ca250f98 343 // ************************************************************************************
Toby_Chen 0:f266ca250f98 344 //@{
Toby_Chen 0:f266ca250f98 345
Toby_Chen 0:f266ca250f98 346 /**
Toby_Chen 0:f266ca250f98 347 * Initializes the MFRC522 chip.
Toby_Chen 0:f266ca250f98 348 */
Toby_Chen 0:f266ca250f98 349 void PCD_Init (void);
Toby_Chen 0:f266ca250f98 350
Toby_Chen 0:f266ca250f98 351 /**
Toby_Chen 0:f266ca250f98 352 * Performs a soft reset on the MFRC522 chip and waits for it to be ready again.
Toby_Chen 0:f266ca250f98 353 */
Toby_Chen 0:f266ca250f98 354 void PCD_Reset (void);
Toby_Chen 0:f266ca250f98 355
Toby_Chen 0:f266ca250f98 356 /**
Toby_Chen 0:f266ca250f98 357 * Turns the antenna on by enabling pins TX1 and TX2.
Toby_Chen 0:f266ca250f98 358 * After a reset these pins disabled.
Toby_Chen 0:f266ca250f98 359 */
Toby_Chen 0:f266ca250f98 360 void PCD_AntennaOn (void);
Toby_Chen 0:f266ca250f98 361
Toby_Chen 0:f266ca250f98 362 /**
Toby_Chen 0:f266ca250f98 363 * Writes a byte to the specified register in the MFRC522 chip.
Toby_Chen 0:f266ca250f98 364 * The interface is described in the datasheet section 8.1.2.
Toby_Chen 0:f266ca250f98 365 *
Toby_Chen 0:f266ca250f98 366 * @param reg The register to write to. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 367 * @param value The value to write.
Toby_Chen 0:f266ca250f98 368 */
Toby_Chen 0:f266ca250f98 369 void PCD_WriteRegister (uint8_t reg, uint8_t value);
Toby_Chen 0:f266ca250f98 370
Toby_Chen 0:f266ca250f98 371 /**
Toby_Chen 0:f266ca250f98 372 * Writes a number of bytes to the specified register in the MFRC522 chip.
Toby_Chen 0:f266ca250f98 373 * The interface is described in the datasheet section 8.1.2.
Toby_Chen 0:f266ca250f98 374 *
Toby_Chen 0:f266ca250f98 375 * @param reg The register to write to. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 376 * @param count The number of bytes to write to the register
Toby_Chen 0:f266ca250f98 377 * @param values The values to write. Byte array.
Toby_Chen 0:f266ca250f98 378 */
Toby_Chen 0:f266ca250f98 379 void PCD_WriteRegister (uint8_t reg, uint8_t count, uint8_t *values);
Toby_Chen 0:f266ca250f98 380
Toby_Chen 0:f266ca250f98 381 /**
Toby_Chen 0:f266ca250f98 382 * Reads a byte from the specified register in the MFRC522 chip.
Toby_Chen 0:f266ca250f98 383 * The interface is described in the datasheet section 8.1.2.
Toby_Chen 0:f266ca250f98 384 *
Toby_Chen 0:f266ca250f98 385 * @param reg The register to read from. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 386 * @returns Register value
Toby_Chen 0:f266ca250f98 387 */
Toby_Chen 0:f266ca250f98 388 uint8_t PCD_ReadRegister (uint8_t reg);
Toby_Chen 0:f266ca250f98 389
Toby_Chen 0:f266ca250f98 390 /**
Toby_Chen 0:f266ca250f98 391 * Reads a number of bytes from the specified register in the MFRC522 chip.
Toby_Chen 0:f266ca250f98 392 * The interface is described in the datasheet section 8.1.2.
Toby_Chen 0:f266ca250f98 393 *
Toby_Chen 0:f266ca250f98 394 * @param reg The register to read from. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 395 * @param count The number of bytes to read.
Toby_Chen 0:f266ca250f98 396 * @param values Byte array to store the values in.
Toby_Chen 0:f266ca250f98 397 * @param rxAlign Only bit positions rxAlign..7 in values[0] are updated.
Toby_Chen 0:f266ca250f98 398 */
Toby_Chen 0:f266ca250f98 399 void PCD_ReadRegister (uint8_t reg, uint8_t count, uint8_t *values, uint8_t rxAlign = 0);
Toby_Chen 0:f266ca250f98 400
Toby_Chen 0:f266ca250f98 401 /**
Toby_Chen 0:f266ca250f98 402 * Sets the bits given in mask in register reg.
Toby_Chen 0:f266ca250f98 403 *
Toby_Chen 0:f266ca250f98 404 * @param reg The register to update. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 405 * @param mask The bits to set.
Toby_Chen 0:f266ca250f98 406 */
Toby_Chen 0:f266ca250f98 407 void PCD_SetRegisterBits(uint8_t reg, uint8_t mask);
Toby_Chen 0:f266ca250f98 408
Toby_Chen 0:f266ca250f98 409 /**
Toby_Chen 0:f266ca250f98 410 * Clears the bits given in mask from register reg.
Toby_Chen 0:f266ca250f98 411 *
Toby_Chen 0:f266ca250f98 412 * @param reg The register to update. One of the PCD_Register enums.
Toby_Chen 0:f266ca250f98 413 * @param mask The bits to clear.
Toby_Chen 0:f266ca250f98 414 */
Toby_Chen 0:f266ca250f98 415 void PCD_ClrRegisterBits(uint8_t reg, uint8_t mask);
Toby_Chen 0:f266ca250f98 416
Toby_Chen 0:f266ca250f98 417 /**
Toby_Chen 0:f266ca250f98 418 * Use the CRC coprocessor in the MFRC522 to calculate a CRC_A.
Toby_Chen 0:f266ca250f98 419 *
Toby_Chen 0:f266ca250f98 420 * @param data Pointer to the data to transfer to the FIFO for CRC calculation.
Toby_Chen 0:f266ca250f98 421 * @param length The number of bytes to transfer.
Toby_Chen 0:f266ca250f98 422 * @param result Pointer to result buffer. Result is written to result[0..1], low byte first.
Toby_Chen 0:f266ca250f98 423 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 424 */
Toby_Chen 0:f266ca250f98 425 uint8_t PCD_CalculateCRC (uint8_t *data, uint8_t length, uint8_t *result);
Toby_Chen 0:f266ca250f98 426
Toby_Chen 0:f266ca250f98 427 /**
Toby_Chen 0:f266ca250f98 428 * Executes the Transceive command.
Toby_Chen 0:f266ca250f98 429 * CRC validation can only be done if backData and backLen are specified.
Toby_Chen 0:f266ca250f98 430 *
Toby_Chen 0:f266ca250f98 431 * @param sendData Pointer to the data to transfer to the FIFO.
Toby_Chen 0:f266ca250f98 432 * @param sendLen Number of bytes to transfer to the FIFO.
Toby_Chen 0:f266ca250f98 433 * @param backData NULL or pointer to buffer if data should be read back after executing the command.
Toby_Chen 0:f266ca250f98 434 * @param backLen Max number of bytes to write to *backData. Out: The number of bytes returned.
Toby_Chen 0:f266ca250f98 435 * @param validBits The number of valid bits in the last byte. 0 for 8 valid bits. Default NULL.
Toby_Chen 0:f266ca250f98 436 * @param rxAlign Defines the bit position in backData[0] for the first bit received. Default 0.
Toby_Chen 0:f266ca250f98 437 * @param checkCRC True => The last two bytes of the response is assumed to be a CRC_A that must be validated.
Toby_Chen 0:f266ca250f98 438 *
Toby_Chen 0:f266ca250f98 439 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 440 */
Toby_Chen 0:f266ca250f98 441 uint8_t PCD_TransceiveData (uint8_t *sendData,
Toby_Chen 0:f266ca250f98 442 uint8_t sendLen,
Toby_Chen 0:f266ca250f98 443 uint8_t *backData,
Toby_Chen 0:f266ca250f98 444 uint8_t *backLen,
Toby_Chen 0:f266ca250f98 445 uint8_t *validBits = NULL,
Toby_Chen 0:f266ca250f98 446 uint8_t rxAlign = 0,
Toby_Chen 0:f266ca250f98 447 bool checkCRC = false);
Toby_Chen 0:f266ca250f98 448
Toby_Chen 0:f266ca250f98 449
Toby_Chen 0:f266ca250f98 450 /**
Toby_Chen 0:f266ca250f98 451 * Transfers data to the MFRC522 FIFO, executes a commend, waits for completion and transfers data back from the FIFO.
Toby_Chen 0:f266ca250f98 452 * CRC validation can only be done if backData and backLen are specified.
Toby_Chen 0:f266ca250f98 453 *
Toby_Chen 0:f266ca250f98 454 * @param command The command to execute. One of the PCD_Command enums.
Toby_Chen 0:f266ca250f98 455 * @param waitIRq The bits in the ComIrqReg register that signals successful completion of the command.
Toby_Chen 0:f266ca250f98 456 * @param sendData Pointer to the data to transfer to the FIFO.
Toby_Chen 0:f266ca250f98 457 * @param sendLen Number of bytes to transfer to the FIFO.
Toby_Chen 0:f266ca250f98 458 * @param backData NULL or pointer to buffer if data should be read back after executing the command.
Toby_Chen 0:f266ca250f98 459 * @param backLen In: Max number of bytes to write to *backData. Out: The number of bytes returned.
Toby_Chen 0:f266ca250f98 460 * @param validBits In/Out: The number of valid bits in the last byte. 0 for 8 valid bits.
Toby_Chen 0:f266ca250f98 461 * @param rxAlign In: Defines the bit position in backData[0] for the first bit received. Default 0.
Toby_Chen 0:f266ca250f98 462 * @param checkCRC In: True => The last two bytes of the response is assumed to be a CRC_A that must be validated.
Toby_Chen 0:f266ca250f98 463 *
Toby_Chen 0:f266ca250f98 464 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 465 */
Toby_Chen 0:f266ca250f98 466 uint8_t PCD_CommunicateWithPICC(uint8_t command,
Toby_Chen 0:f266ca250f98 467 uint8_t waitIRq,
Toby_Chen 0:f266ca250f98 468 uint8_t *sendData,
Toby_Chen 0:f266ca250f98 469 uint8_t sendLen,
Toby_Chen 0:f266ca250f98 470 uint8_t *backData = NULL,
Toby_Chen 0:f266ca250f98 471 uint8_t *backLen = NULL,
Toby_Chen 0:f266ca250f98 472 uint8_t *validBits = NULL,
Toby_Chen 0:f266ca250f98 473 uint8_t rxAlign = 0,
Toby_Chen 0:f266ca250f98 474 bool checkCRC = false);
Toby_Chen 0:f266ca250f98 475
Toby_Chen 0:f266ca250f98 476 /**
Toby_Chen 0:f266ca250f98 477 * Transmits a REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame.
Toby_Chen 0:f266ca250f98 478 * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design.
Toby_Chen 0:f266ca250f98 479 *
Toby_Chen 0:f266ca250f98 480 * @param bufferATQA The buffer to store the ATQA (Answer to request) in
Toby_Chen 0:f266ca250f98 481 * @param bufferSize Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK.
Toby_Chen 0:f266ca250f98 482 *
Toby_Chen 0:f266ca250f98 483 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 484 */
Toby_Chen 0:f266ca250f98 485 uint8_t PICC_RequestA (uint8_t *bufferATQA, uint8_t *bufferSize);
Toby_Chen 0:f266ca250f98 486
Toby_Chen 0:f266ca250f98 487 /**
Toby_Chen 0:f266ca250f98 488 * Transmits a Wake-UP command, Type A. Invites PICCs in state IDLE and HALT to go to READY(*) and prepare for anticollision or selection. 7 bit frame.
Toby_Chen 0:f266ca250f98 489 * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design.
Toby_Chen 0:f266ca250f98 490 *
Toby_Chen 0:f266ca250f98 491 * @param bufferATQA The buffer to store the ATQA (Answer to request) in
Toby_Chen 0:f266ca250f98 492 * @param bufferSize Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK.
Toby_Chen 0:f266ca250f98 493 *
Toby_Chen 0:f266ca250f98 494 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 495 */
Toby_Chen 0:f266ca250f98 496 uint8_t PICC_WakeupA (uint8_t *bufferATQA, uint8_t *bufferSize);
Toby_Chen 0:f266ca250f98 497
Toby_Chen 0:f266ca250f98 498 /**
Toby_Chen 0:f266ca250f98 499 * Transmits REQA or WUPA commands.
Toby_Chen 0:f266ca250f98 500 * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design.
Toby_Chen 0:f266ca250f98 501 *
Toby_Chen 0:f266ca250f98 502 * @param command The command to send - PICC_CMD_REQA or PICC_CMD_WUPA
Toby_Chen 0:f266ca250f98 503 * @param bufferATQA The buffer to store the ATQA (Answer to request) in
Toby_Chen 0:f266ca250f98 504 * @param bufferSize Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK.
Toby_Chen 0:f266ca250f98 505 *
Toby_Chen 0:f266ca250f98 506 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 507 */
Toby_Chen 0:f266ca250f98 508 uint8_t PICC_REQA_or_WUPA (uint8_t command, uint8_t *bufferATQA, uint8_t *bufferSize);
Toby_Chen 0:f266ca250f98 509
Toby_Chen 0:f266ca250f98 510 /**
Toby_Chen 0:f266ca250f98 511 * Transmits SELECT/ANTICOLLISION commands to select a single PICC.
Toby_Chen 0:f266ca250f98 512 * Before calling this function the PICCs must be placed in the READY(*) state by calling PICC_RequestA() or PICC_WakeupA().
Toby_Chen 0:f266ca250f98 513 * On success:
Toby_Chen 0:f266ca250f98 514 * - The chosen PICC is in state ACTIVE(*) and all other PICCs have returned to state IDLE/HALT. (Figure 7 of the ISO/IEC 14443-3 draft.)
Toby_Chen 0:f266ca250f98 515 * - The UID size and value of the chosen PICC is returned in *uid along with the SAK.
Toby_Chen 0:f266ca250f98 516 *
Toby_Chen 0:f266ca250f98 517 * A PICC UID consists of 4, 7 or 10 bytes.
Toby_Chen 0:f266ca250f98 518 * Only 4 bytes can be specified in a SELECT command, so for the longer UIDs two or three iterations are used:
Toby_Chen 0:f266ca250f98 519 *
Toby_Chen 0:f266ca250f98 520 * UID size Number of UID bytes Cascade levels Example of PICC
Toby_Chen 0:f266ca250f98 521 * ======== =================== ============== ===============
Toby_Chen 0:f266ca250f98 522 * single 4 1 MIFARE Classic
Toby_Chen 0:f266ca250f98 523 * double 7 2 MIFARE Ultralight
Toby_Chen 0:f266ca250f98 524 * triple 10 3 Not currently in use?
Toby_Chen 0:f266ca250f98 525 *
Toby_Chen 0:f266ca250f98 526 *
Toby_Chen 0:f266ca250f98 527 * @param uid Pointer to Uid struct. Normally output, but can also be used to supply a known UID.
Toby_Chen 0:f266ca250f98 528 * @param validBits The number of known UID bits supplied in *uid. Normally 0. If set you must also supply uid->size.
Toby_Chen 0:f266ca250f98 529 *
Toby_Chen 0:f266ca250f98 530 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 531 */
Toby_Chen 0:f266ca250f98 532 uint8_t PICC_Select (Uid *uid, uint8_t validBits = 0);
Toby_Chen 0:f266ca250f98 533
Toby_Chen 0:f266ca250f98 534 /**
Toby_Chen 0:f266ca250f98 535 * Instructs a PICC in state ACTIVE(*) to go to state HALT.
Toby_Chen 0:f266ca250f98 536 *
Toby_Chen 0:f266ca250f98 537 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 538 */
Toby_Chen 0:f266ca250f98 539 uint8_t PICC_HaltA (void);
Toby_Chen 0:f266ca250f98 540
Toby_Chen 0:f266ca250f98 541 // ************************************************************************************
Toby_Chen 0:f266ca250f98 542 //@}
Toby_Chen 0:f266ca250f98 543
Toby_Chen 0:f266ca250f98 544
Toby_Chen 0:f266ca250f98 545 // ************************************************************************************
Toby_Chen 0:f266ca250f98 546 //! @name Functions for communicating with MIFARE PICCs
Toby_Chen 0:f266ca250f98 547 // ************************************************************************************
Toby_Chen 0:f266ca250f98 548 //@{
Toby_Chen 0:f266ca250f98 549
Toby_Chen 0:f266ca250f98 550 /**
Toby_Chen 0:f266ca250f98 551 * Executes the MFRC522 MFAuthent command.
Toby_Chen 0:f266ca250f98 552 * This command manages MIFARE authentication to enable a secure communication to any MIFARE Mini, MIFARE 1K and MIFARE 4K card.
Toby_Chen 0:f266ca250f98 553 * The authentication is described in the MFRC522 datasheet section 10.3.1.9 and http://www.nxp.com/documents/data_sheet/MF1S503x.pdf section 10.1.
Toby_Chen 0:f266ca250f98 554 * For use with MIFARE Classic PICCs.
Toby_Chen 0:f266ca250f98 555 * The PICC must be selected - ie in state ACTIVE(*) - before calling this function.
Toby_Chen 0:f266ca250f98 556 * Remember to call PCD_StopCrypto1() after communicating with the authenticated PICC - otherwise no new communications can start.
Toby_Chen 0:f266ca250f98 557 *
Toby_Chen 0:f266ca250f98 558 * All keys are set to FFFFFFFFFFFFh at chip delivery.
Toby_Chen 0:f266ca250f98 559 *
Toby_Chen 0:f266ca250f98 560 * @param command PICC_CMD_MF_AUTH_KEY_A or PICC_CMD_MF_AUTH_KEY_B
Toby_Chen 0:f266ca250f98 561 * @param blockAddr The block number. See numbering in the comments in the .h file.
Toby_Chen 0:f266ca250f98 562 * @param key Pointer to the Crypteo1 key to use (6 bytes)
Toby_Chen 0:f266ca250f98 563 * @param uid Pointer to Uid struct. The first 4 bytes of the UID is used.
Toby_Chen 0:f266ca250f98 564 *
Toby_Chen 0:f266ca250f98 565 * @return STATUS_OK on success, STATUS_??? otherwise. Probably STATUS_TIMEOUT if you supply the wrong key.
Toby_Chen 0:f266ca250f98 566 */
Toby_Chen 0:f266ca250f98 567 uint8_t PCD_Authenticate (uint8_t command, uint8_t blockAddr, MIFARE_Key *key, Uid *uid);
Toby_Chen 0:f266ca250f98 568
Toby_Chen 0:f266ca250f98 569 /**
Toby_Chen 0:f266ca250f98 570 * Used to exit the PCD from its authenticated state.
Toby_Chen 0:f266ca250f98 571 * Remember to call this function after communicating with an authenticated PICC - otherwise no new communications can start.
Toby_Chen 0:f266ca250f98 572 */
Toby_Chen 0:f266ca250f98 573 void PCD_StopCrypto1 (void);
Toby_Chen 0:f266ca250f98 574
Toby_Chen 0:f266ca250f98 575 /**
Toby_Chen 0:f266ca250f98 576 * Reads 16 bytes (+ 2 bytes CRC_A) from the active PICC.
Toby_Chen 0:f266ca250f98 577 *
Toby_Chen 0:f266ca250f98 578 * For MIFARE Classic the sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 579 *
Toby_Chen 0:f266ca250f98 580 * For MIFARE Ultralight only addresses 00h to 0Fh are decoded.
Toby_Chen 0:f266ca250f98 581 * The MF0ICU1 returns a NAK for higher addresses.
Toby_Chen 0:f266ca250f98 582 * The MF0ICU1 responds to the READ command by sending 16 bytes starting from the page address defined by the command argument.
Toby_Chen 0:f266ca250f98 583 * For example; if blockAddr is 03h then pages 03h, 04h, 05h, 06h are returned.
Toby_Chen 0:f266ca250f98 584 * A roll-back is implemented: If blockAddr is 0Eh, then the contents of pages 0Eh, 0Fh, 00h and 01h are returned.
Toby_Chen 0:f266ca250f98 585 *
Toby_Chen 0:f266ca250f98 586 * The buffer must be at least 18 bytes because a CRC_A is also returned.
Toby_Chen 0:f266ca250f98 587 * Checks the CRC_A before returning STATUS_OK.
Toby_Chen 0:f266ca250f98 588 *
Toby_Chen 0:f266ca250f98 589 * @param blockAddr MIFARE Classic: The block (0-0xff) number. MIFARE Ultralight: The first page to return data from.
Toby_Chen 0:f266ca250f98 590 * @param buffer The buffer to store the data in
Toby_Chen 0:f266ca250f98 591 * @param bufferSize Buffer size, at least 18 bytes. Also number of bytes returned if STATUS_OK.
Toby_Chen 0:f266ca250f98 592 *
Toby_Chen 0:f266ca250f98 593 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 594 */
Toby_Chen 0:f266ca250f98 595 uint8_t MIFARE_Read (uint8_t blockAddr, uint8_t *buffer, uint8_t *bufferSize);
Toby_Chen 0:f266ca250f98 596
Toby_Chen 0:f266ca250f98 597 /**
Toby_Chen 0:f266ca250f98 598 * Writes 16 bytes to the active PICC.
Toby_Chen 0:f266ca250f98 599 *
Toby_Chen 0:f266ca250f98 600 * For MIFARE Classic the sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 601 *
Toby_Chen 0:f266ca250f98 602 * For MIFARE Ultralight the opretaion is called "COMPATIBILITY WRITE".
Toby_Chen 0:f266ca250f98 603 * Even though 16 bytes are transferred to the Ultralight PICC, only the least significant 4 bytes (bytes 0 to 3)
Toby_Chen 0:f266ca250f98 604 * are written to the specified address. It is recommended to set the remaining bytes 04h to 0Fh to all logic 0.
Toby_Chen 0:f266ca250f98 605 *
Toby_Chen 0:f266ca250f98 606 * @param blockAddr MIFARE Classic: The block (0-0xff) number. MIFARE Ultralight: The page (2-15) to write to.
Toby_Chen 0:f266ca250f98 607 * @param buffer The 16 bytes to write to the PICC
Toby_Chen 0:f266ca250f98 608 * @param bufferSize Buffer size, must be at least 16 bytes. Exactly 16 bytes are written.
Toby_Chen 0:f266ca250f98 609 *
Toby_Chen 0:f266ca250f98 610 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 611 */
Toby_Chen 0:f266ca250f98 612 uint8_t MIFARE_Write (uint8_t blockAddr, uint8_t *buffer, uint8_t bufferSize);
Toby_Chen 0:f266ca250f98 613
Toby_Chen 0:f266ca250f98 614 /**
Toby_Chen 0:f266ca250f98 615 * Writes a 4 byte page to the active MIFARE Ultralight PICC.
Toby_Chen 0:f266ca250f98 616 *
Toby_Chen 0:f266ca250f98 617 * @param page The page (2-15) to write to.
Toby_Chen 0:f266ca250f98 618 * @param buffer The 4 bytes to write to the PICC
Toby_Chen 0:f266ca250f98 619 * @param bufferSize Buffer size, must be at least 4 bytes. Exactly 4 bytes are written.
Toby_Chen 0:f266ca250f98 620 *
Toby_Chen 0:f266ca250f98 621 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 622 */
Toby_Chen 0:f266ca250f98 623 uint8_t MIFARE_UltralightWrite(uint8_t page, uint8_t *buffer, uint8_t bufferSize);
Toby_Chen 0:f266ca250f98 624
Toby_Chen 0:f266ca250f98 625 /**
Toby_Chen 0:f266ca250f98 626 * MIFARE Decrement subtracts the delta from the value of the addressed block, and stores the result in a volatile memory.
Toby_Chen 0:f266ca250f98 627 * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 628 * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001].
Toby_Chen 0:f266ca250f98 629 * Use MIFARE_Transfer() to store the result in a block.
Toby_Chen 0:f266ca250f98 630 *
Toby_Chen 0:f266ca250f98 631 * @param blockAddr The block (0-0xff) number.
Toby_Chen 0:f266ca250f98 632 * @param delta This number is subtracted from the value of block blockAddr.
Toby_Chen 0:f266ca250f98 633 *
Toby_Chen 0:f266ca250f98 634 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 635 */
Toby_Chen 0:f266ca250f98 636 uint8_t MIFARE_Decrement (uint8_t blockAddr, uint32_t delta);
Toby_Chen 0:f266ca250f98 637
Toby_Chen 0:f266ca250f98 638 /**
Toby_Chen 0:f266ca250f98 639 * MIFARE Increment adds the delta to the value of the addressed block, and stores the result in a volatile memory.
Toby_Chen 0:f266ca250f98 640 * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 641 * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001].
Toby_Chen 0:f266ca250f98 642 * Use MIFARE_Transfer() to store the result in a block.
Toby_Chen 0:f266ca250f98 643 *
Toby_Chen 0:f266ca250f98 644 * @param blockAddr The block (0-0xff) number.
Toby_Chen 0:f266ca250f98 645 * @param delta This number is added to the value of block blockAddr.
Toby_Chen 0:f266ca250f98 646 *
Toby_Chen 0:f266ca250f98 647 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 648 */
Toby_Chen 0:f266ca250f98 649 uint8_t MIFARE_Increment (uint8_t blockAddr, uint32_t delta);
Toby_Chen 0:f266ca250f98 650
Toby_Chen 0:f266ca250f98 651 /**
Toby_Chen 0:f266ca250f98 652 * MIFARE Restore copies the value of the addressed block into a volatile memory.
Toby_Chen 0:f266ca250f98 653 * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 654 * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001].
Toby_Chen 0:f266ca250f98 655 * Use MIFARE_Transfer() to store the result in a block.
Toby_Chen 0:f266ca250f98 656 *
Toby_Chen 0:f266ca250f98 657 * @param blockAddr The block (0-0xff) number.
Toby_Chen 0:f266ca250f98 658 *
Toby_Chen 0:f266ca250f98 659 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 660 */
Toby_Chen 0:f266ca250f98 661 uint8_t MIFARE_Restore (uint8_t blockAddr);
Toby_Chen 0:f266ca250f98 662
Toby_Chen 0:f266ca250f98 663 /**
Toby_Chen 0:f266ca250f98 664 * MIFARE Transfer writes the value stored in the volatile memory into one MIFARE Classic block.
Toby_Chen 0:f266ca250f98 665 * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function.
Toby_Chen 0:f266ca250f98 666 * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001].
Toby_Chen 0:f266ca250f98 667 *
Toby_Chen 0:f266ca250f98 668 * @param blockAddr The block (0-0xff) number.
Toby_Chen 0:f266ca250f98 669 *
Toby_Chen 0:f266ca250f98 670 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 671 */
Toby_Chen 0:f266ca250f98 672 uint8_t MIFARE_Transfer (uint8_t blockAddr);
Toby_Chen 0:f266ca250f98 673
Toby_Chen 0:f266ca250f98 674 // ************************************************************************************
Toby_Chen 0:f266ca250f98 675 //@}
Toby_Chen 0:f266ca250f98 676
Toby_Chen 0:f266ca250f98 677
Toby_Chen 0:f266ca250f98 678 // ************************************************************************************
Toby_Chen 0:f266ca250f98 679 //! @name Support functions
Toby_Chen 0:f266ca250f98 680 // ************************************************************************************
Toby_Chen 0:f266ca250f98 681 //@{
Toby_Chen 0:f266ca250f98 682
Toby_Chen 0:f266ca250f98 683 /**
Toby_Chen 0:f266ca250f98 684 * Wrapper for MIFARE protocol communication.
Toby_Chen 0:f266ca250f98 685 * Adds CRC_A, executes the Transceive command and checks that the response is MF_ACK or a timeout.
Toby_Chen 0:f266ca250f98 686 *
Toby_Chen 0:f266ca250f98 687 * @param sendData Pointer to the data to transfer to the FIFO. Do NOT include the CRC_A.
Toby_Chen 0:f266ca250f98 688 * @param sendLen Number of bytes in sendData.
Toby_Chen 0:f266ca250f98 689 * @param acceptTimeout True => A timeout is also success
Toby_Chen 0:f266ca250f98 690 *
Toby_Chen 0:f266ca250f98 691 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 692 */
Toby_Chen 0:f266ca250f98 693 uint8_t PCD_MIFARE_Transceive(uint8_t *sendData, uint8_t sendLen, bool acceptTimeout = false);
Toby_Chen 0:f266ca250f98 694
Toby_Chen 0:f266ca250f98 695 /**
Toby_Chen 0:f266ca250f98 696 * Translates the SAK (Select Acknowledge) to a PICC type.
Toby_Chen 0:f266ca250f98 697 *
Toby_Chen 0:f266ca250f98 698 * @param sak The SAK byte returned from PICC_Select().
Toby_Chen 0:f266ca250f98 699 *
Toby_Chen 0:f266ca250f98 700 * @return PICC_Type
Toby_Chen 0:f266ca250f98 701 */
Toby_Chen 0:f266ca250f98 702 uint8_t PICC_GetType (uint8_t sak);
Toby_Chen 0:f266ca250f98 703
Toby_Chen 0:f266ca250f98 704 /**
Toby_Chen 0:f266ca250f98 705 * Returns a string pointer to the PICC type name.
Toby_Chen 0:f266ca250f98 706 *
Toby_Chen 0:f266ca250f98 707 * @param type One of the PICC_Type enums.
Toby_Chen 0:f266ca250f98 708 *
Toby_Chen 0:f266ca250f98 709 * @return A string pointer to the PICC type name.
Toby_Chen 0:f266ca250f98 710 */
Toby_Chen 0:f266ca250f98 711 char* PICC_GetTypeName (uint8_t type);
Toby_Chen 0:f266ca250f98 712
Toby_Chen 0:f266ca250f98 713 /**
Toby_Chen 0:f266ca250f98 714 * Returns a string pointer to a status code name.
Toby_Chen 0:f266ca250f98 715 *
Toby_Chen 0:f266ca250f98 716 * @param code One of the StatusCode enums.
Toby_Chen 0:f266ca250f98 717 *
Toby_Chen 0:f266ca250f98 718 * @return A string pointer to a status code name.
Toby_Chen 0:f266ca250f98 719 */
Toby_Chen 0:f266ca250f98 720 char* GetStatusCodeName (uint8_t code);
Toby_Chen 0:f266ca250f98 721
Toby_Chen 0:f266ca250f98 722 /**
Toby_Chen 0:f266ca250f98 723 * Calculates the bit pattern needed for the specified access bits. In the [C1 C2 C3] tupples C1 is MSB (=4) and C3 is LSB (=1).
Toby_Chen 0:f266ca250f98 724 *
Toby_Chen 0:f266ca250f98 725 * @param accessBitBuffer Pointer to byte 6, 7 and 8 in the sector trailer. Bytes [0..2] will be set.
Toby_Chen 0:f266ca250f98 726 * @param g0 Access bits [C1 C2 C3] for block 0 (for sectors 0-31) or blocks 0-4 (for sectors 32-39)
Toby_Chen 0:f266ca250f98 727 * @param g1 Access bits [C1 C2 C3] for block 1 (for sectors 0-31) or blocks 5-9 (for sectors 32-39)
Toby_Chen 0:f266ca250f98 728 * @param g2 Access bits [C1 C2 C3] for block 2 (for sectors 0-31) or blocks 10-14 (for sectors 32-39)
Toby_Chen 0:f266ca250f98 729 * @param g3 Access bits [C1 C2 C3] for the sector trailer, block 3 (for sectors 0-31) or block 15 (for sectors 32-39)
Toby_Chen 0:f266ca250f98 730 */
Toby_Chen 0:f266ca250f98 731 void MIFARE_SetAccessBits (uint8_t *accessBitBuffer,
Toby_Chen 0:f266ca250f98 732 uint8_t g0,
Toby_Chen 0:f266ca250f98 733 uint8_t g1,
Toby_Chen 0:f266ca250f98 734 uint8_t g2,
Toby_Chen 0:f266ca250f98 735 uint8_t g3);
Toby_Chen 0:f266ca250f98 736
Toby_Chen 0:f266ca250f98 737 // ************************************************************************************
Toby_Chen 0:f266ca250f98 738 //@}
Toby_Chen 0:f266ca250f98 739
Toby_Chen 0:f266ca250f98 740
Toby_Chen 0:f266ca250f98 741 // ************************************************************************************
Toby_Chen 0:f266ca250f98 742 //! @name Convenience functions - does not add extra functionality
Toby_Chen 0:f266ca250f98 743 // ************************************************************************************
Toby_Chen 0:f266ca250f98 744 //@{
Toby_Chen 0:f266ca250f98 745
Toby_Chen 0:f266ca250f98 746 /**
Toby_Chen 0:f266ca250f98 747 * Returns true if a PICC responds to PICC_CMD_REQA.
Toby_Chen 0:f266ca250f98 748 * Only "new" cards in state IDLE are invited. Sleeping cards in state HALT are ignored.
Toby_Chen 0:f266ca250f98 749 *
Toby_Chen 0:f266ca250f98 750 * @return bool
Toby_Chen 0:f266ca250f98 751 */
Toby_Chen 0:f266ca250f98 752 bool PICC_IsNewCardPresent(void);
Toby_Chen 0:f266ca250f98 753
Toby_Chen 0:f266ca250f98 754 /**
Toby_Chen 0:f266ca250f98 755 * Simple wrapper around PICC_Select.
Toby_Chen 0:f266ca250f98 756 * Returns true if a UID could be read.
Toby_Chen 0:f266ca250f98 757 * Remember to call PICC_IsNewCardPresent(), PICC_RequestA() or PICC_WakeupA() first.
Toby_Chen 0:f266ca250f98 758 * The read UID is available in the class variable uid.
Toby_Chen 0:f266ca250f98 759 *
Toby_Chen 0:f266ca250f98 760 * @return bool
Toby_Chen 0:f266ca250f98 761 */
Toby_Chen 0:f266ca250f98 762 bool PICC_ReadCardSerial (void);
Toby_Chen 0:f266ca250f98 763
Toby_Chen 0:f266ca250f98 764 // ************************************************************************************
Toby_Chen 0:f266ca250f98 765 //@}
Toby_Chen 0:f266ca250f98 766
Toby_Chen 0:f266ca250f98 767
Toby_Chen 0:f266ca250f98 768 private:
Toby_Chen 0:f266ca250f98 769 SPI m_SPI;
Toby_Chen 0:f266ca250f98 770 DigitalOut m_CS;
Toby_Chen 0:f266ca250f98 771 DigitalOut m_RESET;
Toby_Chen 0:f266ca250f98 772
Toby_Chen 0:f266ca250f98 773 /**
Toby_Chen 0:f266ca250f98 774 * Helper function for the two-step MIFARE Classic protocol operations Decrement, Increment and Restore.
Toby_Chen 0:f266ca250f98 775 *
Toby_Chen 0:f266ca250f98 776 * @param command The command to use
Toby_Chen 0:f266ca250f98 777 * @param blockAddr The block (0-0xff) number.
Toby_Chen 0:f266ca250f98 778 * @param data The data to transfer in step 2
Toby_Chen 0:f266ca250f98 779 *
Toby_Chen 0:f266ca250f98 780 * @return STATUS_OK on success, STATUS_??? otherwise.
Toby_Chen 0:f266ca250f98 781 */
Toby_Chen 0:f266ca250f98 782 uint8_t MIFARE_TwoStepHelper(uint8_t command, uint8_t blockAddr, uint32_t data);
Toby_Chen 0:f266ca250f98 783 };
Toby_Chen 0:f266ca250f98 784
Toby_Chen 0:f266ca250f98 785 #endif