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

2007-11-27 Joel Sherrill <joel.sherrill@OARcorp.com>

Browse Source 
* develenv/develenv.texi, develenv/direct.t, develenv/intro.texi,
	develenv/sample.t, develenv/utils.t: Update directory tree.
This commit is contained in:
Joel Sherrill
2007-11-27 19:30:59 +00:00
parent 5d55a0b242
commit d9779bda42
6 changed files with 192 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ChangeLog
View File

@@ -1,3 +1,8 @@
2007-11-27 Joel Sherrill <joel.sherrill@OARcorp.com>
* develenv/develenv.texi, develenv/direct.t, develenv/intro.texi,
develenv/sample.t, develenv/utils.t: Update directory tree.
2007-11-27 Joel Sherrill <joel.sherrill@oarcorp.com> 2007-11-27 Joel Sherrill <joel.sherrill@oarcorp.com>
* user/conf.t: Add CONFIGURE_APPLICATION_EXTRA_DRIVERS. * user/conf.t: Add CONFIGURE_APPLICATION_EXTRA_DRIVERS.

4
doc/develenv/develenv.texi
View File

@@ -8,7 +8,7 @@
@c %**end of header @c %**end of header
@c @c
@c COPYRIGHT (c) 1988-2002. @c COPYRIGHT (c) 1989-2007.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@c @c
@@ -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 size_rtems - report RTEMS size information, Top @node Command and Variable Index, Concept Index, RTEMS Specific Utilities unhex - Convert Hexadecimal File into Binary Equivalent, 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.

306
doc/develenv/direct.t
View File

