* Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
* -->
*
- * \brief Bertos Kernel core (Process scheduler).
+ * \brief BeRTOS Kernel core (Process scheduler).
*
* \version $Id$
* \author Bernie Innocenti <bernie@codewiz.org>
*
- * $WIZARD_MODULE = {
- * "name" : "kernel",
- * "depends" : [],
- * "configuration" : "bertos/cfg/cfg_kern.h"
- * }
+ * $WIZ$ module_name = "kernel"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_proc.h"
+ * $WIZ$ module_depends = "switch_ctx", "coop"
+ * $WIZ$ module_supports = "not atmega103"
*/
#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
*/
struct Process;
+/**
+ * Initialize the process subsystem (kernel).
+ * It must be called before using any process related function.
+ */
void proc_init(void);
+
+/**
+ * Create a new named process and schedules it for execution.
+ *
+ * \note The function
+ * \code
+ * proc_new(entry, data, stacksize, stack)
+ * \endcode
+ * is a more convenient way to create a process, as you don't have to specify
+ * the name.
+ *
+ * \param name Name of the process (currently unused).
+ * \param entry Function that the process will execute.
+ * \param data Pointer to user data.
+ * \param stacksize Length of the stack.
+ * \param stack Pointer to the memory area to be used as a 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(#entry,(entry),(data),(size),(stack))
#endif
+/**
+ * Terminate the execution of the current process.
+ */
void proc_exit(void);
+
+/**
+ * Co-operative context switch.
+ *
+ * The process that calls this function will release the CPU before its cpu quantum
+ * expires, the scheduler will run to select the next process that will take control
+ * of the processor.
+ * \note This function is available only if CONFIG_KERN is enabled
+ * \sa cpu_relax(), which is the recommended method to release the cpu.
+ */
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);
+
+/**
+ * Return a pointer to the user data of the current process.
+ *
+ * To obtain user data, just call this function inside the process. Remember to cast
+ * the returned pointer to the correct type.
+ * \return Pointer to the user data of the current process.
+ */
iptr_t proc_currentUserData(void);
int proc_testSetup(void);
* stack.
*
* The actual size computed by the default formula is:
- * AVR: 102
- * i386: 156
- * ARM: 164
- * x86_64: 184
+ * \li AVR: 102
+ * \li i386: 156
+ * \li ARM: 164
+ * \li x86_64: 184
*
* Note that on most 16bit architectures, interrupts will also
* run on the stack of the currently running process. Nested