Project

General

Profile

Revision 869

Added by Justin Scheiner over 15 years ago

Recompiled documentation with additional documentation for SPI and encoders.

View differences:

ring__buffer_8h.html
4 4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.5 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
7 
<!-- Generated by Doxygen 1.5.4 -->
8 
<div class="tabs">
9 
  <ul>
10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13 
    <li class="current"><a href="files.html"><span>Files</span></a></li>
14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 
  </ul>
18 16 
</div>
19 
<div class="contents">
20 17 
<h1>ring_buffer.h File Reference</h1>Ring Buffer. <a href="#_details">More...</a>
21 18 
<p>
22 19 

  		




  ......




  55
  52
  
    
Copyright (c) 2007 Colony Project<p>


  		




  56
  53
  
    
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>


  		




  57
  54
  
    
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>


  		




  58
  
  
    
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Include macros to create a ring buffer. Originally written for 15-410. Modified for use in ATMega128 serial driver<p>


  		




  
  55
  
    
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>


  		




  
  56
  
    
Include macros to create a ring buffer. Originally written for 15-410. Modified for use in ATMega128 serial driver<p>


  		




  59
  57
  
    
<dl class="author" compact><dt><b>Author:</b></dt><dd>Cornell Wright (cgwright) <p>


  		




  60
  58
  
    
Jason P. Winters (jpwinter) </dd></dl>


  		




  61
  59
  
    
<hr><h2>Define Documentation</h2>


  		




  ......




  92
  90
  
    
  </table>


  		




  93
  91
  
    
</dl>


  		




  94
  92
  
    

  		




  95
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00182">i2c_request()</a>, and <a class="el" href="i2c_8c-source.html#l00141">i2c_send()</a>.</p>


  		




  96
  
  
    

  		




  97
  93
  
    
</div>


  		




  98
  94
  
    
</div><p>


  		




  99
  95
  
    
<a class="anchor" name="0ae5ca959a3b05583623551cc287a534"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_CLEAR" ref="0ae5ca959a3b05583623551cc287a534" args="(buf)" -->


  		




  ......




  125
  121
  
    
  </table>


  		




  126
  122
  
    
</dl>


  		




  127
  123
  
    

  		




  128
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00107">i2c_init()</a>, and <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>


  		




  129
  
  
    

  		




  130
  124
  
    
</div>


  		




  131
  125
  
    
</div><p>


  		




  132
  126
  
    
<a class="anchor" name="19daf3026b69a26bb3d383b14ae90e23"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_EMPTY" ref="19daf3026b69a26bb3d383b14ae90e23" args="(buf)" -->


  		




  ......




  154
  148
  
    
  </table>


  		




  155
  149
  
    
</dl>


  		




  156
  150
  
    

  		




  157
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>


  		




  158
  
  
    

  		




  159
  151
  
    
</div>


  		




  160
  152
  
    
</div><p>


  		




  161
  153
  
    
<a class="anchor" name="2ed153688dc60c5503f2f7fdd2b73a4a"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_FULL" ref="2ed153688dc60c5503f2f7fdd2b73a4a" args="(buf)" -->


  		




  ......




  183
  175
  
    
  </table>


  		




  184
  176
  
    
</dl>


  		




  185
  177
  
    

  		




  186
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00182">i2c_request()</a>, and <a class="el" href="i2c_8c-source.html#l00141">i2c_send()</a>.</p>


  		




  187
  
  
    

  		




  188
  178
  
    
</div>


  		




  189
  179
  
    
</div><p>


  		




  190
  180
  
    
<a class="anchor" name="3c186ab6ff12fa96c18f6d064720cc2c"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_INIT" ref="3c186ab6ff12fa96c18f6d064720cc2c" args="(buf, size)" -->


  		




  ......




  298
  288
  
    
  </table>


  		




  299
  289
  
    
</dl>


  		




  300
  290
  
    

  		




  301
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>


  		




  302
  
  
    

  		




  303
  291
  
    
</div>


  		




  304
  292
  
    
</div><p>


  		




  305
  293
  
    
<a class="anchor" name="4a0f9de5ac14f60d678cda392921a629"></a><!-- doxytag: member="ring_buffer.h::RING_BUFFER_REMOVE" ref="4a0f9de5ac14f60d678cda392921a629" args="(buf, val_ret)" -->


  		




  ......




  335
  323
  
    
  </table>


  		




  336
  324
  
    
</dl>


  		




  337
  325
  
    

  		




  338
  
  
    
<p>Referenced by <a class="el" href="i2c_8c-source.html#l00214">ISR()</a>.</p>


  		




  339
  
  
    

  		




  340
  326
  
    
</div>


  		




  341
  327
  
    
</div><p>


  		




  342
  
  
    
</div>


  		




  343
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by&nbsp;


  		




  
  328
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 6 15:44:34 2008 for libdragonfly by&nbsp;


  		




  344
  329
  
    
<a href="http://www.doxygen.org/index.html">


  		




  345
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>


  		




  
  330
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>


  		




  346
  331
  
    
</body>


  		




  347
  332
  
    
</html>


  		












Also available in:  Unified diff