Suad Suljic / Mbed OS Cell_lockker

first

Dependencies:   MPU6050_SIM5320_TEST

MFRC522.cpp@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.cpp - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI W AND R BY COOQROBOT.
suads 0:79959cf2cc3e 3 * _Please_ see the comments in MFRC522.h - they give useful hints and background.
suads 0:79959cf2cc3e 4 * Released into the public domain.
suads 0:79959cf2cc3e 5 */
suads 0:79959cf2cc3e 6
suads 0:79959cf2cc3e 7 #include "MFRC522.h"
suads 0:79959cf2cc3e 8
suads 0:79959cf2cc3e 9 static const char* const _TypeNamePICC[] =
suads 0:79959cf2cc3e 10 {
suads 0:79959cf2cc3e 11 "Unknown type",
suads 0:79959cf2cc3e 12 "PICC compliant with ISO/IEC 14443-4",
suads 0:79959cf2cc3e 13 "PICC compliant with ISO/IEC 18092 (NFC)",
suads 0:79959cf2cc3e 14 "MIFARE Mini, 320 bytes",
suads 0:79959cf2cc3e 15 "MIFARE 1KB",
suads 0:79959cf2cc3e 16 "MIFARE 4KB",
suads 0:79959cf2cc3e 17 "MIFARE Ultralight or Ultralight C",
suads 0:79959cf2cc3e 18 "MIFARE Plus",
suads 0:79959cf2cc3e 19 "MIFARE TNP3XXX",
suads 0:79959cf2cc3e 20
suads 0:79959cf2cc3e 21 /* not complete UID */
suads 0:79959cf2cc3e 22 "SAK indicates UID is not complete"
suads 0:79959cf2cc3e 23 };
suads 0:79959cf2cc3e 24
suads 0:79959cf2cc3e 25 static const char* const _ErrorMessage[] =
suads 0:79959cf2cc3e 26 {
suads 0:79959cf2cc3e 27 "Unknown error",
suads 0:79959cf2cc3e 28 "Success",
suads 0:79959cf2cc3e 29 "Error in communication",
suads 0:79959cf2cc3e 30 "Collision detected",
suads 0:79959cf2cc3e 31 "Timeout in communication",
suads 0:79959cf2cc3e 32 "A buffer is not big enough",
suads 0:79959cf2cc3e 33 "Internal error in the code, should not happen",
suads 0:79959cf2cc3e 34 "Invalid argument",
suads 0:79959cf2cc3e 35 "The CRC_A does not match",
suads 0:79959cf2cc3e 36 "A MIFARE PICC responded with NAK"
suads 0:79959cf2cc3e 37 };
suads 0:79959cf2cc3e 38
suads 0:79959cf2cc3e 39 #define MFRC522_MaxPICCs (sizeof(_TypeNamePICC)/sizeof(_TypeNamePICC[0]))
suads 0:79959cf2cc3e 40 #define MFRC522_MaxError (sizeof(_ErrorMessage)/sizeof(_ErrorMessage[0]))
suads 0:79959cf2cc3e 41
suads 0:79959cf2cc3e 42 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 43 // Functions for setting up the driver
suads 0:79959cf2cc3e 44 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 45
suads 0:79959cf2cc3e 46 /**
suads 0:79959cf2cc3e 47 * Constructor.
suads 0:79959cf2cc3e 48 * Prepares the output pins.
suads 0:79959cf2cc3e 49 */
suads 0:79959cf2cc3e 50 MFRC522::MFRC522(PinName mosi,
suads 0:79959cf2cc3e 51 PinName miso,
suads 0:79959cf2cc3e 52 PinName sclk,
suads 0:79959cf2cc3e 53 PinName cs,
suads 0:79959cf2cc3e 54 PinName reset) : m_SPI(mosi, miso, sclk), m_CS(cs), m_RESET(reset)
suads 0:79959cf2cc3e 55 {
suads 0:79959cf2cc3e 56 /* Configure SPI bus */
suads 0:79959cf2cc3e 57 m_SPI.format(8, 0);
suads 0:79959cf2cc3e 58 m_SPI.frequency(8000000);
suads 0:79959cf2cc3e 59
suads 0:79959cf2cc3e 60 /* Release SPI-CS pin */
suads 0:79959cf2cc3e 61 m_CS = 1;
suads 0:79959cf2cc3e 62
suads 0:79959cf2cc3e 63 /* Release RESET pin */
suads 0:79959cf2cc3e 64 m_RESET = 1;
suads 0:79959cf2cc3e 65 } // End constructor
suads 0:79959cf2cc3e 66
suads 0:79959cf2cc3e 67
suads 0:79959cf2cc3e 68 /**
suads 0:79959cf2cc3e 69 * Destructor.
suads 0:79959cf2cc3e 70 */
suads 0:79959cf2cc3e 71 MFRC522::~MFRC522()
suads 0:79959cf2cc3e 72 {
suads 0:79959cf2cc3e 73
suads 0:79959cf2cc3e 74 }
suads 0:79959cf2cc3e 75
suads 0:79959cf2cc3e 76
suads 0:79959cf2cc3e 77 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 78 // Basic interface functions for communicating with the MFRC522
suads 0:79959cf2cc3e 79 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 80
suads 0:79959cf2cc3e 81 /**
suads 0:79959cf2cc3e 82 * Writes a byte to the specified register in the MFRC522 chip.
suads 0:79959cf2cc3e 83 * The interface is described in the datasheet section 8.1.2.
suads 0:79959cf2cc3e 84 */
suads 0:79959cf2cc3e 85 void MFRC522::PCD_WriteRegister(uint8_t reg, uint8_t value)
suads 0:79959cf2cc3e 86 {
suads 0:79959cf2cc3e 87 m_CS = 0; /* Select SPI Chip MFRC522 */
suads 0:79959cf2cc3e 88
suads 0:79959cf2cc3e 89 // MSB == 0 is for writing. LSB is not used in address. Datasheet section 8.1.2.3.
suads 0:79959cf2cc3e 90 (void) m_SPI.write(reg & 0x7E);
suads 0:79959cf2cc3e 91 (void) m_SPI.write(value);
suads 0:79959cf2cc3e 92
suads 0:79959cf2cc3e 93 m_CS = 1; /* Release SPI Chip MFRC522 */
suads 0:79959cf2cc3e 94 } // End PCD_WriteRegister()
suads 0:79959cf2cc3e 95
suads 0:79959cf2cc3e 96 /**
suads 0:79959cf2cc3e 97 * Writes a number of bytes to the specified register in the MFRC522 chip.
suads 0:79959cf2cc3e 98 * The interface is described in the datasheet section 8.1.2.
suads 0:79959cf2cc3e 99 */
suads 0:79959cf2cc3e 100 void MFRC522::PCD_WriteRegister(uint8_t reg, uint8_t count, uint8_t *values)
suads 0:79959cf2cc3e 101 {
suads 0:79959cf2cc3e 102 m_CS = 0; /* Select SPI Chip MFRC522 */
suads 0:79959cf2cc3e 103
suads 0:79959cf2cc3e 104 // MSB == 0 is for writing. LSB is not used in address. Datasheet section 8.1.2.3.
suads 0:79959cf2cc3e 105 (void) m_SPI.write(reg & 0x7E);
suads 0:79959cf2cc3e 106 for (uint8_t index = 0; index < count; index++)
suads 0:79959cf2cc3e 107 {
suads 0:79959cf2cc3e 108 (void) m_SPI.write(values[index]);
suads 0:79959cf2cc3e 109 }
suads 0:79959cf2cc3e 110
suads 0:79959cf2cc3e 111 m_CS = 1; /* Release SPI Chip MFRC522 */
suads 0:79959cf2cc3e 112 } // End PCD_WriteRegister()
suads 0:79959cf2cc3e 113
suads 0:79959cf2cc3e 114 /**
suads 0:79959cf2cc3e 115 * Reads a byte from the specified register in the MFRC522 chip.
suads 0:79959cf2cc3e 116 * The interface is described in the datasheet section 8.1.2.
suads 0:79959cf2cc3e 117 */
suads 0:79959cf2cc3e 118 uint8_t MFRC522::PCD_ReadRegister(uint8_t reg)
suads 0:79959cf2cc3e 119 {
suads 0:79959cf2cc3e 120 uint8_t value;
suads 0:79959cf2cc3e 121 m_CS = 0; /* Select SPI Chip MFRC522 */
suads 0:79959cf2cc3e 122
suads 0:79959cf2cc3e 123 // MSB == 1 is for reading. LSB is not used in address. Datasheet section 8.1.2.3.
suads 0:79959cf2cc3e 124 (void) m_SPI.write(0x80 | reg);
suads 0:79959cf2cc3e 125
suads 0:79959cf2cc3e 126 // Read the value back. Send 0 to stop reading.
suads 0:79959cf2cc3e 127 value = m_SPI.write(0);
suads 0:79959cf2cc3e 128
suads 0:79959cf2cc3e 129 m_CS = 1; /* Release SPI Chip MFRC522 */
suads 0:79959cf2cc3e 130
suads 0:79959cf2cc3e 131 return value;
suads 0:79959cf2cc3e 132 } // End PCD_ReadRegister()
suads 0:79959cf2cc3e 133
suads 0:79959cf2cc3e 134 /**
suads 0:79959cf2cc3e 135 * Reads a number of bytes from the specified register in the MFRC522 chip.
suads 0:79959cf2cc3e 136 * The interface is described in the datasheet section 8.1.2.
suads 0:79959cf2cc3e 137 */
suads 0:79959cf2cc3e 138 void MFRC522::PCD_ReadRegister(uint8_t reg, uint8_t count, uint8_t *values, uint8_t rxAlign)
suads 0:79959cf2cc3e 139 {
suads 0:79959cf2cc3e 140 if (count == 0) { return; }
suads 0:79959cf2cc3e 141
suads 0:79959cf2cc3e 142 uint8_t address = 0x80 | reg; // MSB == 1 is for reading. LSB is not used in address. Datasheet section 8.1.2.3.
suads 0:79959cf2cc3e 143 uint8_t index = 0; // Index in values array.
suads 0:79959cf2cc3e 144
suads 0:79959cf2cc3e 145 m_CS = 0; /* Select SPI Chip MFRC522 */
suads 0:79959cf2cc3e 146 count--; // One read is performed outside of the loop
suads 0:79959cf2cc3e 147 (void) m_SPI.write(address); // Tell MFRC522 which address we want to read
suads 0:79959cf2cc3e 148
suads 0:79959cf2cc3e 149 while (index < count)
suads 0:79959cf2cc3e 150 {
suads 0:79959cf2cc3e 151 if ((index == 0) && rxAlign) // Only update bit positions rxAlign..7 in values[0]
suads 0:79959cf2cc3e 152 {
suads 0:79959cf2cc3e 153 // Create bit mask for bit positions rxAlign..7
suads 0:79959cf2cc3e 154 uint8_t mask = 0;
suads 0:79959cf2cc3e 155 for (uint8_t i = rxAlign; i <= 7; i++)
suads 0:79959cf2cc3e 156 {
suads 0:79959cf2cc3e 157 mask |= (1 << i);
suads 0:79959cf2cc3e 158 }
suads 0:79959cf2cc3e 159
suads 0:79959cf2cc3e 160 // Read value and tell that we want to read the same address again.
suads 0:79959cf2cc3e 161 uint8_t value = m_SPI.write(address);
suads 0:79959cf2cc3e 162
suads 0:79959cf2cc3e 163 // Apply mask to both current value of values[0] and the new data in value.
suads 0:79959cf2cc3e 164 values[0] = (values[index] & ~mask) | (value & mask);
suads 0:79959cf2cc3e 165 }
suads 0:79959cf2cc3e 166 else
suads 0:79959cf2cc3e 167 {
suads 0:79959cf2cc3e 168 // Read value and tell that we want to read the same address again.
suads 0:79959cf2cc3e 169 values[index] = m_SPI.write(address);
suads 0:79959cf2cc3e 170 }
suads 0:79959cf2cc3e 171
suads 0:79959cf2cc3e 172 index++;
suads 0:79959cf2cc3e 173 }
suads 0:79959cf2cc3e 174
suads 0:79959cf2cc3e 175 values[index] = m_SPI.write(0); // Read the final byte. Send 0 to stop reading.
suads 0:79959cf2cc3e 176
suads 0:79959cf2cc3e 177 m_CS = 1; /* Release SPI Chip MFRC522 */
suads 0:79959cf2cc3e 178 } // End PCD_ReadRegister()
suads 0:79959cf2cc3e 179
suads 0:79959cf2cc3e 180 /**
suads 0:79959cf2cc3e 181 * Sets the bits given in mask in register reg.
suads 0:79959cf2cc3e 182 */
suads 0:79959cf2cc3e 183 void MFRC522::PCD_SetRegisterBits(uint8_t reg, uint8_t mask)
suads 0:79959cf2cc3e 184 {
suads 0:79959cf2cc3e 185 uint8_t tmp = PCD_ReadRegister(reg);
suads 0:79959cf2cc3e 186 PCD_WriteRegister(reg, tmp | mask); // set bit mask
suads 0:79959cf2cc3e 187 } // End PCD_SetRegisterBitMask()
suads 0:79959cf2cc3e 188
suads 0:79959cf2cc3e 189 /**
suads 0:79959cf2cc3e 190 * Clears the bits given in mask from register reg.
suads 0:79959cf2cc3e 191 */
suads 0:79959cf2cc3e 192 void MFRC522::PCD_ClrRegisterBits(uint8_t reg, uint8_t mask)
suads 0:79959cf2cc3e 193 {
suads 0:79959cf2cc3e 194 uint8_t tmp = PCD_ReadRegister(reg);
suads 0:79959cf2cc3e 195 PCD_WriteRegister(reg, tmp & (~mask)); // clear bit mask
suads 0:79959cf2cc3e 196 } // End PCD_ClearRegisterBitMask()
suads 0:79959cf2cc3e 197
suads 0:79959cf2cc3e 198
suads 0:79959cf2cc3e 199 /**
suads 0:79959cf2cc3e 200 * Use the CRC coprocessor in the MFRC522 to calculate a CRC_A.
suads 0:79959cf2cc3e 201 */
suads 0:79959cf2cc3e 202 uint8_t MFRC522::PCD_CalculateCRC(uint8_t *data, uint8_t length, uint8_t *result)
suads 0:79959cf2cc3e 203 {
suads 0:79959cf2cc3e 204 PCD_WriteRegister(CommandReg, PCD_Idle); // Stop any active command.
suads 0:79959cf2cc3e 205 PCD_WriteRegister(DivIrqReg, 0x04); // Clear the CRCIRq interrupt request bit
suads 0:79959cf2cc3e 206 PCD_SetRegisterBits(FIFOLevelReg, 0x80); // FlushBuffer = 1, FIFO initialization
suads 0:79959cf2cc3e 207 PCD_WriteRegister(FIFODataReg, length, data); // Write data to the FIFO
suads 0:79959cf2cc3e 208 PCD_WriteRegister(CommandReg, PCD_CalcCRC); // Start the calculation
suads 0:79959cf2cc3e 209
suads 0:79959cf2cc3e 210 // Wait for the CRC calculation to complete. Each iteration of the while-loop takes 17.73us.
suads 0:79959cf2cc3e 211 uint16_t i = 5000;
suads 0:79959cf2cc3e 212 uint8_t n;
suads 0:79959cf2cc3e 213 while (1)
suads 0:79959cf2cc3e 214 {
suads 0:79959cf2cc3e 215 n = PCD_ReadRegister(DivIrqReg); // DivIrqReg[7..0] bits are: Set2 reserved reserved MfinActIRq reserved CRCIRq reserved reserved
suads 0:79959cf2cc3e 216 if (n & 0x04)
suads 0:79959cf2cc3e 217 {
suads 0:79959cf2cc3e 218 // CRCIRq bit set - calculation done
suads 0:79959cf2cc3e 219 break;
suads 0:79959cf2cc3e 220 }
suads 0:79959cf2cc3e 221
suads 0:79959cf2cc3e 222 if (--i == 0)
suads 0:79959cf2cc3e 223 {
suads 0:79959cf2cc3e 224 // The emergency break. We will eventually terminate on this one after 89ms.
suads 0:79959cf2cc3e 225 // Communication with the MFRC522 might be down.
suads 0:79959cf2cc3e 226 return STATUS_TIMEOUT;
suads 0:79959cf2cc3e 227 }
suads 0:79959cf2cc3e 228 }
suads 0:79959cf2cc3e 229
suads 0:79959cf2cc3e 230 // Stop calculating CRC for new content in the FIFO.
suads 0:79959cf2cc3e 231 PCD_WriteRegister(CommandReg, PCD_Idle);
suads 0:79959cf2cc3e 232
suads 0:79959cf2cc3e 233 // Transfer the result from the registers to the result buffer
suads 0:79959cf2cc3e 234 result[0] = PCD_ReadRegister(CRCResultRegL);
suads 0:79959cf2cc3e 235 result[1] = PCD_ReadRegister(CRCResultRegH);
suads 0:79959cf2cc3e 236 return STATUS_OK;
suads 0:79959cf2cc3e 237 } // End PCD_CalculateCRC()
suads 0:79959cf2cc3e 238
suads 0:79959cf2cc3e 239
suads 0:79959cf2cc3e 240 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 241 // Functions for manipulating the MFRC522
suads 0:79959cf2cc3e 242 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 243
suads 0:79959cf2cc3e 244 /**
suads 0:79959cf2cc3e 245 * Initializes the MFRC522 chip.
suads 0:79959cf2cc3e 246 */
suads 0:79959cf2cc3e 247 void MFRC522::PCD_Init()
suads 0:79959cf2cc3e 248 {
suads 0:79959cf2cc3e 249 /* Reset MFRC522 */
suads 0:79959cf2cc3e 250 m_RESET = 0;
suads 0:79959cf2cc3e 251 wait_ms(10);
suads 0:79959cf2cc3e 252 m_RESET = 1;
suads 0:79959cf2cc3e 253
suads 0:79959cf2cc3e 254 // Section 8.8.2 in the datasheet says the oscillator start-up time is the start up time of the crystal + 37,74us. Let us be generous: 50ms.
suads 0:79959cf2cc3e 255 wait_ms(50);
suads 0:79959cf2cc3e 256
suads 0:79959cf2cc3e 257 // When communicating with a PICC we need a timeout if something goes wrong.
suads 0:79959cf2cc3e 258 // f_timer = 13.56 MHz / (2*TPreScaler+1) where TPreScaler = [TPrescaler_Hi:TPrescaler_Lo].
suads 0:79959cf2cc3e 259 // TPrescaler_Hi are the four low bits in TModeReg. TPrescaler_Lo is TPrescalerReg.
suads 0:79959cf2cc3e 260 PCD_WriteRegister(TModeReg, 0x80); // TAuto=1; timer starts automatically at the end of the transmission in all communication modes at all speeds
suads 0:79959cf2cc3e 261 PCD_WriteRegister(TPrescalerReg, 0xA9); // TPreScaler = TModeReg[3..0]:TPrescalerReg, ie 0x0A9 = 169 => f_timer=40kHz, ie a timer period of 25us.
suads 0:79959cf2cc3e 262 PCD_WriteRegister(TReloadRegH, 0x03); // Reload timer with 0x3E8 = 1000, ie 25ms before timeout.
suads 0:79959cf2cc3e 263 PCD_WriteRegister(TReloadRegL, 0xE8);
suads 0:79959cf2cc3e 264
suads 0:79959cf2cc3e 265 PCD_WriteRegister(TxASKReg, 0x40); // Default 0x00. Force a 100 % ASK modulation independent of the ModGsPReg register setting
suads 0:79959cf2cc3e 266 PCD_WriteRegister(ModeReg, 0x3D); // Default 0x3F. Set the preset value for the CRC coprocessor for the CalcCRC command to 0x6363 (ISO 14443-3 part 6.2.4)
suads 0:79959cf2cc3e 267
suads 0:79959cf2cc3e 268 PCD_WriteRegister(RFCfgReg, (0x07<<4)); // Set Rx Gain to max
suads 0:79959cf2cc3e 269
suads 0:79959cf2cc3e 270 PCD_AntennaOn(); // Enable the antenna driver pins TX1 and TX2 (they were disabled by the reset)
suads 0:79959cf2cc3e 271 } // End PCD_Init()
suads 0:79959cf2cc3e 272
suads 0:79959cf2cc3e 273 /**
suads 0:79959cf2cc3e 274 * Performs a soft reset on the MFRC522 chip and waits for it to be ready again.
suads 0:79959cf2cc3e 275 */
suads 0:79959cf2cc3e 276 void MFRC522::PCD_Reset()
suads 0:79959cf2cc3e 277 {
suads 0:79959cf2cc3e 278 PCD_WriteRegister(CommandReg, PCD_SoftReset); // Issue the SoftReset command.
suads 0:79959cf2cc3e 279 // The datasheet does not mention how long the SoftRest command takes to complete.
suads 0:79959cf2cc3e 280 // But the MFRC522 might have been in soft power-down mode (triggered by bit 4 of CommandReg)
suads 0:79959cf2cc3e 281 // Section 8.8.2 in the datasheet says the oscillator start-up time is the start up time of the crystal + 37,74us. Let us be generous: 50ms.
suads 0:79959cf2cc3e 282 wait_ms(50);
suads 0:79959cf2cc3e 283
suads 0:79959cf2cc3e 284 // Wait for the PowerDown bit in CommandReg to be cleared
suads 0:79959cf2cc3e 285 while (PCD_ReadRegister(CommandReg) & (1<<4))
suads 0:79959cf2cc3e 286 {
suads 0:79959cf2cc3e 287 // PCD still restarting - unlikely after waiting 50ms, but better safe than sorry.
suads 0:79959cf2cc3e 288 }
suads 0:79959cf2cc3e 289 } // End PCD_Reset()
suads 0:79959cf2cc3e 290
suads 0:79959cf2cc3e 291 /**
suads 0:79959cf2cc3e 292 * Turns the antenna on by enabling pins TX1 and TX2.
suads 0:79959cf2cc3e 293 * After a reset these pins disabled.
suads 0:79959cf2cc3e 294 */
suads 0:79959cf2cc3e 295 void MFRC522::PCD_AntennaOn()
suads 0:79959cf2cc3e 296 {
suads 0:79959cf2cc3e 297 uint8_t value = PCD_ReadRegister(TxControlReg);
suads 0:79959cf2cc3e 298 if ((value & 0x03) != 0x03)
suads 0:79959cf2cc3e 299 {
suads 0:79959cf2cc3e 300 PCD_WriteRegister(TxControlReg, value | 0x03);
suads 0:79959cf2cc3e 301 }
suads 0:79959cf2cc3e 302 } // End PCD_AntennaOn()
suads 0:79959cf2cc3e 303
suads 0:79959cf2cc3e 304 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 305 // Functions for communicating with PICCs
suads 0:79959cf2cc3e 306 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 307
suads 0:79959cf2cc3e 308 /**
suads 0:79959cf2cc3e 309 * Executes the Transceive command.
suads 0:79959cf2cc3e 310 * CRC validation can only be done if backData and backLen are specified.
suads 0:79959cf2cc3e 311 */
suads 0:79959cf2cc3e 312 uint8_t MFRC522::PCD_TransceiveData(uint8_t *sendData,
suads 0:79959cf2cc3e 313 uint8_t sendLen,
suads 0:79959cf2cc3e 314 uint8_t *backData,
suads 0:79959cf2cc3e 315 uint8_t *backLen,
suads 0:79959cf2cc3e 316 uint8_t *validBits,
suads 0:79959cf2cc3e 317 uint8_t rxAlign,
suads 0:79959cf2cc3e 318 bool checkCRC)
suads 0:79959cf2cc3e 319 {
suads 0:79959cf2cc3e 320 uint8_t waitIRq = 0x30; // RxIRq and IdleIRq
suads 0:79959cf2cc3e 321 return PCD_CommunicateWithPICC(PCD_Transceive, waitIRq, sendData, sendLen, backData, backLen, validBits, rxAlign, checkCRC);
suads 0:79959cf2cc3e 322 } // End PCD_TransceiveData()
suads 0:79959cf2cc3e 323
suads 0:79959cf2cc3e 324 /**
suads 0:79959cf2cc3e 325 * Transfers data to the MFRC522 FIFO, executes a commend, waits for completion and transfers data back from the FIFO.
suads 0:79959cf2cc3e 326 * CRC validation can only be done if backData and backLen are specified.
suads 0:79959cf2cc3e 327 */
suads 0:79959cf2cc3e 328 uint8_t MFRC522::PCD_CommunicateWithPICC(uint8_t command,
suads 0:79959cf2cc3e 329 uint8_t waitIRq,
suads 0:79959cf2cc3e 330 uint8_t *sendData,
suads 0:79959cf2cc3e 331 uint8_t sendLen,
suads 0:79959cf2cc3e 332 uint8_t *backData,
suads 0:79959cf2cc3e 333 uint8_t *backLen,
suads 0:79959cf2cc3e 334 uint8_t *validBits,
suads 0:79959cf2cc3e 335 uint8_t rxAlign,
suads 0:79959cf2cc3e 336 bool checkCRC)
suads 0:79959cf2cc3e 337 {
suads 0:79959cf2cc3e 338 uint8_t n, _validBits = 0;
suads 0:79959cf2cc3e 339 uint32_t i;
suads 0:79959cf2cc3e 340
suads 0:79959cf2cc3e 341 // Prepare values for BitFramingReg
suads 0:79959cf2cc3e 342 uint8_t txLastBits = validBits ? *validBits : 0;
suads 0:79959cf2cc3e 343 uint8_t bitFraming = (rxAlign << 4) + txLastBits; // RxAlign = BitFramingReg[6..4]. TxLastBits = BitFramingReg[2..0]
suads 0:79959cf2cc3e 344
suads 0:79959cf2cc3e 345 PCD_WriteRegister(CommandReg, PCD_Idle); // Stop any active command.
suads 0:79959cf2cc3e 346 PCD_WriteRegister(ComIrqReg, 0x7F); // Clear all seven interrupt request bits
suads 0:79959cf2cc3e 347 PCD_SetRegisterBits(FIFOLevelReg, 0x80); // FlushBuffer = 1, FIFO initialization
suads 0:79959cf2cc3e 348 PCD_WriteRegister(FIFODataReg, sendLen, sendData); // Write sendData to the FIFO
suads 0:79959cf2cc3e 349 PCD_WriteRegister(BitFramingReg, bitFraming); // Bit adjustments
suads 0:79959cf2cc3e 350 PCD_WriteRegister(CommandReg, command); // Execute the command
suads 0:79959cf2cc3e 351 if (command == PCD_Transceive)
suads 0:79959cf2cc3e 352 {
suads 0:79959cf2cc3e 353 PCD_SetRegisterBits(BitFramingReg, 0x80); // StartSend=1, transmission of data starts
suads 0:79959cf2cc3e 354 }
suads 0:79959cf2cc3e 355
suads 0:79959cf2cc3e 356 // Wait for the command to complete.
suads 0:79959cf2cc3e 357 // In PCD_Init() we set the TAuto flag in TModeReg. This means the timer automatically starts when the PCD stops transmitting.
suads 0:79959cf2cc3e 358 // Each iteration of the do-while-loop takes 17.86us.
suads 0:79959cf2cc3e 359 i = 2000;
suads 0:79959cf2cc3e 360 while (1)
suads 0:79959cf2cc3e 361 {
suads 0:79959cf2cc3e 362 n = PCD_ReadRegister(ComIrqReg); // ComIrqReg[7..0] bits are: Set1 TxIRq RxIRq IdleIRq HiAlertIRq LoAlertIRq ErrIRq TimerIRq
suads 0:79959cf2cc3e 363 if (n & waitIRq)
suads 0:79959cf2cc3e 364 { // One of the interrupts that signal success has been set.
suads 0:79959cf2cc3e 365 break;
suads 0:79959cf2cc3e 366 }
suads 0:79959cf2cc3e 367
suads 0:79959cf2cc3e 368 if (n & 0x01)
suads 0:79959cf2cc3e 369 { // Timer interrupt - nothing received in 25ms
suads 0:79959cf2cc3e 370 return STATUS_TIMEOUT;
suads 0:79959cf2cc3e 371 }
suads 0:79959cf2cc3e 372
suads 0:79959cf2cc3e 373 if (--i == 0)
suads 0:79959cf2cc3e 374 { // The emergency break. If all other condions fail we will eventually terminate on this one after 35.7ms. Communication with the MFRC522 might be down.
suads 0:79959cf2cc3e 375 return STATUS_TIMEOUT;
suads 0:79959cf2cc3e 376 }
suads 0:79959cf2cc3e 377 }
suads 0:79959cf2cc3e 378
suads 0:79959cf2cc3e 379 // Stop now if any errors except collisions were detected.
suads 0:79959cf2cc3e 380 uint8_t errorRegValue = PCD_ReadRegister(ErrorReg); // ErrorReg[7..0] bits are: WrErr TempErr reserved BufferOvfl CollErr CRCErr ParityErr ProtocolErr
suads 0:79959cf2cc3e 381 if (errorRegValue & 0x13)
suads 0:79959cf2cc3e 382 { // BufferOvfl ParityErr ProtocolErr
suads 0:79959cf2cc3e 383 return STATUS_ERROR;
suads 0:79959cf2cc3e 384 }
suads 0:79959cf2cc3e 385
suads 0:79959cf2cc3e 386 // If the caller wants data back, get it from the MFRC522.
suads 0:79959cf2cc3e 387 if (backData && backLen)
suads 0:79959cf2cc3e 388 {
suads 0:79959cf2cc3e 389 n = PCD_ReadRegister(FIFOLevelReg); // Number of bytes in the FIFO
suads 0:79959cf2cc3e 390 if (n > *backLen)
suads 0:79959cf2cc3e 391 {
suads 0:79959cf2cc3e 392 return STATUS_NO_ROOM;
suads 0:79959cf2cc3e 393 }
suads 0:79959cf2cc3e 394
suads 0:79959cf2cc3e 395 *backLen = n; // Number of bytes returned
suads 0:79959cf2cc3e 396 PCD_ReadRegister(FIFODataReg, n, backData, rxAlign); // Get received data from FIFO
suads 0:79959cf2cc3e 397 _validBits = PCD_ReadRegister(ControlReg) & 0x07; // RxLastBits[2:0] indicates the number of valid bits in the last received byte. If this value is 000b, the whole byte is valid.
suads 0:79959cf2cc3e 398 if (validBits)
suads 0:79959cf2cc3e 399 {
suads 0:79959cf2cc3e 400 *validBits = _validBits;
suads 0:79959cf2cc3e 401 }
suads 0:79959cf2cc3e 402 }
suads 0:79959cf2cc3e 403
suads 0:79959cf2cc3e 404 // Tell about collisions
suads 0:79959cf2cc3e 405 if (errorRegValue & 0x08)
suads 0:79959cf2cc3e 406 { // CollErr
suads 0:79959cf2cc3e 407 return STATUS_COLLISION;
suads 0:79959cf2cc3e 408 }
suads 0:79959cf2cc3e 409
suads 0:79959cf2cc3e 410 // Perform CRC_A validation if requested.
suads 0:79959cf2cc3e 411 if (backData && backLen && checkCRC)
suads 0:79959cf2cc3e 412 {
suads 0:79959cf2cc3e 413 // In this case a MIFARE Classic NAK is not OK.
suads 0:79959cf2cc3e 414 if ((*backLen == 1) && (_validBits == 4))
suads 0:79959cf2cc3e 415 {
suads 0:79959cf2cc3e 416 return STATUS_MIFARE_NACK;
suads 0:79959cf2cc3e 417 }
suads 0:79959cf2cc3e 418
suads 0:79959cf2cc3e 419 // We need at least the CRC_A value and all 8 bits of the last byte must be received.
suads 0:79959cf2cc3e 420 if ((*backLen < 2) || (_validBits != 0))
suads 0:79959cf2cc3e 421 {
suads 0:79959cf2cc3e 422 return STATUS_CRC_WRONG;
suads 0:79959cf2cc3e 423 }
suads 0:79959cf2cc3e 424
suads 0:79959cf2cc3e 425 // Verify CRC_A - do our own calculation and store the control in controlBuffer.
suads 0:79959cf2cc3e 426 uint8_t controlBuffer[2];
suads 0:79959cf2cc3e 427 n = PCD_CalculateCRC(&backData[0], *backLen - 2, &controlBuffer[0]);
suads 0:79959cf2cc3e 428 if (n != STATUS_OK)
suads 0:79959cf2cc3e 429 {
suads 0:79959cf2cc3e 430 return n;
suads 0:79959cf2cc3e 431 }
suads 0:79959cf2cc3e 432
suads 0:79959cf2cc3e 433 if ((backData[*backLen - 2] != controlBuffer[0]) || (backData[*backLen - 1] != controlBuffer[1]))
suads 0:79959cf2cc3e 434 {
suads 0:79959cf2cc3e 435 return STATUS_CRC_WRONG;
suads 0:79959cf2cc3e 436 }
suads 0:79959cf2cc3e 437 }
suads 0:79959cf2cc3e 438
suads 0:79959cf2cc3e 439 return STATUS_OK;
suads 0:79959cf2cc3e 440 } // End PCD_CommunicateWithPICC()
suads 0:79959cf2cc3e 441
suads 0:79959cf2cc3e 442 /*
suads 0:79959cf2cc3e 443 * 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 444 * 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 445 */
suads 0:79959cf2cc3e 446 uint8_t MFRC522::PICC_RequestA(uint8_t *bufferATQA, uint8_t *bufferSize)
suads 0:79959cf2cc3e 447 {
suads 0:79959cf2cc3e 448 return PICC_REQA_or_WUPA(PICC_CMD_REQA, bufferATQA, bufferSize);
suads 0:79959cf2cc3e 449 } // End PICC_RequestA()
suads 0:79959cf2cc3e 450
suads 0:79959cf2cc3e 451 /**
suads 0:79959cf2cc3e 452 * 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 453 * 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 454 */
suads 0:79959cf2cc3e 455 uint8_t MFRC522::PICC_WakeupA(uint8_t *bufferATQA, uint8_t *bufferSize)
suads 0:79959cf2cc3e 456 {
suads 0:79959cf2cc3e 457 return PICC_REQA_or_WUPA(PICC_CMD_WUPA, bufferATQA, bufferSize);
suads 0:79959cf2cc3e 458 } // End PICC_WakeupA()
suads 0:79959cf2cc3e 459
suads 0:79959cf2cc3e 460 /*
suads 0:79959cf2cc3e 461 * Transmits REQA or WUPA commands.
suads 0:79959cf2cc3e 462 * 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 463 */
suads 0:79959cf2cc3e 464 uint8_t MFRC522::PICC_REQA_or_WUPA(uint8_t command, uint8_t *bufferATQA, uint8_t *bufferSize)
suads 0:79959cf2cc3e 465 {
suads 0:79959cf2cc3e 466 uint8_t validBits;
suads 0:79959cf2cc3e 467 uint8_t status;
suads 0:79959cf2cc3e 468
suads 0:79959cf2cc3e 469 if (bufferATQA == NULL || *bufferSize < 2)
suads 0:79959cf2cc3e 470 { // The ATQA response is 2 bytes long.
suads 0:79959cf2cc3e 471 return STATUS_NO_ROOM;
suads 0:79959cf2cc3e 472 }
suads 0:79959cf2cc3e 473
suads 0:79959cf2cc3e 474 // ValuesAfterColl=1 => Bits received after collision are cleared.
suads 0:79959cf2cc3e 475 PCD_ClrRegisterBits(CollReg, 0x80);
suads 0:79959cf2cc3e 476
suads 0:79959cf2cc3e 477 // For REQA and WUPA we need the short frame format
suads 0:79959cf2cc3e 478 // - transmit only 7 bits of the last (and only) byte. TxLastBits = BitFramingReg[2..0]
suads 0:79959cf2cc3e 479 validBits = 7;
suads 0:79959cf2cc3e 480
suads 0:79959cf2cc3e 481 status = PCD_TransceiveData(&command, 1, bufferATQA, bufferSize, &validBits);
suads 0:79959cf2cc3e 482 if (status != STATUS_OK)
suads 0:79959cf2cc3e 483 {
suads 0:79959cf2cc3e 484 return status;
suads 0:79959cf2cc3e 485 }
suads 0:79959cf2cc3e 486
suads 0:79959cf2cc3e 487 if ((*bufferSize != 2) || (validBits != 0))
suads 0:79959cf2cc3e 488 { // ATQA must be exactly 16 bits.
suads 0:79959cf2cc3e 489 return STATUS_ERROR;
suads 0:79959cf2cc3e 490 }
suads 0:79959cf2cc3e 491
suads 0:79959cf2cc3e 492 return STATUS_OK;
suads 0:79959cf2cc3e 493 } // End PICC_REQA_or_WUPA()
suads 0:79959cf2cc3e 494
suads 0:79959cf2cc3e 495 /*
suads 0:79959cf2cc3e 496 * Transmits SELECT/ANTICOLLISION commands to select a single PICC.
suads 0:79959cf2cc3e 497 */
suads 0:79959cf2cc3e 498 uint8_t MFRC522::PICC_Select(Uid *uid, uint8_t validBits)
suads 0:79959cf2cc3e 499 {
suads 0:79959cf2cc3e 500 bool uidComplete;
suads 0:79959cf2cc3e 501 bool selectDone;
suads 0:79959cf2cc3e 502 bool useCascadeTag;
suads 0:79959cf2cc3e 503 uint8_t cascadeLevel = 1;
suads 0:79959cf2cc3e 504 uint8_t result;
suads 0:79959cf2cc3e 505 uint8_t count;
suads 0:79959cf2cc3e 506 uint8_t index;
suads 0:79959cf2cc3e 507 uint8_t uidIndex; // The first index in uid->uidByte[] that is used in the current Cascade Level.
suads 0:79959cf2cc3e 508 uint8_t currentLevelKnownBits; // The number of known UID bits in the current Cascade Level.
suads 0:79959cf2cc3e 509 uint8_t buffer[9]; // The SELECT/ANTICOLLISION commands uses a 7 byte standard frame + 2 bytes CRC_A
suads 0:79959cf2cc3e 510 uint8_t bufferUsed; // The number of bytes used in the buffer, ie the number of bytes to transfer to the FIFO.
suads 0:79959cf2cc3e 511 uint8_t rxAlign; // Used in BitFramingReg. Defines the bit position for the first bit received.
suads 0:79959cf2cc3e 512 uint8_t txLastBits; // Used in BitFramingReg. The number of valid bits in the last transmitted byte.
suads 0:79959cf2cc3e 513 uint8_t *responseBuffer;
suads 0:79959cf2cc3e 514 uint8_t responseLength;
suads 0:79959cf2cc3e 515
suads 0:79959cf2cc3e 516 // Description of buffer structure:
suads 0:79959cf2cc3e 517 // Byte 0: SEL Indicates the Cascade Level: PICC_CMD_SEL_CL1, PICC_CMD_SEL_CL2 or PICC_CMD_SEL_CL3
suads 0:79959cf2cc3e 518 // Byte 1: NVB Number of Valid Bits (in complete command, not just the UID): High nibble: complete bytes, Low nibble: Extra bits.
suads 0:79959cf2cc3e 519 // Byte 2: UID-data or CT See explanation below. CT means Cascade Tag.
suads 0:79959cf2cc3e 520 // Byte 3: UID-data
suads 0:79959cf2cc3e 521 // Byte 4: UID-data
suads 0:79959cf2cc3e 522 // Byte 5: UID-data
suads 0:79959cf2cc3e 523 // Byte 6: BCC Block Check Character - XOR of bytes 2-5
suads 0:79959cf2cc3e 524 // Byte 7: CRC_A
suads 0:79959cf2cc3e 525 // Byte 8: CRC_A
suads 0:79959cf2cc3e 526 // The BCC and CRC_A is only transmitted if we know all the UID bits of the current Cascade Level.
suads 0:79959cf2cc3e 527 //
suads 0:79959cf2cc3e 528 // Description of bytes 2-5: (Section 6.5.4 of the ISO/IEC 14443-3 draft: UID contents and cascade levels)
suads 0:79959cf2cc3e 529 // UID size Cascade level Byte2 Byte3 Byte4 Byte5
suads 0:79959cf2cc3e 530 // ======== ============= ===== ===== ===== =====
suads 0:79959cf2cc3e 531 // 4 bytes 1 uid0 uid1 uid2 uid3
suads 0:79959cf2cc3e 532 // 7 bytes 1 CT uid0 uid1 uid2
suads 0:79959cf2cc3e 533 // 2 uid3 uid4 uid5 uid6
suads 0:79959cf2cc3e 534 // 10 bytes 1 CT uid0 uid1 uid2
suads 0:79959cf2cc3e 535 // 2 CT uid3 uid4 uid5
suads 0:79959cf2cc3e 536 // 3 uid6 uid7 uid8 uid9
suads 0:79959cf2cc3e 537
suads 0:79959cf2cc3e 538 // Sanity checks
suads 0:79959cf2cc3e 539 if (validBits > 80)
suads 0:79959cf2cc3e 540 {
suads 0:79959cf2cc3e 541 return STATUS_INVALID;
suads 0:79959cf2cc3e 542 }
suads 0:79959cf2cc3e 543
suads 0:79959cf2cc3e 544 // Prepare MFRC522
suads 0:79959cf2cc3e 545 // ValuesAfterColl=1 => Bits received after collision are cleared.
suads 0:79959cf2cc3e 546 PCD_ClrRegisterBits(CollReg, 0x80);
suads 0:79959cf2cc3e 547
suads 0:79959cf2cc3e 548 // Repeat Cascade Level loop until we have a complete UID.
suads 0:79959cf2cc3e 549 uidComplete = false;
suads 0:79959cf2cc3e 550 while ( ! uidComplete)
suads 0:79959cf2cc3e 551 {
suads 0:79959cf2cc3e 552 // Set the Cascade Level in the SEL byte, find out if we need to use the Cascade Tag in byte 2.
suads 0:79959cf2cc3e 553 switch (cascadeLevel)
suads 0:79959cf2cc3e 554 {
suads 0:79959cf2cc3e 555 case 1:
suads 0:79959cf2cc3e 556 buffer[0] = PICC_CMD_SEL_CL1;
suads 0:79959cf2cc3e 557 uidIndex = 0;
suads 0:79959cf2cc3e 558 useCascadeTag = validBits && (uid->size > 4); // When we know that the UID has more than 4 bytes
suads 0:79959cf2cc3e 559 break;
suads 0:79959cf2cc3e 560
suads 0:79959cf2cc3e 561 case 2:
suads 0:79959cf2cc3e 562 buffer[0] = PICC_CMD_SEL_CL2;
suads 0:79959cf2cc3e 563 uidIndex = 3;
suads 0:79959cf2cc3e 564 useCascadeTag = validBits && (uid->size > 7); // When we know that the UID has more than 7 bytes
suads 0:79959cf2cc3e 565 break;
suads 0:79959cf2cc3e 566
suads 0:79959cf2cc3e 567 case 3:
suads 0:79959cf2cc3e 568 buffer[0] = PICC_CMD_SEL_CL3;
suads 0:79959cf2cc3e 569 uidIndex = 6;
suads 0:79959cf2cc3e 570 useCascadeTag = false; // Never used in CL3.
suads 0:79959cf2cc3e 571 break;
suads 0:79959cf2cc3e 572
suads 0:79959cf2cc3e 573 default:
suads 0:79959cf2cc3e 574 return STATUS_INTERNAL_ERROR;
suads 0:79959cf2cc3e 575 //break;
suads 0:79959cf2cc3e 576 }
suads 0:79959cf2cc3e 577
suads 0:79959cf2cc3e 578 // How many UID bits are known in this Cascade Level?
suads 0:79959cf2cc3e 579 if(validBits > (8 * uidIndex))
suads 0:79959cf2cc3e 580 {
suads 0:79959cf2cc3e 581 currentLevelKnownBits = validBits - (8 * uidIndex);
suads 0:79959cf2cc3e 582 }
suads 0:79959cf2cc3e 583 else
suads 0:79959cf2cc3e 584 {
suads 0:79959cf2cc3e 585 currentLevelKnownBits = 0;
suads 0:79959cf2cc3e 586 }
suads 0:79959cf2cc3e 587
suads 0:79959cf2cc3e 588 // Copy the known bits from uid->uidByte[] to buffer[]
suads 0:79959cf2cc3e 589 index = 2; // destination index in buffer[]
suads 0:79959cf2cc3e 590 if (useCascadeTag)
suads 0:79959cf2cc3e 591 {
suads 0:79959cf2cc3e 592 buffer[index++] = PICC_CMD_CT;
suads 0:79959cf2cc3e 593 }
suads 0:79959cf2cc3e 594
suads 0:79959cf2cc3e 595 uint8_t bytesToCopy = currentLevelKnownBits / 8 + (currentLevelKnownBits % 8 ? 1 : 0); // The number of bytes needed to represent the known bits for this level.
suads 0:79959cf2cc3e 596 if (bytesToCopy)
suads 0:79959cf2cc3e 597 {
suads 0:79959cf2cc3e 598 // Max 4 bytes in each Cascade Level. Only 3 left if we use the Cascade Tag
suads 0:79959cf2cc3e 599 uint8_t maxBytes = useCascadeTag ? 3 : 4;
suads 0:79959cf2cc3e 600 if (bytesToCopy > maxBytes)
suads 0:79959cf2cc3e 601 {
suads 0:79959cf2cc3e 602 bytesToCopy = maxBytes;
suads 0:79959cf2cc3e 603 }
suads 0:79959cf2cc3e 604
suads 0:79959cf2cc3e 605 for (count = 0; count < bytesToCopy; count++)
suads 0:79959cf2cc3e 606 {
suads 0:79959cf2cc3e 607 buffer[index++] = uid->uidByte[uidIndex + count];
suads 0:79959cf2cc3e 608 }
suads 0:79959cf2cc3e 609 }
suads 0:79959cf2cc3e 610
suads 0:79959cf2cc3e 611 // Now that the data has been copied we need to include the 8 bits in CT in currentLevelKnownBits
suads 0:79959cf2cc3e 612 if (useCascadeTag)
suads 0:79959cf2cc3e 613 {
suads 0:79959cf2cc3e 614 currentLevelKnownBits += 8;
suads 0:79959cf2cc3e 615 }
suads 0:79959cf2cc3e 616
suads 0:79959cf2cc3e 617 // Repeat anti collision loop until we can transmit all UID bits + BCC and receive a SAK - max 32 iterations.
suads 0:79959cf2cc3e 618 selectDone = false;
suads 0:79959cf2cc3e 619 while ( ! selectDone)
suads 0:79959cf2cc3e 620 {
suads 0:79959cf2cc3e 621 // Find out how many bits and bytes to send and receive.
suads 0:79959cf2cc3e 622 if (currentLevelKnownBits >= 32)
suads 0:79959cf2cc3e 623 { // All UID bits in this Cascade Level are known. This is a SELECT.
suads 0:79959cf2cc3e 624 //Serial.print("SELECT: currentLevelKnownBits="); Serial.println(currentLevelKnownBits, DEC);
suads 0:79959cf2cc3e 625 buffer[1] = 0x70; // NVB - Number of Valid Bits: Seven whole bytes
suads 0:79959cf2cc3e 626
suads 0:79959cf2cc3e 627 // Calulate BCC - Block Check Character
suads 0:79959cf2cc3e 628 buffer[6] = buffer[2] ^ buffer[3] ^ buffer[4] ^ buffer[5];
suads 0:79959cf2cc3e 629
suads 0:79959cf2cc3e 630 // Calculate CRC_A
suads 0:79959cf2cc3e 631 result = PCD_CalculateCRC(buffer, 7, &buffer[7]);
suads 0:79959cf2cc3e 632 if (result != STATUS_OK)
suads 0:79959cf2cc3e 633 {
suads 0:79959cf2cc3e 634 return result;
suads 0:79959cf2cc3e 635 }
suads 0:79959cf2cc3e 636
suads 0:79959cf2cc3e 637 txLastBits = 0; // 0 => All 8 bits are valid.
suads 0:79959cf2cc3e 638 bufferUsed = 9;
suads 0:79959cf2cc3e 639
suads 0:79959cf2cc3e 640 // Store response in the last 3 bytes of buffer (BCC and CRC_A - not needed after tx)
suads 0:79959cf2cc3e 641 responseBuffer = &buffer[6];
suads 0:79959cf2cc3e 642 responseLength = 3;
suads 0:79959cf2cc3e 643 }
suads 0:79959cf2cc3e 644 else
suads 0:79959cf2cc3e 645 { // This is an ANTICOLLISION.
suads 0:79959cf2cc3e 646 //Serial.print("ANTICOLLISION: currentLevelKnownBits="); Serial.println(currentLevelKnownBits, DEC);
suads 0:79959cf2cc3e 647 txLastBits = currentLevelKnownBits % 8;
suads 0:79959cf2cc3e 648 count = currentLevelKnownBits / 8; // Number of whole bytes in the UID part.
suads 0:79959cf2cc3e 649 index = 2 + count; // Number of whole bytes: SEL + NVB + UIDs
suads 0:79959cf2cc3e 650 buffer[1] = (index << 4) + txLastBits; // NVB - Number of Valid Bits
suads 0:79959cf2cc3e 651 bufferUsed = index + (txLastBits ? 1 : 0);
suads 0:79959cf2cc3e 652
suads 0:79959cf2cc3e 653 // Store response in the unused part of buffer
suads 0:79959cf2cc3e 654 responseBuffer = &buffer[index];
suads 0:79959cf2cc3e 655 responseLength = sizeof(buffer) - index;
suads 0:79959cf2cc3e 656 }
suads 0:79959cf2cc3e 657
suads 0:79959cf2cc3e 658 // Set bit adjustments
suads 0:79959cf2cc3e 659 rxAlign = txLastBits; // Having a seperate variable is overkill. But it makes the next line easier to read.
suads 0:79959cf2cc3e 660 PCD_WriteRegister(BitFramingReg, (rxAlign << 4) + txLastBits); // RxAlign = BitFramingReg[6..4]. TxLastBits = BitFramingReg[2..0]
suads 0:79959cf2cc3e 661
suads 0:79959cf2cc3e 662 // Transmit the buffer and receive the response.
suads 0:79959cf2cc3e 663 result = PCD_TransceiveData(buffer, bufferUsed, responseBuffer, &responseLength, &txLastBits, rxAlign);
suads 0:79959cf2cc3e 664 if (result == STATUS_COLLISION)
suads 0:79959cf2cc3e 665 { // More than one PICC in the field => collision.
suads 0:79959cf2cc3e 666 result = PCD_ReadRegister(CollReg); // CollReg[7..0] bits are: ValuesAfterColl reserved CollPosNotValid CollPos[4:0]
suads 0:79959cf2cc3e 667 if (result & 0x20)
suads 0:79959cf2cc3e 668 { // CollPosNotValid
suads 0:79959cf2cc3e 669 return STATUS_COLLISION; // Without a valid collision position we cannot continue
suads 0:79959cf2cc3e 670 }
suads 0:79959cf2cc3e 671
suads 0:79959cf2cc3e 672 uint8_t collisionPos = result & 0x1F; // Values 0-31, 0 means bit 32.
suads 0:79959cf2cc3e 673 if (collisionPos == 0)
suads 0:79959cf2cc3e 674 {
suads 0:79959cf2cc3e 675 collisionPos = 32;
suads 0:79959cf2cc3e 676 }
suads 0:79959cf2cc3e 677
suads 0:79959cf2cc3e 678 if (collisionPos <= currentLevelKnownBits)
suads 0:79959cf2cc3e 679 { // No progress - should not happen
suads 0:79959cf2cc3e 680 return STATUS_INTERNAL_ERROR;
suads 0:79959cf2cc3e 681 }
suads 0:79959cf2cc3e 682
suads 0:79959cf2cc3e 683 // Choose the PICC with the bit set.
suads 0:79959cf2cc3e 684 currentLevelKnownBits = collisionPos;
suads 0:79959cf2cc3e 685 count = (currentLevelKnownBits - 1) % 8; // The bit to modify
suads 0:79959cf2cc3e 686 index = 1 + (currentLevelKnownBits / 8) + (count ? 1 : 0); // First byte is index 0.
suads 0:79959cf2cc3e 687 buffer[index] |= (1 << count);
suads 0:79959cf2cc3e 688 }
suads 0:79959cf2cc3e 689 else if (result != STATUS_OK)
suads 0:79959cf2cc3e 690 {
suads 0:79959cf2cc3e 691 return result;
suads 0:79959cf2cc3e 692 }
suads 0:79959cf2cc3e 693 else
suads 0:79959cf2cc3e 694 { // STATUS_OK
suads 0:79959cf2cc3e 695 if (currentLevelKnownBits >= 32)
suads 0:79959cf2cc3e 696 { // This was a SELECT.
suads 0:79959cf2cc3e 697 selectDone = true; // No more anticollision
suads 0:79959cf2cc3e 698 // We continue below outside the while.
suads 0:79959cf2cc3e 699 }
suads 0:79959cf2cc3e 700 else
suads 0:79959cf2cc3e 701 { // This was an ANTICOLLISION.
suads 0:79959cf2cc3e 702 // We now have all 32 bits of the UID in this Cascade Level
suads 0:79959cf2cc3e 703 currentLevelKnownBits = 32;
suads 0:79959cf2cc3e 704 // Run loop again to do the SELECT.
suads 0:79959cf2cc3e 705 }
suads 0:79959cf2cc3e 706 }
suads 0:79959cf2cc3e 707 } // End of while ( ! selectDone)
suads 0:79959cf2cc3e 708
suads 0:79959cf2cc3e 709 // We do not check the CBB - it was constructed by us above.
suads 0:79959cf2cc3e 710
suads 0:79959cf2cc3e 711 // Copy the found UID bytes from buffer[] to uid->uidByte[]
suads 0:79959cf2cc3e 712 index = (buffer[2] == PICC_CMD_CT) ? 3 : 2; // source index in buffer[]
suads 0:79959cf2cc3e 713 bytesToCopy = (buffer[2] == PICC_CMD_CT) ? 3 : 4;
suads 0:79959cf2cc3e 714 for (count = 0; count < bytesToCopy; count++)
suads 0:79959cf2cc3e 715 {
suads 0:79959cf2cc3e 716 uid->uidByte[uidIndex + count] = buffer[index++];
suads 0:79959cf2cc3e 717 }
suads 0:79959cf2cc3e 718
suads 0:79959cf2cc3e 719 // Check response SAK (Select Acknowledge)
suads 0:79959cf2cc3e 720 if (responseLength != 3 || txLastBits != 0)
suads 0:79959cf2cc3e 721 { // SAK must be exactly 24 bits (1 byte + CRC_A).
suads 0:79959cf2cc3e 722 return STATUS_ERROR;
suads 0:79959cf2cc3e 723 }
suads 0:79959cf2cc3e 724
suads 0:79959cf2cc3e 725 // Verify CRC_A - do our own calculation and store the control in buffer[2..3] - those bytes are not needed anymore.
suads 0:79959cf2cc3e 726 result = PCD_CalculateCRC(responseBuffer, 1, &buffer[2]);
suads 0:79959cf2cc3e 727 if (result != STATUS_OK)
suads 0:79959cf2cc3e 728 {
suads 0:79959cf2cc3e 729 return result;
suads 0:79959cf2cc3e 730 }
suads 0:79959cf2cc3e 731
suads 0:79959cf2cc3e 732 if ((buffer[2] != responseBuffer[1]) || (buffer[3] != responseBuffer[2]))
suads 0:79959cf2cc3e 733 {
suads 0:79959cf2cc3e 734 return STATUS_CRC_WRONG;
suads 0:79959cf2cc3e 735 }
suads 0:79959cf2cc3e 736
suads 0:79959cf2cc3e 737 if (responseBuffer[0] & 0x04)
suads 0:79959cf2cc3e 738 { // Cascade bit set - UID not complete yes
suads 0:79959cf2cc3e 739 cascadeLevel++;
suads 0:79959cf2cc3e 740 }
suads 0:79959cf2cc3e 741 else
suads 0:79959cf2cc3e 742 {
suads 0:79959cf2cc3e 743 uidComplete = true;
suads 0:79959cf2cc3e 744 uid->sak = responseBuffer[0];
suads 0:79959cf2cc3e 745 }
suads 0:79959cf2cc3e 746 } // End of while ( ! uidComplete)
suads 0:79959cf2cc3e 747
suads 0:79959cf2cc3e 748 // Set correct uid->size
suads 0:79959cf2cc3e 749 uid->size = 3 * cascadeLevel + 1;
suads 0:79959cf2cc3e 750
suads 0:79959cf2cc3e 751 return STATUS_OK;
suads 0:79959cf2cc3e 752 } // End PICC_Select()
suads 0:79959cf2cc3e 753
suads 0:79959cf2cc3e 754 /*
suads 0:79959cf2cc3e 755 * Instructs a PICC in state ACTIVE(*) to go to state HALT.
suads 0:79959cf2cc3e 756 */
suads 0:79959cf2cc3e 757 uint8_t MFRC522::PICC_HaltA()
suads 0:79959cf2cc3e 758 {
suads 0:79959cf2cc3e 759 uint8_t result;
suads 0:79959cf2cc3e 760 uint8_t buffer[4];
suads 0:79959cf2cc3e 761
suads 0:79959cf2cc3e 762 // Build command buffer
suads 0:79959cf2cc3e 763 buffer[0] = PICC_CMD_HLTA;
suads 0:79959cf2cc3e 764 buffer[1] = 0;
suads 0:79959cf2cc3e 765
suads 0:79959cf2cc3e 766 // Calculate CRC_A
suads 0:79959cf2cc3e 767 result = PCD_CalculateCRC(buffer, 2, &buffer[2]);
suads 0:79959cf2cc3e 768 if (result == STATUS_OK)
suads 0:79959cf2cc3e 769 {
suads 0:79959cf2cc3e 770 // Send the command.
suads 0:79959cf2cc3e 771 // The standard says:
suads 0:79959cf2cc3e 772 // If the PICC responds with any modulation during a period of 1 ms after the end of the frame containing the
suads 0:79959cf2cc3e 773 // HLTA command, this response shall be interpreted as 'not acknowledge'.
suads 0:79959cf2cc3e 774 // We interpret that this way: Only STATUS_TIMEOUT is an success.
suads 0:79959cf2cc3e 775 result = PCD_TransceiveData(buffer, sizeof(buffer), NULL, 0);
suads 0:79959cf2cc3e 776 if (result == STATUS_TIMEOUT)
suads 0:79959cf2cc3e 777 {
suads 0:79959cf2cc3e 778 result = STATUS_OK;
suads 0:79959cf2cc3e 779 }
suads 0:79959cf2cc3e 780 else if (result == STATUS_OK)
suads 0:79959cf2cc3e 781 { // That is ironically NOT ok in this case ;-)
suads 0:79959cf2cc3e 782 result = STATUS_ERROR;
suads 0:79959cf2cc3e 783 }
suads 0:79959cf2cc3e 784 }
suads 0:79959cf2cc3e 785
suads 0:79959cf2cc3e 786 return result;
suads 0:79959cf2cc3e 787 } // End PICC_HaltA()
suads 0:79959cf2cc3e 788
suads 0:79959cf2cc3e 789
suads 0:79959cf2cc3e 790 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 791 // Functions for communicating with MIFARE PICCs
suads 0:79959cf2cc3e 792 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 793
suads 0:79959cf2cc3e 794 /*
suads 0:79959cf2cc3e 795 * Executes the MFRC522 MFAuthent command.
suads 0:79959cf2cc3e 796 */
suads 0:79959cf2cc3e 797 uint8_t MFRC522::PCD_Authenticate(uint8_t command, uint8_t blockAddr, MIFARE_Key *key, Uid *uid)
suads 0:79959cf2cc3e 798 {
suads 0:79959cf2cc3e 799 uint8_t i, waitIRq = 0x10; // IdleIRq
suads 0:79959cf2cc3e 800
suads 0:79959cf2cc3e 801 // Build command buffer
suads 0:79959cf2cc3e 802 uint8_t sendData[12];
suads 0:79959cf2cc3e 803 sendData[0] = command;
suads 0:79959cf2cc3e 804 sendData[1] = blockAddr;
suads 0:79959cf2cc3e 805
suads 0:79959cf2cc3e 806 for (i = 0; i < MF_KEY_SIZE; i++)
suads 0:79959cf2cc3e 807 { // 6 key bytes
suads 0:79959cf2cc3e 808 sendData[2+i] = key->keyByte[i];
suads 0:79959cf2cc3e 809 }
suads 0:79959cf2cc3e 810
suads 0:79959cf2cc3e 811 for (i = 0; i < 4; i++)
suads 0:79959cf2cc3e 812 { // The first 4 bytes of the UID
suads 0:79959cf2cc3e 813 sendData[8+i] = uid->uidByte[i];
suads 0:79959cf2cc3e 814 }
suads 0:79959cf2cc3e 815
suads 0:79959cf2cc3e 816 // Start the authentication.
suads 0:79959cf2cc3e 817 return PCD_CommunicateWithPICC(PCD_MFAuthent, waitIRq, &sendData[0], sizeof(sendData));
suads 0:79959cf2cc3e 818 } // End PCD_Authenticate()
suads 0:79959cf2cc3e 819
suads 0:79959cf2cc3e 820 /*
suads 0:79959cf2cc3e 821 * Used to exit the PCD from its authenticated state.
suads 0:79959cf2cc3e 822 * Remember to call this function after communicating with an authenticated PICC - otherwise no new communications can start.
suads 0:79959cf2cc3e 823 */
suads 0:79959cf2cc3e 824 void MFRC522::PCD_StopCrypto1()
suads 0:79959cf2cc3e 825 {
suads 0:79959cf2cc3e 826 // Clear MFCrypto1On bit
suads 0:79959cf2cc3e 827 PCD_ClrRegisterBits(Status2Reg, 0x08); // Status2Reg[7..0] bits are: TempSensClear I2CForceHS reserved reserved MFCrypto1On ModemState[2:0]
suads 0:79959cf2cc3e 828 } // End PCD_StopCrypto1()
suads 0:79959cf2cc3e 829
suads 0:79959cf2cc3e 830 /*
suads 0:79959cf2cc3e 831 * Reads 16 bytes (+ 2 bytes CRC_A) from the active PICC.
suads 0:79959cf2cc3e 832 */
suads 0:79959cf2cc3e 833 uint8_t MFRC522::MIFARE_Read(uint8_t blockAddr, uint8_t *buffer, uint8_t *bufferSize)
suads 0:79959cf2cc3e 834 {
suads 0:79959cf2cc3e 835 uint8_t result = STATUS_NO_ROOM;
suads 0:79959cf2cc3e 836
suads 0:79959cf2cc3e 837 // Sanity check
suads 0:79959cf2cc3e 838 if ((buffer == NULL) || (*bufferSize < 18))
suads 0:79959cf2cc3e 839 {
suads 0:79959cf2cc3e 840 return result;
suads 0:79959cf2cc3e 841 }
suads 0:79959cf2cc3e 842
suads 0:79959cf2cc3e 843 // Build command buffer
suads 0:79959cf2cc3e 844 buffer[0] = PICC_CMD_MF_READ;
suads 0:79959cf2cc3e 845 buffer[1] = blockAddr;
suads 0:79959cf2cc3e 846
suads 0:79959cf2cc3e 847 // Calculate CRC_A
suads 0:79959cf2cc3e 848 result = PCD_CalculateCRC(buffer, 2, &buffer[2]);
suads 0:79959cf2cc3e 849 if (result != STATUS_OK)
suads 0:79959cf2cc3e 850 {
suads 0:79959cf2cc3e 851 return result;
suads 0:79959cf2cc3e 852 }
suads 0:79959cf2cc3e 853
suads 0:79959cf2cc3e 854 // Transmit the buffer and receive the response, validate CRC_A.
suads 0:79959cf2cc3e 855 return PCD_TransceiveData(buffer, 4, buffer, bufferSize, NULL, 0, true);
suads 0:79959cf2cc3e 856 } // End MIFARE_Read()
suads 0:79959cf2cc3e 857
suads 0:79959cf2cc3e 858 /*
suads 0:79959cf2cc3e 859 * Writes 16 bytes to the active PICC.
suads 0:79959cf2cc3e 860 */
suads 0:79959cf2cc3e 861 uint8_t MFRC522::MIFARE_Write(uint8_t blockAddr, uint8_t *buffer, uint8_t bufferSize)
suads 0:79959cf2cc3e 862 {
suads 0:79959cf2cc3e 863 uint8_t result;
suads 0:79959cf2cc3e 864
suads 0:79959cf2cc3e 865 // Sanity check
suads 0:79959cf2cc3e 866 if (buffer == NULL || bufferSize < 16)
suads 0:79959cf2cc3e 867 {
suads 0:79959cf2cc3e 868 return STATUS_INVALID;
suads 0:79959cf2cc3e 869 }
suads 0:79959cf2cc3e 870
suads 0:79959cf2cc3e 871 // Mifare Classic protocol requires two communications to perform a write.
suads 0:79959cf2cc3e 872 // Step 1: Tell the PICC we want to write to block blockAddr.
suads 0:79959cf2cc3e 873 uint8_t cmdBuffer[2];
suads 0:79959cf2cc3e 874 cmdBuffer[0] = PICC_CMD_MF_WRITE;
suads 0:79959cf2cc3e 875 cmdBuffer[1] = blockAddr;
suads 0:79959cf2cc3e 876 // Adds CRC_A and checks that the response is MF_ACK.
suads 0:79959cf2cc3e 877 result = PCD_MIFARE_Transceive(cmdBuffer, 2);
suads 0:79959cf2cc3e 878 if (result != STATUS_OK)
suads 0:79959cf2cc3e 879 {
suads 0:79959cf2cc3e 880 return result;
suads 0:79959cf2cc3e 881 }
suads 0:79959cf2cc3e 882
suads 0:79959cf2cc3e 883 // Step 2: Transfer the data
suads 0:79959cf2cc3e 884 // Adds CRC_A and checks that the response is MF_ACK.
suads 0:79959cf2cc3e 885 result = PCD_MIFARE_Transceive(buffer, bufferSize);
suads 0:79959cf2cc3e 886 if (result != STATUS_OK)
suads 0:79959cf2cc3e 887 {
suads 0:79959cf2cc3e 888 return result;
suads 0:79959cf2cc3e 889 }
suads 0:79959cf2cc3e 890
suads 0:79959cf2cc3e 891 return STATUS_OK;
suads 0:79959cf2cc3e 892 } // End MIFARE_Write()
suads 0:79959cf2cc3e 893
suads 0:79959cf2cc3e 894 /*
suads 0:79959cf2cc3e 895 * Writes a 4 byte page to the active MIFARE Ultralight PICC.
suads 0:79959cf2cc3e 896 */
suads 0:79959cf2cc3e 897 uint8_t MFRC522::MIFARE_UltralightWrite(uint8_t page, uint8_t *buffer, uint8_t bufferSize)
suads 0:79959cf2cc3e 898 {
suads 0:79959cf2cc3e 899 uint8_t result;
suads 0:79959cf2cc3e 900
suads 0:79959cf2cc3e 901 // Sanity check
suads 0:79959cf2cc3e 902 if (buffer == NULL || bufferSize < 4)
suads 0:79959cf2cc3e 903 {
suads 0:79959cf2cc3e 904 return STATUS_INVALID;
suads 0:79959cf2cc3e 905 }
suads 0:79959cf2cc3e 906
suads 0:79959cf2cc3e 907 // Build commmand buffer
suads 0:79959cf2cc3e 908 uint8_t cmdBuffer[6];
suads 0:79959cf2cc3e 909 cmdBuffer[0] = PICC_CMD_UL_WRITE;
suads 0:79959cf2cc3e 910 cmdBuffer[1] = page;
suads 0:79959cf2cc3e 911 memcpy(&cmdBuffer[2], buffer, 4);
suads 0:79959cf2cc3e 912
suads 0:79959cf2cc3e 913 // Perform the write
suads 0:79959cf2cc3e 914 result = PCD_MIFARE_Transceive(cmdBuffer, 6); // Adds CRC_A and checks that the response is MF_ACK.
suads 0:79959cf2cc3e 915 if (result != STATUS_OK)
suads 0:79959cf2cc3e 916 {
suads 0:79959cf2cc3e 917 return result;
suads 0:79959cf2cc3e 918 }
suads 0:79959cf2cc3e 919
suads 0:79959cf2cc3e 920 return STATUS_OK;
suads 0:79959cf2cc3e 921 } // End MIFARE_Ultralight_Write()
suads 0:79959cf2cc3e 922
suads 0:79959cf2cc3e 923 /*
suads 0:79959cf2cc3e 924 * MIFARE Decrement subtracts the delta from the value of the addressed block, and stores the result in a volatile memory.
suads 0:79959cf2cc3e 925 */
suads 0:79959cf2cc3e 926 uint8_t MFRC522::MIFARE_Decrement(uint8_t blockAddr, uint32_t delta)
suads 0:79959cf2cc3e 927 {
suads 0:79959cf2cc3e 928 return MIFARE_TwoStepHelper(PICC_CMD_MF_DECREMENT, blockAddr, delta);
suads 0:79959cf2cc3e 929 } // End MIFARE_Decrement()
suads 0:79959cf2cc3e 930
suads 0:79959cf2cc3e 931 /*
suads 0:79959cf2cc3e 932 * MIFARE Increment adds the delta to the value of the addressed block, and stores the result in a volatile memory.
suads 0:79959cf2cc3e 933 */
suads 0:79959cf2cc3e 934 uint8_t MFRC522::MIFARE_Increment(uint8_t blockAddr, uint32_t delta)
suads 0:79959cf2cc3e 935 {
suads 0:79959cf2cc3e 936 return MIFARE_TwoStepHelper(PICC_CMD_MF_INCREMENT, blockAddr, delta);
suads 0:79959cf2cc3e 937 } // End MIFARE_Increment()
suads 0:79959cf2cc3e 938
suads 0:79959cf2cc3e 939 /**
suads 0:79959cf2cc3e 940 * MIFARE Restore copies the value of the addressed block into a volatile memory.
suads 0:79959cf2cc3e 941 */
suads 0:79959cf2cc3e 942 uint8_t MFRC522::MIFARE_Restore(uint8_t blockAddr)
suads 0:79959cf2cc3e 943 {
suads 0:79959cf2cc3e 944 // The datasheet describes Restore as a two step operation, but does not explain what data to transfer in step 2.
suads 0:79959cf2cc3e 945 // Doing only a single step does not work, so I chose to transfer 0L in step two.
suads 0:79959cf2cc3e 946 return MIFARE_TwoStepHelper(PICC_CMD_MF_RESTORE, blockAddr, 0L);
suads 0:79959cf2cc3e 947 } // End MIFARE_Restore()
suads 0:79959cf2cc3e 948
suads 0:79959cf2cc3e 949 /*
suads 0:79959cf2cc3e 950 * Helper function for the two-step MIFARE Classic protocol operations Decrement, Increment and Restore.
suads 0:79959cf2cc3e 951 */
suads 0:79959cf2cc3e 952 uint8_t MFRC522::MIFARE_TwoStepHelper(uint8_t command, uint8_t blockAddr, uint32_t data)
suads 0:79959cf2cc3e 953 {
suads 0:79959cf2cc3e 954 uint8_t result;
suads 0:79959cf2cc3e 955 uint8_t cmdBuffer[2]; // We only need room for 2 bytes.
suads 0:79959cf2cc3e 956
suads 0:79959cf2cc3e 957 // Step 1: Tell the PICC the command and block address
suads 0:79959cf2cc3e 958 cmdBuffer[0] = command;
suads 0:79959cf2cc3e 959 cmdBuffer[1] = blockAddr;
suads 0:79959cf2cc3e 960
suads 0:79959cf2cc3e 961 // Adds CRC_A and checks that the response is MF_ACK.
suads 0:79959cf2cc3e 962 result = PCD_MIFARE_Transceive(cmdBuffer, 2);
suads 0:79959cf2cc3e 963 if (result != STATUS_OK)
suads 0:79959cf2cc3e 964 {
suads 0:79959cf2cc3e 965 return result;
suads 0:79959cf2cc3e 966 }
suads 0:79959cf2cc3e 967
suads 0:79959cf2cc3e 968 // Step 2: Transfer the data
suads 0:79959cf2cc3e 969 // Adds CRC_A and accept timeout as success.
suads 0:79959cf2cc3e 970 result = PCD_MIFARE_Transceive((uint8_t *) &data, 4, true);
suads 0:79959cf2cc3e 971 if (result != STATUS_OK)
suads 0:79959cf2cc3e 972 {
suads 0:79959cf2cc3e 973 return result;
suads 0:79959cf2cc3e 974 }
suads 0:79959cf2cc3e 975
suads 0:79959cf2cc3e 976 return STATUS_OK;
suads 0:79959cf2cc3e 977 } // End MIFARE_TwoStepHelper()
suads 0:79959cf2cc3e 978
suads 0:79959cf2cc3e 979 /*
suads 0:79959cf2cc3e 980 * MIFARE Transfer writes the value stored in the volatile memory into one MIFARE Classic block.
suads 0:79959cf2cc3e 981 */
suads 0:79959cf2cc3e 982 uint8_t MFRC522::MIFARE_Transfer(uint8_t blockAddr)
suads 0:79959cf2cc3e 983 {
suads 0:79959cf2cc3e 984 uint8_t cmdBuffer[2]; // We only need room for 2 bytes.
suads 0:79959cf2cc3e 985
suads 0:79959cf2cc3e 986 // Tell the PICC we want to transfer the result into block blockAddr.
suads 0:79959cf2cc3e 987 cmdBuffer[0] = PICC_CMD_MF_TRANSFER;
suads 0:79959cf2cc3e 988 cmdBuffer[1] = blockAddr;
suads 0:79959cf2cc3e 989
suads 0:79959cf2cc3e 990 // Adds CRC_A and checks that the response is MF_ACK.
suads 0:79959cf2cc3e 991 return PCD_MIFARE_Transceive(cmdBuffer, 2);
suads 0:79959cf2cc3e 992 } // End MIFARE_Transfer()
suads 0:79959cf2cc3e 993
suads 0:79959cf2cc3e 994
suads 0:79959cf2cc3e 995 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 996 // Support functions
suads 0:79959cf2cc3e 997 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 998
suads 0:79959cf2cc3e 999 /*
suads 0:79959cf2cc3e 1000 * Wrapper for MIFARE protocol communication.
suads 0:79959cf2cc3e 1001 * Adds CRC_A, executes the Transceive command and checks that the response is MF_ACK or a timeout.
suads 0:79959cf2cc3e 1002 */
suads 0:79959cf2cc3e 1003 uint8_t MFRC522::PCD_MIFARE_Transceive(uint8_t *sendData, uint8_t sendLen, bool acceptTimeout)
suads 0:79959cf2cc3e 1004 {
suads 0:79959cf2cc3e 1005 uint8_t result;
suads 0:79959cf2cc3e 1006 uint8_t cmdBuffer[18]; // We need room for 16 bytes data and 2 bytes CRC_A.
suads 0:79959cf2cc3e 1007
suads 0:79959cf2cc3e 1008 // Sanity check
suads 0:79959cf2cc3e 1009 if (sendData == NULL || sendLen > 16)
suads 0:79959cf2cc3e 1010 {
suads 0:79959cf2cc3e 1011 return STATUS_INVALID;
suads 0:79959cf2cc3e 1012 }
suads 0:79959cf2cc3e 1013
suads 0:79959cf2cc3e 1014 // Copy sendData[] to cmdBuffer[] and add CRC_A
suads 0:79959cf2cc3e 1015 memcpy(cmdBuffer, sendData, sendLen);
suads 0:79959cf2cc3e 1016 result = PCD_CalculateCRC(cmdBuffer, sendLen, &cmdBuffer[sendLen]);
suads 0:79959cf2cc3e 1017 if (result != STATUS_OK)
suads 0:79959cf2cc3e 1018 {
suads 0:79959cf2cc3e 1019 return result;
suads 0:79959cf2cc3e 1020 }
suads 0:79959cf2cc3e 1021
suads 0:79959cf2cc3e 1022 sendLen += 2;
suads 0:79959cf2cc3e 1023
suads 0:79959cf2cc3e 1024 // Transceive the data, store the reply in cmdBuffer[]
suads 0:79959cf2cc3e 1025 uint8_t waitIRq = 0x30; // RxIRq and IdleIRq
suads 0:79959cf2cc3e 1026 uint8_t cmdBufferSize = sizeof(cmdBuffer);
suads 0:79959cf2cc3e 1027 uint8_t validBits = 0;
suads 0:79959cf2cc3e 1028 result = PCD_CommunicateWithPICC(PCD_Transceive, waitIRq, cmdBuffer, sendLen, cmdBuffer, &cmdBufferSize, &validBits);
suads 0:79959cf2cc3e 1029 if (acceptTimeout && result == STATUS_TIMEOUT)
suads 0:79959cf2cc3e 1030 {
suads 0:79959cf2cc3e 1031 return STATUS_OK;
suads 0:79959cf2cc3e 1032 }
suads 0:79959cf2cc3e 1033
suads 0:79959cf2cc3e 1034 if (result != STATUS_OK)
suads 0:79959cf2cc3e 1035 {
suads 0:79959cf2cc3e 1036 return result;
suads 0:79959cf2cc3e 1037 }
suads 0:79959cf2cc3e 1038
suads 0:79959cf2cc3e 1039 // The PICC must reply with a 4 bit ACK
suads 0:79959cf2cc3e 1040 if (cmdBufferSize != 1 || validBits != 4)
suads 0:79959cf2cc3e 1041 {
suads 0:79959cf2cc3e 1042 return STATUS_ERROR;
suads 0:79959cf2cc3e 1043 }
suads 0:79959cf2cc3e 1044
suads 0:79959cf2cc3e 1045 if (cmdBuffer[0] != MF_ACK)
suads 0:79959cf2cc3e 1046 {
suads 0:79959cf2cc3e 1047 return STATUS_MIFARE_NACK;
suads 0:79959cf2cc3e 1048 }
suads 0:79959cf2cc3e 1049
suads 0:79959cf2cc3e 1050 return STATUS_OK;
suads 0:79959cf2cc3e 1051 } // End PCD_MIFARE_Transceive()
suads 0:79959cf2cc3e 1052
suads 0:79959cf2cc3e 1053
suads 0:79959cf2cc3e 1054 /*
suads 0:79959cf2cc3e 1055 * Translates the SAK (Select Acknowledge) to a PICC type.
suads 0:79959cf2cc3e 1056 */
suads 0:79959cf2cc3e 1057 uint8_t MFRC522::PICC_GetType(uint8_t sak)
suads 0:79959cf2cc3e 1058 {
suads 0:79959cf2cc3e 1059 uint8_t retType = PICC_TYPE_UNKNOWN;
suads 0:79959cf2cc3e 1060
suads 0:79959cf2cc3e 1061 if (sak & 0x04)
suads 0:79959cf2cc3e 1062 { // UID not complete
suads 0:79959cf2cc3e 1063 retType = PICC_TYPE_NOT_COMPLETE;
suads 0:79959cf2cc3e 1064 }
suads 0:79959cf2cc3e 1065 else
suads 0:79959cf2cc3e 1066 {
suads 0:79959cf2cc3e 1067 switch (sak)
suads 0:79959cf2cc3e 1068 {
suads 0:79959cf2cc3e 1069 case 0x09: retType = PICC_TYPE_MIFARE_MINI; break;
suads 0:79959cf2cc3e 1070 case 0x08: retType = PICC_TYPE_MIFARE_1K; break;
suads 0:79959cf2cc3e 1071 case 0x18: retType = PICC_TYPE_MIFARE_4K; break;
suads 0:79959cf2cc3e 1072 case 0x00: retType = PICC_TYPE_MIFARE_UL; break;
suads 0:79959cf2cc3e 1073 case 0x10:
suads 0:79959cf2cc3e 1074 case 0x11: retType = PICC_TYPE_MIFARE_PLUS; break;
suads 0:79959cf2cc3e 1075 case 0x01: retType = PICC_TYPE_TNP3XXX; break;
suads 0:79959cf2cc3e 1076 default:
suads 0:79959cf2cc3e 1077 if (sak & 0x20)
suads 0:79959cf2cc3e 1078 {
suads 0:79959cf2cc3e 1079 retType = PICC_TYPE_ISO_14443_4;
suads 0:79959cf2cc3e 1080 }
suads 0:79959cf2cc3e 1081 else if (sak & 0x40)
suads 0:79959cf2cc3e 1082 {
suads 0:79959cf2cc3e 1083 retType = PICC_TYPE_ISO_18092;
suads 0:79959cf2cc3e 1084 }
suads 0:79959cf2cc3e 1085 break;
suads 0:79959cf2cc3e 1086 }
suads 0:79959cf2cc3e 1087 }
suads 0:79959cf2cc3e 1088
suads 0:79959cf2cc3e 1089 return (retType);
suads 0:79959cf2cc3e 1090 } // End PICC_GetType()
suads 0:79959cf2cc3e 1091
suads 0:79959cf2cc3e 1092 /*
suads 0:79959cf2cc3e 1093 * Returns a string pointer to the PICC type name.
suads 0:79959cf2cc3e 1094 */
suads 0:79959cf2cc3e 1095 char* MFRC522::PICC_GetTypeName(uint8_t piccType)
suads 0:79959cf2cc3e 1096 {
suads 0:79959cf2cc3e 1097 if(piccType == PICC_TYPE_NOT_COMPLETE)
suads 0:79959cf2cc3e 1098 {
suads 0:79959cf2cc3e 1099 piccType = MFRC522_MaxPICCs - 1;
suads 0:79959cf2cc3e 1100 }
suads 0:79959cf2cc3e 1101
suads 0:79959cf2cc3e 1102 return((char *) _TypeNamePICC[piccType]);
suads 0:79959cf2cc3e 1103 } // End PICC_GetTypeName()
suads 0:79959cf2cc3e 1104
suads 0:79959cf2cc3e 1105 /*
suads 0:79959cf2cc3e 1106 * Returns a string pointer to a status code name.
suads 0:79959cf2cc3e 1107 */
suads 0:79959cf2cc3e 1108 char* MFRC522::GetStatusCodeName(uint8_t code)
suads 0:79959cf2cc3e 1109 {
suads 0:79959cf2cc3e 1110 return((char *) _ErrorMessage[code]);
suads 0:79959cf2cc3e 1111 } // End GetStatusCodeName()
suads 0:79959cf2cc3e 1112
suads 0:79959cf2cc3e 1113 /*
suads 0:79959cf2cc3e 1114 * 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 1115 */
suads 0:79959cf2cc3e 1116 void MFRC522::MIFARE_SetAccessBits(uint8_t *accessBitBuffer,
suads 0:79959cf2cc3e 1117 uint8_t g0,
suads 0:79959cf2cc3e 1118 uint8_t g1,
suads 0:79959cf2cc3e 1119 uint8_t g2,
suads 0:79959cf2cc3e 1120 uint8_t g3)
suads 0:79959cf2cc3e 1121 {
suads 0:79959cf2cc3e 1122 uint8_t c1 = ((g3 & 4) << 1) | ((g2 & 4) << 0) | ((g1 & 4) >> 1) | ((g0 & 4) >> 2);
suads 0:79959cf2cc3e 1123 uint8_t c2 = ((g3 & 2) << 2) | ((g2 & 2) << 1) | ((g1 & 2) << 0) | ((g0 & 2) >> 1);
suads 0:79959cf2cc3e 1124 uint8_t c3 = ((g3 & 1) << 3) | ((g2 & 1) << 2) | ((g1 & 1) << 1) | ((g0 & 1) << 0);
suads 0:79959cf2cc3e 1125
suads 0:79959cf2cc3e 1126 accessBitBuffer[0] = (~c2 & 0xF) << 4 | (~c1 & 0xF);
suads 0:79959cf2cc3e 1127 accessBitBuffer[1] = c1 << 4 | (~c3 & 0xF);
suads 0:79959cf2cc3e 1128 accessBitBuffer[2] = c3 << 4 | c2;
suads 0:79959cf2cc3e 1129 } // End MIFARE_SetAccessBits()
suads 0:79959cf2cc3e 1130
suads 0:79959cf2cc3e 1131 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 1132 // Convenience functions - does not add extra functionality
suads 0:79959cf2cc3e 1133 /////////////////////////////////////////////////////////////////////////////////////
suads 0:79959cf2cc3e 1134
suads 0:79959cf2cc3e 1135 /*
suads 0:79959cf2cc3e 1136 * Returns true if a PICC responds to PICC_CMD_REQA.
suads 0:79959cf2cc3e 1137 * Only "new" cards in state IDLE are invited. Sleeping cards in state HALT are ignored.
suads 0:79959cf2cc3e 1138 */
suads 0:79959cf2cc3e 1139 bool MFRC522::PICC_IsNewCardPresent(void)
suads 0:79959cf2cc3e 1140 {
suads 0:79959cf2cc3e 1141 uint8_t bufferATQA[2];
suads 0:79959cf2cc3e 1142 uint8_t bufferSize = sizeof(bufferATQA);
suads 0:79959cf2cc3e 1143 uint8_t result = PICC_RequestA(bufferATQA, &bufferSize);
suads 0:79959cf2cc3e 1144 return ((result == STATUS_OK) || (result == STATUS_COLLISION));
suads 0:79959cf2cc3e 1145 } // End PICC_IsNewCardPresent()
suads 0:79959cf2cc3e 1146
suads 0:79959cf2cc3e 1147 /*
suads 0:79959cf2cc3e 1148 * Simple wrapper around PICC_Select.
suads 0:79959cf2cc3e 1149 */
suads 0:79959cf2cc3e 1150 bool MFRC522::PICC_ReadCardSerial(void)
suads 0:79959cf2cc3e 1151 {
suads 0:79959cf2cc3e 1152 uint8_t result = PICC_Select(&uid);
suads 0:79959cf2cc3e 1153 return (result == STATUS_OK);
suads 0:79959cf2cc3e 1154 } // End PICC_ReadCardSerial()
suads 0:79959cf2cc3e 1155
suads 0:79959cf2cc3e 1156