rtems/score/coremutex.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreMutex
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreMutex which are used by the implementation and the
0010  *   @ref RTEMSImplApplConfig.
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 1989-2011.
0015  *  On-Line Applications Research Corporation (OAR).
0016  *
0017  * Redistribution and use in source and binary forms, with or without
0018  * modification, are permitted provided that the following conditions
0019  * are met:
0020  * 1. Redistributions of source code must retain the above copyright
0021  *    notice, this list of conditions and the following disclaimer.
0022  * 2. Redistributions in binary form must reproduce the above copyright
0023  *    notice, this list of conditions and the following disclaimer in the
0024  *    documentation and/or other materials provided with the distribution.
0025  *
0026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0036  * POSSIBILITY OF SUCH DAMAGE.
0037  */
0038
0039 #ifndef _RTEMS_SCORE_COREMUTEX_H
0040 #define _RTEMS_SCORE_COREMUTEX_H
0041
0042 #include <rtems/score/thread.h>
0043 #include <rtems/score/threadq.h>
0044 #include <rtems/score/priority.h>
0045 #include <rtems/score/watchdog.h>
0046 #include <rtems/score/interr.h>
0047
0048 struct _Scheduler_Control;
0049
0050 #ifdef __cplusplus
0051 extern "C" {
0052 #endif
0053
0054 /**
0055  * @defgroup RTEMSScoreMutex Mutex Handler
0056  *
0057  * @ingroup RTEMSScore
0058  *
0059  * @brief This group contains the Mutex Handler implementation.
0060  *
0061  * This handler encapsulates functionality which provides the foundation
0062  * Mutex services used in all of the APIs supported by RTEMS.  A mutex is an
0063  * enhanced version of the standard Dijkstra binary semaphore used to provide
0064  * synchronization and mutual exclusion capabilities.
0065  *
0066  * @{
0067  */
0068
0069 /**
0070  *  @brief Control block used to manage each mutex.
0071  *
0072  *  The following defines the control block used to manage each mutex.
0073  */
0074 typedef struct {
0075   /**
0076    * @brief The thread queue of this mutex.
0077    *
0078    * The owner of the thread queue indicates the mutex owner.
0079    */
0080   Thread_queue_Control Wait_queue;
0081 } CORE_mutex_Control;
0082
0083 /**
0084  * @brief The recursive mutex control.
0085  */
0086 typedef struct {
0087   /**
0088    * @brief The plain non-recursive mutex.
0089    */
0090   CORE_mutex_Control Mutex;
0091
0092   /**
0093    * @brief The nest level in case of a recursive seize.
0094    */
0095   unsigned int nest_level;
0096 } CORE_recursive_mutex_Control;
0097
0098 /**
0099  * @brief The recursive mutex control with priority ceiling protocol support.
0100  */
0101 typedef struct {
0102   /**
0103    * @brief The plain recursive mutex.
0104    */
0105   CORE_recursive_mutex_Control Recursive;
0106
0107   /**
0108    * @brief The priority ceiling node for the mutex owner.
0109    */
0110   Priority_Node Priority_ceiling;
0111
0112 #if defined(RTEMS_SMP)
0113   /**
0114    * @brief The scheduler instance for this priority ceiling mutex.
0115    */
0116   const struct _Scheduler_Control *scheduler;
0117 #endif
0118 } CORE_ceiling_mutex_Control;
0119
0120 /** @} */
0121
0122 #ifdef __cplusplus
0123 }
0124 #endif
0125
0126 #endif
0127 /*  end of include file */