diff --git a/.gitignore b/.gitignore index 99e9b580..36ae1e1a 100644 --- a/.gitignore +++ b/.gitignore @@ -4,5 +4,6 @@ .vscode/launch.json .vscode/ipch Bruce3_*.bin +bruce.conf _*.sh tmp diff --git a/platformio.ini b/platformio.ini index 6b521043..00b62b3e 100644 --- a/platformio.ini +++ b/platformio.ini @@ -51,6 +51,8 @@ lib_deps = LibSSH-ESP32 PCA9554 https://github.com/bmorcelli/ESPping/ + https://github.com/rennancockles/PN532 + https://github.com/rennancockles/MFRC522-I2C NTPClient Timezone ESP32Time diff --git a/src/core/globals.h b/src/core/globals.h index 6df73541..4960650c 100644 --- a/src/core/globals.h +++ b/src/core/globals.h @@ -134,6 +134,7 @@ extern bool isScreenOff; extern bool dimmer; extern int dimmerSet; extern int devMode; +extern int soundEnabled; void readFGCOLORFromEEPROM(); diff --git a/src/core/menu_items/ConfigMenu.cpp b/src/core/menu_items/ConfigMenu.cpp index 7060d1b7..dc366098 100644 --- a/src/core/menu_items/ConfigMenu.cpp +++ b/src/core/menu_items/ConfigMenu.cpp @@ -9,6 +9,7 @@ void ConfigMenu::optionsMenu() { {"Dim Time", [=]() { setDimmerTimeMenu(); saveConfigs();}}, {"Orientation", [=]() { gsetRotation(true); saveConfigs();}}, {"UI Color", [=]() { setUIColor(); saveConfigs();}}, + {"Sound On/Off", [=]() { setSoundConfig(); saveConfigs();}}, {"Clock", [=]() { setClock(); }}, {"Sleep", [=]() { setSleepMode(); }}, {"Restart", [=]() { ESP.restart(); }}, diff --git a/src/core/sd_functions.cpp b/src/core/sd_functions.cpp index b4a730d2..579d37ad 100644 --- a/src/core/sd_functions.cpp +++ b/src/core/sd_functions.cpp @@ -308,7 +308,7 @@ String readSmallFile(FS &fs, String filepath) { Serial.println("File is too big"); return ""; } - + fileContent = file.readString(); file.close(); @@ -375,18 +375,18 @@ String crc32File(FS &fs, String filepath) { String readDecryptedFile(FS &fs, String filepath) { String cyphertext = readSmallFile(fs, filepath); if(cyphertext.length() == 0) return ""; - + if(cachedPassword.length()==0) { cachedPassword = keyboard("", 32, "password"); if(cachedPassword.length()==0) return ""; // cancelled } - + //Serial.println(cyphertext); //Serial.println(cachedPassword); - + // else try to decrypt String plaintext = decryptString(cyphertext, cachedPassword); - + // check if really plaintext if(!isValidAscii(plaintext)) { // invalidate cached password -> will ask again on the next try @@ -395,7 +395,7 @@ String readDecryptedFile(FS &fs, String filepath) { //Serial.println(plaintext); return ""; } - + // else return plaintext; } @@ -648,30 +648,39 @@ String loopSD(FS &fs, bool filePicker, String allowed_ext) { delay(200); txSubFile(&fs, filepath); }}); - if(filepath.endsWith(".csv")) options.insert(options.begin(), {"Wigle Upload", [&]() { + if(filepath.endsWith(".csv")) { + options.insert(options.begin(), {"Wigle Upload", [&]() { delay(200); Wigle wigle; wigle.upload(&fs, filepath); }}); - if(filepath.endsWith(".bjs") || filepath.endsWith(".js")) options.insert(options.begin(), {"JS Script Run", [&]() { + options.insert(options.begin(), {"Wigle Up All", [&]() { + delay(200); + Wigle wigle; + wigle.upload_all(&fs, Folder); + }}); + } + if(filepath.endsWith(".bjs") || filepath.endsWith(".js")) { + options.insert(options.begin(), {"JS Script Run", [&]() { delay(200); run_bjs_script_headless(fs, filepath); }}); + } #if defined(USB_as_HID) if(filepath.endsWith(".txt")) { - options.push_back({"BadUSB Run", [&]() { - Kb.begin(); USB.begin(); + options.push_back({"BadUSB Run", [&]() { + Kb.begin(); USB.begin(); key_input(fs, filepath); // TODO: reinit serial port }}); - options.push_back({"USB HID Type", [&]() { + options.push_back({"USB HID Type", [&]() { String t = readSmallFile(fs, filepath); displayInfo("Typing"); key_input_from_string(t); }}); } if(filepath.endsWith(".enc")) { // encrypted files - options.insert(options.begin(), {"Decrypt+Type", [&]() { + options.insert(options.begin(), {"Decrypt+Type", [&]() { String plaintext = readDecryptedFile(fs, filepath); if(plaintext.length()==0) // file is too big or cannot read, or cancelled // else @@ -703,16 +712,16 @@ String loopSD(FS &fs, bool filePicker, String allowed_ext) { size_t filesize = getFileSize(fs, filepath); //Serial.println(filesize); if(filesize < SAFE_STACK_BUFFER_SIZE && filesize>0) { - options.push_back({"QR code", [&]() { + options.push_back({"QR code", [&]() { delay(200); qrcode_display(readSmallFile(fs, filepath)); }}); - options.push_back({"CRC32", [&]() { + options.push_back({"CRC32", [&]() { delay(200); displaySuccess(crc32File(fs, filepath)); while(!checkAnyKeyPress()) delay(100); }}); - options.push_back({"MD5", [&]() { + options.push_back({"MD5", [&]() { delay(200); displaySuccess(md5File(fs, filepath)); while(!checkAnyKeyPress()) delay(100); @@ -741,7 +750,7 @@ String loopSD(FS &fs, bool filePicker, String allowed_ext) { #ifdef CARDPUTER if(checkEscPress()) break; // quit - + /* TODO: go back 1 level instead of quitting if(Keyboard.isKeyPressed(KEY_BACKSPACE)) { // go back 1 level @@ -751,7 +760,7 @@ String loopSD(FS &fs, bool filePicker, String allowed_ext) { redraw=true; continue; }*/ - + const short PAGE_JUMP_SIZE = 5; if(checkNextPagePress()) { index += PAGE_JUMP_SIZE; @@ -765,9 +774,9 @@ String loopSD(FS &fs, bool filePicker, String allowed_ext) { redraw = true; continue; } - + // check letter shortcuts - + char pressed_letter = checkLetterShortcutPress(); if(pressed_letter>0) { //Serial.println(pressed_letter); diff --git a/src/core/settings.cpp b/src/core/settings.cpp index 3de338cc..700985c8 100644 --- a/src/core/settings.cpp +++ b/src/core/settings.cpp @@ -275,6 +275,24 @@ void setUIColor(){ EEPROM.end(); } +/********************************************************************* +** Function: setSoundConfig +** Enable or disable sound +**********************************************************************/ +void setSoundConfig() { + int result = 0; + + options = { + {"Sound off", [&]() { result = 0; }, soundEnabled == 0}, + {"Sound on", [&]() { result = 1; }, soundEnabled == 1}, + }; + delay(200); + loopOptions(options, soundEnabled); + delay(200); + + soundEnabled=result; +} + /********************************************************************* ** Function: setRFModuleMenu ** Handles Menu to set the RF module in use @@ -739,9 +757,9 @@ void getConfigs() { if(file) { // init with default settings #if ROTATION >1 - file.print("[{\"rot\":3,\"dimmerSet\":10,\"bright\":100,\"wui_usr\":\"admin\",\"wui_pwd\":\"bruce\",\"Bruce_FGCOLOR\":43023,\"IrTx\":"+String(LED)+",\"IrRx\":"+String(GROVE_SCL)+",\"RfTx\":"+String(GROVE_SDA)+",\"RfRx\":"+String(GROVE_SCL)+",\"tmz\":3,\"RfModule\":0,\"RfFreq\":433.92,\"RfidModule\":"+String(RfidModule)+",\"wifi\":[{\"ssid\":\"myNetSSID\",\"pwd\":\"myNetPassword\"}],\"wigleBasicToken\":\"\",\"devMode\":0}]"); + file.print("[{\"rot\":3,\"dimmerSet\":10,\"bright\":100,\"wui_usr\":\"admin\",\"wui_pwd\":\"bruce\",\"Bruce_FGCOLOR\":43023,\"IrTx\":"+String(LED)+",\"IrRx\":"+String(GROVE_SCL)+",\"RfTx\":"+String(GROVE_SDA)+",\"RfRx\":"+String(GROVE_SCL)+",\"tmz\":3,\"RfModule\":0,\"RfFreq\":433.92,\"RfidModule\":"+String(RfidModule)+",\"wifi\":[{\"ssid\":\"myNetSSID\",\"pwd\":\"myNetPassword\"}],\"wigleBasicToken\":\"\",\"devMode\":0,\"soundEnabled\":1}]"); #else - file.print("[{\"rot\":1,\"dimmerSet\":10,\"bright\":100,\"wui_usr\":\"admin\",\"wui_pwd\":\"bruce\",\"Bruce_FGCOLOR\":43023,\"IrTx\":"+String(LED)+",\"IrRx\":"+String(GROVE_SCL)+",\"RfTx\":"+String(GROVE_SDA)+",\"RfRx\":"+String(GROVE_SCL)+",\"tmz\":3,\"RfModule\":0,\"RfFreq\":433.92,\"RfidModule\":"+String(RfidModule)+",\"wifi\":[{\"ssid\":\"myNetSSID\",\"pwd\":\"myNetPassword\"}],\"wigleBasicToken\":\"\",\"devMode\":0}]"); + file.print("[{\"rot\":1,\"dimmerSet\":10,\"bright\":100,\"wui_usr\":\"admin\",\"wui_pwd\":\"bruce\",\"Bruce_FGCOLOR\":43023,\"IrTx\":"+String(LED)+",\"IrRx\":"+String(GROVE_SCL)+",\"RfTx\":"+String(GROVE_SDA)+",\"RfRx\":"+String(GROVE_SCL)+",\"tmz\":3,\"RfModule\":0,\"RfFreq\":433.92,\"RfidModule\":"+String(RfidModule)+",\"wifi\":[{\"ssid\":\"myNetSSID\",\"pwd\":\"myNetPassword\"}],\"wigleBasicToken\":\"\",\"devMode\":0,\"soundEnabled\":1}]"); #endif } file.close(); @@ -782,6 +800,7 @@ void getConfigs() { if(setting.containsKey("wigleBasicToken")) { wigleBasicToken = setting["wigleBasicToken"].as(); } else { count++; log_i("Fail"); } if(setting.containsKey("devMode")) { devMode = setting["devMode"].as(); } else { count++; log_i("Fail"); } + if(setting.containsKey("soundEnabled")) { soundEnabled = setting["soundEnabled"].as(); } else { count++; log_i("Fail"); } log_i("Brightness: %d", bright); setBrightness(bright); @@ -856,6 +875,7 @@ void saveConfigs() { } setting["wigleBasicToken"] = wigleBasicToken; setting["devMode"] = devMode; + setting["soundEnabled"] = soundEnabled; // Open file for writing File file = fs->open(CONFIG_FILE, FILE_WRITE); if (!file) { diff --git a/src/core/settings.h b/src/core/settings.h index 0c902650..41fd98ce 100644 --- a/src/core/settings.h +++ b/src/core/settings.h @@ -43,3 +43,5 @@ void getConfigs(); void saveConfigs(); void runClockLoop(); + +void setSoundConfig(); diff --git a/src/main.cpp b/src/main.cpp index 16998699..06ff79de 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -32,6 +32,7 @@ int dimmerSet; int bright=100; int tmz=3; int devMode=0; +int soundEnabled=1; bool interpreter_start = false; bool sdcardMounted = false; bool gpsConnected = false; @@ -126,7 +127,7 @@ void setup_gpio() { #if defined(BACKLIGHT) pinMode(BACKLIGHT, OUTPUT); #endif - //if(RfModule==1) + //if(RfModule==1) initCC1101once(&sdcardSPI); // Sets GPIO in the CC1101 lib } @@ -335,6 +336,8 @@ void setup() { boot_screen(); setupSdCard(); + getConfigs(); + startup_sound(); #if ! defined(HAS_SCREEN) diff --git a/src/modules/others/audio.cpp b/src/modules/others/audio.cpp index 716b061d..42a96f1a 100644 --- a/src/modules/others/audio.cpp +++ b/src/modules/others/audio.cpp @@ -11,10 +11,11 @@ #if defined(HAS_NS4168_SPKR) bool playAudioFile(FS* fs, String filepath) { - + if (!soundEnabled) return false; + AudioFileSource* source = new AudioFileSourceFS(*fs, filepath.c_str()); if(!source) return false; - + AudioOutputI2S* audioout = new AudioOutputI2S(); // https://github.com/earlephilhower/ESP8266Audio/blob/master/src/AudioOutputI2S.cpp#L32 audioout->SetPinout(BCLK, WCLK, DOUT); @@ -24,17 +25,17 @@ bool playAudioFile(FS* fs, String filepath) { filepath.toLowerCase(); // case-insensitive match if (filepath.endsWith(".txt") || filepath.endsWith(".rtttl")) generator = new AudioGeneratorRTTTL(); - if (filepath.endsWith(".wav")) + if (filepath.endsWith(".wav")) generator = new AudioGeneratorWAV(); - if (filepath.endsWith(".mod")) + if (filepath.endsWith(".mod")) generator = new AudioGeneratorMOD(); - if (filepath.endsWith(".opus")) + if (filepath.endsWith(".opus")) generator = new AudioGeneratorOpus(); if (filepath.endsWith(".mp3")) { generator = new AudioGeneratorMP3(); source = new AudioFileSourceID3(source); } - /* 2FIX: compilation issues + /* 2FIX: compilation issues if(filepath.endsWith(".mid")) { // need to load a soundfont AudioFileSource* sf2 = NULL; @@ -45,7 +46,7 @@ bool playAudioFile(FS* fs, String filepath) { midi->SetSoundfont(sf2); generator = midi; } */ - + if (generator && source && audioout) { Serial.println("Start audio"); generator->begin(source, audioout); @@ -59,26 +60,28 @@ bool playAudioFile(FS* fs, String filepath) { delete generator; delete source; delete audioout; - + return true; } - // else + // else return false; // init error } bool playAudioRTTTLString(String song) { + if (!soundEnabled) return false; + // derived from https://github.com/earlephilhower/ESP8266Audio/blob/master/examples/PlayRTTTLToI2SDAC/PlayRTTTLToI2SDAC.ino - + song.trim(); if(song=="") return false; - + AudioOutputI2S* audioout = new AudioOutputI2S(); audioout->SetPinout(BCLK, WCLK, DOUT); - + AudioGenerator* generator = new AudioGeneratorRTTTL(); - + AudioFileSource* source = new AudioFileSourcePROGMEM( song.c_str(), song.length() ); - + if (generator && source && audioout) { Serial.println("Start audio"); generator->begin(source, audioout); @@ -92,7 +95,7 @@ bool playAudioRTTTLString(String song) { delete generator; delete source; delete audioout; - + return true; } // else @@ -100,12 +103,14 @@ bool playAudioRTTTLString(String song) { } bool tts(String text){ + if (!soundEnabled) return false; + text.trim(); if(text=="") return false; - + AudioOutputI2S* audioout = new AudioOutputI2S(); audioout->SetPinout(BCLK, WCLK, DOUT); - + // https://github.com/earlephilhower/ESP8266SAM/blob/master/examples/Speak/Speak.ino audioout->begin(); ESP8266SAM *sam = new ESP8266SAM; @@ -116,25 +121,27 @@ bool tts(String text){ bool isAudioFile(String filepath) { - - return filepath.endsWith(".opus") || filepath.endsWith(".rtttl") || + + return filepath.endsWith(".opus") || filepath.endsWith(".rtttl") || filepath.endsWith(".wav") || filepath.endsWith(".mod") || filepath.endsWith(".mp3") ; } void playTone(unsigned int frequency, unsigned long duration, short waveType) { + if (!soundEnabled) return; + // derived from https://github.com/earlephilhower/ESP8266Audio/blob/master/examples/PlayWAVFromFunction/PlayWAVFromFunction.ino - + if(frequency==0 || duration==0) return; - + float hz = frequency; AudioGeneratorWAV* wav; AudioFileSourceFunction* file; AudioOutputI2S* out = new AudioOutputI2S(); out->SetPinout(BCLK, WCLK, DOUT); - + file = new AudioFileSourceFunction( duration/1000.0); // , 1, 44100 // // you can set (sec, channels, hz, bit/sample) but you should care about @@ -146,14 +153,14 @@ void playTone(unsigned int frequency, unsigned long duration, short waveType) // bit/sample : default = 16 (8, 16, 32) // ===== set your sound function ===== - + if(waveType==0) { // square file->addAudioGenerators([&](const float time) { float v = ( sin(hz * time) >= 0 ) ? 1.0f : -1.0f;; // generate square wave v *= 0.1; // scale return v; }); - } + } else if(waveType==1) { // sine file->addAudioGenerators([&](const float time) { float v = sin(TWO_PI * hz * time); // generate sine wave @@ -170,11 +177,11 @@ void playTone(unsigned int frequency, unsigned long duration, short waveType) wav = new AudioGeneratorWAV(); wav->begin(file, out); - + while (wav->isRunning()) { if (!wav->loop() || checkAnyKeyPress()) wav->stop(); } - + delete file; delete wav; delete out; @@ -184,6 +191,8 @@ void playTone(unsigned int frequency, unsigned long duration, short waveType) void _tone(unsigned int frequency, unsigned long duration) { + if (!soundEnabled) return; + #if defined(BUZZ_PIN) tone(BUZZ_PIN, frequency, duration); #elif defined(HAS_NS4168_SPKR) diff --git a/src/modules/rfid/PN532.cpp b/src/modules/rfid/PN532.cpp index 2742f0c2..a90dddcf 100644 --- a/src/modules/rfid/PN532.cpp +++ b/src/modules/rfid/PN532.cpp @@ -13,8 +13,8 @@ PN532::PN532(bool use_i2c) { _use_i2c = use_i2c; - if (use_i2c) nfc.set_interface(); - else nfc.set_interface(SPI_SCK_PIN, SPI_MOSI_PIN, SPI_MISO_PIN, SPI_SS_PIN); + if (use_i2c) nfc.setInterface(GROVE_SDA, GROVE_SCL); + else nfc.setInterface(SPI_SCK_PIN, SPI_MOSI_PIN, SPI_MISO_PIN, SPI_SS_PIN); } bool PN532::begin() { @@ -28,8 +28,8 @@ bool PN532::begin() { } int PN532::read() { - if (!PICC_IsNewCardPresent()) return TAG_NOT_PRESENT; - if (!readDetectedPassiveTargetID()) return FAILURE; + if (!nfc.startPassiveTargetIDDetection()) return TAG_NOT_PRESENT; + if (!nfc.readDetectedPassiveTargetID()) return FAILURE; pageReadSuccess = read_data_blocks(); format_data(); @@ -38,10 +38,10 @@ int PN532::read() { } int PN532::clone() { - if (!PICC_IsNewCardPresent()) return TAG_NOT_PRESENT; - if (!readDetectedPassiveTargetID()) return FAILURE; + if (!nfc.startPassiveTargetIDDetection()) return TAG_NOT_PRESENT; + if (!nfc.readDetectedPassiveTargetID()) return FAILURE; - if (_tag_read_uid.sak != uid.sak) return TAG_NOT_MATCH; + if (nfc.targetUid.sak != uid.sak) return TAG_NOT_MATCH; uint8_t data[16]; byte bcc = 0; @@ -62,24 +62,24 @@ int PN532::clone() { } int PN532::erase() { - if (!PICC_IsNewCardPresent()) return TAG_NOT_PRESENT; - if (!readDetectedPassiveTargetID()) return FAILURE; + if (!nfc.startPassiveTargetIDDetection()) return TAG_NOT_PRESENT; + if (!nfc.readDetectedPassiveTargetID()) return FAILURE; return erase_data_blocks(); } int PN532::write() { - if (!PICC_IsNewCardPresent()) return TAG_NOT_PRESENT; - if (!readDetectedPassiveTargetID()) return FAILURE; + if (!nfc.startPassiveTargetIDDetection()) return TAG_NOT_PRESENT; + if (!nfc.readDetectedPassiveTargetID()) return FAILURE; - if (_tag_read_uid.sak != uid.sak) return TAG_NOT_MATCH; + if (nfc.targetUid.sak != uid.sak) return TAG_NOT_MATCH; return write_data_blocks(); } int PN532::write_ndef() { - if (!PICC_IsNewCardPresent()) return TAG_NOT_PRESENT; - if (!readDetectedPassiveTargetID()) return FAILURE; + if (!nfc.startPassiveTargetIDDetection()) return TAG_NOT_PRESENT; + if (!nfc.readDetectedPassiveTargetID()) return FAILURE; return write_ndef_blocks(); } @@ -157,9 +157,9 @@ int PN532::save(String filename) { } String PN532::get_tag_type() { - String tag_type = PICC_GetTypeName(_tag_read_uid.sak); + String tag_type = nfc.PICC_GetTypeName(nfc.targetUid.sak); - if (_tag_read_uid.sak == PICC_TYPE_MIFARE_UL) { + if (nfc.targetUid.sak == PICC_TYPE_MIFARE_UL) { switch (totalPages) { case 45: tag_type = "NTAG213"; @@ -179,13 +179,13 @@ String PN532::get_tag_type() { } void PN532::set_uid() { - uid.sak = _tag_read_uid.sak; - uid.size = _tag_read_uid.size; + uid.sak = nfc.targetUid.sak; + uid.size = nfc.targetUid.size; - for (byte i = 0; i<2; i++) uid.atqaByte[i] = _tag_read_uid.atqaByte[i]; + for (byte i = 0; i<2; i++) uid.atqaByte[i] = nfc.targetUid.atqaByte[i]; - for (byte i = 0; i<_tag_read_uid.size; i++) { - uid.uidByte[i] = _tag_read_uid.uidByte[i]; + for (byte i = 0; i class PN532 : public RFIDInterface { @@ -44,8 +44,6 @@ class PN532 : public RFIDInterface { private: bool _use_i2c; - byte pn532_packetbuffer[64]; - Uid _tag_read_uid; ///////////////////////////////////////////////////////////////////////////////////// // Converters @@ -57,10 +55,6 @@ class PN532 : public RFIDInterface { ///////////////////////////////////////////////////////////////////////////////////// // PICC Helpers ///////////////////////////////////////////////////////////////////////////////////// - bool PICC_IsNewCardPresent(); - String PICC_GetTypeName(byte sak); - bool readDetectedPassiveTargetID(); - String get_tag_type(); bool read_data_blocks(); bool read_mifare_classic_data_blocks(uint8_t *key); diff --git a/src/modules/rfid/RFID2.cpp b/src/modules/rfid/RFID2.cpp index 48295362..5b8b7488 100644 --- a/src/modules/rfid/RFID2.cpp +++ b/src/modules/rfid/RFID2.cpp @@ -7,7 +7,6 @@ */ #include "RFID2.h" -#include #include "core/sd_functions.h" #include "core/i2c_finder.h" diff --git a/src/modules/rfid/RFID2.h b/src/modules/rfid/RFID2.h index 9f902e4b..95be4ec6 100644 --- a/src/modules/rfid/RFID2.h +++ b/src/modules/rfid/RFID2.h @@ -7,7 +7,7 @@ */ #include "RFIDInterface.h" -#include "lib_mfrc522/mfrc522_i2c.h" +#include class RFID2 : public RFIDInterface { diff --git a/src/modules/rfid/lib_mfrc522/mfrc522_i2c.cpp b/src/modules/rfid/lib_mfrc522/mfrc522_i2c.cpp deleted file mode 100644 index 79d07d4c..00000000 --- a/src/modules/rfid/lib_mfrc522/mfrc522_i2c.cpp +++ /dev/null @@ -1,1793 +0,0 @@ -/* -* MFRC522.cpp - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS I2C BY AROZCAN -* MFRC522.cpp - Based on ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI Library BY COOQROBOT. -* NOTE: Please also check the comments in MFRC522.h - they provide useful hints and background information. -* Released into the public domain. -* Author: arozcan @ https://github.com/arozcan/MFRC522-I2C-Library -*/ - -#include -#include "mfrc522_i2c.h" -#include - -///////////////////////////////////////////////////////////////////////////////////// -// Functions for setting up the Arduino -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Constructor. - * Prepares the output pins. - */ -MFRC522::MFRC522( byte chipAddress - //byte resetPowerDownPin ///< Arduino pin connected to MFRC522's reset and power down input (Pin 6, NRSTPD, active low) - ) { - _chipAddress = chipAddress; - // _resetPowerDownPin = resetPowerDownPin; -} // End constructor - -MFRC522::MFRC522() {} - -void MFRC522::SetChipAddress(byte chipAddress){ - _chipAddress = chipAddress; -} - -///////////////////////////////////////////////////////////////////////////////////// -// Basic interface functions for communicating with the MFRC522 -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Writes a byte to the specified register in the MFRC522 chip. - * The interface is described in the datasheet section 8.1.2. - */ -void MFRC522::PCD_WriteRegister( byte reg, ///< The register to write to. One of the PCD_Register enums. - byte value ///< The value to write. - ) { - Wire.beginTransmission(_chipAddress); - Wire.write(reg); - Wire.write(value); - Wire.endTransmission(); -} // End PCD_WriteRegister() - -/** - * Writes a number of bytes to the specified register in the MFRC522 chip. - * The interface is described in the datasheet section 8.1.2. - */ -void MFRC522::PCD_WriteRegister( byte reg, ///< The register to write to. One of the PCD_Register enums. - byte count, ///< The number of bytes to write to the register - byte *values ///< The values to write. Byte array. - ) { - Wire.beginTransmission(_chipAddress); - Wire.write(reg); - for (byte index = 0; index < count; index++) { - Wire.write(values[index]); - } - Wire.endTransmission(); -} // End PCD_WriteRegister() - -/** - * Reads a byte from the specified register in the MFRC522 chip. - * The interface is described in the datasheet section 8.1.2. - */ -byte MFRC522::PCD_ReadRegister( byte reg ///< The register to read from. One of the PCD_Register enums. - ) { - byte value; - //digitalWrite(_chipSelectPin, LOW); // Select slave - Wire.beginTransmission(_chipAddress); - Wire.write(reg); - Wire.endTransmission(); - - Wire.requestFrom((int)_chipAddress, 1); // adicionado (int) par acompatibilidade - value = Wire.read(); - return value; -} // End PCD_ReadRegister() - -/** - * Reads a number of bytes from the specified register in the MFRC522 chip. - * The interface is described in the datasheet section 8.1.2. - */ -void MFRC522::PCD_ReadRegister( byte reg, ///< The register to read from. One of the PCD_Register enums. - byte count, ///< The number of bytes to read - byte *values, ///< Byte array to store the values in. - byte rxAlign ///< Only bit positions rxAlign..7 in values[0] are updated. - ) { - if (count == 0) { - return; - } - byte address = reg; - byte index = 0; // Index in values array. - Wire.beginTransmission(_chipAddress); - Wire.write(address); - Wire.endTransmission(); - Wire.requestFrom(_chipAddress, count); - while (Wire.available()) { - if (index == 0 && rxAlign) { // Only update bit positions rxAlign..7 in values[0] - // Create bit mask for bit positions rxAlign..7 - byte mask = 0; - for (byte i = rxAlign; i <= 7; i++) { - mask |= (1 << i); - } - // Read value and tell that we want to read the same address again. - byte value = Wire.read(); - // Apply mask to both current value of values[0] and the new data in value. - values[0] = (values[index] & ~mask) | (value & mask); - } - else { // Normal case - values[index] = Wire.read(); - } - index++; - } -} // End PCD_ReadRegister() - -/** - * Sets the bits given in mask in register reg. - */ -void MFRC522::PCD_SetRegisterBitMask( byte reg, ///< The register to update. One of the PCD_Register enums. - byte mask ///< The bits to set. - ) { - byte tmp; - tmp = PCD_ReadRegister(reg); - PCD_WriteRegister(reg, tmp | mask); // set bit mask -} // End PCD_SetRegisterBitMask() - -/** - * Clears the bits given in mask from register reg. - */ -void MFRC522::PCD_ClearRegisterBitMask( byte reg, ///< The register to update. One of the PCD_Register enums. - byte mask ///< The bits to clear. - ) { - byte tmp; - tmp = PCD_ReadRegister(reg); - PCD_WriteRegister(reg, tmp & (~mask)); // clear bit mask -} // End PCD_ClearRegisterBitMask() - - -/** - * Use the CRC coprocessor in the MFRC522 to calculate a CRC_A. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PCD_CalculateCRC( byte *data, ///< In: Pointer to the data to transfer to the FIFO for CRC calculation. - byte length, ///< In: The number of bytes to transfer. - byte *result ///< Out: Pointer to result buffer. Result is written to result[0..1], low byte first. - ) { - PCD_WriteRegister(CommandReg, PCD_Idle); // Stop any active command. - PCD_WriteRegister(DivIrqReg, 0x04); // Clear the CRCIRq interrupt request bit - PCD_SetRegisterBitMask(FIFOLevelReg, 0x80); // FlushBuffer = 1, FIFO initialization - PCD_WriteRegister(FIFODataReg, length, data); // Write data to the FIFO - PCD_WriteRegister(CommandReg, PCD_CalcCRC); // Start the calculation - - // Wait for the CRC calculation to complete. Each iteration of the while-loop takes 17.73�s. - word i = 5000; - byte n; - while (1) { - n = PCD_ReadRegister(DivIrqReg); // DivIrqReg[7..0] bits are: Set2 reserved reserved MfinActIRq reserved CRCIRq reserved reserved - if (n & 0x04) { // CRCIRq bit set - calculation done - break; - } - if (--i == 0) { // The emergency break. We will eventually terminate on this one after 89ms. Communication with the MFRC522 might be down. - return STATUS_TIMEOUT; - } - } - PCD_WriteRegister(CommandReg, PCD_Idle); // Stop calculating CRC for new content in the FIFO. - - // Transfer the result from the registers to the result buffer - result[0] = PCD_ReadRegister(CRCResultRegL); - result[1] = PCD_ReadRegister(CRCResultRegH); - return STATUS_OK; -} // End PCD_CalculateCRC() - - -///////////////////////////////////////////////////////////////////////////////////// -// Functions for manipulating the MFRC522 -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Initializes the MFRC522 chip. - */ -void MFRC522::PCD_Init() { - // Set the chipSelectPin as digital output, do not select the slave yet - - // Set the resetPowerDownPin as digital output, do not reset or power down. - // pinMode(_resetPowerDownPin, OUTPUT); - - - // if (digitalRead(_resetPowerDownPin) == LOW) { //The MFRC522 chip is in power down mode. - // digitalWrite(_resetPowerDownPin, HIGH); // Exit power down mode. This triggers a hard reset. - // // Section 8.8.2 in the datasheet says the oscillator start-up time is the start up time of the crystal + 37,74�s. Let us be generous: 50ms. - // delay(50); - // } - // else { // Perform a soft reset - PCD_Reset(); - // } - - // When communicating with a PICC we need a timeout if something goes wrong. - // f_timer = 13.56 MHz / (2*TPreScaler+1) where TPreScaler = [TPrescaler_Hi:TPrescaler_Lo]. - // TPrescaler_Hi are the four low bits in TModeReg. TPrescaler_Lo is TPrescalerReg. - PCD_WriteRegister(TModeReg, 0x80); // TAuto=1; timer starts automatically at the end of the transmission in all communication modes at all speeds - PCD_WriteRegister(TPrescalerReg, 0xA9); // TPreScaler = TModeReg[3..0]:TPrescalerReg, ie 0x0A9 = 169 => f_timer=40kHz, ie a timer period of 25�s. - PCD_WriteRegister(TReloadRegH, 0x03); // Reload timer with 0x3E8 = 1000, ie 25ms before timeout. - PCD_WriteRegister(TReloadRegL, 0xE8); - - PCD_WriteRegister(TxASKReg, 0x40); // Default 0x00. Force a 100 % ASK modulation independent of the ModGsPReg register setting - 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) - PCD_AntennaOn(); // Enable the antenna driver pins TX1 and TX2 (they were disabled by the reset) -} // End PCD_Init() - -/** - * Performs a soft reset on the MFRC522 chip and waits for it to be ready again. - */ -void MFRC522::PCD_Reset() { - PCD_WriteRegister(CommandReg, PCD_SoftReset); // Issue the SoftReset command. - // The datasheet does not mention how long the SoftRest command takes to complete. - // But the MFRC522 might have been in soft power-down mode (triggered by bit 4 of CommandReg) - // Section 8.8.2 in the datasheet says the oscillator start-up time is the start up time of the crystal + 37,74�s. Let us be generous: 50ms. - delay(50); - // Wait for the PowerDown bit in CommandReg to be cleared - while (PCD_ReadRegister(CommandReg) & (1<<4)) { - // PCD still restarting - unlikely after waiting 50ms, but better safe than sorry. - } -} // End PCD_Reset() - -/** - * Turns the antenna on by enabling pins TX1 and TX2. - * After a reset these pins are disabled. - */ -void MFRC522::PCD_AntennaOn() { - byte value = PCD_ReadRegister(TxControlReg); - if ((value & 0x03) != 0x03) { - PCD_WriteRegister(TxControlReg, value | 0x03); - } -} // End PCD_AntennaOn() - -/** - * Turns the antenna off by disabling pins TX1 and TX2. - */ -void MFRC522::PCD_AntennaOff() { - PCD_ClearRegisterBitMask(TxControlReg, 0x03); -} // End PCD_AntennaOff() - -/** - * Get the current MFRC522 Receiver Gain (RxGain[2:0]) value. - * See 9.3.3.6 / table 98 in http://www.nxp.com/documents/data_sheet/MFRC522.pdf - * NOTE: Return value scrubbed with (0x07<<4)=01110000b as RCFfgReg may use reserved bits. - * - * @return Value of the RxGain, scrubbed to the 3 bits used. - */ -byte MFRC522::PCD_GetAntennaGain() { - return PCD_ReadRegister(RFCfgReg) & (0x07<<4); -} // End PCD_GetAntennaGain() - -/** - * Set the MFRC522 Receiver Gain (RxGain) to value specified by given mask. - * See 9.3.3.6 / table 98 in http://www.nxp.com/documents/data_sheet/MFRC522.pdf - * NOTE: Given mask is scrubbed with (0x07<<4)=01110000b as RCFfgReg may use reserved bits. - */ -void MFRC522::PCD_SetAntennaGain(byte mask) { - if (PCD_GetAntennaGain() != mask) { // only bother if there is a change - PCD_ClearRegisterBitMask(RFCfgReg, (0x07<<4)); // clear needed to allow 000 pattern - PCD_SetRegisterBitMask(RFCfgReg, mask & (0x07<<4)); // only set RxGain[2:0] bits - } -} // End PCD_SetAntennaGain() - -/** - * Performs a self-test of the MFRC522 - * See 16.1.1 in http://www.nxp.com/documents/data_sheet/MFRC522.pdf - * - * @return Whether or not the test passed. - */ -bool MFRC522::PCD_PerformSelfTest() { - // This follows directly the steps outlined in 16.1.1 - // 1. Perform a soft reset. - PCD_Reset(); - - // 2. Clear the internal buffer by writing 25 bytes of 00h - byte ZEROES[25] = {0x00}; - PCD_SetRegisterBitMask(FIFOLevelReg, 0x80); // flush the FIFO buffer - PCD_WriteRegister(FIFODataReg, 25, ZEROES); // write 25 bytes of 00h to FIFO - PCD_WriteRegister(CommandReg, PCD_Mem); // transfer to internal buffer - - // 3. Enable self-test - PCD_WriteRegister(AutoTestReg, 0x09); - - // 4. Write 00h to FIFO buffer - PCD_WriteRegister(FIFODataReg, 0x00); - - // 5. Start self-test by issuing the CalcCRC command - PCD_WriteRegister(CommandReg, PCD_CalcCRC); - - // 6. Wait for self-test to complete - word i; - byte n; - for (i = 0; i < 0xFF; i++) { - n = PCD_ReadRegister(DivIrqReg); // DivIrqReg[7..0] bits are: Set2 reserved reserved MfinActIRq reserved CRCIRq reserved reserved - if (n & 0x04) { // CRCIRq bit set - calculation done - break; - } - } - PCD_WriteRegister(CommandReg, PCD_Idle); // Stop calculating CRC for new content in the FIFO. - - // 7. Read out resulting 64 bytes from the FIFO buffer. - byte result[64]; - PCD_ReadRegister(FIFODataReg, 64, result, 0); - - // Auto self-test done - // Reset AutoTestReg register to be 0 again. Required for normal operation. - PCD_WriteRegister(AutoTestReg, 0x00); - - // Determine firmware version (see section 9.3.4.8 in spec) - byte version = PCD_ReadRegister(VersionReg); - - // Pick the appropriate reference values - const byte *reference; - switch (version) { - case 0x88: // Fudan Semiconductor FM17522 clone - reference = FM17522_firmware_reference; - break; - case 0x90: // Version 0.0 - reference = MFRC522_firmware_referenceV0_0; - break; - case 0x91: // Version 1.0 - reference = MFRC522_firmware_referenceV1_0; - break; - case 0x92: // Version 2.0 - reference = MFRC522_firmware_referenceV2_0; - break; - default: // Unknown version - return false; - } - - // Verify that the results match up to our expectations - for (i = 0; i < 64; i++) { - if (result[i] != pgm_read_byte(&(reference[i]))) { - return false; - } - } - - // Test passed; all is good. - return true; -} // End PCD_PerformSelfTest() - -///////////////////////////////////////////////////////////////////////////////////// -// Functions for communicating with PICCs -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Executes the Transceive command. - * CRC validation can only be done if backData and backLen are specified. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PCD_TransceiveData( byte *sendData, ///< Pointer to the data to transfer to the FIFO. - byte sendLen, ///< Number of bytes to transfer to the FIFO. - byte *backData, ///< NULL or pointer to buffer if data should be read back after executing the command. - byte *backLen, ///< In: Max number of bytes to write to *backData. Out: The number of bytes returned. - byte *validBits, ///< In/Out: The number of valid bits in the last byte. 0 for 8 valid bits. Default NULL. - byte rxAlign, ///< In: Defines the bit position in backData[0] for the first bit received. Default 0. - bool checkCRC ///< In: True => The last two bytes of the response is assumed to be a CRC_A that must be validated. - ) { - byte waitIRq = 0x30; // RxIRq and IdleIRq - return PCD_CommunicateWithPICC(PCD_Transceive, waitIRq, sendData, sendLen, backData, backLen, validBits, rxAlign, checkCRC); -} // End PCD_TransceiveData() - -/** - * Transfers data to the MFRC522 FIFO, executes a command, waits for completion and transfers data back from the FIFO. - * CRC validation can only be done if backData and backLen are specified. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PCD_CommunicateWithPICC( byte command, ///< The command to execute. One of the PCD_Command enums. - byte waitIRq, ///< The bits in the ComIrqReg register that signals successful completion of the command. - byte *sendData, ///< Pointer to the data to transfer to the FIFO. - byte sendLen, ///< Number of bytes to transfer to the FIFO. - byte *backData, ///< NULL or pointer to buffer if data should be read back after executing the command. - byte *backLen, ///< In: Max number of bytes to write to *backData. Out: The number of bytes returned. - byte *validBits, ///< In/Out: The number of valid bits in the last byte. 0 for 8 valid bits. - byte rxAlign, ///< In: Defines the bit position in backData[0] for the first bit received. Default 0. - bool checkCRC ///< In: True => The last two bytes of the response is assumed to be a CRC_A that must be validated. - ) { - byte n, _validBits; - unsigned int i; - - // Prepare values for BitFramingReg - byte txLastBits = validBits ? *validBits : 0; - byte bitFraming = (rxAlign << 4) + txLastBits; // RxAlign = BitFramingReg[6..4]. TxLastBits = BitFramingReg[2..0] - - PCD_WriteRegister(CommandReg, PCD_Idle); // Stop any active command. - PCD_WriteRegister(ComIrqReg, 0x7F); // Clear all seven interrupt request bits - PCD_SetRegisterBitMask(FIFOLevelReg, 0x80); // FlushBuffer = 1, FIFO initialization - PCD_WriteRegister(FIFODataReg, sendLen, sendData); // Write sendData to the FIFO - PCD_WriteRegister(BitFramingReg, bitFraming); // Bit adjustments - PCD_WriteRegister(CommandReg, command); // Execute the command - if (command == PCD_Transceive) { - PCD_SetRegisterBitMask(BitFramingReg, 0x80); // StartSend=1, transmission of data starts - } - - // Wait for the command to complete. - // In PCD_Init() we set the TAuto flag in TModeReg. This means the timer automatically starts when the PCD stops transmitting. - // Each iteration of the do-while-loop takes 17.86�s. - i = 2000; - while (1) { - n = PCD_ReadRegister(ComIrqReg); // ComIrqReg[7..0] bits are: Set1 TxIRq RxIRq IdleIRq HiAlertIRq LoAlertIRq ErrIRq TimerIRq - if (n & waitIRq) { // One of the interrupts that signal success has been set. - break; - } - if (n & 0x01) { // Timer interrupt - nothing received in 25ms - return STATUS_TIMEOUT; - } - if (--i == 0) { // 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. - return STATUS_TIMEOUT; - } - } - - // Stop now if any errors except collisions were detected. - byte errorRegValue = PCD_ReadRegister(ErrorReg); // ErrorReg[7..0] bits are: WrErr TempErr reserved BufferOvfl CollErr CRCErr ParityErr ProtocolErr - if (errorRegValue & 0x13) { // BufferOvfl ParityErr ProtocolErr - return STATUS_ERROR; - } - - // If the caller wants data back, get it from the MFRC522. - if (backData && backLen) { - n = PCD_ReadRegister(FIFOLevelReg); // Number of bytes in the FIFO - if (n > *backLen) { - return STATUS_NO_ROOM; - } - *backLen = n; // Number of bytes returned - PCD_ReadRegister(FIFODataReg, n, backData, rxAlign); // Get received data from FIFO - _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. - if (validBits) { - *validBits = _validBits; - } - } - - // Tell about collisions - if (errorRegValue & 0x08) { // CollErr - return STATUS_COLLISION; - } - - // Perform CRC_A validation if requested. - if (backData && backLen && checkCRC) { - // In this case a MIFARE Classic NAK is not OK. - if (*backLen == 1 && _validBits == 4) { - return STATUS_MIFARE_NACK; - } - // We need at least the CRC_A value and all 8 bits of the last byte must be received. - if (*backLen < 2 || _validBits != 0) { - return STATUS_CRC_WRONG; - } - // Verify CRC_A - do our own calculation and store the control in controlBuffer. - byte controlBuffer[2]; - n = PCD_CalculateCRC(&backData[0], *backLen - 2, &controlBuffer[0]); - if (n != STATUS_OK) { - return n; - } - if ((backData[*backLen - 2] != controlBuffer[0]) || (backData[*backLen - 1] != controlBuffer[1])) { - return STATUS_CRC_WRONG; - } - } - - return STATUS_OK; -} // End PCD_CommunicateWithPICC() - -/** - * Transmits a REQuest command, Type A. Invites PICCs in state IDLE to go to READY and prepare for anticollision or selection. 7 bit frame. - * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PICC_RequestA(byte *bufferATQA, ///< The buffer to store the ATQA (Answer to request) in - byte *bufferSize ///< Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK. - ) { - return PICC_REQA_or_WUPA(PICC_CMD_REQA, bufferATQA, bufferSize); -} // End PICC_RequestA() - -/** - * 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. - * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PICC_WakeupA( byte *bufferATQA, ///< The buffer to store the ATQA (Answer to request) in - byte *bufferSize ///< Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK. - ) { - return PICC_REQA_or_WUPA(PICC_CMD_WUPA, bufferATQA, bufferSize); -} // End PICC_WakeupA() - -/** - * Transmits REQA or WUPA commands. - * Beware: When two PICCs are in the field at the same time I often get STATUS_TIMEOUT - probably due do bad antenna design. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PICC_REQA_or_WUPA( byte command, ///< The command to send - PICC_CMD_REQA or PICC_CMD_WUPA - byte *bufferATQA, ///< The buffer to store the ATQA (Answer to request) in - byte *bufferSize ///< Buffer size, at least two bytes. Also number of bytes returned if STATUS_OK. - ) { - byte validBits; - byte status; - - if (bufferATQA == NULL || *bufferSize < 2) { // The ATQA response is 2 bytes long. - return STATUS_NO_ROOM; - } - PCD_ClearRegisterBitMask(CollReg, 0x80); // ValuesAfterColl=1 => Bits received after collision are cleared. - validBits = 7; // For REQA and WUPA we need the short frame format - transmit only 7 bits of the last (and only) byte. TxLastBits = BitFramingReg[2..0] - status = PCD_TransceiveData(&command, 1, bufferATQA, bufferSize, &validBits); - if (status != STATUS_OK) { - return status; - } - if (*bufferSize != 2 || validBits != 0) { // ATQA must be exactly 16 bits. - return STATUS_ERROR; - } - return STATUS_OK; -} // End PICC_REQA_or_WUPA() - -/** - * Transmits SELECT/ANTICOLLISION commands to select a single PICC. - * Before calling this function the PICCs must be placed in the READY(*) state by calling PICC_RequestA() or PICC_WakeupA(). - * On success: - * - 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.) - * - The UID size and value of the chosen PICC is returned in *uid along with the SAK. - * - * A PICC UID consists of 4, 7 or 10 bytes. - * Only 4 bytes can be specified in a SELECT command, so for the longer UIDs two or three iterations are used: - * UID size Number of UID bytes Cascade levels Example of PICC - * ======== =================== ============== =============== - * single 4 1 MIFARE Classic - * double 7 2 MIFARE Ultralight - * triple 10 3 Not currently in use? - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PICC_Select( Uid *uid, ///< Pointer to Uid struct. Normally output, but can also be used to supply a known UID. - byte validBits ///< The number of known UID bits supplied in *uid. Normally 0. If set you must also supply uid->size. - ) { - bool uidComplete; - bool selectDone; - bool useCascadeTag; - byte cascadeLevel = 1; - byte result; - byte count; - byte index; - byte uidIndex; // The first index in uid->uidByte[] that is used in the current Cascade Level. - int8_t currentLevelKnownBits; // The number of known UID bits in the current Cascade Level. - byte buffer[9]; // The SELECT/ANTICOLLISION commands uses a 7 byte standard frame + 2 bytes CRC_A - byte bufferUsed; // The number of bytes used in the buffer, ie the number of bytes to transfer to the FIFO. - byte rxAlign; // Used in BitFramingReg. Defines the bit position for the first bit received. - byte txLastBits; // Used in BitFramingReg. The number of valid bits in the last transmitted byte. - byte *responseBuffer; - byte responseLength; - - // Description of buffer structure: - // Byte 0: SEL Indicates the Cascade Level: PICC_CMD_SEL_CL1, PICC_CMD_SEL_CL2 or PICC_CMD_SEL_CL3 - // Byte 1: NVB Number of Valid Bits (in complete command, not just the UID): High nibble: complete bytes, Low nibble: Extra bits. - // Byte 2: UID-data or CT See explanation below. CT means Cascade Tag. - // Byte 3: UID-data - // Byte 4: UID-data - // Byte 5: UID-data - // Byte 6: BCC Block Check Character - XOR of bytes 2-5 - // Byte 7: CRC_A - // Byte 8: CRC_A - // The BCC and CRC_A is only transmitted if we know all the UID bits of the current Cascade Level. - // - // Description of bytes 2-5: (Section 6.5.4 of the ISO/IEC 14443-3 draft: UID contents and cascade levels) - // UID size Cascade level Byte2 Byte3 Byte4 Byte5 - // ======== ============= ===== ===== ===== ===== - // 4 bytes 1 uid0 uid1 uid2 uid3 - // 7 bytes 1 CT uid0 uid1 uid2 - // 2 uid3 uid4 uid5 uid6 - // 10 bytes 1 CT uid0 uid1 uid2 - // 2 CT uid3 uid4 uid5 - // 3 uid6 uid7 uid8 uid9 - - // Sanity checks - if (validBits > 80) { - return STATUS_INVALID; - } - - // Prepare MFRC522 - PCD_ClearRegisterBitMask(CollReg, 0x80); // ValuesAfterColl=1 => Bits received after collision are cleared. - - // Repeat Cascade Level loop until we have a complete UID. - uidComplete = false; - while (!uidComplete) { - // Set the Cascade Level in the SEL byte, find out if we need to use the Cascade Tag in byte 2. - switch (cascadeLevel) { - case 1: - buffer[0] = PICC_CMD_SEL_CL1; - uidIndex = 0; - useCascadeTag = validBits && uid->size > 4; // When we know that the UID has more than 4 bytes - break; - - case 2: - buffer[0] = PICC_CMD_SEL_CL2; - uidIndex = 3; - useCascadeTag = validBits && uid->size > 7; // When we know that the UID has more than 7 bytes - break; - - case 3: - buffer[0] = PICC_CMD_SEL_CL3; - uidIndex = 6; - useCascadeTag = false; // Never used in CL3. - break; - - default: - return STATUS_INTERNAL_ERROR; - break; - } - - // How many UID bits are known in this Cascade Level? - currentLevelKnownBits = validBits - (8 * uidIndex); - if (currentLevelKnownBits < 0) { - currentLevelKnownBits = 0; - } - // Copy the known bits from uid->uidByte[] to buffer[] - index = 2; // destination index in buffer[] - if (useCascadeTag) { - buffer[index++] = PICC_CMD_CT; - } - byte bytesToCopy = currentLevelKnownBits / 8 + (currentLevelKnownBits % 8 ? 1 : 0); // The number of bytes needed to represent the known bits for this level. - if (bytesToCopy) { - byte maxBytes = useCascadeTag ? 3 : 4; // Max 4 bytes in each Cascade Level. Only 3 left if we use the Cascade Tag - if (bytesToCopy > maxBytes) { - bytesToCopy = maxBytes; - } - for (count = 0; count < bytesToCopy; count++) { - buffer[index++] = uid->uidByte[uidIndex + count]; - } - } - // Now that the data has been copied we need to include the 8 bits in CT in currentLevelKnownBits - if (useCascadeTag) { - currentLevelKnownBits += 8; - } - - // Repeat anti collision loop until we can transmit all UID bits + BCC and receive a SAK - max 32 iterations. - selectDone = false; - while (!selectDone) { - // Find out how many bits and bytes to send and receive. - if (currentLevelKnownBits >= 32) { // All UID bits in this Cascade Level are known. This is a SELECT. - //Serial.print(F("SELECT: currentLevelKnownBits=")); Serial.println(currentLevelKnownBits, DEC); - buffer[1] = 0x70; // NVB - Number of Valid Bits: Seven whole bytes - // Calculate BCC - Block Check Character - buffer[6] = buffer[2] ^ buffer[3] ^ buffer[4] ^ buffer[5]; - // Calculate CRC_A - result = PCD_CalculateCRC(buffer, 7, &buffer[7]); - if (result != STATUS_OK) { - return result; - } - txLastBits = 0; // 0 => All 8 bits are valid. - bufferUsed = 9; - // Store response in the last 3 bytes of buffer (BCC and CRC_A - not needed after tx) - responseBuffer = &buffer[6]; - responseLength = 3; - } - else { // This is an ANTICOLLISION. - //Serial.print(F("ANTICOLLISION: currentLevelKnownBits=")); Serial.println(currentLevelKnownBits, DEC); - txLastBits = currentLevelKnownBits % 8; - count = currentLevelKnownBits / 8; // Number of whole bytes in the UID part. - index = 2 + count; // Number of whole bytes: SEL + NVB + UIDs - buffer[1] = (index << 4) + txLastBits; // NVB - Number of Valid Bits - bufferUsed = index + (txLastBits ? 1 : 0); - // Store response in the unused part of buffer - responseBuffer = &buffer[index]; - responseLength = sizeof(buffer) - index; - } - - // Set bit adjustments - rxAlign = txLastBits; // Having a seperate variable is overkill. But it makes the next line easier to read. - PCD_WriteRegister(BitFramingReg, (rxAlign << 4) + txLastBits); // RxAlign = BitFramingReg[6..4]. TxLastBits = BitFramingReg[2..0] - - // Transmit the buffer and receive the response. - result = PCD_TransceiveData(buffer, bufferUsed, responseBuffer, &responseLength, &txLastBits, rxAlign); - if (result == STATUS_COLLISION) { // More than one PICC in the field => collision. - result = PCD_ReadRegister(CollReg); // CollReg[7..0] bits are: ValuesAfterColl reserved CollPosNotValid CollPos[4:0] - if (result & 0x20) { // CollPosNotValid - return STATUS_COLLISION; // Without a valid collision position we cannot continue - } - byte collisionPos = result & 0x1F; // Values 0-31, 0 means bit 32. - if (collisionPos == 0) { - collisionPos = 32; - } - if (collisionPos <= currentLevelKnownBits) { // No progress - should not happen - return STATUS_INTERNAL_ERROR; - } - // Choose the PICC with the bit set. - currentLevelKnownBits = collisionPos; - count = (currentLevelKnownBits - 1) % 8; // The bit to modify - index = 1 + (currentLevelKnownBits / 8) + (count ? 1 : 0); // First byte is index 0. - buffer[index] |= (1 << count); - } - else if (result != STATUS_OK) { - return result; - } - else { // STATUS_OK - if (currentLevelKnownBits >= 32) { // This was a SELECT. - selectDone = true; // No more anticollision - // We continue below outside the while. - } - else { // This was an ANTICOLLISION. - // We now have all 32 bits of the UID in this Cascade Level - currentLevelKnownBits = 32; - // Run loop again to do the SELECT. - } - } - } // End of while (!selectDone) - - // We do not check the CBB - it was constructed by us above. - - // Copy the found UID bytes from buffer[] to uid->uidByte[] - index = (buffer[2] == PICC_CMD_CT) ? 3 : 2; // source index in buffer[] - bytesToCopy = (buffer[2] == PICC_CMD_CT) ? 3 : 4; - for (count = 0; count < bytesToCopy; count++) { - uid->uidByte[uidIndex + count] = buffer[index++]; - } - - // Check response SAK (Select Acknowledge) - if (responseLength != 3 || txLastBits != 0) { // SAK must be exactly 24 bits (1 byte + CRC_A). - return STATUS_ERROR; - } - // Verify CRC_A - do our own calculation and store the control in buffer[2..3] - those bytes are not needed anymore. - result = PCD_CalculateCRC(responseBuffer, 1, &buffer[2]); - if (result != STATUS_OK) { - return result; - } - if ((buffer[2] != responseBuffer[1]) || (buffer[3] != responseBuffer[2])) { - return STATUS_CRC_WRONG; - } - if (responseBuffer[0] & 0x04) { // Cascade bit set - UID not complete yes - cascadeLevel++; - } - else { - uidComplete = true; - uid->sak = responseBuffer[0]; - } - } // End of while (!uidComplete) - - // Set correct uid->size - uid->size = 3 * cascadeLevel + 1; - - return STATUS_OK; -} // End PICC_Select() - -/** - * Instructs a PICC in state ACTIVE(*) to go to state HALT. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PICC_HaltA() { - byte result; - byte buffer[4]; - - // Build command buffer - buffer[0] = PICC_CMD_HLTA; - buffer[1] = 0; - // Calculate CRC_A - result = PCD_CalculateCRC(buffer, 2, &buffer[2]); - if (result != STATUS_OK) { - return result; - } - - // Send the command. - // The standard says: - // If the PICC responds with any modulation during a period of 1 ms after the end of the frame containing the - // HLTA command, this response shall be interpreted as 'not acknowledge'. - // We interpret that this way: Only STATUS_TIMEOUT is an success. - result = PCD_TransceiveData(buffer, sizeof(buffer), NULL, 0); - if (result == STATUS_TIMEOUT) { - return STATUS_OK; - } - if (result == STATUS_OK) { // That is ironically NOT ok in this case ;-) - return STATUS_ERROR; - } - return result; -} // End PICC_HaltA() - - -///////////////////////////////////////////////////////////////////////////////////// -// Functions for communicating with MIFARE PICCs -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Executes the MFRC522 MFAuthent command. - * This command manages MIFARE authentication to enable a secure communication to any MIFARE Mini, MIFARE 1K and MIFARE 4K card. - * 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. - * For use with MIFARE Classic PICCs. - * The PICC must be selected - ie in state ACTIVE(*) - before calling this function. - * Remember to call PCD_StopCrypto1() after communicating with the authenticated PICC - otherwise no new communications can start. - * - * All keys are set to FFFFFFFFFFFFh at chip delivery. - * - * @return STATUS_OK on success, STATUS_??? otherwise. Probably STATUS_TIMEOUT if you supply the wrong key. - */ -byte MFRC522::PCD_Authenticate(byte command, ///< PICC_CMD_MF_AUTH_KEY_A or PICC_CMD_MF_AUTH_KEY_B - byte blockAddr, ///< The block number. See numbering in the comments in the .h file. - MIFARE_Key *key, ///< Pointer to the Crypteo1 key to use (6 bytes) - Uid *uid ///< Pointer to Uid struct. The first 4 bytes of the UID is used. - ) { - byte waitIRq = 0x10; // IdleIRq - - // Build command buffer - byte sendData[12]; - sendData[0] = command; - sendData[1] = blockAddr; - for (byte i = 0; i < MF_KEY_SIZE; i++) { // 6 key bytes - sendData[2+i] = key->keyByte[i]; - } - for (byte i = 0; i < 4; i++) { // The first 4 bytes of the UID - sendData[8+i] = uid->uidByte[i]; - } - - // Start the authentication. - return PCD_CommunicateWithPICC(PCD_MFAuthent, waitIRq, &sendData[0], sizeof(sendData)); -} // End PCD_Authenticate() - -/** - * Used to exit the PCD from its authenticated state. - * Remember to call this function after communicating with an authenticated PICC - otherwise no new communications can start. - */ -void MFRC522::PCD_StopCrypto1() { - // Clear MFCrypto1On bit - PCD_ClearRegisterBitMask(Status2Reg, 0x08); // Status2Reg[7..0] bits are: TempSensClear I2CForceHS reserved reserved MFCrypto1On ModemState[2:0] -} // End PCD_StopCrypto1() - -/** - * Reads 16 bytes (+ 2 bytes CRC_A) from the active PICC. - * - * For MIFARE Classic the sector containing the block must be authenticated before calling this function. - * - * For MIFARE Ultralight only addresses 00h to 0Fh are decoded. - * The MF0ICU1 returns a NAK for higher addresses. - * The MF0ICU1 responds to the READ command by sending 16 bytes starting from the page address defined by the command argument. - * For example; if blockAddr is 03h then pages 03h, 04h, 05h, 06h are returned. - * A roll-back is implemented: If blockAddr is 0Eh, then the contents of pages 0Eh, 0Fh, 00h and 01h are returned. - * - * The buffer must be at least 18 bytes because a CRC_A is also returned. - * Checks the CRC_A before returning STATUS_OK. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Read( byte blockAddr, ///< MIFARE Classic: The block (0-0xff) number. MIFARE Ultralight: The first page to return data from. - byte *buffer, ///< The buffer to store the data in - byte *bufferSize ///< Buffer size, at least 18 bytes. Also number of bytes returned if STATUS_OK. - ) { - byte result; - - // Sanity check - if (buffer == NULL || *bufferSize < 18) { - return STATUS_NO_ROOM; - } - - // Build command buffer - buffer[0] = PICC_CMD_MF_READ; - buffer[1] = blockAddr; - // Calculate CRC_A - result = PCD_CalculateCRC(buffer, 2, &buffer[2]); - if (result != STATUS_OK) { - return result; - } - - // Transmit the buffer and receive the response, validate CRC_A. - return PCD_TransceiveData(buffer, 4, buffer, bufferSize, NULL, 0, true); -} // End MIFARE_Read() - -/** - * Writes 16 bytes to the active PICC. - * - * For MIFARE Classic the sector containing the block must be authenticated before calling this function. - * - * For MIFARE Ultralight the operation is called "COMPATIBILITY WRITE". - * Even though 16 bytes are transferred to the Ultralight PICC, only the least significant 4 bytes (bytes 0 to 3) - * are written to the specified address. It is recommended to set the remaining bytes 04h to 0Fh to all logic 0. - * * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Write( byte blockAddr, ///< MIFARE Classic: The block (0-0xff) number. MIFARE Ultralight: The page (2-15) to write to. - byte *buffer, ///< The 16 bytes to write to the PICC - byte bufferSize ///< Buffer size, must be at least 16 bytes. Exactly 16 bytes are written. - ) { - byte result; - - // Sanity check - if (buffer == NULL || bufferSize < 16) { - return STATUS_INVALID; - } - - // Mifare Classic protocol requires two communications to perform a write. - // Step 1: Tell the PICC we want to write to block blockAddr. - byte cmdBuffer[2]; - cmdBuffer[0] = PICC_CMD_MF_WRITE; - cmdBuffer[1] = blockAddr; - result = PCD_MIFARE_Transceive(cmdBuffer, 2); // Adds CRC_A and checks that the response is MF_ACK. - if (result != STATUS_OK) { - return result; - } - - // Step 2: Transfer the data - result = PCD_MIFARE_Transceive(buffer, bufferSize); // Adds CRC_A and checks that the response is MF_ACK. - if (result != STATUS_OK) { - return result; - } - - return STATUS_OK; -} // End MIFARE_Write() - -/** - * Writes a 4 byte page to the active MIFARE Ultralight PICC. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Ultralight_Write( byte page, ///< The page (2-15) to write to. - byte *buffer, ///< The 4 bytes to write to the PICC - byte bufferSize ///< Buffer size, must be at least 4 bytes. Exactly 4 bytes are written. - ) { - byte result; - - // Sanity check - if (buffer == NULL || bufferSize < 4) { - return STATUS_INVALID; - } - - // Build commmand buffer - byte cmdBuffer[6]; - cmdBuffer[0] = PICC_CMD_UL_WRITE; - cmdBuffer[1] = page; - memcpy(&cmdBuffer[2], buffer, 4); - - // Perform the write - result = PCD_MIFARE_Transceive(cmdBuffer, 6); // Adds CRC_A and checks that the response is MF_ACK. - if (result != STATUS_OK) { - return result; - } - return STATUS_OK; -} // End MIFARE_Ultralight_Write() - -/** - * MIFARE Decrement subtracts the delta from the value of the addressed block, and stores the result in a volatile memory. - * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function. - * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001]. - * Use MIFARE_Transfer() to store the result in a block. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Decrement( byte blockAddr, ///< The block (0-0xff) number. - long delta ///< This number is subtracted from the value of block blockAddr. - ) { - return MIFARE_TwoStepHelper(PICC_CMD_MF_DECREMENT, blockAddr, delta); -} // End MIFARE_Decrement() - -/** - * MIFARE Increment adds the delta to the value of the addressed block, and stores the result in a volatile memory. - * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function. - * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001]. - * Use MIFARE_Transfer() to store the result in a block. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Increment( byte blockAddr, ///< The block (0-0xff) number. - long delta ///< This number is added to the value of block blockAddr. - ) { - return MIFARE_TwoStepHelper(PICC_CMD_MF_INCREMENT, blockAddr, delta); -} // End MIFARE_Increment() - -/** - * MIFARE Restore copies the value of the addressed block into a volatile memory. - * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function. - * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001]. - * Use MIFARE_Transfer() to store the result in a block. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Restore( byte blockAddr ///< The block (0-0xff) number. - ) { - // The datasheet describes Restore as a two step operation, but does not explain what data to transfer in step 2. - // Doing only a single step does not work, so I chose to transfer 0L in step two. - return MIFARE_TwoStepHelper(PICC_CMD_MF_RESTORE, blockAddr, 0L); -} // End MIFARE_Restore() - -/** - * Helper function for the two-step MIFARE Classic protocol operations Decrement, Increment and Restore. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_TwoStepHelper( byte command, ///< The command to use - byte blockAddr, ///< The block (0-0xff) number. - long data ///< The data to transfer in step 2 - ) { - byte result; - byte cmdBuffer[2]; // We only need room for 2 bytes. - - // Step 1: Tell the PICC the command and block address - cmdBuffer[0] = command; - cmdBuffer[1] = blockAddr; - result = PCD_MIFARE_Transceive( cmdBuffer, 2); // Adds CRC_A and checks that the response is MF_ACK. - if (result != STATUS_OK) { - return result; - } - - // Step 2: Transfer the data - result = PCD_MIFARE_Transceive( (byte *)&data, 4, true); // Adds CRC_A and accept timeout as success. - if (result != STATUS_OK) { - return result; - } - - return STATUS_OK; -} // End MIFARE_TwoStepHelper() - -/** - * MIFARE Transfer writes the value stored in the volatile memory into one MIFARE Classic block. - * For MIFARE Classic only. The sector containing the block must be authenticated before calling this function. - * Only for blocks in "value block" mode, ie with access bits [C1 C2 C3] = [110] or [001]. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_Transfer( byte blockAddr ///< The block (0-0xff) number. - ) { - byte result; - byte cmdBuffer[2]; // We only need room for 2 bytes. - - // Tell the PICC we want to transfer the result into block blockAddr. - cmdBuffer[0] = PICC_CMD_MF_TRANSFER; - cmdBuffer[1] = blockAddr; - result = PCD_MIFARE_Transceive( cmdBuffer, 2); // Adds CRC_A and checks that the response is MF_ACK. - if (result != STATUS_OK) { - return result; - } - return STATUS_OK; -} // End MIFARE_Transfer() - -/** - * Helper routine to read the current value from a Value Block. - * - * Only for MIFARE Classic and only for blocks in "value block" mode, that - * is: with access bits [C1 C2 C3] = [110] or [001]. The sector containing - * the block must be authenticated before calling this function. - * - * @param[in] blockAddr The block (0x00-0xff) number. - * @param[out] value Current value of the Value Block. - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_GetValue(byte blockAddr, long *value) { - byte status; - byte buffer[18]; - byte size = sizeof(buffer); - - // Read the block - status = MIFARE_Read(blockAddr, buffer, &size); - if (status == STATUS_OK) { - // Extract the value - *value = (long(buffer[3])<<24) | (long(buffer[2])<<16) | (long(buffer[1])<<8) | long(buffer[0]); - } - return status; -} // End MIFARE_GetValue() - -/** - * Helper routine to write a specific value into a Value Block. - * - * Only for MIFARE Classic and only for blocks in "value block" mode, that - * is: with access bits [C1 C2 C3] = [110] or [001]. The sector containing - * the block must be authenticated before calling this function. - * - * @param[in] blockAddr The block (0x00-0xff) number. - * @param[in] value New value of the Value Block. - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::MIFARE_SetValue(byte blockAddr, long value) { - byte buffer[18]; - - // Translate the long into 4 bytes; repeated 2x in value block - buffer[0] = buffer[ 8] = (value & 0xFF); - buffer[1] = buffer[ 9] = (value & 0xFF00) >> 8; - buffer[2] = buffer[10] = (value & 0xFF0000) >> 16; - buffer[3] = buffer[11] = (value & 0xFF000000) >> 24; - // Inverse 4 bytes also found in value block - buffer[4] = ~buffer[0]; - buffer[5] = ~buffer[1]; - buffer[6] = ~buffer[2]; - buffer[7] = ~buffer[3]; - // Address 2x with inverse address 2x - buffer[12] = buffer[14] = blockAddr; - buffer[13] = buffer[15] = ~blockAddr; - - // Write the whole data block - return MIFARE_Write(blockAddr, buffer, 16); -} // End MIFARE_SetValue() - -///////////////////////////////////////////////////////////////////////////////////// -// Support functions -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Wrapper for MIFARE protocol communication. - * Adds CRC_A, executes the Transceive command and checks that the response is MF_ACK or a timeout. - * - * @return STATUS_OK on success, STATUS_??? otherwise. - */ -byte MFRC522::PCD_MIFARE_Transceive( byte *sendData, ///< Pointer to the data to transfer to the FIFO. Do NOT include the CRC_A. - byte sendLen, ///< Number of bytes in sendData. - bool acceptTimeout ///< True => A timeout is also success - ) { - byte result; - byte cmdBuffer[18]; // We need room for 16 bytes data and 2 bytes CRC_A. - - // Sanity check - if (sendData == NULL || sendLen > 16) { - return STATUS_INVALID; - } - - // Copy sendData[] to cmdBuffer[] and add CRC_A - memcpy(cmdBuffer, sendData, sendLen); - result = PCD_CalculateCRC(cmdBuffer, sendLen, &cmdBuffer[sendLen]); - if (result != STATUS_OK) { - return result; - } - sendLen += 2; - - // Transceive the data, store the reply in cmdBuffer[] - byte waitIRq = 0x30; // RxIRq and IdleIRq - byte cmdBufferSize = sizeof(cmdBuffer); - byte validBits = 0; - result = PCD_CommunicateWithPICC(PCD_Transceive, waitIRq, cmdBuffer, sendLen, cmdBuffer, &cmdBufferSize, &validBits); - if (acceptTimeout && result == STATUS_TIMEOUT) { - return STATUS_OK; - } - if (result != STATUS_OK) { - return result; - } - // The PICC must reply with a 4 bit ACK - if (cmdBufferSize != 1 || validBits != 4) { - return STATUS_ERROR; - } - if (cmdBuffer[0] != MF_ACK) { - return STATUS_MIFARE_NACK; - } - return STATUS_OK; -} // End PCD_MIFARE_Transceive() - -/** - * Returns a __FlashStringHelper pointer to a status code name. - * - * @return const __FlashStringHelper * - */ -const __FlashStringHelper *MFRC522::GetStatusCodeName(byte code ///< One of the StatusCode enums. - ) { - switch (code) { - case STATUS_OK: return F("Success."); break; - case STATUS_ERROR: return F("Error in communication."); break; - case STATUS_COLLISION: return F("Collission detected."); break; - case STATUS_TIMEOUT: return F("Timeout in communication."); break; - case STATUS_NO_ROOM: return F("A buffer is not big enough."); break; - case STATUS_INTERNAL_ERROR: return F("Internal error in the code. Should not happen."); break; - case STATUS_INVALID: return F("Invalid argument."); break; - case STATUS_CRC_WRONG: return F("The CRC_A does not match."); break; - case STATUS_MIFARE_NACK: return F("A MIFARE PICC responded with NAK."); break; - default: return F("Unknown error"); break; - } -} // End GetStatusCodeName() - -/** - * Translates the SAK (Select Acknowledge) to a PICC type. - * - * @return PICC_Type - */ -byte MFRC522::PICC_GetType(byte sak ///< The SAK byte returned from PICC_Select(). - ) { - if (sak & 0x04) { // UID not complete - return PICC_TYPE_NOT_COMPLETE; - } - - switch (sak) { - case 0x09: return PICC_TYPE_MIFARE_MINI; break; - case 0x08: return PICC_TYPE_MIFARE_1K; break; - case 0x18: return PICC_TYPE_MIFARE_4K; break; - case 0x00: return PICC_TYPE_MIFARE_UL; break; - case 0x10: - case 0x11: return PICC_TYPE_MIFARE_PLUS; break; - case 0x01: return PICC_TYPE_TNP3XXX; break; - default: break; - } - - if (sak & 0x20) { - return PICC_TYPE_ISO_14443_4; - } - - if (sak & 0x40) { - return PICC_TYPE_ISO_18092; - } - - return PICC_TYPE_UNKNOWN; -} // End PICC_GetType() - -/** - * Returns a __FlashStringHelper pointer to the PICC type name. - * - * @return const __FlashStringHelper * - */ -const __FlashStringHelper *MFRC522::PICC_GetTypeName(byte piccType ///< One of the PICC_Type enums. - ) { - switch (piccType) { - case PICC_TYPE_ISO_14443_4: return F("PICC compliant with ISO/IEC 14443-4"); break; - case PICC_TYPE_ISO_18092: return F("PICC compliant with ISO/IEC 18092 (NFC)");break; - case PICC_TYPE_MIFARE_MINI: return F("MIFARE Mini, 320 bytes"); break; - case PICC_TYPE_MIFARE_1K: return F("MIFARE 1KB"); break; - case PICC_TYPE_MIFARE_4K: return F("MIFARE 4KB"); break; - case PICC_TYPE_MIFARE_UL: return F("MIFARE Ultralight or Ultralight C"); break; - case PICC_TYPE_MIFARE_PLUS: return F("MIFARE Plus"); break; - case PICC_TYPE_TNP3XXX: return F("MIFARE TNP3XXX"); break; - case PICC_TYPE_NOT_COMPLETE: return F("SAK indicates UID is not complete."); break; - case PICC_TYPE_UNKNOWN: - default: return F("Unknown type"); break; - } -} // End PICC_GetTypeName() - -/** - * Dumps debug info about the selected PICC to Serial. - * On success the PICC is halted after dumping the data. - * For MIFARE Classic the factory default key of 0xFFFFFFFFFFFF is tried. - */ -void MFRC522::PICC_DumpToSerial(Uid *uid ///< Pointer to Uid struct returned from a successful PICC_Select(). - ) { - MIFARE_Key key; - - // UID - Serial.print(F("Card UID:")); - for (byte i = 0; i < uid->size; i++) { - if(uid->uidByte[i] < 0x10) - Serial.print(F(" 0")); - else - Serial.print(F(" ")); - Serial.print(uid->uidByte[i], HEX); - } - Serial.println(); - - // PICC type - byte piccType = PICC_GetType(uid->sak); - Serial.print(F("PICC type: ")); - Serial.println(PICC_GetTypeName(piccType)); - - // Dump contents - switch (piccType) { - case PICC_TYPE_MIFARE_MINI: - case PICC_TYPE_MIFARE_1K: - case PICC_TYPE_MIFARE_4K: - // All keys are set to FFFFFFFFFFFFh at chip delivery from the factory. - for (byte i = 0; i < 6; i++) { - key.keyByte[i] = 0xFF; - } - PICC_DumpMifareClassicToSerial(uid, piccType, &key); - break; - - case PICC_TYPE_MIFARE_UL: - PICC_DumpMifareUltralightToSerial(); - break; - - case PICC_TYPE_ISO_14443_4: - case PICC_TYPE_ISO_18092: - case PICC_TYPE_MIFARE_PLUS: - case PICC_TYPE_TNP3XXX: - Serial.println(F("Dumping memory contents not implemented for that PICC type.")); - break; - - case PICC_TYPE_UNKNOWN: - case PICC_TYPE_NOT_COMPLETE: - default: - break; // No memory dump here - } - - Serial.println(); - PICC_HaltA(); // Already done if it was a MIFARE Classic PICC. -} // End PICC_DumpToSerial() - -/** - * Dumps card info (UID,SAK,Type) about the selected PICC to Serial. - */ -void MFRC522::PICC_DumpDetailsToSerial(Uid *uid ///< Pointer to Uid struct returned from a successful PICC_Select(). - ) { - byte bcc = 0; - - // UID - Serial.print(F("Card UID:")); - for (byte i = 0; i < uid->size; i++) { - if(uid->uidByte[i] < 0x10) - Serial.print(F(" 0")); - else - Serial.print(F(" ")); - Serial.print(uid->uidByte[i], HEX); - bcc = bcc ^ uid->uidByte[i]; - } - Serial.println(); - - // BCC - Serial.print(F("Card BCC: ")); - if(bcc < 0x10) - Serial.print(F("0")); - Serial.println(bcc, HEX); - - // SAK - Serial.print(F("Card SAK: ")); - if(uid->sak < 0x10) - Serial.print(F("0")); - Serial.println(uid->sak, HEX); - - // (suggested) PICC type - byte piccType = PICC_GetType(uid->sak); - Serial.print(F("PICC type: ")); - Serial.println(PICC_GetTypeName(piccType)); -} // End PICC_DumpDetailsToSerial() - -/** - * Dumps memory contents of a MIFARE Classic PICC. - * On success the PICC is halted after dumping the data. - */ -void MFRC522::PICC_DumpMifareClassicToSerial( Uid *uid, ///< Pointer to Uid struct returned from a successful PICC_Select(). - byte piccType, ///< One of the PICC_Type enums. - MIFARE_Key *key ///< Key A used for all sectors. - ) { - byte no_of_sectors = 0; - switch (piccType) { - case PICC_TYPE_MIFARE_MINI: - // Has 5 sectors * 4 blocks/sector * 16 bytes/block = 320 bytes. - no_of_sectors = 5; - break; - - case PICC_TYPE_MIFARE_1K: - // Has 16 sectors * 4 blocks/sector * 16 bytes/block = 1024 bytes. - no_of_sectors = 16; - break; - - case PICC_TYPE_MIFARE_4K: - // Has (32 sectors * 4 blocks/sector + 8 sectors * 16 blocks/sector) * 16 bytes/block = 4096 bytes. - no_of_sectors = 40; - break; - - default: // Should not happen. Ignore. - break; - } - - // Dump sectors, highest address first. - if (no_of_sectors) { - Serial.println(F("Sector Block 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 AccessBits")); - for (int8_t i = no_of_sectors - 1; i >= 0; i--) { - PICC_DumpMifareClassicSectorToSerial(uid, key, i); - } - } - PICC_HaltA(); // Halt the PICC before stopping the encrypted session. - PCD_StopCrypto1(); -} // End PICC_DumpMifareClassicToSerial() - -/** - * Dumps memory contents of a sector of a MIFARE Classic PICC. - * Uses PCD_Authenticate(), MIFARE_Read() and PCD_StopCrypto1. - * Always uses PICC_CMD_MF_AUTH_KEY_A because only Key A can always read the sector trailer access bits. - */ -void MFRC522::PICC_DumpMifareClassicSectorToSerial(Uid *uid, ///< Pointer to Uid struct returned from a successful PICC_Select(). - MIFARE_Key *key, ///< Key A for the sector. - byte sector ///< The sector to dump, 0..39. - ) { - byte status; - byte firstBlock; // Address of lowest address to dump actually last block dumped) - byte no_of_blocks; // Number of blocks in sector - bool isSectorTrailer; // Set to true while handling the "last" (ie highest address) in the sector. - - // The access bits are stored in a peculiar fashion. - // There are four groups: - // g[3] Access bits for the sector trailer, block 3 (for sectors 0-31) or block 15 (for sectors 32-39) - // g[2] Access bits for block 2 (for sectors 0-31) or blocks 10-14 (for sectors 32-39) - // g[1] Access bits for block 1 (for sectors 0-31) or blocks 5-9 (for sectors 32-39) - // g[0] Access bits for block 0 (for sectors 0-31) or blocks 0-4 (for sectors 32-39) - // Each group has access bits [C1 C2 C3]. In this code C1 is MSB and C3 is LSB. - // The four CX bits are stored together in a nible cx and an inverted nible cx_. - byte c1, c2, c3; // Nibbles - byte c1_, c2_, c3_; // Inverted nibbles - bool invertedError; // True if one of the inverted nibbles did not match - byte g[4]; // Access bits for each of the four groups. - byte group; // 0-3 - active group for access bits - bool firstInGroup; // True for the first block dumped in the group - - // Determine position and size of sector. - if (sector < 32) { // Sectors 0..31 has 4 blocks each - no_of_blocks = 4; - firstBlock = sector * no_of_blocks; - } - else if (sector < 40) { // Sectors 32-39 has 16 blocks each - no_of_blocks = 16; - firstBlock = 128 + (sector - 32) * no_of_blocks; - } - else { // Illegal input, no MIFARE Classic PICC has more than 40 sectors. - return; - } - - // Dump blocks, highest address first. - byte byteCount; - byte buffer[18]; - byte blockAddr; - isSectorTrailer = true; - for (int8_t blockOffset = no_of_blocks - 1; blockOffset >= 0; blockOffset--) { - blockAddr = firstBlock + blockOffset; - // Sector number - only on first line - if (isSectorTrailer) { - if(sector < 10) - Serial.print(F(" ")); // Pad with spaces - else - Serial.print(F(" ")); // Pad with spaces - Serial.print(sector); - Serial.print(F(" ")); - } - else { - Serial.print(F(" ")); - } - // Block number - if(blockAddr < 10) - Serial.print(F(" ")); // Pad with spaces - else { - if(blockAddr < 100) - Serial.print(F(" ")); // Pad with spaces - else - Serial.print(F(" ")); // Pad with spaces - } - Serial.print(blockAddr); - Serial.print(F(" ")); - // Establish encrypted communications before reading the first block - if (isSectorTrailer) { - status = PCD_Authenticate(PICC_CMD_MF_AUTH_KEY_A, firstBlock, key, uid); - if (status != STATUS_OK) { - Serial.print(F("PCD_Authenticate() failed: ")); - Serial.println(GetStatusCodeName(status)); - return; - } - } - // Read block - byteCount = sizeof(buffer); - status = MIFARE_Read(blockAddr, buffer, &byteCount); - if (status != STATUS_OK) { - Serial.print(F("MIFARE_Read() failed: ")); - Serial.println(GetStatusCodeName(status)); - continue; - } - // Dump data - for (byte index = 0; index < 16; index++) { - if(buffer[index] < 0x10) - Serial.print(F(" 0")); - else - Serial.print(F(" ")); - Serial.print(buffer[index], HEX); - if ((index % 4) == 3) { - Serial.print(F(" ")); - } - } - // Parse sector trailer data - if (isSectorTrailer) { - c1 = buffer[7] >> 4; - c2 = buffer[8] & 0xF; - c3 = buffer[8] >> 4; - c1_ = buffer[6] & 0xF; - c2_ = buffer[6] >> 4; - c3_ = buffer[7] & 0xF; - invertedError = (c1 != (~c1_ & 0xF)) || (c2 != (~c2_ & 0xF)) || (c3 != (~c3_ & 0xF)); - g[0] = ((c1 & 1) << 2) | ((c2 & 1) << 1) | ((c3 & 1) << 0); - g[1] = ((c1 & 2) << 1) | ((c2 & 2) << 0) | ((c3 & 2) >> 1); - g[2] = ((c1 & 4) << 0) | ((c2 & 4) >> 1) | ((c3 & 4) >> 2); - g[3] = ((c1 & 8) >> 1) | ((c2 & 8) >> 2) | ((c3 & 8) >> 3); - isSectorTrailer = false; - } - - // Which access group is this block in? - if (no_of_blocks == 4) { - group = blockOffset; - firstInGroup = true; - } - else { - group = blockOffset / 5; - firstInGroup = (group == 3) || (group != (blockOffset + 1) / 5); - } - - if (firstInGroup) { - // Print access bits - Serial.print(F(" [ ")); - Serial.print((g[group] >> 2) & 1, DEC); Serial.print(F(" ")); - Serial.print((g[group] >> 1) & 1, DEC); Serial.print(F(" ")); - Serial.print((g[group] >> 0) & 1, DEC); - Serial.print(F(" ] ")); - if (invertedError) { - Serial.print(F(" Inverted access bits did not match! ")); - } - } - - if (group != 3 && (g[group] == 1 || g[group] == 6)) { // Not a sector trailer, a value block - long value = (long(buffer[3])<<24) | (long(buffer[2])<<16) | (long(buffer[1])<<8) | long(buffer[0]); - Serial.print(F(" Value=0x")); Serial.print(value, HEX); - Serial.print(F(" Adr=0x")); Serial.print(buffer[12], HEX); - } - Serial.println(); - } - - return; -} // End PICC_DumpMifareClassicSectorToSerial() - -/** - * Dumps memory contents of a MIFARE Ultralight PICC. - */ -void MFRC522::PICC_DumpMifareUltralightToSerial() { - byte status; - byte byteCount; - byte buffer[18]; - byte i; - - Serial.println(F("Page 0 1 2 3")); - // Try the mpages of the original Ultralight. Ultralight C has more pages. - for (byte page = 0; page < 16; page +=4) { // Read returns data for 4 pages at a time. - // Read pages - byteCount = sizeof(buffer); - status = MIFARE_Read(page, buffer, &byteCount); - if (status != STATUS_OK) { - Serial.print(F("MIFARE_Read() failed: ")); - Serial.println(GetStatusCodeName(status)); - break; - } - // Dump data - for (byte offset = 0; offset < 4; offset++) { - i = page + offset; - if(i < 10) - Serial.print(F(" ")); // Pad with spaces - else - Serial.print(F(" ")); // Pad with spaces - Serial.print(i); - Serial.print(F(" ")); - for (byte index = 0; index < 4; index++) { - i = 4 * offset + index; - if(buffer[i] < 0x10) - Serial.print(F(" 0")); - else - Serial.print(F(" ")); - Serial.print(buffer[i], HEX); - } - Serial.println(); - } - } -} // End PICC_DumpMifareUltralightToSerial() - -/** - * 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). - */ -void MFRC522::MIFARE_SetAccessBits( byte *accessBitBuffer, ///< Pointer to byte 6, 7 and 8 in the sector trailer. Bytes [0..2] will be set. - byte g0, ///< Access bits [C1 C2 C3] for block 0 (for sectors 0-31) or blocks 0-4 (for sectors 32-39) - byte g1, ///< Access bits C1 C2 C3] for block 1 (for sectors 0-31) or blocks 5-9 (for sectors 32-39) - byte g2, ///< Access bits C1 C2 C3] for block 2 (for sectors 0-31) or blocks 10-14 (for sectors 32-39) - byte g3 ///< Access bits C1 C2 C3] for the sector trailer, block 3 (for sectors 0-31) or block 15 (for sectors 32-39) - ) { - byte c1 = ((g3 & 4) << 1) | ((g2 & 4) << 0) | ((g1 & 4) >> 1) | ((g0 & 4) >> 2); - byte c2 = ((g3 & 2) << 2) | ((g2 & 2) << 1) | ((g1 & 2) << 0) | ((g0 & 2) >> 1); - byte c3 = ((g3 & 1) << 3) | ((g2 & 1) << 2) | ((g1 & 1) << 1) | ((g0 & 1) << 0); - - accessBitBuffer[0] = (~c2 & 0xF) << 4 | (~c1 & 0xF); - accessBitBuffer[1] = c1 << 4 | (~c3 & 0xF); - accessBitBuffer[2] = c3 << 4 | c2; -} // End MIFARE_SetAccessBits() - - -/** - * Performs the "magic sequence" needed to get Chinese UID changeable - * Mifare cards to allow writing to sector 0, where the card UID is stored. - * - * Note that you do not need to have selected the card through REQA or WUPA, - * this sequence works immediately when the card is in the reader vicinity. - * This means you can use this method even on "bricked" cards that your reader does - * not recognise anymore (see MFRC522::MIFARE_UnbrickUidSector). - * - * Of course with non-bricked devices, you're free to select them before calling this function. - */ -bool MFRC522::MIFARE_OpenUidBackdoor(bool logErrors) { - // Magic sequence: - // > 50 00 57 CD (HALT + CRC) - // > 40 (7 bits only) - // < A (4 bits only) - // > 43 - // < A (4 bits only) - // Then you can write to sector 0 without authenticating - - PICC_HaltA(); // 50 00 57 CD - - byte cmd = 0x40; - byte validBits = 7; /* Our command is only 7 bits. After receiving card response, - this will contain amount of valid response bits. */ - byte response[32]; // Card's response is written here - byte received; - byte status = PCD_TransceiveData(&cmd, (byte)1, response, &received, &validBits, (byte)0, false); // 40 - if(status != STATUS_OK) { - if(logErrors) { - Serial.println(F("Card did not respond to 0x40 after HALT command. Are you sure it is a UID changeable one?")); - Serial.print(F("Error name: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - if (received != 1 || response[0] != 0x0A) { - if (logErrors) { - Serial.print(F("Got bad response on backdoor 0x40 command: ")); - Serial.print(response[0], HEX); - Serial.print(F(" (")); - Serial.print(validBits); - Serial.print(F(" valid bits)\r\n")); - } - return false; - } - - cmd = 0x43; - validBits = 8; - status = PCD_TransceiveData(&cmd, (byte)1, response, &received, &validBits, (byte)0, false); // 43 - if(status != STATUS_OK) { - if(logErrors) { - Serial.println(F("Error in communication at command 0x43, after successfully executing 0x40")); - Serial.print(F("Error name: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - if (received != 1 || response[0] != 0x0A) { - if (logErrors) { - Serial.print(F("Got bad response on backdoor 0x43 command: ")); - Serial.print(response[0], HEX); - Serial.print(F(" (")); - Serial.print(validBits); - Serial.print(F(" valid bits)\r\n")); - } - return false; - } - - // You can now write to sector 0 without authenticating! - return true; -} // End MIFARE_OpenUidBackdoor() - -/** - * Reads entire block 0, including all manufacturer data, and overwrites - * that block with the new UID, a freshly calculated BCC, and the original - * manufacturer data. - * - * It assumes a default KEY A of 0xFFFFFFFFFFFF. - * Make sure to have selected the card before this function is called. - */ -bool MFRC522::MIFARE_SetUid(byte *newUid, byte uidSize, bool logErrors) { - - // UID + BCC byte can not be larger than 16 together - if (!newUid || !uidSize || uidSize > 15) { - if (logErrors) { - Serial.println(F("New UID buffer empty, size 0, or size > 15 given")); - } - return false; - } - - // Authenticate for reading - MIFARE_Key key = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - byte status = PCD_Authenticate(MFRC522::PICC_CMD_MF_AUTH_KEY_A, (byte)1, &key, &uid); - if (status != STATUS_OK) { - - if (status == STATUS_TIMEOUT) { - // We get a read timeout if no card is selected yet, so let's select one - - // Wake the card up again if sleeping - // byte atqa_answer[2]; - // byte atqa_size = 2; - // PICC_WakeupA(atqa_answer, &atqa_size); - - if (!PICC_IsNewCardPresent() || !PICC_ReadCardSerial()) { - Serial.println(F("No card was previously selected, and none are available. Failed to set UID.")); - return false; - } - - status = PCD_Authenticate(MFRC522::PICC_CMD_MF_AUTH_KEY_A, (byte)1, &key, &uid); - if (status != STATUS_OK) { - // We tried, time to give up - if (logErrors) { - Serial.println(F("Failed to authenticate to card for reading, could not set UID: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - } - else { - if (logErrors) { - Serial.print(F("PCD_Authenticate() failed: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - } - - // Read block 0 - byte block0_buffer[18]; - byte byteCount = sizeof(block0_buffer); - status = MIFARE_Read((byte)0, block0_buffer, &byteCount); - if (status != STATUS_OK) { - if (logErrors) { - Serial.print(F("MIFARE_Read() failed: ")); - Serial.println(GetStatusCodeName(status)); - Serial.println(F("Are you sure your KEY A for sector 0 is 0xFFFFFFFFFFFF?")); - } - return false; - } - - // Write new UID to the data we just read, and calculate BCC byte - byte bcc = 0; - for (int i = 0; i < uidSize; i++) { - block0_buffer[i] = newUid[i]; - bcc ^= newUid[i]; - } - - // Write BCC byte to buffer - block0_buffer[uidSize] = bcc; - - // Stop encrypted traffic so we can send raw bytes - PCD_StopCrypto1(); - - // Activate UID backdoor - if (!MIFARE_OpenUidBackdoor(logErrors)) { - if (logErrors) { - Serial.println(F("Activating the UID backdoor failed.")); - } - return false; - } - - // Write modified block 0 back to card - status = MIFARE_Write((byte)0, block0_buffer, (byte)16); - if (status != STATUS_OK) { - if (logErrors) { - Serial.print(F("MIFARE_Write() failed: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - - // Wake the card up again - byte atqa_answer[2]; - byte atqa_size = 2; - PICC_WakeupA(atqa_answer, &atqa_size); - - return true; -} - -/** - * Resets entire sector 0 to zeroes, so the card can be read again by readers. - */ -bool MFRC522::MIFARE_UnbrickUidSector(bool logErrors) { - MIFARE_OpenUidBackdoor(logErrors); - - byte block0_buffer[] = {0x01, 0x02, 0x03, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - - // Write modified block 0 back to card - byte status = MIFARE_Write((byte)0, block0_buffer, (byte)16); - if (status != STATUS_OK) { - if (logErrors) { - Serial.print(F("MIFARE_Write() failed: ")); - Serial.println(GetStatusCodeName(status)); - } - return false; - } - return true; -} - -///////////////////////////////////////////////////////////////////////////////////// -// Convenience functions - does not add extra functionality -///////////////////////////////////////////////////////////////////////////////////// - -/** - * Returns true if a PICC responds to PICC_CMD_REQA. - * Only "new" cards in state IDLE are invited. Sleeping cards in state HALT are ignored. - * - * @return bool - */ -bool MFRC522::PICC_IsNewCardPresent() { - byte bufferATQA[2]; - byte bufferSize = sizeof(bufferATQA); - byte result = PICC_RequestA(bufferATQA, &bufferSize); - return (result == STATUS_OK || result == STATUS_COLLISION); -} // End PICC_IsNewCardPresent() - -/** - * Simple wrapper around PICC_Select. - * Returns true if a UID could be read. - * Remember to call PICC_IsNewCardPresent(), PICC_RequestA() or PICC_WakeupA() first. - * The read UID is available in the class variable uid. - * - * @return bool - */ -bool MFRC522::PICC_ReadCardSerial() { - byte result = PICC_Select(&uid); - return (result == STATUS_OK); -} // End PICC_ReadCardSerial() diff --git a/src/modules/rfid/lib_mfrc522/mfrc522_i2c.h b/src/modules/rfid/lib_mfrc522/mfrc522_i2c.h deleted file mode 100644 index 6974bad0..00000000 --- a/src/modules/rfid/lib_mfrc522/mfrc522_i2c.h +++ /dev/null @@ -1,410 +0,0 @@ -/** - * MFRC522_I2C.h - Library to use ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS I2C BY AROZCAN - * MFRC522_I2C.h - Based on ARDUINO RFID MODULE KIT 13.56 MHZ WITH TAGS SPI Library BY COOQROBOT. - * Based on code Dr.Leong ( WWW.B2CQSHOP.COM ) - * Created by Miguel Balboa (circuitito.com), Jan, 2012. - * Rewritten by Søren Thing Andersen (access.thing.dk), fall of 2013 (Translation to English, refactored, comments, anti collision, cascade levels.) - * Extended by Tom Clement with functionality to write to sector 0 of UID changeable Mifare cards. - * Extended by Ahmet Remzi Ozcan with I2C functionality. - * Author: arozcan @ https://github.com/arozcan/MFRC522-I2C-Library - * Released into the public domain. - * - * Please read this file for an overview and then MFRC522.cpp for comments on the specific functions. - * Search for "mf-rc522" on ebay.com to purchase the MF-RC522 board. - * - * There are three hardware components involved: - * 1) The micro controller: An Arduino - * 2) The PCD (short for Proximity Coupling Device): NXP MFRC522 Contactless Reader IC - * 3) The PICC (short for Proximity Integrated Circuit Card): A card or tag using the ISO 14443A interface, eg Mifare or NTAG203. - * - * The microcontroller and card reader uses I2C for communication. - * The protocol is described in the MFRC522 datasheet: http://www.nxp.com/documents/data_sheet/MFRC522.pdf - * - * The card reader and the tags communicate using a 13.56MHz electromagnetic field. - * The protocol is defined in ISO/IEC 14443-3 Identification cards -- Contactless integrated circuit cards -- Proximity cards -- Part 3: Initialization and anticollision". - * A free version of the final draft can be found at http://wg8.de/wg8n1496_17n3613_Ballot_FCD14443-3.pdf - * Details are found in chapter 6, Type A – Initialization and anticollision. - * - * If only the PICC UID is wanted, the above documents has all the needed information. - * To read and write from MIFARE PICCs, the MIFARE protocol is used after the PICC has been selected. - * The MIFARE Classic chips and protocol is described in the datasheets: - * 1K: http://www.nxp.com/documents/data_sheet/MF1S503x.pdf - * 4K: http://www.nxp.com/documents/data_sheet/MF1S703x.pdf - * Mini: http://www.idcardmarket.com/download/mifare_S20_datasheet.pdf - * The MIFARE Ultralight chip and protocol is described in the datasheets: - * Ultralight: http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf - * Ultralight C: http://www.nxp.com/documents/short_data_sheet/MF0ICU2_SDS.pdf - * - * MIFARE Classic 1K (MF1S503x): - * Has 16 sectors * 4 blocks/sector * 16 bytes/block = 1024 bytes. - * The blocks are numbered 0-63. - * 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: - * Bytes 0-5: Key A - * Bytes 6-8: Access Bits - * Bytes 9: User data - * Bytes 10-15: Key B (or user data) - * Block 0 is read-only manufacturer data. - * To access a block, an authentication using a key from the block's sector must be performed first. - * Example: To read from block 10, first authenticate using a key from sector 3 (blocks 8-11). - * All keys are set to FFFFFFFFFFFFh at chip delivery. - * 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. - * 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. - * MIFARE Classic 4K (MF1S703x): - * Has (32 sectors * 4 blocks/sector + 8 sectors * 16 blocks/sector) * 16 bytes/block = 4096 bytes. - * The blocks are numbered 0-255. - * The last block in each sector is the Sector Trailer like above. - * MIFARE Classic Mini (MF1 IC S20): - * Has 5 sectors * 4 blocks/sector * 16 bytes/block = 320 bytes. - * The blocks are numbered 0-19. - * The last block in each sector is the Sector Trailer like above. - * - * MIFARE Ultralight (MF0ICU1): - * Has 16 pages of 4 bytes = 64 bytes. - * Pages 0 + 1 is used for the 7-byte UID. - * Page 2 contains the last check 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) - * Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0. - * Pages 4-15 are read/write unless blocked by the lock bytes in page 2. - * MIFARE Ultralight C (MF0ICU2): - * Has 48 pages of 4 bytes = 192 bytes. - * Pages 0 + 1 is used for the 7-byte UID. - * Page 2 contains the last check 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) - * Page 3 is OTP, One Time Programmable bits. Once set to 1 they cannot revert to 0. - * Pages 4-39 are read/write unless blocked by the lock bytes in page 2. - * Page 40 Lock bytes - * Page 41 16 bit one way counter - * Pages 42-43 Authentication configuration - * Pages 44-47 Authentication key - */ -#ifndef MFRC522_h -#define MFRC522_h - -#include -#include - -// Firmware data for self-test -// Reference values based on firmware version -// Hint: if needed, you can remove unused self-test data to save flash memory -// -// Version 0.0 (0x90) -// Philips Semiconductors; Preliminary Specification Revision 2.0 - 01 August 2005; 16.1 Sefttest -const byte MFRC522_firmware_referenceV0_0[] PROGMEM = { - 0x00, 0x87, 0x98, 0x0f, 0x49, 0xFF, 0x07, 0x19, - 0xBF, 0x22, 0x30, 0x49, 0x59, 0x63, 0xAD, 0xCA, - 0x7F, 0xE3, 0x4E, 0x03, 0x5C, 0x4E, 0x49, 0x50, - 0x47, 0x9A, 0x37, 0x61, 0xE7, 0xE2, 0xC6, 0x2E, - 0x75, 0x5A, 0xED, 0x04, 0x3D, 0x02, 0x4B, 0x78, - 0x32, 0xFF, 0x58, 0x3B, 0x7C, 0xE9, 0x00, 0x94, - 0xB4, 0x4A, 0x59, 0x5B, 0xFD, 0xC9, 0x29, 0xDF, - 0x35, 0x96, 0x98, 0x9E, 0x4F, 0x30, 0x32, 0x8D -}; -// Version 1.0 (0x91) -// NXP Semiconductors; Rev. 3.8 - 17 September 2014; 16.1.1 Self test -const byte MFRC522_firmware_referenceV1_0[] PROGMEM = { - 0x00, 0xC6, 0x37, 0xD5, 0x32, 0xB7, 0x57, 0x5C, - 0xC2, 0xD8, 0x7C, 0x4D, 0xD9, 0x70, 0xC7, 0x73, - 0x10, 0xE6, 0xD2, 0xAA, 0x5E, 0xA1, 0x3E, 0x5A, - 0x14, 0xAF, 0x30, 0x61, 0xC9, 0x70, 0xDB, 0x2E, - 0x64, 0x22, 0x72, 0xB5, 0xBD, 0x65, 0xF4, 0xEC, - 0x22, 0xBC, 0xD3, 0x72, 0x35, 0xCD, 0xAA, 0x41, - 0x1F, 0xA7, 0xF3, 0x53, 0x14, 0xDE, 0x7E, 0x02, - 0xD9, 0x0F, 0xB5, 0x5E, 0x25, 0x1D, 0x29, 0x79 -}; -// Version 2.0 (0x92) -// NXP Semiconductors; Rev. 3.8 - 17 September 2014; 16.1.1 Self test -const byte MFRC522_firmware_referenceV2_0[] PROGMEM = { - 0x00, 0xEB, 0x66, 0xBA, 0x57, 0xBF, 0x23, 0x95, - 0xD0, 0xE3, 0x0D, 0x3D, 0x27, 0x89, 0x5C, 0xDE, - 0x9D, 0x3B, 0xA7, 0x00, 0x21, 0x5B, 0x89, 0x82, - 0x51, 0x3A, 0xEB, 0x02, 0x0C, 0xA5, 0x00, 0x49, - 0x7C, 0x84, 0x4D, 0xB3, 0xCC, 0xD2, 0x1B, 0x81, - 0x5D, 0x48, 0x76, 0xD5, 0x71, 0x61, 0x21, 0xA9, - 0x86, 0x96, 0x83, 0x38, 0xCF, 0x9D, 0x5B, 0x6D, - 0xDC, 0x15, 0xBA, 0x3E, 0x7D, 0x95, 0x3B, 0x2F -}; -// Clone -// Fudan Semiconductor FM17522 (0x88) -const byte FM17522_firmware_reference[] PROGMEM = { - 0x00, 0xD6, 0x78, 0x8C, 0xE2, 0xAA, 0x0C, 0x18, - 0x2A, 0xB8, 0x7A, 0x7F, 0xD3, 0x6A, 0xCF, 0x0B, - 0xB1, 0x37, 0x63, 0x4B, 0x69, 0xAE, 0x91, 0xC7, - 0xC3, 0x97, 0xAE, 0x77, 0xF4, 0x37, 0xD7, 0x9B, - 0x7C, 0xF5, 0x3C, 0x11, 0x8F, 0x15, 0xC3, 0xD7, - 0xC1, 0x5B, 0x00, 0x2A, 0xD0, 0x75, 0xDE, 0x9E, - 0x51, 0x64, 0xAB, 0x3E, 0xE9, 0x15, 0xB5, 0xAB, - 0x56, 0x9A, 0x98, 0x82, 0x26, 0xEA, 0x2A, 0x62 -}; - -class MFRC522 { -public: - // MFRC522 registers. Described in chapter 9 of the datasheet. - enum PCD_Register { - // Page 0: Command and status - // 0x00 // reserved for future use - CommandReg = 0x01 , // starts and stops command execution - ComIEnReg = 0x02 , // enable and disable interrupt request control bits - DivIEnReg = 0x03 , // enable and disable interrupt request control bits - ComIrqReg = 0x04 , // interrupt request bits - DivIrqReg = 0x05 , // interrupt request bits - ErrorReg = 0x06 , // error bits showing the error status of the last command executed - Status1Reg = 0x07 , // communication status bits - Status2Reg = 0x08 , // receiver and transmitter status bits - FIFODataReg = 0x09 , // input and output of 64 byte FIFO buffer - FIFOLevelReg = 0x0A , // number of bytes stored in the FIFO buffer - WaterLevelReg = 0x0B , // level for FIFO underflow and overflow warning - ControlReg = 0x0C , // miscellaneous control registers - BitFramingReg = 0x0D , // adjustments for bit-oriented frames - CollReg = 0x0E , // bit position of the first bit-collision detected on the RF interface - // 0x0F // reserved for future use - - // Page 1: Command - // 0x10 // reserved for future use - ModeReg = 0x11 , // defines general modes for transmitting and receiving - TxModeReg = 0x12 , // defines transmission data rate and framing - RxModeReg = 0x13 , // defines reception data rate and framing - TxControlReg = 0x14 , // controls the logical behavior of the antenna driver pins TX1 and TX2 - TxASKReg = 0x15 , // controls the setting of the transmission modulation - TxSelReg = 0x16 , // selects the internal sources for the antenna driver - RxSelReg = 0x17 , // selects internal receiver settings - RxThresholdReg = 0x18 , // selects thresholds for the bit decoder - DemodReg = 0x19 , // defines demodulator settings - // 0x1A // reserved for future use - // 0x1B // reserved for future use - MfTxReg = 0x1C , // controls some MIFARE communication transmit parameters - MfRxReg = 0x1D , // controls some MIFARE communication receive parameters - // 0x1E // reserved for future use - SerialSpeedReg = 0x1F , // selects the speed of the serial UART interface - - // Page 2: Configuration - // 0x20 // reserved for future use - CRCResultRegH = 0x21 , // shows the MSB and LSB values of the CRC calculation - CRCResultRegL = 0x22 , - // 0x23 // reserved for future use - ModWidthReg = 0x24 , // controls the ModWidth setting? - // 0x25 // reserved for future use - RFCfgReg = 0x26 , // configures the receiver gain - GsNReg = 0x27 , // selects the conductance of the antenna driver pins TX1 and TX2 for modulation - CWGsPReg = 0x28 , // defines the conductance of the p-driver output during periods of no modulation - ModGsPReg = 0x29 , // defines the conductance of the p-driver output during periods of modulation - TModeReg = 0x2A , // defines settings for the internal timer - TPrescalerReg = 0x2B , // the lower 8 bits of the TPrescaler value. The 4 high bits are in TModeReg. - TReloadRegH = 0x2C , // defines the 16-bit timer reload value - TReloadRegL = 0x2D , - TCounterValueRegH = 0x2E , // shows the 16-bit timer value - TCounterValueRegL = 0x2F , - - // Page 3: Test Registers - // 0x30 // reserved for future use - TestSel1Reg = 0x31 , // general test signal configuration - TestSel2Reg = 0x32 , // general test signal configuration - TestPinEnReg = 0x33 , // enables pin output driver on pins D1 to D7 - TestPinValueReg = 0x34 , // defines the values for D1 to D7 when it is used as an I/O bus - TestBusReg = 0x35 , // shows the status of the internal test bus - AutoTestReg = 0x36 , // controls the digital self test - VersionReg = 0x37 , // shows the software version - AnalogTestReg = 0x38 , // controls the pins AUX1 and AUX2 - TestDAC1Reg = 0x39 , // defines the test value for TestDAC1 - TestDAC2Reg = 0x3A , // defines the test value for TestDAC2 - TestADCReg = 0x3B // shows the value of ADC I and Q channels - // 0x3C // reserved for production tests - // 0x3D // reserved for production tests - // 0x3E // reserved for production tests - // 0x3F // reserved for production tests - }; - - // MFRC522 commands. Described in chapter 10 of the datasheet. - enum PCD_Command { - PCD_Idle = 0x00, // no action, cancels current command execution - PCD_Mem = 0x01, // stores 25 bytes into the internal buffer - PCD_GenerateRandomID = 0x02, // generates a 10-byte random ID number - PCD_CalcCRC = 0x03, // activates the CRC coprocessor or performs a self test - PCD_Transmit = 0x04, // transmits data from the FIFO buffer - PCD_NoCmdChange = 0x07, // no command change, can be used to modify the CommandReg register bits without affecting the command, for example, the PowerDown bit - PCD_Receive = 0x08, // activates the receiver circuits - PCD_Transceive = 0x0C, // transmits data from FIFO buffer to antenna and automatically activates the receiver after transmission - PCD_MFAuthent = 0x0E, // performs the MIFARE standard authentication as a reader - PCD_SoftReset = 0x0F // resets the MFRC522 - }; - - // MFRC522 RxGain[2:0] masks, defines the receiver's signal voltage gain factor (on the PCD). - // Described in 9.3.3.6 / table 98 of the datasheet at http://www.nxp.com/documents/data_sheet/MFRC522.pdf - enum PCD_RxGain { - RxGain_18dB = 0x00 << 4, // 000b - 18 dB, minimum - RxGain_23dB = 0x01 << 4, // 001b - 23 dB - RxGain_18dB_2 = 0x02 << 4, // 010b - 18 dB, it seems 010b is a duplicate for 000b - RxGain_23dB_2 = 0x03 << 4, // 011b - 23 dB, it seems 011b is a duplicate for 001b - RxGain_33dB = 0x04 << 4, // 100b - 33 dB, average, and typical default - RxGain_38dB = 0x05 << 4, // 101b - 38 dB - RxGain_43dB = 0x06 << 4, // 110b - 43 dB - RxGain_48dB = 0x07 << 4, // 111b - 48 dB, maximum - RxGain_min = 0x00 << 4, // 000b - 18 dB, minimum, convenience for RxGain_18dB - RxGain_avg = 0x04 << 4, // 100b - 33 dB, average, convenience for RxGain_33dB - RxGain_max = 0x07 << 4 // 111b - 48 dB, maximum, convenience for RxGain_48dB - }; - - // Commands sent to the PICC. - enum PICC_Command { - // The commands used by the PCD to manage communication with several PICCs (ISO 14443-3, Type A, section 6.4) - 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. - 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. - PICC_CMD_CT = 0x88, // Cascade Tag. Not really a command, but used during anti collision. - PICC_CMD_SEL_CL1 = 0x93, // Anti collision/Select, Cascade Level 1 - PICC_CMD_SEL_CL2 = 0x95, // Anti collision/Select, Cascade Level 2 - PICC_CMD_SEL_CL3 = 0x97, // Anti collision/Select, Cascade Level 3 - PICC_CMD_HLTA = 0x50, // HaLT command, Type A. Instructs an ACTIVE PICC to go to state HALT. - // The commands used for MIFARE Classic (from http://www.nxp.com/documents/data_sheet/MF1S503x.pdf, Section 9) - // Use PCD_MFAuthent to authenticate access to a sector, then use these commands to read/write/modify the blocks on the sector. - // The read/write commands can also be used for MIFARE Ultralight. - PICC_CMD_MF_AUTH_KEY_A = 0x60, // Perform authentication with Key A - PICC_CMD_MF_AUTH_KEY_B = 0x61, // Perform authentication with Key B - PICC_CMD_MF_READ = 0x30, // Reads one 16 byte block from the authenticated sector of the PICC. Also used for MIFARE Ultralight. - PICC_CMD_MF_WRITE = 0xA0, // Writes one 16 byte block to the authenticated sector of the PICC. Called "COMPATIBILITY WRITE" for MIFARE Ultralight. - PICC_CMD_MF_DECREMENT = 0xC0, // Decrements the contents of a block and stores the result in the internal data register. - PICC_CMD_MF_INCREMENT = 0xC1, // Increments the contents of a block and stores the result in the internal data register. - PICC_CMD_MF_RESTORE = 0xC2, // Reads the contents of a block into the internal data register. - PICC_CMD_MF_TRANSFER = 0xB0, // Writes the contents of the internal data register to a block. - // The commands used for MIFARE Ultralight (from http://www.nxp.com/documents/data_sheet/MF0ICU1.pdf, Section 8.6) - // The PICC_CMD_MF_READ and PICC_CMD_MF_WRITE can also be used for MIFARE Ultralight. - PICC_CMD_UL_WRITE = 0xA2 // Writes one 4 byte page to the PICC. - }; - - // MIFARE constants that does not fit anywhere else - enum MIFARE_Misc { - MF_ACK = 0xA, // The MIFARE Classic uses a 4 bit ACK/NAK. Any other value than 0xA is NAK. - MF_KEY_SIZE = 6 // A Mifare Crypto1 key is 6 bytes. - }; - - // PICC types we can detect. Remember to update PICC_GetTypeName() if you add more. - enum PICC_Type { - PICC_TYPE_UNKNOWN = 0, - PICC_TYPE_ISO_14443_4 = 1, // PICC compliant with ISO/IEC 14443-4 - PICC_TYPE_ISO_18092 = 2, // PICC compliant with ISO/IEC 18092 (NFC) - PICC_TYPE_MIFARE_MINI = 3, // MIFARE Classic protocol, 320 bytes - PICC_TYPE_MIFARE_1K = 4, // MIFARE Classic protocol, 1KB - PICC_TYPE_MIFARE_4K = 5, // MIFARE Classic protocol, 4KB - PICC_TYPE_MIFARE_UL = 6, // MIFARE Ultralight or Ultralight C - PICC_TYPE_MIFARE_PLUS = 7, // MIFARE Plus - PICC_TYPE_TNP3XXX = 8, // Only mentioned in NXP AN 10833 MIFARE Type Identification Procedure - PICC_TYPE_NOT_COMPLETE = 255 // SAK indicates UID is not complete. - }; - - // Return codes from the functions in this class. Remember to update GetStatusCodeName() if you add more. - enum StatusCode { - STATUS_OK = 1, // Success - STATUS_ERROR = 2, // Error in communication - STATUS_COLLISION = 3, // Collission detected - STATUS_TIMEOUT = 4, // Timeout in communication. - STATUS_NO_ROOM = 5, // A buffer is not big enough. - STATUS_INTERNAL_ERROR = 6, // Internal error in the code. Should not happen ;-) - STATUS_INVALID = 7, // Invalid argument. - STATUS_CRC_WRONG = 8, // The CRC_A does not match - STATUS_MIFARE_NACK = 9 // A MIFARE PICC responded with NAK. - }; - - // A struct used for passing the UID of a PICC. - typedef struct { - byte size; // Number of bytes in the UID. 4, 7 or 10. - byte uidByte[10]; - byte sak; // The SAK (Select acknowledge) byte returned from the PICC after successful selection. - } Uid; - - // A struct used for passing a MIFARE Crypto1 key - typedef struct { - byte keyByte[MF_KEY_SIZE]; - } MIFARE_Key; - - // Member variables - Uid uid; // Used by PICC_ReadCardSerial(). - - // Size of the MFRC522 FIFO - static const byte FIFO_SIZE = 64; // The FIFO is 64 bytes. - - ///////////////////////////////////////////////////////////////////////////////////// - // Functions for setting up the Arduino - ///////////////////////////////////////////////////////////////////////////////////// - MFRC522(); - MFRC522(byte chipAddress); - void SetChipAddress(byte chipAddress); - - ///////////////////////////////////////////////////////////////////////////////////// - // Basic interface functions for communicating with the MFRC522 - ///////////////////////////////////////////////////////////////////////////////////// - void PCD_WriteRegister(byte reg, byte value); - void PCD_WriteRegister(byte reg, byte count, byte *values); - byte PCD_ReadRegister(byte reg); - void PCD_ReadRegister(byte reg, byte count, byte *values, byte rxAlign = 0); - void setBitMask(unsigned char reg, unsigned char mask); - void PCD_SetRegisterBitMask(byte reg, byte mask); - void PCD_ClearRegisterBitMask(byte reg, byte mask); - byte PCD_CalculateCRC(byte *data, byte length, byte *result); - - ///////////////////////////////////////////////////////////////////////////////////// - // Functions for manipulating the MFRC522 - ///////////////////////////////////////////////////////////////////////////////////// - void PCD_Init(); - void PCD_Reset(); - void PCD_AntennaOn(); - void PCD_AntennaOff(); - byte PCD_GetAntennaGain(); - void PCD_SetAntennaGain(byte mask); - bool PCD_PerformSelfTest(); - - ///////////////////////////////////////////////////////////////////////////////////// - // Functions for communicating with PICCs - ///////////////////////////////////////////////////////////////////////////////////// - byte PCD_TransceiveData(byte *sendData, byte sendLen, byte *backData, byte *backLen, byte *validBits = NULL, byte rxAlign = 0, bool checkCRC = false); - byte PCD_CommunicateWithPICC(byte command, byte waitIRq, byte *sendData, byte sendLen, byte *backData = NULL, byte *backLen = NULL, byte *validBits = NULL, byte rxAlign = 0, bool checkCRC = false); - byte PICC_RequestA(byte *bufferATQA, byte *bufferSize); - byte PICC_WakeupA(byte *bufferATQA, byte *bufferSize); - byte PICC_REQA_or_WUPA(byte command, byte *bufferATQA, byte *bufferSize); - byte PICC_Select(Uid *uid, byte validBits = 0); - byte PICC_HaltA(); - - ///////////////////////////////////////////////////////////////////////////////////// - // Functions for communicating with MIFARE PICCs - ///////////////////////////////////////////////////////////////////////////////////// - byte PCD_Authenticate(byte command, byte blockAddr, MIFARE_Key *key, Uid *uid); - void PCD_StopCrypto1(); - byte MIFARE_Read(byte blockAddr, byte *buffer, byte *bufferSize); - byte MIFARE_Write(byte blockAddr, byte *buffer, byte bufferSize); - byte MIFARE_Decrement(byte blockAddr, long delta); - byte MIFARE_Increment(byte blockAddr, long delta); - byte MIFARE_Restore(byte blockAddr); - byte MIFARE_Transfer(byte blockAddr); - byte MIFARE_Ultralight_Write(byte page, byte *buffer, byte bufferSize); - byte MIFARE_GetValue(byte blockAddr, long *value); - byte MIFARE_SetValue(byte blockAddr, long value); - - ///////////////////////////////////////////////////////////////////////////////////// - // Support functions - ///////////////////////////////////////////////////////////////////////////////////// - byte PCD_MIFARE_Transceive(byte *sendData, byte sendLen, bool acceptTimeout = false); - // old function used too much memory, now name moved to flash; if you need char, copy from flash to memory - //const char *GetStatusCodeName(byte code); - const __FlashStringHelper *GetStatusCodeName(byte code); - byte PICC_GetType(byte sak); - // old function used too much memory, now name moved to flash; if you need char, copy from flash to memory - //const char *PICC_GetTypeName(byte type); - const __FlashStringHelper *PICC_GetTypeName(byte type); - void PICC_DumpToSerial(Uid *uid); - void PICC_DumpDetailsToSerial(Uid *uid); - void PICC_DumpMifareClassicToSerial(Uid *uid, byte piccType, MIFARE_Key *key); - void PICC_DumpMifareClassicSectorToSerial(Uid *uid, MIFARE_Key *key, byte sector); - void PICC_DumpMifareUltralightToSerial(); - void MIFARE_SetAccessBits(byte *accessBitBuffer, byte g0, byte g1, byte g2, byte g3); - bool MIFARE_OpenUidBackdoor(bool logErrors); - bool MIFARE_SetUid(byte *newUid, byte uidSize, bool logErrors); - bool MIFARE_UnbrickUidSector(bool logErrors); - - ///////////////////////////////////////////////////////////////////////////////////// - // Convenience functions - does not add extra functionality - ///////////////////////////////////////////////////////////////////////////////////// - bool PICC_IsNewCardPresent(); - bool PICC_ReadCardSerial(); - -private: - byte _chipAddress; - byte _resetPowerDownPin; // Arduino pin connected to MFRC522's reset and power down input (Pin 6, NRSTPD, active low) - byte MIFARE_TwoStepHelper(byte command, byte blockAddr, long data); -}; - -#endif diff --git a/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.cpp b/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.cpp deleted file mode 100644 index 87ff262e..00000000 --- a/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.cpp +++ /dev/null @@ -1,260 +0,0 @@ -#include "Adafruit_I2CDevice.h" - -//#define DEBUG_SERIAL Serial - -/*! - * @brief Create an I2C device at a given address - * @param addr The 7-bit I2C address for the device - * @param theWire The I2C bus to use, defaults to &Wire - */ -Adafruit_I2CDevice::Adafruit_I2CDevice(uint8_t addr, TwoWire *theWire) { - _addr = addr; - _wire = theWire; - _begun = false; - _maxBufferSize = I2C_BUFFER_LENGTH; -} - -/*! - * @brief Initializes and does basic address detection - * @param addr_detect Whether we should attempt to detect the I2C address - * with a scan. 99% of sensors/devices don't mind, but once in a while they - * don't respond well to a scan! - * @return True if I2C initialized and a device with the addr found - */ -bool Adafruit_I2CDevice::begin(bool addr_detect) { - _wire->begin(GROVE_SDA, GROVE_SCL); - _begun = true; - - if (addr_detect) { - return detected(); - } - return true; -} - -/*! - * @brief De-initialize device, turn off the Wire interface - */ -void Adafruit_I2CDevice::end(void) { - // Not all port implement Wire::end(), such as - // - ESP8266 - // - AVR core without WIRE_HAS_END - // - ESP32: end() is implemented since 2.0.1 which is latest at the moment. - // Temporarily disable for now to give time for user to update. - _wire->end(); - _begun = false; -} - -/*! - * @brief Scans I2C for the address - note will give a false-positive - * if there's no pullups on I2C - * @return True if I2C initialized and a device with the addr found - */ -bool Adafruit_I2CDevice::detected(void) { - // Init I2C if not done yet - if (!_begun && !begin()) { - return false; - } - - // A basic scanner, see if it ACK's - _wire->beginTransmission(_addr); -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("Address 0x")); - DEBUG_SERIAL.print(_addr); -#endif - if (_wire->endTransmission() == 0) { -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(F(" Detected")); -#endif - return true; - } -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(F(" Not detected")); -#endif - return false; -} - -/*! - * @brief Write a buffer or two to the I2C device. Cannot be more than - * maxBufferSize() bytes. - * @param buffer Pointer to buffer of data to write. This is const to - * ensure the content of this buffer doesn't change. - * @param len Number of bytes from buffer to write - * @param prefix_buffer Pointer to optional array of data to write before - * buffer. Cannot be more than maxBufferSize() bytes. This is const to - * ensure the content of this buffer doesn't change. - * @param prefix_len Number of bytes from prefix buffer to write - * @param stop Whether to send an I2C STOP signal on write - * @return True if write was successful, otherwise false. - */ -bool Adafruit_I2CDevice::write(const uint8_t *buffer, size_t len, bool stop, - const uint8_t *prefix_buffer, - size_t prefix_len) { - if ((len + prefix_len) > maxBufferSize()) { - // currently not guaranteed to work if more than 32 bytes! - // we will need to find out if some platforms have larger - // I2C buffer sizes :/ -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(F("\tI2CDevice could not write such a large buffer")); -#endif - return false; - } - - _wire->beginTransmission(_addr); - - // Write the prefix data (usually an address) - if ((prefix_len != 0) && (prefix_buffer != nullptr)) { - if (_wire->write(prefix_buffer, prefix_len) != prefix_len) { -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(F("\tI2CDevice failed to write")); -#endif - return false; - } - } - - // Write the data itself - if (_wire->write(buffer, len) != len) { -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(F("\tI2CDevice failed to write")); -#endif - return false; - } - -#ifdef DEBUG_SERIAL - - DEBUG_SERIAL.print(F("\tI2CWRITE @ 0x")); - DEBUG_SERIAL.print(_addr, HEX); - DEBUG_SERIAL.print(F(" :: ")); - if ((prefix_len != 0) && (prefix_buffer != nullptr)) { - for (uint16_t i = 0; i < prefix_len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(prefix_buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - } - } - for (uint16_t i = 0; i < len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (i % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - - if (stop) { - DEBUG_SERIAL.print("\tSTOP"); - } -#endif - - if (_wire->endTransmission(stop) == 0) { -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println(); - // DEBUG_SERIAL.println("Sent!"); -#endif - return true; - } else { -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.println("\tFailed to send!"); -#endif - return false; - } -} - -/*! - * @brief Read from I2C into a buffer from the I2C device. - * Cannot be more than maxBufferSize() bytes. - * @param buffer Pointer to buffer of data to read into - * @param len Number of bytes from buffer to read. - * @param stop Whether to send an I2C STOP signal on read - * @return True if read was successful, otherwise false. - */ -bool Adafruit_I2CDevice::read(uint8_t *buffer, size_t len, bool stop) { - size_t pos = 0; - while (pos < len) { - size_t read_len = - ((len - pos) > maxBufferSize()) ? maxBufferSize() : (len - pos); - bool read_stop = (pos < (len - read_len)) ? false : stop; - if (!_read(buffer + pos, read_len, read_stop)) - return false; - pos += read_len; - } - return true; -} - -bool Adafruit_I2CDevice::_read(uint8_t *buffer, size_t len, bool stop) { -// #if defined(TinyWireM_h) -// size_t recv = _wire->requestFrom((uint8_t)_addr, (uint8_t)len); -// #elif defined(ARDUINO_ARCH_MEGAAVR) -// size_t recv = _wire->requestFrom(_addr, len, stop); -// #else - size_t recv = _wire->requestFrom((uint8_t)_addr, (uint8_t)len, (uint8_t)stop); -// #endif - - if (recv != len) { - // Not enough data available to fulfill our obligation! -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tI2CDevice did not receive enough data: ")); - DEBUG_SERIAL.println(recv); -#endif - return false; - } - - for (uint16_t i = 0; i < len; i++) { - buffer[i] = _wire->read(); - } - -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tI2CREAD @ 0x")); - DEBUG_SERIAL.print(_addr, HEX); - DEBUG_SERIAL.print(F(" :: ")); - for (uint16_t i = 0; i < len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (len % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - DEBUG_SERIAL.println(); -#endif - - return true; -} - -/*! - * @brief Write some data, then read some data from I2C into another buffer. - * Cannot be more than maxBufferSize() bytes. The buffers can point to - * same/overlapping locations. - * @param write_buffer Pointer to buffer of data to write from - * @param write_len Number of bytes from buffer to write. - * @param read_buffer Pointer to buffer of data to read into. - * @param read_len Number of bytes from buffer to read. - * @param stop Whether to send an I2C STOP signal between the write and read - * @return True if write & read was successful, otherwise false. - */ -bool Adafruit_I2CDevice::write_then_read(const uint8_t *write_buffer, - size_t write_len, uint8_t *read_buffer, - size_t read_len, bool stop) { - if (!write(write_buffer, write_len, stop)) { - return false; - } - - return read(read_buffer, read_len); -} - -/*! - * @brief Returns the 7-bit address of this device - * @return The 7-bit address of this device - */ -uint8_t Adafruit_I2CDevice::address(void) { return _addr; } - -/*! - * @brief Change the I2C clock speed to desired (relies on - * underlying Wire support! - * @param desiredclk The desired I2C SCL frequency - * @return True if this platform supports changing I2C speed. - * Not necessarily that the speed was achieved! - */ -bool Adafruit_I2CDevice::setSpeed(uint32_t desiredclk) { - (void)desiredclk; - return false; -} diff --git a/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.h b/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.h deleted file mode 100644 index 0b2cbea2..00000000 --- a/src/modules/rfid/lib_pn532/Adafruit_I2CDevice.h +++ /dev/null @@ -1,36 +0,0 @@ -#ifndef Adafruit_I2CDevice_h -#define Adafruit_I2CDevice_h - -#include "core/globals.h" -#include - -///< The class which defines how we will talk to this device over I2C -class Adafruit_I2CDevice { -public: - Adafruit_I2CDevice(uint8_t addr, TwoWire *theWire = &Wire); - uint8_t address(void); - bool begin(bool addr_detect = true); - void end(void); - bool detected(void); - - bool read(uint8_t *buffer, size_t len, bool stop = true); - bool write(const uint8_t *buffer, size_t len, bool stop = true, - const uint8_t *prefix_buffer = nullptr, size_t prefix_len = 0); - bool write_then_read(const uint8_t *write_buffer, size_t write_len, - uint8_t *read_buffer, size_t read_len, - bool stop = false); - bool setSpeed(uint32_t desiredclk); - - /*! @brief How many bytes we can read in a transaction - * @return The size of the Wire receive/transmit buffer */ - size_t maxBufferSize() { return _maxBufferSize; } - -private: - uint8_t _addr; - TwoWire *_wire; - bool _begun; - size_t _maxBufferSize; - bool _read(uint8_t *buffer, size_t len, bool stop); -}; - -#endif // Adafruit_I2CDevice_h diff --git a/src/modules/rfid/lib_pn532/Adafruit_PN532.cpp b/src/modules/rfid/lib_pn532/Adafruit_PN532.cpp deleted file mode 100644 index 2ee6f4e5..00000000 --- a/src/modules/rfid/lib_pn532/Adafruit_PN532.cpp +++ /dev/null @@ -1,1987 +0,0 @@ -/**************************************************************************/ -/*! - @file Adafruit_PN532.cpp - - @section intro_sec Introduction - - Driver for NXP's PN532 NFC/13.56MHz RFID Transceiver - - This is a library for the Adafruit PN532 NFC/RFID breakout boards - This library works with the Adafruit NFC breakout - ----> https://www.adafruit.com/products/364 - - Check out the links above for our tutorials and wiring diagrams - These chips use SPI or I2C to communicate. - - Adafruit invests time and resources providing this open source code, - please support Adafruit and open-source hardware by purchasing - products from Adafruit! - - @section author Author - - Adafruit Industries - - @section license License - - BSD (see license.txt) - - @section HISTORY - - v2.2 - Added startPassiveTargetIDDetection() to start card detection and - readDetectedPassiveTargetID() to read it, useful when using the - IRQ pin. - - v2.1 - Added NTAG2xx helper functions - - v2.0 - Refactored to add I2C support from Adafruit_NFCShield_I2C library. - - v1.4 - Added setPassiveActivationRetries() - - v1.2 - Added writeGPIO() - - Added readGPIO() - - v1.1 - Changed readPassiveTargetID() to handle multiple UID sizes - - Added the following helper functions for text display - static void PrintHex(const byte * data, const uint32_t numBytes) - static void PrintHexChar(const byte * pbtData, const uint32_t - numBytes) - - Added the following Mifare Classic functions: - bool mifareclassic_IsFirstBlock (uint32_t uiBlock) - bool mifareclassic_IsTrailerBlock (uint32_t uiBlock) - uint8_t mifareclassic_AuthenticateBlock (uint8_t * uid, uint8_t - uidLen, uint32_t blockNumber, uint8_t keyNumber, uint8_t * keyData) uint8_t - mifareclassic_ReadDataBlock (uint8_t blockNumber, uint8_t * data) uint8_t - mifareclassic_WriteDataBlock (uint8_t blockNumber, uint8_t * data) - - Added the following Mifare Ultalight functions: - uint8_t mifareultralight_ReadPage (uint8_t page, uint8_t * buffer) -*/ -/**************************************************************************/ - -#include "Adafruit_PN532.h" - -byte pn532ack[] = {0x00, 0x00, 0xFF, - 0x00, 0xFF, 0x00}; ///< ACK message from PN532 -byte pn532response_firmwarevers[] = { - 0x00, 0x00, 0xFF, - 0x06, 0xFA, 0xD5}; ///< Expected firmware version message from PN532 - -// Uncomment these lines to enable debug output for PN532(SPI) and/or MIFARE -// related code - -// #define PN532DEBUG -// #define MIFAREDEBUG - -// If using Native Port on Arduino Zero or Due define as SerialUSB -#define PN532DEBUGPRINT Serial ///< Fixed name for debug Serial instance -//#define PN532DEBUGPRINT SerialUSB ///< Fixed name for debug Serial instance - -#define PN532_PACKBUFFSIZ 64 ///< Packet buffer size in bytes -byte pn532_packetbuffer[PN532_PACKBUFFSIZ]; ///< Packet buffer used in various - ///< transactions - -Adafruit_PN532::Adafruit_PN532() {} - -/**************************************************************************/ -/*! - @brief Instantiates a new PN532 class using software SPI. - - @param clk SPI clock pin (SCK) - @param miso SPI MISO pin - @param mosi SPI MOSI pin - @param ss SPI chip select pin (CS/SSEL) -*/ -/**************************************************************************/ -Adafruit_PN532::Adafruit_PN532(uint8_t clk, uint8_t miso, uint8_t mosi, - uint8_t ss) { - _cs = ss; - spi_dev = new Adafruit_SPIDevice(ss, clk, miso, mosi, 1000000, - SPI_BITORDER_LSBFIRST, SPI_MODE0); -} - -/**************************************************************************/ -/*! - @brief Instantiates a new PN532 class using I2C. - - @param irq Location of the IRQ pin - @param reset Location of the RSTPD_N pin - @param theWire pointer to I2C bus to use -*/ -/**************************************************************************/ -Adafruit_PN532::Adafruit_PN532(uint8_t irq, uint8_t reset, TwoWire *theWire) - : _irq(irq), _reset(reset) { - pinMode(_irq, INPUT); - pinMode(_reset, OUTPUT); - i2c_dev = new Adafruit_I2CDevice(PN532_I2C_ADDRESS, theWire); -} - -/**************************************************************************/ -/*! - @brief Instantiates a new PN532 class using hardware SPI. - - @param ss SPI chip select pin (CS/SSEL) - @param theSPI pointer to the SPI bus to use -*/ -/**************************************************************************/ -Adafruit_PN532::Adafruit_PN532(uint8_t ss, SPIClass *theSPI) { - _cs = ss; - spi_dev = new Adafruit_SPIDevice(ss, 1000000, SPI_BITORDER_LSBFIRST, - SPI_MODE0, theSPI); -} - -/**************************************************************************/ -/*! - @brief Instantiates a new PN532 class using hardware UART (HSU). - - @param reset Location of the RSTPD_N pin - @param theSer pointer to HardWare Serial bus to use -*/ -/**************************************************************************/ -Adafruit_PN532::Adafruit_PN532(uint8_t reset, HardwareSerial *theSer) - : _reset(reset) { - pinMode(_reset, OUTPUT); - ser_dev = theSer; -} - -/**************************************************************************/ -/*! - @brief Set PN532 class to use software SPI. - - @param clk SPI clock pin (SCK) - @param miso SPI MISO pin - @param mosi SPI MOSI pin - @param ss SPI chip select pin (CS/SSEL) -*/ -/**************************************************************************/ -void Adafruit_PN532::set_interface(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t ss) { - _cs = ss; - spi_dev = new Adafruit_SPIDevice(ss, clk, miso, mosi, 1000000, SPI_BITORDER_LSBFIRST, SPI_MODE0); -} - -/**************************************************************************/ -/*! - @brief Set PN532 class to use I2C. - - @param theWire pointer to I2C bus to use -*/ -/**************************************************************************/ -void Adafruit_PN532::set_interface(TwoWire *theWire) { - i2c_dev = new Adafruit_I2CDevice(PN532_I2C_ADDRESS, theWire); -} - -/**************************************************************************/ -/*! - @brief Setups the HW - - @returns true if successful, otherwise false -*/ -/**************************************************************************/ -bool Adafruit_PN532::begin() { - if (spi_dev) { - // SPI initialization - if (!spi_dev->begin()) { - return false; - } - } else if (i2c_dev) { - // I2C initialization - // PN532 will fail address check since its asleep, so suppress - if (!i2c_dev->begin(false)) { - return false; - } - } else if (ser_dev) { - ser_dev->begin(115200); - // clear out anything in read buffer - while (ser_dev->available()) - ser_dev->read(); - } else { - // no interface specified - return false; - } - reset(); // HW reset - put in known state - delay(10); - wakeup(); // hey! wakeup! - return true; -} - -/**************************************************************************/ -/*! - @brief Perform a hardware reset. Requires reset pin to have been provided. -*/ -/**************************************************************************/ -void Adafruit_PN532::reset(void) { - // see Datasheet p.209, Fig.48 for timings - if (_reset != -1) { - digitalWrite(_reset, LOW); - delay(1); // min 20ns - digitalWrite(_reset, HIGH); - delay(2); // max 2ms - } -} - -/**************************************************************************/ -/*! - @brief Wakeup from LowVbat mode into Normal Mode. -*/ -/**************************************************************************/ -void Adafruit_PN532::wakeup(void) { - // interface specific wakeups - each one is unique! - if (spi_dev) { - // hold CS low for 2ms - digitalWrite(_cs, LOW); - delay(2); - } else if (ser_dev) { - uint8_t w[3] = {0x55, 0x00, 0x00}; - ser_dev->write(w, 3); - delay(2); - } - - // PN532 will clock stretch I2C during SAMConfig as a "wakeup" - - // need to config SAM to stay in Normal Mode - SAMConfig(); -} - -/**************************************************************************/ -/*! - @brief Prints a hexadecimal value in plain characters - - @param data Pointer to the byte data - @param numBytes Data length in bytes -*/ -/**************************************************************************/ -void Adafruit_PN532::PrintHex(const byte *data, const uint32_t numBytes) { - uint32_t szPos; - for (szPos = 0; szPos < numBytes; szPos++) { - PN532DEBUGPRINT.print(F("0x")); - // Append leading 0 for small values - if (data[szPos] <= 0xF) - PN532DEBUGPRINT.print(F("0")); - PN532DEBUGPRINT.print(data[szPos] & 0xff, HEX); - if ((numBytes > 1) && (szPos != numBytes - 1)) { - PN532DEBUGPRINT.print(F(" ")); - } - } - PN532DEBUGPRINT.println(); -} - -/**************************************************************************/ -/*! - @brief Prints a hexadecimal value in plain characters, along with - the char equivalents in the following format - - 00 00 00 00 00 00 ...... - - @param data Pointer to the byte data - @param numBytes Data length in bytes -*/ -/**************************************************************************/ -void Adafruit_PN532::PrintHexChar(const byte *data, const uint32_t numBytes) { - uint32_t szPos; - for (szPos = 0; szPos < numBytes; szPos++) { - // Append leading 0 for small values - if (data[szPos] <= 0xF) - PN532DEBUGPRINT.print(F("0")); - PN532DEBUGPRINT.print(data[szPos], HEX); - if ((numBytes > 1) && (szPos != numBytes - 1)) { - PN532DEBUGPRINT.print(F(" ")); - } - } - PN532DEBUGPRINT.print(F(" ")); - for (szPos = 0; szPos < numBytes; szPos++) { - if (data[szPos] <= 0x1F) - PN532DEBUGPRINT.print(F(".")); - else - PN532DEBUGPRINT.print((char)data[szPos]); - } - PN532DEBUGPRINT.println(); -} - -/**************************************************************************/ -/*! - @brief Checks the firmware version of the PN5xx chip - - @returns The chip's firmware version and ID -*/ -/**************************************************************************/ -uint32_t Adafruit_PN532::getFirmwareVersion(void) { - uint32_t response; - - pn532_packetbuffer[0] = PN532_COMMAND_GETFIRMWAREVERSION; - - if (!sendCommandCheckAck(pn532_packetbuffer, 1)) { - return 0; - } - - // read data packet - readdata(pn532_packetbuffer, 13); - - // check some basic stuff - if (0 != memcmp((char *)pn532_packetbuffer, - (char *)pn532response_firmwarevers, 6)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Firmware doesn't match!")); -#endif - return 0; - } - - int offset = 7; - response = pn532_packetbuffer[offset++]; - response <<= 8; - response |= pn532_packetbuffer[offset++]; - response <<= 8; - response |= pn532_packetbuffer[offset++]; - response <<= 8; - response |= pn532_packetbuffer[offset++]; - - return response; -} - -/**************************************************************************/ -/*! - @brief Sends a command and waits a specified period for the ACK - - @param cmd Pointer to the command buffer - @param cmdlen The size of the command in bytes - @param timeout timeout before giving up - - @returns 1 if everything is OK, 0 if timeout occured before an - ACK was recieved -*/ -/**************************************************************************/ -// default timeout of one second -bool Adafruit_PN532::sendCommandCheckAck(uint8_t *cmd, uint8_t cmdlen, - uint16_t timeout) { - - // I2C works without using IRQ pin by polling for RDY byte - // seems to work best with some delays between transactions - uint8_t SLOWDOWN = 1; - // if (i2c_dev) - // SLOWDOWN = 1; - - // write the command - writecommand(cmd, cmdlen); - - // I2C TUNING - delay(SLOWDOWN); - - // Wait for chip to say its ready! - if (!waitready(timeout)) { - return false; - } - -#ifdef PN532DEBUG - if (spi_dev == NULL) { - PN532DEBUGPRINT.println(F("IRQ received")); - } -#endif - - // read acknowledgement - if (!readack()) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("No ACK frame received!")); -#endif - return false; - } - - // I2C TUNING - delay(SLOWDOWN); - - // Wait for chip to say its ready! - if (!waitready(timeout)) { - return false; - } - - return true; // ack'd command -} - -/**************************************************************************/ -/*! - @brief Writes an 8-bit value that sets the state of the PN532's GPIO - pins. - @param pinstate P3 pins state. - - @warning This function is provided exclusively for board testing and - is dangerous since it will throw an error if any pin other - than the ones marked "Can be used as GPIO" are modified! All - pins that can not be used as GPIO should ALWAYS be left high - (value = 1) or the system will become unstable and a HW reset - will be required to recover the PN532. - - pinState[0] = P30 Can be used as GPIO - pinState[1] = P31 Can be used as GPIO - pinState[2] = P32 *** RESERVED (Must be 1!) *** - pinState[3] = P33 Can be used as GPIO - pinState[4] = P34 *** RESERVED (Must be 1!) *** - pinState[5] = P35 Can be used as GPIO - - @return 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -bool Adafruit_PN532::writeGPIO(uint8_t pinstate) { - // uint8_t errorbit; - - // Make sure pinstate does not try to toggle P32 or P34 - pinstate |= (1 << PN532_GPIO_P32) | (1 << PN532_GPIO_P34); - - // Fill command buffer - pn532_packetbuffer[0] = PN532_COMMAND_WRITEGPIO; - pn532_packetbuffer[1] = PN532_GPIO_VALIDATIONBIT | pinstate; // P3 Pins - pn532_packetbuffer[2] = 0x00; // P7 GPIO Pins (not used ... taken by SPI) - -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Writing P3 GPIO: ")); - PN532DEBUGPRINT.println(pn532_packetbuffer[1], HEX); -#endif - - // Send the WRITEGPIO command (0x0E) - if (!sendCommandCheckAck(pn532_packetbuffer, 3)) - return 0x0; - - // Read response packet (00 FF PLEN PLENCHECKSUM D5 CMD+1(0x0F) DATACHECKSUM - // 00) - readdata(pn532_packetbuffer, 8); - -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Received: ")); - PrintHex(pn532_packetbuffer, 8); - PN532DEBUGPRINT.println(); -#endif - - int offset = 6; - return (pn532_packetbuffer[offset] == 0x0F); -} - -/**************************************************************************/ -/*! - Reads the state of the PN532's GPIO pins - - @returns An 8-bit value containing the pin state where: - - pinState[0] = P30 - pinState[1] = P31 - pinState[2] = P32 - pinState[3] = P33 - pinState[4] = P34 - pinState[5] = P35 -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::readGPIO(void) { - pn532_packetbuffer[0] = PN532_COMMAND_READGPIO; - - // Send the READGPIO command (0x0C) - if (!sendCommandCheckAck(pn532_packetbuffer, 1)) - return 0x0; - - // Read response packet (00 FF PLEN PLENCHECKSUM D5 CMD+1(0x0D) P3 P7 IO1 - // DATACHECKSUM 00) - readdata(pn532_packetbuffer, 11); - - /* READGPIO response should be in the following format: - - byte Description - ------------- ------------------------------------------ - b0..5 Frame header and preamble (with I2C there is an extra 0x00) - b6 P3 GPIO Pins - b7 P7 GPIO Pins (not used ... taken by SPI) - b8 Interface Mode Pins (not used ... bus select pins) - b9..10 checksum */ - - int p3offset = 7; - -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Received: ")); - PrintHex(pn532_packetbuffer, 11); - PN532DEBUGPRINT.println(); - PN532DEBUGPRINT.print(F("P3 GPIO: 0x")); - PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset], HEX); - PN532DEBUGPRINT.print(F("P7 GPIO: 0x")); - PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset + 1], HEX); - PN532DEBUGPRINT.print(F("IO GPIO: 0x")); - PN532DEBUGPRINT.println(pn532_packetbuffer[p3offset + 2], HEX); - // Note: You can use the IO GPIO value to detect the serial bus being used - switch (pn532_packetbuffer[p3offset + 2]) { - case 0x00: // Using UART - PN532DEBUGPRINT.println(F("Using UART (IO = 0x00)")); - break; - case 0x01: // Using I2C - PN532DEBUGPRINT.println(F("Using I2C (IO = 0x01)")); - break; - case 0x02: // Using SPI - PN532DEBUGPRINT.println(F("Using SPI (IO = 0x02)")); - break; - } -#endif - - return pn532_packetbuffer[p3offset]; -} - -/**************************************************************************/ -/*! - @brief Configures the SAM (Secure Access Module) - @return true on success, false otherwise. -*/ -/**************************************************************************/ -bool Adafruit_PN532::SAMConfig(void) { - pn532_packetbuffer[0] = PN532_COMMAND_SAMCONFIGURATION; - pn532_packetbuffer[1] = 0x01; // normal mode; - pn532_packetbuffer[2] = 0x14; // timeout 50ms * 20 = 1 second - pn532_packetbuffer[3] = 0x01; // use IRQ pin! - - if (!sendCommandCheckAck(pn532_packetbuffer, 4)) - return false; - - // read data packet - readdata(pn532_packetbuffer, 9); - - int offset = 6; - return (pn532_packetbuffer[offset] == 0x15); -} - -/**************************************************************************/ -/*! - Sets the MxRtyPassiveActivation byte of the RFConfiguration register - - @param maxRetries 0xFF to wait forever, 0x00..0xFE to timeout - after mxRetries - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -bool Adafruit_PN532::setPassiveActivationRetries(uint8_t maxRetries) { - pn532_packetbuffer[0] = PN532_COMMAND_RFCONFIGURATION; - pn532_packetbuffer[1] = 5; // Config item 5 (MaxRetries) - pn532_packetbuffer[2] = 0xFF; // MxRtyATR (default = 0xFF) - pn532_packetbuffer[3] = 0x01; // MxRtyPSL (default = 0x01) - pn532_packetbuffer[4] = maxRetries; - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Setting MxRtyPassiveActivation to ")); - PN532DEBUGPRINT.print(maxRetries, DEC); - PN532DEBUGPRINT.println(F(" ")); -#endif - - if (!sendCommandCheckAck(pn532_packetbuffer, 5)) - return 0x0; // no ACK - - return 1; -} - -/***** ISO14443A Commands ******/ - -/**************************************************************************/ -/*! - @brief Waits for an ISO14443A target to enter the field and reads - its ID. - - @param cardbaudrate Baud rate of the card - @param uid Pointer to the array that will be populated - with the card's UID (up to 7 bytes) - @param uidLength Pointer to the variable that will hold the - length of the card's UID. - @param timeout Timeout in milliseconds. - - @return 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -bool Adafruit_PN532::readPassiveTargetID(uint8_t cardbaudrate, uint8_t *uid, - uint8_t *uidLength, uint16_t timeout) { - pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; - pn532_packetbuffer[1] = 1; // max 1 cards at once (we can set this to 2 later) - pn532_packetbuffer[2] = cardbaudrate; - - if (!sendCommandCheckAck(pn532_packetbuffer, 3, timeout)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("No card(s) read")); -#endif - return 0x0; // no cards read - } - - return readDetectedPassiveTargetID(uid, uidLength); -} - -/**************************************************************************/ -/*! - @brief Put the reader in detection mode, non blocking so interrupts - must be enabled. - @param cardbaudrate Baud rate of the card - @return 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -bool Adafruit_PN532::startPassiveTargetIDDetection(uint8_t cardbaudrate) { - pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; - pn532_packetbuffer[1] = 1; // max 1 cards at once (we can set this to 2 later) - pn532_packetbuffer[2] = cardbaudrate; - - return sendCommandCheckAck(pn532_packetbuffer, 3); -} - -/**************************************************************************/ -/*! - Reads the ID of the passive target the reader has deteceted. - - @param uid Pointer to the array that will be populated - with the card's UID (up to 7 bytes) - @param uidLength Pointer to the variable that will hold the - length of the card's UID. - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -bool Adafruit_PN532::readDetectedPassiveTargetID(uint8_t *uid, - uint8_t *uidLength) { - // read data packet - readdata(pn532_packetbuffer, 20); - // check some basic stuff - - /* ISO14443A card response should be in the following format: - - byte Description - ------------- ------------------------------------------ - b0..6 Frame header and preamble - b7 Tags Found - b8 Tag Number (only one used in this example) - b9..10 SENS_RES - b11 SEL_RES - b12 NFCID Length - b13..NFCIDLen NFCID */ - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Found ")); - PN532DEBUGPRINT.print(pn532_packetbuffer[7], DEC); - PN532DEBUGPRINT.println(F(" tags")); -#endif - if (pn532_packetbuffer[7] != 1) - return 0; - - uint16_t sens_res = pn532_packetbuffer[9]; - sens_res <<= 8; - sens_res |= pn532_packetbuffer[10]; -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("ATQA: 0x")); - PN532DEBUGPRINT.println(sens_res, HEX); - PN532DEBUGPRINT.print(F("SAK: 0x")); - PN532DEBUGPRINT.println(pn532_packetbuffer[11], HEX); -#endif - - /* Card appears to be Mifare Classic */ - *uidLength = pn532_packetbuffer[12]; -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("UID:")); -#endif - for (uint8_t i = 0; i < pn532_packetbuffer[12]; i++) { - uid[i] = pn532_packetbuffer[13 + i]; -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F(" 0x")); - PN532DEBUGPRINT.print(uid[i], HEX); -#endif - } -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(); -#endif - - return 1; -} - -String Adafruit_PN532::PICC_GetTypeName(byte sak) { - if (sak & 0x04) { // UID not complete - return "SAK indicates UID is not complete."; - } - - switch (sak) { - case 0x09: return "MIFARE Mini, 320 bytes"; break; - case 0x08: return "MIFARE 1KB"; break; - case 0x18: return "MIFARE 4KB"; break; - case 0x00: return "MIFARE Ultralight or Ultralight C"; break; - case 0x10: - case 0x11: return "MIFARE Plus"; break; - case 0x01: return "MIFARE TNP3XXX"; break; - default: break; - } - - if (sak & 0x20) { - return "PICC compliant with ISO/IEC 14443-4"; - } - - if (sak & 0x40) { - return "PICC compliant with ISO/IEC 18092 (NFC)"; - } - - return "Unknown type"; -} - -/**************************************************************************/ -/*! - @brief Exchanges an APDU with the currently inlisted peer - - @param send Pointer to data to send - @param sendLength Length of the data to send - @param response Pointer to response data - @param responseLength Pointer to the response data length - @return true on success, false otherwise. -*/ -/**************************************************************************/ -bool Adafruit_PN532::inDataExchange(uint8_t *send, uint8_t sendLength, - uint8_t *response, - uint8_t *responseLength) { - if (sendLength > PN532_PACKBUFFSIZ - 2) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("APDU length too long for packet buffer")); -#endif - return false; - } - uint8_t i; - - pn532_packetbuffer[0] = 0x40; // PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = _inListedTag; - for (i = 0; i < sendLength; ++i) { - pn532_packetbuffer[i + 2] = send[i]; - } - - if (!sendCommandCheckAck(pn532_packetbuffer, sendLength + 2, 1000)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Could not send APDU")); -#endif - return false; - } - - if (!waitready(1000)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Response never received for APDU...")); -#endif - return false; - } - - readdata(pn532_packetbuffer, sizeof(pn532_packetbuffer)); - - if (pn532_packetbuffer[0] == 0 && pn532_packetbuffer[1] == 0 && - pn532_packetbuffer[2] == 0xff) { - uint8_t length = pn532_packetbuffer[3]; - if (pn532_packetbuffer[4] != (uint8_t)(~length + 1)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Length check invalid")); - PN532DEBUGPRINT.println(length, HEX); - PN532DEBUGPRINT.println((~length) + 1, HEX); -#endif - return false; - } - if (pn532_packetbuffer[5] == PN532_PN532TOHOST && - pn532_packetbuffer[6] == PN532_RESPONSE_INDATAEXCHANGE) { - if ((pn532_packetbuffer[7] & 0x3f) != 0) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Status code indicates an error")); -#endif - return false; - } - - length -= 3; - - if (length > *responseLength) { - length = *responseLength; // silent truncation... - } - - for (i = 0; i < length; ++i) { - response[i] = pn532_packetbuffer[8 + i]; - } - *responseLength = length; - - return true; - } else { - PN532DEBUGPRINT.print(F("Don't know how to handle this command: ")); - PN532DEBUGPRINT.println(pn532_packetbuffer[6], HEX); - return false; - } - } else { - PN532DEBUGPRINT.println(F("Preamble missing")); - return false; - } -} - -/**************************************************************************/ -/*! - @brief 'InLists' a passive target. PN532 acting as reader/initiator, - peer acting as card/responder. - @return true on success, false otherwise. -*/ -/**************************************************************************/ -bool Adafruit_PN532::inListPassiveTarget() { - pn532_packetbuffer[0] = PN532_COMMAND_INLISTPASSIVETARGET; - pn532_packetbuffer[1] = 1; - pn532_packetbuffer[2] = 0; - -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("About to inList passive target")); -#endif - - if (!sendCommandCheckAck(pn532_packetbuffer, 3, 1000)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Could not send inlist message")); -#endif - return false; - } - - if (!waitready(30000)) { - return false; - } - - readdata(pn532_packetbuffer, sizeof(pn532_packetbuffer)); - - if (pn532_packetbuffer[0] == 0 && pn532_packetbuffer[1] == 0 && - pn532_packetbuffer[2] == 0xff) { - uint8_t length = pn532_packetbuffer[3]; - if (pn532_packetbuffer[4] != (uint8_t)(~length + 1)) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Length check invalid")); - PN532DEBUGPRINT.println(length, HEX); - PN532DEBUGPRINT.println((~length) + 1, HEX); -#endif - return false; - } - if (pn532_packetbuffer[5] == PN532_PN532TOHOST && - pn532_packetbuffer[6] == PN532_RESPONSE_INLISTPASSIVETARGET) { - if (pn532_packetbuffer[7] != 1) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Unhandled number of targets inlisted")); -#endif - PN532DEBUGPRINT.println(F("Number of tags inlisted:")); - PN532DEBUGPRINT.println(pn532_packetbuffer[7]); - return false; - } - - _inListedTag = pn532_packetbuffer[8]; - PN532DEBUGPRINT.print(F("Tag number: ")); - PN532DEBUGPRINT.println(_inListedTag); - - return true; - } else { -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Unexpected response to inlist passive host")); -#endif - return false; - } - } else { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println(F("Preamble missing")); -#endif - return false; - } - - return true; -} - -/***** Mifare Classic Functions ******/ - -/**************************************************************************/ -/*! - @brief Indicates whether the specified block number is the first block - in the sector (block 0 relative to the current sector) - @param uiBlock Block number to test. - @return true if first block, false otherwise. -*/ -/**************************************************************************/ -bool Adafruit_PN532::mifareclassic_IsFirstBlock(uint32_t uiBlock) { - // Test if we are in the small or big sectors - if (uiBlock < 128) - return ((uiBlock) % 4 == 0); - else - return ((uiBlock) % 16 == 0); -} - -/**************************************************************************/ -/*! - @brief Indicates whether the specified block number is the sector - trailer. - @param uiBlock Block number to test. - @return true if sector trailer, false otherwise. -*/ -/**************************************************************************/ -bool Adafruit_PN532::mifareclassic_IsTrailerBlock(uint32_t uiBlock) { - // Test if we are in the small or big sectors - if (uiBlock < 128) - return ((uiBlock + 1) % 4 == 0); - else - return ((uiBlock + 1) % 16 == 0); -} - -/**************************************************************************/ -/*! - Tries to authenticate a block of memory on a MIFARE card using the - INDATAEXCHANGE command. See section 7.3.8 of the PN532 User Manual - for more information on sending MIFARE and other commands. - - @param uid Pointer to a byte array containing the card UID - @param uidLen The length (in bytes) of the card's UID (Should - be 4 for MIFARE Classic) - @param blockNumber The block number to authenticate. (0..63 for - 1KB cards, and 0..255 for 4KB cards). - @param keyNumber Which key type to use during authentication - (0 = MIFARE_CMD_AUTH_A, 1 = MIFARE_CMD_AUTH_B) - @param keyData Pointer to a byte array containing the 6 byte - key value - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareclassic_AuthenticateBlock(uint8_t *uid, - uint8_t uidLen, - uint32_t blockNumber, - uint8_t keyNumber, - uint8_t *keyData) { - // uint8_t len; - uint8_t i; - - // Hang on to the key and uid data - memcpy(_key, keyData, 6); - memcpy(_uid, uid, uidLen); - _uidLen = uidLen; - -// #ifdef MIFAREDEBUG -// PN532DEBUGPRINT.print(F("Trying to authenticate card ")); -// Adafruit_PN532::PrintHex(_uid, _uidLen); -// PN532DEBUGPRINT.print(F("Using authentication KEY ")); -// PN532DEBUGPRINT.print(keyNumber ? 'B' : 'A'); -// PN532DEBUGPRINT.print(F(": ")); -// Adafruit_PN532::PrintHex(_key, 6); -// #endif - - // Prepare the authentication command // - pn532_packetbuffer[0] = - PN532_COMMAND_INDATAEXCHANGE; /* Data Exchange Header */ - pn532_packetbuffer[1] = 1; /* Max card numbers */ - pn532_packetbuffer[2] = (keyNumber) ? MIFARE_CMD_AUTH_B : MIFARE_CMD_AUTH_A; - pn532_packetbuffer[3] = - blockNumber; /* Block Number (1K = 0..63, 4K = 0..255 */ - memcpy(pn532_packetbuffer + 4, _key, 6); - for (i = 0; i < _uidLen; i++) { - pn532_packetbuffer[10 + i] = _uid[i]; /* 4 byte card ID */ - } - - if (!sendCommandCheckAck(pn532_packetbuffer, 10 + _uidLen)) - return 0; - - // Read the response packet - readdata(pn532_packetbuffer, 12); - - // check if the response is valid and we are authenticated??? - // for an auth success it should be bytes 5-7: 0xD5 0x41 0x00 - // Mifare auth error is technically byte 7: 0x14 but anything other and 0x00 - // is not good - if (pn532_packetbuffer[7] != 0x00) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Authentification failed: ")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 12); -#endif - return 0; - } - - return 1; -} - -/**************************************************************************/ -/*! - Tries to read an entire 16-byte data block at the specified block - address. - - @param blockNumber The block number to authenticate. (0..63 for - 1KB cards, and 0..255 for 4KB cards). - @param data Pointer to the byte array that will hold the - retrieved data (if any) - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareclassic_ReadDataBlock(uint8_t blockNumber, - uint8_t *data) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Trying to read 16 bytes from block ")); - PN532DEBUGPRINT.println(blockNumber); -#endif - - /* Prepare the command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ - pn532_packetbuffer[3] = - blockNumber; /* Block Number (0..63 for 1K, 0..255 for 4K) */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for read command")); -#endif - return 0; - } - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); - - /* If byte 8 isn't 0x00 we probably have an error */ - if (pn532_packetbuffer[7] != 0x00) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Unexpected response")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); -#endif - return 0; - } - - /* Copy the 16 data bytes to the output buffer */ - /* Block content starts at byte 9 of a valid response */ - memcpy(data, pn532_packetbuffer + 8, 16); - -/* Display data for debug if requested */ -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Block ")); - PN532DEBUGPRINT.println(blockNumber); - Adafruit_PN532::PrintHexChar(data, 16); -#endif - - return 1; -} - -/**************************************************************************/ -/*! - Tries to write an entire 16-byte data block at the specified block - address. - - @param blockNumber The block number to authenticate. (0..63 for - 1KB cards, and 0..255 for 4KB cards). - @param data The byte array that contains the data to write. - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareclassic_WriteDataBlock(uint8_t blockNumber, - uint8_t *data) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Trying to write 16 bytes to block ")); - PN532DEBUGPRINT.println(blockNumber); -#endif - - /* Prepare the first command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = MIFARE_CMD_WRITE; /* Mifare Write command = 0xA0 */ - pn532_packetbuffer[3] = - blockNumber; /* Block Number (0..63 for 1K, 0..255 for 4K) */ - memcpy(pn532_packetbuffer + 4, data, 16); /* Data Payload */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 20)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); -#endif - return 0; - } - delay(10); - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); - - return 1; -} - -/**************************************************************************/ -/*! - Formats a Mifare Classic card to store NDEF Records - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareclassic_FormatNDEF(void) { - uint8_t sectorbuffer1[16] = {0x14, 0x01, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, - 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1}; - uint8_t sectorbuffer2[16] = {0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, - 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1, 0x03, 0xE1}; - uint8_t sectorbuffer3[16] = {0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0x78, 0x77, - 0x88, 0xC1, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - - // Note 0xA0 0xA1 0xA2 0xA3 0xA4 0xA5 must be used for key A - // for the MAD sector in NDEF records (sector 0) - - // Write block 1 and 2 to the card - if (!(mifareclassic_WriteDataBlock(1, sectorbuffer1))) - return 0; - if (!(mifareclassic_WriteDataBlock(2, sectorbuffer2))) - return 0; - // Write key A and access rights card - if (!(mifareclassic_WriteDataBlock(3, sectorbuffer3))) - return 0; - - // Seems that everything was OK (?!) - return 1; -} - -/**************************************************************************/ -/*! - Writes an NDEF URI Record to the specified sector (1..15) - - Note that this function assumes that the Mifare Classic card is - already formatted to work as an "NFC Forum Tag" and uses a MAD1 - file system. You can use the NXP TagWriter app on Android to - properly format cards for this. - - @param sectorNumber The sector that the URI record should be written - to (can be 1..15 for a 1K card) - @param uriIdentifier The uri identifier code (0 = none, 0x01 = - "http://www.", etc.) - @param url The uri text to write (max 38 characters). - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareclassic_WriteNDEFURI(uint8_t sectorNumber, - uint8_t uriIdentifier, - const char *url) { - // Figure out how long the string is - uint8_t len = strlen(url); - - // Make sure we're within a 1K limit for the sector number - if ((sectorNumber < 1) || (sectorNumber > 15)) - return 0; - - // Make sure the URI payload is between 1 and 38 chars - if ((len < 1) || (len > 38)) - return 0; - - // Note 0xD3 0xF7 0xD3 0xF7 0xD3 0xF7 must be used for key A - // in NDEF records - - // Setup the sector buffer (w/pre-formatted TLV wrapper and NDEF message) - uint8_t sectorbuffer1[16] = {0x00, - 0x00, - 0x03, - (uint8_t)(len + 5), - 0xD1, - 0x01, - (uint8_t)(len + 1), - 0x55, - uriIdentifier, - 0x00, - 0x00, - 0x00, - 0x00, - 0x00, - 0x00, - 0x00}; - uint8_t sectorbuffer2[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, - 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t sectorbuffer3[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, - 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t sectorbuffer4[16] = {0xD3, 0xF7, 0xD3, 0xF7, 0xD3, 0xF7, 0x7F, 0x07, - 0x88, 0x40, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}; - if (len <= 6) { - // Unlikely we'll get a url this short, but why not ... - memcpy(sectorbuffer1 + 9, url, len); - sectorbuffer1[len + 9] = 0xFE; - } else if (len == 7) { - // 0xFE needs to be wrapped around to next block - memcpy(sectorbuffer1 + 9, url, len); - sectorbuffer2[0] = 0xFE; - } else if ((len > 7) && (len <= 22)) { - // Url fits in two blocks - memcpy(sectorbuffer1 + 9, url, 7); - memcpy(sectorbuffer2, url + 7, len - 7); - sectorbuffer2[len - 7] = 0xFE; - } else if (len == 23) { - // 0xFE needs to be wrapped around to final block - memcpy(sectorbuffer1 + 9, url, 7); - memcpy(sectorbuffer2, url + 7, len - 7); - sectorbuffer3[0] = 0xFE; - } else { - // Url fits in three blocks - memcpy(sectorbuffer1 + 9, url, 7); - memcpy(sectorbuffer2, url + 7, 16); - memcpy(sectorbuffer3, url + 23, len - 24); - sectorbuffer3[len - 22] = 0xFE; - } - - // Now write all three blocks back to the card - if (!(mifareclassic_WriteDataBlock(sectorNumber * 4, sectorbuffer1))) - return 0; - if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 1, sectorbuffer2))) - return 0; - if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 2, sectorbuffer3))) - return 0; - if (!(mifareclassic_WriteDataBlock((sectorNumber * 4) + 3, sectorbuffer4))) - return 0; - - // Seems that everything was OK (?!) - return 1; -} - -/***** Mifare Ultralight Functions ******/ - -/**************************************************************************/ -/*! - @brief Tries to read an entire 4-byte page at the specified address. - - @param page The page number (0..63 in most cases) - @param buffer Pointer to the byte array that will hold the - retrieved data (if any) - @return 1 on success, 0 on error. -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareultralight_ReadPage(uint8_t page, - uint8_t *buffer) { - if (page >= 64) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Page value out of range")); -#endif - return 0; - } - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Reading page ")); - PN532DEBUGPRINT.println(page); -#endif - - /* Prepare the command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ - pn532_packetbuffer[3] = page; /* Page Number (0..63 in most cases) */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); -#endif - return 0; - } - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Received: ")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); -#endif - - /* If byte 8 isn't 0x00 we probably have an error */ - if (pn532_packetbuffer[7] == 0x00) { - /* Copy the 4 data bytes to the output buffer */ - /* Block content starts at byte 9 of a valid response */ - /* Note that the command actually reads 16 byte or 4 */ - /* pages at a time ... we simply discard the last 12 */ - /* bytes */ - memcpy(buffer, pn532_packetbuffer + 8, 4); - } else { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Unexpected response reading block: ")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); -#endif - return 0; - } - -/* Display data for debug if requested */ -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Page ")); - PN532DEBUGPRINT.print(page); - PN532DEBUGPRINT.println(F(":")); - Adafruit_PN532::PrintHexChar(buffer, 4); -#endif - - // Return OK signal - return 1; -} - -/**************************************************************************/ -/*! - Tries to write an entire 4-byte page at the specified block - address. - - @param page The page number to write. (0..63 for most cases) - @param data The byte array that contains the data to write. - Should be exactly 4 bytes long. - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::mifareultralight_WritePage(uint8_t page, - uint8_t *data) { - - if (page >= 64) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Page value out of range")); -#endif - // Return Failed Signal - return 0; - } - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Trying to write 4 byte page")); - PN532DEBUGPRINT.println(page); -#endif - - /* Prepare the first command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = - MIFARE_ULTRALIGHT_CMD_WRITE; /* Mifare Ultralight Write command = 0xA2 */ - pn532_packetbuffer[3] = page; /* Page Number (0..63 for most cases) */ - memcpy(pn532_packetbuffer + 4, data, 4); /* Data Payload */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 8)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); -#endif - - // Return Failed Signal - return 0; - } - delay(10); - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); - - // Return OK Signal - return 1; -} - -/***** NTAG2xx Functions ******/ - -/**************************************************************************/ -/*! - @brief Tries to read an entire 4-byte page at the specified address. - - @param page The page number (0..63 in most cases) - @param buffer Pointer to the byte array that will hold the - retrieved data (if any) - @return 1 on success, 0 on error. -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::ntag2xx_ReadPage(uint8_t page, uint8_t *buffer) { - // TAG Type PAGES USER START USER STOP - // -------- ----- ---------- --------- - // NTAG 203 42 4 39 - // NTAG 213 45 4 39 - // NTAG 215 135 4 129 - // NTAG 216 231 4 225 - - if (page >= 231) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Page value out of range")); -#endif - return 0; - } - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Reading page ")); - PN532DEBUGPRINT.println(page); -#endif - - /* Prepare the command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = MIFARE_CMD_READ; /* Mifare Read command = 0x30 */ - pn532_packetbuffer[3] = page; /* Page Number (0..63 in most cases) */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 4)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); -#endif - return 0; - } - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Received: ")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); -#endif - - /* If byte 8 isn't 0x00 we probably have an error */ - if (pn532_packetbuffer[7] == 0x00) { - /* Copy the 4 data bytes to the output buffer */ - /* Block content starts at byte 9 of a valid response */ - /* Note that the command actually reads 16 byte or 4 */ - /* pages at a time ... we simply discard the last 12 */ - /* bytes */ - memcpy(buffer, pn532_packetbuffer + 8, 16); - } else { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Unexpected response reading block: ")); - Adafruit_PN532::PrintHexChar(pn532_packetbuffer, 26); -#endif - return 0; - } - -/* Display data for debug if requested */ -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Page ")); - PN532DEBUGPRINT.print(page); - PN532DEBUGPRINT.println(F(":")); - Adafruit_PN532::PrintHexChar(buffer, 4); -#endif - - // Return OK signal - return 1; -} - -/**************************************************************************/ -/*! - Tries to write an entire 4-byte page at the specified block - address. - - @param page The page number to write. (0..63 for most cases) - @param data The byte array that contains the data to write. - Should be exactly 4 bytes long. - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::ntag2xx_WritePage(uint8_t page, uint8_t *data) { - // TAG Type PAGES USER START USER STOP - // -------- ----- ---------- --------- - // NTAG 203 42 4 39 - // NTAG 213 45 4 39 - // NTAG 215 135 4 129 - // NTAG 216 231 4 225 - - if ((page < 4) || (page > 225)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Page value out of range")); -#endif - // Return Failed Signal - return 0; - } - -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.print(F("Trying to write 4 byte page")); - PN532DEBUGPRINT.println(page); -#endif - - /* Prepare the first command */ - pn532_packetbuffer[0] = PN532_COMMAND_INDATAEXCHANGE; - pn532_packetbuffer[1] = 1; /* Card number */ - pn532_packetbuffer[2] = - MIFARE_ULTRALIGHT_CMD_WRITE; /* Mifare Ultralight Write command = 0xA2 */ - pn532_packetbuffer[3] = page; /* Page Number (0..63 for most cases) */ - memcpy(pn532_packetbuffer + 4, data, 4); /* Data Payload */ - - /* Send the command */ - if (!sendCommandCheckAck(pn532_packetbuffer, 8)) { -#ifdef MIFAREDEBUG - PN532DEBUGPRINT.println(F("Failed to receive ACK for write command")); -#endif - - // Return Failed Signal - return 0; - } - delay(10); - - /* Read the response packet */ - readdata(pn532_packetbuffer, 26); - - // Return OK Signal - return 1; -} - -/**************************************************************************/ -/*! - Writes an NDEF URI Record starting at the specified page (4..nn) - - Note that this function assumes that the NTAG2xx card is - already formatted to work as an "NFC Forum Tag". - - @param uriIdentifier The uri identifier code (0 = none, 0x01 = - "http://www.", etc.) - @param url The uri text to write (null-terminated string). - @param dataLen The size of the data area for overflow checks. - - @returns 1 if everything executed properly, 0 for an error -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::ntag2xx_WriteNDEFURI(uint8_t uriIdentifier, char *url, - uint8_t dataLen) { - uint8_t pageBuffer[4] = {0, 0, 0, 0}; - - // Remove NDEF record overhead from the URI data (pageHeader below) - uint8_t wrapperSize = 12; - - // Figure out how long the string is - uint8_t len = strlen(url); - - // Make sure the URI payload will fit in dataLen (include 0xFE trailer) - if ((len < 1) || (len + 1 > (dataLen - wrapperSize))) - return 0; - - // Setup the record header - // See NFCForum-TS-Type-2-Tag_1.1.pdf for details - uint8_t pageHeader[12] = { - /* NDEF Lock Control TLV (must be first and always present) */ - 0x01, /* Tag Field (0x01 = Lock Control TLV) */ - 0x03, /* Payload Length (always 3) */ - 0xA0, /* The position inside the tag of the lock bytes (upper 4 = page - address, lower 4 = byte offset) */ - 0x10, /* Size in bits of the lock area */ - 0x44, /* Size in bytes of a page and the number of bytes each lock bit can - lock (4 bit + 4 bits) */ - /* NDEF Message TLV - URI Record */ - 0x03, /* Tag Field (0x03 = NDEF Message) */ - (uint8_t)(len + 5), /* Payload Length (not including 0xFE trailer) */ - 0xD1, /* NDEF Record Header (TNF=0x1:Well known record + SR + ME + MB) */ - 0x01, /* Type Length for the record type indicator */ - (uint8_t)(len + 1), /* Payload len */ - 0x55, /* Record Type Indicator (0x55 or 'U' = URI Record) */ - uriIdentifier /* URI Prefix (ex. 0x01 = "http://www.") */ - }; - - // Write 12 byte header (three pages of data starting at page 4) - memcpy(pageBuffer, pageHeader, 4); - if (!(ntag2xx_WritePage(4, pageBuffer))) - return 0; - memcpy(pageBuffer, pageHeader + 4, 4); - if (!(ntag2xx_WritePage(5, pageBuffer))) - return 0; - memcpy(pageBuffer, pageHeader + 8, 4); - if (!(ntag2xx_WritePage(6, pageBuffer))) - return 0; - - // Write URI (starting at page 7) - uint8_t currentPage = 7; - char *urlcopy = url; - while (len) { - if (len < 4) { - memset(pageBuffer, 0, 4); - memcpy(pageBuffer, urlcopy, len); - pageBuffer[len] = 0xFE; // NDEF record footer - if (!(ntag2xx_WritePage(currentPage, pageBuffer))) - return 0; - // DONE! - return 1; - } else if (len == 4) { - memcpy(pageBuffer, urlcopy, len); - if (!(ntag2xx_WritePage(currentPage, pageBuffer))) - return 0; - memset(pageBuffer, 0, 4); - pageBuffer[0] = 0xFE; // NDEF record footer - currentPage++; - if (!(ntag2xx_WritePage(currentPage, pageBuffer))) - return 0; - // DONE! - return 1; - } else { - // More than one page of data left - memcpy(pageBuffer, urlcopy, 4); - if (!(ntag2xx_WritePage(currentPage, pageBuffer))) - return 0; - currentPage++; - urlcopy += 4; - len -= 4; - } - } - - // Seems that everything was OK (?!) - return 1; -} - -/************** high level communication functions (handles both I2C and SPI) */ - -/**************************************************************************/ -/*! - @brief Tries to read the SPI or I2C ACK signal -*/ -/**************************************************************************/ -bool Adafruit_PN532::readack() { - uint8_t ackbuff[6]; - - if (spi_dev) { - uint8_t cmd = PN532_SPI_DATAREAD; - spi_dev->write_then_read(&cmd, 1, ackbuff, 6); - } else if (i2c_dev || ser_dev) { - readdata(ackbuff, 6); - } - - return (0 == memcmp((char *)ackbuff, (char *)pn532ack, 6)); -} - -/**************************************************************************/ -/*! - @brief Return true if the PN532 is ready with a response. -*/ -/**************************************************************************/ -bool Adafruit_PN532::isready() { - if (spi_dev) { - // SPI ready check via Status Request - uint8_t cmd = PN532_SPI_STATREAD; - uint8_t reply; - spi_dev->write_then_read(&cmd, 1, &reply, 1); - return reply == PN532_SPI_READY; - } else if (i2c_dev) { - // I2C ready check via reading RDY byte - uint8_t rdy[1]; - i2c_dev->read(rdy, 1); - return rdy[0] == PN532_I2C_READY; - } else if (ser_dev) { - // Serial ready check based on non-zero read buffer - return (ser_dev->available() != 0); - } else if (_irq != -1) { - uint8_t x = digitalRead(_irq); - return x == 0; - } - return false; -} - -/**************************************************************************/ -/*! - @brief Waits until the PN532 is ready. - - @param timeout Timeout before giving up -*/ -/**************************************************************************/ -bool Adafruit_PN532::waitready(uint16_t timeout) { - uint16_t timer = 0; - while (!isready()) { - if (timeout != 0) { - timer += 10; - if (timer > timeout) { -#ifdef PN532DEBUG - PN532DEBUGPRINT.println("TIMEOUT!"); -#endif - return false; - } - } - delay(10); - } - return true; -} - -/**************************************************************************/ -/*! - @brief Reads n bytes of data from the PN532 via SPI or I2C. - - @param buff Pointer to the buffer where data will be written - @param n Number of bytes to be read -*/ -/**************************************************************************/ -void Adafruit_PN532::readdata(uint8_t *buff, uint8_t n) { - if (spi_dev) { - // SPI read - uint8_t cmd = PN532_SPI_DATAREAD; - spi_dev->write_then_read(&cmd, 1, buff, n); - } else if (i2c_dev) { - // I2C read - uint8_t rbuff[n + 1]; // +1 for leading RDY byte - i2c_dev->read(rbuff, n + 1); - for (uint8_t i = 0; i < n; i++) { - buff[i] = rbuff[i + 1]; - } - } else if (ser_dev) { - // Serial read - ser_dev->readBytes(buff, n); - } -#ifdef PN532DEBUG - PN532DEBUGPRINT.print(F("Reading: ")); - for (uint8_t i = 0; i < n; i++) { - PN532DEBUGPRINT.print(F(" 0x")); - PN532DEBUGPRINT.print(buff[i], HEX); - } - PN532DEBUGPRINT.println(); -#endif -} - -/**************************************************************************/ -/*! - @brief set the PN532 as iso14443a Target behaving as a SmartCard - @return true on success, false otherwise. - @note Author: Salvador Mendoza (salmg.net) new functions: - -AsTarget - -getDataTarget - -setDataTarget -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::AsTarget() { - pn532_packetbuffer[0] = 0x8C; - uint8_t target[] = { - 0x8C, // INIT AS TARGET - 0x00, // MODE -> BITFIELD - 0x08, 0x00, // SENS_RES - MIFARE PARAMS - 0xdc, 0x44, 0x20, // NFCID1T - 0x60, // SEL_RES - 0x01, 0xfe, // NFCID2T MUST START WITH 01fe - FELICA PARAMS - POL_RES - 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xc0, - 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, // PAD - 0xff, 0xff, // SYSTEM CODE - 0xaa, 0x99, 0x88, 0x77, 0x66, 0x55, 0x44, - 0x33, 0x22, 0x11, 0x01, 0x00, // NFCID3t MAX 47 BYTES ATR_RES - 0x0d, 0x52, 0x46, 0x49, 0x44, 0x49, 0x4f, - 0x74, 0x20, 0x50, 0x4e, 0x35, 0x33, 0x32 // HISTORICAL BYTES - }; - if (!sendCommandCheckAck(target, sizeof(target))) - return false; - - // read data packet - readdata(pn532_packetbuffer, 8); - - int offset = 6; - return (pn532_packetbuffer[offset] == 0x15); -} -/**************************************************************************/ -/*! - @brief Retrieve response from the emulation mode - - @param cmd = data - @param cmdlen = data length - @return true on success, false otherwise. -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::getDataTarget(uint8_t *cmd, uint8_t *cmdlen) { - uint8_t length; - pn532_packetbuffer[0] = 0x86; - if (!sendCommandCheckAck(pn532_packetbuffer, 1, 1000)) { - PN532DEBUGPRINT.println(F("Error en ack")); - return false; - } - - // read data packet - readdata(pn532_packetbuffer, 64); - length = pn532_packetbuffer[3] - 3; - - // if (length > *responseLength) {// Bug, should avoid it in the reading - // target data - // length = *responseLength; // silent truncation... - //} - - for (int i = 0; i < length; ++i) { - cmd[i] = pn532_packetbuffer[8 + i]; - } - *cmdlen = length; - return true; -} - -/**************************************************************************/ -/*! - @brief Set data in PN532 in the emulation mode - - @param cmd = data - @param cmdlen = data length - @return true on success, false otherwise. -*/ -/**************************************************************************/ -uint8_t Adafruit_PN532::setDataTarget(uint8_t *cmd, uint8_t cmdlen) { - uint8_t length; - // cmd1[0] = 0x8E; Must! - - if (!sendCommandCheckAck(cmd, cmdlen)) - return false; - - // read data packet - readdata(pn532_packetbuffer, 8); - length = pn532_packetbuffer[3] - 3; - for (int i = 0; i < length; ++i) { - cmd[i] = pn532_packetbuffer[8 + i]; - } - // cmdl = 0 - cmdlen = length; - - int offset = 6; - return (pn532_packetbuffer[offset] == 0x15); -} - -/**************************************************************************/ -/*! - @brief Writes a command to the PN532, automatically inserting the - preamble and required frame details (checksum, len, etc.) - - @param cmd Pointer to the command buffer - @param cmdlen Command length in bytes -*/ -/**************************************************************************/ -void Adafruit_PN532::writecommand(uint8_t *cmd, uint8_t cmdlen) { - if (spi_dev) { - // SPI command write. - uint8_t checksum; - uint8_t packet[9 + cmdlen]; - uint8_t *p = packet; - cmdlen++; - - p[0] = PN532_SPI_DATAWRITE; - p++; - - p[0] = PN532_PREAMBLE; - p++; - p[0] = PN532_STARTCODE1; - p++; - p[0] = PN532_STARTCODE2; - p++; - checksum = PN532_PREAMBLE + PN532_STARTCODE1 + PN532_STARTCODE2; - - p[0] = cmdlen; - p++; - p[0] = ~cmdlen + 1; - p++; - - p[0] = PN532_HOSTTOPN532; - p++; - checksum += PN532_HOSTTOPN532; - - for (uint8_t i = 0; i < cmdlen - 1; i++) { - p[0] = cmd[i]; - p++; - checksum += cmd[i]; - } - - p[0] = ~checksum; - p++; - p[0] = PN532_POSTAMBLE; - p++; - -#ifdef PN532DEBUG - Serial.print("Sending : "); - for (int i = 1; i < 8 + cmdlen; i++) { - Serial.print("0x"); - Serial.print(packet[i], HEX); - Serial.print(", "); - } - Serial.println(); -#endif - - spi_dev->write(packet, 8 + cmdlen); - } else if (i2c_dev || ser_dev) { - // I2C or Serial command write. - uint8_t packet[8 + cmdlen]; - uint8_t LEN = cmdlen + 1; - - packet[0] = PN532_PREAMBLE; - packet[1] = PN532_STARTCODE1; - packet[2] = PN532_STARTCODE2; - packet[3] = LEN; - packet[4] = ~LEN + 1; - packet[5] = PN532_HOSTTOPN532; - uint8_t sum = 0; - for (uint8_t i = 0; i < cmdlen; i++) { - packet[6 + i] = cmd[i]; - sum += cmd[i]; - } - packet[6 + cmdlen] = ~(PN532_HOSTTOPN532 + sum) + 1; - packet[7 + cmdlen] = PN532_POSTAMBLE; - -#ifdef PN532DEBUG - Serial.print("Sending : "); - for (int i = 1; i < 8 + cmdlen; i++) { - Serial.print("0x"); - Serial.print(packet[i], HEX); - Serial.print(", "); - } - Serial.println(); -#endif - - if (i2c_dev) { - i2c_dev->write(packet, 8 + cmdlen); - } else { - ser_dev->write(packet, 8 + cmdlen); - } - } -} - - -/**************************************************************************/ -/*! - @brief Builds the command to send to write to the PN532 registers - @param reg Pointer to the command buffer, goes in the form of - ADDR1H ADDR1L VAL1...ADDRnH ADDRnL VALn - @param len Command length in bytes -*/ -/**************************************************************************/ - -bool Adafruit_PN532::WriteRegister(uint8_t *reg, uint8_t len) { - uint8_t cmd[len + 1]; - uint8_t result[8]; - cmd[0] = PN532_COMMAND_WRITEREGISTER; - for (uint8_t i = 0; i < len; i++) { - cmd[i + 1] = reg[i]; - } - - if (!sendCommandCheckAck(cmd, len + 1)) return false; - - readdata(result, 8); - return true; -} - -/**************************************************************************/ -/*! - @brief Builds the command to send commands directly to the PICC - Works like inDataExchange but doesn't handles all the - protocol features - @param data Pointer to the command buffer - @param len Command length in bytes -*/ -/**************************************************************************/ -bool Adafruit_PN532::InCommunicateThru(uint8_t *data, uint8_t len) { - uint8_t cmd[len + 1]; - uint8_t result[8]; - cmd[0] = PN532_COMMAND_INCOMMUNICATETHRU; - for (uint8_t i = 0; i < len; i++) { - cmd[i + 1] = data[i]; - } - if (!sendCommandCheckAck(cmd, len + 1)) return false; - - readdata(result, 8); - // If byte 8 isn't 0x00 we probably have an error, - if (result[7] != 0x00) return false; - return true; -} - -/**************************************************************************/ -/*! - @brief Performs the command sequence in some chinese MiFare Classic tags - that unlocks a special backdoor to perform write/read - commands without authentication - >HALT + CRC (50 00 57 CD) - >UNLOCK1 (40) 7 bits - UNLOCK2 (43) - > 1) ///< Default I2C address -#define PN532_I2C_READBIT (0x01) ///< Read bit -#define PN532_I2C_BUSY (0x00) ///< Busy -#define PN532_I2C_READY (0x01) ///< Ready -#define PN532_I2C_READYTIMEOUT (20) ///< Ready timeout - -#define PN532_MIFARE_ISO14443A (0x00) ///< MiFare - -// Mifare Commands -#define MIFARE_CMD_AUTH_A (0x60) ///< Auth A -#define MIFARE_CMD_AUTH_B (0x61) ///< Auth B -#define MIFARE_CMD_READ (0x30) ///< Read -#define MIFARE_CMD_WRITE (0xA0) ///< Write -#define MIFARE_CMD_TRANSFER (0xB0) ///< Transfer -#define MIFARE_CMD_DECREMENT (0xC0) ///< Decrement -#define MIFARE_CMD_INCREMENT (0xC1) ///< Increment -#define MIFARE_CMD_STORE (0xC2) ///< Store -#define MIFARE_ULTRALIGHT_CMD_WRITE (0xA2) ///< Write (MiFare Ultralight) - -// Prefixes for NDEF Records (to identify record type) -#define NDEF_URIPREFIX_NONE (0x00) ///< No prefix -#define NDEF_URIPREFIX_HTTP_WWWDOT (0x01) ///< HTTP www. prefix -#define NDEF_URIPREFIX_HTTPS_WWWDOT (0x02) ///< HTTPS www. prefix -#define NDEF_URIPREFIX_HTTP (0x03) ///< HTTP prefix -#define NDEF_URIPREFIX_HTTPS (0x04) ///< HTTPS prefix -#define NDEF_URIPREFIX_TEL (0x05) ///< Tel prefix -#define NDEF_URIPREFIX_MAILTO (0x06) ///< Mailto prefix -#define NDEF_URIPREFIX_FTP_ANONAT (0x07) ///< FTP -#define NDEF_URIPREFIX_FTP_FTPDOT (0x08) ///< FTP dot -#define NDEF_URIPREFIX_FTPS (0x09) ///< FTPS -#define NDEF_URIPREFIX_SFTP (0x0A) ///< SFTP -#define NDEF_URIPREFIX_SMB (0x0B) ///< SMB -#define NDEF_URIPREFIX_NFS (0x0C) ///< NFS -#define NDEF_URIPREFIX_FTP (0x0D) ///< FTP -#define NDEF_URIPREFIX_DAV (0x0E) ///< DAV -#define NDEF_URIPREFIX_NEWS (0x0F) ///< NEWS -#define NDEF_URIPREFIX_TELNET (0x10) ///< Telnet prefix -#define NDEF_URIPREFIX_IMAP (0x11) ///< IMAP prefix -#define NDEF_URIPREFIX_RTSP (0x12) ///< RTSP -#define NDEF_URIPREFIX_URN (0x13) ///< URN -#define NDEF_URIPREFIX_POP (0x14) ///< POP -#define NDEF_URIPREFIX_SIP (0x15) ///< SIP -#define NDEF_URIPREFIX_SIPS (0x16) ///< SIPS -#define NDEF_URIPREFIX_TFTP (0x17) ///< TFPT -#define NDEF_URIPREFIX_BTSPP (0x18) ///< BTSPP -#define NDEF_URIPREFIX_BTL2CAP (0x19) ///< BTL2CAP -#define NDEF_URIPREFIX_BTGOEP (0x1A) ///< BTGOEP -#define NDEF_URIPREFIX_TCPOBEX (0x1B) ///< TCPOBEX -#define NDEF_URIPREFIX_IRDAOBEX (0x1C) ///< IRDAOBEX -#define NDEF_URIPREFIX_FILE (0x1D) ///< File -#define NDEF_URIPREFIX_URN_EPC_ID (0x1E) ///< URN EPC ID -#define NDEF_URIPREFIX_URN_EPC_TAG (0x1F) ///< URN EPC tag -#define NDEF_URIPREFIX_URN_EPC_PAT (0x20) ///< URN EPC pat -#define NDEF_URIPREFIX_URN_EPC_RAW (0x21) ///< URN EPC raw -#define NDEF_URIPREFIX_URN_EPC (0x22) ///< URN EPC -#define NDEF_URIPREFIX_URN_NFC (0x23) ///< URN NFC - -#define PN532_GPIO_VALIDATIONBIT (0x80) ///< GPIO validation bit -#define PN532_GPIO_P30 (0) ///< GPIO 30 -#define PN532_GPIO_P31 (1) ///< GPIO 31 -#define PN532_GPIO_P32 (2) ///< GPIO 32 -#define PN532_GPIO_P33 (3) ///< GPIO 33 -#define PN532_GPIO_P34 (4) ///< GPIO 34 -#define PN532_GPIO_P35 (5) ///< GPIO 35 - -/** - * @brief Class for working with Adafruit PN532 NFC/RFID breakout boards. - */ -class Adafruit_PN532 { -public: - Adafruit_PN532(); - Adafruit_PN532(uint8_t clk, uint8_t miso, uint8_t mosi, - uint8_t ss); // Software SPI - Adafruit_PN532(uint8_t ss, SPIClass *theSPI = &SPI); // Hardware SPI - Adafruit_PN532(uint8_t irq, uint8_t reset, - TwoWire *theWire = &Wire); // Hardware I2C - Adafruit_PN532(uint8_t reset, HardwareSerial *theSer); // Hardware UART - bool begin(void); - - void reset(void); - void wakeup(void); - void set_interface(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t ss); - void set_interface(TwoWire *theWire = &Wire); - - String PICC_GetTypeName(byte sak); - - // Generic PN532 functions - bool SAMConfig(void); - uint32_t getFirmwareVersion(void); - bool sendCommandCheckAck(uint8_t *cmd, uint8_t cmdlen, - uint16_t timeout = 100); - bool writeGPIO(uint8_t pinstate); - uint8_t readGPIO(void); - bool setPassiveActivationRetries(uint8_t maxRetries); - - // ISO14443A functions - bool readPassiveTargetID( - uint8_t cardbaudrate, uint8_t *uid, uint8_t *uidLength, - uint16_t timeout = 0); // timeout 0 means no timeout - will block forever. - bool startPassiveTargetIDDetection(uint8_t cardbaudrate); - bool readDetectedPassiveTargetID(uint8_t *uid, uint8_t *uidLength); - bool inDataExchange(uint8_t *send, uint8_t sendLength, uint8_t *response, - uint8_t *responseLength); - bool inListPassiveTarget(); - uint8_t AsTarget(); - uint8_t getDataTarget(uint8_t *cmd, uint8_t *cmdlen); - uint8_t setDataTarget(uint8_t *cmd, uint8_t cmdlen); - - // Mifare Classic functions - bool UnlockBackdoor(); - bool mifareclassic_WriteBlock0(uint8_t *data); - bool mifareclassic_IsFirstBlock(uint32_t uiBlock); - bool mifareclassic_IsTrailerBlock(uint32_t uiBlock); - uint8_t mifareclassic_AuthenticateBlock(uint8_t *uid, uint8_t uidLen, - uint32_t blockNumber, - uint8_t keyNumber, uint8_t *keyData); - uint8_t mifareclassic_ReadDataBlock(uint8_t blockNumber, uint8_t *data); - uint8_t mifareclassic_WriteDataBlock(uint8_t blockNumber, uint8_t *data); - uint8_t mifareclassic_FormatNDEF(void); - uint8_t mifareclassic_WriteNDEFURI(uint8_t sectorNumber, - uint8_t uriIdentifier, const char *url); - - // Mifare Ultralight functions - uint8_t mifareultralight_ReadPage(uint8_t page, uint8_t *buffer); - uint8_t mifareultralight_WritePage(uint8_t page, uint8_t *data); - - // NTAG2xx functions - uint8_t ntag2xx_ReadPage(uint8_t page, uint8_t *buffer); - uint8_t ntag2xx_WritePage(uint8_t page, uint8_t *data); - uint8_t ntag2xx_WriteNDEFURI(uint8_t uriIdentifier, char *url, - uint8_t dataLen); - - // Help functions to display formatted text - static void PrintHex(const byte *data, const uint32_t numBytes); - static void PrintHexChar(const byte *pbtData, const uint32_t numBytes); - - // Low level communication functions that handle both SPI and I2C. - void readdata(uint8_t *buff, uint8_t n); - -private: - int8_t _irq = -1, _reset = -1, _cs = -1; - int8_t _uid[7]; // ISO14443A uid - int8_t _uidLen; // uid len - int8_t _key[6]; // Mifare Classic key - int8_t _inListedTag; // Tg number of inlisted tag. - - // Low level communication functions that handle both SPI and I2C. - void writecommand(uint8_t *cmd, uint8_t cmdlen); - bool isready(); - bool waitready(uint16_t timeout); - bool readack(); - bool WriteRegister(uint8_t *reg, uint8_t len); - bool InCommunicateThru(uint8_t *data, uint8_t len); - - Adafruit_SPIDevice *spi_dev = NULL; - Adafruit_I2CDevice *i2c_dev = NULL; - HardwareSerial *ser_dev = NULL; -}; - -#endif diff --git a/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.cpp b/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.cpp deleted file mode 100644 index 034dc085..00000000 --- a/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.cpp +++ /dev/null @@ -1,508 +0,0 @@ -#include "Adafruit_SPIDevice.h" - -//#define DEBUG_SERIAL Serial - -/*! - * @brief Create an SPI device with the given CS pin and settings - * @param cspin The arduino pin number to use for chip select - * @param freq The SPI clock frequency to use, defaults to 1MHz - * @param dataOrder The SPI data order to use for bits within each byte, - * defaults to SPI_BITORDER_MSBFIRST - * @param dataMode The SPI mode to use, defaults to SPI_MODE0 - * @param theSPI The SPI bus to use, defaults to &theSPI - */ -Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, uint32_t freq, - BusIOBitOrder dataOrder, - uint8_t dataMode, SPIClass *theSPI) { -#ifdef BUSIO_HAS_HW_SPI - _cs = cspin; - _sck = _mosi = _miso = -1; - _spi = theSPI; - _begun = false; - _spiSetting = new SPISettings(freq, dataOrder, dataMode); - _freq = freq; - _dataOrder = dataOrder; - _dataMode = dataMode; -#else - // unused, but needed to suppress compiler warns - (void)cspin; - (void)freq; - (void)dataOrder; - (void)dataMode; - (void)theSPI; -#endif -} - -/*! - * @brief Create an SPI device with the given CS pin and settings - * @param cspin The arduino pin number to use for chip select - * @param sckpin The arduino pin number to use for SCK - * @param misopin The arduino pin number to use for MISO, set to -1 if not - * used - * @param mosipin The arduino pin number to use for MOSI, set to -1 if not - * used - * @param freq The SPI clock frequency to use, defaults to 1MHz - * @param dataOrder The SPI data order to use for bits within each byte, - * defaults to SPI_BITORDER_MSBFIRST - * @param dataMode The SPI mode to use, defaults to SPI_MODE0 - */ -Adafruit_SPIDevice::Adafruit_SPIDevice(int8_t cspin, int8_t sckpin, - int8_t misopin, int8_t mosipin, - uint32_t freq, BusIOBitOrder dataOrder, - uint8_t dataMode) { - _cs = cspin; - _sck = sckpin; - _miso = misopin; - _mosi = mosipin; - -#ifdef BUSIO_USE_FAST_PINIO - csPort = (BusIO_PortReg *)portOutputRegister(digitalPinToPort(cspin)); - csPinMask = digitalPinToBitMask(cspin); - if (mosipin != -1) { - mosiPort = (BusIO_PortReg *)portOutputRegister(digitalPinToPort(mosipin)); - mosiPinMask = digitalPinToBitMask(mosipin); - } - if (misopin != -1) { - misoPort = (BusIO_PortReg *)portInputRegister(digitalPinToPort(misopin)); - misoPinMask = digitalPinToBitMask(misopin); - } - clkPort = (BusIO_PortReg *)portOutputRegister(digitalPinToPort(sckpin)); - clkPinMask = digitalPinToBitMask(sckpin); -#endif - - _freq = freq; - _dataOrder = dataOrder; - _dataMode = dataMode; - _begun = false; -} - -/*! - * @brief Release memory allocated in constructors - */ -Adafruit_SPIDevice::~Adafruit_SPIDevice() { - if (_spiSetting) - delete _spiSetting; -} - -/*! - * @brief Initializes SPI bus and sets CS pin high - * @return Always returns true because there's no way to test success of SPI - * init - */ -bool Adafruit_SPIDevice::begin(void) { - if (_cs != -1) { - pinMode(_cs, OUTPUT); - digitalWrite(_cs, HIGH); - } - - if (_spi) { // hardware SPI -#ifdef BUSIO_HAS_HW_SPI - _spi->begin(); -#endif - } else { - pinMode(_sck, OUTPUT); - - if ((_dataMode == SPI_MODE0) || (_dataMode == SPI_MODE1)) { - // idle low on mode 0 and 1 - digitalWrite(_sck, LOW); - } else { - // idle high on mode 2 or 3 - digitalWrite(_sck, HIGH); - } - if (_mosi != -1) { - pinMode(_mosi, OUTPUT); - digitalWrite(_mosi, HIGH); - } - if (_miso != -1) { - pinMode(_miso, INPUT); - } - } - - _begun = true; - return true; -} - -/*! - * @brief Transfer (send/receive) a buffer over hard/soft SPI, without - * transaction management - * @param buffer The buffer to send and receive at the same time - * @param len The number of bytes to transfer - */ -void Adafruit_SPIDevice::transfer(uint8_t *buffer, size_t len) { - // - // HARDWARE SPI - // - if (_spi) { -#ifdef BUSIO_HAS_HW_SPI -#if defined(SPARK) - _spi->transfer(buffer, buffer, len, nullptr); -#elif defined(STM32) - for (size_t i = 0; i < len; i++) { - _spi->transfer(buffer[i]); - } -#else - _spi->transfer(buffer, len); -#endif - return; -#endif - } - - // - // SOFTWARE SPI - // - uint8_t startbit; - if (_dataOrder == SPI_BITORDER_LSBFIRST) { - startbit = 0x1; - } else { - startbit = 0x80; - } - - bool towrite, lastmosi = !(buffer[0] & startbit); - uint8_t bitdelay_us = (1000000 / _freq) / 2; - - for (size_t i = 0; i < len; i++) { - uint8_t reply = 0; - uint8_t send = buffer[i]; - - /* - Serial.print("\tSending software SPI byte 0x"); - Serial.print(send, HEX); - Serial.print(" -> 0x"); - */ - - // Serial.print(send, HEX); - for (uint8_t b = startbit; b != 0; - b = (_dataOrder == SPI_BITORDER_LSBFIRST) ? b << 1 : b >> 1) { - - if (bitdelay_us) { - delayMicroseconds(bitdelay_us); - } - - if (_dataMode == SPI_MODE0 || _dataMode == SPI_MODE2) { - towrite = send & b; - if ((_mosi != -1) && (lastmosi != towrite)) { -#ifdef BUSIO_USE_FAST_PINIO - if (towrite) - *mosiPort = *mosiPort | mosiPinMask; - else - *mosiPort = *mosiPort & ~mosiPinMask; -#else - digitalWrite(_mosi, towrite); -#endif - lastmosi = towrite; - } - -#ifdef BUSIO_USE_FAST_PINIO - *clkPort = *clkPort | clkPinMask; // Clock high -#else - digitalWrite(_sck, HIGH); -#endif - - if (bitdelay_us) { - delayMicroseconds(bitdelay_us); - } - - if (_miso != -1) { -#ifdef BUSIO_USE_FAST_PINIO - if (*misoPort & misoPinMask) { -#else - if (digitalRead(_miso)) { -#endif - reply |= b; - } - } - -#ifdef BUSIO_USE_FAST_PINIO - *clkPort = *clkPort & ~clkPinMask; // Clock low -#else - digitalWrite(_sck, LOW); -#endif - } else { // if (_dataMode == SPI_MODE1 || _dataMode == SPI_MODE3) - -#ifdef BUSIO_USE_FAST_PINIO - *clkPort = *clkPort | clkPinMask; // Clock high -#else - digitalWrite(_sck, HIGH); -#endif - - if (bitdelay_us) { - delayMicroseconds(bitdelay_us); - } - - if (_mosi != -1) { -#ifdef BUSIO_USE_FAST_PINIO - if (send & b) - *mosiPort = *mosiPort | mosiPinMask; - else - *mosiPort = *mosiPort & ~mosiPinMask; -#else - digitalWrite(_mosi, send & b); -#endif - } - -#ifdef BUSIO_USE_FAST_PINIO - *clkPort = *clkPort & ~clkPinMask; // Clock low -#else - digitalWrite(_sck, LOW); -#endif - - if (_miso != -1) { -#ifdef BUSIO_USE_FAST_PINIO - if (*misoPort & misoPinMask) { -#else - if (digitalRead(_miso)) { -#endif - reply |= b; - } - } - } - if (_miso != -1) { - buffer[i] = reply; - } - } - } - return; -} - -/*! - * @brief Transfer (send/receive) one byte over hard/soft SPI, without - * transaction management - * @param send The byte to send - * @return The byte received while transmitting - */ -uint8_t Adafruit_SPIDevice::transfer(uint8_t send) { - uint8_t data = send; - transfer(&data, 1); - return data; -} - -/*! - * @brief Manually begin a transaction (calls beginTransaction if hardware - * SPI) - */ -void Adafruit_SPIDevice::beginTransaction(void) { - if (_spi) { -#ifdef BUSIO_HAS_HW_SPI - _spi->beginTransaction(*_spiSetting); -#endif - } -} - -/*! - * @brief Manually end a transaction (calls endTransaction if hardware SPI) - */ -void Adafruit_SPIDevice::endTransaction(void) { - if (_spi) { -#ifdef BUSIO_HAS_HW_SPI - _spi->endTransaction(); -#endif - } -} - -/*! - * @brief Assert/Deassert the CS pin if it is defined - * @param value The state the CS is set to - */ -void Adafruit_SPIDevice::setChipSelect(int value) { - if (_cs != -1) { - digitalWrite(_cs, value); - } -} - -/*! - * @brief Write a buffer or two to the SPI device, with transaction - * management. - * @brief Manually begin a transaction (calls beginTransaction if hardware - * SPI) with asserting the CS pin - */ -void Adafruit_SPIDevice::beginTransactionWithAssertingCS() { - beginTransaction(); - setChipSelect(LOW); -} - -/*! - * @brief Manually end a transaction (calls endTransaction if hardware SPI) - * with deasserting the CS pin - */ -void Adafruit_SPIDevice::endTransactionWithDeassertingCS() { - setChipSelect(HIGH); - endTransaction(); -} - -/*! - * @brief Write a buffer or two to the SPI device, with transaction - * management. - * @param buffer Pointer to buffer of data to write - * @param len Number of bytes from buffer to write - * @param prefix_buffer Pointer to optional array of data to write before - * buffer. - * @param prefix_len Number of bytes from prefix buffer to write - * @return Always returns true because there's no way to test success of SPI - * writes - */ -bool Adafruit_SPIDevice::write(const uint8_t *buffer, size_t len, - const uint8_t *prefix_buffer, - size_t prefix_len) { - beginTransactionWithAssertingCS(); - - // do the writing -#if defined(ARDUINO_ARCH_ESP32) - if (_spi) { - if (prefix_len > 0) { - _spi->transferBytes((uint8_t *)prefix_buffer, nullptr, prefix_len); - } - if (len > 0) { - _spi->transferBytes((uint8_t *)buffer, nullptr, len); - } - } else -#endif - { - for (size_t i = 0; i < prefix_len; i++) { - transfer(prefix_buffer[i]); - } - for (size_t i = 0; i < len; i++) { - transfer(buffer[i]); - } - } - endTransactionWithDeassertingCS(); - -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tSPIDevice Wrote: ")); - if ((prefix_len != 0) && (prefix_buffer != nullptr)) { - for (uint16_t i = 0; i < prefix_len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(prefix_buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - } - } - for (uint16_t i = 0; i < len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (i % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - DEBUG_SERIAL.println(); -#endif - - return true; -} - -/*! - * @brief Read from SPI into a buffer from the SPI device, with transaction - * management. - * @param buffer Pointer to buffer of data to read into - * @param len Number of bytes from buffer to read. - * @param sendvalue The 8-bits of data to write when doing the data read, - * defaults to 0xFF - * @return Always returns true because there's no way to test success of SPI - * writes - */ -bool Adafruit_SPIDevice::read(uint8_t *buffer, size_t len, uint8_t sendvalue) { - memset(buffer, sendvalue, len); // clear out existing buffer - - beginTransactionWithAssertingCS(); - transfer(buffer, len); - endTransactionWithDeassertingCS(); - -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tSPIDevice Read: ")); - for (uint16_t i = 0; i < len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (len % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - DEBUG_SERIAL.println(); -#endif - - return true; -} - -/*! - * @brief Write some data, then read some data from SPI into another buffer, - * with transaction management. The buffers can point to same/overlapping - * locations. This does not transmit-receive at the same time! - * @param write_buffer Pointer to buffer of data to write from - * @param write_len Number of bytes from buffer to write. - * @param read_buffer Pointer to buffer of data to read into. - * @param read_len Number of bytes from buffer to read. - * @param sendvalue The 8-bits of data to write when doing the data read, - * defaults to 0xFF - * @return Always returns true because there's no way to test success of SPI - * writes - */ -bool Adafruit_SPIDevice::write_then_read(const uint8_t *write_buffer, - size_t write_len, uint8_t *read_buffer, - size_t read_len, uint8_t sendvalue) { - beginTransactionWithAssertingCS(); - // do the writing -#if defined(ARDUINO_ARCH_ESP32) - if (_spi) { - if (write_len > 0) { - _spi->transferBytes((uint8_t *)write_buffer, nullptr, write_len); - } - } else -#endif - { - for (size_t i = 0; i < write_len; i++) { - transfer(write_buffer[i]); - } - } - -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tSPIDevice Wrote: ")); - for (uint16_t i = 0; i < write_len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(write_buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (write_len % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - DEBUG_SERIAL.println(); -#endif - - // do the reading - for (size_t i = 0; i < read_len; i++) { - read_buffer[i] = transfer(sendvalue); - } - -#ifdef DEBUG_SERIAL - DEBUG_SERIAL.print(F("\tSPIDevice Read: ")); - for (uint16_t i = 0; i < read_len; i++) { - DEBUG_SERIAL.print(F("0x")); - DEBUG_SERIAL.print(read_buffer[i], HEX); - DEBUG_SERIAL.print(F(", ")); - if (read_len % 32 == 31) { - DEBUG_SERIAL.println(); - } - } - DEBUG_SERIAL.println(); -#endif - - endTransactionWithDeassertingCS(); - - return true; -} - -/*! - * @brief Write some data and read some data at the same time from SPI - * into the same buffer, with transaction management. This is basicaly a wrapper - * for transfer() with CS-pin and transaction management. This /does/ - * transmit-receive at the same time! - * @param buffer Pointer to buffer of data to write/read to/from - * @param len Number of bytes from buffer to write/read. - * @return Always returns true because there's no way to test success of SPI - * writes - */ -bool Adafruit_SPIDevice::write_and_read(uint8_t *buffer, size_t len) { - beginTransactionWithAssertingCS(); - transfer(buffer, len); - endTransactionWithDeassertingCS(); - - return true; -} diff --git a/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.h b/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.h deleted file mode 100644 index f0013c0b..00000000 --- a/src/modules/rfid/lib_pn532/Adafruit_SPIDevice.h +++ /dev/null @@ -1,144 +0,0 @@ -#ifndef Adafruit_SPIDevice_h -#define Adafruit_SPIDevice_h - -#include "core/globals.h" - -#if !defined(SPI_INTERFACES_COUNT) || \ - (defined(SPI_INTERFACES_COUNT) && (SPI_INTERFACES_COUNT > 0)) -// HW SPI available -#include -#define BUSIO_HAS_HW_SPI -#else -// SW SPI ONLY -enum { SPI_MODE0, SPI_MODE1, SPI_MODE2, _SPI_MODE4 }; -typedef uint8_t SPIClass; -#endif - -// some modern SPI definitions don't have BitOrder enum -#if (defined(__AVR__) && !defined(ARDUINO_ARCH_MEGAAVR)) || \ - defined(ESP8266) || defined(TEENSYDUINO) || defined(SPARK) || \ - defined(ARDUINO_ARCH_SPRESENSE) || defined(MEGATINYCORE) || \ - defined(DXCORE) || defined(ARDUINO_AVR_ATmega4809) || \ - defined(ARDUINO_AVR_ATmega4808) || defined(ARDUINO_AVR_ATmega3209) || \ - defined(ARDUINO_AVR_ATmega3208) || defined(ARDUINO_AVR_ATmega1609) || \ - defined(ARDUINO_AVR_ATmega1608) || defined(ARDUINO_AVR_ATmega809) || \ - defined(ARDUINO_AVR_ATmega808) || defined(ARDUINO_ARCH_ARC32) || \ - defined(ARDUINO_ARCH_XMC) - -typedef enum _BitOrder { - SPI_BITORDER_MSBFIRST = MSBFIRST, - SPI_BITORDER_LSBFIRST = LSBFIRST, -} BusIOBitOrder; - -#elif defined(ESP32) || defined(__ASR6501__) || defined(__ASR6502__) - -// some modern SPI definitions don't have BitOrder enum and have different SPI -// mode defines -typedef enum _BitOrder { - SPI_BITORDER_MSBFIRST = SPI_MSBFIRST, - SPI_BITORDER_LSBFIRST = SPI_LSBFIRST, -} BusIOBitOrder; - -#else -// Some platforms have a BitOrder enum but its named MSBFIRST/LSBFIRST -#define SPI_BITORDER_MSBFIRST MSBFIRST -#define SPI_BITORDER_LSBFIRST LSBFIRST -typedef BitOrder BusIOBitOrder; -#endif - -#if defined(__IMXRT1062__) // Teensy 4.x -// *Warning* I disabled the usage of FAST_PINIO as the set/clear operations -// used in the cpp file are not atomic and can effect multiple IO pins -// and if an interrupt happens in between the time the code reads the register -// and writes out the updated value, that changes one or more other IO pins -// on that same IO port, those change will be clobbered when the updated -// values are written back. A fast version can be implemented that uses the -// ports set and clear registers which are atomic. -// typedef volatile uint32_t BusIO_PortReg; -// typedef uint32_t BusIO_PortMask; -//#define BUSIO_USE_FAST_PINIO - -#elif defined(ARDUINO_ARCH_XMC) -#undef BUSIO_USE_FAST_PINIO - -#elif defined(__AVR__) || defined(TEENSYDUINO) -typedef volatile uint8_t BusIO_PortReg; -typedef uint8_t BusIO_PortMask; -#define BUSIO_USE_FAST_PINIO - -#elif defined(ESP8266) || defined(ESP32) || defined(__SAM3X8E__) || \ - defined(ARDUINO_ARCH_SAMD) -typedef volatile uint32_t BusIO_PortReg; -typedef uint32_t BusIO_PortMask; -#define BUSIO_USE_FAST_PINIO - -#elif (defined(__arm__) || defined(ARDUINO_FEATHER52)) && \ - !defined(ARDUINO_ARCH_MBED) && !defined(ARDUINO_ARCH_RP2040) && \ - !defined(ARDUINO_SILABS) && !defined(ARDUINO_UNOR4_MINIMA) && \ - !defined(ARDUINO_UNOR4_WIFI) -typedef volatile uint32_t BusIO_PortReg; -typedef uint32_t BusIO_PortMask; -#if !defined(__ASR6501__) && !defined(__ASR6502__) -#define BUSIO_USE_FAST_PINIO -#endif - -#else -#undef BUSIO_USE_FAST_PINIO -#endif - -/**! The class which defines how we will talk to this device over SPI **/ -class Adafruit_SPIDevice { -public: -#ifdef BUSIO_HAS_HW_SPI - Adafruit_SPIDevice(int8_t cspin, uint32_t freq = 1000000, - BusIOBitOrder dataOrder = SPI_BITORDER_MSBFIRST, - uint8_t dataMode = SPI_MODE0, SPIClass *theSPI = &SPI); -#else - Adafruit_SPIDevice(int8_t cspin, uint32_t freq = 1000000, - BusIOBitOrder dataOrder = SPI_BITORDER_MSBFIRST, - uint8_t dataMode = SPI_MODE0, SPIClass *theSPI = nullptr); -#endif - Adafruit_SPIDevice(int8_t cspin, int8_t sck, int8_t miso, int8_t mosi, - uint32_t freq = 1000000, - BusIOBitOrder dataOrder = SPI_BITORDER_MSBFIRST, - uint8_t dataMode = SPI_MODE0); - ~Adafruit_SPIDevice(); - - bool begin(void); - bool read(uint8_t *buffer, size_t len, uint8_t sendvalue = 0xFF); - bool write(const uint8_t *buffer, size_t len, - const uint8_t *prefix_buffer = nullptr, size_t prefix_len = 0); - bool write_then_read(const uint8_t *write_buffer, size_t write_len, - uint8_t *read_buffer, size_t read_len, - uint8_t sendvalue = 0xFF); - bool write_and_read(uint8_t *buffer, size_t len); - - uint8_t transfer(uint8_t send); - void transfer(uint8_t *buffer, size_t len); - void beginTransaction(void); - void endTransaction(void); - void beginTransactionWithAssertingCS(); - void endTransactionWithDeassertingCS(); - -private: -#ifdef BUSIO_HAS_HW_SPI - SPIClass *_spi = nullptr; - SPISettings *_spiSetting = nullptr; -#else - uint8_t *_spi = nullptr; - uint8_t *_spiSetting = nullptr; -#endif - uint32_t _freq; - BusIOBitOrder _dataOrder; - uint8_t _dataMode; - void setChipSelect(int value); - - int8_t _cs, _sck, _mosi, _miso; -#ifdef BUSIO_USE_FAST_PINIO - BusIO_PortReg *mosiPort, *clkPort, *misoPort, *csPort; - BusIO_PortMask mosiPinMask, misoPinMask, clkPinMask, csPinMask; -#endif - bool _begun; -}; - -#endif // Adafruit_SPIDevice_h diff --git a/src/modules/wifi/wardriving.cpp b/src/modules/wifi/wardriving.cpp index ef60efd9..775be914 100644 --- a/src/modules/wifi/wardriving.cpp +++ b/src/modules/wifi/wardriving.cpp @@ -14,6 +14,7 @@ #include "core/sd_functions.h" #define MAX_WAIT 5000 +#define CURRENT_YEAR 2024 Wardriving::Wardriving() { @@ -89,6 +90,9 @@ void Wardriving::loop() { } else { padprintln("GPS location not updated"); dump_gps_data(); + + if (filename == "" && gps.date.year() >= CURRENT_YEAR && gps.date.year() < CURRENT_YEAR+5) + create_filename(); } } else { if (count > 5) { diff --git a/src/modules/wifi/wigle.cpp b/src/modules/wifi/wigle.cpp index 6a68dfe7..c6e51002 100644 --- a/src/modules/wifi/wigle.cpp +++ b/src/modules/wifi/wigle.cpp @@ -112,24 +112,84 @@ void Wigle::send_upload_headers(WiFiClientSecure &client, String filename, int f client.println(); } -bool Wigle::upload(FS *fs, String filepath) { +bool Wigle::upload(FS *fs, String filepath, bool auto_delete) { display_banner(); if (!fs || !get_user()) return false; dump_wigle_info(); - WiFiClientSecure client; - client.setInsecure(); - if (!client.connect(host, 443)){ - displayError("Wigle API connection failed"); + File file = fs->open(filepath); + if (!file) { + displayError("Failed to open Wigle file"); delay(1000); return false; } - File file = fs->open(filepath, FILE_READ); - if (!file) { - displayError("Failed to open Wigle file"); + if (!_upload_file(file, "Uploading...")) { + file.close(); + displayError("File upload error"); + delay(1000); + return false; + } + + file.close(); + if (auto_delete) fs->remove(filepath); + + displaySuccess("File upload success"); + delay(1000); + return true; +} + +bool Wigle::upload_all(FS *fs, String folder, bool auto_delete) { + Serial.println("Wigle upload all path: " + folder); + + display_banner(); + + File root = fs->open(folder); + if (!root || !root.isDirectory()) return false; + + if (!fs || !get_user()) return false; + + dump_wigle_info(); + int i = 1; + bool success; + + while (true) { + success = false; + + File file = root.openNextFile(); + if (!file) break; + String filename = file.name(); + String filepath = file.path(); + + if (!file.isDirectory() && filename.endsWith(".csv")) { + Serial.println("Uploading file to Wigle: " + filename); + + if (!_upload_file(file, "Uploading "+String(i)+"...")) { + file.close(); + displayError("File upload error"); + delay(1000); + return false; + } + i++; + success = true; + } + file.close(); + if (success && auto_delete) fs->remove(filepath); + } + + String plural = i > 2 ? "s" : ""; + displaySuccess(String(i-1) + " file"+plural+" uploaded"); + delay(1000); + return true; +} + +bool Wigle::_upload_file(File file, String upload_message) { + WiFiClientSecure client; + client.setInsecure(); + if (!client.connect(host, 443)){ + displayError("Wigle API connection failed"); delay(1000); return false; } @@ -150,7 +210,7 @@ bool Wigle::upload(FS *fs, String filepath) { file.read(cbuf, toread); client.write(cbuf, toread); percent = ((float)file.position() / (float)file.size()) * 100; - progressHandler(percent, 100, "Uploading..."); + progressHandler(percent, 100, upload_message); } client.println(); @@ -174,15 +234,6 @@ bool Wigle::upload(FS *fs, String filepath) { } client.stop(); - file.close(); - if (serverres.indexOf("\"success\":true") <= -1){ - displayError("File upload error"); - delay(1000); - return false; - } - - displaySuccess("File upload success"); - delay(1000); - return true; + return (serverres.indexOf("\"success\":true") > -1); } diff --git a/src/modules/wifi/wigle.h b/src/modules/wifi/wigle.h index 9ac129f3..8081b051 100644 --- a/src/modules/wifi/wigle.h +++ b/src/modules/wifi/wigle.h @@ -24,7 +24,8 @@ class Wigle { // Operations ///////////////////////////////////////////////////////////////////////////////////// bool get_user(void); - bool upload(FS *fs, String filepath); + bool upload(FS *fs, String filepath, bool auto_delete = true); + bool upload_all(FS *fs, String filepath, bool auto_delete = true); void send_upload_headers(WiFiClientSecure &client, String filename, int filesize, String boundary); void display_banner(void); void dump_wigle_info(void); @@ -35,6 +36,7 @@ class Wigle { const char* host = "api.wigle.net"; bool _check_token(void); + bool _upload_file(File file, String upload_message); }; #endif // WIGLE_H