Doc fixes.
[bertos.git] / kern / proc_p.h
old mode 100755 (executable)
new mode 100644 (file)
index 5cd44a9..8fbb0ed
-/*!
+/**
  * \file
  * <!--
- * Copyright 2001,2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
- * All Rights Reserved.
- * -->
+ * This file is part of BeRTOS.
  *
- * \brief Internal scheduler structures and definitions for processes.
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
  *
- * \version $Id$
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
- * \author Bernardo Innocenti <bernie@develer.com>
- */
-
-/*
- * $Log$
- * Revision 1.1  2004/05/23 17:27:00  bernie
- * Import kern/ subdirectory.
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  *
- * Revision 1.3  2004/05/14 12:52:13  rasky
- * Importato supporto kernel per AVR da Stefano
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
  *
- * Revision 1.2  2004/04/28 16:13:49  rasky
- * proc_schedule() is now semi-private (used only within the kernel)
+ * Copyright 2001, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 1999, 2000, 2001 Bernardo Innocenti <bernie@develer.com>
  *
- * Revision 1.1  2004/04/26 18:02:40  rasky
- * Importato microkernel
+ * -->
  *
- * Revision 1.1  2004/04/04 17:40:26  aleph
- * Add multithreading kernel
+ * \brief Internal scheduler structures and definitions for processes.
+ *
+ * \version $Id$
  *
+ * \author Bernardo Innocenti <bernie@develer.com>
  */
 
 #ifndef KERN_PROC_P_H
 #define KERN_PROC_P_H
 
-#include "compiler.h"
-#include "config.h"
-#include "config_kern.h"
+#include <cfg/compiler.h>
+#include <cpu/types.h>        /* for cpu_stack_t */
 #include <mware/list.h>
-#include <drv/timer.h>
-
+#include <config_kern.h>
+#include <appconfig.h>
 
 typedef struct Process
 {
-       Node         link;        /*!< Link Process into scheduler lists */
-       cpustack_t  *stack;       /*!< Per-process SP */
+       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
-       sigset_t     sig_wait;    /*!< Signals the process is waiting for */
-       sigset_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_TIMER
-       struct Timer proc_timer;  /*!< Process own timer */
+#if CONFIG_KERN_PREEMPTIVE
+       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
+       struct ProcMonitor
+       {
+               Node        link;
+               const char *name;
+               cpustack_t *stack_base;
+               size_t      stack_size;
+       } monitor;
+#endif
+
 } Process;
 
 
-/*!
- * \name Flags for Process.flags
+/**
+ * \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 */
+       void monitor_init(void);
+
+       /** 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 */
+       void monitor_remove(Process *proc);
+
+       /** Rename a process */
+       void monitor_rename(Process *proc, const char* name);
+#endif /* CONFIG_KERN_MONITOR */
+
 #endif /* KERN_PROC_P_H */