aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Code_Overview.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2017-03-27 16:38:01 -0400
committerKevin O'Connor <kevin@koconnor.net>2017-03-30 11:24:42 -0400
commit6d05dd07f59ef21dc81a299e865cdee1fc1d3f8e (patch)
tree5eb3eab42f4a7e0abe0c5b790cee9938a1f65564 /docs/Code_Overview.md
parent7436ec093acc6f45e0fc2389de7294be43e3f0a8 (diff)
downloadkutter-6d05dd07f59ef21dc81a299e865cdee1fc1d3f8e.tar.gz
kutter-6d05dd07f59ef21dc81a299e865cdee1fc1d3f8e.tar.xz
kutter-6d05dd07f59ef21dc81a299e865cdee1fc1d3f8e.zip
sched: Move timer dispatch loop to board code
Rename sched_timer_kick() to sched_timer_dispatch() and move its loop into its callers in the board code. This eliminates the need to export timer_try_set_next() from the board code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Code_Overview.md')
-rw-r--r--docs/Code_Overview.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md
index ee640457..8b1ca06c 100644
--- a/docs/Code_Overview.md
+++ b/docs/Code_Overview.md
@@ -58,9 +58,9 @@ Timer functions are scheduled by calling sched_add_timer() (located in
**src/sched.c**). The scheduler code will arrange for the given
function to be called at the requested clock time. Timer interrupts
are initially handled in an architecture specific interrupt handler
-(eg, **src/avr/timer.c**), but this just calls sched_timer_kick()
-located in **src/sched.c**. The timer interrupt leads to execution of
-schedule timer functions. Timer functions always run with interrupts
+(eg, **src/avr/timer.c**) which calls sched_timer_dispatch() located
+in **src/sched.c**. The timer interrupt leads to execution of schedule
+timer functions. Timer functions always run with interrupts
disabled. The timer functions should always complete within a few
micro-seconds. At completion of the timer event, the function may
choose to reschedule itself.