Muhammad Imran Shahidan / iBMrfid

rfr

MFRC522.h@0:d4f561785b16, 2016-03-18 (annotated)

Committer:
muhammadimran
Date:
Fri Mar 18 09:41:55 2016 +0000
Revision:
0:d4f561785b16
rr

Who changed what in which revision?

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