nfc_layer.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_NFC_NFC_LAYER_NFC_LAYER_HPP
#define M5_UNIT_NFC_NFC_LAYER_NFC_LAYER_HPP
 
#include "nfc/nfc.hpp"
 
namespace m5 {
namespace nfc {
 
namespace isodep {
class IsoDEP;
}
 
class NFCLayerInterface {
public:
    virtual ~NFCLayerInterface() = default;
 
    virtual m5::nfc::NFCForumTag supportsNFCTag() const
    {
        return m5::nfc::NFCForumTag::None;
    }
    virtual file_system_feature_t supportsFilesystem() const
    {
        return file_system_feature_t(0);
    }
    virtual m5::nfc::isodep::IsoDEP* isoDEP()
    {
        return nullptr;
    }
    virtual uint16_t maximum_fifo_depth() const = 0;
 
    virtual bool transceive(uint8_t* rx, uint16_t& rx_len, const uint8_t* tx, const uint16_t tx_len,
                            const uint32_t timeout_ms)
    {
        return false;
    }
 
    virtual bool transmit(const uint8_t* tx, const uint16_t tx_len, const uint32_t timeout_ms)
    {
        return false;
    }
    virtual bool receive(uint8_t* rx, uint16_t& rx_len, const uint32_t timeout_ms)
    {
        return false;
    }
 
    virtual bool read(uint8_t* rx, uint16_t& rx_len, const uint16_t saddr) = 0;
    virtual bool write(const uint16_t saddr, const uint8_t* tx, const uint16_t tx_len) = 0;
 
    virtual uint16_t first_user_block() const = 0;
    virtual uint16_t last_user_block() const = 0;
    virtual uint16_t user_area_size() const = 0;
    virtual uint16_t unit_size_read() const = 0;
    virtual uint16_t unit_size_write() const = 0;
 
    virtual uint8_t maximum_read_blocks() const
    {
        return 0;
    }
    virtual uint8_t maximum_write_blocks() const
    {
        return 0;
    }
};
 
}  // namespace nfc
}  // namespace m5
#endif