/**
* @file
*
* @ingroup ClassicSem
*
* @brief Classic Semaphores Implementation
*/
/* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_RTEMS_SEMIMPL_H
#define _RTEMS_RTEMS_SEMIMPL_H
#include <rtems/rtems/sem.h>
#include <rtems/score/coremuteximpl.h>
#include <rtems/score/coresemimpl.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Instantiate Semaphore Data
*
* Semaphore Manager -- Data Instantiation
*
* This constant is defined to extern most of the time when using
* this header file. However by defining it to nothing, the data
* declared in this header file can be instantiated. This is done
* in a single per manager file.
*
*/
#ifndef RTEMS_SEM_EXTERN
#define RTEMS_SEM_EXTERN extern
#endif
/**
* The following defines the information control block used to manage
* this class of objects.
*/
RTEMS_SEM_EXTERN Objects_Information _Semaphore_Information;
extern const rtems_status_code
_Semaphore_Translate_core_mutex_return_code_[];
extern const rtems_status_code
_Semaphore_Translate_core_semaphore_return_code_[];
/**
* @brief Semaphore Manager Initialization
*
* This routine performs the initialization necessary for this manager.
*/
void _Semaphore_Manager_initialization(void);
/**
* @brief Semaphore Translate Core Mutex Return Code
*
* This function returns a RTEMS status code based on the mutex
* status code specified.
*
* @param[in] the_mutex_status is the mutex status code to translate
*
* @retval translated RTEMS status code
*/
RTEMS_INLINE_ROUTINE rtems_status_code
_Semaphore_Translate_core_mutex_return_code(
uint32_t status
)
{
/*
* If this thread is blocking waiting for a result on a remote operation.
*/
#if defined(RTEMS_MULTIPROCESSING)
if ( _Thread_Is_proxy_blocking(status) )
return RTEMS_PROXY_BLOCKING;
#endif
/*
* Internal consistency check for bad status from SuperCore
*/
#if defined(RTEMS_DEBUG)
if ( status > CORE_MUTEX_STATUS_LAST )
return RTEMS_INTERNAL_ERROR;
#endif
return _Semaphore_Translate_core_mutex_return_code_[status];
}
/**
* @brief Semaphore Translate Core Semaphore Return Code
*
* This function returns a RTEMS status code based on the semaphore
* status code specified.
*
* @param[in] the_mutex_status is the semaphore status code to translate
*
* @retval translated RTEMS status code
*/
RTEMS_INLINE_ROUTINE rtems_status_code
_Semaphore_Translate_core_semaphore_return_code(
uint32_t status
)
{
#if defined(RTEMS_MULTIPROCESSING)
if ( _Thread_Is_proxy_blocking(status) )
return RTEMS_PROXY_BLOCKING;
#endif
/*
* Internal consistency check for bad status from SuperCore
*/
#if defined(RTEMS_DEBUG)
if ( status > CORE_SEMAPHORE_STATUS_LAST )
return RTEMS_INTERNAL_ERROR;
#endif
return _Semaphore_Translate_core_semaphore_return_code_[status];
}
/**
* @brief Allocates a semaphore control block from
* the inactive chain of free semaphore control blocks.
*
* This function allocates a semaphore control block from
* the inactive chain of free semaphore control blocks.
*/
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Allocate( void )
{
return (Semaphore_Control *) _Objects_Allocate( &_Semaphore_Information );
}
/**
* @brief Frees a semaphore control block to the
* inactive chain of free semaphore control blocks.
*
* This routine frees a semaphore control block to the
* inactive chain of free semaphore control blocks.
*/
RTEMS_INLINE_ROUTINE void _Semaphore_Free (
Semaphore_Control *the_semaphore
)
{
_Objects_Free( &_Semaphore_Information, &the_semaphore->Object );
}
/**
* @brief Maps semaphore IDs to semaphore control blocks.
*
* This function maps semaphore IDs to semaphore control blocks.
* If ID corresponds to a local semaphore, then it returns
* the_semaphore control pointer which maps to ID and location
* is set to OBJECTS_LOCAL. if the semaphore ID is global and
* resides on a remote node, then location is set to OBJECTS_REMOTE,
* and the_semaphore is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_semaphore is undefined.
*/
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get (
Objects_Id id,
Objects_Locations *location
)
{
return (Semaphore_Control *)
_Objects_Get( &_Semaphore_Information, id, location );
}
/**
* @brief Maps semaphore IDs to semaphore control blocks.
*
* This function maps semaphore IDs to semaphore control blocks.
* If ID corresponds to a local semaphore, then it returns
* the_semaphore control pointer which maps to ID and location
* is set to OBJECTS_LOCAL. if the semaphore ID is global and
* resides on a remote node, then location is set to OBJECTS_REMOTE,
* and the_semaphore is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_semaphore is undefined.
*/
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get_interrupt_disable (
Objects_Id id,
Objects_Locations *location,
ISR_Level *level
)
{
return (Semaphore_Control *)
_Objects_Get_isr_disable( &_Semaphore_Information, id, location, level );
}
#ifdef __cplusplus
}
#endif
#ifdef RTEMS_MULTIPROCESSING
#include <rtems/rtems/semmp.h>
#endif
#endif
/* end of include file */
