Project

General

Profile

Revision 241

Added by Brian Coltin over 16 years ago

Updated libdragonfly documentation.

View differences:

group__time.html
1 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3 
<title>libdragonfly: Time</title>
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.4.6 -->
7 
<!-- Generated by Doxygen 1.5.3 -->
8 8 
<div class="tabs">
9 9 
  <ul>
10 10 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 11 
    <li><a href="modules.html"><span>Modules</span></a></li>
12 12 
    <li><a href="files.html"><span>Files</span></a></li>
13 
  </ul></div>
13 
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
14 
  </ul>
15 
</div>
14 16 
<h1>Time</h1>Time functions.
15 17 
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
16 18 
<tr><td></td></tr>
......
61 63 
Time functions.
62 64 
<p>
63 65 
Functions dealing with time. <hr><h2>Function Documentation</h2>
64 
<a class="anchor" name="g8aa473f8ae9a91df4bc9ea700983c72d"></a><!-- doxytag: member="time.c::delay_ms" ref="g8aa473f8ae9a91df4bc9ea700983c72d" args="(int ms)" --><p>
65 
<table class="mdTable" cellpadding="2" cellspacing="0">
66 
  <tr>
67 
    <td class="mdRow">
68 
      <table cellpadding="0" cellspacing="0" border="0">
66 
<a class="anchor" name="g8aa473f8ae9a91df4bc9ea700983c72d"></a><!-- doxytag: member="time.c::delay_ms" ref="g8aa473f8ae9a91df4bc9ea700983c72d" args="(int ms)" -->
67 
<div class="memitem">
68 
<div class="memproto">
69 
      <table class="memname">
69 70 
        <tr>
70 
          <td class="md" nowrap valign="top">void delay_ms           </td>
