Changeset d404771 in rtems


Ignore:
Timestamp:
12/22/21 07:16:43 (10 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
8657986
Parents:
18e47db5
git-author:
Sebastian Huber <sebastian.huber@…> (12/22/21 07:16:43)
git-committer:
Sebastian Huber <sebastian.huber@…> (12/22/21 07:17:50)
Message:

rtems: Fix Clock Manager parameter descriptions

Update #4572.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/rtems/clock.h

    r18e47db5 rd404771  
    452452 *   measured using the CLOCK_MONOTONIC in seconds and nanoseconds format.
    453453 *
     454 * @param[out] time_snapshot is the pointer to a struct timespec object.  The
     455 *   time elapsed since some fixed time point in the past measured using the
     456 *   CLOCK_MONOTONIC at some time point during the directive call will be
     457 *   stored in this object.  Calling the directive with a pointer equal to NULL
     458 *   is undefined behaviour.
     459 *
     460 * @par Notes
     461 * @parblock
     462 * The directive accesses a device provided by the Clock Driver to get the time
     463 * in the highest resolution available to the system.  Alternatively, the
     464 * rtems_clock_get_monotonic_coarse() directive may be used to get the time
     465 * with in a lower resolution and with less runtime overhead.
     466 *
     467 * See rtems_clock_get_monotonic_bintime(),
     468 * rtems_clock_get_monotonic_sbintime(), and
     469 * rtems_clock_get_monotonic_timeval() to get the time in alternative formats.
     470 * @endparblock
     471 *
     472 * @par Constraints
     473 * @parblock
     474 * The following constraints apply to this directive:
     475 *
     476 * * The directive may be called from within any runtime context.
     477 *
     478 * * The directive will not cause the calling task to be preempted.
     479 *
     480 * * The directive requires a Clock Driver.
     481 * @endparblock
     482 */
     483void rtems_clock_get_monotonic( struct timespec *time_snapshot );
     484
     485/* Generated from spec:/rtems/clock/if/get-monotonic-bintime */
     486
     487/**
     488 * @ingroup RTEMSAPIClassicClock
     489 *
     490 * @brief Gets the time elapsed since some fixed time point in the past
     491 *   measured using the CLOCK_MONOTONIC in binary time format.
     492 *
    454493 * @param[out] time_snapshot is the pointer to a bintime object.  The time
    455494 *   elapsed since some fixed time point in the past measured using the
     
    462501 * The directive accesses a device provided by the Clock Driver to get the time
    463502 * in the highest resolution available to the system.  Alternatively, the
    464  * rtems_clock_get_monotonic_coarse() directive may be used to get the time
    465  * with in a lower resolution and with less runtime overhead.
    466  *
    467  * See rtems_clock_get_monotonic_bintime(),
    468  * rtems_clock_get_monotonic_sbintime(), and
    469  * rtems_clock_get_monotonic_timeval() to get the time in alternative formats.
    470  * @endparblock
    471  *
    472  * @par Constraints
    473  * @parblock
    474  * The following constraints apply to this directive:
    475  *
    476  * * The directive may be called from within any runtime context.
    477  *
    478  * * The directive will not cause the calling task to be preempted.
    479  *
    480  * * The directive requires a Clock Driver.
    481  * @endparblock
    482  */
    483 void rtems_clock_get_monotonic( struct timespec *time_snapshot );
    484 
    485 /* Generated from spec:/rtems/clock/if/get-monotonic-bintime */
    486 
    487 /**
    488  * @ingroup RTEMSAPIClassicClock
    489  *
    490  * @brief Gets the time elapsed since some fixed time point in the past
    491  *   measured using the CLOCK_MONOTONIC in binary time format.
    492  *
    493  * @param[out] time_snapshot is the pointer to a bintime object.  The time
    494  *   elapsed since some fixed time point in the past measured using the
    495  *   CLOCK_MONOTONIC at some time point during the directive call will be
    496  *   stored in this object.  Calling the directive with a pointer equal to NULL
    497  *   is undefined behaviour.
    498  *
    499  * @par Notes
    500  * @parblock
    501  * The directive accesses a device provided by the Clock Driver to get the time
    502  * in the highest resolution available to the system.  Alternatively, the
    503503 * rtems_clock_get_monotonic_coarse_bintime() directive may be used to get the
    504504 * time in a lower resolution and with less runtime overhead.
     
    563563 *   measured using the CLOCK_MONOTONIC in seconds and microseconds format.
    564564 *
    565  * @param[out] time_snapshot is the pointer to a bintime object.  The time
    566  *   elapsed since some fixed time point in the past measured using the
     565 * @param[out] time_snapshot is the pointer to a struct timeval object.  The
     566 *   time elapsed since some fixed time point in the past measured using the
    567567 *   CLOCK_MONOTONIC at some time point during the directive call will be
    568568 *   stored in this object.  Calling the directive with a pointer equal to NULL
     
    601601 *   measured using the CLOCK_MONOTONIC in coarse resolution in seconds and
    602602 *   nanoseconds format.
     603 *
     604 * @param[out] time_snapshot is the pointer to a struct timespec object.  The
     605 *   time elapsed since some fixed time point in the past measured using the
     606 *   CLOCK_MONOTONIC at some time point close to the directive call will be
     607 *   stored in this object.  Calling the directive with a pointer equal to NULL
     608 *   is undefined behaviour.
     609 *
     610 * @par Notes
     611 * @parblock
     612 * The directive does not access a device to get the time.  It uses a recent
     613 * snapshot provided by the Clock Driver.  Alternatively, the
     614 * rtems_clock_get_monotonic() directive may be used to get the time in a
     615 * higher resolution and with a higher runtime overhead.
     616 *
     617 * See rtems_clock_get_monotonic_coarse_bintime() and
     618 * rtems_clock_get_monotonic_coarse_timeval() to get the time in alternative
     619 * formats.
     620 * @endparblock
     621 *
     622 * @par Constraints
     623 * @parblock
     624 * The following constraints apply to this directive:
     625 *
     626 * * The directive may be called from within any runtime context.
     627 *
     628 * * The directive will not cause the calling task to be preempted.
     629 *
     630 * * The directive requires a Clock Driver.
     631 * @endparblock
     632 */
     633void rtems_clock_get_monotonic_coarse( struct timespec *time_snapshot );
     634
     635/* Generated from spec:/rtems/clock/if/get-monotonic-coarse-bintime */
     636
     637/**
     638 * @ingroup RTEMSAPIClassicClock
     639 *
     640 * @brief Gets the time elapsed since some fixed time point in the past
     641 *   measured using the CLOCK_MONOTONIC in coarse resolution in binary time
     642 *   format.
    603643 *
    604644 * @param[out] time_snapshot is the pointer to a bintime object.  The time
     
    612652 * The directive does not access a device to get the time.  It uses a recent
    613653 * snapshot provided by the Clock Driver.  Alternatively, the
    614  * rtems_clock_get_monotonic() directive may be used to get the time in a
    615  * higher resolution and with a higher runtime overhead.
    616  *
    617  * See rtems_clock_get_monotonic_coarse_bintime() and
    618  * rtems_clock_get_monotonic_coarse_timeval() to get the time in alternative
    619  * formats.
    620  * @endparblock
    621  *
    622  * @par Constraints
    623  * @parblock
    624  * The following constraints apply to this directive:
    625  *
    626  * * The directive may be called from within any runtime context.
    627  *
    628  * * The directive will not cause the calling task to be preempted.
    629  *
    630  * * The directive requires a Clock Driver.
    631  * @endparblock
    632  */
    633 void rtems_clock_get_monotonic_coarse( struct timespec *time_snapshot );
    634 
    635 /* Generated from spec:/rtems/clock/if/get-monotonic-coarse-bintime */
    636 
    637 /**
    638  * @ingroup RTEMSAPIClassicClock
    639  *
    640  * @brief Gets the time elapsed since some fixed time point in the past
    641  *   measured using the CLOCK_MONOTONIC in coarse resolution in binary time
    642  *   format.
    643  *
    644  * @param[out] time_snapshot is the pointer to a bintime object.  The time
    645  *   elapsed since some fixed time point in the past measured using the
    646  *   CLOCK_MONOTONIC at some time point close to the directive call will be
    647  *   stored in this object.  Calling the directive with a pointer equal to NULL
    648  *   is undefined behaviour.
    649  *
    650  * @par Notes
    651  * @parblock
    652  * The directive does not access a device to get the time.  It uses a recent
    653  * snapshot provided by the Clock Driver.  Alternatively, the
    654654 * rtems_clock_get_monotonic_bintime() directive may be used to get the time in
    655655 * a higher resolution and with a higher runtime overhead.
     
    682682 *   microseconds format.
    683683 *
    684  * @param[out] time_snapshot is the pointer to a bintime object.  The time
    685  *   elapsed since some fixed time point in the past measured using the
     684 * @param[out] time_snapshot is the pointer to a struct timeval object.  The
     685 *   time elapsed since some fixed time point in the past measured using the
    686686 *   CLOCK_MONOTONIC at some time point close to the directive call will be
    687687 *   stored in this object.  Calling the directive with a pointer equal to NULL
Note: See TracChangeset for help on using the changeset viewer.