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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/*
Concepts and parts of this file have been contributed by Uladzimir Pylinsky
aka barthess.
*/
/**
* @file RTCv1/hal_rtc_lld.h
* @brief SAMA RTC low level driver header.
*
* @addtogroup RTC
* @{
*/
#ifndef HAL_RTC_LLD_H
#define HAL_RTC_LLD_H
#if HAL_USE_RTC || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define SYSC_WPMR (0xF80480E4u)
#define SYSC_WPMR_WPKEY_PASSWD (0x535943u << 8)
#define SYSC_WPMR_WPEN (0x1u << 0)
/**
* @name Implementation capabilities
*/
/**
* @brief Number of available alarms.
*/
#define RTC_ALARMS 1
/**
* @brief Presence of a local persistent storage.
*/
#define RTC_HAS_STORAGE FALSE
/**
* @brief Callback supported.
*/
#define RTC_SUPPORTS_CALLBACKS TRUE
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/*
* RTC driver system settings.
*/
#define SAMA_RTC_IRQ_PRIORITY 7
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief FileStream specific methods.
*/
#define _rtc_driver_methods \
_file_stream_methods
/**
* @brief Type of an RTC alarm number.
*/
typedef uint32_t rtcalarm_t;
/**
* @brief Type of an RTC event.
*/
typedef enum {
RTC_EVENT_SECOND = 0, /** Triggered every second. */
RTC_EVENT_ALARM = 1 /** Triggered on alarm. */
} rtcevent_t;
/**
* @brief Type of a generic RTC callback.
*/
typedef void (*rtccb_t)(RTCDriver *rtcp, rtcevent_t event);
/**
* @brief Type of a structure representing an RTC alarm time stamp.
*/
typedef struct {
/**
* @brief Type of an alarm as encoded in RTC registers.
*/
uint32_t timralrm;
uint32_t calralrm;
} RTCAlarm;
#if RTC_HAS_STORAGE || defined(__DOXYGEN__)
/**
* @extends FileStream
*
* @brief @p RTCDriver virtual methods table.
*/
struct RTCDriverVMT {
_rtc_driver_methods
};
#endif
/**
* @brief Structure representing an RTC driver.
*/
struct RTCDriver {
#if RTC_HAS_STORAGE || defined(__DOXYGEN__)
/**
* @brief Virtual Methods Table.
*/
const struct RTCDriverVMT *vmt;
#endif
/* End of the mandatory fields.*/
/**
* @brief Pointer to the RTC registers block.
*/
Rtc *rtc;
/**
* @brief Callback pointer.
*/
rtccb_t callback;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @brief Enable write protection on SYSC registers block.
*
* @notapi
*/
#define syscEnableWP() { \
*(uint32_t *)(SYSC_WPMR) = SYSC_WPMR_WPKEY_PASSWD | SYSC_WPMR_WPEN; \
}
/**
* @brief Disable write protection on SYSC registers block.
*
* @notapi
*/
#define syscDisableWP() { \
*(uint32_t *)(SYSC_WPMR) = SYSC_WPMR_WPKEY_PASSWD; \
}
/**
* @brief Configure RTC_MR register.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[in] value value to be written in the MR register
*
*/
#define rtcConfigureMode(rtcp, value) { \
(rtcp)->rtc->RTC_MR = value; \
}
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if !defined(__DOXYGEN__)
extern RTCDriver RTCD0;
#if RTC_HAS_STORAGE
extern struct RTCDriverVMT _rtc_lld_vmt;
#endif
#endif
#ifdef __cplusplus
extern "C" {
#endif
void rtc_lld_init(void);
void rtc_lld_set_time(RTCDriver *rtcp, const RTCDateTime *timespec);
void rtc_lld_get_time(RTCDriver *rtcp, RTCDateTime *timespec);
void rtc_lld_set_alarm(RTCDriver *rtcp,
rtcalarm_t alarm,
const RTCAlarm *alarmspec);
void rtc_lld_get_alarm(RTCDriver *rtcp,
rtcalarm_t alarm,
RTCAlarm *alarmspec);
void rtc_lld_set_callback(RTCDriver *rtcp, rtccb_t callback);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_RTC */
#endif /* HAL_RTC_LLD_H */
/** @} */
|