web/docs/types_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: pico_base/include/pico/types.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                                 v1.5.1
  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('types_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">types.h</div></div>
 106 </div><!--header-->
 107 <div class="contents">
 108 <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 _PICO_TYPES_H</span></div>
 115 <div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_TYPES_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">#ifndef __ASSEMBLER__</span></div>
 118 <div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
 119 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;pico/assert.h&quot;</span></div>
 120 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
 121 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
 122 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
 123 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
 124 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
 125 <div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uint;</div>
 126 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span> </div>
 127 <div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#ifdef NDEBUG</span></div>
 128 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">typedef</span> uint64_t <a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a>;</div>
 129 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="preprocessor">#else</span></div>
 130 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structabsolute__time__t.html">   33</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
 131 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    uint64_t _private_us_since_boot;</div>
 132 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>} <a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a>;</div>
 133 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="preprocessor">#endif</span></div>
 134 <div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
 135 <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="group__timestamp.html#ga173698876ae00331c92ed4e8c3ba98d1">   44</a></span><span class="keyword">static</span> <span class="keyword">inline</span> uint64_t <a class="code hl_function" href="group__timestamp.html#ga173698876ae00331c92ed4e8c3ba98d1">to_us_since_boot</a>(<a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a> t) {</div>
 136 <div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="preprocessor">#ifdef NDEBUG</span></div>
 137 <div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="keywordflow">return</span> t;</div>
 138 <div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="preprocessor">#else</span></div>
 139 <div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    <span class="keywordflow">return</span> t._private_us_since_boot;</div>
 140 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="preprocessor">#endif</span></div>
 141 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>}</div>
 142 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
 143 <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="group__timestamp.html#gacb69a734d588b758f1ada8af8efe6968">   59</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__timestamp.html#gacb69a734d588b758f1ada8af8efe6968">update_us_since_boot</a>(<a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a> *t, uint64_t us_since_boot) {</div>
 144 <div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#ifdef NDEBUG</span></div>
 145 <div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    *t = us_since_boot;</div>
 146 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="preprocessor">#else</span></div>
 147 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    assert(us_since_boot &lt;= INT64_MAX);</div>
 148 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    t-&gt;_private_us_since_boot = us_since_boot;</div>
 149 <div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="preprocessor">#endif</span></div>
 150 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>}</div>
 151 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
 152 <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="group__timestamp.html#ga2cf14d0bdee9614a98aa34a0e760fb89">   74</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a> <a class="code hl_function" href="group__timestamp.html#ga2cf14d0bdee9614a98aa34a0e760fb89">from_us_since_boot</a>(uint64_t us_since_boot) {</div>
 153 <div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>    <a class="code hl_struct" href="structabsolute__time__t.html">absolute_time_t</a> t;</div>
 154 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>    <a class="code hl_function" href="group__timestamp.html#gacb69a734d588b758f1ada8af8efe6968">update_us_since_boot</a>(&amp;t, us_since_boot);</div>
 155 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>    <span class="keywordflow">return</span> t;</div>
 156 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>}</div>
 157 <div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span> </div>
 158 <div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="preprocessor">#ifdef NDEBUG</span></div>
 159 <div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="preprocessor">#define ABSOLUTE_TIME_INITIALIZED_VAR(name, value) name = value</span></div>
 160 <div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="preprocessor">#else</span></div>
 161 <div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="preprocessor">#define ABSOLUTE_TIME_INITIALIZED_VAR(name, value) name = {value}</span></div>
 162 <div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="preprocessor">#endif</span></div>
 163 <div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span> </div>
 164 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structdatetime__t.html">   93</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
 165 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structdatetime__t.html#a9d974362ac5b0c3981a376888cec7a5a">   94</a></span>    int16_t <a class="code hl_variable" href="structdatetime__t.html#a9d974362ac5b0c3981a376888cec7a5a">year</a>;    </div>
 166 <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="structdatetime__t.html#a52b29dd0c5073256923e405a963a4196">   95</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#a52b29dd0c5073256923e405a963a4196">month</a>;    </div>
 167 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structdatetime__t.html#a05df8ea065455af228d01595ec169866">   96</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#a05df8ea065455af228d01595ec169866">day</a>;      </div>
 168 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="structdatetime__t.html#aa0db9feec0b9788ccf413d63ce4f63a5">   97</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#aa0db9feec0b9788ccf413d63ce4f63a5">dotw</a>;     </div>
 169 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structdatetime__t.html#a17dd24536ca75eeeb5c2dc9c4b434962">   98</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#a17dd24536ca75eeeb5c2dc9c4b434962">hour</a>;     </div>
 170 <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="structdatetime__t.html#ac6661ecb5171df31f0cf72fa6bbcbc89">   99</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#ac6661ecb5171df31f0cf72fa6bbcbc89">min</a>;      </div>
 171 <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="structdatetime__t.html#ad2b37b732b0bb89b8488beb421597331">  100</a></span>    int8_t <a class="code hl_variable" href="structdatetime__t.html#ad2b37b732b0bb89b8488beb421597331">sec</a>;      </div>
 172 <div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>} <a class="code hl_struct" href="structdatetime__t.html">datetime_t</a>;</div>
 173 <div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span> </div>
 174 <div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#define bool_to_bit(x) ((uint)!!(x))</span></div>
 175 <div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span> </div>
 176 <div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="preprocessor">#endif</span></div>
 177 <div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="preprocessor">#endif</span></div>
 178 <div class="ttc" id="agroup__timestamp_html_ga173698876ae00331c92ed4e8c3ba98d1"><div class="ttname"><a href="group__timestamp.html#ga173698876ae00331c92ed4e8c3ba98d1">to_us_since_boot</a></div><div class="ttdeci">static uint64_t to_us_since_boot(absolute_time_t t)</div><div class="ttdoc">convert an absolute_time_t into a number of microseconds since boot.</div><div class="ttdef"><b>Definition:</b> types.h:44</div></div>
 179 <div class="ttc" id="agroup__timestamp_html_ga2cf14d0bdee9614a98aa34a0e760fb89"><div class="ttname"><a href="group__timestamp.html#ga2cf14d0bdee9614a98aa34a0e760fb89">from_us_since_boot</a></div><div class="ttdeci">static absolute_time_t from_us_since_boot(uint64_t us_since_boot)</div><div class="ttdoc">convert a number of microseconds since boot to an absolute_time_t</div><div class="ttdef"><b>Definition:</b> types.h:74</div></div>
 180 <div class="ttc" id="agroup__timestamp_html_gacb69a734d588b758f1ada8af8efe6968"><div class="ttname"><a href="group__timestamp.html#gacb69a734d588b758f1ada8af8efe6968">update_us_since_boot</a></div><div class="ttdeci">static void update_us_since_boot(absolute_time_t *t, uint64_t us_since_boot)</div><div class="ttdoc">update an absolute_time_t value to represent a given number of microseconds since boot</div><div class="ttdef"><b>Definition:</b> types.h:59</div></div>
 181 <div class="ttc" id="astructabsolute__time__t_html"><div class="ttname"><a href="structabsolute__time__t.html">absolute_time_t</a></div><div class="ttdef"><b>Definition:</b> types.h:33</div></div>
 182 <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:93</div></div>
 183 <div class="ttc" id="astructdatetime__t_html_a05df8ea065455af228d01595ec169866"><div class="ttname"><a href="structdatetime__t.html#a05df8ea065455af228d01595ec169866">datetime_t::day</a></div><div class="ttdeci">int8_t day</div><div class="ttdoc">1..28,29,30,31 depending on month</div><div class="ttdef"><b>Definition:</b> types.h:96</div></div>
 184 <div class="ttc" id="astructdatetime__t_html_a17dd24536ca75eeeb5c2dc9c4b434962"><div class="ttname"><a href="structdatetime__t.html#a17dd24536ca75eeeb5c2dc9c4b434962">datetime_t::hour</a></div><div class="ttdeci">int8_t hour</div><div class="ttdoc">0..23</div><div class="ttdef"><b>Definition:</b> types.h:98</div></div>
 185 <div class="ttc" id="astructdatetime__t_html_a52b29dd0c5073256923e405a963a4196"><div class="ttname"><a href="structdatetime__t.html#a52b29dd0c5073256923e405a963a4196">datetime_t::month</a></div><div class="ttdeci">int8_t month</div><div class="ttdoc">1..12, 1 is January</div><div class="ttdef"><b>Definition:</b> types.h:95</div></div>
 186 <div class="ttc" id="astructdatetime__t_html_a9d974362ac5b0c3981a376888cec7a5a"><div class="ttname"><a href="structdatetime__t.html#a9d974362ac5b0c3981a376888cec7a5a">datetime_t::year</a></div><div class="ttdeci">int16_t year</div><div class="ttdoc">0..4095</div><div class="ttdef"><b>Definition:</b> types.h:94</div></div>
 187 <div class="ttc" id="astructdatetime__t_html_aa0db9feec0b9788ccf413d63ce4f63a5"><div class="ttname"><a href="structdatetime__t.html#aa0db9feec0b9788ccf413d63ce4f63a5">datetime_t::dotw</a></div><div class="ttdeci">int8_t dotw</div><div class="ttdoc">0..6, 0 is Sunday</div><div class="ttdef"><b>Definition:</b> types.h:97</div></div>
 188 <div class="ttc" id="astructdatetime__t_html_ac6661ecb5171df31f0cf72fa6bbcbc89"><div class="ttname"><a href="structdatetime__t.html#ac6661ecb5171df31f0cf72fa6bbcbc89">datetime_t::min</a></div><div class="ttdeci">int8_t min</div><div class="ttdoc">0..59</div><div class="ttdef"><b>Definition:</b> types.h:99</div></div>
 189 <div class="ttc" id="astructdatetime__t_html_ad2b37b732b0bb89b8488beb421597331"><div class="ttname"><a href="structdatetime__t.html#ad2b37b732b0bb89b8488beb421597331">datetime_t::sec</a></div><div class="ttdeci">int8_t sec</div><div class="ttdoc">0..59</div><div class="ttdef"><b>Definition:</b> types.h:100</div></div>
 190 </div><!-- fragment --></div><!-- contents -->
 191 </div><!-- doc-content -->
 192
 193         <script src="main.js"></script>
 194 </body>
 195 </html>