Refactor switch context ASM files to comply to Wizard.

[bertos.git] / bertos / kern / proc.h

diff --git a/bertos/kern/proc.h b/bertos/kern/proc.h
index 4efdf9df8e073e4d0a1ff41783dcdf9b32d7c2b0..7ac632ec1fb7fd3702d1dd4e8f20babfde3160f5 100644 (file)
--- a/bertos/kern/proc.h
+++ b/bertos/kern/proc.h
@@ -30,22 +30,29 @@
  * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
- * \brief Process scheduler (public interface).
+ * \brief Bertos Kernel core (Process scheduler).
  *
  * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
+ *
+ * $WIZ$ module_name = "kernel"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_proc.h"
+ * $WIZ$ module_depends = "switch_ctx"
  */
+
 #ifndef KERN_PROC_H
 #define KERN_PROC_H
 
-#include "cfg/cfg_kern.h"
+#include "cfg/cfg_proc.h"
+#include "cfg/cfg_monitor.h"
+
 #include <cfg/compiler.h>
 
 #if CONFIG_KERN_PREEMPT
        #include <cfg/debug.h> // ASSERT()
 #endif
 
-#include <cpu/types.h> // cpustack_t
+#include <cpu/types.h> // cpu_stack_t
 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
 
 /*
@@ -54,9 +61,8 @@
  */
 struct Process;
 
-/* Task scheduling services */
 void proc_init(void);
-struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
+struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t data, size_t stacksize, cpu_stack_t *stack);
 
 #if !CONFIG_KERN_MONITOR
        #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
@@ -66,16 +72,27 @@ struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t
 
 void proc_exit(void);
 void proc_yield(void);
+void proc_rename(struct Process *proc, const char *name);
+const char *proc_name(struct Process *proc);
+const char *proc_currentName(void);
+iptr_t proc_currentUserData(void);
 
 int proc_testSetup(void);
 int proc_testRun(void);
 int proc_testTearDown(void);
 
-struct Process *proc_current(void);
-iptr_t proc_currentUserData(void);
-void proc_rename(struct Process *proc, const char *name);
-const char *proc_name(struct Process *proc);
-const char *proc_currentName(void);
+/**
+ * Return the context structure of the currently running process.
+ *
+ * The details of the Process structure are private to the scheduler.
+ * The address returned by this function is an opaque pointer that can
+ * be passed as an argument to other process-related functions.
+ */
+INLINE struct Process *proc_current(void)
+{
+       extern struct Process *CurrentProcess;
+       return CurrentProcess;
+}
 
 #if CONFIG_KERN_PRI
        void proc_setPri(struct Process *proc, int pri);
@@ -108,7 +125,7 @@ const char *proc_currentName(void);
 INLINE void proc_forbid(void)
 {
        #if CONFIG_KERN_PREEMPT
-               extern cpuatomic_t _preempt_forbid_cnt;
+               extern cpu_atomic_t _preempt_forbid_cnt;
                /*
                 * We don't need to protect the counter against other processes.
                 * The reason why is a bit subtle.
@@ -156,7 +173,7 @@ INLINE void proc_permit(void)
                 * flushed to memory before task switching is re-enabled.
                 */
                MEMORY_BARRIER;
-               extern cpuatomic_t _preempt_forbid_cnt;
+               extern cpu_atomic_t _preempt_forbid_cnt;
                /* No need to protect against interrupts here. */
                ASSERT(_preempt_forbid_cnt != 0);
                --_preempt_forbid_cnt;
@@ -178,7 +195,7 @@ INLINE void proc_permit(void)
 INLINE bool proc_allowed(void)
 {
        #if CONFIG_KERN_PREEMPT
-               extern cpuatomic_t _preempt_forbid_cnt;
+               extern cpu_atomic_t _preempt_forbid_cnt;
                return (_preempt_forbid_cnt == 0);
        #else
                return true;
@@ -221,8 +238,8 @@ INLINE bool proc_allowed(void)
                 * usage.
                 */
                #define CONFIG_KERN_MINSTACKSIZE  \
-                   (CPU_SAVED_REGS_CNT * 2 * sizeof(cpustack_t) \
-                   + 32 * sizeof(int))
+                   (CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
+                   + 48 * sizeof(int))
        #endif
 #endif
 
@@ -230,23 +247,23 @@ INLINE bool proc_allowed(void)
 #if CONFIG_KERN_MONITOR
        #include <cpu/types.h>
        #if (SIZEOF_CPUSTACK_T == 1)
-               /* 8bit cpustack_t */
+               /* 8bit cpu_stack_t */
                #define CONFIG_KERN_STACKFILLCODE  0xA5
                #define CONFIG_KERN_MEMFILLCODE    0xDB
        #elif (SIZEOF_CPUSTACK_T == 2)
-               /* 16bit cpustack_t */
+               /* 16bit cpu_stack_t */
                #define CONFIG_KERN_STACKFILLCODE  0xA5A5
                #define CONFIG_KERN_MEMFILLCODE    0xDBDB
        #elif (SIZEOF_CPUSTACK_T == 4)
-               /* 32bit cpustack_t */
+               /* 32bit cpu_stack_t */
                #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
                #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
        #elif (SIZEOF_CPUSTACK_T == 8)
-               /* 64bit cpustack_t */
+               /* 64bit cpu_stack_t */
                #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
                #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
        #else
-               #error No cpustack_t size supported!
+               #error No cpu_stack_t size supported!
        #endif
 #endif