Osman Kamerić / Mbed OS kopija_NUCLEO_CELL_LOCKER_copy

init

Dependencies:   MPU6050 PinDetect circular_buffer

MFRC522.h@0:b416214256cd, 2017-11-07 (annotated)

Committer:
OsmanKameric
Date:
Tue Nov 07 16:35:14 2017 +0000
Revision:
0:b416214256cd
FIRST

Who changed what in which revision?

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