const

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

diff --git a/frsh_hierarchical_types.h b/frsh_hierarchical_types.h
index d8af1feeac71df6f94fe22ebbed0510231ead0e4..8eaa53bd47522c5cf1bd838509954ba0367e3348 100644 (file)
--- a/frsh_hierarchical_types.h
+++ b/frsh_hierarchical_types.h
@@ -1,10 +1,34 @@
 // -----------------------------------------------------------------------
+//  Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+//
+//    Universidad de Cantabria,              SPAIN
+//    University of York,                    UK
+//    Scuola Superiore Sant'Anna,            ITALY
+//    Kaiserslautern University,             GERMANY
+//    Univ. Politécnica  Valencia,           SPAIN
+//    Czech Technical University in Prague,  CZECH REPUBLIC
+//    ENEA                                   SWEDEN
+//    Thales Communication S.A.              FRANCE
+//    Visual Tools S.A.                      SPAIN
+//    Rapita Systems Ltd                     UK
+//    Evidence                               ITALY
+//    
+//    See http://www.frescor.org for a link to partners' websites
+//
+//           FRESCOR project (FP6/2005/IST/5-034026) is funded
+//        in part by the European Union Sixth Framework Programme
+//        The European Union is not liable of any use that may be
+//        made of this code.
+//
+//
+//  based on previous work (FSF) done in the FIRST project
+//                       
 //   Copyright (C) 2005  Mälardalen University, SWEDEN
 //                       Scuola Superiore S.Anna, ITALY
 //                       Universidad de Cantabria, SPAIN
 //                       University of York, UK
 //
-//   FRSH API web pages: http://marte.unican.es/frsh/docs/
+//   FSF API web pages: http://marte.unican.es/fsf/docs
 //                      http://shark.sssup.it/contrib/first/docs/
 //
 //  This file is part of FRSH API
@@ -33,22 +57,28 @@
 // -----------------------------------------------------------------------
 
 //==============================================
-//  ******** *******    ******** **      **
-//  **///// /**////**  **////// /**     /**
-//  **      /**   /** /**       /**     /**
-//  ******* /*******  /*********/**********
-//  **////  /**///**  ////////**/**//////**
-//  **      /**  //**        /**/**     /**
-//  **      /**   //** ******** /**     /**
-//  //       //     // ////////  //      // 
+//  ******** *******    ********  **      **
+//  **///// /**////**  **//////  /**     /**
+//  **      /**   /** /**        /**     /**
+//  ******* /*******  /********* /**********
+//  **////  /**///**  ////////** /**//////**
+//  **      /**  //**        /** /**     /**
+//  **      /**   //** ********  /**     /**
+//  //       //     // ////////   //      // 
 //
 // FRSH(FRescor ScHeduler), pronounced "fresh"
 //==============================================
 #ifndef        FRSH_HIERARCHICAL_TYPES_H_
 #define        FRSH_HIERARCHICAL_TYPES_H_
 
+/**
+ * @file frsh_hierarchical_types.h
+ **/
+
 #include <time.h>
 
+FRSH_CPP_BEGIN_DECLS
+
 /**
  * @addtogroup hierarchical
  *
@@ -67,7 +97,7 @@ typedef enum {FRSH_FP, FRSH_EDF, FRSH_TABLE_DRIVEN, FRSH_RR, FRSH_NONE}
  * The params member is a pointer to one of the 
  * following:
  *    FP:  int (priority)
- *    EDF: struct timespec (deadline)
+ *    EDF: frsh_rel_time_t (deadline)
  *    RR:  none
  *    TABLE_DRIVEN : struct frsh_table_driven_params_t
  **/
@@ -82,17 +112,17 @@ typedef struct {
  * list of target windows 
  **/
 typedef struct {
-   struct timespec   start;
-   struct timespec   end;
-   struct timespec   comp_time;
-} frsh_target_window;
+   frsh_rel_time_t   start;
+   frsh_rel_time_t   end;
+   frsh_rel_time_t   comp_time;
+} frsh_target_window_t;
 
 /**
  * Container for a frsh_target_window array
  **/
 typedef struct {
   int size;
-  frsh_target_window  table[FRSH_MAX_N_TARGET_WINDOWS];
+  frsh_target_window_t  table[FRSH_MAX_N_TARGET_WINDOWS];
 } frsh_table_driven_params_t;
 
 
@@ -102,11 +132,13 @@ typedef struct {
  * It shall be one of the following:
  *    FP:  none
  *    EDF: none
- *    RR: struct timespec (slice duration)
- *    TABLE_DRIVEN : struct timespec (schedule duration)
+ *    RR: frsh_rel_time_t (slice duration)
+ *    TABLE_DRIVEN : frsh_rel_time_t (schedule duration)
  **/
 typedef void * frsh_sched_init_info_t;
 
 /*}*/
 
+FRSH_CPP_END_DECLS
+
 #endif             /* !FRSH_HIERARCHICAL_TYPES_H_ */