rtems/score/prioritybitmap.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScorePriorityBitmap
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScorePriorityBitmap which are used by the implementation and the
0010  *   @ref RTEMSImplApplConfig.
0011  */
0012
0013 /*
0014  *  COPYRIGHT (c) 1989-2010.
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_PRIORITYBITMAP_H
0040 #define _RTEMS_SCORE_PRIORITYBITMAP_H
0041
0042 #include <rtems/score/cpu.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 /**
0049  * @defgroup RTEMSScorePriorityBitmap Priority Bitmap
0050  *
0051  * @brief This group contains the implementation to support priority bitmaps.
0052  *
0053  * @ingroup RTEMSScore
0054  *
0055  * @{
0056  */
0057
0058 typedef uint16_t Priority_bit_map_Word;
0059
0060 typedef struct {
0061   /**
0062    * @brief Each sixteen bit entry in this word is associated with one of the
0063    * sixteen entries in the bit map.
0064    */
0065   Priority_bit_map_Word major_bit_map;
0066
0067   /**
0068    * @brief Each bit in the bit map indicates whether or not there are threads
0069    * ready at a particular priority.
0070    *
0071    * The mapping of individual priority levels to particular bits is processor
0072    * dependent as is the value of each bit used to indicate that threads are
0073    * ready at that priority.
0074    */
0075   Priority_bit_map_Word bit_map[ 16 ];
0076 } Priority_bit_map_Control;
0077
0078 /**
0079  *  The following record defines the information associated with
0080  *  each thread to manage its interaction with the priority bit maps.
0081  */
0082 typedef struct {
0083   /** This is the address of minor bit map slot. */
0084   Priority_bit_map_Word *minor;
0085   /** This is the priority bit map ready mask. */
0086   Priority_bit_map_Word  ready_major;
0087   /** This is the priority bit map ready mask. */
0088   Priority_bit_map_Word  ready_minor;
0089   /** This is the priority bit map block mask. */
0090   Priority_bit_map_Word  block_major;
0091   /** This is the priority bit map block mask. */
0092   Priority_bit_map_Word  block_minor;
0093 } Priority_bit_map_Information;
0094
0095 /** @} */
0096
0097 #ifdef __cplusplus
0098 }
0099 #endif
0100
0101 #endif
0102 /* end of include file */