include/fosa.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2008 FRESCOR consortium partners:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politécnica  Valencia,           SPAIN
   9 //    Czech Technical University in Prague,  CZECH REPUBLIC
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  18 //           FRESCOR project (FP6/2005/IST/5-034026) is funded
  19 //        in part by the European Union Sixth Framework Programme
  20 //        The European Union is not liable of any use that may be
  21 //        made of this code.
  22 //
  23 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //   This file is part of FOSA (Frsh Operating System Adaption)
  35 //
  36 //  FOSA is free software; you can redistribute it and/or modify it
  37 //  under terms of the GNU General Public License as published by the
  38 //  Free Software Foundation; either version 2, or (at your option) any
  39 //  later version.  FOSA is distributed in the hope that it will be
  40 //  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  41 //  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  42 //  General Public License for more details. You should have received a
  43 //  copy of the GNU General Public License along with FOSA; see file
  44 //  COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  45 //  Cambridge, MA 02139, USA.
  46 //
  47 //  As a special exception, including FOSA header files in a file,
  48 //  instantiating FOSA generics or templates, or linking other files
  49 //  with FOSA objects to produce an executable application, does not
  50 //  by itself cause the resulting executable application to be covered
  51 //  by the GNU General Public License. This exception does not
  52 //  however invalidate any other reasons why the executable file might be
  53 //  covered by the GNU Public License.
  54 // -----------------------------------------------------------------------
  55 //fosa.h
  56 //==============================================
  57 //  ********  ******    ********  **********
  58 //  **///// /**    **  **//////  /**     /**
  59 //  **      /**    ** /**        /**     /**
  60 //  ******* /**    ** /********* /**********
  61 //  **////  /**    ** ////////** /**//////**
  62 //  **      /**    **        /** /**     /**
  63 //  **      /**    **  ********  /**     /**
  64 //  //       /******/  ////////   //      //
  65 //
  66 // FOSA(Frescor Operating System Adaptation layer)
  67 //================================================
  68
  69
  70 #ifndef         _FOSA_H_
  71 #define         _FOSA_H_
  72
  73 #include "fosa_cpp_macros.h"
  74 #include "fosa_configuration_parameters.h"
  75 #include "fosa_types.h"
  76
  77 #include "fosa_threads_and_signals.h"
  78 #include "fosa_clocks_and_timers.h"
  79 #include "fosa_mutexes_and_condvars.h"
  80 #include "fosa_app_def_sched.h"
  81 #include "fosa_long_jump.h"
  82 #include "fosa_time.h"
  83 #include "fosa_platform_values.h"
  84
  85 /**
  86  * @defgroup fosa FOSA Private Interfaces
  87  *
  88  * FOSA is an OS adaption layer that encapsulates all POSIX types and
  89  * functions into neutral names so that FRSH can compile and be used in
  90  * non-POSIX operating systems such as OSE.
  91  *
  92  * It is divided in two parts:
  93  *  - FRSH_FOSA:  Types visible to the application via FRSH_API and
  94  *                the functions to manage them (thread, signals).
  95  *  - FOSA:  Types and functions only used within FRSH.
  96  *
  97  * The former reside in the FRSH subversion directory and the latter
  98  * have their own.  They need to be separated because the application
  99  * must not see FOSA itself.
 100  *
 101  * For simplicity, we have chosen to hide the operation function on
 102  * signals and mutexes with the assumption that a direct mapping
 103  * exists for frsh_signal_t, frsh_signal_info_t and frsh_mutext_t in
 104  * the native OS.
 105  *
 106  * Since there are some parts which are platform dependent a define
 107  * has been introduced for each platform.  Currently the supported
 108  * defines are:
 109  *
 110  *         -DRT_LINUX
 111  *         -DPARTIKLE
 112  *         -DOSE
 113  *         -DMARTE_OS
 114  *         -DAQuoSA
 115  *
 116  * This module contains all other modules that are internal to the
 117  * FRSH implementation.
 118  *
 119  * Note that to compile FOSA objects an include path towards FRSH is
 120  * needed:  -I<frsh_include_directory>.
 121  **/
 122
 123
 124 #endif // _FOSA_H_