2021-10-03 10:36:05 +00:00
|
|
|
/**
|
2022-01-05 16:10:18 +00:00
|
|
|
* @file furi_hal_rfid.h
|
2021-10-03 10:36:05 +00:00
|
|
|
* RFID HAL API
|
|
|
|
*/
|
|
|
|
|
2021-05-04 13:21:16 +00:00
|
|
|
#pragma once
|
2021-10-03 10:36:05 +00:00
|
|
|
|
2021-05-04 13:21:16 +00:00
|
|
|
#include <stdint.h>
|
2021-05-18 09:54:48 +00:00
|
|
|
#include <stdbool.h>
|
[FL-2529][FL-1628] New LF-RFID subsystem (#1601)
* Makefile: unit tests pack
* RFID: pulse joiner and its unit test
* Move pulse protocol helpers to appropriate place
* Drop pulse_joiner tests
* Generic protocol, protocols dictionary, unit test
* Protocol dict unit test
* iButton: protocols dictionary
* Lib: varint
* Lib: profiler
* Unit test: varint
* rfid: worker mockup
* LFRFID: em4100 unit test
* Storage: file_exist function
* rfid: fsk osc
* rfid: generic fsk demodulator
* rfid: protocol em4100
* rfid: protocol h10301
* rfid: protocol io prox xsf
* Unit test: rfid protocols
* rfid: new hal
* rfid: raw worker
* Unit test: fix error output
* rfid: worker
* rfid: plain c cli
* fw: migrate to scons
* lfrfid: full io prox support
* unit test: io prox protocol
* SubGHZ: move bit defines to source
* FSK oscillator: level duration compability
* libs: bit manipulation library
* lfrfid: ioprox protocol, use bit library and new level duration method of FSK ocillator
* bit lib: unit tests
* Bit lib: parity tests, remove every nth bit, copy bits
* Lfrfid: awid protocol
* bit lib: uint16 and uint32 getters, unit tests
* lfrfid: FDX-B read, draft version
* Minunit: better memeq assert
* bit lib: reverse, print, print regions
* Protocol dict: get protocol features, get protocol validate count
* lfrfid worker: improved read
* lfrfid raw worker: psk support
* Cli: rfid plain C cli
* protocol AWID: render
* protocol em4100: render
* protocol h10301: render
* protocol indala26: support every indala 26 scramble
* Protocol IO Prox: render
* Protocol FDX-B: advanced read
* lfrfid: remove unused test function
* lfrfid: fix os primitives
* bit lib: crc16 and unit tests
* FDX-B: save data
* lfrfid worker: increase stream size. Alloc raw worker only when needed.
* lfrfid: indala26 emulation
* lfrfid: prepare to write
* lfrfid: fdx-b emulation
* lfrfid: awid, ioprox write
* lfrfid: write t55xx w\o validation
* lfrfid: better t55xx block0 handling
* lfrfid: use new t5577 functions in worker
* lfrfid: improve protocol description
* lfrfid: write and verify
* lfrfid: delete cpp cli
* lfrfid: improve worker usage
* lfrfid-app: step to new worker
* lfrfid: old indala (I40134) load fallback
* lfrfid: indala26, recover wrong synced data
* lfrfid: remove old worker
* lfrfid app: dummy read screen
* lfrfid app: less dummy read screen
* lfrfid: generic 96-bit HID protocol (covers up to HID 37-bit)
* rename
* lfrfid: improve indala26 read
* lfrfid: generic 192-bit HID protocol (covers all HID extended)
* lfrfid: TODO about HID render
* lfrfid: new protocol FDX-A
* lfrfid-app: correct worker stop on exit
* misc fixes
* lfrfid: FDX-A and HID distinguishability has been fixed.
* lfrfid: decode HID size header and render it (#1612)
* lfrfid: rename HID96 and HID192 to HIDProx and HIDExt
* lfrfid: extra actions scene
* lfrfid: decode generic HID Proximity size lazily (#1618)
* lib: stream of data buffers concept
* lfrfid: raw file helper
* lfrfid: changed raw worker api
* lfrfid: packed varint pair
* lfrfid: read stream speedup
* lfrfid app: show read mode
* Documentation
* lfrfid app: raw read gui
* lfrfid app: storage check for raw read
* memleak fix
* review fixes
* lfrfid app: read blink color
* lfrfid app: reset key name after read
* review fixes
* lfrfid app: fix copypasted text
* review fixes
* lfrfid: disable debug gpio
* lfrfid: card detection events
* lfrfid: change validation color from magenta to green
* Update core_defines.
* lfrfid: prefix fdx-b id by zeroes
* lfrfid: parse up to 43-bit HID Proximity keys (#1640)
* Fbt: downgrade toolchain and fix PS1
* lfrfid: fix unit tests
* lfrfid app: remove printf
* lfrfid: indala26, use bit 55 as data
* lfrfid: indala26, better brief format
* lfrfid: indala26, loading fallback
* lfrfid: read timing tuning
Co-authored-by: James Ide <ide@users.noreply.github.com>
Co-authored-by: あく <alleteam@gmail.com>
2022-08-23 15:57:39 +00:00
|
|
|
#include <stddef.h>
|
2021-05-04 13:21:16 +00:00
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2021-10-03 10:36:05 +00:00
|
|
|
/** Initialize RFID subsystem
|
|
|
|
*/
|
2021-09-10 02:19:02 +00:00
|
|
|
void furi_hal_rfid_init();
|
|
|
|
|
2021-10-03 10:36:05 +00:00
|
|
|
/** Config rfid pins to reset state
|
2021-05-04 13:21:16 +00:00
|
|
|
*/
|
2021-08-08 18:03:25 +00:00
|
|
|
void furi_hal_rfid_pins_reset();
|
2021-05-04 13:21:16 +00:00
|
|
|
|
2021-12-12 11:03:39 +00:00
|
|
|
/** Release rfid pull pin
|
|
|
|
*/
|
|
|
|
void furi_hal_rfid_pin_pull_release();
|
|
|
|
|
|
|
|
/** Pulldown rfid pull pin
|
|
|
|
*/
|
|
|
|
void furi_hal_rfid_pin_pull_pulldown();
|
|
|
|
|
2023-05-29 16:05:57 +00:00
|
|
|
/** Start read timer
|
2021-10-03 10:36:05 +00:00
|
|
|
* @param freq timer frequency
|
|
|
|
* @param duty_cycle timer duty cycle, 0.0-1.0
|
2021-05-04 13:21:16 +00:00
|
|
|
*/
|
2023-05-29 16:05:57 +00:00
|
|
|
void furi_hal_rfid_tim_read_start(float freq, float duty_cycle);
|
2021-05-04 13:21:16 +00:00
|
|
|
|
2023-05-29 16:05:57 +00:00
|
|
|
/** Pause read timer, to be able to continue later
|
2021-05-04 13:21:16 +00:00
|
|
|
*/
|
2023-05-29 16:05:57 +00:00
|
|
|
void furi_hal_rfid_tim_read_pause();
|
2021-05-04 13:21:16 +00:00
|
|
|
|
2023-05-29 16:05:57 +00:00
|
|
|
/** Continue read timer
|
2021-05-04 13:21:16 +00:00
|
|
|
*/
|
2023-05-29 16:05:57 +00:00
|
|
|
void furi_hal_rfid_tim_read_continue();
|
2021-05-04 13:21:16 +00:00
|
|
|
|
2023-05-29 16:05:57 +00:00
|
|
|
/** Stop read timer
|
2021-05-04 13:21:16 +00:00
|
|
|
*/
|
2023-05-29 16:05:57 +00:00
|
|
|
void furi_hal_rfid_tim_read_stop();
|
2021-05-04 13:21:16 +00:00
|
|
|
|
[FL-2529][FL-1628] New LF-RFID subsystem (#1601)
* Makefile: unit tests pack
* RFID: pulse joiner and its unit test
* Move pulse protocol helpers to appropriate place
* Drop pulse_joiner tests
* Generic protocol, protocols dictionary, unit test
* Protocol dict unit test
* iButton: protocols dictionary
* Lib: varint
* Lib: profiler
* Unit test: varint
* rfid: worker mockup
* LFRFID: em4100 unit test
* Storage: file_exist function
* rfid: fsk osc
* rfid: generic fsk demodulator
* rfid: protocol em4100
* rfid: protocol h10301
* rfid: protocol io prox xsf
* Unit test: rfid protocols
* rfid: new hal
* rfid: raw worker
* Unit test: fix error output
* rfid: worker
* rfid: plain c cli
* fw: migrate to scons
* lfrfid: full io prox support
* unit test: io prox protocol
* SubGHZ: move bit defines to source
* FSK oscillator: level duration compability
* libs: bit manipulation library
* lfrfid: ioprox protocol, use bit library and new level duration method of FSK ocillator
* bit lib: unit tests
* Bit lib: parity tests, remove every nth bit, copy bits
* Lfrfid: awid protocol
* bit lib: uint16 and uint32 getters, unit tests
* lfrfid: FDX-B read, draft version
* Minunit: better memeq assert
* bit lib: reverse, print, print regions
* Protocol dict: get protocol features, get protocol validate count
* lfrfid worker: improved read
* lfrfid raw worker: psk support
* Cli: rfid plain C cli
* protocol AWID: render
* protocol em4100: render
* protocol h10301: render
* protocol indala26: support every indala 26 scramble
* Protocol IO Prox: render
* Protocol FDX-B: advanced read
* lfrfid: remove unused test function
* lfrfid: fix os primitives
* bit lib: crc16 and unit tests
* FDX-B: save data
* lfrfid worker: increase stream size. Alloc raw worker only when needed.
* lfrfid: indala26 emulation
* lfrfid: prepare to write
* lfrfid: fdx-b emulation
* lfrfid: awid, ioprox write
* lfrfid: write t55xx w\o validation
* lfrfid: better t55xx block0 handling
* lfrfid: use new t5577 functions in worker
* lfrfid: improve protocol description
* lfrfid: write and verify
* lfrfid: delete cpp cli
* lfrfid: improve worker usage
* lfrfid-app: step to new worker
* lfrfid: old indala (I40134) load fallback
* lfrfid: indala26, recover wrong synced data
* lfrfid: remove old worker
* lfrfid app: dummy read screen
* lfrfid app: less dummy read screen
* lfrfid: generic 96-bit HID protocol (covers up to HID 37-bit)
* rename
* lfrfid: improve indala26 read
* lfrfid: generic 192-bit HID protocol (covers all HID extended)
* lfrfid: TODO about HID render
* lfrfid: new protocol FDX-A
* lfrfid-app: correct worker stop on exit
* misc fixes
* lfrfid: FDX-A and HID distinguishability has been fixed.
* lfrfid: decode HID size header and render it (#1612)
* lfrfid: rename HID96 and HID192 to HIDProx and HIDExt
* lfrfid: extra actions scene
* lfrfid: decode generic HID Proximity size lazily (#1618)
* lib: stream of data buffers concept
* lfrfid: raw file helper
* lfrfid: changed raw worker api
* lfrfid: packed varint pair
* lfrfid: read stream speedup
* lfrfid app: show read mode
* Documentation
* lfrfid app: raw read gui
* lfrfid app: storage check for raw read
* memleak fix
* review fixes
* lfrfid app: read blink color
* lfrfid app: reset key name after read
* review fixes
* lfrfid app: fix copypasted text
* review fixes
* lfrfid: disable debug gpio
* lfrfid: card detection events
* lfrfid: change validation color from magenta to green
* Update core_defines.
* lfrfid: prefix fdx-b id by zeroes
* lfrfid: parse up to 43-bit HID Proximity keys (#1640)
* Fbt: downgrade toolchain and fix PS1
* lfrfid: fix unit tests
* lfrfid app: remove printf
* lfrfid: indala26, use bit 55 as data
* lfrfid: indala26, better brief format
* lfrfid: indala26, loading fallback
* lfrfid: read timing tuning
Co-authored-by: James Ide <ide@users.noreply.github.com>
Co-authored-by: あく <alleteam@gmail.com>
2022-08-23 15:57:39 +00:00
|
|
|
typedef void (*FuriHalRfidReadCaptureCallback)(bool level, uint32_t duration, void* context);
|
|
|
|
|
|
|
|
void furi_hal_rfid_tim_read_capture_start(FuriHalRfidReadCaptureCallback callback, void* context);
|
|
|
|
|
|
|
|
void furi_hal_rfid_tim_read_capture_stop();
|
|
|
|
|
|
|
|
typedef void (*FuriHalRfidDMACallback)(bool half, void* context);
|
|
|
|
|
|
|
|
void furi_hal_rfid_tim_emulate_dma_start(
|
|
|
|
uint32_t* duration,
|
|
|
|
uint32_t* pulse,
|
|
|
|
size_t length,
|
|
|
|
FuriHalRfidDMACallback callback,
|
|
|
|
void* context);
|
|
|
|
|
|
|
|
void furi_hal_rfid_tim_emulate_dma_stop();
|
|
|
|
|
2021-10-03 10:36:05 +00:00
|
|
|
/** Set read timer period
|
|
|
|
*
|
|
|
|
* @param period overall duration
|
2021-06-28 14:42:30 +00:00
|
|
|
*/
|
2021-08-08 18:03:25 +00:00
|
|
|
void furi_hal_rfid_set_read_period(uint32_t period);
|
2021-06-28 14:42:30 +00:00
|
|
|
|
2021-10-03 10:36:05 +00:00
|
|
|
/** Set read timer pulse
|
|
|
|
*
|
|
|
|
* @param pulse duration of high level
|
2021-06-28 14:42:30 +00:00
|
|
|
*/
|
2021-08-08 18:03:25 +00:00
|
|
|
void furi_hal_rfid_set_read_pulse(uint32_t pulse);
|
2021-06-28 14:42:30 +00:00
|
|
|
|
2022-03-23 17:59:20 +00:00
|
|
|
/** Start/Enable comparator */
|
|
|
|
void furi_hal_rfid_comp_start();
|
|
|
|
|
|
|
|
/** Stop/Disable comparator */
|
|
|
|
void furi_hal_rfid_comp_stop();
|
|
|
|
|
|
|
|
typedef void (*FuriHalRfidCompCallback)(bool level, void* context);
|
|
|
|
|
|
|
|
/** Set comparator callback */
|
|
|
|
void furi_hal_rfid_comp_set_callback(FuriHalRfidCompCallback callback, void* context);
|
|
|
|
|
2023-06-28 09:05:48 +00:00
|
|
|
/** Start/Enable Field Presence detect */
|
|
|
|
void furi_hal_rfid_field_detect_start();
|
|
|
|
|
|
|
|
/** Stop/Disable Field Presence detect */
|
|
|
|
void furi_hal_rfid_field_detect_stop();
|
|
|
|
|
|
|
|
/** Check Field Presence
|
|
|
|
*
|
|
|
|
* @param[out] frequency pointer to frequency value to be set if filed detected
|
|
|
|
*
|
|
|
|
* @return true if field is present, false if not
|
|
|
|
*/
|
|
|
|
bool furi_hal_rfid_field_is_present(uint32_t* frequency);
|
|
|
|
|
2021-05-04 13:21:16 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
2022-03-23 17:59:20 +00:00
|
|
|
#endif
|