// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+// Copyright (C) 2006 - 2009 FRESCOR consortium partners:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// Scuola Superiore Sant'Anna, ITALY
// Kaiserslautern University, GERMANY
-// Univ. Politecnica Valencia, SPAIN
+// 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
// 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
+//
+// FSF API web pages: http://marte.unican.es/fsf/docs
+// http://shark.sssup.it/contrib/first/docs/
//
-// 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 Adaption)
//
-// 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_clocks_and_timers.h
//==============================================
// **//// /** ** ////////** /**//////**
// ** /** ** /** /** /**
// ** /** ** ******** /** /**
-// // /******/ //////// // //
+// // /******/ //////// // //
//
// FOSA(Frescor Operating System Adaptation layer)
//================================================
#ifndef FOSA_CLOCKS_AND_TIMERS_H_
#define FOSA_CLOCKS_AND_TIMERS_H_
+#include "fosa_types.h"
+#include "fosa_configuration_parameters.h"
+
+FOSA_CPP_BEGIN_DECLS
+
/**
* @defgroup clocksandtimers Clocks and Timers
* @ingroup fosa
*
* Get the time from a clock
*
- * This function sets the variable pointed to by current_time to the
- * current value of the clock specified by clockid, which may be the
- * FOSA_CLOCK_REALTIME constant or a value obtained with
+ * This function sets the variable pointed to by current_time to the
+ * current value of the clock specified by clockid, which may be the
+ * FOSA_CLOCK_REALTIME constant or a value obtained with
* fosa_get_cputime_clock()
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of clockid is invalid
+ * FOSA_EINVAL: the value of clockid is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_clock_get_time(fosa_clock_id_t clockid, struct timespec *current_time);
+int fosa_clock_get_time(fosa_clock_id_t clockid, fosa_abs_time_t *current_time);
/**
*
* Get the identifier of a cpu-time clock
*
- * This function stores in the variable pointed to by clockid the
+ * This function stores in the variable pointed to by clockid the
* identifier of a cpu-time clock for the thread specified by tid.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of tid is invalid
- *
+ * FOSA_EINVAL: the value of tid is invalid
+ *
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid);
+int fosa_thread_get_cputime_clock(fosa_thread_id_t tid, fosa_clock_id_t *clockid);
/*************************
* disarmed state, i.e., not counting time. It can be armed to start
* counting time with fosa_timer_arm().
*
- * The function stores the identifier of the newly created timer in the
+ * The function stores the identifier of the newly created timer in the
* variable pointed to by timerid.
*
* When the timer expires, the signal number specified by signal will be
* sent together with the information specified by info, to the thread
- * that armed the timer (@see fosa_timer_arm()).
+ * that armed the timer (@see fosa_timer_arm()).
*
* In those implementations that do not support queueing a
* signal with information to a thread (such as POSIX), the signal may
* be sent to any thread that is waiting for this signal via
* fosa_signal_wait(). Portability can be ensured by having the receiver
- * thread be the one who is waiting for the signal.
- *
+ * thread be the one who is waiting for the signal.
+ *
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of clockid or signal is invalid
- *
- * EAGAIN: the system lacks enough resources to create the timer
+ * FOSA_EINVAL: the value of clockid or signal is invalid
+ *
+ * FOSA_EAGAIN: the system lacks enough resources to create the timer
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
int fosa_timer_create
- (fosa_clock_id_t clockid, frsh_signal_t signal, frsh_signal_info_t info,
+ (fosa_clock_id_t clockid, fosa_signal_t signal, fosa_signal_info_t info,
fosa_timer_id_t *timerid);
+/**
+ * fosa_timer_create_with_receiver()
+ *
+ * Create a one-shot timer with a specific signal receiver thread
+ *
+ * This function creates a timer in the same way as fosa_timer_create,
+ * except that the signal generated when the timer expires is sent to
+ * the thread specified by receiver
+ *
+ * Returns 0 if successful; otherwise it returns an error code:
+ * FOSA_EINVAL: the value of clockid or signal is invalid
+ *
+ * FOSA_EAGAIN: the system lacks enough resources to create the timer
+ *
+ * Alternatively, in case of error the implementation is allowed to
+ * notify it to the system console and then terminate the FRSH
+ * implementation and dependant applications
+ **/
+ int fosa_timer_create_with_receiver
+ (fosa_clock_id_t clockid, fosa_signal_t signal, fosa_signal_info_t info,
+ fosa_timer_id_t *timerid, fosa_thread_id_t receiver);
+
/**
* fosa_timer_delete()
*
* Delete a timer
- *
- * The function deletes the timer specified by timerid, which becomes
+ *
+ * The function deletes the timer specified by timerid, which becomes
* unusable. If the timer was armed, it is automatically disarmed before
* deletion.
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid is not valid
+ * FOSA_EINVAL: the value of timerid is not valid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
int fosa_timer_delete(fosa_timer_id_t timerid);
/**
- * fosa_timer_arm()
+ * fosa_rel_timer_arm()
*
- * Arm a timer
+ * Arm a timer with a relative time interval
*
* The timer specified by timer is armed and starts counting time.
*
- * If abstime is true, the value pointed to by value is the absolute
- * time at which the timer will expire. If value specifies a time instant
- * in the past, the timer expires immediately.
+ * The value pointed to by value is the relative interval that must
+ * elapse for the timer to expire. Negative values cause the timer to
+ * expire immediately.
+ *
+ * The time is measured with the clock associated with the timer when
+ * it was created.
*
- * If abstime is false, the value pointed to by value is the relative interval
- * that must elapse for the timer to expire.
+ * If the timer was already armed, the previous time or interval is discarded
+ * and the timer is rearmed with the new value.
+ *
+ * When the timer expires, it is disarmed.
+ *
+ * Returns 0 if successful; otherwise it returns an error code:
+ * FOSA_EINVAL: the value of timerid or value is invalid
*
- * In both cases, absolute or relative, the time is measured with the clock
- * associated with the timer when it was created.
+ * Alternatively, in case of error the implementation is allowed to
+ * notify it to the system console and then terminate the FRSH
+ * implementation and dependant applications
+ **/
+int fosa_rel_timer_arm
+ (fosa_timer_id_t timerid, const fosa_rel_time_t *value);
+
+/**
+ * fosa_abs_timer_arm()
+ *
+ * Arm a timer that will expire in an absolute time instant.
+ *
+ * The timer specified by timer is armed and starts counting time.
+ *
+ * The value pointed to by value is the absolute time at which the
+ * timer will expire. If value specifies a time instant in the past,
+ * the timer expires immediately.
+ *
+ * The time is measured with the clock associated with the timer when
+ * it was created.
*
* If the timer was already armed, the previous time or interval is discarded
* and the timer is rearmed with the new value.
* When the timer expires, it is disarmed.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid or value is invalid
+ * FOSA_EINVAL: the value of timerid or value is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_timer_arm
- (fosa_timer_id_t timerid, bool abstime,
- const struct timespec *value);
+int fosa_abs_timer_arm
+ (fosa_timer_id_t timerid, const fosa_abs_time_t *value);
+
+
+
/**
* fosa_timer_get_remaining_time()
* If the timer is disarmed it returns 0.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid or value is invalid
+ * FOSA_EINVAL: the value of timerid or value is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
int fosa_timer_get_remaining_time
- (fosa_timer_id_t timerid, struct timespec *remaining_time);
-
-
-
+ (fosa_timer_id_t timerid, fosa_rel_time_t *remaining_time);
/**
* fosa_timer_disarm()
* disarmed a 0 value will be set.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid or value is invalid
+ * FOSA_EINVAL: the value of timerid or value is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_timer_disarm(fosa_timer_id_t timerid, struct timespec
- *remaining_time);
+int fosa_timer_disarm(fosa_timer_id_t timerid,
+ fosa_rel_time_t *remaining_time);
/*@}*/
+FOSA_CPP_END_DECLS
#endif /* !FOSA_CLOCKS_AND_TIMERS_H_ */
projects / frescor / fosa.git / blobdiff