@@ -1,5 +1,5 @@
@c @c
@c COPYRIGHT (c) 1988-2002. @c COPYRIGHT (c) 1989-2007.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@c @c
@@ -68,9 +68,9 @@ as @code{$@{RTEMS_ROOT@}} in this discussion.
@group @group
rtems-VERSION rtems-VERSION
| |
+--------+----+----+----+--+-----+---+------+-----+ +--------+----+----+----+--+-----+---+-------+--------+
| | | | | | | | | | | | | | | | | |
aclocal automake c contrib cpukit doc make scripts tools aclocal automake c contrib cpukit doc make testsuites tools
@end group @end group
@end example @end example
@c @end ifset @c @end ifset
@@ -109,11 +109,21 @@ in the @ref{Directory Structure c/ Directory} section.
@item $@{RTEMS_ROOT@}/contrib/ @item $@{RTEMS_ROOT@}/contrib/
This directory contains contributed support software. Currently This directory contains contributed support software. Currently
this directory contains the RPM specifications for cross-compilers this directory contains the RPM specifications for cross-compilers
hosted on GNU/Linux that target Cygwin and Solaris. The hosted on GNU/Linux that target various operating systems
including MinGW, Cygwin, FreeBSD, and Solaris. The
cross-compilers produced using these specifications are then cross-compilers produced using these specifications are then
used in a Canadian cross build procedure to produce the Cygwin used in a Canadian cross build procedure to produce the various
and Solaris hosted RTEMS toolsets on a GNU/Linux host. This RTEMS toolsets on a GNU/Linux host.
directory will not be discussed further in this document.
This directory also contains 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 unde the @code{contrib/crossrpms/} directory.
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@}/cpukit/ @item $@{RTEMS_ROOT@}/cpukit/
This directory is the root for all of the "multilib'able" This directory is the root for all of the "multilib'able"
@@ -123,7 +133,7 @@ C Library (@code{libc.a}) and the functionality is
neither CPU model nor BSP specific. The source code neither CPU model nor BSP specific. The source code
for most RTEMS services reside under this directory. for most RTEMS services reside under this directory.
The contents of this directory will be discussed The contents of this directory will be discussed
in the @ref{Directory Structure CPUKit Directory} section. in the @ref{Directory Structure CPU Kit Directory} section.
@item $@{RTEMS_ROOT@}/doc/ @item $@{RTEMS_ROOT@}/doc/
This directory is the root for all RTEMS documentation. This directory is the root for all RTEMS documentation.
@@ -146,16 +156,11 @@ These files are described in detail in the
@b{RTEMS BSP and Device Driver Development Guide} @b{RTEMS BSP and Device Driver Development Guide}
and will not be discussed further in this document. and will not be discussed further in this document.
@item $@{RTEMS_ROOT@}/scripts/ @item $@{RTEMS_ROOT@}/testsuites/
This directory contains the RPM specifications for the This directory contains the test suites for the
prebuilt cross-compilation toolsets provided by the various RTEMS APIs and support libraries. This
RTEMS project. There are separate subdirectories contents of this directory are discussed in the
for each of the components in the RTEMS Cross Compilation @ref{Directory Structure testsuites/ Test Suites} section.
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/ @item $@{RTEMS_ROOT@}/tools/
This directory contains RTEMS specific support utilities which This directory contains RTEMS specific support utilities which
@@ -188,7 +193,7 @@ following subdirectories:
@item $@{RTEMS_ROOT@}/c/src/ @item $@{RTEMS_ROOT@}/c/src/
This directory is logically the root for the RTEMS components This directory is logically the root for the RTEMS components
which are CPU model or board dependent. Thus this directory which are CPU model or board dependent. Thus this directory
is the root for the BSPs and the various Test Suites as well is the root for the BSPs and the Ada Test Suites as well
as CPU model and BSP dependent libraries. The contents of as CPU model and BSP dependent libraries. The contents of
this directory are discussed in the this directory are discussed in the
@ref{Directory Structure c/src/ Directory} section. @ref{Directory Structure c/src/ Directory} section.
@@ -213,6 +218,10 @@ following is a list of the subdirectories in this
directorie and a description of each. directorie and a description of each.
@table @code @table @code
@item $@{RTEMS_ROOT@}/c/src/ada/
This directory contains the Ada95 language bindings to the
RTEMS Classic API.
@item $@{RTEMS_ROOT@}/c/src/ada-tests/ @item $@{RTEMS_ROOT@}/c/src/ada-tests/
This directory contains the test suite for the Ada This directory contains the test suite for the Ada
language bindings to the Classic API. language bindings to the Classic API.
@@ -242,22 +251,6 @@ board dependent. This directory contains a variety
of drivers for serial devices, network interface of drivers for serial devices, network interface
controllers, and real-time clocks. 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/librtems++/ @item $@{RTEMS_ROOT@}/c/src/librtems++/
This directory contains C++ classes which map to the RTEMS This directory contains C++ classes which map to the RTEMS
Classic API. Classic API.
@@ -275,12 +268,6 @@ may be explicitly forbidden by an application. All of the
directive implementations in this Optional Managers directive implementations in this Optional Managers
return @code{E_NOTCONFIGURED}. return @code{E_NOTCONFIGURED}.
@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 c/src/tests/ Test Suites} section.
@item $@{RTEMS_ROOT@}/c/src/wrapup/ @item $@{RTEMS_ROOT@}/c/src/wrapup/
This directory is responsible for taking the individual This directory is responsible for taking the individual
libraries and objects built in each of the components libraries and objects built in each of the components
@@ -343,106 +330,20 @@ clock console include shmsupp startup timer
@c @end ifset @c @end ifset
@c @c
@c c/src/tests/ Test Suites @c CPU Kit Directory
@c @c
@subsection c/src/tests/ Test Suites @section CPU Kit Directory
This directory provides all of the RTEMS Test Suite
except those for the Classic API Ada95 binding
This includes the single processor tests, multiprocessor tests,
timing tests, library tests, and sample tests. Additionally,
subdirectories for support functions and test related header
files are provided. 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/
This directory contains the test suite for the
RTEMS ITRON API.
@item $@{RTEMS_ROOT@}/c/src/tests/libtests/
This directory contains the test suite for the
various RTEMS support components.
@item $@{RTEMS_ROOT@}/c/src/tests/mptests/
This directory contains the test suite for the
multiprocessor support in the Classic API.
The tests provided address two node configurations
and provide coverage for the multiprocessor code found
in RTEMS.
@item $@{RTEMS_ROOT@}/c/src/tests/psxtests/
This directory contains the test suite for the
RTEMS POSIX API.
@item $@{RTEMS_ROOT@}/c/src/tests/samples/
This directory provides sample application tests
which aid in the testing a newly built RTEMS environment, a new
BSP, or as starting points for the development of an application
using the RTEMS executive. They are discussed in
@ref{Sample Applications}.
@item $@{RTEMS_ROOT@}/c/src/tests/sptests/
This directory contains the test suite for the RTEMS
Classic API when executing on a single processor.
The tests were originally designed to provide
near complete test coverage for the the entire
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.
@item $@{RTEMS_ROOT@}/c/src/tests/support/
This directory contains support software and header files
for the various test suites.
@item $@{RTEMS_ROOT@}/c/src/tests/tmitrontests/
This directory contains the timing test suite for
the RTEMS ITRON API.
@item $@{RTEMS_ROOT@}/c/src/tests/tmtests/
This directory contains the timing test suite for
the RTEMS Classic API. This include tests that
benchmark each directive in the Classic API
as well as a set of critical SuperCore functions.
These tests are important for helping to verify
that RTEMS performs as expected on your target hardware.
It is not uncommon to discover mistakes in board
initialization such as caching being disabled as
a side-effect of analyzing the results of these tests.
@item $@{RTEMS_ROOT@}/c/src/tests/tools/
This directory contains tools which execute on
the development host and aid in executing and
evaluating the results of the test suite. The
tools @code{difftest} compares the output of one
or more tests with the expected output. If you
place the output of all the @code{tmtests/} in
a single file, then the utility @code{sorttimes}
will be able to produce a report organizing the
execution times by manager.
@end table
@c
@c CPUKit Directory
@c
@section CPUKit Directory
@c The @code{cpukit/} directory structure is as follows: @c The @code{cpukit/} directory structure is as follows:
@c @c
@c CPUKit Tree @c CPU Kit Tree
@c @c
@c @ifset use-ascii @c @ifset use-ascii
@c @example @c @example
@c @group @c @group
@c CPUKit @c cpukit
@c | @c |
@c +-----------+----------+-----------+----------+ @c +-----------+----------+-----------+----------+
@c | | | | | @c | | | | |
@@ -473,15 +374,18 @@ RTEMS build for a particular host and target environment. The
contents of this directory will not be discussed further in this contents of this directory will not be discussed further in this
document. document.
@item $@{RTEMS_ROOT@}/cpukit/ada/
This directory contains the Ada95 language bindings to the
RTEMS Classic API.
@item $@{RTEMS_ROOT@}/cpukit/automake/ @item $@{RTEMS_ROOT@}/cpukit/automake/
This directory contains files which are "Makefile fragments." This directory contains files which are "Makefile fragments."
They are included as required by the various @code{Makefile.am} They are included as required by the various @code{Makefile.am}
files throughout the CPU Kit portion of the RTEMS source tree. files throughout the CPU Kit portion of the RTEMS source tree.
@item $@{RTEMS_ROOT@}/cpukit/ftpd/
This directory contains the RTEMS ftpd server.
@item $@{RTEMS_ROOT@}/cpukit/httpd/
This directory contains the port of the GoAhead
web server to RTEMS.
@item $@{RTEMS_ROOT@}/cpukit/include/ @item $@{RTEMS_ROOT@}/cpukit/include/
This directory contains header files which are private to This directory contains header files which are private to
RTEMS and not considered to be owned by any other component RTEMS and not considered to be owned by any other component
@@ -512,6 +416,24 @@ filesystem implementations for RTEMS. It includes
the In-Memory FileSystem (IMFS), the mini-IMFS, the In-Memory FileSystem (IMFS), the mini-IMFS,
and FAT filesystems. and FAT filesystems.
@item $@{RTEMS_ROOT@}/cpukit/libi2c/
This directory contains the RTEMS I2C framework.
@item $@{RTEMS_ROOT@}/cpukit/libmd/
This directory contains a port of the standard MD5
checksum code.
@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@}/cpukit/libnetworking/ @item $@{RTEMS_ROOT@}/cpukit/libnetworking/
This directory contains the port of the FreeBSD This directory contains the port of the FreeBSD
TCP/IP stack to RTEMS. TCP/IP stack to RTEMS.
@@ -524,6 +446,10 @@ RPC/XDR source to RTEMS.
This directory contains the RTEMS implementation This directory contains the RTEMS implementation
of the threading portions of the POSIX API. of the threading portions of the POSIX API.
@item $@{RTEMS_ROOT@}/cpukit/pppd/
This directory contains a port of the free implementation
of the PPPD network protocol.
@item $@{RTEMS_ROOT@}/cpukit/rtems/ @item $@{RTEMS_ROOT@}/cpukit/rtems/
This directory contains the implementation of the This directory contains the implementation of the
Classic API. Classic API.
@@ -546,7 +472,7 @@ independent of the API used to create it.
Within the @code{score/} directory the CPU dependent modules are found. Within the @code{score/} directory the CPU dependent modules are found.
The @code{score/cpu/} subdirectory 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 this 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 @code{no_cpu} directory provides a code necessary to host RTEMS. The @code{no_cpu} directory provides a
starting point for developing a new port to an unsupported starting point for developing a new port to an unsupported
@@ -554,6 +480,13 @@ processor. The files contained within the @code{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.
@item $@{RTEMS_ROOT@}/cpukit/shttpd/
This directory contains the port of the Simple HTTPD
web server to RTEMS.
@item $@{RTEMS_ROOT@}/cpukit/telnet/
This directory contains the RTEMS telnetd server.
@item $@{RTEMS_ROOT@}/cpukit/wrapup/ @item $@{RTEMS_ROOT@}/cpukit/wrapup/
This directory is responsible for taking the individual This directory is responsible for taking the individual
libraries and objects built in each of the components libraries and objects built in each of the components
@@ -561,8 +494,98 @@ in the RTEMS CPU Kit source tree and bundling them
together to form the single RTEMS library @code{librtemscpu.a}. This together to form the single RTEMS library @code{librtemscpu.a}. This
library contains all BSP and CPU model specific software. library contains all BSP and CPU model specific software.
@item $@{RTEMS_ROOT@}/cpukit/zlib/
This directory contains a port of the GNU Zlib compression
library to RTEMS.
@end table @end table
@c
@c testsuites/ Test Suites
@c
@section testsuites/ Test Suites
This directory provides all of the RTEMS Test Suite
except those for the Classic API Ada95 binding
This includes the single processor tests, multiprocessor tests,
timing tests, library tests, and sample tests. Additionally,
subdirectories for support functions and test related header
files are provided. 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@}/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.
@item $@{RTEMS_ROOT@}/testsuites/mptests/
This directory contains the test suite for the
multiprocessor support in the Classic API.
The tests provided address two node configurations
and provide coverage for the multiprocessor code found
in RTEMS.
@item $@{RTEMS_ROOT@}/testsuites/psxtests/
This directory contains the test suite for the
RTEMS POSIX API.
@item $@{RTEMS_ROOT@}/testsuites/samples/
This directory provides sample application tests
which aid in the testing a newly built RTEMS environment, a new
BSP, or as starting points for the development of an application
using the RTEMS executive. They are discussed in
@ref{Sample Applications}.
@item $@{RTEMS_ROOT@}/testsuites/sptests/
This directory contains the test suite for the RTEMS
Classic API when executing on a single processor.
The tests were originally designed to provide
near complete test coverage for the the entire
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.
@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
benchmark each directive in the Classic API
as well as a set of critical SuperCore functions.
These tests are important for helping to verify
that RTEMS performs as expected on your target hardware.
It is not uncommon to discover mistakes in board
initialization such as caching being disabled as
a side-effect of analyzing the results of these tests.
@item $@{RTEMS_ROOT@}/testsuites/tools/
This directory contains tools which execute on
the development host and aid in executing and
evaluating the results of the test suite. The
tools @code{difftest} compares the output of one
or more tests with the expected output. If you
place the output of all the @code{tmtests/} in
a single file, then the utility @code{sorttimes}
will be able to produce a report organizing the
execution times by manager.
@end table
@c @c
@c Documentation Directory @c Documentation Directory
@c @c
@@ -598,6 +621,10 @@ This includes the copyright page as well as the timing
tables which can be filled in on a per BSP basis in the tables which can be filled in on a per BSP basis in the
CPU supplements. CPU supplements.
@item $@{RTEMS_ROOT@}/doc/cpu_supplement/
This directory contains the source code for the
RTEMS CPU Supplement.
@item $@{RTEMS_ROOT@}/doc/develenv/ @item $@{RTEMS_ROOT@}/doc/develenv/
This directory contains the source code for the This directory contains the source code for the
@cite{RTEMS Development Environment Guide}. This is @cite{RTEMS Development Environment Guide}. This is
@@ -666,11 +693,6 @@ This directory contains the source code for the
This directory contains the source code for the This directory contains the source code for the
@cite{Getting Started with RTEMS for Ada Users} manual. @cite{Getting Started with RTEMS for Ada Users} manual.
@item $@{RTEMS_ROOT@}/doc/cpu_supplement/
This directory contains the source code for the
RTEMS CPU Supplement.
the
@item $@{RTEMS_ROOT@}/doc/tools/ @item $@{RTEMS_ROOT@}/doc/tools/
This directory contains the source code for the tools This directory contains the source code for the tools
used on the development host to assist in producing the used on the development host to assist in producing the

