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

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

Update #3706.

File:
1 edited

Legend:

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

    rd369903 r86b05bf6  
    3232/**
    3333 * @addtogroup RTEMSScoreMutex
    34  */
    35 /**@{**/
     34 *
     35 * @{
     36 */
    3637
    3738#define CORE_MUTEX_TQ_OPERATIONS &_Thread_queue_Operations_priority
     
    4041  &_Thread_queue_Operations_priority_inherit
    4142
     43/**
     44 * @brief Initializes the mutex.
     45 *
     46 * @param[out] the_mutex The mutex to initialize.
     47 */
    4248RTEMS_INLINE_ROUTINE void _CORE_mutex_Initialize(
    4349  CORE_mutex_Control *the_mutex
     
    4753}
    4854
     55/**
     56 * @brief Destroys the mutex.
     57 *
     58 * @param[out] the_mutex the mutex to destroy.
     59 */
    4960RTEMS_INLINE_ROUTINE void _CORE_mutex_Destroy( CORE_mutex_Control *the_mutex )
    5061{
     
    5263}
    5364
     65/**
     66 * @brief Acquires the mutex critical.
     67 *
     68 * @param[in, out] the_mutex The mutex to acquire critical.
     69 * @param queue_context The queue context.
     70 */
    5471RTEMS_INLINE_ROUTINE void _CORE_mutex_Acquire_critical(
    5572  CORE_mutex_Control   *the_mutex,
     
    6077}
    6178
     79/**
     80 * @brief Releases the mutex.
     81 *
     82 * @param[in, out] the_mutex The mutex to release.
     83 * @param queue_context The queue context.
     84 */
    6285RTEMS_INLINE_ROUTINE void _CORE_mutex_Release(
    6386  CORE_mutex_Control   *the_mutex,
     
    6891}
    6992
     93/**
     94 * @brief Gets the owner of the mutex.
     95 *
     96 * @param the_mutex The mutex to get the owner from.
     97 *
     98 * @return The owner of the mutex.
     99 */
    70100RTEMS_INLINE_ROUTINE Thread_Control *_CORE_mutex_Get_owner(
    71101  const CORE_mutex_Control *the_mutex
     
    76106
    77107/**
    78  * @brief Is mutex locked.
    79  *
    80  * This routine returns true if the mutex specified is locked and false
     108 * @brief Checks if the mutex is locked.
     109 *
     110 * This routine returns true if the specified mutex is locked and false
    81111 * otherwise.
    82112 *
    83  * @param[in] the_mutex is the mutex to check.
     113 * @param the_mutex The mutex to check if it is locked.
    84114 *
    85115 * @retval true The mutex is locked.
     
    93123}
    94124
     125/**
     126 * @brief Seize the mutex slowly.
     127 *
     128 * @param[in, out] the_mutex The mutex to seize.
     129 * @param operations The thread queue operations.
     130 * @param executing The calling thread.
     131 * @param wait Indicates whether the calling thread is willing to wait.
     132 * @param queue_context The thread queue context.
     133 *
     134 * @retval _Thread_Wait_get_status The status of the executing thread.
     135 * @retval STATUS_UNAVAILABLE The calling thread is not willing to wait.
     136 */
    95137Status_Control _CORE_mutex_Seize_slow(
    96138  CORE_mutex_Control            *the_mutex,
     
    101143);
    102144
     145/**
     146 * @brief Sets the owner of the mutex.
     147 *
     148 * @param[out] the_mutex The mutex to set the owner from.
     149 * @param owner The new owner of the mutex.
     150 */
    103151RTEMS_INLINE_ROUTINE void _CORE_mutex_Set_owner(
    104152  CORE_mutex_Control *the_mutex,
     
    109157}
    110158
     159/**
     160 * @brief Checks if the the thread is the owner of the mutex.
     161 *
     162 * @param the_mutex The mutex to check the owner of.
     163 * @param the_thread The thread to check if it is the owner of @a the_mutex.
     164 *
     165 * @retval true @a the_thread is the owner of @a the_mutex.
     166 * @retval false @a the_thread is not the owner of @a the_mutex.
     167 */
    111168RTEMS_INLINE_ROUTINE bool _CORE_mutex_Is_owner(
    112169  const CORE_mutex_Control *the_mutex,
     
    117174}
    118175
     176/**
     177 * @brief Initializes a recursive mutex.
     178 *
     179 * @param[out] the_mutex The recursive mutex to initialize.
     180 */
    119181RTEMS_INLINE_ROUTINE void _CORE_recursive_mutex_Initialize(
    120182  CORE_recursive_mutex_Control *the_mutex
     
    125187}
    126188
     189/**
     190 * @brief Seizes the recursive mutex nested.
     191 *
     192 * @param[out] the_mutex The recursive mutex to seize nested.
     193 *
     194 * @return STATUS_SUCCESSFUL, this method is always successful.
     195 */
    127196RTEMS_INLINE_ROUTINE Status_Control _CORE_recursive_mutex_Seize_nested(
    128197  CORE_recursive_mutex_Control *the_mutex
     
    133202}
    134203
     204/**
     205 * @brief Seizes the recursive mutex.
     206 *
     207 * @param[in, out] the_mutex The recursive mutex to seize.
     208 * @param operations The thread queue operations.
     209 * @param[out] executing The executing thread.
     210 * @param wait Indicates whether the calling thread is willing to wait.
     211 * @param nested Returns the status of a recursive mutex.
     212 * @param queue_context The thread queue context.
     213 *
     214 * @retval STATUS_SUCCESSFUL The owner of the mutex was NULL, successful
     215 *      seizing of the mutex.
     216 * @retval _Thread_Wait_get_status The status of the executing thread.
     217 * @retval STATUS_UNAVAILABLE The calling thread is not willing to wait.
     218 */
    135219RTEMS_INLINE_ROUTINE Status_Control _CORE_recursive_mutex_Seize(
    136220  CORE_recursive_mutex_Control  *the_mutex,
     
    172256}
    173257
     258/**
     259 * @brief Surrenders the recursive mutex.
     260 *
     261 * @param[in, out] the_mutex The recursive mutex to surrender.
     262 * @param operations The thread queue operations.
     263 * @param executing The executing thread.
     264 * @param queue_context the thread queue context.
     265 *
     266 * @retval STATUS_SUCCESSFUL @a the_mutex is successfully surrendered.
     267 * @retval STATUS_NOT_OWNER The executing thread does not own @a the_mutex.
     268 */
    174269RTEMS_INLINE_ROUTINE Status_Control _CORE_recursive_mutex_Surrender(
    175270  CORE_recursive_mutex_Control  *the_mutex,
     
    217312}
    218313
     314/**
     315 * @brief initializes a ceiling mutex.
     316 *
     317 * @param[out] the_mutex The ceiling mutex to initialize.
     318 * @param scheduler The scheduler for the new ceiling mutex.
     319 *      Only needed if RTEMS_SMP is defined
     320 * @param priority_ceiling The priority ceiling for the initialized mutex.
     321 */
    219322RTEMS_INLINE_ROUTINE void _CORE_ceiling_mutex_Initialize(
    220323  CORE_ceiling_mutex_Control *the_mutex,
     
    230333}
    231334
     335/**
     336 * @brief Gets the scheduler of the ceiling mutex.
     337 *
     338 * @param the_mutex The ceiling mutex to get the scheduler from.
     339 *
     340 * @return The scheduler of the mutex. If RTEMS_SMP is not defined, the first entry of the _Scheduler_Table is returned.
     341 */
    232342RTEMS_INLINE_ROUTINE const Scheduler_Control *
    233343_CORE_ceiling_mutex_Get_scheduler(
     
    242352}
    243353
     354/**
     355 * @brief Sets the priority of the ceiling mutex.
     356 *
     357 * @param[out] the_mutex The ceiling mutex to set the priority of.
     358 * @param priority_ceiling The new priority ceiling of the mutex.
     359 * @param queue_context The thread queue context.
     360 */
    244361RTEMS_INLINE_ROUTINE void _CORE_ceiling_mutex_Set_priority(
    245362  CORE_ceiling_mutex_Control *the_mutex,
     
    267384}
    268385
     386/**
     387 * @brief Gets the priority of the ceiling mutex.
     388 *
     389 * @param the_mutex The mutex to get the priority from.
     390 *
     391 * @return The priority ceiling of @a the_mutex.
     392 */
    269393RTEMS_INLINE_ROUTINE Priority_Control _CORE_ceiling_mutex_Get_priority(
    270394  const CORE_ceiling_mutex_Control *the_mutex
     
    274398}
    275399
     400/**
     401 * @brief Sets the owner of the ceiling mutex.
     402 *
     403 * @param[in, out] the_mutex The mutex to set the owner of.
     404 * @param owner The new owner of @a the_mutex.
     405 * @param queue_context The thread queue context.
     406 *
     407 * @retval STATUS_SUCCESSFUL The owner of the mutex was changed successfully.
     408 * @retval STATUS_MUTEX_CEILING_VIOLATED The owners wait priority
     409 *          is smaller than the priority of the ceiling mutex.
     410 */
    276411RTEMS_INLINE_ROUTINE Status_Control _CORE_ceiling_mutex_Set_owner(
    277412  CORE_ceiling_mutex_Control *the_mutex,
     
    313448}
    314449
     450/**
     451 * @brief Seizes the ceiling mutex.
     452 *
     453 * @param[in, out] the_mutex The mutex to seize.
     454 * @param executing The executing thread.
     455 * @param wait Indicates whether the calling thread is willing to wait.
     456 * @param nested Function that returns the status of the recursive mutex
     457 * @param queue_context The thread queue context.
     458 *
     459 * @retval STATUS_SUCCESSFUL The owner of the mutex was changed successfully.
     460 * @retval STATUS_NOT_DEFINED If the scheduler of the executing thread is not equal to the owner of @a the_mutex .
     461 * @retval STATUS_MUTEX_CEILING_VIOLATED The owners wait priority
     462 *          is smaller than the priority of the ceiling mutex.
     463 * @retval other Return value of @a nested.
     464 */
    315465RTEMS_INLINE_ROUTINE Status_Control _CORE_ceiling_mutex_Seize(
    316466  CORE_ceiling_mutex_Control    *the_mutex,
     
    363513}
    364514
     515/**
     516 * @brief Surrenders the ceiling mutex.
     517 *
     518 * @param[in, out] the_mutex The ceiling mutex to surrender.
     519 * @param executing The executing thread.
     520 * @param queue_context The thread queue context.
     521 *
     522 * @retval STATUS_SUCCESSFUL The ceiling mutex was successfullysurrendered.
     523 * @retval STATUS_NOT_OWNER The executing thread is not the owner of @a the_mutex.
     524 */
    365525RTEMS_INLINE_ROUTINE Status_Control _CORE_ceiling_mutex_Surrender(
    366526  CORE_ceiling_mutex_Control *the_mutex,
Note: See TracChangeset for help on using the changeset viewer.