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.
267 lines
14 KiB
HTML
267 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: chip_cfg Struct Reference</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('structchip__cfg.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="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">chip_cfg Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Chip configuration data structure. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00015">15</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
</div>
|
|
<p><code>#include <<a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:aac7dca6b93b5a47657dd9e250c849990"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#aac7dca6b93b5a47657dd9e250c849990">name</a></td></tr>
|
|
<tr class="memdesc:aac7dca6b93b5a47657dd9e250c849990"><td class="mdescLeft"> </td><td class="mdescRight">Chip name. <a href="structchip__cfg.html#aac7dca6b93b5a47657dd9e250c849990">More...</a><br /></td></tr>
|
|
<tr class="separator:aac7dca6b93b5a47657dd9e250c849990"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2990645d0d8b9c330c59f2e48d50d08"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#ac2990645d0d8b9c330c59f2e48d50d08">reg_chip_id</a></td></tr>
|
|
<tr class="memdesc:ac2990645d0d8b9c330c59f2e48d50d08"><td class="mdescLeft"> </td><td class="mdescRight">Address of the chip ID register. <a href="structchip__cfg.html#ac2990645d0d8b9c330c59f2e48d50d08">More...</a><br /></td></tr>
|
|
<tr class="separator:ac2990645d0d8b9c330c59f2e48d50d08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55a9beca8f607e56375db6deb0599065"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#a55a9beca8f607e56375db6deb0599065">gpio_set_oe</a> )(uint8_t gpio_num, bool oe)</td></tr>
|
|
<tr class="memdesc:a55a9beca8f607e56375db6deb0599065"><td class="mdescLeft"> </td><td class="mdescRight">Function to set GPIO output enable. <a href="structchip__cfg.html#a55a9beca8f607e56375db6deb0599065">More...</a><br /></td></tr>
|
|
<tr class="separator:a55a9beca8f607e56375db6deb0599065"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5310e821dc80760394b96d44de04e6a3"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#a5310e821dc80760394b96d44de04e6a3">gpio_set_value</a> )(uint8_t gpio_num, bool value)</td></tr>
|
|
<tr class="memdesc:a5310e821dc80760394b96d44de04e6a3"><td class="mdescLeft"> </td><td class="mdescRight">Function to set GPIO value. <a href="structchip__cfg.html#a5310e821dc80760394b96d44de04e6a3">More...</a><br /></td></tr>
|
|
<tr class="separator:a5310e821dc80760394b96d44de04e6a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71e1389ae2b09722e325b5f2209d4de8"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#a71e1389ae2b09722e325b5f2209d4de8">busy_gpio_num</a></td></tr>
|
|
<tr class="memdesc:a71e1389ae2b09722e325b5f2209d4de8"><td class="mdescLeft"> </td><td class="mdescRight">Busy GPIO number. <a href="structchip__cfg.html#a71e1389ae2b09722e325b5f2209d4de8">More...</a><br /></td></tr>
|
|
<tr class="separator:a71e1389ae2b09722e325b5f2209d4de8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d5735d4eee454b11781751319dd7dc0"><td class="memItemLeft" align="right" valign="top">const uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#a0d5735d4eee454b11781751319dd7dc0">valid_chip_ids</a></td></tr>
|
|
<tr class="memdesc:a0d5735d4eee454b11781751319dd7dc0"><td class="mdescLeft"> </td><td class="mdescRight">List of valid chip IDs for this configuration. <a href="structchip__cfg.html#a0d5735d4eee454b11781751319dd7dc0">More...</a><br /></td></tr>
|
|
<tr class="separator:a0d5735d4eee454b11781751319dd7dc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6fd84b399c5ddf30d4bef87c98c7e848"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structchip__cfg.html#a6fd84b399c5ddf30d4bef87c98c7e848">n_valid_chip_ids</a></td></tr>
|
|
<tr class="memdesc:a6fd84b399c5ddf30d4bef87c98c7e848"><td class="mdescLeft"> </td><td class="mdescRight">Number of valid chip IDs in <code>valid_chip_ids</code>. <a href="structchip__cfg.html#a6fd84b399c5ddf30d4bef87c98c7e848">More...</a><br /></td></tr>
|
|
<tr class="separator:a6fd84b399c5ddf30d4bef87c98c7e848"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a71e1389ae2b09722e325b5f2209d4de8" name="a71e1389ae2b09722e325b5f2209d4de8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71e1389ae2b09722e325b5f2209d4de8">◆ </a></span>busy_gpio_num</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t chip_cfg::busy_gpio_num</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Busy GPIO number. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00026">26</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55a9beca8f607e56375db6deb0599065" name="a55a9beca8f607e56375db6deb0599065"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55a9beca8f607e56375db6deb0599065">◆ </a></span>gpio_set_oe</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int(* chip_cfg::gpio_set_oe) (uint8_t gpio_num, bool oe)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to set GPIO output enable. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00022">22</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5310e821dc80760394b96d44de04e6a3" name="a5310e821dc80760394b96d44de04e6a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5310e821dc80760394b96d44de04e6a3">◆ </a></span>gpio_set_value</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int(* chip_cfg::gpio_set_value) (uint8_t gpio_num, bool value)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function to set GPIO value. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00024">24</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6fd84b399c5ddf30d4bef87c98c7e848" name="a6fd84b399c5ddf30d4bef87c98c7e848"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6fd84b399c5ddf30d4bef87c98c7e848">◆ </a></span>n_valid_chip_ids</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t chip_cfg::n_valid_chip_ids</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of valid chip IDs in <code>valid_chip_ids</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00030">30</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac7dca6b93b5a47657dd9e250c849990" name="aac7dca6b93b5a47657dd9e250c849990"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac7dca6b93b5a47657dd9e250c849990">◆ </a></span>name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* chip_cfg::name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Chip name. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00018">18</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2990645d0d8b9c330c59f2e48d50d08" name="ac2990645d0d8b9c330c59f2e48d50d08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2990645d0d8b9c330c59f2e48d50d08">◆ </a></span>reg_chip_id</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t chip_cfg::reg_chip_id</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Address of the chip ID register. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00020">20</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d5735d4eee454b11781751319dd7dc0" name="a0d5735d4eee454b11781751319dd7dc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d5735d4eee454b11781751319dd7dc0">◆ </a></span>valid_chip_ids</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint32_t* chip_cfg::valid_chip_ids</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>List of valid chip IDs for this configuration. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="chip__cfg_8h_source.html#l00028">28</a> of file <a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="chip__cfg_8h_source.html">chip_cfg.h</a></li>
|
|
</ul>
|
|
</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="structchip__cfg.html">chip_cfg</a></li>
|
|
<li class="footer">Copyright 2021 Morse Micro </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|