parallel-ref/mm-iot-sdk
1
0
Fork 0
mirror of https://github.com/buildwithparallel/mm-iot-sdk synced 2026-08-10 21:27:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
mm-iot-sdk/framework/doc/html/hooks_8c_source.html
Morse Micro 4f4eb7fc7a Morse Micro MM-IoT-SDK release 2.9.7 
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK
for ARM microcontroller base platforms.
2025-10-04 02:04:28 +10:00

197 lines
19 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.17-->
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Morse Micro IoT SDK: hooks.c 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="style.css" rel="stylesheet" type="text/css"/>
<link rel="shortcut icon" href="favicon.svg" />
</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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Morse Micro IoT SDK
&#160;<span id="projectnumber">2.9.7</span>
</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('hooks_8c_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">hooks.c</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"> * Copyright 2021-2023 Morse Micro</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"> * SPDX-License-Identifier: MIT</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> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;FreeRTOS.h&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;task.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;queue.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;mmhal.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keywordtype">void</span> vApplicationMallocFailedHook(<span class="keywordtype">void</span>)</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* This hook function that will be called if configUSE_MALLOC_FAILED_HOOK is set to 1 and</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * a call to pvPortMalloc() fails. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> configABORT();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>}</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keywordtype">void</span> vApplicationStackOverflowHook(TaskHandle_t pxTask, <span class="keywordtype">char</span> *pcTaskName)</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> (void)pcTaskName;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> (void)pxTask;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* This hook function will be called if configCHECK_FOR_STACK_OVERFLOW is set to 1 or 2</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * and a stack overflow is detected. */</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> configABORT();</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>}</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keywordtype">void</span> vApplicationIdleHook(<span class="keywordtype">void</span>)</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/* This hook function will be called on each iteration of the idle task if</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * configUSE_IDLE_HOOK is set to 1. */</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>}</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keywordtype">void</span> vApplicationTickHook(<span class="keywordtype">void</span>)</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>{</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/* This hook function will be called on each tick interrupt (from interrupt context)</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * if configUSE_TICK_HOOK is set to 1. */</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</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">#if (configUSE_TICKLESS_IDLE == 1)</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keywordtype">void</span> vPortSuppressTicksAndSleep(uint32_t expected_idle_time_ms)</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>{</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMHAL.html#ga38da43831c553f238544c541c94b0e44">mmhal_sleep_state</a> sleep_state;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> uint32_t elapsed_ms = 0;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">while</span> (elapsed_ms &lt; expected_idle_time_ms)</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> sleep_state = <a class="code hl_function" href="group__MMHAL.html#gaba693440d2efbbc6c36b8288489ffd04">mmhal_sleep_prepare</a>(expected_idle_time_ms - elapsed_ms);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">if</span> (sleep_state == <a class="code hl_enumvalue" href="group__MMHAL.html#gga38da43831c553f238544c541c94b0e44a362ebf9027aca6abaf0b9671b516e879">MMHAL_SLEEP_DISABLED</a>)</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/* If a context switch is pending or a task is waiting for the scheduler</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * to be unsuspended then abandon the low power entry. */</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">if</span> (eTaskConfirmSleepModeStatus() == eAbortSleep)</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_function" href="group__MMHAL.html#ga427d8210d481cb4b205a1230e0f624c8">mmhal_sleep_abort</a>(sleep_state);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> uint32_t slept_ms = <a class="code hl_function" href="group__MMHAL.html#ga2ebb1c4e63ff30a284273f221e98e3d1">mmhal_sleep</a>(sleep_state, expected_idle_time_ms - elapsed_ms);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> elapsed_ms += slept_ms;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">if</span> (sleep_state == <a class="code hl_enumvalue" href="group__MMHAL.html#gga38da43831c553f238544c541c94b0e44a7a1c40aa602a26a1c0e10b3c1493ac09">MMHAL_SLEEP_DEEP</a>)</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/* Step the FreeRTOS tick to account for any tick periods that elapsed. */</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> vTaskStepTick(slept_ms);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/* If a context switch is pending or a task is waiting for the scheduler</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * to be unsuspended then abandon the low power entry. */</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">if</span> (eTaskConfirmSleepModeStatus() == eAbortSleep)</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_function" href="group__MMHAL.html#ga427d8210d481cb4b205a1230e0f624c8">mmhal_sleep_abort</a>(sleep_state);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <a class="code hl_function" href="group__MMHAL.html#ga58f8854cefa4fe7f3fb3518c5f70bf9a">mmhal_sleep_cleanup</a>();</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> }</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span>}</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__MMHAL_html_ga2ebb1c4e63ff30a284273f221e98e3d1"><div class="ttname"><a href="group__MMHAL.html#ga2ebb1c4e63ff30a284273f221e98e3d1">mmhal_sleep</a></div><div class="ttdeci">uint32_t mmhal_sleep(enum mmhal_sleep_state sleep_state, uint32_t expected_idle_time_ms)</div><div class="ttdoc">Function to enter MCU sleep.</div></div>
<div class="ttc" id="agroup__MMHAL_html_ga38da43831c553f238544c541c94b0e44"><div class="ttname"><a href="group__MMHAL.html#ga38da43831c553f238544c541c94b0e44">mmhal_sleep_state</a></div><div class="ttdeci">mmhal_sleep_state</div><div class="ttdoc">Enumeration of MCU sleep state.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal_8h_source.html#l00058">mmhal.h:59</a></div></div>
<div class="ttc" id="agroup__MMHAL_html_ga427d8210d481cb4b205a1230e0f624c8"><div class="ttname"><a href="group__MMHAL.html#ga427d8210d481cb4b205a1230e0f624c8">mmhal_sleep_abort</a></div><div class="ttdeci">void mmhal_sleep_abort(enum mmhal_sleep_state sleep_state)</div><div class="ttdoc">Function to abort the MCU sleep state.</div></div>
<div class="ttc" id="agroup__MMHAL_html_ga58f8854cefa4fe7f3fb3518c5f70bf9a"><div class="ttname"><a href="group__MMHAL.html#ga58f8854cefa4fe7f3fb3518c5f70bf9a">mmhal_sleep_cleanup</a></div><div class="ttdeci">void mmhal_sleep_cleanup(void)</div><div class="ttdoc">Function to cleanup on exit from the MCU sleep state.</div></div>
<div class="ttc" id="agroup__MMHAL_html_gaba693440d2efbbc6c36b8288489ffd04"><div class="ttname"><a href="group__MMHAL.html#gaba693440d2efbbc6c36b8288489ffd04">mmhal_sleep_prepare</a></div><div class="ttdeci">enum mmhal_sleep_state mmhal_sleep_prepare(uint32_t expected_idle_time_ms)</div><div class="ttdoc">Function to prepare MCU to enter sleep.</div></div>
<div class="ttc" id="agroup__MMHAL_html_gga38da43831c553f238544c541c94b0e44a362ebf9027aca6abaf0b9671b516e879"><div class="ttname"><a href="group__MMHAL.html#gga38da43831c553f238544c541c94b0e44a362ebf9027aca6abaf0b9671b516e879">MMHAL_SLEEP_DISABLED</a></div><div class="ttdeci">@ MMHAL_SLEEP_DISABLED</div><div class="ttdoc">Disable MCU sleep.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal_8h_source.html#l00060">mmhal.h:60</a></div></div>
<div class="ttc" id="agroup__MMHAL_html_gga38da43831c553f238544c541c94b0e44a7a1c40aa602a26a1c0e10b3c1493ac09"><div class="ttname"><a href="group__MMHAL.html#gga38da43831c553f238544c541c94b0e44a7a1c40aa602a26a1c0e10b3c1493ac09">MMHAL_SLEEP_DEEP</a></div><div class="ttdeci">@ MMHAL_SLEEP_DEEP</div><div class="ttdoc">MCU can enter deep sleep.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal_8h_source.html#l00062">mmhal.h:62</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.17-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_2b316fbf51ac995e875dc7b728ebb0de.html">framework</a></li><li class="navelem"><a class="el" href="dir_efae593241d9aa8d7fdf89ff4311750d.html">src</a></li><li class="navelem"><a class="el" href="dir_c4048d02038b1ff7dc5ca6547b496387.html">freertos</a></li><li class="navelem"><a class="el" href="dir_ed3208a3444601d47aa4c7641227eb1c.html">mmiot</a></li><li class="navelem"><b>hooks.c</b></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink