Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

Core

Core

Error codes

typedef int nfc_err_t
 Type for NFC errors.

Scheduler

typedef struct __nfc_timer nfc_scheduler_timer_t
typedef struct __nfc_task nfc_task_t
typedef struct __scheduler nfc_scheduler_t
typedef void(* nfc_task_fn )(uint32_t events, void *pUserData)
void nfc_scheduler_timer_init (nfc_scheduler_timer_t *timer)
void nfc_scheduler_timer_start (nfc_scheduler_timer_t *timer)
uint32_t nfc_scheduler_timer_get (nfc_scheduler_timer_t *timer)
void nfc_scheduler_timer_stop (nfc_scheduler_timer_t *timer)
void nfc_scheduler_timer_reset (nfc_scheduler_timer_t *timer)
void nfc_scheduler_init (nfc_scheduler_t *pScheduler, nfc_scheduler_timer_t *pTimer)
 Init scheduler.
uint32_t nfc_scheduler_iteration (nfc_scheduler_t *pScheduler, uint32_t events)
 Iterate through all tasks.
void nfc_scheduler_queue_task (nfc_scheduler_t *pScheduler, nfc_task_t *pTask)
 Queue a task to execute.
void nfc_scheduler_dequeue_task (nfc_scheduler_t *pScheduler, bool abort, nfc_task_t *pTask)
 Remove a task to execute.
void task_init (nfc_task_t *pTask, uint32_t events, uint32_t timeout, nfc_task_fn fn, void *pUserData)
 Initialize task with the following parameters.

Typedef Documentation

typedef int nfc_err_t

Type for NFC errors.

Definition at line 59 of file nfc_errors.h.


Function Documentation

void nfc_scheduler_dequeue_task ( nfc_scheduler_t *  pScheduler,
bool  abort,
nfc_task_t *  pTask 
)

Remove a task to execute.

Parameters:
pSchedulerscheduler instance
pTasktask to remove
abortabort task if queued

Definition at line 148 of file nfc_scheduler.c.

void nfc_scheduler_init ( nfc_scheduler_t *  pScheduler,
nfc_scheduler_timer_t *  pTimer 
)

Init scheduler.

Parameters:
pSchedulerscheduler instance to init
pTimertimer instance

Definition at line 34 of file nfc_scheduler.c.

uint32_t nfc_scheduler_iteration ( nfc_scheduler_t *  pScheduler,
uint32_t  events 
)

Iterate through all tasks.

Parameters:
pSchedulerscheduler instance
eventsmask of events (except EVENT_TIMEOUT) that have been raised since this function last returned (0 on first call)
Returns:
time after which this function must be called again if no other event arises

Definition at line 45 of file nfc_scheduler.c.

void nfc_scheduler_queue_task ( nfc_scheduler_t *  pScheduler,
nfc_task_t *  pTask 
)

Queue a task to execute.

Parameters:
pSchedulerscheduler instance
pTasktask to queue

Definition at line 131 of file nfc_scheduler.c.

void task_init ( nfc_task_t *  pTask,
uint32_t  events,
uint32_t  timeout,
nfc_task_fn  fn,
void *  pUserData 
)

Initialize task with the following parameters.

Parameters:
pTasktask to initialize
eventsevents on which to call task
timeoutif relevant
fnfunction to be called
pUserDatadata that will be passed to function

Definition at line 179 of file nfc_scheduler.c.