log: Retouch documentation; Rearrenge level logic; Rename LOG_VERBOSITY to LOG_FORMAT...

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

diff --git a/bertos/kern/proc_p.h b/bertos/kern/proc_p.h
index 7dad780d4fb03098ce3f388afcee3750acec50bb..24c02fe3de612b385fa76bbdfc43bb407b0c50e0 100644 (file)
--- a/bertos/kern/proc_p.h
+++ b/bertos/kern/proc_p.h
@@ -94,11 +94,24 @@ typedef struct Process
 /** Track running processes. */
 extern REGISTER Process        *CurrentProcess;
 
-/** Track ready processes. */
+/**
+ * Track ready processes.
+ *
+ * Access to this list must be protected with a proc_forbid() / proc_premit()
+ * pair, or with SCHED_ATOMIC()
+ */
 extern REGISTER List     ProcReadyList;
 
 
-/** Enqueue a task in the ready list. */
+/**
+ * Enqueue a task in the ready list.
+ *
+ * Always use this macro to instert a process in the ready list, as its
+ * might vary to implement a different scheduling algorithms.
+ *
+ * \note This macro is *NOT* protected against the scheduler.  Access to
+ *       this list must be performed with interrupts disabled.
+ */
 #define SCHED_ENQUEUE(proc)  ADDTAIL(&ProcReadyList, &(proc)->link)
 
 /** Schedule to another process *without* adding the current to the ready list. */