rtems/score/corebarrier.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreBarrier
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreBarrier which are used by the implementation and the
0010  *   @ref RTEMSImplApplConfig.
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 1989-2007.
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_COREBARRIER_H
0040 #define _RTEMS_SCORE_COREBARRIER_H
0041
0042 #include <rtems/score/threadq.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 /**
0049  * @defgroup RTEMSScoreBarrier Barrier Handler
0050  *
0051  * @ingroup RTEMSScore
0052  *
0053  * @brief This group contains the Barrier Handler implementation.
0054  *
0055  * This handler encapsulates functionality which provides the foundation
0056  * Barrier services used in all of the APIs supported by RTEMS.
0057  *
0058  * @{
0059  */
0060
0061 /**
0062  * @brief This control block is used to manage a barrier.
0063  */
0064 typedef struct {
0065   /**
0066    * @brief This member is used to manage the set of tasks which are
0067    *   blocked waiting for the barrier to be released.
0068    */
0069   Thread_queue_Control Wait_queue;
0070
0071   /**
0072    * @brief This member contains the current number of thread waiting at the
0073    *   barrier to be released.
0074    */
0075   uint32_t number_of_waiting_threads;
0076
0077   /**
0078    * @brief This member indicates the number of threads which must arrive at
0079    *   the barrier to trip the automatic release.
0080    *
0081    * Use ::CORE_BARRIER_MANUAL_RELEASE_MAXIMUM_COUNT to indicate a manual
0082    * release barrier.
0083    */
0084   uint32_t maximum_count;
0085 } CORE_barrier_Control;
0086
0087 /** @} */
0088
0089 #ifdef __cplusplus
0090 }
0091 #endif
0092
0093 #endif
0094 /*  end of include file */