71 
          <td class="md" valign="top">(&nbsp;</td>
72 
          <td class="md" nowrap valign="top">int&nbsp;</td>
73 
          <td class="mdname1" valign="top" nowrap> <em>ms</em>          </td>
74 
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
75 
          <td class="md" nowrap></td>
71 
          <td class="memname">void delay_ms           </td>
72 
          <td>(</td>
73 
          <td class="paramtype">int&nbsp;</td>
74 
          <td class="paramname"> <em>ms</em>          </td>
75 
          <td>&nbsp;)&nbsp;</td>
76 
          <td width="100%"></td>
76 77 
        </tr>
77 78 
      </table>
78 
    </td>
79 
  </tr>
80 
</table>
81 
<table cellspacing="5" cellpadding="0" border="0">
82 
  <tr>
83 
    <td>
84 
      &nbsp;
85 
    </td>
86 
    <td>
79 
</div>
80 
<div class="memdoc">
87 81 

  		




  88
  82
  
    
<p>


  		




  89
  83
  
    
Delay execution for the specified time. 


  		




  ......




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


  		




  95
  89
  
    
  </table>


  		




  96
  90
  
    
</dl>


  		




  97
  
  
    
    </td>


  		




  98
  
  
    
  </tr>


  		




  99
  
  
    
</table>


  		




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


  		




  101
  
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  102
  
  
    
  <tr>


  		




  103
  
  
    
    <td class="mdRow">


  		




  104
  
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  91
  
    

  		




  
  92
  
    
</div>


  		




  
  93
  
    
</div><p>


  		




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


  		




  
  95
  
    
<div class="memitem">


  		




  
  96
  
    
<div class="memproto">


  		




  
  97
  
    
      <table class="memname">


  		




  105
  98
  
    
        <tr>


  		




  106
  
  
    
          <td class="md" nowrap valign="top">int rtc_get           </td>


  		




  107
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  108
  
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  109
  
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  110
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  111
  
  
    
          <td class="md" nowrap></td>


  		




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


  		




  
  100
  
    
          <td>(</td>


  		




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


  		




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


  		




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


  		




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


  		




  112
  105
  
    
        </tr>


  		




  113
  106
  
    
      </table>


  		




  114
  
  
    
    </td>


  		




  115
  
  
    
  </tr>


  		




  116
  
  
    
</table>


  		




  117
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  118
  
  
    
  <tr>


  		




  119
  
  
    
    <td>


  		




  120
  
  
    
      &nbsp;


  		




  121
  
  
    
    </td>


  		




  122
  
  
    
    <td>


  		




  
  107
  
    
</div>


  		




  
  108
  
    
<div class="memdoc">


  		




  123
  109
  
    

  		




  124
  110
  
    
<p>


  		




  125
  111
  
    
Get the value of the realtime clock. 


  		




  126
  112
  
    
<p>


  		




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


  		




  128
  
  
    
<dl compact><dt><b>Returns:</b></dt><dd>the number of seconds since the last call to rtc_init or rtc_reset</dd></dl>


  		




  129
  
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> </dd></dl>


  		




  130
  
  
    
    </td>


  		




  131
  
  
    
  </tr>


  		




  132
  
  
    
</table>


  		




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


  		




  134
  
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  135
  
  
    
  <tr>


  		




  136
  
  
    
    <td class="mdRow">


  		




  137
  
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  114
  
    
<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>


  		




  
  115
  
    
<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>


  		




  
  116
  
    

  		




  
  117
  
    
</div>


  		




  
  118
  
    
</div><p>


  		




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


  		




  
  120
  
    
<div class="memitem">


  		




  
  121
  
    
<div class="memproto">


  		




  
  122
  
    
      <table class="memname">


  		




  138
  123
  
    
        <tr>


  		




  139
  
  
    
          <td class="md" nowrap valign="top">void rtc_init           </td>


  		




  140
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  141
  
  
    
          <td class="md" nowrap valign="top">int&nbsp;</td>


  		




  142
  
  
    
          <td class="mdname" nowrap> <em>prescale_opt</em>, </td>


  		




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


  		




  
  125
  
    
          <td>(</td>


  		




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


  		




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


  		




  143
  128
  
    
        </tr>


  		




  144
  129
  
    
        <tr>


  		




  145
  
  
    
          <td class="md" nowrap align="right"></td>


  		




  146
  
  
    
          <td class="md"></td>


  		




  147
  
  
    
          <td class="md" nowrap>void(*)(void)&nbsp;</td>


  		




  148
  
  
    
          <td class="mdname" nowrap> <em>rtc_func</em></td>


  		




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


  		




  
  131
  
    
          <td></td>


  		




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


  		




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


  		




  149
  134
  
    
        </tr>


  		




  150
  135
  
    
        <tr>


  		




  151
  
  
    
          <td class="md"></td>


  		




  152
  
  
    
          <td class="md">)&nbsp;</td>


  		




  153
  
  
    
          <td class="md" colspan="2"></td>


  		




  
  136
  
    
          <td></td>


  		




  
  137
  
    
          <td>)</td>


  		




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


  		




  154
  139
  
    
        </tr>


  		




  155
  140
  
    
      </table>


  		




  156
  
  
    
    </td>


  		




  157
  
  
    
  </tr>


  		




  158
  
  
    
</table>


  		




  159
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  160
  
  
    
  <tr>


  		




  161
  
  
    
    <td>


  		




  162
  
  
    
      &nbsp;


  		




  163
  
  
    
    </td>


  		




  164
  
  
    
    <td>


  		




  
  141
  
    
</div>


  		




  
  142
  
    
<div class="memdoc">


  		




  165
  143
  
    

  		




  166
  144
  
    
<p>


  		




  167
  145
  
    
Enable the realtime clock. 


  		




  168
  146
  
    
<p>


  		




  169
  
  
    
Initializes the real time clock. Prescales are defined in <a class="el" href="time_8h.html">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>


  		




  
  147
  
    
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>


  		




  170
  148
  
    
<dl compact><dt><b>Parameters:</b></dt><dd>


  		




  171
  149
  
    
  <table border="0" cellspacing="2" cellpadding="0">


  		




  172
  150
  
    
    <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>


  		




  173
  151
  
    
    <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>


  		




  174
  152
  
    
  </table>


  		




  175
  153
  
    
</dl>


  		




  176
  
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a>, <a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> </dd></dl>


  		




  177
  
  
    
    </td>


  		




  178
  
  
    
  </tr>


  		




  179
  
  
    
</table>


  		




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


  		




  181
  
  
    
<table class="mdTable" cellpadding="2" cellspacing="0">


  		




  182
  
  
    
  <tr>


  		




  183
  
  
    
    <td class="mdRow">


  		




  184
  
  
    
      <table cellpadding="0" cellspacing="0" border="0">


  		




  
  154
  
    
<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>


  		




  
  155
  
    

  		




  
  156
  
    
</div>


  		




  
  157
  
    
</div><p>


  		




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


  		




  
  159
  
    
<div class="memitem">


  		




  
  160
  
    
<div class="memproto">


  		




  
  161
  
    
      <table class="memname">


  		




  185
  162
  
    
        <tr>


  		




  186
  
  
    
          <td class="md" nowrap valign="top">void rtc_reset           </td>


  		




  187
  
  
    
          <td class="md" valign="top">(&nbsp;</td>


  		




  188
  
  
    
          <td class="md" nowrap valign="top">void&nbsp;</td>


  		




  189
  
  
    
          <td class="mdname1" valign="top" nowrap>          </td>


  		




  190
  
  
    
          <td class="md" valign="top">&nbsp;)&nbsp;</td>


  		




  191
  
  
    
          <td class="md" nowrap></td>


  		




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


  		




  
  164
  
    
          <td>(</td>


  		




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


  		




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


  		




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


  		




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


  		




  192
  169
  
    
        </tr>


  		




  193
  170
  
    
      </table>


  		




  194
  
  
    
    </td>


  		




  195
  
  
    
  </tr>


  		




  196
  
  
    
</table>


  		




  197
  
  
    
<table cellspacing="5" cellpadding="0" border="0">


  		




  198
  
  
    
  <tr>


  		




  199
  
  
    
    <td>


  		




  200
  
  
    
      &nbsp;


  		




  201
  
  
    
    </td>


  		




  202
  
  
    
    <td>


  		




  
  171
  
    
</div>


  		




  
  172
  
    
<div class="memdoc">


  		




  203
  173
  
    

  		




  204
  174
  
    
<p>


  		




  205
  175
  
    
Reset the counter of the realtime clock. 


  		




  206
  176
  
    
<p>


  		




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


  		




  208
  
  
    
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__time.html#g4b8a034dd8e994f4a1af612806f7c553">rtc_init</a>, <a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> </dd></dl>


  		




  209
  
  
    
    </td>


  		




  210
  
  
    
  </tr>


  		




  211
  
  
    
</table>


  		




  212
  
  
    
<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 26 17:39:31 2007 for libdragonfly by&nbsp;


  		




  
  178
  
    
<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>


  		




  
  179
  
    

  		




  
  180
  
    
</div>


  		




  
  181
  
    
</div><p>


  		




  
  182
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:15:40 2007 for libdragonfly by&nbsp;


  		




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


  		




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


  		




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


  		




  215
  185
  
    
</body>


  		




  216
  186
  
    
</html>


  		












Also available in:  Unified diff