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

2003-02-18 Joel Sherrill <joel@OARcorp.com>

Browse Source 
* Makefile.am, develenv.texi: Relect generating .texi from .t's.
	* direct.t, sample.t, utils.t: New files.
	* direct.texi, sample.texi, utils.texi: Removed. Now generated from
	corresponding .t files which are in the process of being updated.
	This commit is a anspshot of the update effort.
This commit is contained in:
Joel Sherrill
2003-02-18 16:16:12 +00:00
parent b22fa3ab19
commit aa4142936e
6 changed files with 318 additions and 444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/develenv/ChangeLog
View File

@@ -1,3 +1,10 @@
2003-02-18 Joel Sherrill <joel@OARcorp.com>
* Makefile.am, develenv.texi: Relect generating .texi from .t's.
* direct.t, sample.t, utils.t: New files.
* direct.texi, sample.texi, utils.texi: Removed. Now generated from
corresponding .t files which are in the process of being updated.
This commit is a anspshot of the update effort.
2003-01-25 Ralf Corsepius <corsepiu@faw.uni-ulm.de> 2003-01-25 Ralf Corsepius <corsepiu@faw.uni-ulm.de>
* develenv.texi: Set @setfilename develenv.info. * develenv.texi: Set @setfilename develenv.info.

19
doc/develenv/Makefile.am
View File

@@ -15,8 +15,25 @@ include $(top_srcdir)/main.am
FILES = compile.texi direct.texi intro.texi sample.texi utils.texi FILES = compile.texi direct.texi intro.texi sample.texi utils.texi
GENERATED_FILES = direct.texi sample.texi utils.texi
COMMON_FILES = $(top_srcdir)/common/setup.texi \ COMMON_FILES = $(top_srcdir)/common/setup.texi \
$(top_srcdir)/common/cpright.texi $(top_srcdir)/common/cpright.texi
info_TEXINFOS = develenv.texi info_TEXINFOS = develenv.texi
develenv_TEXINFOS = $(FILES) $(COMMON_FILES) develenv_TEXINFOS = $(FILES) $(COMMON_FILES) $(GENERATED_FILES)
$(srcdir)/direct.texi: direct.t
$(BMENU2) -p "Introduction" \
-u "Top" \
-n "Sample Applications" < $< > $@
$(srcdir)/sample.texi: sample.t
$(BMENU2) -p "Directory Structure Test Suite Source Directory" \
-u "Top" \
-n "RTEMS Specific Utilities" < $< > $@
$(srcdir)/utils.texi: utils.t
$(BMENU2) -p "Sample Applications Paranoia Floating Point Application" \
-u "Top" \
-n "Command and Variable Index" < $< > $@

4
doc/develenv/develenv.texi
View File

@@ -1,6 +1,6 @@
\input texinfo @c -*-texinfo-*- \input texinfo @c -*-texinfo-*-
@c %**start of header @c %**start of header
@setfilename develenv.info @setfilename develenv
@setcontentsaftertitlepage @setcontentsaftertitlepage
@syncodeindex vr fn @syncodeindex vr fn
@synindex ky cp @synindex ky cp
@@ -98,7 +98,7 @@ This is the online version of the RTEMS Development Environment Guide.
@c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here @c Need to copy the emacs stuff and "trailer stuff" (index, toc) into here
@c @c
@node Command and Variable Index, Concept Index, RTEMS Specific Utilities Ada Language Specific Utilities, Top @node Command and Variable Index, Concept Index, RTEMS Specific Utilities size_rtems - report RTEMS size information, Top
@unnumbered Command and Variable Index @unnumbered Command and Variable Index
There are currently no Command and Variable Index entries. There are currently no Command and Variable Index entries.

652
doc/develenv/direct.texi → doc/develenv/direct.t
View File

