nfcv.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_UNIFIED_NFC_NFC_V_NFCV_HPP
#define M5_UNIT_UNIFIED_NFC_NFC_V_NFCV_HPP
 
#include "nfc/nfc.hpp"
#include <cstdint>
#include <string>
#include <cstring>
#include <vector>
 
namespace m5 {
namespace nfc {
namespace v {
 
enum class Type : uint8_t {
    Unknown,  
 
    NXP_ICODE_SLI,     
    NXP_ICODE_SLIX,    
    NXP_ICODE_SLIX_2,  
    NXP,               
 
    TI_TAGIT_2048,       
    TI_TAGIT_HF_I,       
    TI_TAGIT_HF_I_Plus,  
    TI_TAGIT_HF_I_Pro,   
    TI,                  
 
    ST_LRI,     
    ST_ST25V,   
    ST_ST25DV,  
    ST,         
 
    Fujitsu_FRAM,  
    Fujitsu,       
 
    Unclassified,  
};
 
const uint8_t option_flag{0x40};
const uint8_t address_flag{0x20};
const uint8_t select_flag{0x10};
const uint8_t inventory_flag{0x04};
const uint8_t data_rate_flag{0x02};
const uint8_t subcarrier_flag{0x01};
const uint8_t nb_slots_flag{0x20};  // if inventory_flag is 1
const uint8_t AFI_flag{0x10};       // // if inventory_flag is 1
constexpr uint8_t MAX_BLOCK_SIZE{32};
 
enum class ModulationMode : uint8_t {
    OneOf4,    
    OneOf256,  
};
 
inline m5::nfc::NFCForumTag get_nfc_forum_tag_type(const Type t)
{
    return (t != Type::Unknown) ? NFCForumTag::Type5 : NFCForumTag::None;
}
 
struct PICC {
    uint8_t uid[8]{};      
    Type type{};           
    uint8_t dsfID{};       
    uint8_t afi{};         
    uint8_t icRef{};       
    uint8_t block_size{};  
    uint8_t _pad{};        //
    uint16_t blocks{};     
 
    inline bool valid() const
    {
        return (uid[0] == 0xE0) && blocks && block_size;
    }
    inline uint8_t manufacturerCode() const
    {
        return valid() ? uid[1] : 0xFF;
    }
    inline uint8_t icIdentifier() const
    {
        return valid() ? uid[2] : 0x00;
    }
    inline uint8_t icReference() const
    {
        return valid() ? icRef : 0xFF;
    }
 
    inline uint16_t totalSize() const
    {
        return blocks * block_size;
    }
    inline uint16_t userAreaSize() const
    {
        return totalSize();  // Same as totalSize
    }
    inline NFCForumTag nfcForumTagType() const
    {
        return get_nfc_forum_tag_type(type);
    }
 
    inline uint16_t firstUserBlock() const
    {
        return valid() ? 0 : 0xFFFF;
    }
    inline uint16_t lastUserBlock() const
    {
        return valid() ? (blocks - 1) : 0xFFFF;
    }
 
    std::string uidAsString() const;
    std::string typeAsString() const;
};
 
inline bool operator==(const PICC& a, const PICC& b)
{
    return std::memcmp(a.uid, b.uid, 8) == 0;
}
inline bool operator!=(const PICC& a, const PICC& b)
{
    return !(a == b);
}
 
Type identify_type(const PICC& picc);
 
enum class Command : uint8_t {
    Inventory                = 0x01,  
    StayQuiet                = 0x02,  
    Select                   = 0x25,  
    ResetToReady             = 0x26,  
    GetSystemInformaion      = 0x2B,  
    GetSystemInformation     = 0x2B,  
    ExtendedGetSystemInfo    = 0x3B,  
    ReadSingleBlock          = 0x20,  
    ExtendedReadSingleBlock  = 0x30,  
    WriteSingleBlock         = 0x21,  
    ExtendedWriteSingleBlock = 0x31,  
};
 
constexpr uint32_t TIMEOUT_INVENTORY{16};
constexpr uint32_t TIMEOUT_STAY_QUIET{16};
constexpr uint32_t TIMEOUT_SELECT{16};
constexpr uint32_t TIMEOUT_RESET_TO_READY{16};
constexpr uint32_t TIMEOUT_GET_SYSTEM_INFORMATION{20};
constexpr uint32_t TIMEOUT_READ_SINGLE_BLOCK{20};
constexpr uint32_t TIMEOUT_WRITE_SINGLE_BLOCK{30};
 
uint32_t encode_VCD(std::vector<uint8_t>& out, const ModulationMode mode, const uint8_t* buffer, const uint32_t length,
                    const bool high_rate = true, const bool add_crc = true);
 
bool decode_VICC(std::vector<uint8_t>& out, const uint8_t* buffer, const uint32_t length,
                 const uint32_t ignore_bits = 16);
 
}  // namespace v
}  // namespace nfc
}  // namespace m5
#endif