Suad Suljic / Mbed OS Cell_lockker

first

Dependencies:   MPU6050_SIM5320_TEST

MFRC522.h@0:79959cf2cc3e, 2017-11-09 (annotated)

Committer:
suads
Date:
Thu Nov 09 15:00:04 2017 +0000
Revision:
0:79959cf2cc3e
commit

Who changed what in which revision?

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