2
doc/develenv/intro.texi
View File

@@ -1,5 +1,5 @@
@c @c
@c COPYRIGHT (c) 1988-2002. @c COPYRIGHT (c) 1989-2007.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@c @c

38
doc/develenv/sample.t
View File

@@ -1,5 +1,5 @@
@c @c
@c COPYRIGHT (c) 1988-2002. @c COPYRIGHT (c) 1989-2007.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@c @c
@@ -11,7 +11,7 @@
@section Introduction @section Introduction
The RTEMS source distribution includes a set of sample applications The RTEMS source distribution includes a set of sample applications
that are located in the @code{$@{RTEMS_ROOT@}/c/src/tests/samples/} that are located in the @code{$@{RTEMS_ROOT@}/testsuites/samples/}
directory. These applications are intended to illustrate the directory. These applications are intended to illustrate the
basic format of RTEMS single and multiple processor basic format of RTEMS single and multiple processor
applications and the use of some features. In addition, these applications and the use of some features. In addition, these
@@ -26,51 +26,51 @@ more detail in the following sections:
@table @b @table @b
@item Hello World @item Hello World
The RTEMS Hello World test is provided in The RTEMS Hello World test is provided in
the subdirectory @code{$@{RTEMS_ROOT@}/c/src/tests/samples/hello/}. the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/hello/}.
This test is helpful when testing new This test is helpful when testing new
versions of RTEMS, BSPs, or modifications to any portion of the versions of RTEMS, BSPs, or modifications to any portion of the
RTEMS development environment. RTEMS development environment.
@item Clock Tick @item Clock Tick
The @code{$@{RTEMS_ROOT@}/c/src/tests/samples/ticker/} The @code{$@{RTEMS_ROOT@}/testsuites/samples/ticker/}
subdirectory provides a test for verification of clock chip subdirectory provides a test for verification of clock chip
device drivers of BSPs. device drivers of BSPs.
@item Base Single Processor @item Base Single Processor
A simple single processor test similar to those in the A simple single processor test similar to those in the
single processor test suite is provided in single processor test suite is provided in
@code{$@{RTEMS_ROOT@}/c/src/tests/samples/base_sp/}. @code{$@{RTEMS_ROOT@}/testsuites/samples/base_sp/}.
@item Base Multiple Processor @item Base Multiple Processor
A simple two node multiprocessor test capable of testing an newly A simple two node multiprocessor test capable of testing an newly
developed MPCI layer is provided in developed MPCI layer is provided in
@code{$@{RTEMS_ROOT@}/c/src/tests/samples/base_mp/}. @code{$@{RTEMS_ROOT@}/testsuites/samples/base_mp/}.
@item Constructor/Destructor C++ Test @item Constructor/Destructor C++ Test
The @code{$@{RTEMS_ROOT@}/c/src/tests/samples/cdtest/} The @code{$@{RTEMS_ROOT@}/testsuites/samples/cdtest/}
subdirectory provides a simple C++ application using subdirectory provides a simple C++ application using
constructors and destructors. It is only built when constructors and destructors. It is only built when
C++ is enabled. C++ is enabled.
@item Paranoia Floating Point Test @item Paranoia Floating Point Test
The directory @code{$@{RTEMS_ROOT@}/c/src/tests/samples/paranoia/} The directory @code{$@{RTEMS_ROOT@}/testsuites/samples/paranoia/}
contains the public domain floating point and math library test. contains the public domain floating point and math library test.
@item Minimum Size Test @item Minimum Size Test
The directory The directory
@code{$@{RTEMS_ROOT@}/c/src/tests/samples/minimum/} @code{$@{RTEMS_ROOT@}/testsuites/samples/minimum/}
contains a simple RTEMS program that results in a non-functional contains a simple RTEMS program that results in a non-functional
executable. It is intended to show the size of a minimum footprint executable. It is intended to show the size of a minimum footprint
application based upon the current RTEMS configuration. application based upon the current RTEMS configuration.
@item Unlimited Object Allocation @item Unlimited Object Allocation
The @code{$@{RTEMS_ROOT@}/c/src/tests/samples/unlimited/} The @code{$@{RTEMS_ROOT@}/testsuites/samples/unlimited/}
directory contains a sample test that demonstrates the use of the directory contains a sample test that demonstrates the use of the
@i{unlimited} object allocation configuration option to RTEMS. @i{unlimited} object allocation configuration option to RTEMS.
@item Network Loopback Test @item Network Loopback Test
The @code{$@{RTEMS_ROOT@}/c/src/tests/samples/loopback/} The @code{$@{RTEMS_ROOT@}/testsuites/samples/loopback/}
directory contains a sample test that demonstrates the use of directory contains a sample test that demonstrates the use of
sockets and the loopback network device. It does not require sockets and the loopback network device. It does not require
the presence of network hardware in order to run. the presence of network hardware in order to run.
@@ -87,7 +87,7 @@ material presented in the @b{RTEMS Applications Users Guide}.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/hello/ $@{RTEMS_ROOT@}/testsuites/samples/hello/
@end example @end example
It provides a rudimentary test of the BSP start up It provides a rudimentary test of the BSP start up
@@ -115,7 +115,7 @@ console output routine is not operating properly.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/ticker/ $@{RTEMS_ROOT@}/testsuites/samples/ticker/
@end example @end example
This application is designed as a simple test of the This application is designed as a simple test of the
@@ -162,7 +162,7 @@ operating properly.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/base_sp/ $@{RTEMS_ROOT@}/testsuites/samples/base_sp/
@end example @end example
It provides a framework from which a single processor It provides a framework from which a single processor
@@ -189,7 +189,7 @@ are printed from the single application task.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/base_mp/ $@{RTEMS_ROOT@}/testsuites/samples/base_mp/
@end example @end example
It provides a framework from which a multiprocessor It provides a framework from which a multiprocessor
@@ -238,7 +238,7 @@ must be unique on each node.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/cdtest/ $@{RTEMS_ROOT@}/testsuites/samples/cdtest/
@end example @end example
This sample application demonstrates that RTEMS is This sample application demonstrates that RTEMS is
@@ -284,7 +284,7 @@ Hey I'M in base class constructor number 1 for 0x400010cc.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/minimum/ $@{RTEMS_ROOT@}/testsuites/samples/minimum/
@end example @end example
This sample application is designed to produce the This sample application is designed to produce the
@@ -300,7 +300,7 @@ hardware shutdown support.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/paranoia/ $@{RTEMS_ROOT@}/testsuites/samples/paranoia/
@end example @end example
This sample application uses a public domain floating This sample application uses a public domain floating
@@ -318,7 +318,7 @@ handlers not installed.
This sample application is in the following directory: This sample application is in the following directory:
@example @example
$@{RTEMS_ROOT@}/tests/samples/loopback/ $@{RTEMS_ROOT@}/testsuites/samples/loopback/
@end example @end example
This sample application uses the network loopback device to This sample application uses the network loopback device to

77
doc/develenv/utils.t
View File

@@ -1,5 +1,5 @@
@c @c
@c COPYRIGHT (c) 1988-2002. @c COPYRIGHT (c) 1989-2007.
@c On-Line Applications Research Corporation (OAR). @c On-Line Applications Research Corporation (OAR).
@c All rights reserved. @c All rights reserved.
@c @c
@@ -183,78 +183,3 @@ file binary.bin:
unhex -o binary.bin downloadA.sr downloadB.sr unhex -o binary.bin downloadA.sr downloadB.sr
@end example @end example
@c
@c size_rtems
@c
@section size_rtems - report RTEMS size information
@subheading SYNOPSIS
@example
size_rtems
@end example
@subheading DESCRIPTION
size_rtems analyzes RTEMS and determines all of the
critical sizing information which is reported in the related
documentation.
@subheading EXAMPLES
To generate the RTEMS size report for the currently
configured processor, execute the following command:
@example
size_rtems
@end example
Although the actual size information will differ, a
report of the following format will be output:
@example
RTEMS SIZE REPORT
CODE DATA BSS
==================
MANAGERS: 15988 0 0
CORE : 4568 0 0
CPU : 364 0 0
OVERALL : 20556 0 0
MINIMUM : 8752 0 0
init : 1592 0 0
tasks : 2440 0 0
intr : 64 0 0
clock : 2252 0 0
sem : 876 0 0
msg : 1624 0 0
event : 604 0 0
signal : 212 0 0
part : 872 0 0
region : 844 0 0
dpmem : 532 0 0
timer : 424 0 0
io : 288 0 0
fatal : 40 0 0
rtmon : 764 0 0
mp : 2984 0 0
sem : 4 0 0
msg : 4 0 0
event : 4 0 0
signal : 4 0 0
part : 4 0 0
region : 4 0 0
timer : 4 0 0
dpmem : 4 0 0
io : 4 0 0
rtmon : 4 0 0
mp : 8 0 0
@end example
@subheading SEE ALSO
gsize020(1G), gsize386(1G), gsize960(1G)