mirror of
https://github.com/buildwithparallel/mm-iot-sdk
synced 2026-08-10 21:27:58 -04:00
4f4eb7fc7a
This commit introduces version 2.9.7 of the Morse Micro MM-IoT-SDK for ARM microcontroller base platforms.
413 lines
26 KiB
HTML
413 lines
26 KiB
HTML
<!-- 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: Assertions and failure handling</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
|
|
 <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&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>
|
|
</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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__MMOSAL__ASSERT.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="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Assertions and failure handling<div class="ingroups"><a class="el" href="group__MMOSAL.html">Morse Micro Operating System Abstraction Layer (mmosal) API</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p >Provides support for assertions and logging failure data. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmmosal__failure__info.html">mmosal_failure_info</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data structure used to store information about a failure that can be preserved across reset. <a href="structmmosal__failure__info.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gae9a238e70e8ae1b8da15fe9ca36f802e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#gae9a238e70e8ae1b8da15fe9ca36f802e">MMOSAL_FILEID</a>   0</td></tr>
|
|
<tr class="memdesc:gae9a238e70e8ae1b8da15fe9ca36f802e"><td class="mdescLeft"> </td><td class="mdescRight">File identifier: if not provided by compiler then define to zero. <a href="group__MMOSAL__ASSERT.html#gae9a238e70e8ae1b8da15fe9ca36f802e">More...</a><br /></td></tr>
|
|
<tr class="separator:gae9a238e70e8ae1b8da15fe9ca36f802e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga98c9317eeccabe1644c790812bcad227"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga98c9317eeccabe1644c790812bcad227">MMOSAL_MAX_FAILURE_RECORDS</a>   4</td></tr>
|
|
<tr class="memdesc:ga98c9317eeccabe1644c790812bcad227"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of failure records to buffer (must be a power of 2). <a href="group__MMOSAL__ASSERT.html#ga98c9317eeccabe1644c790812bcad227">More...</a><br /></td></tr>
|
|
<tr class="separator:ga98c9317eeccabe1644c790812bcad227"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga85c232ca83d2375318386c4ea49c7b17"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga85c232ca83d2375318386c4ea49c7b17">MMOSAL_LOG_FAILURE_INFO</a>(...)</td></tr>
|
|
<tr class="memdesc:ga85c232ca83d2375318386c4ea49c7b17"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a <a class="el" href="structmmosal__failure__info.html" title="Data structure used to store information about a failure that can be preserved across reset.">mmosal_failure_info</a> struct based on current state and invoke <a class="el" href="group__MMOSAL__ASSERT.html#ga351ea740e61f98a4e92442ace45ab24e" title="Log failure information in a way that it is preserved across reboots so that it can be available for ...">mmosal_log_failure_info()</a>. <a href="group__MMOSAL__ASSERT.html#ga85c232ca83d2375318386c4ea49c7b17">More...</a><br /></td></tr>
|
|
<tr class="separator:ga85c232ca83d2375318386c4ea49c7b17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9bae87b1059a31f390403d647b73e4b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga9bae87b1059a31f390403d647b73e4b9">MMOSAL_ASSERT</a>(expr)</td></tr>
|
|
<tr class="memdesc:ga9bae87b1059a31f390403d647b73e4b9"><td class="mdescLeft"> </td><td class="mdescRight">Assert that the given expression evaluates to true and abort execution if not. <a href="group__MMOSAL__ASSERT.html#ga9bae87b1059a31f390403d647b73e4b9">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9bae87b1059a31f390403d647b73e4b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga54003ace4e888bdbcd9fdd52334a9f96"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga54003ace4e888bdbcd9fdd52334a9f96">MMOSAL_ASSERT_LOG_DATA</a>(expr, ...)</td></tr>
|
|
<tr class="memdesc:ga54003ace4e888bdbcd9fdd52334a9f96"><td class="mdescLeft"> </td><td class="mdescRight">Assert that the given expression evaluates to true and abort execution if not. <a href="group__MMOSAL__ASSERT.html#ga54003ace4e888bdbcd9fdd52334a9f96">More...</a><br /></td></tr>
|
|
<tr class="separator:ga54003ace4e888bdbcd9fdd52334a9f96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab53fa43784adb38e9bbcad684ab57ecf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#gab53fa43784adb38e9bbcad684ab57ecf">MMOSAL_DEV_ASSERT</a>(x)   ((void)(x))</td></tr>
|
|
<tr class="memdesc:gab53fa43784adb38e9bbcad684ab57ecf"><td class="mdescLeft"> </td><td class="mdescRight">Assertions that are only enabled for debug builds. <a href="group__MMOSAL__ASSERT.html#gab53fa43784adb38e9bbcad684ab57ecf">More...</a><br /></td></tr>
|
|
<tr class="separator:gab53fa43784adb38e9bbcad684ab57ecf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaed754648f1810c1f44ed48ad8debbfa1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#gaed754648f1810c1f44ed48ad8debbfa1">MMOSAL_DEV_ASSERT_LOG_DATA</a>(x, ...)   ((void)(x))</td></tr>
|
|
<tr class="memdesc:gaed754648f1810c1f44ed48ad8debbfa1"><td class="mdescLeft"> </td><td class="mdescRight">Assertions that are only enabled for debug builds (with support for up to 4 <code>uint32_t's</code> to be logged). <a href="group__MMOSAL__ASSERT.html#gaed754648f1810c1f44ed48ad8debbfa1">More...</a><br /></td></tr>
|
|
<tr class="separator:gaed754648f1810c1f44ed48ad8debbfa1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga351ea740e61f98a4e92442ace45ab24e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga351ea740e61f98a4e92442ace45ab24e">mmosal_log_failure_info</a> (const struct <a class="el" href="structmmosal__failure__info.html">mmosal_failure_info</a> *info)</td></tr>
|
|
<tr class="memdesc:ga351ea740e61f98a4e92442ace45ab24e"><td class="mdescLeft"> </td><td class="mdescRight">Log failure information in a way that it is preserved across reboots so that it can be available for postmortem analysis. <a href="group__MMOSAL__ASSERT.html#ga351ea740e61f98a4e92442ace45ab24e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga351ea740e61f98a4e92442ace45ab24e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga41b8d9eb883471f448679cc06cf322e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MMOSAL__ASSERT.html#ga41b8d9eb883471f448679cc06cf322e0">mmosal_impl_assert</a> (void)</td></tr>
|
|
<tr class="memdesc:ga41b8d9eb883471f448679cc06cf322e0"><td class="mdescLeft"> </td><td class="mdescRight">Assertion handler implementation. <a href="group__MMOSAL__ASSERT.html#ga41b8d9eb883471f448679cc06cf322e0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga41b8d9eb883471f448679cc06cf322e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga9bae87b1059a31f390403d647b73e4b9" name="ga9bae87b1059a31f390403d647b73e4b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9bae87b1059a31f390403d647b73e4b9">◆ </a></span>MMOSAL_ASSERT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_ASSERT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">expr</td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
|
|
<div class="line"> if (!(expr)) { \</div>
|
|
<div class="line"> MMOSAL_LOG_FAILURE_INFO(0); \</div>
|
|
<div class="line"> mmosal_impl_assert(); \</div>
|
|
<div class="line"> while (1) \</div>
|
|
<div class="line"> {} \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
|
|
</div><!-- fragment -->
|
|
<p>Assert that the given expression evaluates to true and abort execution if not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">expr</td><td>Expression to evaluation. If it evaluates to <code>false</code> then the assertion handler will be triggered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00927">927</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga54003ace4e888bdbcd9fdd52334a9f96" name="ga54003ace4e888bdbcd9fdd52334a9f96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga54003ace4e888bdbcd9fdd52334a9f96">◆ </a></span>MMOSAL_ASSERT_LOG_DATA</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_ASSERT_LOG_DATA</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">expr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
|
|
<div class="line"> if (!(expr)) { \</div>
|
|
<div class="line"> MMOSAL_LOG_FAILURE_INFO(__VA_ARGS__); \</div>
|
|
<div class="line"> mmosal_impl_assert(); \</div>
|
|
<div class="line"> while (1) \</div>
|
|
<div class="line"> {} \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
|
|
</div><!-- fragment -->
|
|
<p>Assert that the given expression evaluates to true and abort execution if not. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">expr</td><td>Expression to evaluation. If it evaluates to <code>false</code> then the assertion handler will be triggered. </td></tr>
|
|
<tr><td class="paramname">...</td><td>Up to 4 32-bit unsigned integers to log. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00946">946</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab53fa43784adb38e9bbcad684ab57ecf" name="gab53fa43784adb38e9bbcad684ab57ecf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab53fa43784adb38e9bbcad684ab57ecf">◆ </a></span>MMOSAL_DEV_ASSERT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_DEV_ASSERT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">x</td><td>)</td>
|
|
<td>   ((void)(x))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assertions that are only enabled for debug builds. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00971">971</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaed754648f1810c1f44ed48ad8debbfa1" name="gaed754648f1810c1f44ed48ad8debbfa1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaed754648f1810c1f44ed48ad8debbfa1">◆ </a></span>MMOSAL_DEV_ASSERT_LOG_DATA</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_DEV_ASSERT_LOG_DATA</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">x, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   ((void)(x))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assertions that are only enabled for debug builds (with support for up to 4 <code>uint32_t's</code> to be logged). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00974">974</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae9a238e70e8ae1b8da15fe9ca36f802e" name="gae9a238e70e8ae1b8da15fe9ca36f802e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae9a238e70e8ae1b8da15fe9ca36f802e">◆ </a></span>MMOSAL_FILEID</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_FILEID   0</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>File identifier: if not provided by compiler then define to zero. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00856">856</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga85c232ca83d2375318386c4ea49c7b17" name="ga85c232ca83d2375318386c4ea49c7b17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga85c232ca83d2375318386c4ea49c7b17">◆ </a></span>MMOSAL_LOG_FAILURE_INFO</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_LOG_FAILURE_INFO</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
|
|
<div class="line"> void *pc; \</div>
|
|
<div class="line"> struct <a class="code hl_struct" href="structmmosal__failure__info.html">mmosal_failure_info</a> info = { \</div>
|
|
<div class="line"> .<a class="code hl_variable" href="structmmosal__failure__info.html#a530aa0570e831d7bbc8c498732f8e85e">lr</a> = (uint32_t)MMPORT_GET_LR(), \</div>
|
|
<div class="line"> .fileid = <a class="code hl_define" href="group__MMOSAL__ASSERT.html#gae9a238e70e8ae1b8da15fe9ca36f802e">MMOSAL_FILEID</a>, \</div>
|
|
<div class="line"> .line = __LINE__, \</div>
|
|
<div class="line"> .platform_info = { __VA_ARGS__ }, \</div>
|
|
<div class="line"> }; \</div>
|
|
<div class="line"> MMPORT_GET_PC(pc); \</div>
|
|
<div class="line"> info.pc = (uint32_t)pc; \</div>
|
|
<div class="line"> mmosal_log_failure_info(&info); \</div>
|
|
<div class="line"> } <span class="keywordflow">while</span> (0)</div>
|
|
<div class="ttc" id="agroup__MMOSAL__ASSERT_html_gae9a238e70e8ae1b8da15fe9ca36f802e"><div class="ttname"><a href="group__MMOSAL__ASSERT.html#gae9a238e70e8ae1b8da15fe9ca36f802e">MMOSAL_FILEID</a></div><div class="ttdeci">#define MMOSAL_FILEID</div><div class="ttdoc">File identifier: if not provided by compiler then define to zero.</div><div class="ttdef"><b>Definition:</b> <a href="mmosal_8h_source.html#l00856">mmosal.h:856</a></div></div>
|
|
<div class="ttc" id="astructmmosal__failure__info_html"><div class="ttname"><a href="structmmosal__failure__info.html">mmosal_failure_info</a></div><div class="ttdoc">Data structure used to store information about a failure that can be preserved across reset.</div><div class="ttdef"><b>Definition:</b> <a href="mmosal_8h_source.html#l00868">mmosal.h:869</a></div></div>
|
|
<div class="ttc" id="astructmmosal__failure__info_html_a530aa0570e831d7bbc8c498732f8e85e"><div class="ttname"><a href="structmmosal__failure__info.html#a530aa0570e831d7bbc8c498732f8e85e">mmosal_failure_info::lr</a></div><div class="ttdeci">uint32_t lr</div><div class="ttdoc">Content of the LR register at assertion.</div><div class="ttdef"><b>Definition:</b> <a href="mmosal_8h_source.html#l00873">mmosal.h:873</a></div></div>
|
|
</div><!-- fragment -->
|
|
<p>Initialize a <a class="el" href="structmmosal__failure__info.html" title="Data structure used to store information about a failure that can be preserved across reset.">mmosal_failure_info</a> struct based on current state and invoke <a class="el" href="group__MMOSAL__ASSERT.html#ga351ea740e61f98a4e92442ace45ab24e" title="Log failure information in a way that it is preserved across reboots so that it can be available for ...">mmosal_log_failure_info()</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00897">897</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga98c9317eeccabe1644c790812bcad227" name="ga98c9317eeccabe1644c790812bcad227"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga98c9317eeccabe1644c790812bcad227">◆ </a></span>MMOSAL_MAX_FAILURE_RECORDS</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MMOSAL_MAX_FAILURE_RECORDS   4</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Maximum number of failure records to buffer (must be a power of 2). </p>
|
|
<p >Defaults to 4 if no platform-specific definition exists. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal_8h_source.html#l00864">864</a> of file <a class="el" href="mmosal_8h_source.html">mmosal.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga41b8d9eb883471f448679cc06cf322e0" name="ga41b8d9eb883471f448679cc06cf322e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga41b8d9eb883471f448679cc06cf322e0">◆ </a></span>mmosal_impl_assert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mmosal_impl_assert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assertion handler implementation. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This function does not return. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal__shim__bootloader_8c_source.html#l00108">108</a> of file <a class="el" href="mmosal__shim__bootloader_8c_source.html">mmosal_shim_bootloader.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga351ea740e61f98a4e92442ace45ab24e" name="ga351ea740e61f98a4e92442ace45ab24e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga351ea740e61f98a4e92442ace45ab24e">◆ </a></span>mmosal_log_failure_info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mmosal_log_failure_info </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const struct <a class="el" href="structmmosal__failure__info.html">mmosal_failure_info</a> * </td>
|
|
<td class="paramname"><em>info</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Log failure information in a way that it is preserved across reboots so that it can be available for postmortem analysis. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">info</td><td>Failure information to log. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mmosal__shim__bootloader_8c_source.html#l00114">114</a> of file <a class="el" href="mmosal__shim__bootloader_8c_source.html">mmosal_shim_bootloader.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|