Skip to content

Commit

Permalink
adding firmware documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kanndil committed Jan 13, 2025
1 parent cc6b663 commit 97557ac
Show file tree
Hide file tree
Showing 45 changed files with 8,571 additions and 1,269 deletions.
628 changes: 498 additions & 130 deletions docs/doxygen/html/_e_f___i2_c_8c.html

Large diffs are not rendered by default.

684 changes: 569 additions & 115 deletions docs/doxygen/html/_e_f___i2_c_8h.html

Large diffs are not rendered by default.

193 changes: 135 additions & 58 deletions docs/doxygen/html/_e_f___i2_c_8h_source.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/doxygen/html/_e_f___i2_c__regs_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@
Typedefs</h2></td></tr>
<tr class="memitem:ab0d3f158914422e7299a70fcd51e6141"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct___e_f___i2_c___t_y_p_e__.html">_EF_I2C_TYPE_</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a></td></tr>
<tr class="separator:ab0d3f158914422e7299a70fcd51e6141"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affb413da2854fa5bbd6d42b9b0c4e73f"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___i2_c__regs_8h.html#affb413da2854fa5bbd6d42b9b0c4e73f">EF_I2C_PTR</a></td></tr>
<tr class="separator:affb413da2854fa5bbd6d42b9b0c4e73f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2269a016ba045981b24348570da1bbe"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___i2_c__regs_8h.html#aa2269a016ba045981b24348570da1bbe">EF_I2C_TYPE_PTR</a></td></tr>
<tr class="separator:aa2269a016ba045981b24348570da1bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aef00c279597b188e4cdd14d288ddf77a" name="aef00c279597b188e4cdd14d288ddf77a"></a>
Expand Down Expand Up @@ -593,28 +593,28 @@ <h2 class="memtitle"><span class="permalink"><a href="#a470cd5845bed94d8b8b35893
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="affb413da2854fa5bbd6d42b9b0c4e73f" name="affb413da2854fa5bbd6d42b9b0c4e73f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affb413da2854fa5bbd6d42b9b0c4e73f">&#9670;&#160;</a></span>EF_I2C_PTR</h2>
<a id="ab0d3f158914422e7299a70fcd51e6141" name="ab0d3f158914422e7299a70fcd51e6141"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0d3f158914422e7299a70fcd51e6141">&#9670;&#160;</a></span>EF_I2C_TYPE</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a>* <a class="el" href="_e_f___i2_c__regs_8h.html#affb413da2854fa5bbd6d42b9b0c4e73f">EF_I2C_PTR</a></td>
<td class="memname">typedef struct <a class="el" href="struct___e_f___i2_c___t_y_p_e__.html">_EF_I2C_TYPE_</a> <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a></td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab0d3f158914422e7299a70fcd51e6141" name="ab0d3f158914422e7299a70fcd51e6141"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0d3f158914422e7299a70fcd51e6141">&#9670;&#160;</a></span>EF_I2C_TYPE</h2>
<a id="aa2269a016ba045981b24348570da1bbe" name="aa2269a016ba045981b24348570da1bbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2269a016ba045981b24348570da1bbe">&#9670;&#160;</a></span>EF_I2C_TYPE_PTR</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct___e_f___i2_c___t_y_p_e__.html">_EF_I2C_TYPE_</a> <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a></td>
<td class="memname">typedef <a class="el" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a>* <a class="el" href="_e_f___i2_c__regs_8h.html#aa2269a016ba045981b24348570da1bbe">EF_I2C_TYPE_PTR</a></td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
4 changes: 2 additions & 2 deletions docs/doxygen/html/_e_f___i2_c__regs_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141"> 82</a></span>} <a class="code hl_typedef" href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a>;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="_e_f___i2_c__regs_8h.html#affb413da2854fa5bbd6d42b9b0c4e73f"> 85</a></span><span class="keyword">typedef</span> <a class="code hl_struct" href="struct___e_f___i2_c___t_y_p_e__.html">EF_I2C_TYPE</a> * <a class="code hl_typedef" href="_e_f___i2_c__regs_8h.html#affb413da2854fa5bbd6d42b9b0c4e73f">EF_I2C_PTR</a>; <span class="comment">// EF_I2C_PTR is a pointer to a structure of type EF_I2C_TYPE</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="_e_f___i2_c__regs_8h.html#aa2269a016ba045981b24348570da1bbe"> 85</a></span><span class="keyword">typedef</span> <a class="code hl_struct" href="struct___e_f___i2_c___t_y_p_e__.html">EF_I2C_TYPE</a> * <a class="code hl_typedef" href="_e_f___i2_c__regs_8h.html#aa2269a016ba045981b24348570da1bbe">EF_I2C_TYPE_PTR</a>; <span class="comment">// EF_I2C_PTR is a pointer to a structure of type EF_I2C_TYPE</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment">/******************************************************************************</span></div>
Expand All @@ -179,10 +179,10 @@
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment">******************************************************************************/</span></div>
<div class="ttc" id="a_e_f___driver___common_8h_html"><div class="ttname"><a href="_e_f___driver___common_8h.html">EF_Driver_Common.h</a></div><div class="ttdoc">C header file for common driver definitions and types.</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_a81f369079976a46554fd9798ab035697"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#a81f369079976a46554fd9798ab035697">__RW</a></div><div class="ttdeci">#define __RW</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:36</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_aa2269a016ba045981b24348570da1bbe"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#aa2269a016ba045981b24348570da1bbe">EF_I2C_TYPE_PTR</a></div><div class="ttdeci">EF_I2C_TYPE * EF_I2C_TYPE_PTR</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:85</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_ab0d3f158914422e7299a70fcd51e6141"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#ab0d3f158914422e7299a70fcd51e6141">EF_I2C_TYPE</a></div><div class="ttdeci">struct _EF_I2C_TYPE_ EF_I2C_TYPE</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_ad8cfe7014044235a4c8d3239c2597f09"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#ad8cfe7014044235a4c8d3239c2597f09">__W</a></div><div class="ttdeci">#define __W</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:35</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_aef00c279597b188e4cdd14d288ddf77a"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#aef00c279597b188e4cdd14d288ddf77a">__R</a></div><div class="ttdeci">#define __R</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:34</div></div>
<div class="ttc" id="a_e_f___i2_c__regs_8h_html_affb413da2854fa5bbd6d42b9b0c4e73f"><div class="ttname"><a href="_e_f___i2_c__regs_8h.html#affb413da2854fa5bbd6d42b9b0c4e73f">EF_I2C_PTR</a></div><div class="ttdeci">EF_I2C_TYPE * EF_I2C_PTR</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:85</div></div>
<div class="ttc" id="astruct___e_f___i2_c___t_y_p_e___html"><div class="ttname"><a href="struct___e_f___i2_c___t_y_p_e__.html">_EF_I2C_TYPE_</a></div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:71</div></div>
<div class="ttc" id="astruct___e_f___i2_c___t_y_p_e___html_a0f2c90771caed07ebcc3cae40508b5df"><div class="ttname"><a href="struct___e_f___i2_c___t_y_p_e__.html#a0f2c90771caed07ebcc3cae40508b5df">_EF_I2C_TYPE_::MIS</a></div><div class="ttdeci">__R MIS</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:78</div></div>
<div class="ttc" id="astruct___e_f___i2_c___t_y_p_e___html_a16243abba225c900732085b8ea82f943"><div class="ttname"><a href="struct___e_f___i2_c___t_y_p_e__.html#a16243abba225c900732085b8ea82f943">_EF_I2C_TYPE_::GCLK</a></div><div class="ttdeci">__W GCLK</div><div class="ttdef"><b>Definition:</b> EF_I2C_regs.h:81</div></div>
Expand Down
81 changes: 81 additions & 0 deletions docs/doxygen/html/_r_e_a_d_m_e_8md.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EF_I2C APIs: README.md File 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="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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">EF_I2C APIs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">README.md File Reference</div></div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Loading

0 comments on commit 97557ac

Please sign in to comment.