M5Unit-NFC 0.0.3 git rev:59f5362
Loading...
Searching...
No Matches
emulation_layer_f.hpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
3 *
4 * SPDX-License-Identifier: MIT
5 */
17#ifndef M5_UNIT_NFC_NFC_LAYER_F_EMULATION_LAYER_F_HPP
18#define M5_UNIT_NFC_NFC_LAYER_F_EMULATION_LAYER_F_HPP
19
20#include "nfc/f/nfcf.hpp"
21#include <vector>
22#include <memory>
23
24namespace m5 {
25
26namespace unit {
27class UnitST25R3916;
28class CapST25R3916;
29} // namespace unit
30
31namespace nfc {
32
38public:
43 enum class State { None, Off, Communicated, Selected };
44
45 struct Adapter;
50
52 inline State state() const
53 {
54 return _state;
55 }
57 inline const m5::nfc::f::PICC& emulatePICC() const
58 {
59 return _picc;
60 }
62 inline uint32_t expiredTime() const
63 {
64 return _expired_ms;
65 }
67 void setExpiredTime(const uint32_t ms)
68 {
69 _expired_ms = ms;
70 }
71
73 bool begin(const m5::nfc::f::PICC& picc, uint8_t* ptr, const uint32_t size);
75 bool end();
77 void update();
78
79 virtual State receive_callback(const State s, const uint8_t* rx, const uint32_t rx_len);
80
81protected:
82 void update_expired();
83
84private:
85 void update_off();
86 void update_communicated();
87 void update_selected();
88
89protected:
90 uint8_t* _memory{};
91 uint32_t _memory_size{};
92
93private:
94 State _state{}, _prev{};
95 uint32_t _expired_ms{60 * 1000u};
96 unsigned int _expired_at{};
97 std::unique_ptr<Adapter> _impl;
98 m5::nfc::f::PICC _picc{};
99};
100
102// Impl for units
103struct EmulationLayerF::Adapter {
104 virtual ~Adapter() = default;
105
106 virtual bool start_emulation(const m5::nfc::f::PICC& picc) = 0;
107 virtual bool stop_emulation() = 0;
108 virtual bool transmit(const uint8_t* tx, const uint16_t tx_len, const uint32_t timeout_ms) = 0;
109
110 virtual EmulationLayerF::State update_off() = 0;
111 virtual EmulationLayerF::State update_communicated() = 0;
112 virtual EmulationLayerF::State update_selected() = 0;
113};
115
116} // namespace nfc
117} // namespace m5
118#endif
Common interface layer for each chip of the NFC-F emulation.
Definition emulation_layer_f.hpp:37
void setExpiredTime(const uint32_t ms)
Sets the expiration time (ms)
Definition emulation_layer_f.hpp:67
State state() const
Gets the current emulation state.
Definition emulation_layer_f.hpp:52
const m5::nfc::f::PICC & emulatePICC() const
Gets the emulated PICC information.
Definition emulation_layer_f.hpp:57
State
Emulation state for NFC-F.
Definition emulation_layer_f.hpp:43
bool end()
End NFC-F emulation.
Definition emulation_layer_f.cpp:101
bool begin(const m5::nfc::f::PICC &picc, uint8_t *ptr, const uint32_t size)
Begin NFC-F emulation.
Definition emulation_layer_f.cpp:68
uint32_t expiredTime() const
Gets the expiration time (ms)
Definition emulation_layer_f.hpp:62
void update()
Update emulation state machine.
Definition emulation_layer_f.cpp:110
ST25R3916 unit in CapCC1101 (SPI)
Definition unit_ST25R3916.hpp:2062
ST25R3916 Unit.
Definition unit_ST25R3916.hpp:38
Top level namespace of M5stack.
NFC related definitions.
Unit-related namespace.
NFC-F definitions.
PICC information for NFC-F.
Definition nfcf.hpp:381