aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/rtc.c
blob: 24ccce84e2489d127d26fa5e1890ef7d8a8857e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    rtc.c
 * @brief   RTC Driver code.
 *
 * @addtogroup RTC
 * @{
 */

#include "ch.h"
#include "hal.h"

#if HAL_USE_RTC || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver local definitions.                                                 */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported variables.                                                */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local variables.                                                   */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local functions.                                                   */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported functions.                                                */
/*===========================================================================*/

/**
 * @brief   Enable access to registers and initialize RTC if BKP domain
 *          was previously reset.
 * @note    This function is implicitly invoked by @p halInit(), there is
 *          no need to explicitly initialize the driver.
 *
 * @init
 */
void rtcInit(void) {
  rtc_lld_init();
}

#if RTC_SUPPORTS_CALLBACKS || defined(__DOXYGEN__)
/**
 * @brief   Enables or disables callbacks.
 * @details This function enables or disables callbacks, use a @p NULL pointer
 *          in order to disable a callback.
 * @pre     To use this function you must set @p RTC_SUPPORTS_CALLBACKS
 *          to @p TRUE.
 *
 * @param[in] rtcp      pointer to RTC driver structure
 * @param[in] overflowcb overflow callback function
 * @param[in] secondcb  every second callback function
 * @param[in] alarmcb   alarm callback function
 */
void rtcSetCallback(RTCDriver *rtcp, rtccb_t overflowcb,
                    rtccb_t secondcb, rtccb_t alarmcb) {

  chDbgCheck((rtcp != NULL), "rtcSetCallback");

  rtc_lld_set_callback(rtcp, overflowcb, secondcb, alarmcb);
}
#endif /* RTC_SUPPORTS_CALLBACKS */

/**
 * @brief   Set current time.
 *
 * @param[in] timespec  pointer to a @p RTCDateTime structure
 */
void rtcSetTime(RTCDateTime *timespec) {

  chDbgCheck((timespec != NULL), "rtcSetTime");

  rtc_lld_set_time(timespec);
}

/**
 * @brief   Get current time.
 *
 * @param[in] timespec  pointer to a @p RTCDateTime structure
 */
void rtcGetTime(RTCDateTime *timespec) {

  chDbgCheck((timespec != NULL), "rtcGetTime");
  rtc_lld_get_time(timespec);
}

/**
 * @brief   Set alarm time.
 *
 * @param[in] timespec  pointer to a @p RTCDateTime structure
 */
void rtcSetAlarm(RTCDateTime *timespec) {

  chDbgCheck((timespec != NULL), "rtcSetAlarm");

  rtc_lld_set_alarm(timespec);
}

/**
 * @brief   Get current alarm.
 *
 * @param[in] timespec  pointer to a @p RTCDateTime structure
 */
void rtcGetAlarm(RTCDateTime *timespec){

  chDbgCheck((timespec != NULL), "rtcGetAlarm");

  rtc_lld_get_alarm(timespec);
}

#endif /* HAL_USE_RTC */

/** @} */