Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kanndil committed Jan 12, 2025
1 parent fe4588e commit 6576ce9
Show file tree
Hide file tree
Showing 31 changed files with 4,599 additions and 123 deletions.
46 changes: 46 additions & 0 deletions docs/doxygen/html/_e_f___s_p_i_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@
<tr class="separator:a83c5fa1a6e95392f2b3ab02661f40dec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f3ae4eb3cca3c9892bf0fd2ea1af96e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___s_p_i_8c.html#a8f3ae4eb3cca3c9892bf0fd2ea1af96e">EF_SPI_getMIS</a> (<a class="el" href="_e_f___s_p_i__regs_8h.html#ab51eaba59e1d37581be74b95ac7b4b20">EF_SPI_TYPE_PTR</a> spi, uint32_t *mask)</td></tr>
<tr class="separator:a8f3ae4eb3cca3c9892bf0fd2ea1af96e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bd18073e3f75287527f0ee881546b2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___s_p_i_8c.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI_setICR</a> (<a class="el" href="_e_f___s_p_i__regs_8h.html#ab51eaba59e1d37581be74b95ac7b4b20">EF_SPI_TYPE_PTR</a> spi, uint32_t mask)</td></tr>
<tr class="separator:a1bd18073e3f75287527f0ee881546b2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C file for SPI APIs which contains the function Implementations. </p>
Expand Down Expand Up @@ -649,6 +651,50 @@ <h2 class="memtitle"><span class="permalink"><a href="#a825604b02b3136b2ae6b57cd
</dl>
<dl class="section return"><dt>Returns</dt><dd>status A value of type <a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a> : returns a success or error code </dd></dl>

</div>
</div>
<a id="a1bd18073e3f75287527f0ee881546b2a" name="a1bd18073e3f75287527f0ee881546b2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bd18073e3f75287527f0ee881546b2a">&#9670;&#160;</a></span>EF_SPI_setICR()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a> EF_SPI_setICR </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_e_f___s_p_i__regs_8h.html#ab51eaba59e1d37581be74b95ac7b4b20">EF_SPI_TYPE_PTR</a>&#160;</td>
<td class="paramname"><em>spi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>mask</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sets the value of the Interrupt Clear Register; which clears the interrupts The mask value is a 6-bit value, where each bit corresponds to a specific interrupt</p><ul>
<li>bit 0 TXE : Transmit FIFO is Empty.</li>
<li>bit 1 TXF : Transmit FIFO is Full.</li>
<li>bit 2 RXE : Receive FIFO is Empty.</li>
<li>bit 3 RXF : Receive FIFO is Full.</li>
<li>bit 4 TXB : Transmit FIFO level is Below Threshold.</li>
<li>bit 5 RXA : Receive FIFO level is Above Threshold.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">spi</td><td>An <a class="el" href="_e_f___s_p_i__regs_8h.html#a13327a2a72e415754d4174d9e8c1ce84">EF_SPI_TYPE</a> pointer, which points to the base memory address of SPI registers. <a class="el" href="_e_f___s_p_i__regs_8h.html#a13327a2a72e415754d4174d9e8c1ce84">EF_SPI_TYPE</a> is a structure that contains the SPI registers. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mask</td><td>The required mask value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status A value of type <a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a> : returns a success or error code </dd></dl>

