Safe API Framework
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
Timer Service - Backend Adaptation

Backend vtable and registration for the Timer service (ADR-005). More...

Data Structures

struct  sapi_timer_backend_t
 Backend vtable: an integrator's implementation of the timer service for a specific OS/RTOS/BSP target (ADR-005). Any slot may be NULL if that operation is unsupported by the backend, in which case the corresponding sapi_timer_* call returns SAPI_STATUS_NOT_SUPPORTED. More...

Functions

sapi_status_t sapi_timer_register_backend (const sapi_timer_backend_t *backend)
 Registers the backend implementation used by every sapi_timer_* call. This is how an integrator supplies their own timer implementation (ADR-005 section 2.1) - call once at startup, before any other sapi_timer_* function.

Detailed Description

Backend vtable and registration for the Timer service (ADR-005).

Function Documentation

◆ sapi_timer_register_backend()

sapi_status_t sapi_timer_register_backend ( const sapi_timer_backend_t * backend)

Registers the backend implementation used by every sapi_timer_* call. This is how an integrator supplies their own timer implementation (ADR-005 section 2.1) - call once at startup, before any other sapi_timer_* function.

Parameters
backendMust not be NULL. Registering again replaces the previously registered backend.
Returns
SAPI_STATUS_INVALID_PARAM if backend is NULL; SAPI_STATUS_OK otherwise.
SAPI_STATUS_INVALID_STATE if the application's setup phase is already locked (ADR-026).

REQ-OAL-TIMER-015

Global variables declarations Local function declarations Global functions

Definition at line 25 of file sapi_timer.c.