root / branches / lib_additions / docs / libdragonfly / group__time.html @ 79
History | View | Annotate | Download (11.8 KB)
1 | 41 | bcoltin | <!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"> |
||
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.4.6 -->
|
||
8 | <div class="tabs"> |
||
9 | <ul>
|
||
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
||
11 | <li><a href="modules.html"><span>Modules</span></a></li> |
||
12 | <li><a href="files.html"><span>Files</span></a></li> |
||
13 | </ul></div> |
||
14 | <h1>Time</h1>Time functions. |
||
15 | <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
||
16 | <tr><td></td></tr> |
||
17 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
18 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" --> |
||
19 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a> 1</td></tr> |
||
20 | |||
21 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A sixteenth of a second. <br></td></tr> |
||
22 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" --> |
||
23 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a> 2</td></tr> |
||
24 | |||
25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An eighth of a second. <br></td></tr> |
||
26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" --> |
||
27 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a> 4</td></tr> |
||
28 | |||
29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A quarter of a second. <br></td></tr> |
||
30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" --> |
||
31 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a> 8</td></tr> |
||
32 | |||
33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Half of a second. <br></td></tr> |
||
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" --> |
||
35 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a> 16</td></tr> |
||
36 | |||
37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">One second. <br></td></tr> |
||
38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" --> |
||
39 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a> 32</td></tr> |
||
40 | |||
41 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Two seconds. <br></td></tr> |
||
42 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" --> |
||
43 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a> 64</td></tr> |
||
44 | |||
45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Four seconds. <br></td></tr> |
||
46 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g8aa473f8ae9a91df4bc9ea700983c72d">delay_ms</a> (int ms)</td></tr> |
||
48 | |||
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Delay execution for the specified time. <a href="#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr> |
||
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </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> |
||
51 | |||
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the realtime clock. <a href="#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr> |
||
53 | <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g5c7f2bf39314463dd5f4913e05ca991d">rtc_get</a> (void)</td></tr> |
||
54 | |||
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the realtime clock. <a href="#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr> |
||
56 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g83ae542199d1c0e964aff89537d686a3">rtc_reset</a> (void)</td></tr> |
||
57 | |||
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the counter of the realtime clock. <a href="#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr> |
||
59 | </table>
|
||
60 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
61 | Time functions. |
||
62 | <p>
|
||
63 | 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"> |
||
69 | <tr>
|
||
70 | <td class="md" nowrap valign="top">void delay_ms </td> |
||
71 | <td class="md" valign="top">( </td> |
||
72 | <td class="md" nowrap valign="top">int </td> |
||
73 | <td class="mdname1" valign="top" nowrap> <em>ms</em> </td> |
||
74 | <td class="md" valign="top"> ) </td> |
||
75 | <td class="md" nowrap></td> |
||
76 | </tr>
|
||
77 | </table>
|
||
78 | </td>
|
||
79 | </tr>
|
||
80 | </table>
|
||
81 | <table cellspacing="5" cellpadding="0" border="0"> |
||
82 | <tr>
|
||
83 | <td>
|
||
84 |
|
||
85 | </td>
|
||
86 | <td>
|
||
87 | |||
88 | <p>
|
||
89 | Delay execution for the specified time. |
||
90 | <p>
|
||
91 | Delays for the specified number of milliseconds. The accuracy of this function is unknown.<p>
|
||
92 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
93 | <table border="0" cellspacing="2" cellpadding="0"> |
||
94 | <tr><td valign="top"></td><td valign="top"><em>ms</em> </td><td>the number of milliseconds to delay for </td></tr> |
||
95 | </table>
|
||
96 | </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"> |
||
105 | <tr>
|
||
106 | <td class="md" nowrap valign="top">int rtc_get </td> |
||
107 | <td class="md" valign="top">( </td> |
||
108 | <td class="md" nowrap valign="top">void </td> |
||
109 | <td class="mdname1" valign="top" nowrap> </td> |
||
110 | <td class="md" valign="top"> ) </td> |
||
111 | <td class="md" nowrap></td> |
||
112 | </tr>
|
||
113 | </table>
|
||
114 | </td>
|
||
115 | </tr>
|
||
116 | </table>
|
||
117 | <table cellspacing="5" cellpadding="0" border="0"> |
||
118 | <tr>
|
||
119 | <td>
|
||
120 |
|
||
121 | </td>
|
||
122 | <td>
|
||
123 | |||
124 | <p>
|
||
125 | Get the value of the realtime clock. |
||
126 | <p>
|
||
127 | 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"> |
||
138 | <tr>
|
||
139 | <td class="md" nowrap valign="top">void rtc_init </td> |
||
140 | <td class="md" valign="top">( </td> |
||
141 | <td class="md" nowrap valign="top">int </td> |
||
142 | <td class="mdname" nowrap> <em>prescale_opt</em>, </td> |
||
143 | </tr>
|
||
144 | <tr>
|
||
145 | <td class="md" nowrap align="right"></td> |
||
146 | <td class="md"></td> |
||
147 | <td class="md" nowrap>void(*)(void) </td> |
||
148 | <td class="mdname" nowrap> <em>rtc_func</em></td> |
||
149 | </tr>
|
||
150 | <tr>
|
||
151 | <td class="md"></td> |
||
152 | <td class="md">) </td> |
||
153 | <td class="md" colspan="2"></td> |
||
154 | </tr>
|
||
155 | </table>
|
||
156 | </td>
|
||
157 | </tr>
|
||
158 | </table>
|
||
159 | <table cellspacing="5" cellpadding="0" border="0"> |
||
160 | <tr>
|
||
161 | <td>
|
||
162 |
|
||
163 | </td>
|
||
164 | <td>
|
||
165 | |||
166 | <p>
|
||
167 | Enable the realtime clock. |
||
168 | <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> |
||
170 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
171 | <table border="0" cellspacing="2" cellpadding="0"> |
||
172 | <tr><td valign="top"></td><td valign="top"><em>prescale_opt</em> </td><td>the period with which the timer is triggered </td></tr> |
||
173 | <tr><td valign="top"></td><td valign="top"><em>rtc_func</em> </td><td>the function called when the timer is triggered</td></tr> |
||
174 | </table>
|
||
175 | </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"> |
||
185 | <tr>
|
||
186 | <td class="md" nowrap valign="top">void rtc_reset </td> |
||
187 | <td class="md" valign="top">( </td> |
||
188 | <td class="md" nowrap valign="top">void </td> |
||
189 | <td class="mdname1" valign="top" nowrap> </td> |
||
190 | <td class="md" valign="top"> ) </td> |
||
191 | <td class="md" nowrap></td> |
||
192 | </tr>
|
||
193 | </table>
|
||
194 | </td>
|
||
195 | </tr>
|
||
196 | </table>
|
||
197 | <table cellspacing="5" cellpadding="0" border="0"> |
||
198 | <tr>
|
||
199 | <td>
|
||
200 |
|
||
201 | </td>
|
||
202 | <td>
|
||
203 | |||
204 | <p>
|
||
205 | Reset the counter of the realtime clock. |
||
206 | <p>
|
||
207 | 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 Fri Sep 14 15:36:18 2007 for libdragonfly by |
||
213 | <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> |
||
215 | </body>
|
||
216 | </html> |