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.
254 lines
14 KiB
HTML
254 lines
14 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: Morse BINary Loader API</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__MBIN.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="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle"><div class="title">Morse BINary Loader API</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p >This file defines the structure of the <code>MBIN</code> file. </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="structmbin__tlv__hdr.html">mbin_tlv_hdr</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">TLV header data structure. <a href="structmbin__tlv__hdr.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbin__segment__hdr.html">mbin_segment_hdr</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data header in a FIELD_TYPE_XX_SEGMENT field. <a href="structmbin__segment__hdr.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbin__deflated__segment__hdr.html">mbin_deflated_segment_hdr</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data header in a FIELD_TYPE_XX_SEGMENT_DEFLATED field. <a href="structmbin__deflated__segment__hdr.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmbin__regdom__hdr.html">mbin_regdom_hdr</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data header in a <code>FIELD_TYPE_BCF_REGDOM</code> field. <a href="structmbin__regdom__hdr.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:ga36d525cf4d116b2fe4ecc00222b256f1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MBIN.html#ga36d525cf4d116b2fe4ecc00222b256f1">PACKED</a>   __attribute__((packed))</td></tr>
|
|
<tr class="memdesc:ga36d525cf4d116b2fe4ecc00222b256f1"><td class="mdescLeft"> </td><td class="mdescRight">Macro for the compiler packed attribute. <a href="group__MBIN.html#ga36d525cf4d116b2fe4ecc00222b256f1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga36d525cf4d116b2fe4ecc00222b256f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5741dea85b112cfa0965f8fac9faa299"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MBIN.html#ga5741dea85b112cfa0965f8fac9faa299">MBIN_SW_MAGIC_NUMBER</a>   (0x57534d4d)</td></tr>
|
|
<tr class="memdesc:ga5741dea85b112cfa0965f8fac9faa299"><td class="mdescLeft"> </td><td class="mdescRight">Expected value of the magic field for a SW image <code>MMSW</code>. <a href="group__MBIN.html#ga5741dea85b112cfa0965f8fac9faa299">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5741dea85b112cfa0965f8fac9faa299"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga19596314ce03f3c5a77c7134a9f6b1c8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MBIN.html#ga19596314ce03f3c5a77c7134a9f6b1c8">MBIN_FW_MAGIC_NUMBER</a>   (0x57464d4d)</td></tr>
|
|
<tr class="memdesc:ga19596314ce03f3c5a77c7134a9f6b1c8"><td class="mdescLeft"> </td><td class="mdescRight">Expected value of the magic field for a firmware image <code>MMFW</code>. <a href="group__MBIN.html#ga19596314ce03f3c5a77c7134a9f6b1c8">More...</a><br /></td></tr>
|
|
<tr class="separator:ga19596314ce03f3c5a77c7134a9f6b1c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf8500f1e9eadc1323f4f0d971d9a6b91"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MBIN.html#gaf8500f1e9eadc1323f4f0d971d9a6b91">MBIN_BCF_MAGIC_NUMBER</a>   (0x43424d4d)</td></tr>
|
|
<tr class="memdesc:gaf8500f1e9eadc1323f4f0d971d9a6b91"><td class="mdescLeft"> </td><td class="mdescRight">Expected value of the magic field for a BCF <code>MMBC</code>. <a href="group__MBIN.html#gaf8500f1e9eadc1323f4f0d971d9a6b91">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf8500f1e9eadc1323f4f0d971d9a6b91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gab0d3f4ede88ad76c355d75fef726ba43"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__MBIN.html#gab0d3f4ede88ad76c355d75fef726ba43">mbin_tlv_types</a> { <br />
|
|
  <b>FIELD_TYPE_FW_TLV_BCF_ADDR</b> = 0x0001
|
|
, <b>FIELD_TYPE_MAGIC</b> = 0x8000
|
|
, <b>FIELD_TYPE_FW_SEGMENT</b> = 0x8001
|
|
, <b>FIELD_TYPE_FW_SEGMENT_DEFLATED</b> = 0x8002
|
|
, <br />
|
|
  <b>FIELD_TYPE_BCF_BOARD_CONFIG</b> = 0x8100
|
|
, <b>FIELD_TYPE_BCF_REGDOM</b> = 0x8101
|
|
, <b>FIELD_TYPE_BCF_BOARD_DESC</b> = 0x8102
|
|
, <b>FIELD_TYPE_BCF_BUILD_VER</b> = 0x8103
|
|
, <br />
|
|
  <b>FIELD_TYPE_SW_SEGMENT</b> = 0x8201
|
|
, <b>FIELD_TYPE_SW_SEGMENT_DEFLATED</b> = 0x8202
|
|
, <b>FIELD_TYPE_EOF</b> = 0x8f00
|
|
, <b>FIELD_TYPE_EOF_WITH_SIGNATURE</b> = 0x8f01
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:gab0d3f4ede88ad76c355d75fef726ba43"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of TLV field types. <a href="group__MBIN.html#gab0d3f4ede88ad76c355d75fef726ba43">More...</a><br /></td></tr>
|
|
<tr class="separator:gab0d3f4ede88ad76c355d75fef726ba43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="gaf8500f1e9eadc1323f4f0d971d9a6b91" name="gaf8500f1e9eadc1323f4f0d971d9a6b91"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf8500f1e9eadc1323f4f0d971d9a6b91">◆ </a></span>MBIN_BCF_MAGIC_NUMBER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MBIN_BCF_MAGIC_NUMBER   (0x43424d4d)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Expected value of the magic field for a BCF <code>MMBC</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mbin_8h_source.html#l00080">80</a> of file <a class="el" href="mbin_8h_source.html">mbin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga19596314ce03f3c5a77c7134a9f6b1c8" name="ga19596314ce03f3c5a77c7134a9f6b1c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga19596314ce03f3c5a77c7134a9f6b1c8">◆ </a></span>MBIN_FW_MAGIC_NUMBER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MBIN_FW_MAGIC_NUMBER   (0x57464d4d)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Expected value of the magic field for a firmware image <code>MMFW</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mbin_8h_source.html#l00078">78</a> of file <a class="el" href="mbin_8h_source.html">mbin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5741dea85b112cfa0965f8fac9faa299" name="ga5741dea85b112cfa0965f8fac9faa299"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5741dea85b112cfa0965f8fac9faa299">◆ </a></span>MBIN_SW_MAGIC_NUMBER</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MBIN_SW_MAGIC_NUMBER   (0x57534d4d)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Expected value of the magic field for a SW image <code>MMSW</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mbin_8h_source.html#l00076">76</a> of file <a class="el" href="mbin_8h_source.html">mbin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga36d525cf4d116b2fe4ecc00222b256f1" name="ga36d525cf4d116b2fe4ecc00222b256f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga36d525cf4d116b2fe4ecc00222b256f1">◆ </a></span>PACKED</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PACKED   __attribute__((packed))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Macro for the compiler packed attribute. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mbin_8h_source.html#l00019">19</a> of file <a class="el" href="mbin_8h_source.html">mbin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gab0d3f4ede88ad76c355d75fef726ba43" name="gab0d3f4ede88ad76c355d75fef726ba43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab0d3f4ede88ad76c355d75fef726ba43">◆ </a></span>mbin_tlv_types</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__MBIN.html#gab0d3f4ede88ad76c355d75fef726ba43">mbin_tlv_types</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration of TLV field types. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mbin_8h_source.html#l00023">23</a> of file <a class="el" href="mbin_8h_source.html">mbin.h</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>
|