mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2025-12-05 15:15:44 +00:00
6449498bc7
* SUPPORT, LICENSE: New files. * Numerous files touched as part of merging the 4.5 branch onto the mainline development trunk and ensuring that the script that cuts snapshots and releases works on the documentation.
311 lines
3.7 KiB
Perl
311 lines
3.7 KiB
Perl
@c
|
|
@c COPYRIGHT (c) 1988-2002.
|
|
@c On-Line Applications Research Corporation (OAR).
|
|
@c All rights reserved.
|
|
@c
|
|
@c This is the chapter from the RTEMS ITRON User's Guide that
|
|
@c documents the services provided by the time
|
|
@c manager.
|
|
@c
|
|
@c $Id$
|
|
@c
|
|
|
|
@chapter Time Manager
|
|
|
|
@section Introduction
|
|
|
|
The
|
|
time manager is ...
|
|
|
|
The services provided by the time manager are:
|
|
|
|
@itemize @bullet
|
|
@item @code{get_tim} - Get System Clock
|
|
@item @code{set_tim} - Set System Clock
|
|
@item @code{dly_tsk} - Delay Task
|
|
@item @code{def_cyc} - Define Cyclic Handler
|
|
@item @code{act_cyc} - Activate Cyclic Handler
|
|
@item @code{ref_cyc} - Reference Cyclic Handler Status
|
|
@item @code{def_alm} - Define Alarm Handler
|
|
@item @code{ref_alm} - Reference Alarm Handler Status
|
|
@item @code{ret_tmr} - Return from Timer Handler
|
|
@end itemize
|
|
|
|
@section Background
|
|
|
|
@section Operations
|
|
|
|
@section System Calls
|
|
|
|
This section details the time manager's services.
|
|
A subsection is dedicated to each of this manager's services
|
|
and describes the calling sequence, related constants, usage,
|
|
and status codes.
|
|
|
|
|
|
@c
|
|
@c get_tim
|
|
@c
|
|
|
|
@page
|
|
@subsection get_tim - Get System Clock
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER get_tim(
|
|
SYSTIME *pk_tim
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c set_tim
|
|
@c
|
|
|
|
@page
|
|
@subsection set_tim - Set System Clock
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER set_tim(
|
|
SYSTIME *pk_tim
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c dly_tsk
|
|
@c
|
|
|
|
@page
|
|
@subsection dly_tsk - Delay Task
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER dly_tsk(
|
|
DLYTIME dlytim
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c def_cyc
|
|
@c
|
|
|
|
@page
|
|
@subsection def_cyc - Define Cyclic Handler
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER def_cyc(
|
|
HNO cycno,
|
|
T_DCYC *pk_dcyc
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c act_cyc
|
|
@c
|
|
|
|
@page
|
|
@subsection act_cyc - Activate Cyclic Handler
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER act_cyc(
|
|
HNO cycno,
|
|
UINT cycact
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c ref_cyc
|
|
@c
|
|
|
|
@page
|
|
@subsection ref_cyc - Reference Cyclic Handler Status
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER ref_cyc(
|
|
T_RCYC *pk_rcyc,
|
|
HNO cycno
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c def_alm
|
|
@c
|
|
|
|
@page
|
|
@subsection def_alm - Define Alarm Handler
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER def_alm(
|
|
HNO almno,
|
|
T_DALM *pk_dalm
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c ref_alm
|
|
@c
|
|
|
|
@page
|
|
@subsection ref_alm - Reference Alarm Handler Status
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
ER ref_alm(
|
|
T_RALM *pk_ralm,
|
|
HNO almno
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|
|
|
|
@c
|
|
@c ret_tmr
|
|
@c
|
|
|
|
@page
|
|
@subsection ret_tmr - Return from Timer Handler
|
|
|
|
@subheading CALLING SEQUENCE:
|
|
|
|
@ifset is-C
|
|
@example
|
|
void ret_tmr(
|
|
|
|
);
|
|
@end example
|
|
@end ifset
|
|
|
|
@ifset is-Ada
|
|
@end ifset
|
|
|
|
@subheading STATUS CODES:
|
|
|
|
@code{EXXX} -
|
|
|
|
@subheading DESCRIPTION:
|
|
|
|
@subheading NOTES:
|
|
|