rtt.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2014 Thomas Eichinger <thomas.eichinger@fu-berlin.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifdef DOXYGEN
#  define RTT_FREQUENCY
#endif

#ifdef DOXYGEN
#  define RTT_MAX_VALUE
#endif

#ifndef RTT_MIN_OFFSET
#  pragma message "RTT_MIN_OFFSET is undefined. Using default value of 2. "   \
                  "Please test your CPU using RIOT/tests/periph/rtt_min and " \
                  "define RTT_MIN_OFFSET in periph_cpu.h accordingly."
#  define RTT_MIN_OFFSET (2U)
#endif
 
/* Allow mock-RTT for unit tests */
#ifdef MOCK_RTT_FREQUENCY
#  undef RTT_FREQUENCY
#  define RTT_FREQUENCY MOCK_RTT_FREQUENCY
#else
#  ifndef RTT_FREQUENCY
#    warning "RTT_FREQUENCY undefined. Set RTT_FREQUENCY to the number of ticks " \
             "per second for the current architecture."
#  endif
#endif
 
/* Allow mock-RTT for unit tests */
#ifdef MOCK_RTT_MAX_VALUE
#  undef RTT_MAX_VALUE
#  define RTT_MAX_VALUE MOCK_RTT_MAX_VALUE
#else
#  ifndef RTT_MAX_VALUE
#    warning "RTT_MAX_VALUE is undefined. Set RTT_MAX_VALUE to the maximum value " \
             "for the RTT counter, ensure it is (2^n - 1)."
#  endif
#endif

#define RTT_US_TO_TICKS(us)     (RTT_SEC_TO_TICKS(us) / 1000000UL)

#define RTT_MS_TO_TICKS(ms)     (RTT_SEC_TO_TICKS(ms) / 1000UL)

#define RTT_SEC_TO_TICKS(sec)   (sec * RTT_FREQUENCY)

#define RTT_MIN_TO_TICKS(min)   (RTT_SEC_TO_TICKS((min) * 60))

#define RTT_TICKS_TO_US(ticks)  ((uint64_t)(ticks) * 1000000UL / RTT_FREQUENCY)

#define RTT_TICKS_TO_MS(ticks)  (RTT_TICKS_TO_US(ticks) / 1000)

#define RTT_TICKS_TO_SEC(ticks) (RTT_TICKS_TO_MS(ticks) / 1000)

#define RTT_TICKS_TO_MIN(ticks) (RTT_TICKS_TO_SEC(ticks) / 60)

typedef void (*rtt_cb_t)(void *arg);

void rtt_init(void);

void rtt_set_overflow_cb(rtt_cb_t cb, void *arg);

void rtt_clear_overflow_cb(void);

uint32_t rtt_get_counter(void);

void rtt_set_counter(uint32_t counter);

void rtt_set_alarm(uint32_t alarm, rtt_cb_t cb, void *arg);

uint32_t rtt_get_alarm(void);

void rtt_clear_alarm(void);

void rtt_poweron(void);

void rtt_poweroff(void);
 
#ifdef __cplusplus
}
#endif