nfcb.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_B_NFCB_HPP
#define M5_UNIT_UNIFIED_NFC_NFC_B_NFCB_HPP
 
#include "nfc/nfc.hpp"
#include <cstdint>
#include <string>
#include <cstring>
 
namespace m5 {
namespace nfc {
namespace b {
 
enum class Type : uint8_t {
    Unknown,       
    Unclassified,  
};
 
enum class Require : uint8_t {
    Slot1,
    Slot2,
    Slot4,
    Slot8,
    Slot16,
};
 
constexpr uint8_t ATQB_LENGTH{11};  
 
constexpr uint8_t COMMUNICATION_SAME_SPEED{0x80};
// Correct spelling
constexpr uint8_t COMMUNICATION_SPEED_106K{0X00};
constexpr uint8_t COMMUNICATION_SPEED_212K_FROM_PICC{0X10};
constexpr uint8_t COMMUNICATION_SPEED_424K_FROM_PICC{0X20};
constexpr uint8_t COMMUNICATION_SPEED_847K_FROM_PICC{0X40};
constexpr uint8_t COMMUNICATION_SPEED_212K_TO_PICC{0X01};
constexpr uint8_t COMMUNICATION_SPEED_424K_TO_PICC{0X02};
constexpr uint8_t COMMUNICATION_SPEED_847K_TO_PICC{0X04};
// @deprecated typo aliases; use COMMUNICATION_SPEED_*
constexpr uint8_t COMMUNICATION_SPPED_106K{COMMUNICATION_SPEED_106K};
constexpr uint8_t COMMUNICATION_SPPED_212K_FROM_PICC{COMMUNICATION_SPEED_212K_FROM_PICC};
constexpr uint8_t COMMUNICATION_SPPED_424K_FROM_PICC{COMMUNICATION_SPEED_424K_FROM_PICC};
constexpr uint8_t COMMUNICATION_SPPED_847K_FROM_PICC{COMMUNICATION_SPEED_847K_FROM_PICC};
constexpr uint8_t COMMUNICATION_SPPED_212K_TO_PICC{COMMUNICATION_SPEED_212K_TO_PICC};
constexpr uint8_t COMMUNICATION_SPPED_424K_TO_PICC{COMMUNICATION_SPEED_424K_TO_PICC};
constexpr uint8_t COMMUNICATION_SPPED_847K_TO_PICC{COMMUNICATION_SPEED_847K_TO_PICC};
 
const uint8_t FRAME_OPTION_NAD{0x02};
const uint8_t FRAME_OPTION_CID{0x01};
 
 
uint16_t maximum_frame_length(const uint8_t protocol[3]);
 
inline uint8_t maximum_frame_length_bits(const uint8_t protocol[3])
{
    return protocol ? protocol[1] >> 4 : 0x0F;
}
 
inline bool supports_iso14443_4(const uint8_t protocol[3])
{
    return protocol ? ((protocol[1] & 0x0F) & 0x01) : false;
}
 
inline uint8_t get_frame_option(const uint8_t protocol[3])
{
    return protocol ? (protocol[2] & 0x03) : 0x00;
}
inline uint8_t get_fwi(const uint8_t protocol[3])
{
    return protocol ? ((protocol[2] >> 4) & 0x0F) : 0x0F /*RFU*/;
}
 
struct PICC {
    uint8_t uid[8]{};
    union {
        uint8_t atqb[ATQB_LENGTH]{};  
        struct {
            uint8_t pupi[4];         
            uint8_t application[4];  
            uint8_t protocol[3];     
            //            uint8_t cid[1];
        } __attribute__((packed));
    } __attribute__((packed));
    Type type{Type::Unknown};  
    uint8_t cid{};             
    uint8_t option{};
 
    inline bool valid() const
    {
        return isISO14443_4();
    }
 
    std::string pupiAsString() const;
    std::string typeAsString() const;
 
 
    inline bool isISO14443_4() const
    {
        return supports_iso14443_4(protocol);
    }
 
 
    inline bool supportsNAD() const
    {
        return get_frame_option(protocol) & FRAME_OPTION_NAD;
    }
    inline bool supportsCID() const
    {
        return get_frame_option(protocol) & FRAME_OPTION_CID;
    }
    inline uint16_t maximumFrameLength() const
    {
        return maximum_frame_length(protocol);
    }
    inline uint8_t maximumFrameLengthBits() const
    {
        return maximum_frame_length_bits(protocol);
    }
    inline uint8_t communicationSpeed() const
    {
        return protocol[0];
    }
    inline uint8_t fwi() const
    {
        return get_fwi(protocol);
    }
};
 
inline bool operator==(const PICC& a, const PICC& b)
{
    return std::memcmp(a.atqb, b.atqb, sizeof(a.atqb)) == 0;
}
inline bool operator!=(const PICC& a, const PICC& b)
{
    return !(a == b);
}
 
enum class Command : uint8_t {
    // ISO/IEC 14443B
    REQ_WUPB = 0x05,  
    ATTRIB   = 0x1D,  
    HLTB     = 0x50,  
    // ISO/IEC 14443-4
    DESELECT          = 0xC2,  
    DESELECT_WITH_CID = 0xCA,  
};
 
constexpr uint32_t TIMEOUT_REQ_WUP_B{5};
constexpr uint32_t TIMEOUT_ATTRIB{50};
constexpr uint32_t TIMEOUT_HLTB{5};
constexpr uint32_t TIMEOUT_DESELECT{5};
 
}  // namespace b
}  // namespace nfc
}  // namespace m5
#endif