rtc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _HARDWARE_RTC_H
#define _HARDWARE_RTC_H
 
#include "pico.h"
#if HAS_RP2040_RTC
#include "hardware/structs/rtc.h"
 
// The RTC clock frequency is 48MHz divided by power of 2 (to ensure an integer
// division ratio will be used in the clocks block).  A divisor of 1024 generates
// an RTC clock tick of 46875Hz.  This frequency is relatively close to the
// customary 32 or 32.768kHz 'slow clock' crystals and provides good timing resolution.
#define RTC_CLOCK_FREQ_HZ       (USB_CLK_HZ / 1024)
#endif

 
#ifdef __cplusplus
extern "C" {
#endif

typedef void (*rtc_callback_t)(void);

void rtc_init(void);

bool rtc_set_datetime(const datetime_t *t);

bool rtc_get_datetime(datetime_t *t);

bool rtc_running(void);

void rtc_set_alarm(const datetime_t *t, rtc_callback_t user_callback);

void rtc_enable_alarm(void);

void rtc_disable_alarm(void);

bool rtc_run_from_external_source(uint32_t src_hz, uint gpio_pin);
 
#ifdef __cplusplus
}
#endif
 
#endif