cpu/power.h: Documentation fixes

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

diff --git a/bertos/kern/proc_p.h b/bertos/kern/proc_p.h
index d69794103bdd943530c525cce2fe0dbf13eb0c1f..6a79eec30d6048194f359f40458e3d8943b39e2d 100644 (file)
--- a/bertos/kern/proc_p.h
+++ b/bertos/kern/proc_p.h
@@ -34,7 +34,6 @@
  * \brief Internal scheduler structures and definitions for processes.
  *
  * \version $Id$
- *
  * \author Bernie Innocenti <bernie@codewiz.org>
  */
 
@@ -94,14 +93,23 @@ 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.
  *
- * \note This is *NOT* protected against 
+ * 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)
 
@@ -123,4 +131,3 @@ void proc_schedule(void);
 #endif /* CONFIG_KERN_MONITOR */
 
 #endif /* KERN_PROC_P_H */
-