timer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014-2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <limits.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "architecture.h"
#include "periph_cpu.h"
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef TIMER_DEV
#  define TIMER_DEV(x)      (x)
#endif

#ifndef TIMER_UNDEF
#  define TIMER_UNDEF       (UINT_FAST8_MAX)
#endif

#ifndef HAVE_TIMER_T
typedef uint_fast8_t tim_t;
#endif

#ifndef TIM_FLAG_RESET_ON_SET
#  define TIM_FLAG_RESET_ON_SET (0x01)
#endif

#ifndef TIM_FLAG_RESET_ON_MATCH
#  define TIM_FLAG_RESET_ON_MATCH   (0x02)
#endif

#ifndef TIM_FLAG_SET_STOPPED
#  define TIM_FLAG_SET_STOPPED  (0x04)
#endif

typedef void (*timer_cb_t)(void *arg, int channel);

#ifndef HAVE_TIMER_ISR_CTX_T
typedef struct {
    timer_cb_t cb;          
    void *arg;              
} timer_isr_ctx_t;
#endif

int timer_init(tim_t dev, uint32_t freq, timer_cb_t cb, void *arg);

int timer_set(tim_t dev, int channel, unsigned int timeout);

int timer_set_absolute(tim_t dev, int channel, unsigned int value);

int timer_set_periodic(tim_t dev, int channel, unsigned int value, uint8_t flags);

int timer_clear(tim_t dev, int channel);

unsigned int timer_read(tim_t dev);

void timer_start(tim_t dev);

void timer_stop(tim_t dev);

__attribute__((pure))
uword_t timer_query_freqs_numof(tim_t dev);

__attribute__((pure))
uword_t timer_query_channel_numof(tim_t dev);

uint32_t timer_query_freqs(tim_t dev, uword_t index);

uint32_t timer_get_closest_freq(tim_t dev, uint32_t target);
 
#if defined(DOXYGEN)
/* As this function is polled, it needs to be inlined, so it is typically
 * provided through `timer_arch.h`. If a platform ever does not need to go
 * through static inline here, this declaration's condition can be extended to
 * be `(defined(MODULE_PERIPH_TIMER_POLL) &&
 * !defined(PERIPH_TIMER_PROVIDES_INLINE_POLL_CHANNEL) || defined(DOXYGEN)` or
 * similar. */
bool timer_poll_channel(tim_t dev, int channel);
#endif
 
#if defined(MODULE_PERIPH_TIMER_POLL)
#  include "timer_arch.h" /* IWYU pragma: export */
#endif
 
#ifdef __cplusplus
}
#endif