Younes BOUHLEL / Mbed OS er4_2022

tfsd

Dependencies:   Servo GroveGPS Cayenne-LPP driver_mbed_TH02

MFRC522.h@64:4cd8fed3f437, 2022-03-15 (annotated)

Committer:
younousleconquerant
Date:
Tue Mar 15 08:54:01 2022 +0000
Revision:
64:4cd8fed3f437
totql;

Who changed what in which revision?

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