Changeset b6bbe83 in rtems


Ignore:
Timestamp:
Apr 17, 2019, 3:35:43 PM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
843879d0
Parents:
f1507fb
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/17/19 15:35:43)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    rf1507fb rb6bbe83  
    11/**
    2  *  @file
    3  *
    4  *  Constants and Structures Associated with the Manipulation of Objects
    5  *
    6  *  This include file contains all the constants and structures associated
    7  *  with the manipulation of objects.
     2 * @file
     3 *
     4 * @ingroup RTEMSScoreThreadQueue
     5 *
     6 * @brief Constants and Structures Associated with the Manipulation of Objects
     7 *
     8 * This include file contains all the constants and structures associated
     9 * with the manipulation of objects.
    810 */
    911
     
    3941/**
    4042 *  @addtogroup RTEMSScoreThreadQueue
    41  */
    42 /**@{*/
     43 *
     44 * @{
     45 */
    4346
    4447#define THREAD_QUEUE_LINK_OF_PATH_NODE( node ) \
     
    6366} Thread_queue_Syslock_queue;
    6467
     68/**
     69 * @brief Does nothing.
     70 *
     71 * @param queue This parameter is unused.
     72 * @param the_thread This parameter is unused.
     73 * @param cpu_self This parameter is unused.
     74 * @param queue_context This parameter is unused.
     75 */
    6576void _Thread_queue_Enqueue_do_nothing_extra(
    6677  Thread_queue_Queue   *queue,
     
    7081);
    7182
     83/**
     84 * @brief Adds timeout ticks of the queue to the thread.
     85 *
     86 * @param queue This parameter is unused.
     87 * @param[in, out] the_thread The thread to add timeout ticks to.
     88 * @param cpu_self The cpu for the operation.
     89 * @param queue_context The thread queue context.
     90 */
    7291void _Thread_queue_Add_timeout_ticks(
    7392  Thread_queue_Queue   *queue,
     
    7796);
    7897
     98/**
     99 * @brief Adds a monotonic timespec to the thread and sets the watchdog header
     100 *      to monotonic.
     101 *
     102 * @param queue This parameter is unused.
     103 * @param[in, out] the_thread The thread to add the timeout and set watchdog header to
     104 *      monotonic.
     105 * @param cpu_self The cpu to get the monotonic watchdog header from.
     106 * @param queue_context The thread queue context.
     107 */
    79108void _Thread_queue_Add_timeout_monotonic_timespec(
    80109  Thread_queue_Queue   *queue,
     
    84113);
    85114
     115/**
     116 * @brief Adds a monotonic timespec to the thread and sets the watchdog header
     117 *      to realtime.
     118 *
     119 * @param queue This parameter is unused.
     120 * @param[in, out] the_thread The thread to add the timeout and set watchdog header to
     121 *      realtime.
     122 * @param cpu_self The cpu to get the realtime watchdog header from.
     123 * @param queue_context The thread queue context.
     124 */
    86125void _Thread_queue_Add_timeout_realtime_timespec(
    87126  Thread_queue_Queue   *queue,
     
    93132/**
    94133 * @brief Sets the thread wait return code to STATUS_DEADLOCK.
     134 *
     135 * @param[out] the_thread The thread to set the wait return code to
     136 *      STATUS_DEADLOCK.
    95137 */
    96138void _Thread_queue_Deadlock_status( Thread_Control *the_thread );
     
    98140/**
    99141 * @brief Results in an INTERNAL_ERROR_THREAD_QUEUE_DEADLOCK fatal error.
     142 *
     143 * @param the_thread The thread for the operation.
    100144 */
    101145void _Thread_queue_Deadlock_fatal( Thread_Control *the_thread );
     
    104148 * @brief Initializes a thread queue context.
    105149 *
    106  * @param queue_context The thread queue context to initialize.
     150 * @param[out] queue_context The thread queue context to initialize.
    107151 */
    108152RTEMS_INLINE_ROUTINE void _Thread_queue_Context_initialize(
     
    126170 * context.
    127171 *
    128  * @param queue_context The thread queue context.
     172 * @param[out] queue_context The thread queue context.
    129173 * @param state The thread state.
    130174 *
     
    143187 * @brief Sets the timeout ticks in the thread queue context.
    144188 *
    145  * @param queue_context The thread queue context.
     189 * @param[out] queue_context The thread queue context.
    146190 * @param ticks The timeout in ticks.
    147191 *
     
    160204 * @brief Sets the timeout argument in the thread queue context.
    161205 *
    162  * @param queue_context The thread queue context.
     206 * @param[out] queue_context The thread queue context.
    163207 * @param arg The timeout argument.
    164208 *
     
    177221 * @brief Sets the enqueue callout in the thread queue context.
    178222 *
    179  * @param queue_context The thread queue context.
     223 * @param[out] queue_context The thread queue context.
    180224 * @param enqueue_callout The enqueue callout.
    181225 *
     
    194238 * @brief Sets the do nothing enqueue callout in the thread queue context.
    195239 *
    196  * @param queue_context The thread queue context.
     240 * @param[out] queue_context The thread queue context.
    197241 *
    198242 * @see _Thread_queue_Enqueue().
     
    210254 * ticks.
    211255 *
    212  * @param queue_context The thread queue context.
     256 * @param[out] queue_context The thread queue context.
    213257 * @param ticks The timeout in ticks.
    214258 *
     
    229273 * timespec format.
    230274 *
    231  * @param queue_context The thread queue context.
     275 * @param[out] queue_context The thread queue context.
    232276 * @param abstime The absolute monotonic timeout.
    233277 *
     
    249293 * timespec format.
    250294 *
    251  * @param queue_context The thread queue context.
     295 * @param[out] queue_context The thread queue context.
    252296 * @param abstime The absolute realtime timeout.
    253297 *
     
    273317 * and _Thread_queue_Deadlock_fatal().
    274318 *
    275  * @param queue_context The thread queue context.
     319 * @param[out] queue_context The thread queue context.
    276320 * @param deadlock_callout The deadlock callout.
    277321 *
     
    286330}
    287331
     332/**
     333 * @brief Clears the priority update count of the thread queue context.
     334 *
     335 * @param[out] queue_context The thread queue context to clear the priority
     336 * update count.
     337 */
    288338RTEMS_INLINE_ROUTINE void _Thread_queue_Context_clear_priority_updates(
    289339  Thread_queue_Context *queue_context
     
    293343}
    294344
     345/**
     346 * @brief Returns the priority update count of the thread queue context.
     347 *
     348 * @param queue_context The thread queue context to get the priority update
     349 *      count of.
     350 *
     351 * @return The priority update count of @a queue_context.
     352 */
    295353RTEMS_INLINE_ROUTINE size_t _Thread_queue_Context_save_priority_updates(
    296354  Thread_queue_Context *queue_context
     
    300358}
    301359
     360/**
     361 * @brief Sets the priority update count of the thread queue context.
     362 *
     363 * @param[out] queue_context The thread queue context to set the priority
     364 *      update count of.
     365 * @param update_count The priority update count.
     366 */
    302367RTEMS_INLINE_ROUTINE void _Thread_queue_Context_restore_priority_updates(
    303368  Thread_queue_Context *queue_context,
     
    308373}
    309374
     375/**
     376 * @brief Adds a priority update of the thread to the thread queue context.
     377 *
     378 * @param[in, out] queue_context The thread queue context to increase the
     379 *      priority update count of and set the_thread in its Priority update
     380 *      array.
     381 * @param the_thread The thread for the priority update.
     382 */
    310383RTEMS_INLINE_ROUTINE void _Thread_queue_Context_add_priority_update(
    311384  Thread_queue_Context *queue_context,
     
    330403  } while ( 0 )
    331404
     405/**
     406 * @brief Sets the thread queue context ISR level.
     407 *
     408 * @param[out] queue_context The thread queue context to set the ISR level of.
     409 * @param level The ISR level to set @a queue_context to.
     410 */
    332411RTEMS_INLINE_ROUTINE void _Thread_queue_Context_set_ISR_level(
    333412  Thread_queue_Context *queue_context,
     
    341420}
    342421
     422/**
     423 * @brief Disables dispatching in a critical section.
     424 *
     425 * @param queue_context The thread queue context to get the lock context from.
     426 *
     427 * @return The current processor.
     428 */
    343429RTEMS_INLINE_ROUTINE Per_CPU_Control *_Thread_queue_Dispatch_disable(
    344430  Thread_queue_Context *queue_context
     
    353439 * @brief Sets the MP callout in the thread queue context.
    354440 *
    355  * @param queue_context The thread queue context.
     441 * @param[out] queue_context The thread queue context.
    356442 * @param mp_callout Callout to unblock the thread in case it is actually a
    357443 *   thread proxy.  This parameter is only used on multiprocessing
     
    375461
    376462#if defined(RTEMS_SMP)
     463/**
     464 * @brief Closes the gate.
     465 *
     466 * @param[out] gate The gate to close.
     467 */
    377468RTEMS_INLINE_ROUTINE void _Thread_queue_Gate_close(
    378469  Thread_queue_Gate *gate
     
    382473}
    383474
     475/**
     476 * @brief Adds the gate to the chain.
     477 *
     478 * @param[in, out] chain The chain to add the gate to.
     479 * @param gate The gate to add to the chain.
     480 */
    384481RTEMS_INLINE_ROUTINE void _Thread_queue_Gate_add(
    385482  Chain_Control     *chain,
     
    390487}
    391488
     489/**
     490 * @brief Opens the gate.
     491 *
     492 * @param[out] gate The gate to open.
     493 */
    392494RTEMS_INLINE_ROUTINE void _Thread_queue_Gate_open(
    393495  Thread_queue_Gate *gate
     
    397499}
    398500
     501/**
     502 * @brief Waits on a gate to open.
     503 *
     504 * Performs busy waiting.
     505 *
     506 * @param gate The gate to wait for.
     507 */
    399508RTEMS_INLINE_ROUTINE void _Thread_queue_Gate_wait(
    400509  Thread_queue_Gate *gate
     
    407516#endif
    408517
     518/**
     519 * @brief Initializes the thread queue heads.
     520 *
     521 * @param[out] heads The thread queue heads to initialize.
     522 */
    409523RTEMS_INLINE_ROUTINE void _Thread_queue_Heads_initialize(
    410524  Thread_queue_Heads *heads
     
    425539}
    426540
     541/**
     542 * @brief Initializes the thread queue queue with the given name.
     543 *
     544 * @param[out] queue The thread queue queue to initialize.
     545 * @param name The name for the @a queue.
     546 */
    427547RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_initialize(
    428548  Thread_queue_Queue *queue,
     
    438558}
    439559
     560/**
     561 * @brief Acquires the thread queue queue in a critical section.
     562 *
     563 * @param queue The thread queue queue to acquire in a critical section.
     564 * @param lock_stats The lock statistics.
     565 * @param[out] lock_context The interrupt lock context.
     566 */
    440567RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_do_acquire_critical(
    441568  Thread_queue_Queue *queue,
     
    468595#endif
    469596
     597/**
     598 * @brief Releases the thread queue queue in a critical section.
     599 *
     600 * @param queue The thread queue queue to release in a critical section.
     601 * @param[out] lock_context The interrupt lock context.
     602 */
    470603RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_release_critical(
    471604  Thread_queue_Queue *queue,
     
    484617}
    485618
     619/**
     620 * @brief Releases the thread queue queue and enables interrupts.
     621 *
     622 * @param queue The thread queue queue to release.
     623 * @param[out] lock_context The interrupt lock context to enable interrupts.
     624 */
    486625RTEMS_INLINE_ROUTINE void _Thread_queue_Queue_release(
    487626  Thread_queue_Queue *queue,
     
    496635 * @brief Copies the thread queue name to the specified buffer.
    497636 *
    498  * @param[in] queue The actual thread queue.
    499  * @param[in] buffer The buffer for the thread queue name copy.
    500  * @param[in] buffer_size The buffer size in characters.
    501  * @param[in] id The object identifier in case the thread queue is embedded in
     637 * @param queue The actual thread queue.
     638 * @param[out] buffer The buffer for the thread queue name copy.
     639 * @param buffer_size The buffer size in characters.
     640 * @param id The object identifier in case the thread queue is embedded in
    502641 *   an object with identifier, otherwise it is set to 0.
    503642 *
    504  * @retval The length of the thread queue name.  May be greater than or equal
    505  *   to the buffer size if truncation occurred.
     643 * @return The length of the thread queue name.  May be greater than or equal
     644 *  to the buffer size if truncation occurred.
    506645 */
    507646size_t _Thread_queue_Queue_get_name_and_id(
     
    512651);
    513652
     653/**
     654 * @brief Acquires the thread queue control in a critical section.
     655 *
     656 * @param the_thread_queue The thread queue control to acquire.
     657 * @param[out] lock_context The interrupt lock context.
     658 */
    514659#if defined(RTEMS_SMP)
    515660void _Thread_queue_Do_acquire_critical(
     
    528673#endif
    529674
     675/**
     676 * @brief Acquires the thread queue control in a critical section.
     677 *
     678 * @param the_thread_queue The thread queue control to acquire.
     679 * @param[out] lock_context The interrupt lock context.
     680 */
    530681RTEMS_INLINE_ROUTINE void _Thread_queue_Acquire_critical(
    531682  Thread_queue_Control *the_thread_queue,
     
    539690}
    540691
     692/**
     693 * @brief Acquires the thread queue control in a critical section.
     694 *
     695 * @param the_thread_queue The thread queue control to acquire.
     696 * @param[out] queue_context The thread queue context.
     697 */
    541698#if defined(RTEMS_SMP)
    542699void _Thread_queue_Acquire(
     
    555712#endif
    556713
     714/**
     715 * @brief Checks if the thread queue control is the owner of the lock.
     716 *
     717 * @param the_thread_queue The thread queue control for the verification.
     718 *
     719 * @retval true The thread queue control is the owner of the lock.
     720 * @retval false The thread queue control is not the owner of the lock.
     721 */
    557722#if defined(RTEMS_DEBUG)
    558723RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_lock_owner(
     
    568733#endif
    569734
     735/**
     736 * @brief Releases the thread queue control in a critical section.
     737 *
     738 * @param the_thread_queue The thread queue control to release.
     739 * @param[out] lock_context The interrupt lock context.
     740 */
    570741#if defined(RTEMS_SMP)
    571742void _Thread_queue_Do_release_critical(
     
    585756#endif
    586757
     758/**
     759 * @brief Releases the thread queue control in a critical section.
     760 *
     761 * @param the_thread_queue The thread queue control to release.
     762 * @param[out] queue_context The thread queue context.
     763 */
    587764RTEMS_INLINE_ROUTINE void _Thread_queue_Release_critical(
    588765  Thread_queue_Control *the_thread_queue,
     
    596773}
    597774
     775/**
     776 * @brief Releases the thread queue control and enables interrupts.
     777 *
     778 * @param the_thread_queue The thread queue control to release.
     779 * @param[out] queue_context The thread queue context.
     780 */
    598781#if defined(RTEMS_SMP)
    599782void _Thread_queue_Release(
     
    613796#endif
    614797
     798/**
     799 * @brief Dequeues the first thread waiting on the thread queue and returns it.
     800 *
     801 * @param the_thread_queue The thread queue for the operation.
     802 * @param operations The thread queue operations.
     803 *
     804 * @return The first locked thread.
     805 */
    615806Thread_Control *_Thread_queue_Do_dequeue(
    616807  Thread_queue_Control          *the_thread_queue,
     
    728919 * @endcode
    729920 *
    730  * @param[in] queue The actual thread queue.
    731  * @param[in] operations The thread queue operations.
    732  * @param[in] the_thread The thread to enqueue.
    733  * @param[in] queue_context The thread queue context of the lock acquire.
     921 * @param queue The actual thread queue.
     922 * @param operations The thread queue operations.
     923 * @param[in, out] the_thread The thread to enqueue.
     924 * @param[in, out] queue_context The thread queue context of the lock acquire.
    734925 */
    735926void _Thread_queue_Enqueue(
     
    758949 * the processor instead of blocking with respect to the scheduler.
    759950 *
    760  * @param[in] queue The actual thread queue.
    761  * @param[in] operations The thread queue operations.
    762  * @param[in] the_thread The thread to enqueue.
    763  * @param[in] queue_context The thread queue context of the lock acquire.
     951 * @param queue The actual thread queue.
     952 * @param operations The thread queue operations.
     953 * @param[in, out] the_thread The thread to enqueue.
     954 * @param[in, out] queue_context The thread queue context of the lock acquire.
    764955 */
    765956Status_Control _Thread_queue_Enqueue_sticky(
     
    778969 * lock is not released.
    779970 *
    780  * @param[in] queue The actual thread queue.
    781  * @param[in] operations The thread queue operations.
    782  * @param[in] the_thread The thread to extract.
    783  * @param[in] queue_context The thread queue context.
     971 * @param queue The actual thread queue.
     972 * @param operations The thread queue operations.
     973 * @param[in, out] the_thread The thread to extract.
     974 * @param[in, out] queue_context The thread queue context.
    784975 *
    785976 * @return Returns the unblock indicator for _Thread_queue_Unblock_critical().
     
    806997 * dispatching is enabled once the sequence to unblock the thread is complete.
    807998 *
    808  * @param[in] unblock The unblock indicator returned by
     999 * @param unblock The unblock indicator returned by
    8091000 * _Thread_queue_Extract_locked().
    810  * @param[in] queue The actual thread queue.
    811  * @param[in] the_thread The thread to extract.
    812  * @param[in] lock_context The lock context of the lock acquire.
     1001 * @param queue The actual thread queue.
     1002 * @param[in, out] the_thread The thread to extract.
     1003 * @param[in, out] lock_context The lock context of the lock acquire.
    8131004 */
    8141005void _Thread_queue_Unblock_critical(
     
    8601051 * @endcode
    8611052 *
    862  * @param[in] queue The actual thread queue.
    863  * @param[in] operations The thread queue operations.
    864  * @param[in] the_thread The thread to extract.
    865  * @param[in] queue_context The thread queue context of the lock acquire.
     1053 * @param queue The actual thread queue.
     1054 * @param operations The thread queue operations.
     1055 * @param[in, out] the_thread The thread to extract.
     1056 * @param[in, out] queue_context The thread queue context of the lock acquire.
    8661057 */
    8671058void _Thread_queue_Extract_critical(
     
    8731064
    8741065/**
    875  *  @brief Extracts thread from thread queue.
    876  *
    877  *  This routine removes @a the_thread its thread queue
    878  *  and cancels any timeouts associated with this blocking.
    879  *
    880  *  @param[in] the_thread is the pointer to a thread control block that
    881  *      is to be removed
     1066 * @brief Extracts thread from thread queue.
     1067 *
     1068 * This routine removes @a the_thread its thread queue
     1069 * and cancels any timeouts associated with this blocking.
     1070 *
     1071 * @param[in, out] the_thread The pointer to a thread control block that
     1072 *     is to be removed
    8821073 */
    8831074void _Thread_queue_Extract( Thread_Control *the_thread );
    8841075
    8851076/**
    886  *  @brief Extracts the_thread from the_thread_queue.
    887  *
    888  *  This routine extracts the_thread from the_thread_queue
    889  *  and ensures that if there is a proxy for this task on
    890  *  another node, it is also dealt with.
     1077 * @brief Extracts the_thread from the_thread_queue.
     1078 *
     1079 * This routine extracts the_thread from the_thread_queue
     1080 * and ensures that if there is a proxy for this task on
     1081 * another node, it is also dealt with.
     1082 *
     1083 * @param[in, out] the_thread The pointer to a thread control block that
     1084 *     is to be removed
    8911085 */
    8921086void _Thread_queue_Extract_with_proxy(
     
    9031097 * thread dispatch if necessary.
    9041098 *
    905  * @param[in] queue The actual thread queue.
    906  * @param[in] heads The thread queue heads.  It must not be NULL.
    907  * @param[in] previous_owner The previous owner thread surrendering the thread
     1099 * @param[in, out] queue The actual thread queue.
     1100 * @param heads The thread queue heads.  It must not be NULL.
     1101 * @param previous_owner The previous owner thread surrendering the thread
    9081102 *   queue.
    909  * @param[in] queue_context The thread queue context of the lock acquire.
    910  * @param[in] operations The thread queue operations.
     1103 * @param queue_context The thread queue context of the lock acquire.
     1104 * @param operations The thread queue operations.
    9111105 */
    9121106void _Thread_queue_Surrender(
     
    9321126 * performed if necessary.
    9331127 *
    934  * @param[in] queue The actual thread queue.
    935  * @param[in] heads The thread queue heads.  It must not be NULL.
    936  * @param[in] previous_owner The previous owner thread surrendering the thread
     1128 * @param[in, out] queue The actual thread queue.
     1129 * @param heads The thread queue heads.  It must not be NULL.
     1130 * @param[in, out] previous_owner The previous owner thread surrendering the thread
    9371131 *   queue.
    938  * @param[in] queue_context The thread queue context of the lock acquire.
    939  * @param[in] operations The thread queue operations.
     1132 * @param queue_context The thread queue context of the lock acquire.
     1133 * @param operations The thread queue operations.
    9401134 */
    9411135void _Thread_queue_Surrender_sticky(
     
    9481142#endif
    9491143
     1144/**
     1145 * @brief Checks if the thread queue queue is empty.
     1146 *
     1147 * @param queue The thread queue for the verification.
     1148 *
     1149 * @retval true @a queue is empty.
     1150 * @retval false @a queue is not empty.
     1151 */
    9501152RTEMS_INLINE_ROUTINE bool _Thread_queue_Is_empty(
    9511153  const Thread_queue_Queue *queue
     
    9621164 * lock is not released.
    9631165 *
    964  * @param[in] the_thread_queue The thread queue.
    965  * @param[in] operations The thread queue operations.
    966  *
     1166 * @param the_thread_queue The thread queue.
     1167 * @param operations The thread queue operations.
     1168 *
     1169* @retval first The first thread on the thread queue according to the enqueue
     1170 * order.
    9671171 * @retval NULL No thread is present on the thread queue.
    968  * @retval first The first thread on the thread queue according to the enqueue
    969  * order.
    9701172 */
    9711173RTEMS_INLINE_ROUTINE Thread_Control *_Thread_queue_First_locked(
     
    9871189 * @c NULL.
    9881190 *
    989  * @param[in] the_thread_queue The thread queue.
    990  *
    991  * @retval NULL No thread is present on the thread queue.
     1191 * @param the_thread_queue The thread queue.
     1192 *
    9921193 * @retval first The first thread on the thread queue according to the enqueue
    9931194 * order.
     1195 * @retval NULL No thread is present on the thread queue.
    9941196 */
    9951197Thread_Control *_Thread_queue_First(
     
    10291231 *
    10301232 * @param the_thread The thread to extract.
    1031  * @param queue Unused.
    1032  * @param queue_context Unused.
     1233 * @param queue This parameter is unused.
     1234 * @param queue_context This parameter is unused.
    10331235 *
    10341236 * @retval the_thread Extract this thread.
     
    10451247 * Sets the thread wait return code of the thread to STATUS_UNAVAILABLE.
    10461248 *
    1047  * @param the_thread The thread to extract.
    1048  * @param queue Unused.
    1049  * @param queue_context Unused.
     1249 * @param[out] the_thread The thread to extract.
     1250 * @param queue This parameter is unused.
     1251 * @param queue_context This parameter is unused.
    10501252 *
    10511253 * @retval the_thread Extract this thread.
     
    10621264 * Sets the thread wait return code of the thread to STATUS_OBJECT_WAS_DELETED
    10631265 *
    1064  * @param the_thread The thread to extract.
    1065  * @param queue Unused.
    1066  * @param queue_context Unused.
     1266 * @param[out] the_thread The thread to extract.
     1267 * @param queue This parameter is unused.
     1268 * @param queue_context This parameter is unused.
    10671269 *
    10681270 * @retval the_thread Extract this thread.
     
    11031305);
    11041306
     1307/**
     1308 * @brief Initializes the thread queue control to the given name.
     1309 *
     1310 * @param[out] the_thread_queue The thread queue control to initialize.
     1311 * @param name The name for @a the_thread_queue.
     1312 */
    11051313void _Thread_queue_Initialize(
    11061314  Thread_queue_Control *the_thread_queue,
     
    11631371#endif
    11641372
     1373/**
     1374 * @brief Destroys the thread queue.
     1375 *
     1376 * @param[out] the_thread_queue The thread queue to destroy.
     1377 */
    11651378RTEMS_INLINE_ROUTINE void _Thread_queue_Destroy(
    11661379  Thread_queue_Control *the_thread_queue
     
    11731386}
    11741387
     1388/**
     1389 * @brief Does nothing.
     1390 *
     1391 * @param the_proxy This parameter is unused.
     1392 * @param mp_id This parameter is unused.
     1393 */
    11751394#if defined(RTEMS_MULTIPROCESSING)
    11761395void _Thread_queue_MP_callout_do_nothing(
     
    11791398);
    11801399
     1400/**
     1401 * @brief Unblocks the proxy of the thread.
     1402 *
     1403 * @param queue The thread queue queue.
     1404 * @param the_threat The thread to unblock proxy (after casting it to Thread_Proxy_control *).
     1405 */
    11811406void _Thread_queue_Unblock_proxy(
    11821407  Thread_queue_Queue *queue,
     
    11851410#endif
    11861411
     1412/**
     1413 * @brief Acquires the thread queue path in a critical section.
     1414 *
     1415 * @param queue The thread queue queue.
     1416 * @param the_thread The thread for the operation.
     1417 * @param queue_context The thread queue context.
     1418 *
     1419 * @retval true The operation was successful.
     1420 * @retval false The operation failed.
     1421 */
    11871422#if defined(RTEMS_SMP)
    11881423bool _Thread_queue_Path_acquire_critical(
     
    11921427);
    11931428
     1429/**
     1430 * @brief Releases the thread queue path in a critical section.
     1431 *
     1432 * @param queue_context The thread queue context.
     1433 */
    11941434void _Thread_queue_Path_release_critical(
    11951435  Thread_queue_Context *queue_context
     
    12501490 * be ensured with the THREAD_QUEUE_OBJECT_ASSERT() static assertion.
    12511491 *
    1252  * @param[in] the_thread_queue The thread queue.
     1492 * @param[out] the_thread_queue The thread queue.
    12531493 */
    12541494void _Thread_queue_Object_initialize(
     
    12561496);
    12571497
    1258 /**@}*/
     1498/** @} */
    12591499
    12601500#ifdef __cplusplus
Note: See TracChangeset for help on using the changeset viewer.