167 lines
20 KiB
HTML
167 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Sensor Watch: watch-library/shared/watch/watch_rtc.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Sensor Watch<span id="projectnumber"> 0.0.1</span>
|
|
</div>
|
|
<div id="projectbrief">A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_f1a087a6659d970f5756e21fc1ac4961.html">watch-library</a></li><li class="navelem"><a class="el" href="dir_3351a3556ab4b770be21f3a77a6d7b80.html">shared</a></li><li class="navelem"><a class="el" href="dir_280ec1f3fe74f12cdd5c78898ed1ca3c.html">watch</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">watch_rtc.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * MIT License</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Copyright (c) 2020 Joey Castillo</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * copies or substantial portions of the Software.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * SOFTWARE.</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#ifndef _WATCH_RTC_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#define _WATCH_RTC_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="watch_8h.html">watch.h</a>"</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "hpl_calendar.h"</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#define WATCH_RTC_REFERENCE_YEAR (2020)</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="unionwatch__date__time.html"> 44</a></span><span class="keyword">typedef</span> <span class="keyword">union </span>{</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> uint32_t second : 6; <span class="comment">// 0-59</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> uint32_t minute : 6; <span class="comment">// 0-59</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> uint32_t hour : 5; <span class="comment">// 0-23</span></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> uint32_t day : 5; <span class="comment">// 1-31</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> uint32_t month : 4; <span class="comment">// 1-12</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> uint32_t year : 6; <span class="comment">// 0-63 (representing 2020-2083)</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> } unit;</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> uint32_t reg; <span class="comment">// the bit-packed value as expected by the RTC peripheral's CLOCK register.</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a>;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="keyword">typedef</span> <span class="keyword">enum</span> watch_rtc_alarm_match {</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> ALARM_MATCH_DISABLED = 0,</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> ALARM_MATCH_SS,</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> ALARM_MATCH_MMSS,</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> ALARM_MATCH_HHMMSS,</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>} watch_rtc_alarm_match;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="group__rtc.html#ga3ac65a314540ae8b7be5b9015785d565"> 66</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__rtc.html#ga3ac65a314540ae8b7be5b9015785d565">_watch_rtc_is_enabled</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="group__rtc.html#gadfcc143db9d71e95c2d2dc45732ab4e5"> 76</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#gadfcc143db9d71e95c2d2dc45732ab4e5">watch_rtc_set_date_time</a>(<a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> date_time);</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="group__rtc.html#ga166b575563d39a0061dc9a28ad0309a7"> 82</a></span><a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> <a class="code hl_function" href="group__rtc.html#ga166b575563d39a0061dc9a28ad0309a7">watch_rtc_get_date_time</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="group__rtc.html#gaa5220d0d7f542a0bc6c9bef176d6d83b"> 99</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#gaa5220d0d7f542a0bc6c9bef176d6d83b">watch_rtc_register_alarm_callback</a>(ext_irq_cb_t callback, <a class="code hl_union" href="unionwatch__date__time.html">watch_date_time</a> alarm_time, watch_rtc_alarm_match mask);</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="group__rtc.html#ga836cade77c24e93c06bf534eaded55bf"> 103</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#ga836cade77c24e93c06bf534eaded55bf">watch_rtc_disable_alarm_callback</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="group__rtc.html#ga969ea57aaedf13d4950edbeacff3f2be"> 112</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#ga969ea57aaedf13d4950edbeacff3f2be">watch_rtc_register_tick_callback</a>(ext_irq_cb_t callback);</div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="group__rtc.html#ga685f2afb2e99dfebf8d2ef058a5bc19d"> 116</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#ga685f2afb2e99dfebf8d2ef058a5bc19d">watch_rtc_disable_tick_callback</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="group__rtc.html#gaeb4e67aa0062e39eaff465aeebc24f53"> 133</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#gaeb4e67aa0062e39eaff465aeebc24f53">watch_rtc_register_periodic_callback</a>(ext_irq_cb_t callback, uint8_t frequency);</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="group__rtc.html#ga4e025485bb50e1c93abd4a185447705f"> 138</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#ga4e025485bb50e1c93abd4a185447705f">watch_rtc_disable_periodic_callback</a>(uint8_t frequency);</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="group__rtc.html#gadccd826da474b5fe24cac8d8edc88ae6"> 144</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#gadccd826da474b5fe24cac8d8edc88ae6">watch_rtc_disable_matching_periodic_callbacks</a>(uint8_t mask);</div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="group__rtc.html#ga0150da34307ba61e44f1a00aa90a7f0f"> 148</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__rtc.html#ga0150da34307ba61e44f1a00aa90a7f0f">watch_rtc_disable_all_periodic_callbacks</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> </div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga0150da34307ba61e44f1a00aa90a7f0f"><div class="ttname"><a href="group__rtc.html#ga0150da34307ba61e44f1a00aa90a7f0f">watch_rtc_disable_all_periodic_callbacks</a></div><div class="ttdeci">void watch_rtc_disable_all_periodic_callbacks(void)</div><div class="ttdoc">Disables all periodic callbacks, including the once-per-second tick callback.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga166b575563d39a0061dc9a28ad0309a7"><div class="ttname"><a href="group__rtc.html#ga166b575563d39a0061dc9a28ad0309a7">watch_rtc_get_date_time</a></div><div class="ttdeci">watch_date_time watch_rtc_get_date_time(void)</div><div class="ttdoc">Returns the date and time.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga3ac65a314540ae8b7be5b9015785d565"><div class="ttname"><a href="group__rtc.html#ga3ac65a314540ae8b7be5b9015785d565">_watch_rtc_is_enabled</a></div><div class="ttdeci">bool _watch_rtc_is_enabled(void)</div><div class="ttdoc">Called by main.c to check if the RTC is enabled. You may call this function, but outside of app_init,...</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga4e025485bb50e1c93abd4a185447705f"><div class="ttname"><a href="group__rtc.html#ga4e025485bb50e1c93abd4a185447705f">watch_rtc_disable_periodic_callback</a></div><div class="ttdeci">void watch_rtc_disable_periodic_callback(uint8_t frequency)</div><div class="ttdoc">Disables the tick callback for the given period.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga685f2afb2e99dfebf8d2ef058a5bc19d"><div class="ttname"><a href="group__rtc.html#ga685f2afb2e99dfebf8d2ef058a5bc19d">watch_rtc_disable_tick_callback</a></div><div class="ttdeci">void watch_rtc_disable_tick_callback(void)</div><div class="ttdoc">Disables the tick callback for the given period.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga836cade77c24e93c06bf534eaded55bf"><div class="ttname"><a href="group__rtc.html#ga836cade77c24e93c06bf534eaded55bf">watch_rtc_disable_alarm_callback</a></div><div class="ttdeci">void watch_rtc_disable_alarm_callback(void)</div><div class="ttdoc">Disables the alarm callback.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_ga969ea57aaedf13d4950edbeacff3f2be"><div class="ttname"><a href="group__rtc.html#ga969ea57aaedf13d4950edbeacff3f2be">watch_rtc_register_tick_callback</a></div><div class="ttdeci">void watch_rtc_register_tick_callback(ext_irq_cb_t callback)</div><div class="ttdoc">Registers a "tick" callback that will be called once per second.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_gaa5220d0d7f542a0bc6c9bef176d6d83b"><div class="ttname"><a href="group__rtc.html#gaa5220d0d7f542a0bc6c9bef176d6d83b">watch_rtc_register_alarm_callback</a></div><div class="ttdeci">void watch_rtc_register_alarm_callback(ext_irq_cb_t callback, watch_date_time alarm_time, watch_rtc_alarm_match mask)</div><div class="ttdoc">Registers an alarm callback that will be called when the RTC time matches the target time,...</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_gadccd826da474b5fe24cac8d8edc88ae6"><div class="ttname"><a href="group__rtc.html#gadccd826da474b5fe24cac8d8edc88ae6">watch_rtc_disable_matching_periodic_callbacks</a></div><div class="ttdeci">void watch_rtc_disable_matching_periodic_callbacks(uint8_t mask)</div><div class="ttdoc">Disables tick callbacks for the given periods (as a bitmask).</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_gadfcc143db9d71e95c2d2dc45732ab4e5"><div class="ttname"><a href="group__rtc.html#gadfcc143db9d71e95c2d2dc45732ab4e5">watch_rtc_set_date_time</a></div><div class="ttdeci">void watch_rtc_set_date_time(watch_date_time date_time)</div><div class="ttdoc">Sets the date and time.</div></div>
|
|
<div class="ttc" id="agroup__rtc_html_gaeb4e67aa0062e39eaff465aeebc24f53"><div class="ttname"><a href="group__rtc.html#gaeb4e67aa0062e39eaff465aeebc24f53">watch_rtc_register_periodic_callback</a></div><div class="ttdeci">void watch_rtc_register_periodic_callback(ext_irq_cb_t callback, uint8_t frequency)</div><div class="ttdoc">Registers a callback that will be called at a configurable period.</div></div>
|
|
<div class="ttc" id="aunionwatch__date__time_html"><div class="ttname"><a href="unionwatch__date__time.html">watch_date_time</a></div><div class="ttdef"><b>Definition:</b> watch_rtc.h:44</div></div>
|
|
<div class="ttc" id="awatch_8h_html"><div class="ttname"><a href="watch_8h.html">watch.h</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|