maxim_ds3231.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Peter Bigot Consulting, LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_RTC_DS3231_H_
#define ZEPHYR_INCLUDE_DRIVERS_RTC_DS3231_H_
 
#include <time.h>
 
#include <zephyr/drivers/counter.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/sys/notify.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MAXIM_DS3231_ALARM1 BIT(0)
 
#define MAXIM_DS3231_ALARM2 BIT(1)
 
/* Constants corresponding to bits in the DS3231 control register at
 * 0x0E.
 *
 * See the datasheet for interpretation of these bits.
 */
#define MAXIM_DS3231_REG_CTRL_A1IE MAXIM_DS3231_ALARM1
 
#define MAXIM_DS3231_REG_CTRL_A2IE MAXIM_DS3231_ALARM2
 
#define MAXIM_DS3231_REG_CTRL_INTCN BIT(2)
 
#define MAXIM_DS3231_REG_CTRL_RS_Pos 3
 
#define MAXIM_DS3231_REG_CTRL_RS_Msk (0x03 << MAXIM_DS3231_REG_CTRL_RS_Pos)
 
#define MAXIM_DS3231_REG_CTRL_RS_1Hz 0x00
 
#define MAXIM_DS3231_REG_CTRL_RS_1KiHz 0x01
 
#define MAXIM_DS3231_REG_CTRL_RS_4KiHz 0x02
 
#define MAXIM_DS3231_REG_CTRL_RS_8KiHz 0x03
 
#define MAXIM_DS3231_REG_CTRL_CONV BIT(5)
 
#define MAXIM_DS3231_REG_CTRL_BBSQW BIT(6)
 
#define MAXIM_DS3231_REG_CTRL_EOSCn BIT(7),
 
#define MAXIM_DS3231_REG_STAT_A1F MAXIM_DS3231_ALARM1
 
#define MAXIM_DS3231_REG_STAT_A2F MAXIM_DS3231_ALARM2
 
#define MAXIM_DS3231_REG_STAT_BSY BIT(2)
 
#define MAXIM_DS3231_REG_STAT_EN32kHz BIT(3)
 
#define MAXIM_DS3231_REG_STAT_OSF BIT(7)
 
#define MAXIM_DS3231_ALARM_FLAGS_IGNSE BIT(0)
 
#define MAXIM_DS3231_ALARM_FLAGS_IGNMN BIT(1)
 
#define MAXIM_DS3231_ALARM_FLAGS_IGNHR BIT(2)
 
#define MAXIM_DS3231_ALARM_FLAGS_IGNDA BIT(3)
 
#define MAXIM_DS3231_ALARM_FLAGS_DOW BIT(4)
 
#define MAXIM_DS3231_ALARM_FLAGS_AUTODISABLE BIT(7)
 
typedef void (*maxim_ds3231_alarm_callback_handler_t)(const struct device *dev,
                                                      uint8_t id,
                                                      uint32_t syncclock,
                                                      void *user_data);
 
typedef void (*maxim_ds3231_notify_callback)(const struct device *dev,
                                             struct sys_notify *notify,
                                             int res);
 
struct maxim_ds3231_alarm {
        time_t time;
 
        maxim_ds3231_alarm_callback_handler_t handler;
 
        void *user_data;
 
        uint8_t flags;
};
 
struct maxim_ds3231_syncpoint {
        struct timespec rtc;
 
        uint32_t syncclock;
};
 
static inline uint32_t maxim_ds3231_read_syncclock(const struct device *dev)
{
        return k_uptime_get_32();
}
 
static inline uint32_t maxim_ds3231_syncclock_frequency(const struct device *dev)
{
        return 1000U;
}
 
int maxim_ds3231_ctrl_update(const struct device *dev,
                             uint8_t set_bits,
                             uint8_t clear_bits);
 
int maxim_ds3231_stat_update(const struct device *dev,
                             uint8_t set_bits,
                             uint8_t clear_bits);
 
int maxim_ds3231_get_alarm(const struct device *dev,
                           uint8_t id,
                           struct maxim_ds3231_alarm *cfg);
 
int maxim_ds3231_set_alarm(const struct device *dev,
                           uint8_t id,
                           const struct maxim_ds3231_alarm *cfg);
 
int maxim_ds3231_synchronize(const struct device *dev,
                             struct sys_notify *notify);
 
__syscall int maxim_ds3231_req_syncpoint(const struct device *dev,
                                         struct k_poll_signal *signal);
 
__syscall int maxim_ds3231_get_syncpoint(const struct device *dev,
                                         struct maxim_ds3231_syncpoint *syncpoint);
 
int maxim_ds3231_set(const struct device *dev,
                     const struct maxim_ds3231_syncpoint *syncpoint,
                     struct sys_notify *notify);
 
int maxim_ds3231_check_alarms(const struct device *dev);
 
#ifdef __cplusplus
}
#endif
 
/* @todo this should be syscalls/drivers/rtc/maxim_ds3231.h */
#include <syscalls/maxim_ds3231.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_RTC_DS3231_H_ */