Changeset c53ec8c4 in rtems


Ignore:
Timestamp:
Apr 18, 2019, 7:30:32 AM (2 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
904c2312
Parents:
eb84cc3f
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/18/19 07:30:32)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:05)
Message:

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

Update #3706.

File:
1 edited

Legend:

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

    reb84cc3f rc53ec8c4  
    11/**
    22 * @file
     3 *
     4 * @ingroup RTEMSScoreWatchdog
    35 *
    46 * @brief Inlined Routines in the Watchdog Handler
     
    3537
    3638/**
    37  *  @addtogroup RTEMSScoreWatchdog
    38  *  @{
     39 * @addtogroup RTEMSScoreWatchdog
     40 *
     41 * @{
    3942 */
    4043
     
    9093#endif
    9194
     95/**
     96 * @brief Initializes the watchdog header.
     97 *
     98 * @param[out] header The header to initialize.
     99 */
    92100RTEMS_INLINE_ROUTINE void _Watchdog_Header_initialize(
    93101  Watchdog_Header *header
     
    98106}
    99107
     108/**
     109 * @brief Returns the first of the watchdog header.
     110 *
     111 * @param header The watchdog header to remove the first of.
     112 *
     113 * @return The first of @a header.
     114 */
    100115RTEMS_INLINE_ROUTINE Watchdog_Control *_Watchdog_Header_first(
    101116  const Watchdog_Header *header
     
    105120}
    106121
     122/**
     123 * @brief Destroys the watchdog header.
     124 *
     125 * @param header The watchdog header to destroy.
     126 */
    107127RTEMS_INLINE_ROUTINE void _Watchdog_Header_destroy(
    108128  Watchdog_Header *header
     
    114134
    115135/**
    116  *  @brief Performs a watchdog tick.
    117  *
    118  *  @param cpu The processor for this watchdog tick.
     136 * @brief Performs a watchdog tick.
     137 *
     138 * @param cpu The processor for this watchdog tick.
    119139 */
    120140void _Watchdog_Tick( struct Per_CPU_Control *cpu );
    121141
     142/**
     143 * @brief Gets the state of the watchdog.
     144 *
     145 * @param the_watchdog The watchdog to get the state of.
     146 *
     147 * @return The RB_COLOR of @a the_watchdog.
     148 */
    122149RTEMS_INLINE_ROUTINE Watchdog_State _Watchdog_Get_state(
    123150  const Watchdog_Control *the_watchdog
     
    127154}
    128155
     156/**
     157 * @brief Sets the state of the watchdog.
     158 *
     159 * @param[out] the_watchdog The watchdog to set the state of.
     160 * @param state The state to set the watchdog to.
     161 */
    129162RTEMS_INLINE_ROUTINE void _Watchdog_Set_state(
    130163  Watchdog_Control *the_watchdog,
     
    135168}
    136169
     170/**
     171 * @brief Gets the watchdog's cpu.
     172 *
     173 * @param the_watchdog The watchdog to get the cpu of.
     174 *
     175 * @return The cpu of the watchdog.
     176 */
    137177RTEMS_INLINE_ROUTINE Per_CPU_Control *_Watchdog_Get_CPU(
    138178  const Watchdog_Control *the_watchdog
     
    146186}
    147187
     188/**
     189 * @brief Sets the cpu for the watchdog.
     190 *
     191 * @param[out] the_watchdog The watchdog to set the cpu of.
     192 * @param cpu The cpu to be set as @a the_watchdog's cpu.
     193 */
    148194RTEMS_INLINE_ROUTINE void _Watchdog_Set_CPU(
    149195  Watchdog_Control *the_watchdog,
     
    164210 * exception are statically initialized watchdogs via WATCHDOG_INITIALIZER().
    165211 *
    166  * @param[in] the_watchdog The uninitialized watchdog.
     212 * @param[out] the_watchdog The uninitialized watchdog.
    167213 */
    168214RTEMS_INLINE_ROUTINE void _Watchdog_Preinitialize(
     
    184230 *
    185231 * The watchdog must be inactive.
     232 *
     233 * @param[out] the_watchdog The watchdog to initialize.
     234 * @param routing The service routine for @a the_watchdog.
    186235 */
    187236RTEMS_INLINE_ROUTINE void _Watchdog_Initialize(
     
    194243}
    195244
     245/**
     246 * @brief Calls the routine of each not expired watchdog control node.
     247 *
     248 * @param header The watchdog header.
     249 * @param first The first watchdog control node.
     250 * @param now The current time to check the expiration time against.
     251 * @param lock The lock that is released before calling the routine and then
     252 *      acquired after the call.
     253 * @param lock_context The lock context for the release before calling the
     254 *      routine and for the acquire after.
     255 */
    196256void _Watchdog_Do_tickle(
    197257  Watchdog_Header  *header,
     
    217277 *
    218278 * The watchdog must be inactive.
     279 *
     280 * @param[in, out] header The set of scheduler watchdogs to insert into.
     281 * @param[in, out] the_watchdog The watchdog to insert.
     282 * @param expire The expiration time for the watchdog.
    219283 */
    220284void _Watchdog_Insert(
     
    225289
    226290/**
    227  * @brief In case the watchdog is scheduled, then it is removed from the set of
     291 * @brief In the case the watchdog is scheduled, then it is removed from the set of
    228292 * scheduled watchdogs.
    229293 *
    230294 * The watchdog must be initialized before this call.
     295 *
     296 * @param[in, out] header The scheduled watchdogs.
     297 * @param[in, out] the_watchdog The watchdog to remove.
    231298 */
    232299void _Watchdog_Remove(
     
    236303
    237304/**
    238  * @brief In case the watchdog is scheduled, then it is removed from the set of
     305 * @brief In the case the watchdog is scheduled, then it is removed from the set of
    239306 * scheduled watchdogs.
    240307 *
    241308 * The watchdog must be initialized before this call.
    242309 *
     310 * @param[in, out] header The scheduled watchdogs.
     311 * @param[in, out] the_watchdog The watchdog to remove.
     312 * @param now The current time.
     313 *
     314 * @retval other The difference of the now and expiration time.
    243315 * @retval 0 The now time is greater than or equal to the expiration time of
    244316 * the watchdog.
    245  * @retval other The difference of the now and expiration time.
    246317 */
    247318RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Cancel(
     
    267338}
    268339
     340/**
     341 * @brief Checks if the watchdog is scheduled.
     342 *
     343 * @param the_watchdog The watchdog for the verification.
     344 *
     345 * @retval true The watchdog is scheduled.
     346 * @retval false The watchdog is inactive.
     347 */
    269348RTEMS_INLINE_ROUTINE bool _Watchdog_Is_scheduled(
    270349  const Watchdog_Control *the_watchdog
     
    274353}
    275354
     355/**
     356 * @brief Sets the first node of the header.
     357 *
     358 * Sets the first node of the header to either the leftmost child node of the
     359 *  watchdog control node, or if not present sets it to the right child node of
     360 * the watchdog control node. if both are not present, the new first node is
     361 * the parent node of the current first node.
     362 *
     363 * @param[in, out] header The watchdog header.
     364 * @param the_watchdog The watchdog control node for the operation.
     365 */
    276366RTEMS_INLINE_ROUTINE void _Watchdog_Next_first(
    277367  Watchdog_Header  *header,
     
    319409#define WATCHDOG_MAX_SECONDS 0x3ffffffff
    320410
     411/**
     412 * @brief Checks if the timespec is a valid timespec for a watchdog.
     413 *
     414 * @param ts The timespec for the verification.
     415 *
     416 * @retval true The timespec is a valid timespec.
     417 * @retval false The timespec is invalid.
     418 */
    321419RTEMS_INLINE_ROUTINE bool _Watchdog_Is_valid_timespec(
    322420  const struct timespec *ts
     
    327425}
    328426
     427/**
     428 * @brief Checks if the timespec is a valid interval timespec for a watchdog.
     429 *
     430 * @param ts The timespec for the verification.
     431 *
     432 * @retval true The timespec is a valid interval timespec.
     433 * @retval false The timespec is invalid.
     434 */
    329435RTEMS_INLINE_ROUTINE bool _Watchdog_Is_valid_interval_timespec(
    330436  const struct timespec *ts
     
    334440}
    335441
     442/**
     443 * @brief Adds the delta timespec to the current time if the delta is a valid
     444 * interval timespec.
     445 *
     446 * @param[in, out] now The current time.
     447 * @param delta The delta timespec for the addition.
     448 *
     449 * @retval pointer Pointer to the now timespec.
     450 * @retval NULL @a delta is not a valid interval timespec.
     451 */
    336452RTEMS_INLINE_ROUTINE const struct timespec * _Watchdog_Future_timespec(
    337453  struct timespec       *now,
     
    364480}
    365481
     482/**
     483 * @brief Checks if the timespec is too far in the future.
     484 *
     485 * @param ts The timespec for the verification.
     486 *
     487 * @retval true @a ts is too far in the future.
     488 * @retval false @a ts is not too far in the future.
     489 */
    366490RTEMS_INLINE_ROUTINE bool _Watchdog_Is_far_future_timespec(
    367491  const struct timespec *ts
     
    371495}
    372496
     497/**
     498 * @brief Converts the seconds to ticks.
     499 *
     500 * @param seconds The seconds to convert to ticks.
     501 *
     502 * @return @a seconds converted to ticks.
     503 */
    373504RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_seconds(
    374505  uint32_t seconds
     
    382513}
    383514
     515/**
     516 * @brief Converts the timespec in ticks.
     517 *
     518 * @param ts The timespec to convert to ticks.
     519 *
     520 * @return @a ts converted to ticks.
     521 */
    384522RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_timespec(
    385523  const struct timespec *ts
     
    399537}
    400538
     539/**
     540 * @brief Converts the sbintime in ticks.
     541 *
     542 * @param sbt The sbintime to convert to ticks.
     543 *
     544 * @return @a sbt converted to ticks.
     545 */
    401546RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Ticks_from_sbintime( int64_t sbt )
    402547{
     
    408553}
    409554
     555/**
     556 * @brief Acquires the per cpu watchdog lock in a critical section.
     557 *
     558 * @param cpu The cpu to acquire the watchdog lock of.
     559 * @param lock_context The lock context.
     560 */
    410561RTEMS_INLINE_ROUTINE void _Watchdog_Per_CPU_acquire_critical(
    411562  Per_CPU_Control  *cpu,
     
    416567}
    417568
     569/**
     570 * @brief Releases the per cpu watchdog lock in a critical section.
     571 *
     572 * @param cpu The cpu to release the watchdog lock of.
     573 * @param lock_context The lock context.
     574 */
    418575RTEMS_INLINE_ROUTINE void _Watchdog_Per_CPU_release_critical(
    419576  Per_CPU_Control  *cpu,
     
    424581}
    425582
     583/**
     584 * @brief Sets the watchdog's cpu to the given instance and sets its expiration
     585 *      time to the watchdog expiration time of the cpu plus the ticks.
     586 *
     587 * @param[in, out] the_watchdog The watchdog to set the cpu and expiration time of.
     588 * @param cpu The cpu for the watchdog.
     589 * @param ticks The ticks to add to the expiration time.
     590 *
     591 * @return The new expiration time of the watchdog.
     592 */
    426593RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Per_CPU_insert_ticks(
    427594  Watchdog_Control  *the_watchdog,
     
    445612}
    446613
     614/**
     615 * @brief Sets the watchdog's cpu and inserts it with the given expiration time
     616 *      in the scheduled watchdogs.
     617 *
     618 * @param[in, out] the_watchdog The watchdog to set cpu and expiration time of.
     619 * @param cpu The cpu for the operation.
     620 * @param[in, out] header The scheduled watchdogs.
     621 * @param expire The expiration time for the watchdog.
     622 *
     623 * @return The expiration time of the watchdog.
     624 */
    447625RTEMS_INLINE_ROUTINE uint64_t _Watchdog_Per_CPU_insert(
    448626  Watchdog_Control *the_watchdog,
     
    462640}
    463641
     642/**
     643 * @brief Removes the watchdog from the cpu and the scheduled watchdogs.
     644 *
     645 * @param[in, out] the_watchdog The watchdog to remove.
     646 * @param cpu The cpu to remove the watchdog from.
     647 * @param[in, out] The scheduled watchdogs.
     648 */
    464649RTEMS_INLINE_ROUTINE void _Watchdog_Per_CPU_remove(
    465650  Watchdog_Control *the_watchdog,
     
    478663}
    479664
     665/**
     666 * @brief Removes the watchdog from the cpu and the scheduled watchdogs.
     667 *
     668 * @param[in, out] the_watchdog The watchdog to remove.
     669 */
    480670RTEMS_INLINE_ROUTINE void _Watchdog_Per_CPU_remove_ticks(
    481671  Watchdog_Control *the_watchdog
Note: See TracChangeset for help on using the changeset viewer.