439 lines
24 KiB
HTML
439 lines
24 KiB
HTML
<!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.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RTOS_MSPM0: FIFO</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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="RobotSensors.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">RTOS_MSPM0
|
|
 <span id="projectnumber">1.1</span>
|
|
</div>
|
|
<div id="projectbrief">ECE445M starter code</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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="#files">Files</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FIFO</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>First in first out queue.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
|
|
Files</h2></td></tr>
|
|
<tr class="memitem:_r_t_o_s___f_i_f_o_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="_r_t_o_s___f_i_f_o_8h.html">RTOS_FIFO.h</a></td></tr>
|
|
<tr class="memdesc:_r_t_o_s___f_i_f_o_8h"><td class="mdescLeft"> </td><td class="mdescRight">Provide functions for a first in first out queue. <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 name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gacac935f876812a013763d9b9a710ce90"><td class="memItemLeft" align="right" valign="top"><a id="gacac935f876812a013763d9b9a710ce90"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#gacac935f876812a013763d9b9a710ce90">TXFIFOSIZE</a>   64</td></tr>
|
|
<tr class="memdesc:gacac935f876812a013763d9b9a710ce90"><td class="mdescLeft"> </td><td class="mdescRight">TXFIFOSIZE the size of the transmit FIFO, which can hold 0 to TXFIFOSIZE-1 elements. The size must be a power of 2. <br /></td></tr>
|
|
<tr class="separator:gacac935f876812a013763d9b9a710ce90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7db362029bfc1133f544334692c6d9cb"><td class="memItemLeft" align="right" valign="top"><a id="ga7db362029bfc1133f544334692c6d9cb"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga7db362029bfc1133f544334692c6d9cb">RXFIFOSIZE</a>   16</td></tr>
|
|
<tr class="memdesc:ga7db362029bfc1133f544334692c6d9cb"><td class="mdescLeft"> </td><td class="mdescRight">RXFIFOSIZE the size of the receive FIFO, which can hold 0 to RXFIFOSIZE-1 elements The size must be a power of 2. <br /></td></tr>
|
|
<tr class="separator:ga7db362029bfc1133f544334692c6d9cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8ba15f9bfd321bd622d2f421e20587d1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>AddIndexFifo</b>(NAME, SIZE, TYPE, SUCCESS, FAIL)</td></tr>
|
|
<tr class="separator:ga8ba15f9bfd321bd622d2f421e20587d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga12f98aad5544d637df30127479c3ad0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga12f98aad5544d637df30127479c3ad0a">TxFifo_Init</a> (void)</td></tr>
|
|
<tr class="memdesc:ga12f98aad5544d637df30127479c3ad0a"><td class="mdescLeft"> </td><td class="mdescRight">Initialize FIFO. <a href="group___f_i_f_o.html#ga12f98aad5544d637df30127479c3ad0a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga12f98aad5544d637df30127479c3ad0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad88cce6fdfe0b28cc009844c3707349c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#gad88cce6fdfe0b28cc009844c3707349c">TxFifo_Put</a> (char data)</td></tr>
|
|
<tr class="memdesc:gad88cce6fdfe0b28cc009844c3707349c"><td class="mdescLeft"> </td><td class="mdescRight">Put FIFO. <a href="group___f_i_f_o.html#gad88cce6fdfe0b28cc009844c3707349c">More...</a><br /></td></tr>
|
|
<tr class="separator:gad88cce6fdfe0b28cc009844c3707349c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga847a7a2b184edc97682f81f6eb920a87"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga847a7a2b184edc97682f81f6eb920a87">TxFifo_Get</a> (void)</td></tr>
|
|
<tr class="memdesc:ga847a7a2b184edc97682f81f6eb920a87"><td class="mdescLeft"> </td><td class="mdescRight">Get FIFO. <a href="group___f_i_f_o.html#ga847a7a2b184edc97682f81f6eb920a87">More...</a><br /></td></tr>
|
|
<tr class="separator:ga847a7a2b184edc97682f81f6eb920a87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6bddd7794716cb6c25fd532aa2402b51"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga6bddd7794716cb6c25fd532aa2402b51">TxFifo_Size</a> (void)</td></tr>
|
|
<tr class="memdesc:ga6bddd7794716cb6c25fd532aa2402b51"><td class="mdescLeft"> </td><td class="mdescRight">number of elements in FIFO <a href="group___f_i_f_o.html#ga6bddd7794716cb6c25fd532aa2402b51">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6bddd7794716cb6c25fd532aa2402b51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6cbc225d9f8a8b4548578117f180d656"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga6cbc225d9f8a8b4548578117f180d656">RxFifo_Init</a> (void)</td></tr>
|
|
<tr class="memdesc:ga6cbc225d9f8a8b4548578117f180d656"><td class="mdescLeft"> </td><td class="mdescRight">Initialize FIFO. <a href="group___f_i_f_o.html#ga6cbc225d9f8a8b4548578117f180d656">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6cbc225d9f8a8b4548578117f180d656"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac964616ddfe5d9ac964a45edaed99035"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#gac964616ddfe5d9ac964a45edaed99035">RxFifo_Put</a> (char data)</td></tr>
|
|
<tr class="memdesc:gac964616ddfe5d9ac964a45edaed99035"><td class="mdescLeft"> </td><td class="mdescRight">Put FIFO. <a href="group___f_i_f_o.html#gac964616ddfe5d9ac964a45edaed99035">More...</a><br /></td></tr>
|
|
<tr class="separator:gac964616ddfe5d9ac964a45edaed99035"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga65360c4fc119e55405acc5eac6dcd150"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga65360c4fc119e55405acc5eac6dcd150">RxFifo_Get</a> (void)</td></tr>
|
|
<tr class="memdesc:ga65360c4fc119e55405acc5eac6dcd150"><td class="mdescLeft"> </td><td class="mdescRight">Get FIFO. <a href="group___f_i_f_o.html#ga65360c4fc119e55405acc5eac6dcd150">More...</a><br /></td></tr>
|
|
<tr class="separator:ga65360c4fc119e55405acc5eac6dcd150"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga926d96cfdd46ff110c52ed6c8a3bd975"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_i_f_o.html#ga926d96cfdd46ff110c52ed6c8a3bd975">RxFifo_Size</a> (void)</td></tr>
|
|
<tr class="memdesc:ga926d96cfdd46ff110c52ed6c8a3bd975"><td class="mdescLeft"> </td><td class="mdescRight">number of elements in FIFO <a href="group___f_i_f_o.html#ga926d96cfdd46ff110c52ed6c8a3bd975">More...</a><br /></td></tr>
|
|
<tr class="separator:ga926d96cfdd46ff110c52ed6c8a3bd975"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>First in first out queue. </p>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="ga8ba15f9bfd321bd622d2f421e20587d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8ba15f9bfd321bd622d2f421e20587d1">◆ </a></span>AddIndexFifo</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define AddIndexFifo</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">NAME, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">SIZE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TYPE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">SUCCESS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">FAIL </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line">uint32_t <span class="keyword">volatile</span> NAME ## PutI; \</div>
|
|
<div class="line">uint32_t <span class="keyword">volatile</span> NAME ## GetI; \</div>
|
|
<div class="line">TYPE <span class="keyword">static</span> NAME ## Fifo [SIZE]; \</div>
|
|
<div class="line">void NAME ## Fifo_Init(<span class="keywordtype">void</span>){ \</div>
|
|
<div class="line"> NAME ## PutI = NAME ## GetI = 0; \</div>
|
|
<div class="line">} \</div>
|
|
<div class="line">int NAME ## Fifo_Put (TYPE data){ \</div>
|
|
<div class="line"> if(( NAME ## PutI - NAME ## GetI ) & ~(SIZE-1)){ \</div>
|
|
<div class="line"> return(FAIL); \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> NAME ## Fifo[ NAME ## PutI &(SIZE-1)] = data; \</div>
|
|
<div class="line"> NAME ## PutI++; \</div>
|
|
<div class="line"> return(SUCCESS); \</div>
|
|
<div class="line">} \</div>
|
|
<div class="line">int NAME ## Fifo_Get (TYPE *datapt){ \</div>
|
|
<div class="line"> if( NAME ## PutI == NAME ## GetI ){ \</div>
|
|
<div class="line"> return(FAIL); \</div>
|
|
<div class="line"> } \</div>
|
|
<div class="line"> *datapt = NAME ## Fifo[ NAME ## GetI &(SIZE-1)]; \</div>
|
|
<div class="line"> NAME ## GetI++; \</div>
|
|
<div class="line"> return(SUCCESS); \</div>
|
|
<div class="line">} \</div>
|
|
<div class="line">unsigned <span class="keywordtype">short</span> NAME ## Fifo_Size (<span class="keywordtype">void</span>){\</div>
|
|
<div class="line"> return ((<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span>)( NAME ## PutI - NAME ## GetI )); \</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga65360c4fc119e55405acc5eac6dcd150"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga65360c4fc119e55405acc5eac6dcd150">◆ </a></span>RxFifo_Get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char RxFifo_Get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get FIFO. </p>
|
|
<p>Get character from the receive FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for fail because empty, nonzero is data </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga6cbc225d9f8a8b4548578117f180d656" title="Initialize FIFO.">RxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#gac964616ddfe5d9ac964a45edaed99035" title="Put FIFO.">RxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga926d96cfdd46ff110c52ed6c8a3bd975" title="number of elements in FIFO">RxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>RXFIFOSIZE the size of the receive FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6cbc225d9f8a8b4548578117f180d656"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6cbc225d9f8a8b4548578117f180d656">◆ </a></span>RxFifo_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void RxFifo_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize FIFO. </p>
|
|
<p>Initialize the receive FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#gac964616ddfe5d9ac964a45edaed99035" title="Put FIFO.">RxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga65360c4fc119e55405acc5eac6dcd150" title="Get FIFO.">RxFifo_Get()</a> <a class="el" href="group___f_i_f_o.html#ga926d96cfdd46ff110c52ed6c8a3bd975" title="number of elements in FIFO">RxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>RXFIFOSIZE the size of the receive FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac964616ddfe5d9ac964a45edaed99035"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac964616ddfe5d9ac964a45edaed99035">◆ </a></span>RxFifo_Put()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int RxFifo_Put </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Put FIFO. </p>
|
|
<p>Put character into the receive FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>is a new character to save </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for fail because full, 1 for success </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga6cbc225d9f8a8b4548578117f180d656" title="Initialize FIFO.">RxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#ga65360c4fc119e55405acc5eac6dcd150" title="Get FIFO.">RxFifo_Get()</a> <a class="el" href="group___f_i_f_o.html#ga926d96cfdd46ff110c52ed6c8a3bd975" title="number of elements in FIFO">RxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>RXFIFOSIZE the size of the receive FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga926d96cfdd46ff110c52ed6c8a3bd975"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga926d96cfdd46ff110c52ed6c8a3bd975">◆ </a></span>RxFifo_Size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t RxFifo_Size </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>number of elements in FIFO </p>
|
|
<p>Determine how many elements are currently stored in the receive FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of elements in FIFO </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga6cbc225d9f8a8b4548578117f180d656" title="Initialize FIFO.">RxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#gac964616ddfe5d9ac964a45edaed99035" title="Put FIFO.">RxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga65360c4fc119e55405acc5eac6dcd150" title="Get FIFO.">RxFifo_Get()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Does not change the FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga847a7a2b184edc97682f81f6eb920a87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga847a7a2b184edc97682f81f6eb920a87">◆ </a></span>TxFifo_Get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char TxFifo_Get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get FIFO. </p>
|
|
<p>Get character from the transmit FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for fail because empty, nonzero is data </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga12f98aad5544d637df30127479c3ad0a" title="Initialize FIFO.">TxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#gad88cce6fdfe0b28cc009844c3707349c" title="Put FIFO.">TxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga6bddd7794716cb6c25fd532aa2402b51" title="number of elements in FIFO">TxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>TXFIFOSIZE the size of the transmit FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga12f98aad5544d637df30127479c3ad0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga12f98aad5544d637df30127479c3ad0a">◆ </a></span>TxFifo_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void TxFifo_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize FIFO. </p>
|
|
<p>Initialize the transmit FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>none </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#gad88cce6fdfe0b28cc009844c3707349c" title="Put FIFO.">TxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga847a7a2b184edc97682f81f6eb920a87" title="Get FIFO.">TxFifo_Get()</a> <a class="el" href="group___f_i_f_o.html#ga6bddd7794716cb6c25fd532aa2402b51" title="number of elements in FIFO">TxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>TXFIFOSIZE the size of the transmit FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad88cce6fdfe0b28cc009844c3707349c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad88cce6fdfe0b28cc009844c3707349c">◆ </a></span>TxFifo_Put()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int TxFifo_Put </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Put FIFO. </p>
|
|
<p>Put character into the transmit FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>is a new character to save </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 for fail because full, 1 for success </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga12f98aad5544d637df30127479c3ad0a" title="Initialize FIFO.">TxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#ga847a7a2b184edc97682f81f6eb920a87" title="Get FIFO.">TxFifo_Get()</a> <a class="el" href="group___f_i_f_o.html#ga6bddd7794716cb6c25fd532aa2402b51" title="number of elements in FIFO">TxFifo_Size()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>TXFIFOSIZE the size of the transmit FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6bddd7794716cb6c25fd532aa2402b51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6bddd7794716cb6c25fd532aa2402b51">◆ </a></span>TxFifo_Size()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t TxFifo_Size </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>number of elements in FIFO </p>
|
|
<p>Determine how many elements are currently stored in the transmit FIFO </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>number of elements in FIFO </dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___f_i_f_o.html#ga12f98aad5544d637df30127479c3ad0a" title="Initialize FIFO.">TxFifo_Init()</a> <a class="el" href="group___f_i_f_o.html#gad88cce6fdfe0b28cc009844c3707349c" title="Put FIFO.">TxFifo_Put()</a> <a class="el" href="group___f_i_f_o.html#ga847a7a2b184edc97682f81f6eb920a87" title="Get FIFO.">TxFifo_Get()</a> </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Does not change the FIFO </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|