Mirrors_Framework/rtems
1
0
Fork 0
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2026-09-21 17:36:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Initial revision

Browse Source
This commit is contained in:
Joel Sherrill
1999-05-20 21:55:30 +00:00
parent 0aeda88267
commit 10122b7195
16 changed files with 4561 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/itron3.0/Makefile
+123
View File
@@ -0,0 +1,123 @@
#
# COPYRIGHT (c) 1988-1998.
# On-Line Applications Research Corporation (OAR).
# All rights reserved.
#
# $Id$
#
PROJECT=itron
TEXI2DVI=../tools/texi2dvi
MAKEINFO=makeinfo
TEXI2WWW=../tools/texi2www
BMENU=../tools/bmenu
TEXI2WWW_ARGS=-dirfile index.html \
-header ../tools/rtems_header.html \
-footer ../tools/rtems_footer.html \
-icons .
all: html info ps
COMMON_FILES=
GENERATED_FILES= \
task.texi tasksync.texi semaphore.texi eventflags.texi mailbox.texi \
msgbuffer.texi rendezvous.texi interrupt.texi memorypool.texi \
fixedblock.texi time.texi config.texi network.texi
FILES= $(PROJECT).texi \
$(COMMON_FILES) $(GENERATED_FILES)
INFOFILES=$(wildcard $(PROJECT) $(PROJECT)-*)
info: $(FILES) $(PROJECT)
$(PROJECT): $(FILES)
$(MAKEINFO) $(PROJECT).texi
dvi: $(PROJECT).dvi
ps: $(PROJECT).ps
$(PROJECT).ps: $(PROJECT).dvi
dvips -o $(PROJECT).ps $(PROJECT).dvi
$(PROJECT).dvi: $(FILES)
$(TEXI2DVI) $(PROJECT).texi
html: $(FILES)
-mkdir -p html
cp $(wildcard ../tools/*.gif) html
$(TEXI2WWW) $(TEXI2WWW_ARGS) -dir html $(PROJECT).texi
clean:
rm -f *.o $(PROG) *.txt core *.html
rm -f *.dvi *.ps *.log *.aux *.cp *.fn *.ky *.pg *.toc *.tp *.vr $(BASE)
rm -f $(PROJECT) $(PROJECT)-* _* $(GENERATED_FILES)
rm -rf html
task.texi: task.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
tasksync.texi: tasksync.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
semaphore.texi: semaphore.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
eventflags.texi: eventflags.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
mailbox.texi: mailbox.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
msgbuffer.texi: msgbuffer.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
rendezvous.texi: rendezvous.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
interrupt.texi: interrupt.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
memorypool.texi: memorypool.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
fixedblock.texi: fixedblock.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
time.texi: time.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
config.texi: config.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
network.texi: network.t Makefile
$(BMENU) -p "" \
-u "Top" \
-n "" ${*}.t
doc/itron3.0/config.t
+196
View File
@@ -0,0 +1,196 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the system
@c manager.
@c
@c $Id$
@c
@chapter System Manager
@section Introduction
The
system manager is ...
The services provided by the system manager are:
@itemize @bullet
@item @code{get_ver} -
@item @code{ref_sys} -
@item @code{ref_cfg} -
@item @code{def_svc} -
@item @code{def_exc} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the system 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_ver
@c
@page
@subsection get_ver -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int get_ver(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_sys
@c
@page
@subsection ref_sys -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_sys(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_cfg
@c
@page
@subsection ref_cfg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_cfg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c def_svc
@c
@page
@subsection def_svc -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int def_svc(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c def_exc
@c
@page
@subsection def_exc -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int def_exc(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/eventflags.t
+295
View File
@@ -0,0 +1,295 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the eventflags
@c manager.
@c
@c $Id$
@c
@chapter Eventflags Manager
@section Introduction
The
eventflags manager is ...
The services provided by the eventflags manager are:
@itemize @bullet
@item @code{cre_flg} -
@item @code{del_flg} -
@item @code{set_flg} -
@item @code{clr_flg} -
@item @code{wai_flg} -
@item @code{pol_flg} -
@item @code{twai_flg} -
@item @code{ref_flg} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the eventflags 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 cre_flg
@c
@page
@subsection cre_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_flg
@c
@page
@subsection del_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c set_flg
@c
@page
@subsection set_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int set_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c clr_flg
@c
@page
@subsection clr_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int clr_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c wai_flg
@c
@page
@subsection wai_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int wai_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c pol_flg
@c
@page
@subsection pol_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pol_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c twai_flg
@c
@page
@subsection twai_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int twai_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_flg
@c
@page
@subsection ref_flg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_flg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/fixedblock.t
+262
View File
@@ -0,0 +1,262 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the fixed block
@c manager.
@c
@c $Id$
@c
@chapter Fixed Block Manager
@section Introduction
The
fixed block manager is ...
The services provided by the fixed block manager are:
@itemize @bullet
@item @code{cre_mpf} -
@item @code{del_mpf} -
@item @code{get_blf} -
@item @code{pget_blf} -
@item @code{tget_blf} -
@item @code{rel_blf} -
@item @code{ref_mpf} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the fixed block 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 cre_mpf
@c
@page
@subsection cre_mpf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_mpf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_mpf
@c
@page
@subsection del_mpf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_mpf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c get_blf
@c
@page
@subsection get_blf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int get_blf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c pget_blf
@c
@page
@subsection pget_blf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pget_blf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c tget_blf
@c
@page
@subsection tget_blf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tget_blf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rel_blf
@c
@page
@subsection rel_blf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rel_blf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_mpf
@c
@page
@subsection ref_mpf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_mpf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/gen_section
+181
View File
@@ -0,0 +1,181 @@
#
# This shell script generates the starting template for a manager chapter.
#
# Set this based on which chapter you want to generate a template for.
chapter=$1
case ${chapter} in
task)
CHAPTER_CAPS="Task"
CHAPTER_LOWER="task"
ROUTINES=" cre_tsk del_tsk sta_tsk ext_tsk exd_tsk ter_tsk \
dis_dsp ena_dsp chg_pri rot_rdq rel_wai get_tid ref_tsk"
;;
tasksync)
CHAPTER_CAPS="Task-Dependent Synchronization"
CHAPTER_LOWER="task-dependent synchronization"
ROUTINES=" sus_tsk rsm_tsk frsm_tsk \
slp_tsk tslp_tsk wup_tsk can_wup"
;;
semaphore)
CHAPTER_CAPS="Semaphore"
CHAPTER_LOWER="semaphore"
ROUTINES="cre_sem del_sem sig_sem wai_sem preq_sem twai_sem ref_sem "
;;
eventflags)
CHAPTER_CAPS="Eventflags"
CHAPTER_LOWER="eventflags"
ROUTINES=" cre_flg del_flg set_flg clr_flg wai_flg pol_flg \
twai_flg ref_flg "
;;
mailbox)
CHAPTER_CAPS="Mailbox"
CHAPTER_LOWER="mailbox"
ROUTINES="cre_mbx del_mbx snd_msg rcv_msg prcv_msg trcv_msg ref_mbx"
;;
msgbuffer)
CHAPTER_CAPS="Message Buffer"
CHAPTER_LOWER="message buffer"
ROUTINES=" cre_mbf del_mbf snd_mbf psnd_mbf tsnd_mbf rcv_mbf prcv_mbf \
trcv_mbf ref_mbf "
;;
rendezvous)
CHAPTER_CAPS="Rendezvous"
CHAPTER_LOWER="rendezvous"
ROUTINES=" cre_por del_por cal_por pcal_por tcal_por acp_por pacp_por \
tacp_por fwd_por rpl_rdv ref_por"
;;
interrupt)
CHAPTER_CAPS="Interrupt"
CHAPTER_LOWER="interrupt"
ROUTINES=" def_int ret_int ret_wup loc_cpu unl_cpu dis_int ena_int
chg_iXX ref_iXX"
;;
memorypool)
CHAPTER_CAPS="Memory Pool"
CHAPTER_LOWER="memory pool"
ROUTINES=" cre_mpl del_mpl get_blk pget_blk tget_blk rel_blk ref_mpl"
;;
fixedblock)
CHAPTER_CAPS="Fixed Block"
CHAPTER_LOWER="fixed block"
ROUTINES=" cre_mpf del_mpf get_blf pget_blf tget_blf rel_blf ref_mpf"
;;
time)
CHAPTER_CAPS="Time"
CHAPTER_LOWER="time"
ROUTINES=" get_tim set_tim dly_tsk \
def_cyc act_cyc ref_cyc \
def_alm ref_alm ret_tmr"
;;
config)
CHAPTER_CAPS="System"
CHAPTER_LOWER="system"
ROUTINES=" get_ver ref_sys ref_cfg def_svc def_exc"
;;
network)
CHAPTER_CAPS="Network Support"
CHAPTER_LOWER="network support"
ROUTINES=" nrea_dat nwri_dat nget_nod nget_ver"
;;
*)
echo "Unknown chapter name"
exit 1
;;
esac
if [ "x${CHAPTER_CAPS}" = "x" -o "x${CHAPTER_LOWER}" = "x" \
-o "x${ROUTINES}" = "x" ] ; then
echo "initialization problem"
exit 1
fi
echo "@c"
echo "@c This is the chapter from the RTEMS ITRON User's Guide that"
echo "@c documents the services provided by the ${CHAPTER_LOWER}"
echo "@c manager."
echo "@c"
echo "@c \$Id\$"
echo "@c"
echo ""
echo "@chapter ${CHAPTER_CAPS}" Manager
echo ""
echo "@section Introduction"
echo ""
echo "The "
echo "${CHAPTER_LOWER} manager is ..."
echo ""
echo "The services provided by the ${CHAPTER_LOWER} manager are:"
echo ""
echo "@itemize @bullet"
for routine in ${ROUTINES}
do
echo "@item @code{${routine}} - "
done
echo "@end itemize"
echo ""
echo "@section Background"
echo ""
echo "@section Operations"
echo ""
echo "@section Directives"
echo ""
echo "This section details the ${CHAPTER_LOWER} manager's services."
echo "A subsection is dedicated to each of this manager's services"
echo "and describes the calling sequence, related constants, usage,"
echo "and status codes."
echo ""
for routine in ${ROUTINES}
do
echo ""
echo "@c"
echo "@c ${routine}"
echo "@c"
echo ""
echo "@page"
echo "@subsection ${routine} - "
echo ""
echo "@subheading CALLING SEQUENCE:"
echo ""
echo "@ifset is-C"
echo "@example"
echo "int ${routine}("
echo ");"
echo "@end example"
echo "@end ifset"
echo ""
echo "@ifset is-Ada"
echo "@end ifset"
echo ""
echo "@subheading STATUS CODES:"
echo ""
echo "@table @b"
echo "@item E"
echo "The"
echo ""
echo "@end table"
echo ""
echo "@subheading DESCRIPTION:"
echo ""
echo "@subheading NOTES:"
echo ""
done
doc/itron3.0/interrupt.t
+328
View File
@@ -0,0 +1,328 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the interrupt
@c manager.
@c
@c $Id$
@c
@chapter Interrupt Manager
@section Introduction
The
interrupt manager is ...
The services provided by the interrupt manager are:
@itemize @bullet
@item @code{def_int} -
@item @code{ret_int} -
@item @code{ret_wup} -
@item @code{loc_cpu} -
@item @code{unl_cpu} -
@item @code{dis_int} -
@item @code{ena_int} -
@item @code{chg_iXX} -
@item @code{ref_iXX} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the interrupt 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 def_int
@c
@page
@subsection def_int -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int def_int(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ret_int
@c
@page
@subsection ret_int -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ret_int(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ret_wup
@c
@page
@subsection ret_wup -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ret_wup(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c loc_cpu
@c
@page
@subsection loc_cpu -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int loc_cpu(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c unl_cpu
@c
@page
@subsection unl_cpu -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int unl_cpu(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c dis_int
@c
@page
@subsection dis_int -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int dis_int(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ena_int
@c
@page
@subsection ena_int -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ena_int(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c chg_iXX
@c
@page
@subsection chg_iXX -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int chg_iXX(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_iXX
@c
@page
@subsection ref_iXX -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_iXX(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/itron.texi
+145
View File
@@ -0,0 +1,145 @@
\input ../tools/texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename itron
@syncodeindex vr fn
@synindex ky cp
@paragraphindent 0
@c @smallbook
@c %**end of header
@c
@c COPYRIGHT (c) 1988-1998.
@c On-Line Applications Research Corporation (OAR).
@c All rights reserved.
@c
@c $Id$
@c
@c
@c Master file for the ITRON C User's Guide
@c
@c Joel's Questions
@c
@c 1. Why does paragraphindent only impact makeinfo?
@c 2. Why does paragraphindent show up in HTML?
@c
@include ../tools/setup.texi
@ignore
@ifinfo
@format
START-INFO-DIR-ENTRY
* RTEMS ITRON User's Guide: (itron). ITRON Guide
END-INFO-DIR-ENTRY
@end format
@end ifinfo
@end ignore
@c variable substitution info:
@c
@c Note: At the moment there is not an Ada interface to ITRON.
@set is-C
@clear is-Ada
@set LANGUAGE C
@set STRUCTURE structure
@set ROUTINE function
@set OR |
@set RPREFIX RTEMS_
@set DIRPREFIX rtems_
@c the language is @value{LANGUAGE}
@c NOTE: don't use underscore in the name
@c
@c
@c Title Page Stuff
@c
@set edition @value{RTEMS-EDITION}
@set version @value{RTEMS-VERSION}
@c @set update-date @value{RTEMS-UPDATE-DATE}
@c @set update-month @value{RTEMS-UPDATE-MONTH}
@set update-date 17 May 1999
@set update-month May 1999
@c
@c I don't really like having a short title page. --joel
@c
@c @shorttitlepage ITRON User's Guide
@setchapternewpage odd
@settitle ITRON API User's Guide
@titlepage
@finalout
@title RTEMS ITRON User's Guide
@subtitle Edition @value{edition}, for RTEMS @value{version}
@sp 1
@subtitle @value{update-month}
@author UAH CS595
@page
@end titlepage
@c This prevents a black box from being printed on "overflow" lines.
@c The alternative is to rework a sentence to avoid this problem.
@include task.texi
@include tasksync.texi
@include semaphore.texi
@include eventflags.texi
@include mailbox.texi
@include msgbuffer.texi
@include rendezvous.texi
@include interrupt.texi
@include memorypool.texi
@include fixedblock.texi
@include time.texi
@include config.texi
@include network.texi
@ifinfo
@node Top, , (dir), (dir)
@top itron
This is the online version of the RTEMS ITRON API User's Guide
@menu
* Task Manager::
* Task-Dependent Synchronization Manager::
* Semaphore Manager::
* Eventflags Manager::
* Mailbox Manager::
* Message Buffer Manager::
* Rendezvous Manager::
* Interrupt Manager::
* Memory Pool Manager::
* Fixed Block Manager::
* Time Manager::
* System Manager::
* Network Support Manager::
* Command and Variable Index::
* Concept Index::
@end menu
@end ifinfo
@c
@c
@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
@c
@node Command and Variable Index, Concept Index, , Top
@unnumbered Command and Variable Index
There are currently no Command and Variable Index entries.
@c @printindex fn
@node Concept Index, , Command and Variable Index, Top
@unnumbered Concept Index
There are currently no Concept Index entries.
@c @printindex cp
@contents
@bye
doc/itron3.0/mailbox.t
+262
View File
@@ -0,0 +1,262 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the mailbox
@c manager.
@c
@c $Id$
@c
@chapter Mailbox Manager
@section Introduction
The
mailbox manager is ...
The services provided by the mailbox manager are:
@itemize @bullet
@item @code{cre_mbx} -
@item @code{del_mbx} -
@item @code{snd_msg} -
@item @code{rcv_msg} -
@item @code{prcv_msg} -
@item @code{trcv_msg} -
@item @code{ref_mbx} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the mailbox 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 cre_mbx
@c
@page
@subsection cre_mbx -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_mbx(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_mbx
@c
@page
@subsection del_mbx -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_mbx(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c snd_msg
@c
@page
@subsection snd_msg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int snd_msg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rcv_msg
@c
@page
@subsection rcv_msg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rcv_msg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c prcv_msg
@c
@page
@subsection prcv_msg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int prcv_msg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c trcv_msg
@c
@page
@subsection trcv_msg -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int trcv_msg(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_mbx
@c
@page
@subsection ref_mbx -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_mbx(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/memorypool.t
+262
View File
@@ -0,0 +1,262 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the memory pool
@c manager.
@c
@c $Id$
@c
@chapter Memory Pool Manager
@section Introduction
The
memory pool manager is ...
The services provided by the memory pool manager are:
@itemize @bullet
@item @code{cre_mpl} -
@item @code{del_mpl} -
@item @code{get_blk} -
@item @code{pget_blk} -
@item @code{tget_blk} -
@item @code{rel_blk} -
@item @code{ref_mpl} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the memory pool 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 cre_mpl
@c
@page
@subsection cre_mpl -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_mpl(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_mpl
@c
@page
@subsection del_mpl -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_mpl(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c get_blk
@c
@page
@subsection get_blk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int get_blk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c pget_blk
@c
@page
@subsection pget_blk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pget_blk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c tget_blk
@c
@page
@subsection tget_blk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tget_blk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rel_blk
@c
@page
@subsection rel_blk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rel_blk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_mpl
@c
@page
@subsection ref_mpl -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_mpl(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/msgbuffer.t
+328
View File
@@ -0,0 +1,328 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the message buffer
@c manager.
@c
@c $Id$
@c
@chapter Message Buffer Manager
@section Introduction
The
message buffer manager is ...
The services provided by the message buffer manager are:
@itemize @bullet
@item @code{cre_mbf} -
@item @code{del_mbf} -
@item @code{snd_mbf} -
@item @code{psnd_mbf} -
@item @code{tsnd_mbf} -
@item @code{rcv_mbf} -
@item @code{prcv_mbf} -
@item @code{trcv_mbf} -
@item @code{ref_mbf} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the message buffer 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 cre_mbf
@c
@page
@subsection cre_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_mbf
@c
@page
@subsection del_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c snd_mbf
@c
@page
@subsection snd_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int snd_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c psnd_mbf
@c
@page
@subsection psnd_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int psnd_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c tsnd_mbf
@c
@page
@subsection tsnd_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tsnd_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rcv_mbf
@c
@page
@subsection rcv_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rcv_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c prcv_mbf
@c
@page
@subsection prcv_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int prcv_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c trcv_mbf
@c
@page
@subsection trcv_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int trcv_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_mbf
@c
@page
@subsection ref_mbf -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_mbf(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/network.t
+163
View File
@@ -0,0 +1,163 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the network support
@c manager.
@c
@c $Id$
@c
@chapter Network Support Manager
@section Introduction
The
network support manager is ...
The services provided by the network support manager are:
@itemize @bullet
@item @code{nrea_dat} -
@item @code{nwri_dat} -
@item @code{nget_nod} -
@item @code{nget_ver} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the network support 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 nrea_dat
@c
@page
@subsection nrea_dat -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int nrea_dat(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c nwri_dat
@c
@page
@subsection nwri_dat -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int nwri_dat(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c nget_nod
@c
@page
@subsection nget_nod -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int nget_nod(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c nget_ver
@c
@page
@subsection nget_ver -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int nget_ver(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/rendezvous.t
+394
View File
@@ -0,0 +1,394 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the rendezvous
@c manager.
@c
@c $Id$
@c
@chapter Rendezvous Manager
@section Introduction
The
rendezvous manager is ...
The services provided by the rendezvous manager are:
@itemize @bullet
@item @code{cre_por} -
@item @code{del_por} -
@item @code{cal_por} -
@item @code{pcal_por} -
@item @code{tcal_por} -
@item @code{acp_por} -
@item @code{pacp_por} -
@item @code{tacp_por} -
@item @code{fwd_por} -
@item @code{rpl_rdv} -
@item @code{ref_por} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the rendezvous 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 cre_por
@c
@page
@subsection cre_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_por
@c
@page
@subsection del_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c cal_por
@c
@page
@subsection cal_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cal_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c pcal_por
@c
@page
@subsection pcal_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pcal_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c tcal_por
@c
@page
@subsection tcal_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tcal_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c acp_por
@c
@page
@subsection acp_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int acp_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c pacp_por
@c
@page
@subsection pacp_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int pacp_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c tacp_por
@c
@page
@subsection tacp_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int tacp_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c fwd_por
@c
@page
@subsection fwd_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int fwd_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rpl_rdv
@c
@page
@subsection rpl_rdv -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rpl_rdv(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_por
@c
@page
@subsection ref_por -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_por(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/semaphore.t
+262
View File
@@ -0,0 +1,262 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the semaphore
@c manager.
@c
@c $Id$
@c
@chapter Semaphore Manager
@section Introduction
The
semaphore manager is ...
The services provided by the semaphore manager are:
@itemize @bullet
@item @code{cre_sem} -
@item @code{del_sem} -
@item @code{sig_sem} -
@item @code{wai_sem} -
@item @code{preq_sem} -
@item @code{twai_sem} -
@item @code{ref_sem} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the semaphore 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 cre_sem
@c
@page
@subsection cre_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int cre_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c del_sem
@c
@page
@subsection del_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int del_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c sig_sem
@c
@page
@subsection sig_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sig_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c wai_sem
@c
@page
@subsection wai_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int wai_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c preq_sem
@c
@page
@subsection preq_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int preq_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c twai_sem
@c
@page
@subsection twai_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int twai_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_sem
@c
@page
@subsection ref_sem -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_sem(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
doc/itron3.0/task.t
+769
View File
File diff suppressed because it is too large Load Diff
doc/itron3.0/tasksync.t
+263
View File
@@ -0,0 +1,263 @@
@c
@c This is the chapter from the RTEMS ITRON User's Guide that
@c documents the services provided by the task-dependent synchronization
@c manager.
@c
@c $Id$
@c
@chapter Task-Dependent Synchronization Manager
@section Introduction
The
task-dependent synchronization manager is ...
The services provided by the task-dependent synchronization manager are:
@itemize @bullet
@item @code{sus_tsk} -
@item @code{rsm_tsk} -
@item @code{frsm_tsk} -
@item @code{slp_tsk} -
@item @code{tslp_tsk} -
@item @code{wup_tsk} -
@item @code{can_wup} -
@end itemize
@section Background
@section Operations
@section Directives
This section details the task-dependent synchronization 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 sus_tsk
@c
@page
@subsection sus_tsk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int sus_tsk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c rsm_tsk
@c
@page
@subsection rsm_tsk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int rsm_tsk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c frsm_tsk
@c
@page
@subsection frsm_tsk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int frsm_tsk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c slp_tsk
@c
@page
@subsection slp_tsk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int slp_tsk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
This system call puts the issuing task (which was in RUN state) into WAIT state, causing the issuing task to sleep until wup_tsk is invoked.
Since the slp_tsk system call causes the issuing task to enter WAIT state, slp_tsk calls may not be nested. It is possible, however, for another task to execute a sus_tsk on a task which has put itself in WAIT state using slp_tsk. If this happens, the task will enter the combined WAIT-SUSPEND state.
No polling function for slp_tsk is provided. A similar function can be implemented if necessary using can_wup.
@c
@c tslp_tsk
@c
@subsection tslp_tsk -
@subsection tslp_tsk - Sleep Task with Timeout
@subheading CALLING SEQUENCE:
@ifset is-C
int tslp_tsk(
TMO tmout
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@code{E_CTX} - Context error (issued from task-independent portions or a task in dispatch disabled state)
@end table
The tslp_tsk system call is the same as slp_tsk but with an additional timeout feature. If a wup_tsk is issued before the period of time specified by tmout elapses, tslp_tsk will complete normally. An E_TMOUT error will result if no wup_tsk is issued before the time specified by tmout expires. Specifying tmout = TMO_FEVR = -1 can be used to set the timeout period to forever (no timeout). In this case, tslp_tsk will function exactly the same as slp_tsk causing the issuing task to wait forever for wup_tsk to be issued.
Since the tslp_tsk system call causes the issuing task to enter WAIT state, tslp_tsk calls may not be nested. It is possible, however, for another task to execute a sus_tsk on a task which has put itself in WAIT state using tslp_tsk. If this happens, the task will enter the combined WAIT-SUSPEND state.
If you simply wish to delay a task (make it wait for a while), use dly_tsk rather than tslp_tsk.
@c
@c wup_tsk
@c
@subsection wup_tsk -
@subsection wup_tsk - Wakeup Other Task
@subheading CALLING SEQUENCE:
@ifset is-C
int wup_tsk(
ID tskid
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@code{EN_CTXID} - Specified an object on another node when the system call was issued from a task in dispatch disabled state or from a task-independent portion
@end table
If the specified task is not in the WAIT state caused by a slp_tsk or tslp_tsk, the wakeup request based on the wup_tsk call will be queued. In other words, a record will be kept that a wup_tsk has been issued for the specified task and no WAIT state will result even if slp_tsk or tslp_tsk is executed by the task later. This is called queuing for wakeup request.
An E_QOVR error will result if wup_tsk is issued more than the maximum value allowed for the wakeup request queuing count (wupcnt).
@c
@c can_wup
@c
@subsection can_wup -
@subsection can_wup - Cancel Wakeup Request
@subheading CALLING SEQUENCE:
@ifset is-C
int can_wup(
ID tskid
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@code{EN_RPAR} - A value outside the range supported by the issuing node and/or transmission packet format was returned as a return parameter (a value outside supported range was returned for wupcnt)
A task may specify itself by specifying tskid = TSK_SELF = 0. Note, however, that an E_ID error will result if tskid = TSK_SELF = 0 is specified when this system call is issued from a task-independent portion.
doc/itron3.0/time.t
+328
View File
@@ -0,0 +1,328 @@
@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} -
@item @code{set_tim} -
@item @code{dly_tsk} -
@item @code{def_cyc} -
@item @code{act_cyc} -
@item @code{ref_cyc} -
@item @code{def_alm} -
@item @code{ref_alm} -
@item @code{ret_tmr} -
@end itemize
@section Background
@section Operations
@section Directives
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 -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int get_tim(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c set_tim
@c
@page
@subsection set_tim -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int set_tim(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c dly_tsk
@c
@page
@subsection dly_tsk -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int dly_tsk(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c def_cyc
@c
@page
@subsection def_cyc -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int def_cyc(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c act_cyc
@c
@page
@subsection act_cyc -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int act_cyc(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_cyc
@c
@page
@subsection ref_cyc -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_cyc(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c def_alm
@c
@page
@subsection def_alm -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int def_alm(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ref_alm
@c
@page
@subsection ref_alm -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ref_alm(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES:
@c
@c ret_tmr
@c
@page
@subsection ret_tmr -
@subheading CALLING SEQUENCE:
@ifset is-C
@example
int ret_tmr(
);
@end example
@end ifset
@ifset is-Ada
@end ifset
@subheading STATUS CODES:
@table @b
@item E
The
@end table
@subheading DESCRIPTION:
@subheading NOTES: