Mention DevLib license.
[bertos.git] / kern / proc.c
index 164df21e91806b7f1cd366451af14ac2e92e0b56..f8c7fb8df3330138729574a189c1401350c10be8 100755 (executable)
@@ -1,9 +1,9 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2001,2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \brief Simple realtime multitasking scheduler.
 
 /*#*
  *#* $Log$
+ *#* Revision 1.31  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.30  2006/03/27 04:49:23  bernie
+ *#* CPU_IDLE(): Fix for new emulator.
+ *#*
+ *#* Revision 1.29  2006/02/24 01:17:05  bernie
+ *#* Update for new emulator.
+ *#*
+ *#* Revision 1.28  2006/02/21 16:06:55  bernie
+ *#* Cleanup/update process scheduling.
+ *#*
+ *#* Revision 1.27  2005/11/04 16:20:02  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.26  2005/04/11 19:10:28  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.25  2005/03/15 00:20:54  bernie
+ *#* proc_schedule(): New sanity check.
+ *#*
  *#* Revision 1.24  2005/01/08 09:20:54  bernie
  *#* Remove unused variable.
  *#*
 
 #include "proc_p.h"
 #include "proc.h"
-#include "cpu.h"
-#include "event.h"
-#include "hw.h"
-#include <debug.h>
-#include <arch_config.h>  /* ARCH_EMUL */
-#include <macros.h>  /* ABS() */
+//#include "hw.h"
+#include <mware/event.h>
+#include <cfg/cpu.h>
+#include <cfg/debug.h>
+#include <cfg/arch_config.h>  /* ARCH_EMUL */
+#include <cfg/macros.h>  /* ABS() */
 
 #include <string.h> /* memset() */
 
-/*!
+/**
  * CPU dependent context switching routines.
  *
  * \note This function *MUST* preserve also the status of the interrupts.
@@ -133,7 +154,7 @@ uint16_t Quantum;
 extern List StackFreeList;
 #endif
 
-/*! The main process (the one that executes main()). */
+/** The main process (the one that executes main()). */
 struct Process MainProcess;
 
 
@@ -176,13 +197,13 @@ void proc_init(void)
 }
 
 
-/*!
+/**
  * Create a new process, starting at the provided entry point.
  *
  * \return Process structure of new created process
  *         if successful, NULL otherwise.
  */
