X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=kern%2Fproc_p.h;h=9ab3dcbf1f24eb4e808d1e1b22c897950a4a8884;hb=7920ccf2c9be523f680d88ef7d681d09af7da209;hp=a9553d81da66c623b4173c2f784f34a467ef3490;hpb=af9c555446161016fdd76c1cdff96ce76bb6cba2;p=bertos.git diff --git a/kern/proc_p.h b/kern/proc_p.h index a9553d81..9ab3dcbf 100755 --- a/kern/proc_p.h +++ b/kern/proc_p.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \brief Internal scheduler structures and definitions for processes. @@ -15,6 +15,15 @@ /*#* *#* $Log$ + *#* Revision 1.16 2006/07/19 12:56:27 bernie + *#* Convert to new Doxygen style. + *#* + *#* Revision 1.15 2005/11/27 23:36:19 bernie + *#* Use appconfig.h instead of cfg/config.h. + *#* + *#* Revision 1.14 2005/11/04 16:20:02 bernie + *#* Fix reference to README.devlib in header. + *#* *#* Revision 1.13 2005/04/11 19:10:28 bernie *#* Include top-level headers from cfg/ subdir. *#* @@ -73,29 +82,29 @@ #include #include /* for cpu_stack_t */ -#include -#include #include +#include +#include typedef struct Process { - Node link; /*!< Link Process into scheduler lists */ - cpustack_t *stack; /*!< Per-process SP */ - iptr_t user_data; /*!< Custom data passed to the process */ + Node link; /**< Link Process into scheduler lists */ + cpustack_t *stack; /**< Per-process SP */ + iptr_t user_data; /**< Custom data passed to the process */ #if CONFIG_KERN_SIGNALS - sigmask_t sig_wait; /*!< Signals the process is waiting for */ - sigmask_t sig_recv; /*!< Received signals */ + sigmask_t sig_wait; /**< Signals the process is waiting for */ + sigmask_t sig_recv; /**< Received signals */ #endif #if CONFIG_KERN_PREEMPTIVE - int forbid_cnt; /*!< Nesting count for proc_forbid()/proc_permit(). */ + int forbid_cnt; /**< Nesting count for proc_forbid()/proc_permit(). */ #endif #if CONFIG_KERN_HEAP - uint16_t flags; /*!< Flags */ - cpustack_t *stack_base; /*!< Base of process stack */ - size_t stack_size; /*!< Size of process stack */ + uint16_t flags; /**< Flags */ + cpustack_t *stack_base; /**< Base of process stack */ + size_t stack_size; /**< Size of process stack */ #endif #if CONFIG_KERN_MONITOR @@ -111,38 +120,38 @@ typedef struct Process } Process; -/*! +/** * \name Flags for Process.flags. * \{ */ -#define PF_FREESTACK BV(0) /*!< Free the stack when process dies */ +#define PF_FREESTACK BV(0) /**< Free the stack when process dies */ /*\}*/ -/*! Track running processes. */ +/** Track running processes. */ extern REGISTER Process *CurrentProcess; -/*! Track ready processes. */ +/** Track ready processes. */ extern REGISTER List ProcReadyList; -/*! Enqueue a task in the ready list. */ +/** Enqueue a task in the ready list. */ #define SCHED_ENQUEUE(proc) ADDTAIL(&ProcReadyList, &(proc)->link) -/*! Schedule to another process *without* adding the current to the ready list. */ +/** Schedule to another process *without* adding the current to the ready list. */ void proc_schedule(void); #if CONFIG_KERN_MONITOR - /*! Initialize the monitor */ + /** Initialize the monitor */ void monitor_init(void); - /*! Register a process into the monitor */ + /** Register a process into the monitor */ void monitor_add(Process *proc, const char *name, cpustack_t *stack, size_t stacksize); - /*! Unregister a process from the monitor */ + /** Unregister a process from the monitor */ void monitor_remove(Process *proc); - /*! Rename a process */ + /** Rename a process */ void monitor_rename(Process *proc, const char* name); #endif /* CONFIG_KERN_MONITOR */