blob: fff4969fd2eacfbe783854c0f936c78d83b21672 (
plain) (
tree)
|
|
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*
* $Id$
*/
/**
* @file
*
* @ingroup rtems-rfs
*
* RTEMS File System Mutex.
*
* It may be suprising we abstract this for the RTEMS file system but this code
* is designed to be run on host operating systems.
*/
#if !defined (_RTEMS_RFS_MUTEX_H_)
#define _RTEMS_RFS_MUTEX_H_
#include <errno.h>
#include <rtems/rfs/rtems-rfs-trace.h>
#if __rtems__
#include <rtems.h>
#include <rtems/error.h>
#endif
/**
* RFS Mutex type.
*/
#if __rtems__
typedef rtems_id rtems_rfs_mutex;
#else
typedef uint32_t rtems_rfs_mutex; /* place holder */
#endif
/**
* Create the mutex.
*
* @param mutex Reference to the mutex handle returned to the caller.
* @return int The error number (errno). No error if 0.
*/
int rtems_rfs_mutex_create (rtems_rfs_mutex* mutex);
/**
* Create the mutex.
*
* @param mutex Reference to the mutex handle returned to the caller.
* @return int The error number (errno). No error if 0.
*/
int rtems_rfs_mutex_destroy (rtems_rfs_mutex* mutex);
/**
* Lock the mutex.
*
* @param mutex The mutex to lock.
* @retval true The mutex is locked.
* @retval false The mutex could not be locked.
*/
static inline int
rtems_rfs_mutex_lock (rtems_rfs_mutex* mutex)
{
#if __rtems__
rtems_status_code sc = rtems_semaphore_obtain (*mutex, RTEMS_WAIT, 0);
if (sc != RTEMS_SUCCESSFUL)
{
#if RTEMS_RFS_TRACE
if (rtems_rfs_trace (RTEMS_RFS_TRACE_MUTEX))
printf ("rtems-rfs: mutex: obtain failed: %s\n",
rtems_status_text (sc));
#endif
return EIO;
}
#endif
return 0;
}
/**
* Unlock the mutex.
*
* @param mutex The mutex to unlock.
* @retval true The mutex is unlocked.
* @retval false The mutex could not be unlocked.
*/
static inline int
rtems_rfs_mutex_unlock (rtems_rfs_mutex* mutex)
{
#if __rtems__
rtems_status_code sc = rtems_semaphore_release (*mutex);
if (sc != RTEMS_SUCCESSFUL)
{
#if RTEMS_RFS_TRACE
if (rtems_rfs_trace (RTEMS_RFS_TRACE_MUTEX))
printf ("rtems-rfs: mutex: release failed: %s\n",
rtems_status_text (sc));
#endif
return EIO;
}
#endif
return 0;
}
#endif
|