@@ -6,15 +6,7 @@
@c $Id$ @c $Id$
@c @c
@ifinfo
@node Directory Structure, Directory Structure Suites, Introduction, Top
@end ifinfo
@chapter Directory Structure @chapter Directory Structure
@ifinfo
@menu
* Directory Structure Suites::
@end menu
@end ifinfo
The RTEMS directory structure is designed to meet The RTEMS directory structure is designed to meet
the following requirements: the following requirements:
@@ -24,7 +16,7 @@ the following requirements:
@item isolate processor and target dependent code, while @item isolate processor and target dependent code, while
allowing as much common source code as possible to be shared allowing as much common source code as possible to be shared
across multiple processors and targets. across multiple processors and target boards.
@item allow multiple RTEMS users to perform simultaneous @item allow multiple RTEMS users to perform simultaneous
compilation of RTEMS and its support facilities for different compilation of RTEMS and its support facilities for different
@@ -32,12 +24,14 @@ processors and targets.
@end itemize @end itemize
The resulting directory structure has processor and The resulting directory structure has processor and
target dependent source files isolated from generic files. When board dependent source files isolated from generic files. When
RTEMS is built, object directories and an install point will be RTEMS is configured and built, object directories and
automatically created based upon the target BSP selected. The an install point will be automatically created based upon
placement of object files based upon the selected BSP name the target CPU family and BSP selected.
insures that object files are not mixed across CPUs or targets.
This in combination with the make files allows the specific The placement of object files based upon the selected BSP name
ensures that object files are not mixed across CPUs or targets.
This in combination with the makefiles allows the specific
compilation options to be tailored for a particular target compilation options to be tailored for a particular target
board. For example, the efficiency of the memory subsystem for board. For example, the efficiency of the memory subsystem for
a particular target board may be sensitive to the alignment of a particular target board may be sensitive to the alignment of
@@ -47,323 +41,295 @@ options could specify very strict alignment requirements, while
on the second the data structures could be "packed" to conserve on the second the data structures could be "packed" to conserve
memory. It is impossible to achieve this degree of flexibility memory. It is impossible to achieve this degree of flexibility
without providing source code. without providing source code.
@ifinfo
@node Directory Structure Suites, C Suites, Directory Structure, Directory Structure @c
@end ifinfo @c Directory Organization
@section Suites @c
@ifinfo @section Directory Organization
@menu
* C Suites::
* Executive Source Directory::
* Support Library Source Directory::
* Test Suite Source Directory::
@end menu
@end ifinfo
The RTEMS source tree is organized based on the The RTEMS source tree is organized based on the
following four variables: following variables:
@itemize @bullet @itemize @bullet
@item language,
@item target processor, @item functionality,
@item target processor family,
@item target processor model,
@item peripherals, and
@item target board.
@item target board, and
@item compiler vendor (Ada only).
@end itemize @end itemize
The language may be either C or Ada and there is
currently nothing shared between the source trees for these two
implementations of RTEMS. The user generally selects the
subdirectory for the implementation they are using and ignores
that for the other implementation. The only exceptions to this
normally occurs when comparing the source code for the two
implementations or when porting both to a new CPU or target
board. The following shows the top level RTEMS directory
structure which includes directories for each language
implementation and a language independent source documentation
directory. The source documentation directory is currently not
supported.
@c
@c Tree 1 - Top Level
@c
@ifset use-ascii
@example
@group
RTEMS
|
+-----------------------+-----------------------+
| |
c doc
@end group
@end example
@end ifset
@ifset use-tex
@sp 1
@tex
{\parskip=0pt\offinterlineskip%
\hskip 15.0em
\hskip 1.25em\hbox to 3.00em{\hss{RTEMS}\hss}%
\vrule width0em height1.972ex depth0.812ex\par\penalty10000
\hskip 15.0em
\hskip 2.75em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 0.25em\vrule width2.50em height-0.407ex depth0.500ex%
\vrule width.04em\vrule width2.50em height-0.407ex depth0.500ex%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 0.25em\vrule width.04em%
\hskip 4.92em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 0.00em\hbox to 0.50em{\hss{c}\hss}%
\hskip 1.50em\hbox to 1.50em{\hss{ }\hss}%
\hskip 1.00em\hbox to 1.50em{\hss{doc}\hss}%
\vrule width0em height1.972ex depth0.812ex\par}
@end tex
@end ifset
@c
@c for now continue to use the ascii
@c
@ifset use-html
@example
@group
RTEMS
|
+-----------------------+-----------------------+
| |
c doc
@end group
@end example
@html
@end html
@end ifset
Each of the following sections will describe the Each of the following sections will describe the
contents of the directories in the RTEMS source contents of the directories in the RTEMS source
tree. tree. The top of the tree will be referenced
as @code{$@{RTEMS_ROOT@}} in this discussion.
@ifinfo @c
@node C Suites, Executive Source Directory, Directory Structure Suites, Directory Structure Suites @c Top Level Tree
@end ifinfo @c
@subsection C Suites
The following table lists the suites currently included with the @c @ifset use-ascii
C implementation of RTEMS and the directory in which they may be located: @example
@group
rtems-VERSION
|
+--------+----+----+----+--+-----+---+------+-----+
| | | | | | | | |
aclocal automake c contrib cpukit doc make scripts tools
@end group
@end example
@c @end ifset
@ifset use-tex
@end ifset
@ifset use-html
@html
@end html
@end ifset
@ifset use-texinfo-tables
@table @code @table @code
@item Support Libraries (BSPs, C library, CPU support) @item $@{RTEMS_ROOT@}/aclocal/
$RTEMS_ROOT/c/src/lib This directory contains the custom M4 macros which are available to
the various GNU autoconf @code{configure.ac} scripts throughout
the RTEMS source tree. GNU autoconf interprets @code{configure.ac}
files to produce the @code{configure} files used to tailor
RTEMS build for a particular host and target environment. The
contents of this directory will not be discussed further in this
document.
@item Single Processor Tests @item $@{RTEMS_ROOT@}/automake/
$RTEMS_ROOT/c/src/tests/sptests This directory contains the custom GNU automake fragments
which are used to support the various @code{Makefile.am}
files throughout the RTEMS source tree. The
contents of this directory will not be discussed
further in this document.
@item Timing Tests @item $@{RTEMS_ROOT@}/c/
$RTEMS_ROOT/c/src/tests/tmtests This directory is the root of the portions of the RTEMS source
tree which must be built tailored for a particular CPU model
or BSP. The contents of this directory will be discussed
in the @ref{Directory Structure c/ Directory} section.
@item Multiprocessor Tests @item $@{RTEMS_ROOT@}/contrib/
$RTEMS_ROOT/c/src/tests/mptests This directory contains contributed support software. Currently
this directory contains the RPM specifications for cross-compilers
hosted on GNU/Linux that target Cygwin and Solaris. The
cross-compilers produced using these specifications are then
used in a Canadian cross build procedure to produce the Cygwin
and Solaris hosted RTEMS toolsets on a GNU/Linux host. This
directory will not be discussed further in this document.
@item Sample Applications @item $@{RTEMS_ROOT@}/cpukit/
$RTEMS_ROOT/c/src/tests/samples This directory is the root for all of the "multilib'able"
portions of RTEMS. This is a GNU way of saying the the
contents of this directory can be compiled like the
C Library (@code{libc.a}) and the functionality is
neither CPU model nor BSP specific. The source code
for most RTEMS services reside under this directory.
The contents of this directory will be discussed
in the @ref{Directory Structure CPUKit Directory} section.
@item RTEMS Build Tools @item $@{RTEMS_ROOT@}/doc/
$RTEMS_SRC_BASE/c/build_tools This directory is the root for all RTEMS documentation.
The source for RTEMS is written in GNU TeXinfo and
used to produce HTML, PDF, and "info" files.
The RTEMS documentation is configured, built,
and installed separately from the RTEMS executive and tests.
The contents of this directory will be discussed
in the @ref{Directory Structure Documentation Directory} section.
@item $@{RTEMS_ROOT@}/make/
This directory contains files which support the
RTEMS Makefile's. From a user's perspective, the
most important parts are found in the @code{custom/}
subdirectory. Each ".cfg" file in this directory
is associated with a specific BSP and describes
the CPU model, compiler flags, and procedure to
a produce an executable for the target board.
These files are described in detail in the
@b{RTEMS BSP and Device Driver Development Guide}
and will not be discussed further in this document.
@item $@{RTEMS_ROOT@}/scripts/
This directory contains the RPM specifications for the
prebuilt cross-compilation toolsets provided by the
RTEMS project. There are separate subdirectories
for each of the components in the RTEMS Cross Compilation
Environment including @code{binutils/}, @code{gcc3newlib/},
and @code{gdb/}. This directory is configured, built,
and installed separately from the RTEMS executive
and tests. This directory will not be discussed further
in this document.
@item $@{RTEMS_ROOT@}/tools/
This directory contains RTEMS specific support utilities which
execute on the development host. These utilities are divided
into subdirectories based upon whether they are used in the process
of building RTEMS and applications, are CPU specific, or are
used to assist in updating the RTEMS source tree and applications.
The support utilities used in the process of building RTEMS are
described in @ref{RTEMS Specific Utilities}. These are the
only components of this subtree that will be discussed in this
document.
@item Make Support
$RTEMS_ROOT/c/make
@end table @end table
@end ifset
@ifclear use-texinfo-tables
@html
<CENTER>
<TABLE COLS=2 WIDTH="80%" BORDER=2>
<TR><TD ALIGN=center>Support Libraries (BSPs, C library, CPU support)</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/src/lib</TD></TR>
<TR><TD ALIGN=center>Single Processor Tests</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/src/tests/sptests</TD></TR>
<TR><TD ALIGN=center>Timing Tests</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/src/tests/tmtests</TD></TR>
<TR><TD ALIGN=center>Multiprocessor Tests</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/src/tests/mptests</TD></TR>
<TR><TD ALIGN=center>Sample Applications</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/src/tests/samples</TD></TR>
<TR><TD ALIGN=center>RTEMS Build Tools</TD>
<TD ALIGN=center>$RTEMS_SRC_BASE/c/build_tools</TD></TR>
<TR><TD ALIGN=center>Make Support</TD>
<TD ALIGN=center>$RTEMS_ROOT/c/make</TD></TR>
</TABLE>
</CENTER>
@end html
@end ifclear
The top level directory structure for the C implementation of RTEMS
is as follows:
@c @c
@c Tree 2 - Top C Level @c c/ Directions
@c
@subsection c/ Directory
The @code{$@{RTEMS_ROOT@}/c/} directory was formerly
the root directory of all RTEMS source code. At this time, it contains
the root directory for only those RTEMS components
which must be compiled or linked in a way that is specific to a
particular CPU model or board. This directory contains the
following subdirectories:
@table @code
@item $@{RTEMS_ROOT@}/c/src/
This directory is logically the root for the RTEMS components
which are CPU model or board dependent. Thus this directory
is the root for the BSPs and the various Test Suites as well
as CPU model and BSP dependent libraries. The contents of
this directory are discussed in the
@ref{Directory Structure c/src/ Directory} section.
@item $@{RTEMS_ROOT@}/c/make/
This directory is used to generate the file @code{target.cfg}
which is installed as part of the Application Makefiles. This
file contains settings for various Makefile variables to
tailor them to the particular CPU model and BSP configured.
@end table
@c
@c c/src/ Directory
@c
@subsubsection c/src/ Directory
As mentioned previously, this directory is logically
the root for the RTEMS components
which are CPU model or board dependent. The
following is a list of the subdirectories in this
directorie and a description of each.
@table @code
@item $@{RTEMS_ROOT@}/c/src/ada-tests/
This directory contains the test suite for the Ada
language bindings to the Classic API.
@item $@{RTEMS_ROOT@}/c/src/lib/
@item $@{RTEMS_ROOT@}/c/src/libchip/
This directory contains device drivers for various
peripheral chips which are designed to be CPU and
board dependent. This directory contains a variety
of drivers for serial devices, network interface
controllers, and real-time clocks.
@item $@{RTEMS_ROOT@}/c/src/libmisc/
This directory contains support facilities which
are RTEMS specific but otherwise unclassified. In
general, they do not adhere to a standard API.
Among the support facilities in this directory are
a @code{/dev/null} device driver, the Stack
Overflow Checker, a mini-shell, the CPU and
rate monotonic period usage monitoring libraries,
and a utility to "dump a buffer" in a nicely
formatted way similar to many ROM monitors.
@item $@{RTEMS_ROOT@}/c/src/libnetworking/
This directory contains the networking components which
might be tailored based upon the particular BSP. This
includes the RTEMS telnetd, httpd, and ftpd servers.
@item $@{RTEMS_ROOT@}/c/src/librdbg/
This directory contains the Ethernet-based remote debugging
stub. This software must be built to be intimately aware
of a particular CPU model.
@item $@{RTEMS_ROOT@}/c/src/librtems++/
@item $@{RTEMS_ROOT@}/c/src/make/
@item $@{RTEMS_ROOT@}/c/src/optman/
@item $@{RTEMS_ROOT@}/c/src/tests/
This directory contains the test suites for the
various RTEMS APIs and support libraries. This
contents of this directory are discussed in the
@ref{Directory Structure Test Suites} section.
@item $@{RTEMS_ROOT@}/c/src/wrapup/
@end table
@c
@c Test Suites
@c
@lowersections
@subsubsection Test Suites
The following table lists the test suites currently included with the
RTEMS and the directory in which they may be located:
@table @code
@item @{RTEMS_ROOT@}c/src/tests/itrontests
ITRON API Tests
@item @{RTEMS_ROOT@}c/src/tests/libtests
Support Library Tests
@item @{RTEMS_ROOT@}c/src/tests/mptests
Classic API Multiprocessor Tests
@item @{RTEMS_ROOT@}c/src/tests/psxtests
POSIX API Tests
@item @{RTEMS_ROOT@}c/src/tests/samples
Sample Applications
@item @{RTEMS_ROOT@}c/src/tests/sptests
Classic API Single Processor Tests
@item @{RTEMS_ROOT@}c/src/tests/support
Test Support Software
@item @{RTEMS_ROOT@}c/src/tests/tmitrontests
ITRON API Timing Tests
@item @{RTEMS_ROOT@}c/src/tests/tmtests
Classic API Timing Tests
@item @{RTEMS_ROOT@}c/src/tests/tools
XXX
@end table
@raisesections
@c
@c CPUKit Directory
@c
@subsection CPUKit Directory
The @code{cpukit/} directory structure is as follows:
@c
@c CPUKit Tree
@c @c
@ifset use-ascii @ifset use-ascii
@example @example
@group @group
C CPUKit
|
+----------+-----------+----------+
| | | |
build_tools make src update_tools
@end group
@end example
@end ifset
@ifset use-tex
@sp 1
@tex
{\parskip=0pt\offinterlineskip%
\hskip 08.0em
\hskip 13.00em\hbox to 0.50em{\hss{C}\hss}%
\vrule width0em height1.972ex depth0.812ex\par\penalty10000
\hskip 08.0em
\hskip 13.25em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 08.0em
\hskip 1.75em\vrule width11.50em height-0.407ex depth0.500ex%
\vrule width.04em\vrule width11.50em height-0.407ex depth0.500ex%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 08.0em
\hskip 1.75em\vrule width.04em%
\hskip 5.71em\vrule width.04em%
\hskip 5.71em\vrule width.04em%
\hskip 5.71em\vrule width.04em%
\hskip 5.71em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 08.0em
\hskip 0.00em\hbox to 3.50em{\hss{Modules}\hss}%
\hskip 1.00em\hbox to 6.00em{\hss{build\_tools}\hss}%
\hskip 1.75em\hbox to 2.00em{\hss{make}\hss}%
\hskip 4.00em\hbox to 1.50em{\hss{src}\hss}%
\hskip 1.75em\hbox to 6.50em{\hss{update\_tools}\hss}%
\vrule width0em height1.972ex depth0.812ex\par}
@end tex
@end ifset
@ifset use-html
@example
@group
C
|
+----------+-----------+----------+
| | | |
build_tools make src update_tools
@end group
@end example
@html
@end html
@end ifset
This directory contains the subdirectories which
contain the entire C implementation of the RTEMS executive.
The "build-tools" directory contains an assortment of support tools
for the RTEMS development environment. Two subdirectories exist
under "build-tools" which contain scripts (executables) and
source for the support tools. The "make" directory contains
configuration files and subdirectories which provide a robust
host and cross-target makefile system supporting the building of
the executive for numerous application environments. The
"update_tools" directory contains utilities which aid in the
updating from a previous version to the current version of the
RTEMS executive.
The "src" directory structure for the C implementation of RTEMS is as follows:
@c
@c Tree 3 - Top C src Level
@c
@ifset use-ascii
@example
@group
C Source
|
+-----------------------+-----------------------+
| | |
exec lib tests
@end group
@end example
@end ifset
@ifset use-tex
@sp 1
@tex
{\parskip=0pt\offinterlineskip%
\hskip 15.0em
\hskip 2.00em\hbox to 4.00em{\hss{C Source}\hss}%
\vrule width0em height1.972ex depth0.812ex\par\penalty10000
\hskip 15.0em
\hskip 4.00em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 1.00em\vrule width3.00em height-0.407ex depth0.500ex%
\vrule width.04em\vrule width3.00em height-0.407ex depth0.500ex%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 1.00em\vrule width.04em%
\hskip 2.96em\vrule width.04em%
\hskip 2.96em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 15.0em
\hskip 0.00em\hbox to 2.00em{\hss{exec}\hss}%
\hskip 1.25em\hbox to 1.50em{\hss{lib}\hss}%
\hskip 1.00em\hbox to 2.50em{\hss{tests}\hss}%
\vrule width0em height1.972ex depth0.812ex\par}
@end tex
@end ifset
@ifset use-html
@example
@group
C Source
|
+-----------------------+-----------------------+
| | |
exec lib tests
@end group
@end example
@html
@end html
@end ifset
This directory contains all source files that
comprises the RTEMS executive, supported target board support
packages, and the RTEMS Test Suite.
@ifinfo
@node Executive Source Directory, Support Library Source Directory, C Suites, Directory Structure Suites
@end ifinfo
@subsection Executive Source Directory
The "exec" directory structure for the C implementation is as follows:
@c
@c Tree 4 - C Executive Tree
@c
@ifset use-ascii
@example
@group
C Executive
| |
+-----------+----------+-----------+----------+ +-----------+----------+-----------+----------+
| | | | | | | | | |
@@ -372,64 +338,20 @@ posix rtems sapi score wrapup
@end example @end example
@end ifset @end ifset
@ifset use-tex
@sp 1
@tex
{\parskip=0pt\offinterlineskip%
\hskip 10.0em
\hskip 6.00em\hbox to 5.50em{\hss{C Executive}\hss}%
\vrule width0em height1.972ex depth0.812ex\par\penalty10000
\hskip 10.0em
\hskip 8.75em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 10.0em
\hskip 1.25em\vrule width7.50em height-0.407ex depth0.500ex%
\vrule width.04em\vrule width7.50em height-0.407ex depth0.500ex%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 10.0em
\hskip 1.25em\vrule width.04em%
\hskip 3.71em\vrule width.04em%
\hskip 3.71em\vrule width.04em%
\hskip 3.71em\vrule width.04em%
\hskip 3.71em\vrule width.04em%
\vrule width0em height1.500ex depth0.500ex\par\penalty10000
\hskip 10.0em
\hskip 0.00em\hbox to 2.50em{\hss{posix}\hss}%
\hskip 1.25em\hbox to 2.50em{\hss{rtems}\hss}%
\hskip 1.50em\hbox to 2.00em{\hss{sapi}\hss}%
\hskip 1.50em\hbox to 2.50em{\hss{score}\hss}%
\hskip 1.00em\hbox to 3.00em{\hss{wrapup}\hss}%
\vrule width0em height1.972ex depth0.812ex\par}
@end tex
@end ifset
@ifset use-html
@example
@group
C Executive
|
+-----------+----------+-----------+----------+
| | | | |
posix rtems sapi score wrapup
@end group
@end example
@html
@end html
@end ifset
This directory contains a set of subdirectories which This directory contains a set of subdirectories which
contains the source files comprising the executive portion of contains the source files comprising the executive portion of
the RTEMS development environment. At this point the API the RTEMS development environment as well as portable support
specific and "supercore" source code files are separated into libraries such as support for the C Library and filesystems.
distinct directory trees. The "rtems" and the "posix" The API specific and "SuperCore" (e.g. @code{score/} directory)
subdirectories contain the C language source files for each source code files are separated into
distinct directory trees. The @code{rtems/}, @code{posix/}, and
@code{itron/} subdirectories contain the C language source files for each
module comprising the respective API. Also included in this module comprising the respective API. Also included in this
directory are the subdirectories "sapi" and "score" which are directory are the subdirectories @code{sapi/} and @code{score/} which are
the supercore modules. Within the "score" directory the CPU the SuperCore modules. Within the @code{score/} directory the CPU
dependent modules are found. dependent modules are found.
The "cpu" directory contains a subdirectory for each The @code{score/cpu/} subdirectory contains a subdirectory for each
target CPU supported by the @value{RELEASE} release of the RTEMS target CPU supported by the @value{RELEASE} release of the RTEMS
executive. Each processor directory contains the CPU dependent executive. Each processor directory contains the CPU dependent
code necessary to host RTEMS. The "no_cpu" directory provides a code necessary to host RTEMS. The "no_cpu" directory provides a
@@ -438,9 +360,17 @@ processor. The files contained within the "no_cpu" directory
may also be used as a reference for the other ports to specific may also be used as a reference for the other ports to specific
processors. processors.
@ifinfo
@node Support Library Source Directory, Test Suite Source Directory, Executive Source Directory, Directory Structure Suites @c
@end ifinfo @c
@c
@subsection Documentation Directory
XXX
@c
@c
@c
@subsection Support Library Source Directory @subsection Support Library Source Directory
The "lib" directory contains the support libraries and BSPS. The "lib" directory contains the support libraries and BSPS.
@@ -549,9 +479,9 @@ clock console include ... startup timer
@end html @end html
@end ifset @end ifset
@ifinfo @c
@node Test Suite Source Directory, Sample Applications, Support Library Source Directory, Directory Structure Suites @c
@end ifinfo @c
@subsection Test Suite Source Directory @subsection Test Suite Source Directory
The "tests" directory structure for the C The "tests" directory structure for the C