</div>
</div>
<a id="a475700f9498d9ab54b03d3e81ace1f0a" name="a475700f9498d9ab54b03d3e81ace1f0a"></a>
Expand Down
4 changes: 2 additions & 2 deletions docs/doxygen/html/_e_f___s_p_i_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span> </div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"><a class="line" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a"> 268</a></span><a class="code hl_typedef" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a> <a class="code hl_function" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI_setICR</a>(<a class="code hl_struct" href="struct___e_f___s_p_i___t_y_p_e__.html">EF_SPI_TYPE_PTR</a> spi, uint32_t mask);</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span><a class="code hl_typedef" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a> <a class="code hl_function" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI_setICR</a>(<a class="code hl_struct" href="struct___e_f___s_p_i___t_y_p_e__.html">EF_SPI_TYPE_PTR</a> spi, uint32_t mask);</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> </div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> </div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span><span class="comment">/******************************************************************************</span></div>
Expand All @@ -204,7 +204,7 @@
<div class="ttc" id="a_e_f___s_p_i_8h_html_a0cbec2da38446744274c64e9585e846c"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a0cbec2da38446744274c64e9585e846c">EF_SPI_getIM</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_getIM(EF_SPI_TYPE_PTR spi, uint32_t *mask)</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:296</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a143d8c3d4948fe4b3b673d4f7d37dc22"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a143d8c3d4948fe4b3b673d4f7d37dc22">EF_SPI_readRxFifoEmpty</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_readRxFifoEmpty(EF_SPI_TYPE_PTR spi, uint32_t *RXfifo_state)</div><div class="ttdoc">reads the RX FIFO empty flag from the STATUS register</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:152</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a17bb022c768cb9acb92e540dd0d5dcce"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a17bb022c768cb9acb92e540dd0d5dcce">EF_SPI_enable</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_enable(EF_SPI_TYPE_PTR spi)</div><div class="ttdoc">enables the SPI by setting the enable bit in the CTRL register to 1, enables spi master pulse generat...</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:210</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a1bd18073e3f75287527f0ee881546b2a"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI_setICR</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask)</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a1bd18073e3f75287527f0ee881546b2a"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI_setICR</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask)</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:343</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a1e57164045e2dc6ba9f3ebffc30f5985"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a1e57164045e2dc6ba9f3ebffc30f5985">EF_SPI_writeData</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_writeData(EF_SPI_TYPE_PTR spi, uint32_t data)</div><div class="ttdoc">writes a byte of data to the TXDATA register</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:73</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a37d6919aa636f75a7ad383d5c03a6595"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a37d6919aa636f75a7ad383d5c03a6595">EF_SPI_waitTxFifoEmpty</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_waitTxFifoEmpty(EF_SPI_TYPE_PTR spi)</div><div class="ttdoc">waits for the TX FIFO to be empty by polling the TX FIFO empty flag in the STATUS register</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:168</div></div>
<div class="ttc" id="a_e_f___s_p_i_8h_html_a3c26e6c7e5aa70bb44ee388a811aa762"><div class="ttname"><a href="_e_f___s_p_i_8h.html#a3c26e6c7e5aa70bb44ee388a811aa762">EF_SPI_disableRx</a></div><div class="ttdeci">EF_DRIVER_STATUS EF_SPI_disableRx(EF_SPI_TYPE_PTR spi)</div><div class="ttdoc">disables the RX by setting the RX enable bit in the CTRL register to 0, disables storing bytes reciev...</div><div class="ttdef"><b>Definition:</b> EF_SPI.c:246</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_SPI 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_SPI 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>
2 changes: 1 addition & 1 deletion docs/doxygen/html/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
<li>EF_SPI_RXE_FLAG&#160;:&#160;<a class="el" href="_e_f___s_p_i__regs_8h.html#ab7395a85fac8f34cd0ccf4d2499b7faa">EF_SPI_regs.h</a></li>
<li>EF_SPI_RXF_FLAG&#160;:&#160;<a class="el" href="_e_f___s_p_i__regs_8h.html#a6465a731b247cffcbb987ac7772b024f">EF_SPI_regs.h</a></li>
<li>EF_SPI_setGclkEnable()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a825604b02b3136b2ae6b57cd74f7f885">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a825604b02b3136b2ae6b57cd74f7f885">EF_SPI.h</a></li>
<li>EF_SPI_setICR()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.h</a></li>
<li>EF_SPI_setICR()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.h</a></li>
<li>EF_SPI_setIM()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a475700f9498d9ab54b03d3e81ace1f0a">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a475700f9498d9ab54b03d3e81ace1f0a">EF_SPI.h</a></li>
<li>EF_SPI_STATUS_REG_RX_A_BIT&#160;:&#160;<a class="el" href="_e_f___s_p_i__regs_8h.html#a03cff033c5e429f83f67c071221d3564">EF_SPI_regs.h</a></li>
<li>EF_SPI_STATUS_REG_RX_A_MASK&#160;:&#160;<a class="el" href="_e_f___s_p_i__regs_8h.html#ae86785f5f92756bc46988900ad755f8c">EF_SPI_regs.h</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/html/globals_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3><a id="index_e" name="index_e"></a>- e -</h3><ul>
<li>EF_SPI_readRxFifoEmpty()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a143d8c3d4948fe4b3b673d4f7d37dc22">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a143d8c3d4948fe4b3b673d4f7d37dc22">EF_SPI.h</a></li>
<li>EF_SPI_readTxFifoEmpty()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a5ba73cb278ddca9c4e4d7e2de81d086c">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a5ba73cb278ddca9c4e4d7e2de81d086c">EF_SPI.h</a></li>
<li>EF_SPI_setGclkEnable()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a825604b02b3136b2ae6b57cd74f7f885">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a825604b02b3136b2ae6b57cd74f7f885">EF_SPI.h</a></li>
<li>EF_SPI_setICR()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.h</a></li>
<li>EF_SPI_setICR()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a1bd18073e3f75287527f0ee881546b2a">EF_SPI.h</a></li>
<li>EF_SPI_setIM()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a475700f9498d9ab54b03d3e81ace1f0a">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a475700f9498d9ab54b03d3e81ace1f0a">EF_SPI.h</a></li>
<li>EF_SPI_waitRxFifoNotEmpty()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a07fa3d20aee584b19921035cd715b71b">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a07fa3d20aee584b19921035cd715b71b">EF_SPI.h</a></li>
<li>EF_SPI_waitTxFifoEmpty()&#160;:&#160;<a class="el" href="_e_f___s_p_i_8c.html#a37d6919aa636f75a7ad383d5c03a6595">EF_SPI.c</a>, <a class="el" href="_e_f___s_p_i_8h.html#a37d6919aa636f75a7ad383d5c03a6595">EF_SPI.h</a></li>
Expand Down
Loading

0 comments on commit 6576ce9

Please sign in to comment.