mirror of
https://github.com/hathach/tinyusb.git
synced 2025-02-07 05:54:11 +08:00
158 lines
19 KiB
HTML
158 lines
19 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.6"/>
|
|
<title>tinyusb: tinyusb/common/fifo.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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">tinyusb
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('fifo_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">fifo.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="fifo_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/**************************************************************************/</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef _TUSB_FIFO_H_</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#define _TUSB_FIFO_H_</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="common_8h.html">common/common.h</a>"</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structfifo__t.html"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__group__fifo.html#ga209cb9cecab36517780818f791fd4cb1"> 57</a></span>  uint8_t* <span class="keyword">const</span> <a class="code" href="group__group__fifo.html#ga209cb9cecab36517780818f791fd4cb1">buffer</a> ; </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="group__group__fifo.html#ga826355f44678c1fda92ad8dd8768c741"> 58</a></span>  uint16_t <span class="keyword">const</span> <a class="code" href="group__group__fifo.html#ga826355f44678c1fda92ad8dd8768c741">depth</a> ; </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__group__fifo.html#gad20fcdaf91880e1eadac74f44ca810af"> 59</a></span>  uint16_t <span class="keyword">const</span> <a class="code" href="group__group__fifo.html#gad20fcdaf91880e1eadac74f44ca810af">item_size</a> ; </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094"> 60</a></span>  <span class="keyword">volatile</span> uint16_t <a class="code" href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094">count</a> ; </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="group__group__fifo.html#ga1183877201abc773ede7d0fd7bff02be"> 61</a></span>  <span class="keyword">volatile</span> uint16_t <a class="code" href="group__group__fifo.html#ga1183877201abc773ede7d0fd7bff02be">wr_idx</a> ; </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group__group__fifo.html#ga85e6a7b1738f3f627cab6ff605ec0fa6"> 62</a></span>  <span class="keyword">volatile</span> uint16_t <a class="code" href="group__group__fifo.html#ga85e6a7b1738f3f627cab6ff605ec0fa6">rd_idx</a> ; </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> overwritable ;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// IRQn_Type irq;</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <a class="code" href="structfifo__t.html">fifo_t</a>;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#define FIFO_DEF(name, ff_depth, type, is_overwritable) </span><span class="comment">/*, irq_mutex)*/</span><span class="preprocessor"> \</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"> uint8_t name##_buffer[ff_depth*sizeof(type)];\</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> fifo_t name = {\</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"> .buffer = name##_buffer,\</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> .depth = ff_depth,\</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> .item_size = sizeof(type),\</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> .overwritable = is_overwritable,\</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"> </span><span class="comment">/*.irq = irq_mutex*/</span><span class="preprocessor">\</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> }</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">bool</span> <a class="code" href="group__group__fifo.html#ga9189952c6b2516777f06cdfcbb45d6b8">fifo_write</a>(<a class="code" href="structfifo__t.html">fifo_t</a>* f, <span class="keywordtype">void</span> <span class="keyword">const</span> * p_data);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">bool</span> <a class="code" href="group__group__fifo.html#gad1b3c074f899149ff9736bf80d869f99">fifo_read</a>(<a class="code" href="structfifo__t.html">fifo_t</a>* f, <span class="keywordtype">void</span> * p_buffer);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code" href="group__group__fifo.html#gaec337b950afaa3d427e3793b98fe591c">fifo_clear</a>(<a class="code" href="structfifo__t.html">fifo_t</a> *f);</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> fifo_is_empty(<a class="code" href="structfifo__t.html">fifo_t</a>* f) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a>;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> fifo_is_empty(<a class="code" href="structfifo__t.html">fifo_t</a>* f)</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> {</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> (f-><a class="code" href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094">count</a> == 0);</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> fifo_is_full(<a class="code" href="structfifo__t.html">fifo_t</a>* f) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a>;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> fifo_is_full(<a class="code" href="structfifo__t.html">fifo_t</a>* f)</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> (f-><a class="code" href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094">count</a> == f-><a class="code" href="group__group__fifo.html#ga826355f44678c1fda92ad8dd8768c741">depth</a>);</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> }</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint16_t fifo_get_length(<a class="code" href="structfifo__t.html">fifo_t</a>* f) <a class="code" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="code" href="group___group___func_attr.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a>;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">static</span> <span class="keyword">inline</span> uint16_t fifo_get_length(<a class="code" href="structfifo__t.html">fifo_t</a>* f)</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> {</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> f-><a class="code" href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094">count</a>;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> }</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"></span> }</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif </span><span class="comment">/* _TUSB_FIFO_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="group__group__fifo_html_ga85e6a7b1738f3f627cab6ff605ec0fa6"><div class="ttname"><a href="group__group__fifo.html#ga85e6a7b1738f3f627cab6ff605ec0fa6">fifo_t::rd_idx</a></div><div class="ttdeci">volatile uint16_t rd_idx</div><div class="ttdoc">read pointer </div><div class="ttdef"><b>Definition:</b> fifo.h:62</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_ga826355f44678c1fda92ad8dd8768c741"><div class="ttname"><a href="group__group__fifo.html#ga826355f44678c1fda92ad8dd8768c741">fifo_t::depth</a></div><div class="ttdeci">uint16_t const depth</div><div class="ttdoc">max items </div><div class="ttdef"><b>Definition:</b> fifo.h:58</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_gad20fcdaf91880e1eadac74f44ca810af"><div class="ttname"><a href="group__group__fifo.html#gad20fcdaf91880e1eadac74f44ca810af">fifo_t::item_size</a></div><div class="ttdeci">uint16_t const item_size</div><div class="ttdoc">size of each item </div><div class="ttdef"><b>Definition:</b> fifo.h:59</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_gaec337b950afaa3d427e3793b98fe591c"><div class="ttname"><a href="group__group__fifo.html#gaec337b950afaa3d427e3793b98fe591c">fifo_clear</a></div><div class="ttdeci">void fifo_clear(fifo_t *f)</div><div class="ttdoc">Clear the fifo read and write pointers and set length to zero. </div><div class="ttdef"><b>Definition:</b> fifo.c:138</div></div>
|
|
<div class="ttc" id="group___group___func_attr_html_ga477faefde32bfd89d5b5b40d70b1a998"><div class="ttname"><a href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a></div><div class="ttdeci">#define ATTR_PURE</div><div class="ttdoc">Many functions have no effects except the return value and their return value depends only on the par...</div><div class="ttdef"><b>Definition:</b> compiler_gcc.h:96</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_ga9189952c6b2516777f06cdfcbb45d6b8"><div class="ttname"><a href="group__group__fifo.html#ga9189952c6b2516777f06cdfcbb45d6b8">fifo_write</a></div><div class="ttdeci">bool fifo_write(fifo_t *f, void const *p_data)</div><div class="ttdoc">Write one byte into the RX buffer. </div><div class="ttdef"><b>Definition:</b> fifo.c:102</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_gad1b3c074f899149ff9736bf80d869f99"><div class="ttname"><a href="group__group__fifo.html#gad1b3c074f899149ff9736bf80d869f99">fifo_read</a></div><div class="ttdeci">bool fifo_read(fifo_t *f, void *p_buffer)</div><div class="ttdoc">Read one byte out of the RX buffer. </div><div class="ttdef"><b>Definition:</b> fifo.c:65</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_ga1183877201abc773ede7d0fd7bff02be"><div class="ttname"><a href="group__group__fifo.html#ga1183877201abc773ede7d0fd7bff02be">fifo_t::wr_idx</a></div><div class="ttdeci">volatile uint16_t wr_idx</div><div class="ttdoc">write pointer </div><div class="ttdef"><b>Definition:</b> fifo.h:61</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_ga209cb9cecab36517780818f791fd4cb1"><div class="ttname"><a href="group__group__fifo.html#ga209cb9cecab36517780818f791fd4cb1">fifo_t::buffer</a></div><div class="ttdeci">uint8_t *const buffer</div><div class="ttdoc">buffer pointer </div><div class="ttdef"><b>Definition:</b> fifo.h:57</div></div>
|
|
<div class="ttc" id="structfifo__t_html"><div class="ttname"><a href="structfifo__t.html">fifo_t</a></div><div class="ttdoc">Simple Circular FIFO. </div><div class="ttdef"><b>Definition:</b> fifo.h:55</div></div>
|
|
<div class="ttc" id="common_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div></div>
|
|
<div class="ttc" id="group___group___func_attr_html_ga18a61fcb06b815274b12b7f626993ac6"><div class="ttname"><a href="group___group___func_attr.html#ga18a61fcb06b815274b12b7f626993ac6">ATTR_ALWAYS_INLINE</a></div><div class="ttdeci">#define ATTR_ALWAYS_INLINE</div><div class="ttdoc">Generally, functions are not inlined unless optimization is specified. For functions declared inline...</div><div class="ttdef"><b>Definition:</b> compiler_gcc.h:89</div></div>
|
|
<div class="ttc" id="group__group__fifo_html_gacf3bcd17dde685a9fe185401f6158094"><div class="ttname"><a href="group__group__fifo.html#gacf3bcd17dde685a9fe185401f6158094">fifo_t::count</a></div><div class="ttdeci">volatile uint16_t count</div><div class="ttdoc">number of items in queue </div><div class="ttdef"><b>Definition:</b> fifo.h:60</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_f44c0f1c8d3a85cc1de1e7f4648a56e6.html">tinyusb</a></li><li class="navelem"><a class="el" href="dir_2cf369265cdb233771cbf8cc15e70526.html">common</a></li><li class="navelem"><a class="el" href="fifo_8h.html">fifo.h</a></li>
|
|
<li class="footer">Generated on Wed Mar 26 2014 16:23:16 for tinyusb by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|