Mbed OS Reference
Loading...
Searching...
No Matches
NFCControllerDriver Class Referenceabstract

The abstraction for a NFC controller driver. More...

#include <NFCControllerDriver.h>

Inheritance diagram for NFCControllerDriver:
PN512Driver

Data Structures

struct  Delegate
 The NFCControllerDriver delegate. More...
 

Public Member Functions

 NFCControllerDriver ()
 Instantiate a NFCControllerDriver. More...
 
virtual ~NFCControllerDriver ()
 NFCControllerDriver destructor. More...
 
virtual nfc_transceiver_tinitialize (nfc_scheduler_timer_t *scheduler_timer)=0
 Initialize the driver and retrieve the interface to the controller. More...
 
virtual void get_supported_nfc_techs (nfc_tech_t *initiator, nfc_tech_t *target) const =0
 Retrieve list of technologies supported by the controller. More...
 
void set_delegate (Delegate *delegate)
 Set this instance's delegate. More...
 

Protected Member Functions

void hw_interrupt ()
 An implementation must call this function (can be called from interrupt context) when the controller asserts its interrupt line. More...
 

Detailed Description

The abstraction for a NFC controller driver.

Implementers need to derive from this class and implement its methods.

Definition at line 40 of file NFCControllerDriver.h.

Constructor & Destructor Documentation

◆ NFCControllerDriver()

◆ ~NFCControllerDriver()

virtual ~NFCControllerDriver ( )
virtual

NFCControllerDriver destructor.

Member Function Documentation

◆ initialize()

virtual nfc_transceiver_t * initialize ( nfc_scheduler_timer_t *  scheduler_timer)
pure virtual

Initialize the driver and retrieve the interface to the controller.

Parameters
[in]scheduler_timera timer to initialize the controller's scheduler instance with
Returns
an initialized MicroNFC nfc_transceiver_t instance

Implemented in PN512Driver.

◆ get_supported_nfc_techs()

virtual void get_supported_nfc_techs ( nfc_tech_t initiator,
nfc_tech_t target 
) const
pure virtual

Retrieve list of technologies supported by the controller.

Parameters
[out]initiatorbitmask of technologies supported when the controller is in initiator mode
[out]targetbitmask of technologies supported when the controller is in target mode

Implemented in PN512Driver.

◆ set_delegate()

void set_delegate ( Delegate delegate)

Set this instance's delegate.

Parameters
[in]delegatethe delegate instance to use

◆ hw_interrupt()

void hw_interrupt ( )
protected

An implementation must call this function (can be called from interrupt context) when the controller asserts its interrupt line.