From 595c3cb881c14a28d37a8a9a3e4aadc79285a673 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Sat, 5 Feb 2022 18:37:05 +0000 Subject: deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49 --- watch__rtc_8h_source.html | 193 +++++++++++++++++++++++----------------------- 1 file changed, 96 insertions(+), 97 deletions(-) (limited to 'watch__rtc_8h_source.html') diff --git a/watch__rtc_8h_source.html b/watch__rtc_8h_source.html index 1bc77f9b..8016cfe0 100644 --- a/watch__rtc_8h_source.html +++ b/watch__rtc_8h_source.html @@ -2,8 +2,8 @@ - - + + Sensor Watch: watch-library/shared/watch/watch_rtc.h Source File @@ -19,10 +19,9 @@
- - + @@ -31,21 +30,22 @@
-
Sensor Watch -  0.0.0 +
+
Sensor Watch 0.0.0
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
- + +/* @license-end */ +
-
-
watch_rtc.h
+
watch_rtc.h
-
1 /*
-
2  * MIT License
-
3  *
-
4  * Copyright (c) 2020 Joey Castillo
-
5  *
-
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
-
7  * of this software and associated documentation files (the "Software"), to deal
-
8  * in the Software without restriction, including without limitation the rights
-
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-
10  * copies of the Software, and to permit persons to whom the Software is
-
11  * furnished to do so, subject to the following conditions:
-
12  *
-
13  * The above copyright notice and this permission notice shall be included in all
-
14  * copies or substantial portions of the Software.
-
15  *
-
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
22  * SOFTWARE.
-
23  */
-
24 #ifndef _WATCH_RTC_H_INCLUDED
-
25 #define _WATCH_RTC_H_INCLUDED
-
27 
-
28 #include "watch.h"
-
29 #include "hpl_calendar.h"
-
30 
-
41 
-
42 #define WATCH_RTC_REFERENCE_YEAR (2020)
-
43 
-
44 typedef union {
-
45  struct {
-
46  uint32_t second : 6; // 0-59
-
47  uint32_t minute : 6; // 0-59
-
48  uint32_t hour : 5; // 0-23
-
49  uint32_t day : 5; // 1-31
-
50  uint32_t month : 4; // 1-12
-
51  uint32_t year : 6; // 0-63 (representing 2020-2083)
-
52  } unit;
-
53  uint32_t reg; // the bit-packed value as expected by the RTC peripheral's CLOCK register.
-
54 } watch_date_time;
-
55 
-
56 typedef enum watch_rtc_alarm_match {
-
57  ALARM_MATCH_DISABLED = 0,
-
58  ALARM_MATCH_SS,
-
59  ALARM_MATCH_MMSS,
-
60  ALARM_MATCH_HHMMSS,
-
61 } watch_rtc_alarm_match;
-
62 
-
66 bool _watch_rtc_is_enabled(void);
-
67 
-
76 void watch_rtc_set_date_time(watch_date_time date_time);
-
77 
-
82 watch_date_time watch_rtc_get_date_time(void);
-
83 
-
99 void watch_rtc_register_alarm_callback(ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask);
-
100 
-
103 void watch_rtc_disable_alarm_callback(void);
-
104 
-
112 void watch_rtc_register_tick_callback(ext_irq_cb_t callback);
-
113 
-
116 void watch_rtc_disable_tick_callback(void);
-
117 
-
133 void watch_rtc_register_periodic_callback(ext_irq_cb_t callback, uint8_t frequency);
-
134 
-
138 void watch_rtc_disable_periodic_callback(uint8_t frequency);
-
139 
-
144 void watch_rtc_disable_matching_periodic_callbacks(uint8_t mask);
-
145 
-
148 void watch_rtc_disable_all_periodic_callbacks(void);
-
149 
-
153 __attribute__((deprecated("Use watch_rtc_set_date_time function instead")))
-
154 void watch_set_date_time(struct calendar_date_time date_time);
-
155 
-
159 __attribute__((deprecated("Use the watch_rtc_get_date_time function instead")))
-
160 void watch_get_date_time(struct calendar_date_time *date_time);
-
161 
-
166 __attribute__((deprecated("Use the watch_rtc_register_tick_callback function instead")))
-
167 void watch_register_tick_callback(ext_irq_cb_t callback);
-
168 
-
170 #endif
+
1/*
+
2 * MIT License
+
3 *
+
4 * Copyright (c) 2020 Joey Castillo
+
5 *
+
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
+
7 * of this software and associated documentation files (the "Software"), to deal
+
8 * in the Software without restriction, including without limitation the rights
+
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+
10 * copies of the Software, and to permit persons to whom the Software is
+
11 * furnished to do so, subject to the following conditions:
+
12 *
+
13 * The above copyright notice and this permission notice shall be included in all
+
14 * copies or substantial portions of the Software.
+
15 *
+
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+
22 * SOFTWARE.
+
23 */
+
24#ifndef _WATCH_RTC_H_INCLUDED
+
25#define _WATCH_RTC_H_INCLUDED
+
27
+
28#include "watch.h"
+
29#include "hpl_calendar.h"
+
30
+
41
+
42#define WATCH_RTC_REFERENCE_YEAR (2020)
+
43
+
44typedef union {
+
45 struct {
+
46 uint32_t second : 6; // 0-59
+
47 uint32_t minute : 6; // 0-59
+
48 uint32_t hour : 5; // 0-23
+
49 uint32_t day : 5; // 1-31
+
50 uint32_t month : 4; // 1-12
+
51 uint32_t year : 6; // 0-63 (representing 2020-2083)
+
52 } unit;
+
53 uint32_t reg; // the bit-packed value as expected by the RTC peripheral's CLOCK register.
+
54} watch_date_time;
+
55
+
56typedef enum watch_rtc_alarm_match {
+
57 ALARM_MATCH_DISABLED = 0,
+
58 ALARM_MATCH_SS,
+
59 ALARM_MATCH_MMSS,
+
60 ALARM_MATCH_HHMMSS,
+
61} watch_rtc_alarm_match;
+
62
+
66bool _watch_rtc_is_enabled(void);
+
67
+
76void watch_rtc_set_date_time(watch_date_time date_time);
+
77
+
82watch_date_time watch_rtc_get_date_time(void);
+
83
+
99void watch_rtc_register_alarm_callback(ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask);
+
100
+
103void watch_rtc_disable_alarm_callback(void);
+
104
+
112void watch_rtc_register_tick_callback(ext_irq_cb_t callback);
+
113
+
116void watch_rtc_disable_tick_callback(void);
+
117
+
133void watch_rtc_register_periodic_callback(ext_irq_cb_t callback, uint8_t frequency);
+
134
+
138void watch_rtc_disable_periodic_callback(uint8_t frequency);
+
139
+
144void watch_rtc_disable_matching_periodic_callbacks(uint8_t mask);
+
145
+
148void watch_rtc_disable_all_periodic_callbacks(void);
+
149
+
153__attribute__((deprecated("Use watch_rtc_set_date_time function instead")))
+
154void watch_set_date_time(struct calendar_date_time date_time);
+
155
+
159__attribute__((deprecated("Use the watch_rtc_get_date_time function instead")))
+
160void watch_get_date_time(struct calendar_date_time *date_time);
+
161
+
166__attribute__((deprecated("Use the watch_rtc_register_tick_callback function instead")))
+
167void watch_register_tick_callback(ext_irq_cb_t callback);
+
168
+
170#endif
watch_rtc_disable_all_periodic_callbacks
void watch_rtc_disable_all_periodic_callbacks(void)
Disables all periodic callbacks, including the once-per-second tick callback.
watch_rtc_get_date_time
watch_date_time watch_rtc_get_date_time(void)
Returns the date and time.
_watch_rtc_is_enabled
bool _watch_rtc_is_enabled(void)
Called by main.c to check if the RTC is enabled. You may call this function, but outside of app_init,...
@@ -171,7 +170,7 @@ $(function() {
-Generated by doxygen 1.9.1 +Generated by doxygen 1.9.3
-- cgit v1.2.3