35
doc/develenv/sample.texi → doc/develenv/sample.t
View File

@@ -6,25 +6,8 @@
@c $Id$ @c $Id$
@c @c
@ifinfo
@node Sample Applications, Sample Applications Introduction, Test Suite Source Directory, Top
@end ifinfo
@chapter Sample Applications @chapter Sample Applications
@ifinfo
@menu
* Sample Applications Introduction::
* Sample Applications Hello World::
* Sample Applications Clock Tick::
* Sample Applications Base Single Processor Application::
* Sample Applications Base Multiple Processor Application::
* Sample Applications Constructor/Destructor C++ Application::
* Sample Applications Paranoia Floating Point Application::
@end menu
@end ifinfo
@ifinfo
@node Sample Applications Introduction, Sample Applications Hello World, Sample Applications, Sample Applications
@end ifinfo
@section Introduction @section Introduction
RTEMS is shipped with the following sample applications: RTEMS is shipped with the following sample applications:
@@ -53,9 +36,6 @@ device drivers.
The reader should be familiar with the terms used and The reader should be familiar with the terms used and
material presented in the RTEMS Applications User's Guide. material presented in the RTEMS Applications User's Guide.
@ifinfo
@node Sample Applications Hello World, Sample Applications Clock Tick, Sample Applications Introduction, Sample Applications
@end ifinfo
@section Hello World @section Hello World
This sample application is in the following directory: This sample application is in the following directory:
@@ -84,9 +64,6 @@ single initialization task. If the above messages are not
printed correctly, then either the BSP start up code or the printed correctly, then either the BSP start up code or the
console output routine is not operating properly. console output routine is not operating properly.
@ifinfo
@node Sample Applications Clock Tick, Sample Applications Base Single Processor Application, Sample Applications Hello World, Sample Applications
@end ifinfo
@section Clock Tick @section Clock Tick
This sample application is in the following directory: This sample application is in the following directory:
@@ -134,9 +111,6 @@ task, TA3, every fifteen seconds. If the time printed does not
match the above output, then the clock device driver is not match the above output, then the clock device driver is not
operating properly. operating properly.
@ifinfo
@node Sample Applications Base Single Processor Application, Sample Applications Base Multiple Processor Application, Sample Applications Clock Tick, Sample Applications
@end ifinfo
@section Base Single Processor Application @section Base Single Processor Application
This sample application is in the following directory: This sample application is in the following directory:
@@ -164,9 +138,6 @@ The first two messages are printed from the
application's single initialization task. The final messages application's single initialization task. The final messages
are printed from the single application task. are printed from the single application task.
@ifinfo
@node Sample Applications Base Multiple Processor Application, Sample Applications Constructor/Destructor C++ Application, Sample Applications Base Single Processor Application, Sample Applications
@end ifinfo
@section Base Multiple Processor Application @section Base Multiple Processor Application
This sample application is in the following directory: This sample application is in the following directory:
@@ -216,9 +187,6 @@ Configuration Table. This file is not shared because the node
number field in the RTEMS Multiprocessor Configuration Table number field in the RTEMS Multiprocessor Configuration Table
must be unique on each node. must be unique on each node.
@ifinfo
@node Sample Applications Constructor/Destructor C++ Application, Sample Applications Paranoia Floating Point Application, Sample Applications Base Multiple Processor Application, Sample Applications
@end ifinfo
@section Constructor/Destructor C++ Application @section Constructor/Destructor C++ Application
This sample application is in the following directory: This sample application is in the following directory:
@@ -265,9 +233,6 @@ Hey I'M in base class constructor number 1 for 0x400010cc.
@end group @end group
@end example @end example
@ifinfo
@node Sample Applications Paranoia Floating Point Application, RTEMS Specific Utilities, Sample Applications Constructor/Destructor C++ Application, Sample Applications
@end ifinfo
@section Paranoia Floating Point Application @section Paranoia Floating Point Application
This sample application is in the following directory: This sample application is in the following directory:

