mm-iot-sdk/framework/doc/html/chip__cfg_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

138 lines
12 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.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('chip__cfg_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">chip_cfg.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 2025 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="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;stdint.h&gt;</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> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structchip__cfg.html"> 15</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structchip__cfg.html">chip_cfg</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structchip__cfg.html#aac7dca6b93b5a47657dd9e250c849990"> 18</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structchip__cfg.html#aac7dca6b93b5a47657dd9e250c849990">name</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structchip__cfg.html#ac2990645d0d8b9c330c59f2e48d50d08"> 20</a></span> uint32_t <a class="code hl_variable" href="structchip__cfg.html#ac2990645d0d8b9c330c59f2e48d50d08">reg_chip_id</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structchip__cfg.html#a55a9beca8f607e56375db6deb0599065"> 22</a></span> int (*<a class="code hl_variable" href="structchip__cfg.html#a55a9beca8f607e56375db6deb0599065">gpio_set_oe</a>)(uint8_t gpio_num, <span class="keywordtype">bool</span> oe);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structchip__cfg.html#a5310e821dc80760394b96d44de04e6a3"> 24</a></span> int (*<a class="code hl_variable" href="structchip__cfg.html#a5310e821dc80760394b96d44de04e6a3">gpio_set_value</a>)(uint8_t gpio_num, <span class="keywordtype">bool</span> value);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structchip__cfg.html#a71e1389ae2b09722e325b5f2209d4de8"> 26</a></span> uint8_t <a class="code hl_variable" href="structchip__cfg.html#a71e1389ae2b09722e325b5f2209d4de8">busy_gpio_num</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structchip__cfg.html#a0d5735d4eee454b11781751319dd7dc0"> 28</a></span> <span class="keyword">const</span> uint32_t *<a class="code hl_variable" href="structchip__cfg.html#a0d5735d4eee454b11781751319dd7dc0">valid_chip_ids</a>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structchip__cfg.html#a6fd84b399c5ddf30d4bef87c98c7e848"> 30</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structchip__cfg.html#a6fd84b399c5ddf30d4bef87c98c7e848">n_valid_chip_ids</a>;</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> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="structchip__cfg.html">chip_cfg</a> chip_cfgs[];</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> n_chip_cfgs;</div>
<div class="ttc" id="astructchip__cfg_html"><div class="ttname"><a href="structchip__cfg.html">chip_cfg</a></div><div class="ttdoc">Chip configuration data structure.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00015">chip_cfg.h:16</a></div></div>
<div class="ttc" id="astructchip__cfg_html_a0d5735d4eee454b11781751319dd7dc0"><div class="ttname"><a href="structchip__cfg.html#a0d5735d4eee454b11781751319dd7dc0">chip_cfg::valid_chip_ids</a></div><div class="ttdeci">const uint32_t * valid_chip_ids</div><div class="ttdoc">List of valid chip IDs for this configuration.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00028">chip_cfg.h:28</a></div></div>
<div class="ttc" id="astructchip__cfg_html_a5310e821dc80760394b96d44de04e6a3"><div class="ttname"><a href="structchip__cfg.html#a5310e821dc80760394b96d44de04e6a3">chip_cfg::gpio_set_value</a></div><div class="ttdeci">int(* gpio_set_value)(uint8_t gpio_num, bool value)</div><div class="ttdoc">Function to set GPIO value.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00024">chip_cfg.h:24</a></div></div>
<div class="ttc" id="astructchip__cfg_html_a55a9beca8f607e56375db6deb0599065"><div class="ttname"><a href="structchip__cfg.html#a55a9beca8f607e56375db6deb0599065">chip_cfg::gpio_set_oe</a></div><div class="ttdeci">int(* gpio_set_oe)(uint8_t gpio_num, bool oe)</div><div class="ttdoc">Function to set GPIO output enable.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00022">chip_cfg.h:22</a></div></div>
<div class="ttc" id="astructchip__cfg_html_a6fd84b399c5ddf30d4bef87c98c7e848"><div class="ttname"><a href="structchip__cfg.html#a6fd84b399c5ddf30d4bef87c98c7e848">chip_cfg::n_valid_chip_ids</a></div><div class="ttdeci">size_t n_valid_chip_ids</div><div class="ttdoc">Number of valid chip IDs in valid_chip_ids.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00030">chip_cfg.h:30</a></div></div>
<div class="ttc" id="astructchip__cfg_html_a71e1389ae2b09722e325b5f2209d4de8"><div class="ttname"><a href="structchip__cfg.html#a71e1389ae2b09722e325b5f2209d4de8">chip_cfg::busy_gpio_num</a></div><div class="ttdeci">uint8_t busy_gpio_num</div><div class="ttdoc">Busy GPIO number.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00026">chip_cfg.h:26</a></div></div>
<div class="ttc" id="astructchip__cfg_html_aac7dca6b93b5a47657dd9e250c849990"><div class="ttname"><a href="structchip__cfg.html#aac7dca6b93b5a47657dd9e250c849990">chip_cfg::name</a></div><div class="ttdeci">const char * name</div><div class="ttdoc">Chip name.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00018">chip_cfg.h:18</a></div></div>
<div class="ttc" id="astructchip__cfg_html_ac2990645d0d8b9c330c59f2e48d50d08"><div class="ttname"><a href="structchip__cfg.html#ac2990645d0d8b9c330c59f2e48d50d08">chip_cfg::reg_chip_id</a></div><div class="ttdeci">uint32_t reg_chip_id</div><div class="ttdoc">Address of the chip ID register.</div><div class="ttdef"><b>Definition:</b> <a href="chip__cfg_8h_source.html#l00020">chip_cfg.h:20</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_91b8f418cff946e8d8b598a9068417a8.html">examples</a></li><li class="navelem"><a class="el" href="dir_7de8b8c8b2ab5cd087fb005fc8243698.html">porting_assistant</a></li><li class="navelem"><a class="el" href="dir_79a7522752d9b58767ff1718f87ed209.html">src</a></li><li class="navelem"><b>chip_cfg.h</b></li>
<li class="footer">Copyright 2021 Morse Micro </li>
</ul>
</div>
</body>
</html>