Exclude doc directories from the codelite project file

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

diff --git a/bertos/kern/proc.h b/bertos/kern/proc.h
index 70cd7dc177f5cb6b3119217017129bcad91c6cae..45949e8e3ef166f0bebc3b62bb014a15c8444ba1 100644 (file)
--- a/bertos/kern/proc.h
+++ b/bertos/kern/proc.h
@@ -56,6 +56,16 @@
 #include <cpu/types.h> // cpu_stack_t
 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
 
+/*
+ * Define stack for one process.
+ *
+ * This macro define a static stack for one process and do
+ * check if given stack size is enough to run process.
+ */
+#define PROC_DEFINE_STACK(name, size) \
+       STATIC_ASSERT(size >= CONFIG_KERN_MINSTACKSIZE); \
+       cpu_stack_t name[size / sizeof(cpu_stack_t)]; \
+
 /*
  * Forward declaration. The definition of struct Process is private to the
  * scheduler and hidden in proc_p.h.
@@ -71,6 +81,14 @@ void proc_init(void);
 /**
  * Create a new named process and schedules it for execution.
  *
+ * When defining the stacksize take into account that you may want at least:
+ * \li save all the registers for each nested function call;
+ * \li have memory for the struct Process, which is positioned at the bottom
+ * of the stack;
+ * \li have some memory for temporary variables inside called functions.
+ *
+ * The value given by CONFIG_KERN_MINSTACKSIZE is rather safe to use in the first place.
+ *
  * \note The function
  * \code
  * proc_new(entry, data, stacksize, stack)
@@ -78,11 +96,11 @@ void proc_init(void);
  * is a more convenient way to create a process, as you don't have to specify
  * the name.
  *
- * \param name The name of the process (currently unused).
- * \param entry The function that the process will execute.
- * \param data A pointer to user data.
- * \param stacksize The length of the stack.
- * \param stack A pointer to the memory area to be used as a stack.
+ * \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);
 
@@ -93,17 +111,18 @@ struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t
 #endif
 
 /**
- * Terminates the execution of the current process.
+ * 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 afterwards.
- * \note This function is enabled only if CONFIG_KERN is enabled
- * \sa cpu_relax(), which the recommended method to release the cpu.
+ * 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);
 
@@ -116,7 +135,7 @@ const char *proc_currentName(void);
  *
  * To obtain user data, just call this function inside the process. Remember to cast
  * the returned pointer to the correct type.
- * \return A pointer to the user data of the current process.
+ * \return Pointer to the user data of the current process.
  */
 iptr_t proc_currentUserData(void);