45
doc/develenv/utils.texi → doc/develenv/utils.t
View File

@@ -6,16 +6,7 @@
@c $Id$ @c $Id$
@c @c
@ifinfo
@node RTEMS Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities, Sample Applications Paranoia Floating Point Application, Top
@end ifinfo
@chapter RTEMS Specific Utilities @chapter RTEMS Specific Utilities
@ifinfo
@menu
* RTEMS Specific Utilities C Language Specific Utilities::
* RTEMS Specific Utilities Ada Language Specific Utilities::
@end menu
@end ifinfo
This section describes the additional commands This section describes the additional commands
available within the RTEMS Development Environment. Although available within the RTEMS Development Environment. Although
@@ -101,17 +92,7 @@ For example, ls(1) means see the standard ls command
in section 1 of the UNIX documentation. gcc020(1G) means see in section 1 of the UNIX documentation. gcc020(1G) means see
the description of gcc020 in section 1 of the GNU documentation. the description of gcc020 in section 1 of the GNU documentation.
@ifinfo
@node RTEMS Specific Utilities C Language Specific Utilities, packhex - Compress Hexadecimal File, RTEMS Specific Utilities, RTEMS Specific Utilities
@end ifinfo
@section C Language Specific Utilities @section C Language Specific Utilities
@ifinfo
@menu
* packhex - Compress Hexadecimal File::
* unhex - Convert Hexadecimal File into Binary::
* size_rtems - report RTEMS size information::
@end menu
@end ifinfo
The C language utilities provide a powerful set of The C language utilities provide a powerful set of
tools which combine to allow operations within the RTEMS tools which combine to allow operations within the RTEMS
@@ -120,9 +101,6 @@ effort was devoted to providing as close to the standard UNIX
and GNU style of operations as possible. Each of these and GNU style of operations as possible. Each of these
utilities are described in the section below. utilities are described in the section below.
@ifinfo
@node packhex - Compress Hexadecimal File, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities, RTEMS Specific Utilities C Language Specific Utilities
@end ifinfo
@subsection packhex - Compress Hexadecimal File @subsection packhex - Compress Hexadecimal File
@subheading SYNOPSIS @subheading SYNOPSIS
@@ -166,9 +144,6 @@ issue of Embedded Systems magazine. The code was downloaded
from their BBS. Unfortunately, the author's name was not from their BBS. Unfortunately, the author's name was not
provided in the listing. provided in the listing.
@ifinfo
@node unhex - Convert Hexadecimal File into Binary, size_rtems - report RTEMS size information, packhex - Compress Hexadecimal File, RTEMS Specific Utilities C Language Specific Utilities
@end ifinfo
@subsection unhex - Convert Hexadecimal File into Binary Equivalent @subsection unhex - Convert Hexadecimal File into Binary Equivalent
@subheading SYNOPSIS @subheading SYNOPSIS
@@ -218,9 +193,6 @@ file binary.bin:
unhex -o binary.bin downloadA.sr downloadB.sr unhex -o binary.bin downloadA.sr downloadB.sr
@end example @end example
@ifinfo
@node size_rtems - report RTEMS size information, RTEMS Specific Utilities Ada Language Specific Utilities, unhex - Convert Hexadecimal File into Binary, RTEMS Specific Utilities C Language Specific Utilities
@end ifinfo
@subsection size_rtems - report RTEMS size information @subsection size_rtems - report RTEMS size information
@subheading SYNOPSIS @subheading SYNOPSIS
@@ -293,20 +265,3 @@ mp : 8 0 0
gsize020(1G), gsize386(1G), gsize960(1G) gsize020(1G), gsize386(1G), gsize960(1G)
@ifinfo
@node RTEMS Specific Utilities Ada Language Specific Utilities, Command and Variable Index, size_rtems - report RTEMS size information, RTEMS Specific Utilities
@end ifinfo
@section Ada Language Specific Utilities
The Ada language utilities provide a powerful set of
tools which combine to allow operations within the RTEMS
Development Environment to be consistent and easy to use. Much
effort was devoted to providing as close to the standard UNIX
and GNU style of operations as possible. Each of these
utilities are described in the section below.
NOTE: The Ada implementation is not included in this
release.