592d17b16401e2ca4e6699c3b0cdefb549124173
[bertos.git] / bertos / kern / idle.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2008 Bernie Innocenti <bernie@codewiz.org>
30  * -->
31  *
32  * \brief Idle loop for preemptive scheduling
33  *
34  * \version $Id$
35  * \author Bernie Innocenti <bernie@codewiz.org>
36  */
37
38 #include "idle.h"
39 #include "proc.h"
40
41 #include <cpu/power.h> // cpu_relax()
42 #include <cfg/module.h>
43 #include <cpu/types.h> // INT_MIN
44
45 #include <kern/proc_p.h>
46
47 struct Process *idle_proc;
48
49 static PROC_DEFINE_STACK(idle_stack, KERN_MINSTACKSIZE);
50
51 /**
52  * The idle process
53  *
54  * This process never dies and never sleeps.  It's also quite lazy, apathic
55  * and sometimes even a little antisocial.
56  *
57  * Having an idle process costs us some stack space, but simplifies the
58  * interrupt-driven preemption logic because there is always a user
59  * context to which we can return.
60  *
61  * The idle process is not required for cooperative task switching.
62  */
63 static NORETURN void idle(void)
64 {
65         for (;;)
66         {
67                 CPU_IDLE;
68                 proc_switch();
69         }
70 }
71
72 void idle_init(void)
73 {
74         /*
75          * Idle will be added to the ProcReadyList, but immediately removed
76          * after the first cpu_relax() execution.
77          *
78          * XXX: it would be better to never add idle_proc to the ProcReadyList,
79          * e.g., changing the prototype of proc_new() (or introducing a
80          * proc_new_nostart()) to allow the creation of "sleeping" tasks.
81          */
82         idle_proc = proc_new(idle, NULL, sizeof(idle_stack), idle_stack);
83         proc_setPri(idle_proc, INT_MIN);
84 }