RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

2007-03-28 Chris Johns <chrisj@rtems.org>

Browse Source 
* 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.
This commit is contained in:
Joel Sherrill
2007-03-28 19:55:50 +00:00
parent 4fbd8f7aa9
commit a91cc066d5
3 changed files with 64 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ChangeLog
View File

@@ -1,3 +1,11 @@
2007-03-28 Chris Johns <chrisj@rtems.org>
* 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.
2007-03-10 Joel Sherrill <joel@OARcorp.com>
PR 1226/cpukit

2
doc/user/Makefile.am
View File

@@ -1,5 +1,5 @@
#
# COPYRIGHT (c) 1988-2002.
# COPYRIGHT (c) 1988-2007
# On-Line Applications Research Corporation (OAR).
# All rights reserved.
#

60
doc/user/clock.t
View File

@@ -1,5 +1,5 @@
@c
@c COPYRIGHT (c) 1988-2002.
@c COPYRIGHT (c) 1988-2007
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@@ -19,6 +19,7 @@ the clock manager are:
@itemize @bullet
@item @code{@value{DIRPREFIX}clock_set} - Set system date and time
@item @code{@value{DIRPREFIX}clock_get} - Get system date and time information
@item @code{@value{DIRPREFIX}clock_set_nanoseconds_extension} - Install the nanoseconds since last tick handler
@item @code{@value{DIRPREFIX}clock_tick} - Announce a clock tick
@end itemize
@@ -390,6 +391,57 @@ time to be reset to an uninitialized state. Another call to
@code{@value{DIRPREFIX}clock_set} is required to re-initialize the
system date and time to application specific specifications.
@c
@c
@c
@page
@subsection CLOCK_SET_NANOSECONDS_EXTENSION - Install the nanoseconds since last tick handler
@cindex clock set nanoseconds extension
@cindex nanoseconds extension
@cindex nanoseconds time accuracy
@subheading CALLING SEQUENCE:
@ifset is-C
@findex rtems_clock_set_nanoseconds_extension
@example
rtems_status_code rtems_clock_set_nanoseconds_extension(
rtems_nanoseconds_extension_routine routine
);
@end example
@end ifset
@ifset is-Ada
@example
NOT SUPPORTED FROM Ada BINDING
@end example
@end ifset
@subheading DIRECTIVE STATUS CODES:
@code{@value{RPREFIX}SUCCESSFUL} - clock tick processed successfully@*
@code{@value{RPREFIX}INVALID_ADDRESS} - @code{time_buffer} is NULL
@subheading DESCRIPTION:
This directive is used by the Clock device driver to install the
@code{routine} which will be invoked by the internal RTEMS method used to
obtain a highly accurate time of day. It is usually called during
the initialization of the driver.
When the @code{routine} is invoked, it will determine the number of
nanoseconds which have elapsed since the last invocation of
the @code{@value{DIRPREFIX}clock_tick} directive. It should do
this as quickly as possible with as little impact as possible
on the device used as a clock source.
@subheading NOTES:
This directive may be called from an ISR.
This directive is called as part of every service to obtain the
current date and time as well as timestamps.
@c
@c
@c
@@ -409,9 +461,7 @@ rtems_status_code rtems_clock_tick( void );
@ifset is-Ada
@example
procedure Clock_Tick (
Result : out RTEMS.Status_Codes
);
NOT SUPPORTED FROM Ada BINDING
@end example
@end ifset
@@ -431,7 +481,7 @@ timeslicing.
This directive is typically called from an ISR.
The microseconds_per_tick and ticks_per_timeslice
The @code{microseconds_per_tick} and @code{ticks_per_timeslice}
parameters in the Configuration Table contain the number of
microseconds per tick and number of ticks per timeslice,
respectively.