// **//// /** ** ////////** /**//////**
// ** /** ** /** /** /**
// ** /** ** ******** /** /**
-// // /******/ //////// // //
+// // /******/ //////// // //
//
// FOSA(Frescor Operating System Adaptation layer)
//================================================
#include "fosa_types.h"
+FOSA_CPP_BEGIN_DECLS
+
/**
* @defgroup mutexesandcondvars Mutexes and Condvars
* @ingroup fosa
*
* Initialize a frsh mutex
*
- * The mutex pointed to by mutex is initialized as a mutex using
+ * The mutex pointed to by mutex is initialized as a mutex using
* the priority ceiling protocol. A priority ceiling of prioceiling
* is assigned to this mutex.
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
*
* FOSA_EINVAL: the value of prioceiling is invalid \n
* FOSA_EAGAIN: the system lacked the necessary resources to create
- * the mutex \n
+ * the mutex \n
* FOSA_ENOMEM: Insufficient memory exists to initialize the mutex \n
* FOSA_EBUSY: The system has detected an attempt to reinitialize the mutex
*
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_mutex_init(frsh_mutex_t *mutex, int prioceiling);
+int fosa_mutex_init(fosa_mutex_t *mutex, int prioceiling);
/**
* fosa_mutex_destroy()
*
* Destroy a frsh mutex
- *
+ *
* The mutex pointed to by mutex is destroyed
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
*
* FOSA_EINVAL: the value of mutex is invalid \n
- * FOSA_EBUSY: The mutex is in use (is locked)\n
+ * FOSA_EBUSY: The mutex is in use (is locked)\n
*
* 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_mutex_destroy(frsh_mutex_t *mutex);
+int fosa_mutex_destroy(fosa_mutex_t *mutex);
/**
* fosa_mutex_set_prioceiling()
*
* Dynamically set the priority ceiling of a mutex
- *
+ *
* This function locks the mutex (blocking the calling thread if
* necessary) and after it is locked it changes its priority ceiling
* to the value specified by new_ceiling, and then it unlocks the
* mutex. The previous value of the ceiling is returned in
* old_ceiling.
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
*
* FOSA_EINVAL: the value of mutex or prioceiling is invalid \n
* implementation and dependant applications
**/
int fosa_mutex_set_prioceiling
- (frsh_mutex_t *mutex, int new_ceiling, int *old_ceiling);
+ (fosa_mutex_t *mutex, int new_ceiling, int *old_ceiling);
/**
* fosa_mutex_get_prioceiling()
*
- * Dynamically get the priority ceiling of a mutex
+ * Dynamically get the priority ceiling of a mutex
*
* This function copies into the variable pointed to by ceiling the
* current priority ceiling of the mutex referenced by mutex
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
*
* FOSA_EINVAL: the value of mutex is invalid \n
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_mutex_get_prioceiling(const frsh_mutex_t *mutex, int *ceiling);
+int fosa_mutex_get_prioceiling(const fosa_mutex_t *mutex, int *ceiling);
/**
* fosa_mutex_lock()
*
* Lock a mutex
- *
+ *
* This function locks the mutex specified by mutex. If it is already
* locked, the calling thread blocks until the mutex becomes
* available. The operation returns with the mutex in the locked
* state, with the calling thread as its owner.
- *
+ *
* Returns 0 if successful; otherwise it returns an error code: \n
*
* FOSA_EINVAL: the value of mutex is invalid, or the priority of the
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_mutex_lock(frsh_mutex_t *mutex);
+int fosa_mutex_lock(fosa_mutex_t *mutex);
/**
* fosa_mutex_trylock()
* implementation is allowed to notify it to the system console and
* then terminate the FRSH implementation and dependant applications
**/
-int fosa_mutex_trylock(frsh_mutex_t *mutex);
+int fosa_mutex_trylock(fosa_mutex_t *mutex);
/**
* fosa_mutex_unlock()
*
* Unlock a mutex
- *
+ *
* This function must be called by the owner of the mutex referenced
* by mutex, to unlock it. If there are threads blocked on the mutex
* the mutex becomes available and the highest priority thread is
* awakened to acquire the mutex.
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
* FOSA_EINVAL: the value of mutex is invalid
* FOSA_EPERM: the calling thread is not the owner of the mutex
*
* Alternatively, except for FOSA_EBUSY, in case of error the
* implementation is allowed to notify it to the system console and
- * then terminate the FRSH implementation and dependant applications
+ * then terminate the FRSH implementation and dependant applications
**/
-int fosa_mutex_unlock(frsh_mutex_t *mutex);
+int fosa_mutex_unlock(fosa_mutex_t *mutex);
/**********************
* fosa_cond_init()
*
* Initiatize a condition variable
- *
+ *
* The condition variable referenced by cond is initialized with
* the attributes required by the FOSA implementation.
*
* FOSA_EAGAIN: the system lacked the necessary resources to create the
* condition variable
* FOSA_ENOMEM: Insufficient memory exists to initialize the condition variable
- * FOSA_EBUSY: The system has detected an attempt to reinitialize the
+ * FOSA_EBUSY: The system has detected an attempt to reinitialize the
* condition variable
*
* Alternatively, in case of error the implementation is allowed to
* Destroy a condition variable
*
* The condition variable pointed to by cond is destroyed
- *
+ *
* Returns 0 if successful; otherwise it returns an error code:
* FOSA_EINVAL: the value of cond is invalid
- * FOSA_EBUSY: The condition variable is in use (a thread is waiting on it)
+ * FOSA_EBUSY: The condition variable is in use (a thread is waiting on it)
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* notify it to the system console and then terminate the FRSH
* implementation and dependant applications
**/
-int fosa_cond_wait(fosa_cond_t *cond, frsh_mutex_t *mutex);
+int fosa_cond_wait(fosa_cond_t *cond, fosa_mutex_t *mutex);
/**
* fosa_cond_timedwait()
*
* Wait at a condition variable, with a timeout
- *
+ *
* This function is equal to fosa_cond_wait(), except that the maximum
* wait time is limited to the absolute time referenced by abstime, as
- * measured by the FOSA_CLOCK_REALTIME clock.
+ * measured by the FOSA_CLOCK_ABSOLUTE clock.
*
* Returns 0 if successful; otherwise it returns an error code:
* FOSA_EINVAL: the value of cond or mutex or abstime is invalid, or different
* implementation is allowed to notify it to the system console and
* then terminate the FRSH implementation and dependant applications
**/
-int fosa_cond_timedwait(fosa_cond_t *cond, frsh_mutex_t *mutex,
+int fosa_cond_timedwait(fosa_cond_t *cond, fosa_mutex_t *mutex,
const struct timespec *abstime);
-/*@}*/
-
+/*@}*/
+FOSA_CPP_END_DECLS
#endif /* !FOSA_MUTEX_AND_CONDVARS_H_ */
projects / frescor / fosa.git / blobdiff