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/mmhal__uart_8h_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

153 lines
15 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: mmhal_uart.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="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('mmhal__uart_8h_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">mmhal_uart.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"> * Copyright 2024 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: Apache-2.0</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="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &quot;mmhal.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &quot;mmosal.h&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#ga240b9a33c2c7df9ce753d74a4844b8de"> 45</a></span><span class="keyword">typedef</span> void (*<a class="code hl_typedef" href="group__MMHAL__UART.html#ga240b9a33c2c7df9ce753d74a4844b8de">mmhal_uart_rx_cb_t</a>)(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> length, <span class="keywordtype">void</span> *arg);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#gad368f1afcc9094ac2ff4c85a1be3c4c0"> 53</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__MMHAL__UART.html#gad368f1afcc9094ac2ff4c85a1be3c4c0">mmhal_uart_init</a>(<a class="code hl_typedef" href="group__MMHAL__UART.html#ga240b9a33c2c7df9ce753d74a4844b8de">mmhal_uart_rx_cb_t</a> rx_cb, <span class="keywordtype">void</span> *rx_cb_arg);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#ga35f7c10c7d83c9c92105f2637ac59f73"> 58</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__MMHAL__UART.html#ga35f7c10c7d83c9c92105f2637ac59f73">mmhal_uart_deinit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#ga22114935cff34ea4bdf3d714acdda560"> 67</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="group__MMHAL__UART.html#ga22114935cff34ea4bdf3d714acdda560">mmhal_uart_tx</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> length);</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> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c"> 71</a></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c">mmhal_uart_deep_sleep_mode</a></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span>{</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134"> 74</a></span> <a class="code hl_enumvalue" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134">MMHAL_UART_DEEP_SLEEP_DISABLED</a>,</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73"> 76</a></span> <a class="code hl_enumvalue" href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73">MMHAL_UART_DEEP_SLEEP_ONE_SHOT</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> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="group__MMHAL__UART.html#gaf31cd17018e1bd3a8387de5a038fd06c"> 87</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__MMHAL__UART.html#gaf31cd17018e1bd3a8387de5a038fd06c">mmhal_uart_set_deep_sleep_mode</a>(<span class="keyword">enum</span> <a class="code hl_enumeration" href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c">mmhal_uart_deep_sleep_mode</a> mode);</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><span class="preprocessor">#ifdef __cplusplus</span></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><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga22114935cff34ea4bdf3d714acdda560"><div class="ttname"><a href="group__MMHAL__UART.html#ga22114935cff34ea4bdf3d714acdda560">mmhal_uart_tx</a></div><div class="ttdeci">void mmhal_uart_tx(const uint8_t *data, size_t length)</div><div class="ttdoc">Transmit data on the UART.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga240b9a33c2c7df9ce753d74a4844b8de"><div class="ttname"><a href="group__MMHAL__UART.html#ga240b9a33c2c7df9ce753d74a4844b8de">mmhal_uart_rx_cb_t</a></div><div class="ttdeci">void(* mmhal_uart_rx_cb_t)(const uint8_t *data, size_t length, void *arg)</div><div class="ttdoc">Function type for UART RX callback.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00045">mmhal_uart.h:45</a></div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga35f7c10c7d83c9c92105f2637ac59f73"><div class="ttname"><a href="group__MMHAL__UART.html#ga35f7c10c7d83c9c92105f2637ac59f73">mmhal_uart_deinit</a></div><div class="ttdeci">void mmhal_uart_deinit(void)</div><div class="ttdoc">Deinitialize the UART HAL, and disable the UART.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_ga88024c213665f84c6273777704117b8c"><div class="ttname"><a href="group__MMHAL__UART.html#ga88024c213665f84c6273777704117b8c">mmhal_uart_deep_sleep_mode</a></div><div class="ttdeci">mmhal_uart_deep_sleep_mode</div><div class="ttdoc">Enumeration of deep sleep modes for the UART HAL.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00071">mmhal_uart.h:72</a></div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gad368f1afcc9094ac2ff4c85a1be3c4c0"><div class="ttname"><a href="group__MMHAL__UART.html#gad368f1afcc9094ac2ff4c85a1be3c4c0">mmhal_uart_init</a></div><div class="ttdeci">void mmhal_uart_init(mmhal_uart_rx_cb_t rx_cb, void *rx_cb_arg)</div><div class="ttdoc">Initialize the UART HAL and perform any setup necessary.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gaf31cd17018e1bd3a8387de5a038fd06c"><div class="ttname"><a href="group__MMHAL__UART.html#gaf31cd17018e1bd3a8387de5a038fd06c">mmhal_uart_set_deep_sleep_mode</a></div><div class="ttdeci">bool mmhal_uart_set_deep_sleep_mode(enum mmhal_uart_deep_sleep_mode mode)</div><div class="ttdoc">Set the deep sleep mode for the UART.</div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73"><div class="ttname"><a href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca0eb6679f719abcc8c7aed5a74f405d73">MMHAL_UART_DEEP_SLEEP_ONE_SHOT</a></div><div class="ttdeci">@ MMHAL_UART_DEEP_SLEEP_ONE_SHOT</div><div class="ttdoc">Enable deep sleep until activity occurs on data-link transport.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00076">mmhal_uart.h:76</a></div></div>
<div class="ttc" id="agroup__MMHAL__UART_html_gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134"><div class="ttname"><a href="group__MMHAL__UART.html#gga88024c213665f84c6273777704117b8ca5cdc4ec8e6be8869746c7e39725b1134">MMHAL_UART_DEEP_SLEEP_DISABLED</a></div><div class="ttdeci">@ MMHAL_UART_DEEP_SLEEP_DISABLED</div><div class="ttdoc">Deep sleep mode is disabled.</div><div class="ttdef"><b>Definition:</b> <a href="mmhal__uart_8h_source.html#l00074">mmhal_uart.h:74</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_81ef0fb1c5d83934621da892b9e3f6f6.html">morselib</a></li><li class="navelem"><a class="el" href="dir_bd756646489e9e9d67d91307eca56693.html">include</a></li><li class="navelem"><b>mmhal_uart.h</b></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink