Changeset f553c6e in rtems for doc/user/clock.t


Ignore:
Timestamp:
Aug 22, 2014, 2:39:47 PM (6 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, 5, master
Children:
0a314839
Parents:
e7a42a0c
git-author:
Sebastian Huber <sebastian.huber@…> (08/22/14 14:39:47)
git-committer:
Sebastian Huber <sebastian.huber@…> (08/25/14 06:57:36)
Message:

rtems: Inline rtems_clock_get_ticks_since_boot()

Update documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user/clock.t

    re7a42a0c rf553c6e  
    2121@item @code{@value{DIRPREFIX}clock_get_seconds_since_epoch} - Get seconds since epoch
    2222@item @code{@value{DIRPREFIX}clock_get_ticks_per_second} - Get ticks per second
    23 @item @code{@value{DIRPREFIX}clock_get_ticks_since_boot} - Get ticks since boot
     23@item @code{@value{DIRPREFIX}clock_get_ticks_since_boot} - Get current ticks counter value
    2424@item @code{@value{DIRPREFIX}clock_get_uptime} - Get time since boot
    2525@item @code{@value{DIRPREFIX}clock_get_uptime_timeval} - Get time since boot in timeval format
     
    570570This directive is callable from an ISR.
    571571
    572 This directive will not cause the running task to be
    573 preempted.  Re-initializing RTEMS causes the system date and
    574 time to be reset to an uninitialized state.  Another call to
    575 @code{@value{DIRPREFIX}clock_set} is required to re-initialize the
    576 system date and time to application specific specifications.
    577 
    578 @c
    579 @c
    580 @c
    581 @page
    582 @subsection CLOCK_GET_TICKS_SINCE_BOOT - Get ticks since boot
     572This directive will not cause the running task to be preempted.
     573
     574@c
     575@c
     576@c
     577@page
     578@subsection CLOCK_GET_TICKS_SINCE_BOOT - Get current ticks counter value
    583579
    584580@cindex obtain ticks since boot
     581@cindex get current ticks counter value
    585582
    586583@subheading CALLING SEQUENCE:
     
    605602@subheading DESCRIPTION:
    606603
    607 This directive returns the number of clock ticks that have elapsed
    608 since the system was booted.  This is the historical measure of uptime
    609 in an RTEMS system.  The newer service
    610 @code{@value{DIRPREFIX}clock_get_uptime} is another and potentially
    611 more accurate way of obtaining similar information.
     604This directive returns the current tick counter value.  With a 1ms clock tick,
     605this counter overflows after 50 days since boot.  This is the historical
     606measure of uptime in an RTEMS system.  The newer service
     607@code{@value{DIRPREFIX}clock_get_uptime} is another and potentially more
     608accurate way of obtaining similar information.
    612609
    613610@subheading NOTES:
     
    615612This directive is callable from an ISR.
    616613
    617 This directive will not cause the running task to be
    618 preempted.  Re-initializing RTEMS causes the system date and
    619 time to be reset to an uninitialized state.  Another call to
    620 @code{@value{DIRPREFIX}clock_set} is required to re-initialize the
    621 system date and time to application specific specifications.
    622 
    623 This directive simply returns the number of times the dirivective
    624 @code{@value{DIRPREFIX}clock_tick} has been invoked since the
    625 system was booted.
     614This directive will not cause the running task to be preempted.
    626615
    627616@c
Note: See TracChangeset for help on using the changeset viewer.