Upgrading FRSH trunk to D-AC2v2. Phase I: Moving FRSH-FOSA to FOSA

[frescor/frsh-include.git] / frsh_hierarchical.h

diff --git a/frsh_hierarchical.h b/frsh_hierarchical.h
index d397ff87f8a435d4e0ac7e54c111781f85e348bd..ea04e229c29b26cc71d202a025e0d65d4087b52d 100644 (file)
--- a/frsh_hierarchical.h
+++ b/frsh_hierarchical.h
@@ -79,6 +79,9 @@
 
 #define FRSH_HIERARCHICAL_MODULE_SUPPORTED       1
 
+/**
+ * @file frsh_hierarchical.h
+ **/
 
 /**
  * @defgroup hierarchical Hierarchical Scheduling Module
@@ -94,20 +97,21 @@
  * frsh_local_scheduler_init()
  *
  *  This call has the following effects:
- *    FP:  none
- *    EDF: none
+ *    FP:  none \n
+ *    EDF: none \n
  *    TABLE_DRIVEN :
  *       Records the schedule duration, and starts the
  *       schedule at the time of the call. After the
  *       schedule duration has elapsed, the schedule in
  *       the table is repeated.
  *
- *  @return
+ *  @return 0 if no error \n
  *    FRSH_ERR_BAD_ARGUMENT : if the value of the vres argument is not in range,
- *      or info is NULL
+ *      or info is NULL \n
  *    FRSH_ERR_NOT_SCHEDULED_CALLING_THREAD : if the calling thread is not
- *      scheduled under the FRSH
- *    FRSH_ERR_INVALID_SCHEDULER_REPLY : the scheduler is wrong or not running
+ *      scheduled under the FRSH \n
+ *    FRSH_ERR_INVALID_SCHEDULER_REPLY : the scheduler is wrong or not
+ *      running \n
  *    FRSH_ERR_NOT_CONTRACTED_VRES : if the vres of the calling thread 
  *      has been cancelled or it is not valid
  **/
@@ -124,7 +128,7 @@ int frsh_local_scheduler_init(
  *  The default policy is FRSH_NONE, which means that only one thread
  *  may be bound to the vres
  *
- *  @return
+ *  @return 0 if no error \n
  *    FRSH_ERR_BAD_ARGUMENT : if sched_policy is not in range,
  *     or contract is NULL
  **/
@@ -140,7 +144,7 @@ int frsh_contract_set_sched_policy
  * object its scheduling policy, and copies it to the place pointed to
  * by the corresponding input parameter.
  *
- *  @return
+ *  @return 0 if no error \n
  *     FRSH_ERR_BAD_ARGUMENT : if sched_policy or contract are NULL
  **/
 int frsh_contract_get_sched_policy
@@ -163,17 +167,18 @@ int frsh_contract_get_sched_policy
  * policy and priority, according to the preemption level given in the
  * contract and the frsh_priority_map() function defined by the user.
  *
- * @return
+ * @return 0 if no error \n
  *   FRSH_ERR_BAD_ARGUMENT : if the value of the vres argument is not in range,
- *     or sched_params is NULL
+ *     or sched_params is NULL \n
  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the scheduling policy 
- *     in sched_params is not compatible to the vres's one.
+ *     in sched_params is not compatible to the vres's one \n
  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
- *     main scheduler
- *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not valid
+ *     main scheduler \n
+ *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not
+ *     valid \n
  *   FRSH_ERR_VRES_WORKLOAD_NOT_COMPATIBLE: if the kind of workload
- *     of the vres is FRSH_OVERHEAD
- *    
+ *     of the vres is FRSH_OVERHEAD \n
+ *   . 
  *   It may also return any of  the errors that may be returned by the
  *   pthread_create()POSIX function call
  **/
@@ -202,17 +207,19 @@ int frsh_thread_create_local(frsh_vres_id_t      vres,
  * scheduling policy SCHED_APP and at the same time be attached to an
  * application scheduler different than the frsh scheduler. 
  *
- * @return
+ * @return 0 if no error \n
  *   FRSH_ERR_BAD_ARGUMENT : if the vres argument does not complain with
  *     the expected format or valid range, the given thread does not exist,
- *     or sched_params is NULL
+ *     or sched_params is NULL \n
  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the scheduling policy 
- *     in sched_params is not compatible to the vres's one.
+ *     in sched_params is not compatible to the vres's one. \n
  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
- *     main scheduler
+ *     main scheduler \n
  *   FRSH_ERR_UNKNOWN_APPSCHEDULED_THREAD : if the thread is attached to
- *     an application defined scheduler different than the frsh scheduler
- *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not valid
+ *     an application defined scheduler different than the frsh
+ *     scheduler \n
+ *   FRSH_ERR_NOT_CONTRACTED_VRES : if the referenced vres is not
+ *     valid \n
  *   FRSH_ERR_VRES_WORKLOAD_NOT_COMPATIBLE: if the kind of workload
  *     of the vres is FRSH_OVERHEAD
  **/
@@ -229,18 +236,19 @@ int frsh_thread_bind_local(frsh_vres_id_t      vres,
  * compatible with the scheduling policy of the vres to which the
  * thread is bound.
  *
- * @return
+ * @return 0 if no error \n
  *   FRSH_ERR_BAD_ARGUMENT : if the given thread does not exist,
- *     or sched_params is NULL
+ *     or sched_params is NULL \n
  *   FRSH_ERR_SCHED_POLICY_NOT_COMPATIBLE : if the thread is already bound
  *     and the scheduling policy in sched_params is not compatible to the
- *     one of the thread's vres.
+ *     one of the thread's vres. \n
  *   FRSH_ERR_NOT_SCHEDULED_THREAD : if the given thread is not scheduled 
- *     under the FRSH
+ *     under FRSH \n
  *   FRSH_ERR_INTERNAL_ERROR : erroneous binding or malfunction of the FRSH
- *     main scheduler
+ *     main scheduler \n
  *   FRSH_ERR_UNKNOWN_APPSCHEDULED_THREAD : if the thread is attached to
- *     an application defined scheduler different than the frsh scheduler
+ *     an application defined scheduler different than the frsh
+ *     scheduler \n
  *   FRSH_ERR_NOT_CONTRACTED_VRES : if the thread is bound and its vres
  *     is not valid
  **/
@@ -253,11 +261,11 @@ int frsh_thread_set_local_sched_params (frsh_thread_id_t thread,
  * This function stores the local scheduling parameters of the
  * specified thread in the variable pointed to by sched_params.
  *
- * @return
+ * @return 0 if no error \n
  *   FRSH_ERR_BAD_ARGUMENT : if sched_params is NULL or the thread does
- *      not exist
+ *      not exist \n
  *   FRSH_ERR_NOT_SCHEDULED_THREAD : if the given thread is not scheduled 
- *      under the FRSH
+ *      under FRSH
  **/
 int frsh_thread_get_local_sched_params(frsh_thread_id_t            thread,
                                        frsh_sched_params_t  *sched_params);