Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / group__time.html @ 497

History | View | Annotate | Download (11.2 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>libdragonfly: Time</title>
4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.3 -->
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><a href="files.html"><span>Files</span></a></li>
14 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 
  </ul>
16 
</div>
17 
<h1>Time</h1>Time functions.
18 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
19 
<tr><td></td></tr>
20 
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
21 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" -->
22 
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a>&nbsp;&nbsp;&nbsp;1</td></tr>
23 

    		
  

  

    
      24
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A sixteenth of a second. <br></td></tr>


    		
  

  

    
      25
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" -->


    		
  

  

    
      26
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a>&nbsp;&nbsp;&nbsp;2</td></tr>


    		
  

  

    
      27
    
    
      

    		
  

  

    
      28
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An eighth of a second. <br></td></tr>


    		
  

  

    
      29
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" -->


    		
  

  

    
      30
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a>&nbsp;&nbsp;&nbsp;4</td></tr>


    		
  

  

    
      31
    
    
      

    		
  

  

    
      32
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A quarter of a second. <br></td></tr>


    		
  

  

    
      33
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" -->


    		
  

  

    
      34
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a>&nbsp;&nbsp;&nbsp;8</td></tr>


    		
  

  

    
      35
    
    
      

    		
  

  

    
      36
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Half of a second. <br></td></tr>


    		
  

  

    
      37
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" -->


    		
  

  

    
      38
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a>&nbsp;&nbsp;&nbsp;16</td></tr>


    		
  

  

    
      39
    
    
      

    		
  

  

    
      40
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">One second. <br></td></tr>


    		
  

  

    
      41
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" -->


    		
  

  

    
      42
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a>&nbsp;&nbsp;&nbsp;32</td></tr>


    		
  

  

    
      43
    
    
      

    		
  

  

    
      44
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Two seconds. <br></td></tr>


    		
  

  

    
      45
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" -->


    		
  

  

    
      46
    
    
      
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a>&nbsp;&nbsp;&nbsp;64</td></tr>


    		
  

  

    
      47
    
    
      

    		
  

  

    
      48
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Four seconds. <br></td></tr>


    		
  

  

    
      49
    
    
      
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>


    		
  

  

    
      50
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d">delay_ms</a> (int ms)</td></tr>


    		
  

  

    
      51
    
    
      

    		
  

  

    
      52
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delay execution for the specified time.  <a href="#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr>


    		
  

  

    
      53
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a> (int prescale_opt, void(*rtc_func)(void))</td></tr>


    		
  

  

    
      54
    
    
      

    		
  

  

    
      55
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable the realtime clock.  <a href="#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr>


    		
  

  

    
      56
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> (void)</td></tr>


    		
  

  

    
      57
    
    
      

    		
  

  

    
      58
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value of the realtime clock.  <a href="#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr>


    		
  

  

    
      59
    
    
      
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> (void)</td></tr>


    		
  

  

    
      60
    
    
      

    		
  

  

    
      61
    
    
      
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset the counter of the realtime clock.  <a href="#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr>


    		
  

  

    
      62
    
    
      
</table>


    		
  

  

    
      63
    
    
      
<hr><a name="_details"></a><h2>Detailed Description</h2>


    		
  

  

    
      64
    
    
      
Time functions. 


    		
  

  

    
      65
    
    
      
<p>


    		
  

  

    
      66
    
    
      
Functions dealing with time. <hr><h2>Function Documentation</h2>


    		
  

  

    
      67
    
    
      
<a class="anchor" name="g8aa473f8ae9a91df4bc9ea700983c72d"></a><!-- doxytag: member="time.c::delay_ms" ref="g8aa473f8ae9a91df4bc9ea700983c72d" args="(int ms)" -->


    		
  

  

    
      68
    
    
      
<div class="memitem">


    		
  

  

    
      69
    
    
      
<div class="memproto">


    		
  

  

    
      70
    
    
      
      <table class="memname">


    		
  

  

    
      71
    
    
      
        <tr>


    		
  

  

    
      72
    
    
      
          <td class="memname">void delay_ms           </td>


    		
  

  

    
      73
    
    
      
          <td>(</td>


    		
  

  

    
      74
    
    
      
          <td class="paramtype">int&nbsp;</td>


    		
  

  

    
      75
    
    
      
          <td class="paramname"> <em>ms</em>          </td>


    		
  

  

    
      76
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      77
    
    
      
          <td width="100%"></td>


    		
  

  

    
      78
    
    
      
        </tr>


    		
  

  

    
      79
    
    
      
      </table>


    		
  

  

    
      80
    
    
      
</div>


    		
  

  

    
      81
    
    
      
<div class="memdoc">


    		
  

  

    
      82
    
    
      

    		
  

  

    
      83
    
    
      
<p>


    		
  

  

    
      84
    
    
      
Delay execution for the specified time. 


    		
  

  

    
      85
    
    
      
<p>


    		
  

  

    
      86
    
    
      
Delays for the specified number of milliseconds. The accuracy of this function is unknown.<p>


    		
  

  

    
      87
    
    
      
<dl compact><dt><b>Parameters:</b></dt><dd>


    		
  

  

    
      88
    
    
      
  <table border="0" cellspacing="2" cellpadding="0">


    		
  

  

    
      89
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>ms</em>&nbsp;</td><td>the number of milliseconds to delay for </td></tr>


    		
  

  

    
      90
    
    
      
  </table>


    		
  

  

    
      91
    
    
      
</dl>


    		
  

  

    
      92
    
    
      

    		
  

  

    
      93
    
    
      
</div>


    		
  

  

    
      94
    
    
      
</div><p>


    		
  

  

    
      95
    
    
      
<a class="anchor" name="g5c7f2bf39314463dd5f4913e05ca991d"></a><!-- doxytag: member="time.c::rtc_get" ref="g5c7f2bf39314463dd5f4913e05ca991d" args="(void)" -->


    		
  

  

    
      96
    
    
      
<div class="memitem">


    		
  

  

    
      97
    
    
      
<div class="memproto">


    		
  

  

    
      98
    
    
      
      <table class="memname">


    		
  

  

    
      99
    
    
      
        <tr>


    		
  

  

    
      100
    
    
      
          <td class="memname">int rtc_get           </td>


    		
  

  

    
      101
    
    
      
          <td>(</td>


    		
  

  

    
      102
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      103
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      104
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      105
    
    
      
          <td width="100%"></td>


    		
  

  

    
      106
    
    
      
        </tr>


    		
  

  

    
      107
    
    
      
      </table>


    		
  

  

    
      108
    
    
      
</div>


    		
  

  

    
      109
    
    
      
<div class="memdoc">


    		
  

  

    
      110
    
    
      

    		
  

  

    
      111
    
    
      
<p>


    		
  

  

    
      112
    
    
      
Get the value of the realtime clock. 


    		
  

  

    
      113
    
    
      
<p>


    		
  

  

    
      114
    
    
      
Returns the time elapsed in seconds since the last call to rtc_init or rtc_reset.<p>


    		
  

  

    
      115
    
    
      
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of seconds since the last call to rtc_init or rtc_reset</dd></dl>


    		
  

  

    
      116
    
    
      
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553" title="Enable the realtime clock.">rtc_init</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3" title="Reset the counter of the realtime clock.">rtc_reset</a> </dd></dl>


    		
  

  

    
      117
    
    
      

    		
  

  

    
      118
    
    
      
</div>


    		
  

  

    
      119
    
    
      
</div><p>


    		
  

  

    
      120
    
    
      
<a class="anchor" name="g4b8a034dd8e994f4a1af612806f7c553"></a><!-- doxytag: member="time.c::rtc_init" ref="g4b8a034dd8e994f4a1af612806f7c553" args="(int prescale_opt, void(*rtc_func)(void))" -->


    		
  

  

    
      121
    
    
      
<div class="memitem">


    		
  

  

    
      122
    
    
      
<div class="memproto">


    		
  

  

    
      123
    
    
      
      <table class="memname">


    		
  

  

    
      124
    
    
      
        <tr>


    		
  

  

    
      125
    
    
      
          <td class="memname">void rtc_init           </td>


    		
  

  

    
      126
    
    
      
          <td>(</td>


    		
  

  

    
      127
    
    
      
          <td class="paramtype">int&nbsp;</td>


    		
  

  

    
      128
    
    
      
          <td class="paramname"> <em>prescale_opt</em>, </td>


    		
  

  

    
      129
    
    
      
        </tr>


    		
  

  

    
      130
    
    
      
        <tr>


    		
  

  

    
      131
    
    
      
          <td class="paramkey"></td>


    		
  

  

    
      132
    
    
      
          <td></td>


    		
  

  

    
      133
    
    
      
          <td class="paramtype">void(*)(void)&nbsp;</td>


    		
  

  

    
      134
    
    
      
          <td class="paramname"> <em>rtc_func</em></td><td>&nbsp;</td>


    		
  

  

    
      135
    
    
      
        </tr>


    		
  

  

    
      136
    
    
      
        <tr>


    		
  

  

    
      137
    
    
      
          <td></td>


    		
  

  

    
      138
    
    
      
          <td>)</td>


    		
  

  

    
      139
    
    
      
          <td></td><td></td><td width="100%"></td>


    		
  

  

    
      140
    
    
      
        </tr>


    		
  

  

    
      141
    
    
      
      </table>


    		
  

  

    
      142
    
    
      
</div>


    		
  

  

    
      143
    
    
      
<div class="memdoc">


    		
  

  

    
      144
    
    
      

    		
  

  

    
      145
    
    
      
<p>


    		
  

  

    
      146
    
    
      
Enable the realtime clock. 


    		
  

  

    
      147
    
    
      
<p>


    		
  

  

    
      148
    
    
      
Initializes the real time clock. Prescales are defined in <a class="el" href="time_8h.html" title="Contains time-related functions and definitions.">time.h</a>. For example, SECOND will give 1 second. The specified function is called every clock tick. For the real time clock to activate, interrupts must be enabled. (through sei() )<p>


    		
  

  

    
      149
    
    
      
<dl compact><dt><b>Parameters:</b></dt><dd>


    		
  

  

    
      150
    
    
      
  <table border="0" cellspacing="2" cellpadding="0">


    		
  

  

    
      151
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>prescale_opt</em>&nbsp;</td><td>the period with which the timer is triggered </td></tr>


    		
  

  

    
      152
    
    
      
    <tr><td valign="top"></td><td valign="top"><em>rtc_func</em>&nbsp;</td><td>the function called when the timer is triggered</td></tr>


    		
  

  

    
      153
    
    
      
  </table>


    		
  

  

    
      154
    
    
      
</dl>


    		
  

  

    
      155
    
    
      
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d" title="Get the value of the realtime clock.">rtc_get</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3" title="Reset the counter of the realtime clock.">rtc_reset</a> </dd></dl>


    		
  

  

    
      156
    
    
      

    		
  

  

    
      157
    
    
      
</div>


    		
  

  

    
      158
    
    
      
</div><p>


    		
  

  

    
      159
    
    
      
<a class="anchor" name="g83ae542199d1c0e964aff89537d686a3"></a><!-- doxytag: member="time.c::rtc_reset" ref="g83ae542199d1c0e964aff89537d686a3" args="(void)" -->


    		
  

  

    
      160
    
    
      
<div class="memitem">


    		
  

  

    
      161
    
    
      
<div class="memproto">


    		
  

  

    
      162
    
    
      
      <table class="memname">


    		
  

  

    
      163
    
    
      
        <tr>


    		
  

  

    
      164
    
    
      
          <td class="memname">void rtc_reset           </td>


    		
  

  

    
      165
    
    
      
          <td>(</td>


    		
  

  

    
      166
    
    
      
          <td class="paramtype">void&nbsp;</td>


    		
  

  

    
      167
    
    
      
          <td class="paramname">          </td>


    		
  

  

    
      168
    
    
      
          <td>&nbsp;)&nbsp;</td>


    		
  

  

    
      169
    
    
      
          <td width="100%"></td>


    		
  

  

    
      170
    
    
      
        </tr>


    		
  

  

    
      171
    
    
      
      </table>


    		
  

  

    
      172
    
    
      
</div>


    		
  

  

    
      173
    
    
      
<div class="memdoc">


    		
  

  

    
      174
    
    
      

    		
  

  

    
      175
    
    
      
<p>


    		
  

  

    
      176
    
    
      
Reset the counter of the realtime clock. 


    		
  

  

    
      177
    
    
      
<p>


    		
  

  

    
      178
    
    
      
Resets the real time clock counter to 0.<p>


    		
  

  

    
      179
    
    
      
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553" title="Enable the realtime clock.">rtc_init</a>, <a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d" title="Get the value of the realtime clock.">rtc_get</a> </dd></dl>


    		
  

  

    
      180
    
    
      

    		
  

  

    
      181
    
    
      
</div>


    		
  

  

    
      182
    
    
      
</div><p>


    		
  

  

    
      183
    
    
      
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 6 20:27:39 2008 for libdragonfly by&nbsp;


    		
  

  

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


    		
  

  

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


    		
  

  

    
      186
    
    
      
</body>


    		
  

  

    
      187
    
    
      
</html>