Changeset 0b1bfab in rtems


Ignore:
Timestamp:
Apr 10, 2019, 7:12:01 AM (3 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
ae8be3f
Parents:
b817de6d
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/10/19 07:12:01)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rb817de6d r0b1bfab  
     1/**
     2 * @file
     3 *
     4 * @ingroup RTEMSScoreMRSP
     5 *
     6 * @brief Definitions for Multiprocessor Resource Sharing Protocol (MrsP) Implementation.
     7 */
     8
    19/*
    210 * Copyright (c) 2014, 2016 embedded brains GmbH.  All rights reserved.
     
    3846#define MRSP_TQ_OPERATIONS &_Thread_queue_Operations_priority_inherit
    3947
     48/**
     49 * @brief Acquires critical accordingt to MrsP.
     50 *
     51 * @param mrsp The MrsP control for the operation.
     52 * @param queue_context The thread queue context.
     53 */
    4054RTEMS_INLINE_ROUTINE void _MRSP_Acquire_critical(
    4155  MRSP_Control         *mrsp,
     
    4660}
    4761
     62/**
     63 * @brief Releases according to MrsP.
     64 *
     65 * @param mrsp The MrsP control for the operation.
     66 * @param queue_context The thread queue context.
     67 */
    4868RTEMS_INLINE_ROUTINE void _MRSP_Release(
    4969  MRSP_Control         *mrsp,
     
    5474}
    5575
     76/**
     77 * @brief Gets owner of the MrsP control.
     78 *
     79 * @param mrsp The MrsP control to get the owner from.
     80 *
     81 * @return The owner of the Mrsp control.
     82 */
    5683RTEMS_INLINE_ROUTINE Thread_Control *_MRSP_Get_owner(
    5784  const MRSP_Control *mrsp
     
    6188}
    6289
     90/**
     91 * @brief Sets owner of the MrsP control.
     92 *
     93 * @param[out] mrsp The MrsP control to set the owner of.
     94 * @param owner The desired new owner for @a mrsp.
     95 */
    6396RTEMS_INLINE_ROUTINE void _MRSP_Set_owner(
    6497  MRSP_Control   *mrsp,
     
    69102}
    70103
     104/**
     105 * @brief Gets priority of the MrsP control.
     106 *
     107 * @param mrsp The mrsp to get the priority from.
     108 * @param scheduler The corresponding scheduler.
     109 *
     110 * @return The priority of the MrsP control.
     111 */
    71112RTEMS_INLINE_ROUTINE Priority_Control _MRSP_Get_priority(
    72113  const MRSP_Control      *mrsp,
     
    80121}
    81122
     123/**
     124 * @brief Sets priority of the MrsP control
     125 *
     126 * @param[out] mrsp The MrsP control to set the priority of.
     127 * @param schedulger The corresponding scheduler.
     128 * @param new_priority The new priority for the MrsP control
     129 */
    82130RTEMS_INLINE_ROUTINE void _MRSP_Set_priority(
    83131  MRSP_Control            *mrsp,
     
    92140}
    93141
     142/**
     143 * @brief Adds the priority to the given thread.
     144 *
     145 * @param mrsp The MrsP control for the operation.
     146 * @param[in, out] thread The thread to add the priority node to.
     147 * @param[out] priority_node The priority node to initialize and add to
     148 *      the thread.
     149 * @param queue_context The thread queue context.
     150 *
     151 * @retval STATUS_SUCCESSFUL The operation succeeded.
     152 * @retval STATUS_MUTEX_CEILING_VIOLATED The wait priority of the thread
     153 *      exceeds the ceiling priority.
     154 */
    94155RTEMS_INLINE_ROUTINE Status_Control _MRSP_Raise_priority(
    95156  MRSP_Control         *mrsp,
     
    127188}
    128189
     190/**
     191 * @brief Removes the priority from the given thread.
     192 *
     193 * @param[in, out] The thread to remove the priority from.
     194 * @param priority_node The priority node to remove from the thread
     195 * @param queue_context The thread queue context.
     196 */
    129197RTEMS_INLINE_ROUTINE void _MRSP_Remove_priority(
    130198  Thread_Control       *thread,
     
    141209}
    142210
     211/**
     212 * @brief Replaces the given priority node with the ceiling priority of
     213 *      the MrsP control.
     214 *
     215 * @param mrsp The mrsp control for the operation.
     216 * @param[out] thread The thread to replace the priorities.
     217 * @param ceiling_priority The node to be replaced.
     218 */
    143219RTEMS_INLINE_ROUTINE void _MRSP_Replace_priority(
    144220  MRSP_Control   *mrsp,
     
    158234}
    159235
     236/**
     237 * @brief Claims ownership of the MrsP control.
     238 *
     239 * @param mrsp The MrsP control to claim the ownership of.
     240 * @param[in, out] executing The currently executing thread.
     241 * @param queue_context The thread queue context.
     242 *
     243 * @retval STATUS_SUCCESSFUL The operation succeeded.
     244 * @retval STATUS_MUTEX_CEILING_VIOLATED The wait priority of the executing
     245 *      thread exceeds the ceiling priority.
     246 */
    160247RTEMS_INLINE_ROUTINE Status_Control _MRSP_Claim_ownership(
    161248  MRSP_Control         *mrsp,
     
    187274}
    188275
     276/**
     277 * @brief Initializes a MrsP control.
     278 *
     279 * @param[out] mrsp The MrsP control that is initialized.
     280 * @param scheduler The scheduler for the operation.
     281 * @param ceiling_priority
     282 * @param executing The currently executing thread.  Ignored in this method.
     283 * @param initially_locked Indicates whether the MrsP control shall be initally
     284 *      locked. If it is initially locked, this method returns STATUS_INVALID_NUMBER.
     285 *
     286 * @retval STATUS_SUCCESSFUL The operation succeeded.
     287 * @retval STATUS_INVALID_NUMBER The MrsP control is initially locked.
     288 * @retval STATUS_NO_MEMORY There is not enough memory to allocate.
     289 */
    189290RTEMS_INLINE_ROUTINE Status_Control _MRSP_Initialize(
    190291  MRSP_Control            *mrsp,
     
    226327}
    227328
     329/**
     330 * @brief Waits for the ownership of the MrsP control.
     331 *
     332 * @param[in, out] mrsp The MrsP control to get the ownership of.
     333 * @param[in, out] executing The currently executing thread.
     334 * @param queue_context the thread queue context.
     335 *
     336 * @retval STATUS_SUCCESSFUL The operation succeeded.
     337 * @retval STATUS_MUTEX_CEILING_VIOLATED The wait priority of the
     338 *      currently executing thread exceeds the ceiling priority.
     339 * @retval STATUS_DEADLOCK A deadlock occured.
     340 * @retval STATUS_TIMEOUT A timeout occured.
     341 */
    228342RTEMS_INLINE_ROUTINE Status_Control _MRSP_Wait_for_ownership(
    229343  MRSP_Control         *mrsp,
     
    284398}
    285399
     400/**
     401 * @brief Seizes the MrsP control.
     402 *
     403 * @param[in, out] mrsp The MrsP control to seize the control of.
     404 * @param[in, out] executing The currently executing thread.
     405 * @param wait Indicates whether the calling thread is willing to wait.
     406 * @param queue_context The thread queue context.
     407 *
     408 * @retval STATUS_SUCCESSFUL The operation succeeded.
     409 * @retval STATUS_MUTEX_CEILING_VIOLATED The wait priority of the executing
     410 *      thread exceeds the ceiling priority.
     411 * @retval STATUS_UNAVAILABLE The executing thread is already the owner of
     412 *      the MrsP control.  Seizing it is not possible.
     413 */
    286414RTEMS_INLINE_ROUTINE Status_Control _MRSP_Seize(
    287415  MRSP_Control         *mrsp,
     
    313441}
    314442
     443/**
     444 * @brief Surrenders the MrsP control.
     445 *
     446 * @param[in, out] mrsp The MrsP control to surrender the control of.
     447 * @param[in, out] executing The currently executing thread.
     448 * @param queue_context The thread queue context.
     449 *
     450 * @retval STATUS_SUCCESSFUL The operation succeeded.
     451 * @retval STATUS_NOT_OWNER The executing thread does not own the MrsP control.
     452 */
    315453RTEMS_INLINE_ROUTINE Status_Control _MRSP_Surrender(
    316454  MRSP_Control         *mrsp,
     
    355493}
    356494
     495/**
     496 * @brief Checks if the MrsP control can be destroyed.
     497 *
     498 * @param mrsp The MrsP control for the operation.
     499 *
     500 * @retval STATUS_SUCCESSFUL The MrsP is currently not used
     501 *      and can be destroyed.
     502 * @retval STATUS_RESOURCE_IN_USE The MrsP control is in use,
     503 *      it cannot be destroyed.
     504 */
    357505RTEMS_INLINE_ROUTINE Status_Control _MRSP_Can_destroy( MRSP_Control *mrsp )
    358506{
     
    364512}
    365513
     514/**
     515 * @brief Destroys the MrsP control
     516 *
     517 * @param[in, out] The mrsp that is about to be destroyed.
     518 * @param queue_context The thread queue context.
     519 */
    366520RTEMS_INLINE_ROUTINE void _MRSP_Destroy(
    367521  MRSP_Control         *mrsp,
Note: See TracChangeset for help on using the changeset viewer.