web/docs/rtc_8h_source.html

   1 <!-- HTML header for doxygen 1.8.20-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5         <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6         <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7         <meta name="generator" content="Doxygen 1.9.4"/>
   8         <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9         <title>Raspberry Pi Pico SDK: include/hardware/rtc.h Source File</title>
  10         <!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
  11         <script type="text/javascript" src="jquery.js"></script>
  12         <script type="text/javascript" src="dynsections.js"></script>
  13         <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17         <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/searchdata.js"></script>
  19 <script type="text/javascript" src="search/search.js"></script>
  20     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
  21         <link href="doxygen.css" rel="stylesheet" type="text/css" />
  22         <link href="normalise.css" rel="stylesheet" type="text/css"/>
  23 <link href="main.css" rel="stylesheet" type="text/css"/>
  24 <link href="styles.css" rel="stylesheet" type="text/css"/>
  25 </head>
  26 <body>
  27         <div class="navigation-mobile">
  28                 <div class="logo--mobile">
  29                         <a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
  30                 </div>
  31                 <div class="navigation-toggle">
  32                         <span class="line-1"></span>
  33                         <span class="line-2">
  34                                 <p>Menu Toggle</p>
  35                         </span>
  36                         <span class="line-3"></span>
  37                 </div>
  38         </div>
  39         <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40                 <div class="logo">
  41                         <a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
  42                         <span style="display: inline-block; margin-top: 10px;">
  43                                 v2.0.0-develop
  44                         </span>
  45                 </div>
  46                 <div class="navigation-footer">
  47                         <img src="logo-mobile.svg" alt="Raspberry Pi">
  48                         <a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
  49                 </div>
  50 <!--            <div class="search">
  51                         <form>
  52                                 <input type="search" name="search" id="search" placeholder="Search">
  53                                 <input type="submit" value="Search">
  54                         </form>
  55                 </div> -->
  56 <!-- Generated by Doxygen 1.9.4 -->
  57 <script type="text/javascript">
  58 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  59 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
  60 /* @license-end */
  61 </script>
  62 <script type="text/javascript" src="menudata.js"></script>
  63 <script type="text/javascript" src="menu.js"></script>
  64 <script type="text/javascript">
  65 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  66 $(function() {
  67   initMenu('',true,false,'search.php','Search');
  68   $(document).ready(function() { init_search(); });
  69 });
  70 /* @license-end */
  71 </script>
  72 <div id="main-nav"></div>
  73 </div><!-- top -->
  74 <div id="side-nav" class="ui-resizable side-nav-resizable">
  75   <div id="nav-tree">
  76     <div id="nav-tree-contents">
  77       <div id="nav-sync" class="sync"></div>
  78     </div>
  79   </div>
  80   <div id="splitbar" style="-moz-user-select:none;"
  81        class="ui-resizable-handle">
  82   </div>
  83 </div>
  84 <script type="text/javascript">
  85 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  86 $(document).ready(function(){initNavTree('rtc_8h_source.html',''); initResizable(); });
  87 /* @license-end */
  88 </script>
  89 <div id="doc-content">
  90 <!-- window showing the filter options -->
  91 <div id="MSearchSelectWindow"
  92      onmouseover="return searchBox.OnSearchSelectShow()"
  93      onmouseout="return searchBox.OnSearchSelectHide()"
  94      onkeydown="return searchBox.OnSearchSelectKey(event)">
  95 </div>
  96
  97 <!-- iframe showing the search results (closed by default) -->
  98 <div id="MSearchResultsWindow">
  99 <iframe src="javascript:void(0)" frameborder="0"
 100         name="MSearchResults" id="MSearchResults">
 101 </iframe>
 102 </div>
 103
 104 <div class="header">
 105   <div class="headertitle"><div class="title">rtc.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <a href="rtc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
 109 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.</span></div>
 110 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
 111 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
 112 <div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
 113 <div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
 114 <div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _HARDWARE_RTC_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _HARDWARE_RTC_H</span></div>
 116 <div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
 117 <div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="pico_8h.html">pico.h</a>&quot;</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;hardware/structs/rtc.h&quot;</span></div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span> </div>
 120 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 121 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
 122 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="preprocessor">#endif</span></div>
 123 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
 124 <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">   40</a></span><span class="keyword">typedef</span> void (*<a class="code hl_typedef" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a>)(void);</div>
 125 <div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
 126 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__rtc.html#gacf9024748b942a7ae375cf75951afa9c">rtc_init</a>(<span class="keywordtype">void</span>);</div>
 127 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
 128 <div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">rtc_set_datetime</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structdatetime__t.html">datetime_t</a> *t);</div>
 129 <div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
 130 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">rtc_get_datetime</a>(<a class="code hl_struct" href="structdatetime__t.html">datetime_t</a> *t);</div>
 131 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
 132 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__hardware__rtc.html#gabf6cc1546be8d1ddb56e3d83a915f683">rtc_running</a>(<span class="keywordtype">void</span>);</div>
 133 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span> </div>
 134 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">rtc_set_alarm</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structdatetime__t.html">datetime_t</a> *t, <a class="code hl_typedef" href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a> user_callback);</div>
 135 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
 136 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__rtc.html#gab7f69ee0de1cae2518b2822fd82d5201">rtc_enable_alarm</a>(<span class="keywordtype">void</span>);</div>
 137 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
 138 <div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="keywordtype">void</span> <a class="code hl_function" href="group__hardware__rtc.html#ga718b866eab2ba73221d37f7d15ba9737">rtc_disable_alarm</a>(<span class="keywordtype">void</span>);</div>
 139 <div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span> </div>
 140 <div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="preprocessor">#ifdef __cplusplus</span></div>
 141 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>}</div>
 142 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="preprocessor">#endif</span></div>
 143 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span> </div>
 144 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="preprocessor">#endif</span></div>
 145 <div class="ttc" id="agroup__hardware__rtc_html_ga05a9e12c70c56e6e2a9869d0682045d1"><div class="ttname"><a href="group__hardware__rtc.html#ga05a9e12c70c56e6e2a9869d0682045d1">rtc_callback_t</a></div><div class="ttdeci">void(* rtc_callback_t)(void)</div><div class="ttdef"><b>Definition:</b> rtc.h:40</div></div>
 146 <div class="ttc" id="agroup__hardware__rtc_html_ga076d68dec35129dd2b44d16ae457a3de"><div class="ttname"><a href="group__hardware__rtc.html#ga076d68dec35129dd2b44d16ae457a3de">rtc_set_datetime</a></div><div class="ttdeci">bool rtc_set_datetime(const datetime_t *t)</div><div class="ttdoc">Set the RTC to the specified time.</div><div class="ttdef"><b>Definition:</b> rtc.c:54</div></div>
 147 <div class="ttc" id="agroup__hardware__rtc_html_ga718b866eab2ba73221d37f7d15ba9737"><div class="ttname"><a href="group__hardware__rtc.html#ga718b866eab2ba73221d37f7d15ba9737">rtc_disable_alarm</a></div><div class="ttdeci">void rtc_disable_alarm(void)</div><div class="ttdoc">Disable the RTC alarm (if active)</div><div class="ttdef"><b>Definition:</b> rtc.c:184</div></div>
 148 <div class="ttc" id="agroup__hardware__rtc_html_ga7c5528e71733b7bfc0b0543cd3bb6d3f"><div class="ttname"><a href="group__hardware__rtc.html#ga7c5528e71733b7bfc0b0543cd3bb6d3f">rtc_get_datetime</a></div><div class="ttdeci">bool rtc_get_datetime(datetime_t *t)</div><div class="ttdoc">Get the current time from the RTC.</div><div class="ttdef"><b>Definition:</b> rtc.c:87</div></div>
 149 <div class="ttc" id="agroup__hardware__rtc_html_gaac8ad85f301295b6a130aa8e00122253"><div class="ttname"><a href="group__hardware__rtc.html#gaac8ad85f301295b6a130aa8e00122253">rtc_set_alarm</a></div><div class="ttdeci">void rtc_set_alarm(const datetime_t *t, rtc_callback_t user_callback)</div><div class="ttdoc">Set a time in the future for the RTC to call a user provided callback.</div><div class="ttdef"><b>Definition:</b> rtc.c:146</div></div>
 150 <div class="ttc" id="agroup__hardware__rtc_html_gab7f69ee0de1cae2518b2822fd82d5201"><div class="ttname"><a href="group__hardware__rtc.html#gab7f69ee0de1cae2518b2822fd82d5201">rtc_enable_alarm</a></div><div class="ttdeci">void rtc_enable_alarm(void)</div><div class="ttdoc">Enable the RTC alarm (if inactive)</div><div class="ttdef"><b>Definition:</b> rtc.c:108</div></div>
 151 <div class="ttc" id="agroup__hardware__rtc_html_gabf6cc1546be8d1ddb56e3d83a915f683"><div class="ttname"><a href="group__hardware__rtc.html#gabf6cc1546be8d1ddb56e3d83a915f683">rtc_running</a></div><div class="ttdeci">bool rtc_running(void)</div><div class="ttdoc">Is the RTC running?</div><div class="ttdef"><b>Definition:</b> rtc.c:18</div></div>
 152 <div class="ttc" id="agroup__hardware__rtc_html_gacf9024748b942a7ae375cf75951afa9c"><div class="ttname"><a href="group__hardware__rtc.html#gacf9024748b942a7ae375cf75951afa9c">rtc_init</a></div><div class="ttdeci">void rtc_init(void)</div><div class="ttdoc">Initialise the RTC system.</div><div class="ttdef"><b>Definition:</b> rtc.c:22</div></div>
 153 <div class="ttc" id="apico_8h_html"><div class="ttname"><a href="pico_8h.html">pico.h</a></div></div>
 154 <div class="ttc" id="astructdatetime__t_html"><div class="ttname"><a href="structdatetime__t.html">datetime_t</a></div><div class="ttdoc">Structure containing date and time information.</div><div class="ttdef"><b>Definition:</b> types.h:106</div></div>
 155 </div><!-- fragment --></div><!-- contents -->
 156 </div><!-- doc-content -->
 157
 158         <script src="main.js"></script>
 159 </body>
 160 </html>