root / trunk / docs / libdragonfly / group__time.html @ 409
History | View | Annotate | Download (11.1 KB)
1 | 41 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | 241 | bcoltin | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 | 41 | bcoltin | <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 | 241 | bcoltin | <!-- Generated by Doxygen 1.5.3 -->
|
8 | 41 | bcoltin | <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 | 241 | bcoltin | <li><a href="pages.html"><span>Related Pages</span></a></li> |
14 | </ul>
|
||
15 | </div>
|
||
16 | 41 | bcoltin | <h1>Time</h1>Time functions. |
17 | <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
||
18 | <tr><td></td></tr> |
||
19 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
20 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd271145628da4e0e85e3e2486d117713"></a><!-- doxytag: member="time::SIXTEENTH_SECOND" ref="gd271145628da4e0e85e3e2486d117713" args="" --> |
||
21 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gd271145628da4e0e85e3e2486d117713">SIXTEENTH_SECOND</a> 1</td></tr> |
||
22 | |||
23 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A sixteenth of a second. <br></td></tr> |
||
24 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7bdae984203001070e9abeb3190f844a"></a><!-- doxytag: member="time::EIGTH_SECOND" ref="g7bdae984203001070e9abeb3190f844a" args="" --> |
||
25 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g7bdae984203001070e9abeb3190f844a">EIGTH_SECOND</a> 2</td></tr> |
||
26 | |||
27 | <tr><td class="mdescLeft"> </td><td class="mdescRight">An eighth of a second. <br></td></tr> |
||
28 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b2a348d9afca1f1182bc2bb2aa6a3d1"></a><!-- doxytag: member="time::QUARTER_SECOND" ref="g0b2a348d9afca1f1182bc2bb2aa6a3d1" args="" --> |
||
29 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g0b2a348d9afca1f1182bc2bb2aa6a3d1">QUARTER_SECOND</a> 4</td></tr> |
||
30 | |||
31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">A quarter of a second. <br></td></tr> |
||
32 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf95f27544f39827250d6bef6fa5fe18e"></a><!-- doxytag: member="time::HALF_SECOND" ref="gf95f27544f39827250d6bef6fa5fe18e" args="" --> |
||
33 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#gf95f27544f39827250d6bef6fa5fe18e">HALF_SECOND</a> 8</td></tr> |
||
34 | |||
35 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Half of a second. <br></td></tr> |
||
36 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g94212be2394d2d37d9dfd33d07d82dba"></a><!-- doxytag: member="time::SECOND" ref="g94212be2394d2d37d9dfd33d07d82dba" args="" --> |
||
37 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g94212be2394d2d37d9dfd33d07d82dba">SECOND</a> 16</td></tr> |
||
38 | |||
39 | <tr><td class="mdescLeft"> </td><td class="mdescRight">One second. <br></td></tr> |
||
40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4c2dc0c899e1571596205f29fcc35cd6"></a><!-- doxytag: member="time::TWO_SECOND" ref="g4c2dc0c899e1571596205f29fcc35cd6" args="" --> |
||
41 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g4c2dc0c899e1571596205f29fcc35cd6">TWO_SECOND</a> 32</td></tr> |
||
42 | |||
43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Two seconds. <br></td></tr> |
||
44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g335312d1eed285bbc48a7f383ad78d97"></a><!-- doxytag: member="time::FOUR_SECOND" ref="g335312d1eed285bbc48a7f383ad78d97" args="" --> |
||
45 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__time.html#g335312d1eed285bbc48a7f383ad78d97">FOUR_SECOND</a> 64</td></tr> |
||
46 | |||
47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Four seconds. <br></td></tr> |
||
48 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
49 | <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> |
||
50 | |||
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Delay execution for the specified time. <a href="#g8aa473f8ae9a91df4bc9ea700983c72d"></a><br></td></tr> |
||
52 | <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> |
||
53 | |||
54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable the realtime clock. <a href="#g4b8a034dd8e994f4a1af612806f7c553"></a><br></td></tr> |
||
55 | <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> |
||
56 | |||
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the realtime clock. <a href="#g5c7f2bf39314463dd5f4913e05ca991d"></a><br></td></tr> |
||
58 | <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> |
||
59 | |||
60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the counter of the realtime clock. <a href="#g83ae542199d1c0e964aff89537d686a3"></a><br></td></tr> |
||
61 | </table>
|
||
62 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
63 | Time functions. |
||
64 | <p>
|
||
65 | Functions dealing with time. <hr><h2>Function Documentation</h2> |
||
66 | 241 | bcoltin | <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"> |
||
70 | 41 | bcoltin | <tr>
|
71 | 241 | bcoltin | <td class="memname">void delay_ms </td> |
72 | <td>(</td> |
||
73 | <td class="paramtype">int </td> |
||
74 | <td class="paramname"> <em>ms</em> </td> |
||
75 | <td> ) </td> |
||
76 | <td width="100%"></td> |
||
77 | 41 | bcoltin | </tr>
|
78 | </table>
|
||
79 | 241 | bcoltin | </div>
|
80 | <div class="memdoc"> |
||
81 | 41 | bcoltin | |
82 | <p>
|
||
83 | Delay execution for the specified time. |
||
84 | <p>
|
||
85 | Delays for the specified number of milliseconds. The accuracy of this function is unknown.<p>
|
||
86 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
87 | <table border="0" cellspacing="2" cellpadding="0"> |
||
88 | <tr><td valign="top"></td><td valign="top"><em>ms</em> </td><td>the number of milliseconds to delay for </td></tr> |
||
89 | </table>
|
||
90 | </dl>
|
||
91 | 241 | bcoltin | |
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"> |
||
98 | 41 | bcoltin | <tr>
|
99 | 241 | bcoltin | <td class="memname">int rtc_get </td> |
100 | <td>(</td> |
||
101 | <td class="paramtype">void </td> |
||
102 | <td class="paramname"> </td> |
||
103 | <td> ) </td> |
||
104 | <td width="100%"></td> |
||
105 | 41 | bcoltin | </tr>
|
106 | </table>
|
||
107 | 241 | bcoltin | </div>
|
108 | <div class="memdoc"> |
||
109 | 41 | bcoltin | |
110 | <p>
|
||
111 | Get the value of the realtime clock. |
||
112 | <p>
|
||
113 | Returns the time elapsed in seconds since the last call to rtc_init or rtc_reset.<p>
|
||
114 | 241 | bcoltin | <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"> |
||
123 | 41 | bcoltin | <tr>
|
124 | 241 | bcoltin | <td class="memname">void rtc_init </td> |
125 | <td>(</td> |
||
126 | <td class="paramtype">int </td> |
||
127 | <td class="paramname"> <em>prescale_opt</em>, </td> |
||
128 | 41 | bcoltin | </tr>
|
129 | <tr>
|
||
130 | 241 | bcoltin | <td class="paramkey"></td> |
131 | <td></td> |
||
132 | <td class="paramtype">void(*)(void) </td> |
||
133 | <td class="paramname"> <em>rtc_func</em></td><td> </td> |
||
134 | 41 | bcoltin | </tr>
|
135 | <tr>
|
||
136 | 241 | bcoltin | <td></td> |
137 | <td>)</td> |
||
138 | <td></td><td></td><td width="100%"></td> |
||
139 | 41 | bcoltin | </tr>
|
140 | </table>
|
||
141 | 241 | bcoltin | </div>
|
142 | <div class="memdoc"> |
||
143 | 41 | bcoltin | |
144 | <p>
|
||
145 | Enable the realtime clock. |
||
146 | <p>
|
||
147 | 241 | bcoltin | 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> |
148 | 41 | bcoltin | <dl compact><dt><b>Parameters:</b></dt><dd> |
149 | <table border="0" cellspacing="2" cellpadding="0"> |
||
150 | <tr><td valign="top"></td><td valign="top"><em>prescale_opt</em> </td><td>the period with which the timer is triggered </td></tr> |
||
151 | <tr><td valign="top"></td><td valign="top"><em>rtc_func</em> </td><td>the function called when the timer is triggered</td></tr> |
||
152 | </table>
|
||
153 | </dl>
|
||
154 | 241 | bcoltin | <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"> |
||
162 | 41 | bcoltin | <tr>
|
163 | 241 | bcoltin | <td class="memname">void rtc_reset </td> |
164 | <td>(</td> |
||
165 | <td class="paramtype">void </td> |
||
166 | <td class="paramname"> </td> |
||
167 | <td> ) </td> |
||
168 | <td width="100%"></td> |
||
169 | 41 | bcoltin | </tr>
|
170 | </table>
|
||
171 | 241 | bcoltin | </div>
|
172 | <div class="memdoc"> |
||
173 | 41 | bcoltin | |
174 | <p>
|
||
175 | Reset the counter of the realtime clock. |
||
176 | <p>
|
||
177 | Resets the real time clock counter to 0.<p>
|
||
178 | 241 | bcoltin | <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 |
||
183 | 41 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
184 | 241 | bcoltin | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
185 | 41 | bcoltin | </body>
|
186 | </html> |