optiga-nbt-lib-c/ifx-timer_8h_source.html

// SPDX-FileCopyrightText: Copyright (c) 2024-2026 Infineon Technologies AG

// SPDX-License-Identifier: MIT


#ifndef IFX_TIMER_H

#define IFX_TIMER_H


#include <stdbool.h>

#include <stdint.h>


#include "infineon/ifx-error.h"


#ifdef __cplusplus

extern "C" {

#endif


#define LIB_TIMER         UINT8_C(0x02)


#define IFX_TIMER_SET     UINT8_C(0x01)


#define IFX_TIMER_JOIN    UINT8_C(0x02)


#define IFX_TIMER_NOT_SET 0x01u


typedef struct

{

    void *_start;


    uint64_t _duration;

} ifx_timer_t;


ifx_status_t ifx_timer_set(ifx_timer_t *timer, uint64_t time_us);


bool ifx_timer_has_elapsed(const ifx_timer_t *timer);


ifx_status_t ifx_timer_join(const ifx_timer_t *timer);


void ifx_timer_destroy(ifx_timer_t *timer);


#ifdef __cplusplus

}

#endif


#endif // IFX_TIMER_H

ifx-error.h
Infineon specific error code creation and parsing.

ifx_status_t
uint32_t ifx_status_t
Custom return code type used by all Infineon host software libraries.
Definition ifx-error.h:91

ifx_timer_t
Generic struct for joinable timers.
Definition ifx-timer.h:48

ifx_timer_t::ifx_timer_join
ifx_status_t ifx_timer_join(const ifx_timer_t *timer)
Waits for Timer to finish.

ifx_timer_t::_duration
uint64_t _duration
Private member for duration of timer in [us].
Definition ifx-timer.h:62

ifx_timer_t::_start
void * _start
Private member for start of timer as void* to be as generic as possible.
Definition ifx-timer.h:55

ifx_timer_t::ifx_timer_destroy
void ifx_timer_destroy(ifx_timer_t *timer)
Frees memory associated with Timer object (but not object itself).

ifx_timer_t::ifx_timer_set
ifx_status_t ifx_timer_set(ifx_timer_t *timer, uint64_t time_us)
Sets Timer for given amount of [us].

ifx_timer_t::ifx_timer_has_elapsed
bool ifx_timer_has_elapsed(const ifx_timer_t *timer)
Checks if Timer has elapsed.