From 11be37d1e3d5cf3093f4eceede267d7e903512aa Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Thu, 17 Jun 2010 18:45:36 +0000 Subject: 2010-06-17 Joel Sherrill * Makefile.am, configure.ac, index.html.in, develenv/direct.t, posix_users/gen_size_report, started/nextstep.t, started_ada/buildada.t, user/conf.t, user/object.t: Remove ITRON API. * itron3.0/.cvsignore, itron3.0/Makefile.am, itron3.0/config.t, itron3.0/eventflags.t, itron3.0/fixedblock.t, itron3.0/gen_all, itron3.0/gen_section, itron3.0/gen_status_shell, itron3.0/interrupt.t, itron3.0/itron.texi, itron3.0/mailbox.t, itron3.0/memorypool.t, itron3.0/msgbuffer.t, itron3.0/network.t, itron3.0/preface.texi, itron3.0/rendezvous.t, itron3.0/semaphore.t, itron3.0/stamp-vti, itron3.0/status.t, itron3.0/task.t, itron3.0/tasksync.t, itron3.0/time.t, itron3.0/version.texi: Removed. --- doc/ChangeLog | 14 + doc/Makefile.am | 2 +- doc/configure.ac | 1 - doc/develenv/direct.t | 22 +- doc/index.html.in | 10 - doc/itron3.0/.cvsignore | 37 -- doc/itron3.0/Makefile.am | 102 ----- doc/itron3.0/config.t | 187 -------- doc/itron3.0/eventflags.t | 860 ------------------------------------ doc/itron3.0/fixedblock.t | 389 ----------------- doc/itron3.0/gen_all | 4 - doc/itron3.0/gen_section | 191 -------- doc/itron3.0/gen_status_shell | 230 ---------- doc/itron3.0/interrupt.t | 306 ------------- doc/itron3.0/itron.texi | 144 ------ doc/itron3.0/mailbox.t | 338 -------------- doc/itron3.0/memorypool.t | 401 ----------------- doc/itron3.0/msgbuffer.t | 826 ----------------------------------- doc/itron3.0/network.t | 162 ------- doc/itron3.0/preface.texi | 14 - doc/itron3.0/rendezvous.t | 395 ----------------- doc/itron3.0/semaphore.t | 642 --------------------------- doc/itron3.0/stamp-vti | 4 - doc/itron3.0/status.t | 943 ---------------------------------------- doc/itron3.0/task.t | 767 -------------------------------- doc/itron3.0/tasksync.t | 388 ----------------- doc/itron3.0/time.t | 310 ------------- doc/itron3.0/version.texi | 4 - doc/posix_users/gen_size_report | 20 - doc/started/nextstep.t | 7 +- doc/started_ada/buildada.t | 5 - doc/user/conf.t | 110 ----- doc/user/object.t | 2 +- 33 files changed, 20 insertions(+), 7817 deletions(-) delete mode 100644 doc/itron3.0/.cvsignore delete mode 100644 doc/itron3.0/Makefile.am delete mode 100644 doc/itron3.0/config.t delete mode 100644 doc/itron3.0/eventflags.t delete mode 100644 doc/itron3.0/fixedblock.t delete mode 100644 doc/itron3.0/gen_all delete mode 100644 doc/itron3.0/gen_section delete mode 100644 doc/itron3.0/gen_status_shell delete mode 100644 doc/itron3.0/interrupt.t delete mode 100644 doc/itron3.0/itron.texi delete mode 100644 doc/itron3.0/mailbox.t delete mode 100644 doc/itron3.0/memorypool.t delete mode 100644 doc/itron3.0/msgbuffer.t delete mode 100644 doc/itron3.0/network.t delete mode 100644 doc/itron3.0/preface.texi delete mode 100644 doc/itron3.0/rendezvous.t delete mode 100644 doc/itron3.0/semaphore.t delete mode 100644 doc/itron3.0/stamp-vti delete mode 100644 doc/itron3.0/status.t delete mode 100644 doc/itron3.0/task.t delete mode 100644 doc/itron3.0/tasksync.t delete mode 100644 doc/itron3.0/time.t delete mode 100644 doc/itron3.0/version.texi (limited to 'doc') diff --git a/doc/ChangeLog b/doc/ChangeLog index 3e1fbe06c3..f99d28276b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,17 @@ +2010-06-17 Joel Sherrill + + * Makefile.am, configure.ac, index.html.in, develenv/direct.t, + posix_users/gen_size_report, started/nextstep.t, + started_ada/buildada.t, user/conf.t, user/object.t: Remove ITRON API. + * itron3.0/.cvsignore, itron3.0/Makefile.am, itron3.0/config.t, + itron3.0/eventflags.t, itron3.0/fixedblock.t, itron3.0/gen_all, + itron3.0/gen_section, itron3.0/gen_status_shell, + itron3.0/interrupt.t, itron3.0/itron.texi, itron3.0/mailbox.t, + itron3.0/memorypool.t, itron3.0/msgbuffer.t, itron3.0/network.t, + itron3.0/preface.texi, itron3.0/rendezvous.t, itron3.0/semaphore.t, + itron3.0/stamp-vti, itron3.0/status.t, itron3.0/task.t, + itron3.0/tasksync.t, itron3.0/time.t, itron3.0/version.texi: Removed. + 2010-06-16 Joel Sherrill PR 1568/doc diff --git a/doc/Makefile.am b/doc/Makefile.am index 9995134666..f3e83ab9d6 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,7 +8,7 @@ ACLOCAL_AMFLAGS = -I ../aclocal # + tools, common and images are shared across many documents SUBDIRS = tools started user bsp_howto porting develenv posix_users \ - posix1003.1 filesystem itron3.0 networking ada_user started_ada \ + posix1003.1 filesystem networking ada_user started_ada \ new_chapters relnotes cpu_supplement shell if USE_HTML diff --git a/doc/configure.ac b/doc/configure.ac index 79b8393807..eec59336a9 100644 --- a/doc/configure.ac +++ b/doc/configure.ac @@ -206,7 +206,6 @@ networking/Makefile posix_users/Makefile posix1003.1/Makefile filesystem/Makefile -itron3.0/Makefile ada_user/Makefile started_ada/Makefile relnotes/Makefile diff --git a/doc/develenv/direct.t b/doc/develenv/direct.t index fc0a824efc..de64781a05 100644 --- a/doc/develenv/direct.t +++ b/doc/develenv/direct.t @@ -404,10 +404,6 @@ This directory contains header files which are private to RTEMS and not considered to be owned by any other component in the CPU Kit. -@item $@{RTEMS_ROOT@}/cpukit/itron/ -This directory contains the implementation of the -ITRON API. - @item $@{RTEMS_ROOT@}/cpukit/libblock/ This directory contains support code for using Block Devices such as hard drives, floppies, and @@ -476,8 +472,8 @@ initialization, shutdown, and IO services. @item $@{RTEMS_ROOT@}/cpukit/score/ This directory contains the "SuperCore" of RTEMS. All APIs are implemented in terms of SuperCore services. -For example, Classic API tasks, POSIX threads, and ITRON -tasks are all implemented in terms of SuperCore threads. +For example, Classic API tasks and POSIX threads +are all implemented in terms of SuperCore threads. This provides a common infrastructure and a high degree of interoperability between the APIs. For example, services from all APIs may be used by any task/thread @@ -529,10 +525,6 @@ they may be located: @table @code -@item $@{RTEMS_ROOT@}/testsuites/itrontests/ -This directory contains the test suite for the -RTEMS ITRON API. - @item $@{RTEMS_ROOT@}/testsuites/libtests/ This directory contains the test suite for the various RTEMS support components. @@ -564,16 +556,12 @@ executive code. With the addition of multiple APIs, this is no longer the case as some SuperCore functionality is not available through the Classic API. Thus some functionality in the SuperCore is only covered -by tests in the POSIX API and ITRON API Test Suites. +by tests in the POSIX API Test Suites. @item $@{RTEMS_ROOT@}/testsuites/support/ This directory contains support software and header files for the various test suites. -@item $@{RTEMS_ROOT@}/testsuites/tmitrontests/ -This directory contains the timing test suite for -the RTEMS ITRON API. - @item $@{RTEMS_ROOT@}/testsuites/tmtests/ This directory contains the timing test suite for the RTEMS Classic API. This include tests that @@ -651,10 +639,6 @@ information required by those implementing filesystems. This directory contains the source code for the graphics used in the HTML version of the RTEMS Documentation. -@item $@{RTEMS_ROOT@}/doc/itron3.0/ -This directory contains the source code for the -@cite{RTEMS ITRON 3.0 API User's Guide}. - @item $@{RTEMS_ROOT@}/doc/networking/ This directory contains the source code for the @cite{RTEMS Network Supplement}. diff --git a/doc/index.html.in b/doc/index.html.in index cea0915bae..7a291b2f25 100644 --- a/doc/index.html.in +++ b/doc/index.html.in @@ -40,16 +40,6 @@ RTEMS POSIX API User's Guide -
  • - - - - - - - RTEMS ITRON 3.0 API User's Guide -
    • -
  • diff --git a/doc/itron3.0/.cvsignore b/doc/itron3.0/.cvsignore deleted file mode 100644 index 3b94f81df5..0000000000 --- a/doc/itron3.0/.cvsignore +++ /dev/null @@ -1,37 +0,0 @@ -config.texi -eventflags.texi -fixedblock.texi -index.html -interrupt.texi -itron -itron-? -itron-?? -itron.aux -itron.cp -itron.dvi -itron.fn -itron*.html -itron.info -itron.ky -itron.log -itron.pdf -itron.pg -itron.ps -itron.toc -itron.tp -itron.vr -mailbox.texi -Makefile -Makefile.in -mdate-sh -memorypool.texi -msgbuffer.texi -network.texi -rendezvous.texi -rtems_footer.html -rtems_header.html -semaphore.texi -status.texi -tasksync.texi -task.texi -time.texi diff --git a/doc/itron3.0/Makefile.am b/doc/itron3.0/Makefile.am deleted file mode 100644 index 31b8288780..0000000000 --- a/doc/itron3.0/Makefile.am +++ /dev/null @@ -1,102 +0,0 @@ -# -# COPYRIGHT (c) 1988-2002. -# On-Line Applications Research Corporation (OAR). -# All rights reserved. -# -# $Id$ -# - -PROJECT = itron - -include $(top_srcdir)/project.am -include $(top_srcdir)/main.am - -GENERATED_FILES = status.texi 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 - -COMMON_FILES += $(top_srcdir)/common/cpright.texi - -FILES = preface.texi - -info_TEXINFOS = itron.texi -itron_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES) - -status.texi: status.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -task.texi: task.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -tasksync.texi: tasksync.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -semaphore.texi: semaphore.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -eventflags.texi: eventflags.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -mailbox.texi: mailbox.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -msgbuffer.texi: msgbuffer.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -rendezvous.texi: rendezvous.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -interrupt.texi: interrupt.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -memorypool.texi: memorypool.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -fixedblock.texi: fixedblock.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -time.texi: time.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -config.texi: config.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -network.texi: network.t - $(BMENU2) -p "" \ - -u "Top" \ - -n "" < $< > $@ - -noinst_SCRIPTS = gen_all gen_section gen_status_shell - -EXTRA_DIST = config.t eventflags.t fixedblock.t interrupt.t mailbox.t \ - memorypool.t msgbuffer.t network.t rendezvous.t semaphore.t status.t \ - task.t tasksync.t time.t $(noinst_SCRIPTS) - -CLEANFILES += itron.info itron.info-? diff --git a/doc/itron3.0/config.t b/doc/itron3.0/config.t deleted file mode 100644 index ddfd61fcef..0000000000 --- a/doc/itron3.0/config.t +++ /dev/null @@ -1,187 +0,0 @@ -@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 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} - Get Version Information -@item @code{ref_sys} - Reference Semaphore Status -@item @code{ref_cfg} - Reference Configuration Information -@item @code{def_svc} - Define Extended SVC Handler -@item @code{def_exc} - Define Exception Handler -@end itemize - -@section Background - -@section Operations - -@section System Calls - -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 - Get Version Information - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER get_ver( - T_VER *pk_ver -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{EXXX} - - -@subheading DESCRIPTION: - -@subheading NOTES: - - -@c -@c ref_sys -@c - -@page -@subsection ref_sys - Reference Semaphore Status - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ref_sys( - T_RSYS *pk_rsys -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{EXXX} - - -@subheading DESCRIPTION: - -@subheading NOTES: - - -@c -@c ref_cfg -@c - -@page -@subsection ref_cfg - Reference Configuration Information - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ref_cfg( - T_RCFG *pk_rcfg -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{EXXX} - - -@subheading DESCRIPTION: - -@subheading NOTES: - - -@c -@c def_svc -@c - -@page -@subsection def_svc - Define Extended SVC Handler - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER def_svc( - FN s_fncd, - T_DSVC *pk_dsvc -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{EXXX} - - -@subheading DESCRIPTION: - -@subheading NOTES: - - -@c -@c def_exc -@c - -@page -@subsection def_exc - Define Exception Handler - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER def_exc( - UINT exckind, - T_DEXC *pk_dexc -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{EXXX} - - -@subheading DESCRIPTION: - -@subheading NOTES: - diff --git a/doc/itron3.0/eventflags.t b/doc/itron3.0/eventflags.t deleted file mode 100644 index 1d9d134fe2..0000000000 --- a/doc/itron3.0/eventflags.t +++ /dev/null @@ -1,860 +0,0 @@ -@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 eventflags -@c manager. -@c -@c $Id$ -@c - -@chapter Eventflags Manager - -@section Introduction - -The eventflag manager provides a high performance method of intertask communication and synchronization. The directives provided by the eventflag manager are: - -The services provided by the eventflags manager are: - -@itemize @bullet -@item @code{cre_flg} - Create Eventflag -@item @code{del_flg} - Delete Eventflag -@item @code{set_flg} - Set Eventflag -@item @code{clr_flg} - Clear Eventflag -@item @code{wai_flg} - Wait on Eventflag -@item @code{pol_flg} - Wait for Eventflag (Polling) -@item @code{twai_flg} - Wait on Eventflag with Timeout -@item @code{ref_flg} - Reference Eventflag Status -@end itemize - -@section Background - -@subsection Event sets - -An eventflag is used by a task (or ISR) to inform another task of the -occurrence of a significant situation. One word bit-field is associated with each eventflags. The application developer should remember the -following key characteristics of event operations when utilizing the event -manager: - -@itemize @bullet -@item Events provide a simple synchronization facility. -@item Events are aimed at tasks. -@item Tasks can wait on more than one event simultaneously. -@item Events are independent of one another. -@item Events do not hold or transport data. -@item Events are not queued. In other words, if an event is sent more than once to a task before being received, the second and subsequent send operations to that same task have no effect. -@end itemize - -A pending event is an event that has been set. An -event condition is used to specify the events which the task desires to -receive and the algorithm which will be used to determine when the request -is satisfied. An event condition is satisfied based upon one of two -algorithms which are selected by the user. The @code{TWF_ORW} algorithm -states that an event condition is satisfied when at least a single -requested event is posted. The @code{TWF_ANDW} algorithm states that an -event condition is satisfied when every requested event is posted. - -An eventflags or condition is built by a bitwise OR of the desired events. -If an event is not explicitly specified in the set or condition, then it -is not present. Events are specifically designed to be mutually exclusive, -therefore bitwise OR and addition operations are equivalent as long as -each event appears exactly once in the event set list. - -@subsection T_CFLG Structure - -The T_CFLG structire is used to define the characteristics of an eventflag -and passed as an argument to the @code{cre_flg} service. The structure is -defined as follows: - -@example - -/* - * Create Eventflags (cre_flg) Structure - */ - -typedef struct t_cflg @{ - VP exinf; /* extended information */ - ATR flgatr; /* eventflag attribute */ - UINT iflgptn; /* initial eventflag */ - /* additional implementation dependent information may be included */ -@} T_CFLG; - -/* - * flgatr - Eventflag Attribute Values - */ - - -/* multiple tasks are not allowed to wait (Wait Single Task)*/ - -#define TA_WSGL 0x00 - -/* multiple tasks are allowed to wait (Wait Multiple Task) */ - -#define TA_WMUL 0x08 - -/* wfmode */ -#define TWF_ANDW 0x00 /* AND wait */ -#define TWF_ORW 0x02 /* OR wait */ -#define TWF_CLR 0x01 /* clear specification */ -@end example - -where the meaning of each field is: - -@table @b - -@item exinf - -may be used freely by the user for including extended information about -the eventflag to be created. Information set here may be accessed by -@code{ref_flg}. If a larger region is desired for including user information, or -if the user wishes to change the contents of this information, the usr -should allocate memory area and set the address of this memory packet to -@code{exinf}. The OS does not take care of the contents of @code{exinf}. This -implementation does not use this field. - -@item flgatr - -is the attributes for this eventflag. The lower bits of flgatr represent -system attributes, while the upper bits represent implementation-dependent -attributes. - -@item iflgptn - -is the initial eventflag pattern. -(CPU and/or implementation-dependent information may also be included) - -@end table - -@subsection T_RFLG Structure - -The T_RFLG structire is used to define the characteristics of an eventflag -and passed as an argument to the @code{ref_flg} service. The structure is -defined as follows: - -@example -/* Reference Eventflags (ref_flg) Structure */ -typedef struct t_rflg @{ - VP exinf; /* extended information */ - BOOL_ID wtsk; /* indicates whether or not there is a waiting task */ - UINT flgptn; /* eventflag bit pattern */ - /* additional implementation dependent information may be included */ -@} T_RFLG; -@end example - -@table @b - -@item exinf - -see @code{T_CFLG}. - -@item wtsk - -indicates whether or not there is a task waiting for the eventflag in -question. If there is no waiting task, @code{wtsk} is returned as FALSE = 0. -If there is a waiting task, @code{wtsk} is returned as a value other than 0. - -@item flgptn - -is the eventflag pattern. - -@end table - -@section Operations - -@section System Calls - -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 - Create Eventflag - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER cre_flg( - ID flgid, - T_CFLG *pk_cflg -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_NOMEM} - Insufficient memory (Memory for control block cannot be -allocated) - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_RSATR} - Reserved attribute (flgatr was invalid or could not be -used) - -@code{E_OBJ} - Invalid object state (an eventflag of the same ID already -exists) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (pk_cflg is invalid) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@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 - -@code{EN_PAR}- A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for exinf, flgatr and/or iflgptn) - -@subheading DESCRIPTION: - -This system call creates the eventflag specified by @code{flgid}. -Specifically, a control block for the eventflag to be created is allocated -and the associated flag pattern is initialized using @code{iflgptn}. A -single eventflag handles one word's worth of bits of the processor in -question as a group. All operations are done in single word units. - -User eventflags have positive ID numbers, while system eventflags have -negative ID numbers. User tasks (tasks having positive task IDs) cannot -access system eventflags. An @code{E_OACV} error will result if a user -task issues a system call on a system eventflag, but error detection is -implementation dependent. - -Eventflags having ID numbers from -4 through 0 cannot be created. An -@code{E_ID} error will result if a value in this range is specified for -@code{flgid}. - -The system attribute part of @code{flgatr} may be specified as @code{TA_WSGL} -(Wait Single Task) or @code{TA_WMUL} (Wait Multiple Tasks) - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - -All memory is preallocated for @code{RTEMS ITRON} objects. Thus, no -dynamic memory allocation is performed by @code{cre_flg} and the -@code{E_NOMEM} error can not be returned. - -@c -@c del_flg -@c - -@page -@subsection del_flg - Delete Eventflag - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER del_flg( - ID flgid -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@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 - -@subheading DESCRIPTION: - -This system call deletes the eventflag specified by @code{flgid}. - -Issuing this system call causes memory used for the control block of the -associated eventflag to be released. After this system call is invoked, -another eventflag having the same ID number can be created. - -This system call will complete normally even if there are tasks waiting -for the eventflag. In that case, an @code{E_DLT} error will be returned -to each waiting task. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - -When an eventflag being waited for by more than one tasks is deleted, the -order of tasks on the ready queue after the WAIT state is cleared is -implementation dependent in the case of tasks having the same priority. - -@c -@c set_flg -@c - -@page -@subsection set_flg - Set Eventflag - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER set_flg( - ID flgid, - UINT setptn -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@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 - -@code{EN_PAR} - A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for setptn or clrptn) - -@subheading DESCRIPTION: - -The @code{set_flg} system call sets the bits specified by @code{setptn} of the -one word eventflag specified by @code{flgid}. In other words, a logical -sum is taken for the values of the eventflag specified by @code{flgid} with the -value of @code{setptn}. - -If the eventflag value is changed by @code{set_flg} and the new eventflag -value satisfies the condition to release the WAIT state of the task which -issued @code{wai_flg} on the eventflag, the WAIT state of that task will -be released and the task will be put into RUN or READY state (or SUSPEND -state if the task was in WAIT-SUSPEND). - -Nothing will happen to the target eventflag if all bits of @code{setptn} -are specified as 0 with @code{set_flg}. No error will result in either -case. - -Multiple tasks can wait for a single eventflag if that eventflags has the -@code{TA_WMUL} attribute. This means that even eventflags can make queues -for tasks to wait on. When such eventflags are used, a single -@code{set_flg} call may result in the release of multiple waiting tasks. -In this case, the order of tasks on the ready queue after the WAIT state -is cleared is preserved for tasks having the same priority. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - -@c -@c clr_flg -@c - -@page -@subsection clr_flg - Clear Eventflag - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER clr_flg( - ID flgid, - UINT clrptn -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@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 - -@code{EN_PAR} - A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for setptn or clrptn) - -@subheading DESCRIPTION: - -The @code{clr_flg} system call clears the bits of the one word eventflag -based on the corresponding zero bits of @code{clrptn}. In other words, a -logical product is taken for the values of the eventflag specified by -@code{flgid} with the value of @code{clrptn}. - -Issuing @code{clr_flg} never results in wait conditions being released on -a task waiting for the specified eventflag. In other words, dispatching -never occurs with @code{clr_flg}. - -Nothing will happen to the target eventflag if all bits of @code{clrptn} -are specified as 1 with @code{clr_flg}. No error will result. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - -@c -@c wai_flg -@c - -@page -@subsection wai_flg - Wait on Eventflag - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER wai_flg( - UINT *p_flgptn, - ID flgid, - UINT waiptn, - UINT wfmode -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (waiptn = 0, wfmode invalid, or tmout is -2 -or less) - -@code{E_OBJ} - Invalid object state (multiple tasks waiting for an -eventflag with the TA_WSGL attribute) - -@code{E_DLT} - The object being waited for was deleted (the specified -eventflag was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received -while waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@code{EN_PAR} - A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for waiptn and tmout) - -@code{EN_RPAR} - A value outside the range supported by the requesting -node and/or transmission packet format was specified as a parameter (a -value exceeding the range for the requesting node was specified for -flgptn) - -@subheading DESCRIPTION: - -The @code{wai_flg} system call waits for the eventflag specified by -@code{flgid} to be set to satisfy the wait release condition specified by -@code{wfmode}. The Eventflags bit-pattern will be returned with a pointer @code{p_flgptn}. - -If the eventflag specified by @code{flgid} already satisfies the wait -release conditions given by @code{wfmode}, the issuing task will continue -execution without waiting. @code{wfmode} may be specified as follows. - -@example - wfmode = TWF_ANDW (or TWF_ORW) | TWF_CLR(optional) -@end example - -If @code{TWF_ORW} is specified, the issuing task will wait for any of the -bits specified by @code{waiptn} to be set for the eventflag given by -@code{flgid} (OR wait). If @code{TWF_ANDW} is specified, the issuing task -will wait for all of the bits specified by @code{waiptn} to be set for the -eventflag given by @code{flgid} (AND wait). - -If the @code{TWF_CLR} specification is not present, the eventflag value -will remain unchanged even after the wait conditions have been satisfied -and the task has been released from the WAIT state. If @code{TWF_CLR} is -specified, all bits of the eventflag will be cleared to 0 once the wait -conditions of the waiting task have been satisfied. - -The return parameter @code{flgptn} returns the value of the eventflag after the -wait state of a task has been released due to this system call. If -@code{TWF_CLR} was specified, the value before eventflag bits were cleared -is returned. The value returned by @code{flgptn} fulfills the wait -release conditions of this system call. - -An @code{E_PAR} parameter error will result if @code{waiptn} is 0. - -A task can not execute any of @code{wai_flg, twai_flg} or @code{pol_flg} -on an eventflag having the @code{TA_WSGL} attribute if another task is -already waiting for that eventflag. An @code{E_OBJ} error will be -returned to a task which executes @code{wai_flg} at a later time -regardless as to whether or not the task that executes @code{wai_flg} or -@code{twai_flg} later will be placed in a WAIT state (conditions for -releasing wait state be satisfied). An @code{E_OBJ} error will be -returned even to tasks which just execute @code{pol_flg}, again regardless -as to whether or not wait release conditions for that task were satisfied. - -On the other hand, multiple tasks can wait at the same time for the same -eventflag if that eventflag has the @code{TA_WMUL} attribute. This means -that event flags can make queues for tasks to wait on. When such -eventflags are used, a single @code{set_flg} call may release multiple -waiting tasks. - -The following processing takes place if a queue for allowing multiple -tasks to wait has been created for an eventflag with the @code{TA_WMUL} -attribute. - -@itemize @bullet - -@item The waiting order on the queue is FIFO. (However, depending on -@code{waiptn} and @code{wfmode}, task at the head of the queue will not -always be released from waiting.) - -@item If a task specifying that the eventflag be cleared is on the queue, -the flag is cleared when that task is released from waiting. - -@item Since any tasks behind a task which clears the eventflag (by -specifying @code{TWF_CLR}) will check the eventflag after it is cleared, -they will not be released from waiting. - -@end itemize - -If multiple tasks having the same priority are released from waiting -simultaneously due to @code{set_flg}, the order of tasks on the ready -queue after release will be the same as their original order on the -eventflag queue. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - - -@c -@c pol_flg -@c - -@page -@subsection pol_flg - Wait for Eventflag (Polling) - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER pol_flg( - UINT *p_flgptn, - ID flgid, - UINT waiptn, - UINT wfmode -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (waiptn = 0, wfmode invalid, or tmout is -2 -or less) - -@code{E_OBJ} - Invalid object state (multiple tasks waiting for an -eventflag with the TA_WSGL attribute) - -@code{E_DLT} - The object being waited for was deleted (the specified -eventflag was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received -while waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@code{EN_PAR} - A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for waiptn and tmout) - -@code{EN_RPAR} - A value outside the range supported by the requesting -node and/or transmission packet format was specified as a parameter (a -value exceeding the range for the requesting node was specified for -flgptn) - -@subheading DESCRIPTION: - -The @code{pol_flg} system call has the same function as @code{wai_flg} -except for the waiting feature. @code{pol_flg} polls whether or not the -task should wait if @code{wai_flg} is executed. The meanings of -parameters to @code{pol_flg} are the same as for @code{wai_flg}. The -specific operations by @code{pol_flg} are as follows. - -@itemize @bullet - -@item If the target eventflag already satisfies the conditions for -releasing wait given by @code{wfmode}, processing is the same as -@code{wai_flg}: the eventflag is cleared if @code{TWF_CLR} is specified -and the system call completes normally. - -@item If the target eventflag does not yet satisfy the conditions for -releasing wait given by @code{wfmode}, an @code{E_TMOUT} error is returned to -indicate polling failed and the system call finishes. Unlike -@code{wai_flg}, the issuing task does not wait in this case. The eventflag -is not cleared in this case even if @code{TWF_CLR} has been specified. - -@end itemize - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - - -@c -@c twai_flg -@c - -@page -@subsection twai_flg - Wait on Eventflag with Timeout - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER twai_flg( - UINT *p_flgptn, - ID flgid, - UINT waiptn, - UINT wfmode, - TMO tmout -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (waiptn = 0, wfmode invalid, or tmout is -2 -or less) - -@code{E_OBJ} - Invalid object state (multiple tasks waiting for an -eventflag with the TA_WSGL attribute) - -@code{E_DLT} - The object being waited for was deleted (the specified -eventflag was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received -while waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@code{EN_PAR} - A value outside the range supported by the target node -and/or transmission packet format was specified as a parameter (a value -outside supported range was specified for waiptn and tmout) - -@code{EN_RPAR} - A value outside the range supported by the requesting -node and/or transmission packet format was specified as a parameter (a -value exceeding the range for the requesting node was specified for -flgptn) - -@subheading DESCRIPTION: - -The @code{twai_flg} system call has the same function as @code{wai_flg} -with an additional timeout feature. A maximum wait time (timeout value) -can be specified using the parameter @code{tmout}. When a timeout is specified, -a timeout error, @code{E_TMOUT}, will result and the system call will -finish if the period specified by @code{tmout} elapses without conditions for -releasing wait being satisfied. - -Specifying @code{TMO_POL = 0} to @code{twai_flg} for @code{tmout} indicates that -a timeout value of 0 be used, resulting in exactly the same processing as -@code{pol_flg}. Specifying @code{TMO_FEVR = -1} to @code{twai_flg} for -@code{tmout} indicates that an infinite timeout value be used, resulting in -exactly the same processing as @code{wai_flg}. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - - -@code{Pol_flg} and @code{wai_flg} represent the same processing as -specifying certain values (@code{TMO_POL} or @code{TMO_FEVR}) to -@code{twai_flg} for tmout. As such, only @code{twai_flg} is implemented -in the kernel; @code{pol_flg} and @code{wai_flg} should be implemented as macros -which call @code{twai_flg}. - -@c -@c ref_flg -@c - -@page -@subsection ref_flg - Reference Eventflag Status - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ref_flg( - T_RFLG *pk_rflg, - ID flgid ); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (flgid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the eventflag specified by flgid -does not exist) - -@code{E_OACV} - Object access violation (A flgid less than -4 was -specified from a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (the packet address for the return -parameters could not be used) - -@code{EN_OBJNO} - An object number which could not be accessed on the -target node is specified. - -@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 - -@code{EN_RPAR} - A value outside the range supported by the requesting -node and/or transmission packet format was returned as a parameter (a -value outside supported range was specified for exinf, wtsk and/or flgptn) - -@subheading DESCRIPTION: - -This system call refers to the state of the eventflag specified by -@code{flgid}, and returns its current flag pattern (@code{flgptn}), -waiting task information (@code{wtsk}), and its extended information -(@code{exinf}). - -Depending on the implementation, @code{wtsk} may be returned as the ID -(non-zero) of the task waiting for the eventflag. If there are multiple -tasks waiting for the eventflag (only when attribute is @code{TA_WMUL}), -the ID of the task at the head of the queue is returned. - -An @code{E_NOEXS} error will result if the eventflag specified to -@code{ref_flg} does not exist. - -@subheading NOTES: - -Multiprocessing is not supported. Thus none of the "@code{EN_}" status -codes will be returned. - -Although both @code{ref_flg} and @code{pol_flg} can be used to find an -eventflag's pattern (@code{flgptn}) without causing the issuing task to -wait, @code{ref_flg} simply reads the eventflag's pattern (@code{flgptn}) -while @code{pol_flg} functions is identical to @code{wai_flg} when wait -release conditions are satisfied (it clears the eventflag if -@code{TWF_CLR} is specified). - -Depending on the implementation, additional information besides -@code{wtsk} and @code{flgptn} (such as eventflag attributes, -@code{flgatr}) may also be referred. diff --git a/doc/itron3.0/fixedblock.t b/doc/itron3.0/fixedblock.t deleted file mode 100644 index 97270e2636..0000000000 --- a/doc/itron3.0/fixedblock.t +++ /dev/null @@ -1,389 +0,0 @@ -@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 fixed block -@c manager. -@c -@c $Id$ -@c - -@chapter Fixed Block Manager - -@section Introduction - -The fixed block manager provides functions for creating, deleting, getting, polling, getting with timeout, releasing, and referencing the fixed-sized memorypool. This manager is based on ITRON 3.0 standard. - -The services provided by the fixed block manager are: - -@itemize @bullet -@item @code{cre_mpf} - Create Fixed-Size Memorypool -@item @code{del_mpf} - Delete Fixed-Size Memorypool -@item @code{get_blf} - Get Fixed-Size Memory Block -@item @code{pget_blf} - Poll and Get Fixed-Size Memory Block -@item @code{tget_blf} - Get Fixed-Size Memory Block with Timeout -@item @code{rel_blf} - Release Fixed-Size Memory Block -@item @code{ref_mpf} - Reference Fixed-Size Memorypool Status -@end itemize - -@section Background - -@section Operations - -@section System Calls - -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 - Create Fixed-Size Memorypool - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER cre_mpf( - ID mpfid, - T_CMPF *pk_cmpf -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_NOMEM} - Insufficient memory (Memory for control block and/or for -memorypool cannot be allocated) - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_RSATR} - Reserved attribute (mpfatr was invalid or could not be used) - -@code{E_OBJ} - Invalid object state (a memorypool of the same ID already exists) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (pk_cmpf is invalid or mpfsz and/or blfsz is -negative or invalid) - -@subheading DESCRIPTION: - -This system call creates a fixed-size memorypool having the ID number specified by mpfid. Specifically, a memory area of a size based on values of mpfcnt and blfsz is reserved for use as a memorypool. A control block for the memorypool being created is also allocated. The get_blf system call specifying the memorypool created by this call can be issued to allocate memory blocks of the size given by blfsz (in bytes). - -@subheading NOTES: - -The memory area required for creating memorypools and for allocating control blocks for each object is allocated while system initialization. Associated parameters are therefore specified at system configuration. - -@c -@c del_mpf -@c - -@page -@subsection del_mpf - Delete Fixed-Size Memorypool - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER del_mpf( - ID mpfid -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the memorypool specified by mpfid does not exist) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from a user task. This is implementation dependent.) - -@subheading DESCRIPTION: - -This system call deletes the fixed-size memorypool specified by mpfid. No check or error report is performed even if there are tasks using memory from the memorypool to be deleted. This system call completes normally even if some of the memory blocks are not returned. Issuing this system call causes memory used for the control block of the associated memorypool and the memory area making up the memorypool itself to be released. After this system call is invoked, another memorypool having the same ID number can be created. This system call will complete normally even if there are tasks waiting to get memory blocks from the memorypool. In that case, an E_DLT error will be returned to each waiting task. - -@subheading NOTES: - -When a memorypool being waited for by more than one tasks is deleted, the order of tasks on the ready queue after the WAIT state is cleared is implementation dependent in the case of tasks having the same priority. - - -@c -@c get_blf -@c - -@page -@subsection get_blf - Get Fixed-Size Memory Block - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER get_blf( - VP *p_blf, - ID mpfid -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the memorypool specified by mpfid does not exist) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (tmout is -2 or less) - -@code{E_DLT} - The object being waited for was deleted (the specified memorypool -was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received while -waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state; implementation dependent for pget_blf and tget_blf(tmout=TMO_POL)) - -@subheading DESCRIPTION: - -A memory block is allocated from the fixed-size memorypool specified by mpfid. The start address of the memory block allocated is returned to blf. The size of the memory block allocated is specified by the blfsz parameter when the fixed-size memorypool was created. The allocated memory block is not cleared to zero. The contents of the allocated memory block are undefined. If the memory block cannot be obtained from the specified memorypool when get_blf is issued, the task issuing get_blf will be placed on the memory allocation queue of the specified memorypool, and wait until it can get the memory it requires. If the object being waited for is deleted (the specified memorypool is deleted while waiting), an E_DLT error will be returned. - -@subheading NOTES: - -NONE - - -@c -@c pget_blf -@c - -@page -@subsection pget_blf - Poll and Get Fixed-Size Memory Block - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ercd =pget_blf( - VP *p_blf, - ID mpfid -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the memorypool specified by mpfid does not exist) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (tmout is -2 or less) - -@code{E_DLT} - The object being waited for was deleted (the specified memorypool -was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received while -waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state; implementation dependent for pget_blf and tget_blf(tmout=TMO_POL)) - -@subheading DESCRIPTION: - -The pget_blf system call has the same function as get_blf except for the waiting feature. Pget_blf polls whether or not the task should wait if get_blf is executed. The meaning of parameters to pget_blf are the same with get_blf. The specific operations by pget_blf are as follows. - - - If there is a free memory block available, processing is the same as - get_blf: that is, the requested memory is allocated and the system call - completes normally. - - - If there is no free memory block, an E_TMOUT error is returned to - indicate polling failed and the system call finishes. Unlike get_blf, - the issuing task does not wait in this case. Also, the issuing task - does not get any memory. - -@subheading NOTES: - -NONE - - -@c -@c tget_blf -@c - -@page -@subsection tget_blf - Get Fixed-Size Memory Block with Timeout - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ercd =tget_blf( - VP *p_blf, - ID mpfid, - TMO tmout -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the memorypool specified by mpfid does not exist) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (tmout is -2 or less) - -@code{E_DLT} - The object being waited for was deleted (the specified memorypool -was deleted while waiting) - -@code{E_RLWAI} - WAIT state was forcibly released (rel_wai was received while -waiting) - -@code{E_TMOUT} - Polling failure or timeout exceeded - -@code{E_CTX} - Context error (issued from task-independent portions or a -task in dispatch disabled state; implementation dependent for pget_blf and tget_blf(tmout=TMO_POL)) - -@subheading DESCRIPTION: - -The tget_blf system call has the same function as get_blf with an additional timeout feature. A maximum wait time (timeout value) can be specified using the parameter tmout. When a timeout is specified, a timeout error, E_TMOUT, will result and the system call will finish if the period specified by tmout elapses without conditions for releasing wait being satisfied (i.e. without free memory becoming available). - -@subheading NOTES: - -NONE - -@c -@c rel_blf -@c - -@page -@subsection rel_blf - Release Fixed-Size Memory Block - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER rel_blf( - ID mpfid, - VP blf -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist (the memorypool specified by mpfid does not exist) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (blf is invalid or an attempt was made to return -the memory block to the wrong memorypool) - -@subheading DESCRIPTION: - -This system call releases the memory block specified by blf and returns it to the fixed-size memorypool specified by mpfid. Executing rel_blf allows memory to be allocated to the next task waiting for memory allocation from the memorypool given by mpfid, thus releasing that task from its WAIT state. - -@subheading NOTES: - -The fixed-size memorypool to which the memory block is returned must be the same memorypool from which it was originally allocated. An E_PAR error will result if an attempt is made to return a memory block to another memorypool than that from which it was originally allocated. - -@c -@c ref_mpf -@c - -@page -@subsection ref_mpf - Reference Fixed-Size Memorypool Status - -@subheading CALLING SEQUENCE: - -@ifset is-C -@example -ER ref_mpf( - T_RMPF *pk_rmpf, - ID mpfid -); -@end example -@end ifset - -@ifset is-Ada -@end ifset - -@subheading STATUS CODES: - -@code{E_OK} - Normal Completion - -@code{E_ID} - Invalid ID number (mpfid was invalid or could not be used) - -@code{E_NOEXS} - Object does not exist \(the memorypool specified by mpfid does -not exist.) - -@code{E_OACV} - Object access violation (A mpfid less than -4 was specified from -a user task. This is implementation dependent.) - -@code{E_PAR} - Parameter error (the packet address for the return parameters -could not be used) - -@subheading DESCRIPTION: - -This system call refers to the state of the fixed-size memorypool specified by mpfid, and returns the current number of free blocks (frbcnt), information of a task waiting to be allocated memory (wtsk), and its extended information (exinf). Wtsk indicates whether or not there is a task waiting to be allocated memory from the fixed-size memorypool specified. If there is no waiting task, wtsk is returned as FALSE = 0. If there is a waiting task, wtsk is returned as a value other than 0. - -@subheading NOTES: - -While the frsz return parameter of ref_mpl returns the total size of free memory, the frbcnt return parameter of ref_mpf returns the number of free blocks. - -Depending on the implementation, additional information besides wtsk and frbcnt (such as memorypool attributes, mpfatr) may also be referred. - diff --git a/doc/itron3.0/gen_all b/doc/itron3.0/gen_all deleted file mode 100644 index 6e4e66893f..0000000000 --- a/doc/itron3.0/gen_all +++ /dev/null @@ -1,4 +0,0 @@ -for i in config eventflags fixedblock interrupt mailbox memorypool msgbuffer network rendezvous task tasksync time -do - sh ./gen_section $i | tr -d "\r" >${i}.t -done diff --git a/doc/itron3.0/gen_section b/doc/itron3.0/gen_section deleted file mode 100644 index cdc1c80f2c..0000000000 --- a/doc/itron3.0/gen_section +++ /dev/null @@ -1,191 +0,0 @@ -# -# 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" - ;; - psxtimer) - CHAPTER_CAPS="Timer" - CHAPTER_LOWER="timer" - ROUTINES="timer_create timer_delete timer_settime timer_gettime timer_getoverrun" - ;; - *) - 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 - description=`grep " ${routine} " ../../itron_spec/itron3-1.txt | grep "]" | cut -d']' -f2 ` - description=`echo ${description}` - echo "@item @code{${routine}} - ${description}" -done -echo "@end itemize" - -echo "" -echo "@section Background" -echo "" -echo "@section Operations" -echo "" -echo "@section System Calls" -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 - description=`grep ${routine} ../../itron_spec/itron3-1.txt | grep "]" | cut -d']' -f2` - description=`echo -n ${description}` - echo "" - echo "@c" - echo "@c ${routine}" - echo "@c" - echo "" - echo "@page" - echo "@subsection ${routine} - " ${description} - echo "" - echo "@subheading CALLING SEQUENCE:" - echo "" - echo "@ifset is-C" - echo "@example" - proto=`grep "${routine} (" ../../itron_spec/itron3-6.txt | sed -e 's/ercd = //'` # | sed -e 's/ \\(/(/'` - - echo `echo -n ${proto} | cut -d'(' -f1`"(" - echo ${proto} | cut -d'(' -f2 | sed -e 's/ .;//' - echo ");" - # 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 "@code{EXXX} - " - echo "" - echo "@subheading DESCRIPTION:" - echo "" - echo "@subheading NOTES:" - echo "" -done - diff --git a/doc/itron3.0/gen_status_shell b/doc/itron3.0/gen_status_shell deleted file mode 100644 index 1f3f8e4c47..0000000000 --- a/doc/itron3.0/gen_status_shell +++ /dev/null @@ -1,230 +0,0 @@ -# -# This shell script generates the starting template for a manager chapter. -# - -FILES="task tasksync semaphore eventflags mailbox msgbuffer rendezvous interrupt memorypool fixedblock time config network" - - -cat <