-struct Process *proc_new_with_name(UNUSED(const char*, name), void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack_base)
+struct Process *proc_new_with_name(UNUSED(const char *, name), void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack_base)
 {
        Process *proc;
        size_t i;
@@ -193,9 +214,9 @@ struct Process *proc_new_with_name(UNUSED(const char*, name), void (*entry)(void
 
 #if (ARCH & ARCH_EMUL)
        /* Ignore stack provided by caller and use the large enough default instead. */
-       stack_base = (cpustack_t *)StackFreeList.head;
-       REMOVE((Node *)stack_base);
-       stacksize = DEF_STACKSIZE;
+       stack_base = (cpustack_t *)LIST_HEAD(&StackFreeList);
+       REMOVE(LIST_HEAD(&StackFreeList));
+       stacksize = CONFIG_KERN_DEFSTACKSIZE;
 #elif CONFIG_KERN_HEAP
        /* Did the caller provide a stack for us? */
        if (!stack_base)
@@ -265,7 +286,7 @@ struct Process *proc_new_with_name(UNUSED(const char*, name), void (*entry)(void
        return proc;
 }
 
-/*! Rename a process */
+/** Rename a process */
 void proc_rename(struct Process *proc, const char *name)
 {
 #if CONFIG_KERN_MONITOR
@@ -276,7 +297,7 @@ void proc_rename(struct Process *proc, const char *name)
 }
 
 
-/*!
+/**
  * System scheduler: pass CPU control to the next process in
  * the ready queue.
  *
@@ -296,9 +317,14 @@ void proc_schedule(void)
        /* Remember old process to save its context later */
        old_process = CurrentProcess;
 
+#ifdef IRQ_RUNNING
+       /* Scheduling in interrupts is a nono. */
+       ASSERT(!IRQ_RUNNING());
+#endif
+
        /* Poll on the ready queue for the first ready process */
        IRQ_SAVE_DISABLE(flags);
-       while (!(CurrentProcess = (struct Process *)REMHEAD(&ProcReadyList)))
+       while (!(CurrentProcess = (struct Process *)list_remHead(&ProcReadyList)))
        {
                /*
                 * Make sure we physically reenable interrupts here, no matter what
@@ -311,7 +337,7 @@ void proc_schedule(void)
                 * reason to do this.
                 */
                IRQ_ENABLE;
-               SCHEDULER_IDLE;
+               CPU_IDLE;
                IRQ_DISABLE;
        }
        IRQ_RESTORE(flags);
@@ -343,13 +369,18 @@ void proc_schedule(void)
 }
 
 
-/*!
+/**
  * Terminate the current process
  */
 void proc_exit(void)
 {
+#if CONFIG_KERN_MONITOR
+       monitor_remove(CurrentProcess);
+#endif
+
 #if CONFIG_KERN_HEAP
-       /* The following code is BROKEN.
+       /*
+        * The following code is BROKEN.
         * We are freeing our own stack before entering proc_schedule()
         * BAJO: A correct fix would be to rearrange the scheduler with
         *  an additional parameter which frees the old stack/process
@@ -361,28 +392,25 @@ void proc_exit(void)
 #endif
 
 #if (ARCH & ARCH_EMUL)
-#error This is wrong
+#warning This is wrong
        /* Reinsert process stack in free list */
        ADDHEAD(&StackFreeList, (Node *)(CurrentProcess->stack
-               - (DEF_STACKSIZE / sizeof(cpustack_t))));
+               - (CONFIG_KERN_DEFSTACKSIZE / sizeof(cpustack_t))));
 
-       /* NOTE: At this point the first two words of what used
+       /*
+        * NOTE: At this point the first two words of what used
         * to be our stack contain a list node. From now on, we
         * rely on the compiler not reading/writing the stack.
         */
 #endif /* ARCH_EMUL */
 
-#if CONFIG_KERN_MONITOR
-       monitor_remove(CurrentProcess);
-#endif
-
        CurrentProcess = NULL;
        proc_schedule();
        /* not reached */
 }
 
 
-/*!
+/**
  * Co-operative context switch
  */
 void proc_switch(void)
@@ -398,7 +426,7 @@ void proc_switch(void)
 }
 
 
-/*!
+/**
  * Get the pointer to the current process
  */
 struct Process *proc_current(void)
@@ -406,7 +434,7 @@ struct Process *proc_current(void)
        return CurrentProcess;
 }
 
-/*!
+/**
  * Get the pointer to the user data of the current process
  */
 iptr_t proc_current_user_data(void)
@@ -417,7 +445,7 @@ iptr_t proc_current_user_data(void)
 
 #if CONFIG_KERN_PREEMPTIVE
 
-/*!
+/**
  * Disable preemptive task switching.
  *
  * The scheduler maintains a per-process nesting counter.  Task switching is
@@ -437,7 +465,7 @@ void proc_forbid(void)
        ++CurrentProcess->forbid_cnt;
 }
 
-/*!
+/**
  * Re-enable preemptive task switching.
  *
  * \sa proc_forbid()
@@ -455,7 +483,7 @@ void proc_permit(void)
 
 #include <drv/timer.h>
 
-/*!
+/**
  * Proc scheduling test subthread 1
  */
 static void NORETURN proc_test_thread1(void)
@@ -468,7 +496,7 @@ static void NORETURN proc_test_thread1(void)
        }
 }
 
-/*!
+/**
  * Proc scheduling test subthread 2
  */
 static void NORETURN proc_test_thread2(void)
@@ -484,7 +512,7 @@ static void NORETURN proc_test_thread2(void)
 static cpustack_t proc_test_stack1[CONFIG_KERN_DEFSTACKSIZE/sizeof(cpustack_t)];
 static cpustack_t proc_test_stack2[CONFIG_KERN_DEFSTACKSIZE/sizeof(cpustack_t)];
 
-/*!
+/**
  * Proc scheduling test
  */
 void NORETURN proc_test(void)