Changeset 263fa5ef in rtems


Ignore:
Timestamp:
Apr 12, 2019, 10:37:52 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
4aed194
Parents:
08901bf
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/12/19 10:37:52)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:04)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    r08901bf r263fa5ef  
    3434 *
    3535 * @ingroup RTEMSScoreSchedulerPrioritySMP
     36 *
     37 * @brief Deterministic Priority Affinity SMP Scheduler
    3638 *
    3739 * This is an extension of the Deterministic Priority SMP Scheduler. which
     
    7678
    7779/**
    78  *  @brief Initializes per thread scheduler information
    79  *
    80  *  This routine allocates @a thread->scheduler.
    81  *
    82  *  @param[in] scheduler points to the scheduler specific information.
    83  *  @param[in] node is the node the scheduler is allocating
    84  *             management memory for.
    85  *  @param[in] the_thread the thread of the node.
    86  *  @param[in] priority is the thread priority.
     80 * @brief Initializes per thread scheduler information.
     81 *
     82 * This routine allocates @a thread->scheduler.
     83 *
     84 * @param scheduler Points to the scheduler specific information.
     85 * @param[in, out] node The node the scheduler is allocating
     86 *            management memory for.
     87 * @param the_thread The thread of the node.
     88 * @param priority The thread priority.
    8789 */
    8890void _Scheduler_priority_affinity_SMP_Node_initialize(
     
    9395);
    9496
     97/**
     98 * @brief Blocks a thread.
     99 *
     100 * @param scheduler The scheduler instance.
     101 * @param[in, out] The thread to block.
     102 * @param[in, out] node The scheduler node of the thread.
     103 */
    95104void _Scheduler_priority_affinity_SMP_Block(
    96105  const Scheduler_Control *scheduler,
     
    99108);
    100109
     110/**
     111 * @brief Unblocks a thread.
     112 *
     113 * @param scheduler The scheduler instance.
     114 * @param[in, out] The thread to unblock.
     115 * @param[in, out] node The scheduler node of the thread.
     116 */
    101117void _Scheduler_priority_affinity_SMP_Unblock(
    102118  const Scheduler_Control *scheduler,
     
    105121);
    106122
     123/**
     124 * @brief Updates the priority of the node.
     125 *
     126 * @param scheduler The scheduler instance.
     127 * @param the_thread The thread of the node.
     128 * @param[in, out] The node to update the priority of.
     129 */
    107130void _Scheduler_priority_affinity_SMP_Update_priority(
    108131  const Scheduler_Control *scheduler,
     
    111134);
    112135
     136/**
     137 * @brief Asks for help.
     138 *
     139 * @param scheduler The scheduler instance to ask for help.
     140 * @param the_thread The thread needing help.
     141 * @param node The scheduler node.
     142 *
     143 * @retval true Ask for help was successful.
     144 * @retval false Ask for help was not successful.
     145 */
    113146bool _Scheduler_priority_affinity_SMP_Ask_for_help(
    114147  const Scheduler_Control *scheduler,
     
    117150);
    118151
     152/**
     153 * @brief Reconsiders help.
     154 *
     155 * @param scheduler The scheduler instance to reconsider the help
     156 *   request.
     157 * @param the_thread The thread reconsidering a help request.
     158 * @param node The scheduler node.
     159 */
    119160void _Scheduler_priority_affinity_SMP_Reconsider_help_request(
    120161  const Scheduler_Control *scheduler,
     
    123164);
    124165
     166/**
     167 * @brief Withdraws node.
     168 *
     169 * @param scheduler The scheduler instance to withdraw the node.
     170 * @param the_thread The thread using the node.
     171 * @param node The scheduler node to withdraw.
     172 * @param next_state The next thread scheduler state in the case the node is
     173 *   scheduled.
     174 */
    125175void _Scheduler_priority_affinity_SMP_Withdraw_node(
    126176  const Scheduler_Control *scheduler,
     
    130180);
    131181
     182/**
     183 * @brief Adds @a idle to @a scheduler.
     184 *
     185 * @param[in, out] scheduler The scheduler instance to add the processor to.
     186 * @param idle The idle thread control.
     187 */
    132188void _Scheduler_priority_affinity_SMP_Add_processor(
    133189  const Scheduler_Control *scheduler,
     
    135191);
    136192
     193/**
     194 * @brief Removes an idle thread from the given cpu.
     195 *
     196 * @param scheduler The scheduler instance.
     197 * @param cpu The cpu control to remove from @a scheduler.
     198 *
     199 * @return The idle thread of the processor.
     200 */
    137201Thread_Control *_Scheduler_priority_affinity_SMP_Remove_processor(
    138202  const Scheduler_Control *scheduler,
     
    141205
    142206/**
    143  * @brief Set affinity for the priority affinity SMP scheduler.
    144  *
    145  * @param[in] scheduler The scheduler of the thread.
    146  * @param[in] thread The associated thread.
    147  * @param[in] affinity The new affinity set.
     207 * @brief Sets affinity for the priority affinity SMP scheduler.
     208 *
     209 * @param scheduler The scheduler of the thread.
     210 * @param[in, out] thread The associated thread.
     211 * @param[in, out] node The scheduler node.
     212 * @param affinity The new affinity set.
    148213 *
    149214 * @retval true if successful
Note: See TracChangeset for help on using the changeset viewer.