1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00

Merge pull request #13933 from fjmolinas/pr_rtt_doc

drivers/periph/rtt.h: ensure RTT_MAX_VALUE is set
This commit is contained in:
Alexandre Abadie 2020-04-23 22:38:13 +02:00 committed by GitHub
commit e9d2fdb29b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -42,16 +42,42 @@
extern "C" {
#endif
#ifndef RTT_FREQUENCY
/**
* @def RTT_FREQUENCY
*
* @brief The desired frequency for the RTT
*/
#ifdef DOXYGEN
#define RTT_FREQUENCY
#endif
/**
* @def RTT_MAX_VALUE
*
* @brief The maximum value for the RTT counter, must be (2^n - 1)
*
*/
#ifdef DOXYGEN
#define RTT_MAX_VALUE
#endif
#ifndef RTT_FREQUENCY
/* Allow mock-RTT for unit tests */
#ifdef MOCK_RTT_FREQUENCY
#define RTT_FREQUENCY MOCK_RTT_FREQUENCY
#else
#warning "RTT_FREQUENCY undefined. Set RTT_FREQUENCY to the number of ticks " \
"per second for the current architecture."
#endif
#endif
#ifndef RTT_MAX_VALUE
/* Allow mock-RTT for unit tests */
#ifdef MOCK_RTT_MAX_VALUE
#define RTT_MAX_VALUE MOCK_RTT_MAX_VALUE
#else
#warning "RTT_FREQUENCY undefined. Set RTT_FREQUENCY to the number of ticks" \
"per second for the current architecture."
#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