furi_hal_nfc.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define FURI_HAL_NFC_CARRIER_HZ (13560000UL)
 
#define FURI_HAL_NFC_EVENT_WAIT_FOREVER (0xFFFFFFFFU)
 
typedef enum {
    FuriHalNfcEventOscOn = (1U << 0), 
    FuriHalNfcEventFieldOn = (1U << 1), 
    FuriHalNfcEventFieldOff = (1U << 2), 
    FuriHalNfcEventListenerActive = (1U << 3), 
    FuriHalNfcEventTxStart = (1U << 4), 
    FuriHalNfcEventTxEnd = (1U << 5), 
    FuriHalNfcEventRxStart = (1U << 6), 
    FuriHalNfcEventRxEnd = (1U << 7), 
    FuriHalNfcEventCollision = (1U << 8), 
    FuriHalNfcEventTimerFwtExpired = (1U << 9), 
    FuriHalNfcEventTimerBlockTxExpired = (1U << 10), 
    FuriHalNfcEventTimeout =
        (1U << 11), 
    FuriHalNfcEventAbortRequest =
        (1U << 12), 
} FuriHalNfcEvent;
 
typedef enum {
    FuriHalNfcErrorNone, 
    FuriHalNfcErrorBusy, 
    FuriHalNfcErrorCommunication, 
    FuriHalNfcErrorOscillator, 
    FuriHalNfcErrorCommunicationTimeout, 
    FuriHalNfcErrorBufferOverflow, 
    FuriHalNfcErrorIncompleteFrame, 
    FuriHalNfcErrorDataFormat, 
} FuriHalNfcError;
 
typedef enum {
    FuriHalNfcModePoller, 
    FuriHalNfcModeListener, 
    FuriHalNfcModeNum, 
} FuriHalNfcMode;
 
typedef enum {
    FuriHalNfcTechIso14443a, 
    FuriHalNfcTechIso14443b, 
    FuriHalNfcTechIso15693, 
    FuriHalNfcTechFelica, 
    FuriHalNfcTechNum, 
    FuriHalNfcTechInvalid, 
} FuriHalNfcTech;
 
FuriHalNfcError furi_hal_nfc_init(void);
 
FuriHalNfcError furi_hal_nfc_is_hal_ready(void);
 
FuriHalNfcError furi_hal_nfc_acquire(void);
 
FuriHalNfcError furi_hal_nfc_release(void);
 
FuriHalNfcError furi_hal_nfc_low_power_mode_start(void);
 
FuriHalNfcError furi_hal_nfc_low_power_mode_stop(void);
 
FuriHalNfcError furi_hal_nfc_set_mode(FuriHalNfcMode mode, FuriHalNfcTech tech);
 
FuriHalNfcError furi_hal_nfc_reset_mode(void);
 
FuriHalNfcError furi_hal_nfc_field_detect_start(void);
 
FuriHalNfcError furi_hal_nfc_field_detect_stop(void);
 
bool furi_hal_nfc_field_is_present(void);
 
FuriHalNfcError furi_hal_nfc_poller_field_on(void);
 
FuriHalNfcEvent furi_hal_nfc_poller_wait_event(uint32_t timeout_ms);
 
FuriHalNfcEvent furi_hal_nfc_listener_wait_event(uint32_t timeout_ms);
 
FuriHalNfcError furi_hal_nfc_poller_tx(const uint8_t* tx_data, size_t tx_bits);
 
FuriHalNfcError furi_hal_nfc_poller_rx(uint8_t* rx_data, size_t rx_data_size, size_t* rx_bits);
 
FuriHalNfcError furi_hal_nfc_listener_tx(const uint8_t* tx_data, size_t tx_bits);
 
FuriHalNfcError furi_hal_nfc_listener_rx(uint8_t* rx_data, size_t rx_data_size, size_t* rx_bits);
 
FuriHalNfcError furi_hal_nfc_listener_sleep(void);
 
FuriHalNfcError furi_hal_nfc_listener_idle(void);
 
FuriHalNfcError furi_hal_nfc_listener_enable_rx(void);
 
FuriHalNfcError furi_hal_nfc_trx_reset(void);
 
FuriHalNfcError furi_hal_nfc_event_start(void);
 
FuriHalNfcError furi_hal_nfc_event_stop(void);
 
FuriHalNfcError furi_hal_nfc_abort(void);
 
void furi_hal_nfc_timer_fwt_start(uint32_t time_fc);
 
void furi_hal_nfc_timer_fwt_stop(void);
 
void furi_hal_nfc_timer_block_tx_start(uint32_t time_fc);
 
void furi_hal_nfc_timer_block_tx_start_us(uint32_t time_us);
 
void furi_hal_nfc_timer_block_tx_stop(void);
 
bool furi_hal_nfc_timer_block_tx_is_running(void);
 
/*
 * Technology-specific functions.
 *
 * In a perfect world, this would not be necessary.
 * However, the current implementation employs NFC hardware that partially implements
 * certain protocols (e.g. ISO14443-3A), thus requiring methods to access such features.
 */
 
/******************* Iso14443a specific API *******************/
 
typedef enum {
    FuriHalNfcaShortFrameAllReq,
    FuriHalNfcaShortFrameSensReq,
} FuriHalNfcaShortFrame;
 
FuriHalNfcError furi_hal_nfc_iso14443a_poller_trx_short_frame(FuriHalNfcaShortFrame frame);
 
FuriHalNfcError furi_hal_nfc_iso14443a_tx_sdd_frame(const uint8_t* tx_data, size_t tx_bits);
 
FuriHalNfcError
    furi_hal_nfc_iso14443a_rx_sdd_frame(uint8_t* rx_data, size_t rx_data_size, size_t* rx_bits);
 
FuriHalNfcError
    furi_hal_nfc_iso14443a_poller_tx_custom_parity(const uint8_t* tx_data, size_t tx_bits);
 
FuriHalNfcError furi_hal_nfc_iso14443a_listener_set_col_res_data(
    uint8_t* uid,
    uint8_t uid_len,
    uint8_t* atqa,
    uint8_t sak);
 
FuriHalNfcError furi_hal_nfc_iso14443a_listener_tx_custom_parity(
    const uint8_t* tx_data,
    const uint8_t* tx_parity,
    size_t tx_bits);
 
FuriHalNfcError furi_hal_nfc_iso15693_listener_tx_sof(void);
 
FuriHalNfcError furi_hal_nfc_felica_listener_set_sensf_res_data(
    const uint8_t* idm,
    const uint8_t idm_len,
    const uint8_t* pmm,
    const uint8_t pmm_len,
    const uint16_t sys_code);
 
#ifdef __cplusplus
}
#endif