1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/drivers/ds3231/include/ds3231_params.h
J. David Ibáñez d741f71ebd drivers/ds3231 fix docs, alarms are supported
Remove the text stating that setting alarms is not yet supported,
because it is, since PR #16180

Also document DS3231_PARAM_INT_PIN
2022-12-27 17:21:55 +01:00

65 lines
1.5 KiB
C

/*
* Copyright (C) 2020 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup drivers_ds3231
* @{
*
* @file
* @brief Default configuration for DS3231 devices
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef DS3231_PARAMS_H
#define DS3231_PARAMS_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @name Default configuration parameters for the DS3231 driver
* @{
*/
#ifndef DS3231_PARAM_I2C
#define DS3231_PARAM_I2C I2C_DEV(0)
#endif
#ifndef DS3231_PARAM_OPT
#define DS3231_PARAM_OPT (DS3231_OPT_BAT_ENABLE)
#endif
#ifndef DS3231_PARAM_INT_PIN
#define DS3231_PARAM_INT_PIN (GPIO_UNDEF) /**< Interrupt pin */
#endif
#ifndef DS3231_PARAMS
#if IS_USED(MODULE_DS3231_INT)
#define DS3231_PARAMS { .bus = DS3231_PARAM_I2C, \
.opt = DS3231_PARAM_OPT, \
.int_pin = DS3231_PARAM_INT_PIN}
#else /* MODULE_DS3231_INT */
#define DS3231_PARAMS { .bus = DS3231_PARAM_I2C, \
.opt = DS3231_PARAM_OPT}
#endif /* MODULE_DS3231_INT */
#endif /* DS3231_PARAMS */
/** @} */
/**
* @brief DS3231 configuration
*/
static const ds3231_params_t ds3231_params[] =
{
DS3231_PARAMS
};
#ifdef __cplusplus
}
#endif
#endif /* DS3231_PARAMS_H */
/** @} */