include/fosa.h

   1 //----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 by the FRESCOR consortium:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politecnica  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
  17 //
  18 //        The 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 // This file is part of FOSA (Frsh Operating System Abstraction)
  32 //
  33 // FOSA is free software; you can redistribute it and/or modify it
  34 // under terms of the GNU General Public License as published by the
  35 // Free Software Foundation; either version 2, or (at your option) any
  36 // later version.  FOSA is distributed in the hope that it will be
  37 // useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  38 // of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  39 // General Public License for more details. You should have received a
  40 // copy of the GNU General Public License along with FOSA; see file
  41 // COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
  42 // Cambridge, MA 02139, USA.
  43 //
  44 // As a special exception, including FOSA header files in a file,
  45 // instantiating FOSA generics or templates, or linking other files
  46 // with FOSA objects to produce an executable application, does not
  47 // by itself cause the resulting executable application to be covered
  48 // by the GNU General Public License. This exception does not
  49 // however invalidate any other reasons why the executable file might be
  50 // covered by the GNU Public License.
  51 // -----------------------------------------------------------------------
  52 //fosa.h
  53 //==============================================
  54 //  ********  ******    ********  **********
  55 //  **///// /**    **  **//////  /**     /**
  56 //  **      /**    ** /**        /**     /**
  57 //  ******* /**    ** /********* /**********
  58 //  **////  /**    ** ////////** /**//////**
  59 //  **      /**    **        /** /**     /**
  60 //  **      /**    **  ********  /**     /**
  61 //  //       /******/  ////////   //      //
  62 //
  63 // FOSA(Frescor Operating System Adaptation layer)
  64 //================================================
  65
  66
  67 #ifndef         _FOSA_H_
  68 #define         _FOSA_H_
  69
  70 #include "fosa_configuration_parameters.h"
  71 #include "fosa_types.h"
  72
  73 #include "fosa_threads_and_signals.h"
  74 #include "fosa_clocks_and_timers.h"
  75 #include "fosa_mutexes_and_condvars.h"
  76 #include "fosa_app_def_sched.h"
  77 #include "fosa_long_jump.h"
  78 #include "fosa_time.h"
  79
  80
  81 /**
  82  * @defgroup fosa FOSA Private Interfaces
  83  *
  84  * FOSA is an OS adaption layer that encapsulates all POSIX types and
  85  * functions into neutral names so that FRSH can compile and be used in
  86  * non-POSIX operating systems such as OSE.
  87  *
  88  * It is divided in two parts:
  89  *  - FRSH_FOSA:  Types visible to the application via FRSH_API and
  90  *                the functions to manage them (thread, signals).
  91  *  - FOSA:  Types and functions only used within FRSH.
  92  *
  93  * The former reside in the FRSH subversion directory and the latter
  94  * have their own.  They need to be separated because the application
  95  * must not see FOSA itself.
  96  *
  97  * For simplicity, we have chosen to hide the operation function on
  98  * signals and mutexes with the assumption that a direct mapping
  99  * exists for frsh_signal_t, frsh_signal_info_t and frsh_mutext_t in
 100  * the native OS.
 101  *
 102  * Since there are some parts which are platform dependent a define
 103  * has been introduced for each platform.  Currently the supported
 104  * defines are:
 105  *
 106  *         -DRT_LINUX
 107  *         -DOSE
 108  *         -DMARTE_OS
 109  *         -DAQuoSA
 110  *
 111  * This module contains all other modules that are internal to the
 112  * FRSH implementation.
 113  *
 114  * Note that to compile FOSA objects an include path towards FRSH is
 115  * needed:  -I<frsh_include_directory>.
 116  **/
 117
 118
 119 #endif // _FOSA_H_