-// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+//----------------------------------------------------------------------
+// Copyright (C) 2006 - 2007 by the FRESCOR consortium:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// 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
+// See http://www.frescor.org
+//
+// The 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.
//
-// This file is part of the FRSH implementation
//
-// FRSH 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, or (at your option)
-// any later version.
+// 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 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.
+// This file is part of FOSA (Frsh Operating System Abstraction)
//
-// You should have received a copy of the GNU General Public License
-// distributed with FRSH; see file COPYING. If not, write to the
-// Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-// 02111-1307, USA.
+// FOSA is free software; you can redistribute it and/or modify it
+// under terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2, or (at your option) any
+// later version. FOSA 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. You should have received a
+// copy of the GNU General Public License along with FOSA; see file
+// COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+// Cambridge, MA 02139, USA.
//
-// As a special exception, if you include this header file into source
-// files to be compiled, this header 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.
+// As a special exception, including FOSA header files in a file,
+// instantiating FOSA generics or templates, or linking other files
+// with FOSA objects to produce an executable application, does not
+// by itself cause the resulting executable application 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 Public License.
// -----------------------------------------------------------------------
//fosa.h
//==============================================
#ifndef _FOSA_H_
#define _FOSA_H_
-#include "frsh.h"
-
#include "fosa_configuration_parameters.h"
#include "fosa_types.h"
-#include "fosa_errors.h"
#include "fosa_threads_and_signals.h"
#include "fosa_clocks_and_timers.h"
#include "fosa_mutexes_and_condvars.h"
#include "fosa_app_def_sched.h"
+#include "fosa_long_jump.h"
+#include "fosa_time.h"
+
+
+/**
+ * @defgroup fosa FOSA Private Interfaces
+ *
+ * FOSA is an OS adaption layer that encapsulates all POSIX types and
+ * functions into neutral names so that FRSH can compile and be used in
+ * non-POSIX operating systems such as OSE.
+ *
+ * It is divided in two parts:
+ * - FRSH_FOSA: Types visible to the application via FRSH_API and
+ * the functions to manage them (thread, signals).
+ * - FOSA: Types and functions only used within FRSH.
+ *
+ * The former reside in the FRSH subversion directory and the latter
+ * have their own. They need to be separated because the application
+ * must not see FOSA itself.
+ *
+ * For simplicity, we have chosen to hide the operation function on
+ * signals and mutexes with the assumption that a direct mapping
+ * exists for frsh_signal_t, frsh_signal_info_t and frsh_mutext_t in
+ * the native OS.
+ *
+ * Since there are some parts which are platform dependent a define
+ * has been introduced for each platform. Currently the supported
+ * defines are:
+ *
+ * -DRT_LINUX
+ * -DOSE
+ * -DMARTE_OS
+ * -DAQuoSA
+ *
+ * This module contains all other modules that are internal to the
+ * FRSH implementation.
+ *
+ * Note that to compile FOSA objects an include path towards FRSH is
+ * needed: -I<frsh_include_directory>.
+ **/
#endif // _FOSA_H_
projects / frescor / fosa.git / blobdiff