forked from Imagelibrary/rtems
231 lines
6.2 KiB
Plaintext
231 lines
6.2 KiB
Plaintext
#
|
|
# 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 <<EOF
|
|
@c
|
|
@c This is the chapter from the RTEMS ITRON User's Guide that
|
|
@c documents the services provided by the task
|
|
@c manager.
|
|
@c
|
|
@c $Id$
|
|
@c
|
|
|
|
@chapter ITRON Implementation Status
|
|
|
|
@section Introduction
|
|
|
|
This chapter describes the status of the implementation of each
|
|
manager in the RTEMS implementataion of the uITRON 3.0 API. The
|
|
status of each manager is presented in terms of documentation and
|
|
status relative to the extended level (level 'E') of the uITRON 3.0
|
|
API specification. The extended level of the specification is
|
|
the level at which dynamic object creation, deletion, and
|
|
reference services are available. This level is more akin to the other
|
|
APIs supported by RTEMS. This purpose of this chapter is
|
|
to make it clear what is required to bring the RTEMS
|
|
uITRON API implementation into compliance with the
|
|
specification. The following description of the specification
|
|
levels is taken from the uITRON 3.0 API specification.
|
|
|
|
|
|
uITRON 3.0 specification is divided into fewer system call levels than was the
|
|
previous uITRON 2.0 specification. There are now just three levels: Level R
|
|
(Required), Level S (Standard) and Level E (Extended). In addition to these
|
|
three levels, there is also Level C for CPU-dependent system calls.
|
|
In addition, the uITRON 3.0 API, defines the network level ('N') which
|
|
represents system calls that support the connection function
|
|
|
|
@itemize @bullet
|
|
@item [level R] (Required)
|
|
The functions in this level are mandatory for all implementations of
|
|
uITRON 3.0 specification. This includes basic functions for achieving
|
|
a real-time, multitasking OS. These functions can be implemented even
|
|
without a hardware timer. This level corresponds to Levels 1 and 2
|
|
of uITRON 2.0 specification.
|
|
|
|
@item [level S] (Standard)
|
|
This includes basic functions for achieving a real-time, multitasking
|
|
OS. This level corresponds to Levels 3 and 4 of uITRON 2.0
|
|
specification.
|
|
|
|
@item [level E] (Extended)
|
|
This includes additional and extended functions. This corresponds to
|
|
functions not included in uITRON 2.0 specification (functions of
|
|
ITRON2 specification). Specifically, this level includes object
|
|
creation and deletion functions, rendezvous functions, memorypools
|
|
and the timer handler.
|
|
|
|
@item [level C] (CPU dependent)
|
|
This level provides implementation-dependent functions required due to
|
|
the CPU or hardware configuration.
|
|
|
|
@end itemize
|
|
|
|
The support level of the connection function is indicated by appending an 'N'
|
|
to the end of the level. For example, connectivity supported at [level S]
|
|
would be referred to as [level SN]. The support level for functions which
|
|
can only send requests for operations on other nodes but offer no system call
|
|
processing on the issuing node itself are indicated by the lower case letter
|
|
's' or 'e'.
|
|
|
|
|
|
EOF
|
|
|
|
|
|
for chapter in $FILES
|
|
do
|
|
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
|
|
|
|
echo "@c"
|
|
echo "@c ${CHAPTER_CAPS}"
|
|
echo "@c"
|
|
echo
|
|
echo "@section ${CHAPTER_CAPS} Status"
|
|
cat <<EOF
|
|
|
|
@itemize @bullet
|
|
|
|
@item Implementation
|
|
@itemize @bullet
|
|
EOF
|
|
|
|
for routine in ${ROUTINES}
|
|
do
|
|
echo "@item ${routine} - Stub, Needs to be Fleshed Out"
|
|
done
|
|
cat <<EOF
|
|
@end itemize
|
|
|
|
@item Executive Modifications
|
|
@itemize @bullet
|
|
@item None Expected
|
|
@end itemize
|
|
|
|
@item Testing
|
|
@itemize @bullet
|
|
@item No Tests Written
|
|
@end itemize
|
|
|
|
@item Documentation
|
|
@itemize @bullet
|
|
@item Shell, Needs to be Fleshed Out
|
|
@end itemize
|
|
|
|
@item ITRON 3.0 API Conformance
|
|
@itemize @bullet
|
|
@item Level E - Extended Functionality
|
|
@itemize @bullet
|
|
@item
|
|
@end itemize
|
|
|
|
@item Level C - CPU Dependent Functionality
|
|
@itemize @bullet
|
|
@item NA
|
|
@end itemize
|
|
|
|
@item Level N - Connection Functionality
|
|
@itemize @bullet
|
|
@item Not implemented
|
|
@end itemize
|
|
@end itemize
|
|
|
|
@end itemize
|
|
|
|
EOF
|
|
done
|