192 lines
20 KiB
HTML
192 lines
20 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: RTOS_Labs_common/FIFO2.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="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>
|
||
|
|
<!-- 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 id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="dir_d9737668015ddda3d9b152d7c8d1103c.html">RTOS_Labs_common</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">FIFO2.h</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// FIFO.h</span></div>
|
||
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Runs on any LM3Sxxx</span></div>
|
||
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Provide functions that initialize a FIFO, put data in, get data out,</span></div>
|
||
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// and return the current size. The file includes a transmit FIFO</span></div>
|
||
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// using index implementation and a receive FIFO using pointer</span></div>
|
||
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// implementation. Other index or pointer implementation FIFOs can be</span></div>
|
||
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// created using the macros supplied at the end of the file.</span></div>
|
||
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Daniel Valvano</span></div>
|
||
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// June 16, 2011</span></div>
|
||
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
||
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* This example accompanies the book</span></div>
|
||
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> "Embedded Systems: Real Time Interfacing to Arm Cortex M Microcontrollers",</span></div>
|
||
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ISBN: 978-1463590154, Jonathan Valvano, copyright (c) 2015</span></div>
|
||
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Programs 3.7, 3.8., 3.9 and 3.10 in Section 3.7</span></div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Copyright 2015 by Jonathan W. Valvano, valvano@mail.utexas.edu</span></div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> You may use, edit, run or distribute this file</span></div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> as long as the above copyright notice remains</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.</span></div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> VALVANO SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL,</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> For more information about my classes, my research, and my books, see</span></div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> http://users.ece.utexas.edu/~valvano/</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> */</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef __FIFO_H__</span></div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define __FIFO_H__</span></div>
|
||
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
||
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// macro to create an index FIFO</span></div>
|
||
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define AddIndexFifo(NAME,SIZE,TYPE,SUCCESS,FAIL) \</span></div>
|
||
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">uint32_t volatile NAME ## PutI; \</span></div>
|
||
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">uint32_t volatile NAME ## GetI; \</span></div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">TYPE static NAME ## Fifo [SIZE]; \</span></div>
|
||
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">void NAME ## Fifo_Init(void){ \</span></div>
|
||
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> NAME ## PutI = NAME ## GetI = 0; \</span></div>
|
||
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">int NAME ## Fifo_Put (TYPE data){ \</span></div>
|
||
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"> if(( NAME ## PutI - NAME ## GetI ) & ~(SIZE-1)){ \</span></div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> return(FAIL); \</span></div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"> NAME ## Fifo[ NAME ## PutI &(SIZE-1)] = data; \</span></div>
|
||
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> NAME ## PutI ## ++; \</span></div>
|
||
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> return(SUCCESS); \</span></div>
|
||
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">int NAME ## Fifo_Get (TYPE *datapt){ \</span></div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"> if( NAME ## PutI == NAME ## GetI ){ \</span></div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> return(FAIL); \</span></div>
|
||
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"> *datapt = NAME ## Fifo[ NAME ## GetI &(SIZE-1)]; \</span></div>
|
||
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"> NAME ## GetI ## ++; \</span></div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"> return(SUCCESS); \</span></div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">unsigned short NAME ## Fifo_Size (void){ \</span></div>
|
||
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"> return ((unsigned short)( NAME ## PutI - NAME ## GetI )); \</span></div>
|
||
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">}</span></div>
|
||
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// e.g.,</span></div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// AddIndexFifo(Tx,32,unsigned char, 1,0)</span></div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// SIZE must be a power of two</span></div>
|
||
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// creates TxFifo_Init() TxFifo_Get() and TxFifo_Put()</span></div>
|
||
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
||
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// macro to create a pointer FIFO</span></div>
|
||
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define AddPointerFifo(NAME,SIZE,TYPE,SUCCESS,FAIL) \</span></div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">TYPE volatile *NAME ## PutPt; \</span></div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">TYPE volatile *NAME ## GetPt; \</span></div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">TYPE static NAME ## Fifo [SIZE]; \</span></div>
|
||
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">void NAME ## Fifo_Init(void){ long sr; \</span></div>
|
||
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"> sr = StartCritical(); \</span></div>
|
||
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> NAME ## PutPt = NAME ## GetPt = &NAME ## Fifo[0]; \</span></div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> EndCritical(sr); \</span></div>
|
||
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">int NAME ## Fifo_Put (TYPE data){ \</span></div>
|
||
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> TYPE volatile *nextPutPt; \</span></div>
|
||
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> nextPutPt = NAME ## PutPt + 1; \</span></div>
|
||
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"> if(nextPutPt == &NAME ## Fifo[SIZE]){ \</span></div>
|
||
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"> nextPutPt = &NAME ## Fifo[0]; \</span></div>
|
||
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"> if(nextPutPt == NAME ## GetPt ){ \</span></div>
|
||
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> return(FAIL); \</span></div>
|
||
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> else{ \</span></div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"> *( NAME ## PutPt ) = data; \</span></div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"> NAME ## PutPt = nextPutPt; \</span></div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"> return(SUCCESS); \</span></div>
|
||
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">int NAME ## Fifo_Get (TYPE *datapt){ \</span></div>
|
||
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"> if( NAME ## PutPt == NAME ## GetPt ){ \</span></div>
|
||
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor"> return(FAIL); \</span></div>
|
||
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor"> *datapt = *( NAME ## GetPt ## ++); \</span></div>
|
||
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"> if( NAME ## GetPt == &NAME ## Fifo[SIZE]){ \</span></div>
|
||
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor"> NAME ## GetPt = &NAME ## Fifo[0]; \</span></div>
|
||
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor"> } \</span></div>
|
||
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor"> return(SUCCESS); \</span></div>
|
||
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">} \</span></div>
|
||
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">unsigned short NAME ## Fifo_Size (void){\</span></div>
|
||
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor"> if( NAME ## PutPt < NAME ## GetPt ){ \</span></div>
|
||
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor"> return ((unsigned short)( NAME ## PutPt - NAME ## GetPt + (SIZE*sizeof(TYPE)))/sizeof(TYPE)); \</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"> return ((unsigned short)( NAME ## PutPt - NAME ## GetPt )/sizeof(TYPE)); \</span></div>
|
||
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">}</span></div>
|
||
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">// e.g.,</span></div>
|
||
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// AddPointerFifo(Rx,32,unsigned char, 1,0)</span></div>
|
||
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">// SIZE can be any size</span></div>
|
||
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// creates RxFifo_Init() RxFifo_Get() and RxFifo_Put()</span></div>
|
||
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
||
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif </span><span class="comment">// __FIFO_H__</span></div>
|
||
|
|
</div><!-- fragment --></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>
|