Changeset a91cc06 in rtems


Ignore:
Timestamp:
Mar 28, 2007, 7:55:50 PM (13 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
4b6546f0
Parents:
4fbd8f7
Message:

2007-03-28 Chris Johns <chrisj@…>

  • user/Makefile.am, user/clock.t: Add support for a handler to obtain the number of nanoseconds since the last clock tick. The primary interface for this is rtems_clock_set_nanoseconds_extension. Subsequent commits from Joel will redo the TOD support to use this capability.
Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r4fbd8f7 ra91cc06  
     12007-03-28      Chris Johns <chrisj@rtems.org>
     2
     3        * user/Makefile.am, user/clock.t: Add support for a handler to obtain
     4        the number of nanoseconds since the last clock tick. The primary
     5        interface for this is rtems_clock_set_nanoseconds_extension.
     6        Subsequent commits from Joel will redo the TOD support to use this
     7        capability.
     8
    192007-03-10      Joel Sherrill <joel@OARcorp.com>
    210
  • doc/user/Makefile.am

    r4fbd8f7 ra91cc06  
    11#
    2 #  COPYRIGHT (c) 1988-2002.
     2#  COPYRIGHT (c) 1988-2007
    33#  On-Line Applications Research Corporation (OAR).
    44#  All rights reserved.
  • doc/user/clock.t

    r4fbd8f7 ra91cc06  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2007
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    2020@item @code{@value{DIRPREFIX}clock_set} - Set system date and time
    2121@item @code{@value{DIRPREFIX}clock_get} - Get system date and time information
     22@item @code{@value{DIRPREFIX}clock_set_nanoseconds_extension} - Install the nanoseconds since last tick handler
    2223@item @code{@value{DIRPREFIX}clock_tick} - Announce a clock tick
    2324@end itemize
     
    395396@c
    396397@page
     398@subsection CLOCK_SET_NANOSECONDS_EXTENSION - Install the nanoseconds since last tick handler
     399
     400@cindex clock set nanoseconds extension
     401@cindex nanoseconds extension
     402@cindex nanoseconds time accuracy
     403
     404@subheading CALLING SEQUENCE:
     405
     406@ifset is-C
     407@findex rtems_clock_set_nanoseconds_extension
     408@example
     409rtems_status_code rtems_clock_set_nanoseconds_extension(
     410  rtems_nanoseconds_extension_routine routine
     411);
     412@end example
     413@end ifset
     414
     415@ifset is-Ada
     416@example
     417NOT SUPPORTED FROM Ada BINDING
     418@end example
     419@end ifset
     420
     421@subheading DIRECTIVE STATUS CODES:
     422@code{@value{RPREFIX}SUCCESSFUL} - clock tick processed successfully@*
     423@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL
     424
     425@subheading DESCRIPTION:
     426
     427This directive is used by the Clock device driver to install the
     428@code{routine} which will be invoked by the internal RTEMS method used to
     429obtain a highly accurate time of day.  It is usually called during
     430the initialization of the driver.
     431
     432When the @code{routine} is invoked, it will determine the number of
     433nanoseconds which have elapsed since the last invocation of
     434the @code{@value{DIRPREFIX}clock_tick} directive.  It should do
     435this as quickly as possible with as little impact as possible
     436on the device used as a clock source.
     437
     438@subheading NOTES:
     439
     440This directive may be called from an ISR.
     441
     442This directive is called as part of every service to obtain the
     443current date and time as well as timestamps.
     444
     445@c
     446@c
     447@c
     448@page
    397449@subsection CLOCK_TICK - Announce a clock tick
    398450
     
    410462@ifset is-Ada
    411463@example
    412 procedure Clock_Tick (
    413    Result :    out RTEMS.Status_Codes
    414 );
     464NOT SUPPORTED FROM Ada BINDING
    415465@end example
    416466@end ifset
     
    432482This directive is typically called from an ISR.
    433483
    434 The microseconds_per_tick and ticks_per_timeslice
     484The @code{microseconds_per_tick} and @code{ticks_per_timeslice}
    435485parameters in the Configuration Table contain the number of
    436486microseconds per tick and number of ticks per timeslice,
Note: See TracChangeset for help on using the changeset viewer.