root / trunk / code / projects / libdragonfly / time.c @ 1462
History | View | Annotate | Download (6.99 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2007 Colony Project
|
3 |
*
|
4 |
* Permission is hereby granted, free of charge, to any person
|
5 |
* obtaining a copy of this software and associated documentation
|
6 |
* files (the "Software"), to deal in the Software without
|
7 |
* restriction, including without limitation the rights to use,
|
8 |
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9 |
* copies of the Software, and to permit persons to whom the
|
10 |
* Software is furnished to do so, subject to the following
|
11 |
* conditions:
|
12 |
*
|
13 |
* The above copyright notice and this permission notice shall be
|
14 |
* included in all copies or substantial portions of the Software.
|
15 |
*
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
18 |
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
20 |
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
21 |
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
22 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
23 |
* OTHER DEALINGS IN THE SOFTWARE.
|
24 |
**/
|
25 |
|
26 |
|
27 |
/**
|
28 |
* @file time.c
|
29 |
* @brief Timer code
|
30 |
*
|
31 |
* Implementation of functions for timers.
|
32 |
*
|
33 |
* @author Colony Project, CMU Robotics Club
|
34 |
**/
|
35 |
|
36 |
/*
|
37 |
time.c
|
38 |
anything that requires a delay
|
39 |
mostly delay_ms
|
40 |
|
41 |
author: Robotics Club, Colony Project
|
42 |
|
43 |
Change Log:
|
44 |
2.5.07 - Kevin
|
45 |
Aaron fixed the orb/servo code and made them use timer3 but compare registers B and C. He hard set the prescaler
|
46 |
to 8 so the RTC broke. Changed it so that we use a 8 prescaler which sets the compare match at 1/16th of a second.
|
47 |
You now count how many 16ths of a second you want until you trigger your actual interrupt. Works. Changed defines
|
48 |
for time so you can still call rtc_init with a scale but now it is defined in terms of actual time like second, quarter_second
|
49 |
etc. Read that section in the time.h file for more information. Tested and works, though the clock drifts more than
|
50 |
it used to
|
51 |
1.30.07 - Kevin
|
52 |
Modified the clock to run on timer3 on the Dragonfly. Works with decent accuracy. Using a prescaler of 256
|
53 |
the timer counts up to a precomputer value which will trigger an interrupt and reset the timer. Multiples of
|
54 |
256 change it by that multiple. Refer to the time.h file for all possible prescalers.
|
55 |
The interrupt will call a specified function _rtc_func every pulse.
|
56 |
All of it has been tested and it works.
|
57 |
|
58 |
*/
|
59 |
#include <avr/interrupt.h> |
60 |
#include <util/delay.h> |
61 |
|
62 |
#include "dragonfly_defs.h" |
63 |
#include "time.h" |
64 |
|
65 |
|
66 |
/* Calculate how many cycles to delay for to get 1 ms. Based on F_CPU which should be defined by the makefile */
|
67 |
#ifdef F_CPU
|
68 |
#define WAIT_CYCLES ((F_CPU / 1000) / 10) |
69 |
#else
|
70 |
#define WAIT_CYCLES (8000 / 10) |
71 |
#endif
|
72 |
|
73 |
|
74 |
unsigned char time_initd = 0; |
75 |
|
76 |
static volatile int _rtc_val = 0; |
77 |
static volatile int _rtc_pulse = 0; |
78 |
static volatile int _rtc_scale = 32; //Defaults to 1 Second per pulse |
79 |
static void (*_rtc_f)(void) = 0; |
80 |
|
81 |
|
82 |
|
83 |
/**
|
84 |
* @defgroup time Time
|
85 |
* @brief Time functions
|
86 |
*
|
87 |
* Functions dealing with time.
|
88 |
*
|
89 |
* @{
|
90 |
**/
|
91 |
|
92 |
/**
|
93 |
* Delays for the specified number of milliseconds.
|
94 |
* It depends on F_CPU to be defined in order to calculate how many cycles
|
95 |
* it should delay. If it is not defined, a default clock of 8MHz is assumed.
|
96 |
*
|
97 |
* We use _delay_loop_2 which will run assembly instructions that should be
|
98 |
* 4 cycles long. Optimizations must be enabled for this to be true.
|
99 |
* That function is called to ensure around 1ms per execution. To generate
|
100 |
* multiple ms we run a for loop of how many milliseconds are desired.
|
101 |
*
|
102 |
* The error should be just the skew on the oscillator as the formula to
|
103 |
* calculate delay cycles should always be a whole number. The is some skew
|
104 |
* in practice though it is unavoidable. Delaying for less than 1s should make
|
105 |
* the error negligable.
|
106 |
*
|
107 |
* @param ms the number of milliseconds to delay for
|
108 |
**/
|
109 |
void delay_ms(int ms) { |
110 |
for (; ms > 0; ms--) { |
111 |
_delay_loop_2(WAIT_CYCLES); |
112 |
} |
113 |
} |
114 |
|
115 |
|
116 |
/* Prescales defined in time.h. SECOND will give you 1 second.
|
117 |
More scales are defined in the time.h file.
|
118 |
rtc_func is the address to a function that you want called every clock tick. */
|
119 |
/**
|
120 |
* Initializes the real time clock. Prescales are defined in time.h.
|
121 |
* For example, SECOND will give 1 second. The specified function is
|
122 |
* called every clock tick. For the real time clock to activate,
|
123 |
* interrupts must be enabled. (through sei() )
|
124 |
*
|
125 |
* @param prescale_opt the period with which the timer is triggered
|
126 |
* @param rtc_func the function called when the timer is triggered
|
127 |
*
|
128 |
* @return 0 if init succesfull, an error code otherwise
|
129 |
*
|
130 |
* @see rtc_get, rtc_reset
|
131 |
*
|
132 |
**/
|
133 |
int rtc_init(int prescale_opt, void (*rtc_func)(void)) { |
134 |
|
135 |
if(time_initd) {
|
136 |
return ERROR_INIT_ALREADY_INITD;
|
137 |
} |
138 |
|
139 |
//Clear timer register for Timer 3
|
140 |
TCNT3 = 0;
|
141 |
|
142 |
/* This sets the Waveform Generation Module to CTC (Clear Timer on Compare) Mode (100)
|
143 |
See page135 in Atmega128 Docs for more modes and explanations */
|
144 |
TCCR3B |= _BV(WGM32); |
145 |
|
146 |
/* This sets the prescaler for the system clock (8MHz) ie: divides the clock by some number.
|
147 |
Currently set to a prescaler of 8 because that is what the orb and servos use (they are on this timer as well)
|
148 |
See page137 in Atemga128 Docs for all the available prescalers */
|
149 |
TCCR3B |= _BV(CS31); |
150 |
|
151 |
/* Sets the two regsiters that we compare against. So the timer counts up to this number and
|
152 |
then resets back to 0 and calls the compare match interrupt.
|
153 |
8x10^6 / 8 = 1/16 Second. All values are based off of this number. Do not change it unless you
|
154 |
are l337*/
|
155 |
|
156 |
OCR3A = 0xF424;
|
157 |
|
158 |
/* Enable Output Compare A Interrupt. When OCR3A is met by the timer TCNT3 this interrupt will be
|
159 |
triggerd. (See page140 in Atmega128 Docs for more information */
|
160 |
ETIMSK |= _BV(OCIE3A); |
161 |
|
162 |
/* Store the pointer to the function to be used in the interrupt */
|
163 |
_rtc_f = rtc_func; |
164 |
|
165 |
/* Store how many 1/16ths of a second you want to let by before triggering an interrupt */
|
166 |
_rtc_scale = prescale_opt; |
167 |
|
168 |
time_initd = 1;
|
169 |
|
170 |
return 0; |
171 |
} |
172 |
|
173 |
/**
|
174 |
* Returns the time elapsed in seconds since the last call to
|
175 |
* rtc_init or rtc_reset.
|
176 |
*
|
177 |
* @return the number of seconds since the last call to rtc_init or rtc_reset
|
178 |
*
|
179 |
* @see rtc_init, rtc_reset
|
180 |
**/
|
181 |
int rtc_get(void) { |
182 |
return _rtc_val;
|
183 |
} |
184 |
|
185 |
/**
|
186 |
* Resets the real time clock counter to 0.
|
187 |
*
|
188 |
* @see rtc_init, rtc_get
|
189 |
**/
|
190 |
void rtc_reset(void) { |
191 |
_rtc_val = 0;
|
192 |
} |
193 |
|
194 |
/** @} **/ //end defgroup |
195 |
|
196 |
/* Called every pulse. Function in _rtc_f is called every _rtc_scale and also the counter is updated.
|
197 |
Bascially, since the pulse is hard set at 1/16s you want to count how many 16ths of a second have passed
|
198 |
and when it reaches the amount of time you want, execute the code. */
|
199 |
SIGNAL(TIMER3_COMPA_vect) { |
200 |
|
201 |
if (_rtc_pulse == _rtc_scale) {
|
202 |
//Increment the real time clock counter
|
203 |
_rtc_val++; |
204 |
|
205 |
//Calls the function tied to the real time clock if defined
|
206 |
if(_rtc_f != 0) |
207 |
_rtc_f(); |
208 |
|
209 |
//Resets the pulse until the next scale is matched
|
210 |
_rtc_pulse = 0;
|
211 |
} |
212 |
|
213 |
//Updates the amount of pulses seen since the last scale match
|
214 |
_rtc_pulse++; |
215 |
|
216 |
} |