Changeset accbe67 in rtems


Ignore:
Timestamp:
Apr 5, 2019, 8:59:58 AM (7 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
0865cd2
Parents:
62128be0
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/05/19 08:59:58)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

doxygen: score: adjust doc in corebarrierimpl.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/corebarrierimpl.h

    r62128be0 raccbe67  
    11/**
    22 * @file
     3 *
     4 * @ingroup RTEMSScoreBarrier
    35 *
    46 * @brief Inlined Routines Associated with the SuperCore Barrier
     
    3032/**
    3133 * @addtogroup RTEMSScoreBarrier
    32  */
    33 /**@{**/
     34 *
     35 * @{
     36 */
    3437
    3538#define CORE_BARRIER_TQ_OPERATIONS &_Thread_queue_Operations_FIFO
    3639
    3740/**
    38  *  @brief Initialize core barrier.
     41 *  @brief Initializes the core barrier.
    3942 *
    4043 *  This routine initializes the barrier based on the parameters passed.
    4144 *
    42  *  @param[in] the_barrier is the barrier to initialize
    43  *  @param[in] the_barrier_attributes define the behavior of this instance
     45 *  @param[out] the_barrier The barrier to initialize.
     46 *  @param[out] the_barrier_attributes The attributes which define the behavior of this instance.
    4447 */
    4548void _CORE_barrier_Initialize(
     
    4851);
    4952
     53/**
     54 * @brief Destroys the core barrier.
     55 *
     56 * This routine destroys the barrier.
     57 *
     58 * @param[out] the_barrier The barrier to destroy.
     59 */
    5060RTEMS_INLINE_ROUTINE void _CORE_barrier_Destroy(
    5161  CORE_barrier_Control *the_barrier
     
    5565}
    5666
     67/**
     68 * @brief Acquires critical core barrier.
     69 *
     70 * @param[in, out] the_barrier The barrier to acquire.
     71 * @param queue_context The thread queue context.
     72 */
    5773RTEMS_INLINE_ROUTINE void _CORE_barrier_Acquire_critical(
    5874  CORE_barrier_Control *the_barrier,
     
    6379}
    6480
     81/**
     82 * @brief Releases core barrier.
     83 *
     84 * @param[in, out] the_barrier The barrier to release.
     85 * @param queue_context The thread queue context.
     86 */
    6587RTEMS_INLINE_ROUTINE void _CORE_barrier_Release(
    6688  CORE_barrier_Control *the_barrier,
     
    7294
    7395/**
    74  *  @brief Wait for the barrier.
    75  *
    76  *  This routine wait for the barrier to be released.  If the barrier
    77  *  is set to automatic and this is the appropriate thread, then it returns
    78  *  immediately.  Otherwise, the calling thread is blocked until the barrier
    79  *  is released.
    80  *
    81  *  @param[in] the_barrier is the barrier to wait for
    82  *  @param[in,out] executing The currently executing thread.
    83  *  @param[in] wait is true if the calling thread is willing to wait
     96 * @brief Waits for the barrier.
     97 *
     98 * This routine waits for the barrier to be released.  If the barrier
     99 * is set to automatic and this is the appropriate thread, then it returns
     100 * immediately.  Otherwise, the calling thread is blocked until the barrier
     101 * is released.
     102 *
     103 * @param[in, out] the_barrier The barrier to wait for.
     104 * @param[in, out] executing The currently executing thread.
     105 * @param wait This parameter is true if the calling thread is willing to wait.
     106 * @param queue_context The thread queue context.
    84107 *
    85108 * @return The method status.
     
    92115);
    93116
     117/**
     118 * @brief Flushes the barrier.
     119 *
     120 * @param[in, out] the_barrier The barrier to flush.
     121 * @param[out] filter The filter for flushing.
     122 * @param[out] queue_context The thread queue context.
     123 */
    94124uint32_t _CORE_barrier_Do_flush(
    95125  CORE_barrier_Control      *the_barrier,
     
    99129
    100130/**
    101  *  @brief Manually release the barrier.
    102  *
    103  *  This routine manually releases the barrier.  All of the threads waiting
    104  *  for the barrier will be readied.
    105  *
    106  *  @param[in] the_barrier is the barrier to surrender
    107  *  @param[in] mp_callout is the routine to invoke if the
    108  *         thread unblocked is remote
    109  *
    110  *  @retval the number of unblocked threads
     131 * @brief Manually releases the barrier.
     132 *
     133 * This routine manually releases the barrier.  All of the threads waiting
     134 * for the barrier will be readied.
     135 *
     136 * @param[in, out] the_barrier The barrier to surrender.
     137 * @param[out] queue_context The thread queue context.
     138 *
     139 * @return The number of unblocked threads.
    111140 */
    112141RTEMS_INLINE_ROUTINE uint32_t _CORE_barrier_Surrender(
     
    122151}
    123152
     153/**
     154 * @brief Flushes the barrier using _CORE_barrier_Do_flush().
     155 *
     156 * @param[in, out] the_barrier The barrier to flush.
     157 * @param queue_context The thread queue context.
     158 */
    124159RTEMS_INLINE_ROUTINE void _CORE_barrier_Flush(
    125160  CORE_barrier_Control *the_barrier,
     
    135170
    136171/**
     172 * @brief Checks if the barrier is automatic.
     173 *
    137174 * This function returns true if the automatic release attribute is
    138175 * enabled in the @a attribute_set and false otherwise.
    139176 *
    140  * @param[in] the_attribute is the attribute set to test
    141  *
    142  * @return true if the priority attribute is enabled
     177 * @param the_attribute The attribute set to test.
     178 *
     179 * @retval true The automatic release attribute is enabled.
     180 * @retval false The automatic release attribute is not enabled.
    143181 */
    144182RTEMS_INLINE_ROUTINE bool _CORE_barrier_Is_automatic(
     
    151189
    152190/**
     191 * @brief Returns the number of currently waiting threads.
     192 *
    153193 * This routine returns the number of threads currently waiting at the barrier.
    154194 *
    155  * @param[in] the_barrier is the barrier to obtain the number of blocked
    156  *            threads for
    157  * @return the current count of this barrier
     195 * @param[in] the_barrier The barrier to obtain the number of blocked
     196 *            threads of.
     197 *
     198 * @return the current count of waiting threads of this barrier.
    158199 */
    159200RTEMS_INLINE_ROUTINE uint32_t  _CORE_barrier_Get_number_of_waiting_threads(
Note: See TracChangeset for help on using the changeset viewer.