Changeset fc121ce in rtems


Ignore:
Timestamp:
Nov 29, 2007, 4:13:32 PM (12 years ago)
Author:
Glenn Humphrey <glenn.humphrey@…>
Branches:
4.8
Children:
eb5b37d
Parents:
b5273f0
Message:

2007-11-29 Glenn Humphrey <glenn.humphrey@…>

  • develenv/direct.t, develenv/sample.t: Corrected various errors in the documentation.
Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    rb5273f0 rfc121ce  
     12007-11-29      Glenn Humphrey <glenn.humphrey@OARcorp.com>
     2
     3        * develenv/direct.t, develenv/sample.t: Corrected various errors in the
     4        documentation.
     5
    162007-11-28      Glenn Humphrey <glenn.humphrey@OARcorp.com>
    27
  • doc/develenv/direct.t

    rb5273f0 rfc121ce  
    128128@item $@{RTEMS_ROOT@}/cpukit/
    129129This directory is the root for all of the "multilib'able"
    130 portions of RTEMS.  This is a GNU way of saying the the
     130portions of RTEMS.  This is a GNU way of saying the
    131131contents of this directory can be compiled like the
    132132C Library (@code{libc.a}) and the functionality is
     
    152152is associated with a specific BSP and describes
    153153the CPU model, compiler flags, and procedure to
    154 a produce an executable for the target board.
     154produce an executable for the target board.
    155155These files are described in detail in the
    156156@b{RTEMS BSP and Device Driver Development Guide}
     
    159159@item $@{RTEMS_ROOT@}/testsuites/
    160160This directory contains the test suites for the
    161 various RTEMS APIs and support libraries.  This
     161various RTEMS APIs and support libraries.  The
    162162contents of this directory are discussed in the
    163163@ref{Directory Structure testsuites/ Test Suites} section.
     
    198198this directory are discussed in the
    199199@ref{Directory Structure c/src/ Directory} section.
    200 
    201 @item $@{RTEMS_ROOT@}/c/make/
    202 This directory is used to generate the file @code{target.cfg}
    203 which is installed as part of the Application Makefiles.  This
    204 file contains settings for various Makefile variables to
    205 tailor them to the particular CPU model and BSP configured.
    206 
    207200@end table
    208201
     
    216209which are CPU model or board dependent.  The
    217210following is a list of the subdirectories in this
    218 directorie and a description of each.
     211directory and a description of each.
    219212
    220213@table @code
     214@item $@{RTEMS_ROOT@}/c/src/aclocal/
     215This directory contains the custom M4 macros which are available to
     216the various GNU autoconf @code{configure.ac} scripts throughout
     217this portion of the RTEMS source tree.  GNU autoconf interprets
     218@code{configure.ac} files to produce the @code{configure} files used
     219to tailor RTEMS build for a particular host and target environment.  The
     220contents of this directory will not be discussed further in this
     221document.
     222
    221223@item $@{RTEMS_ROOT@}/c/src/ada/
    222224This directory contains the Ada95 language bindings to the
     
    227229language bindings to the Classic API.
    228230
     231@item $@{RTEMS_ROOT@}/c/src/automake/
     232This directory contains files which are "Makefile fragments."
     233They are included as required by the various @code{Makefile.am}
     234files throughout this portion of the RTEMS source tree.
     235
    229236@item $@{RTEMS_ROOT@}/c/src/lib/
    230 This directory contains the directories @code{libbsp}
     237This directory contains the directories @code{libbsp/}
    231238and @code{libcpu/} which contain the source code for
    232239the Board Support Packages (BSPs) and CPU Model
     
    250257board dependent.  This directory contains a variety
    251258of drivers for serial devices, network interface
    252 controllers, and real-time clocks.
     259controllers, shared memory and real-time clocks.
    253260
    254261@item $@{RTEMS_ROOT@}/c/src/librtems++/
     
    261268This file contains settings for various Makefile variables to
    262269tailor them to the particular CPU model and BSP configured.
     270
     271@item $@{RTEMS_ROOT@}/c/src/nfsclient/
     272This directory contains a Network File System (NFS) client
     273for RTEMS.  With this file system, a user's application can
     274access files on a remote computer.
    263275
    264276@item $@{RTEMS_ROOT@}/c/src/optman/
     
    269281return @code{E_NOTCONFIGURED}.
    270282
     283@item $@{RTEMS_ROOT@}/c/src/support/
     284This directory exists solely to generate the RTEMS
     285version string which includes the RTEMS version,
     286CPU architecture, CPU model, and BSP name.
     287
    271288@item $@{RTEMS_ROOT@}/c/src/wrapup/
    272289This directory is responsible for taking the individual
     
    295312release of the RTEMS executive.  The subdirectories are
    296313divided,  as discussed previously, based on specific processor
    297 family, then further breaking down into specific target board
    298 environments.  The "shmdr" subdirectory provides the
    299 implementation of a shared memory driver which supports the
    300 multiprocessing portion of the executive.  In addition, two
    301 starting point subdirectories are provided for reference.  The
    302 "no_cpu" subdirectory provides a template BSP which can be used
    303 to develop a specific BSP for an unsupported target board.  The
    304 "stubdr" subdirectory provides stubbed out BSPs.  These files
    305 may aid in preliminary testing of the RTEMS development
    306 environment that has been built for no particular target in mind.
     314family, then further broken down into specific target board
     315environments.  The "no_cpu" subdirectory provides a starting point
     316template BSP which can be used to develop a specific BSP for an
     317unsupported target board.  The files in this subdirectory may aid
     318in preliminary testing of the RTEMS development environment that has
     319been built for no particular target in mind.
    307320
    308321Below each CPU dependent directory is a directory for each target BSP
     
    485498web server to RTEMS.
    486499
    487 @item $@{RTEMS_ROOT@}/cpukit/telnet/
     500@item $@{RTEMS_ROOT@}/cpukit/telnetd/
    488501This directory contains the RTEMS telnetd server.
    489502
     
    547560Classic API when executing on a single processor.
    548561The tests were originally designed to provide
    549 near complete test coverage for the the entire
     562near complete test coverage for the entire
    550563executive code.  With the addition of multiple APIs,
    551564this is no longer the case as some SuperCore functionality
     
    600613@table @code
    601614
    602 @item $@{RTEMS_ROOT@}/doc/user/
    603 This directory contains the source code for the @cite{RTEMS
    604 Applications C User's Guide} which documents the Classic API.
    605 
    606615@item $@{RTEMS_ROOT@}/doc/ada_user/
    607616This directory contains the source code for the @cite{RTEMS
     
    677686release notes document.  This has not been used for
    678687recent RTEMS releases.
    679 
    680 @item $@{RTEMS_ROOT@}/doc/rgdb_specs/
    681 This directory contains the source code for the
    682 @cite{RTEMS Remote Debugger Server Specifications}.
    683 
    684 @item $@{RTEMS_ROOT@}/doc/rtems_gdb/
    685 This directory contains the source code for the
    686 @cite{RTEMS/GDB User's Guide}.
    687688
    688689@item $@{RTEMS_ROOT@}/doc/started/
     
    702703subsection organization.
    703704
     705@item $@{RTEMS_ROOT@}/doc/user/
     706This directory contains the source code for the @cite{RTEMS
     707Applications C User's Guide} which documents the Classic API.
     708
    704709@end table
  • doc/develenv/sample.t

    rb5273f0 rfc121ce  
    2121broken in new BSPs.
    2222
    23 Each of the following sample applications will be listed in
    24 more detail in the following sections:
     23Some of the following sample applications will be covered in
     24more detail in subsequent sections:
    2525
    2626@table @b
     
    2828The RTEMS Hello World test is provided in
    2929the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/hello/}.
    30 This test is helpful when testing new
    31 versions of RTEMS, BSPs, or modifications to any portion of the
    32 RTEMS development environment. 
     30This test is helpful when testing new RTEMS development environment. 
    3331
    3432@item Clock Tick
     
    4745@code{$@{RTEMS_ROOT@}/testsuites/samples/base_mp/}.
    4846
     47@item Capture
     48The RTEMS Capture test is provided in
     49the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/capture/}.
     50This is an interactive test which demonstrates the capabilities
     51of the RTEMS Capture Engine.  It includes a few test threads
     52which generate interesting execution patterns.  Look at the
     53file @code{$@{RTEMS_ROOT@}/testsuites/samples/capture/capture.scn}
     54for a sample session.
     55
    4956@item Constructor/Destructor C++ Test
    5057The @code{$@{RTEMS_ROOT@}/testsuites/samples/cdtest/}
    5158subdirectory provides a simple C++ application using
    5259constructors and destructors.  It is only built when
    53 C++ is enabled. 
    54 
    55 
    56 @item Paranoia Floating Point Test
    57 The directory @code{$@{RTEMS_ROOT@}/testsuites/samples/paranoia/}
    58 contains the public domain floating point and math library test.
     60C++ is enabled and its primary purpose is to demonstrate
     61that global constructors and destructors work.  Since this
     62requires that the linker script for your BSP be correct, this is
     63an important test.
     64
     65@item File IO
     66The RTEMS File IO test is provided in
     67the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/fileio/}.
     68This is an interactive test which allows the user to interact with
     69an ATA/IDE device.  It will read the partition table and allow the
     70user to dynamically mount one of the FAT32 partitions it finds.
     71Commands are also provided to write and read files on the disk.
     72
     73@item IO Stream
     74The RTEMS IO Stream test is provided in
     75the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/iostream/}.
     76This test is a simple C++ application which demonstrates that
     77C++ iostreams are functional. This requires that the RTEMS C++
     78run-time support is functioning properly.  This test is only
     79build when C++ is enabled.
     80
     81@item Network Loopback Test
     82The @code{$@{RTEMS_ROOT@}/testsuites/samples/loopback/}
     83directory contains a sample test that demonstrates the use of
     84sockets and the loopback network device.  It does not require
     85the presence of network hardware in order to run.
     86It is only built if RTEMS was configured with networking enabled.
    5987
    6088@item Minimum Size Test
     
    6593application based upon the current RTEMS configuration. 
    6694
     95@item Nanoseconds
     96The RTEMS Nanoseconds test is provided in
     97the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/nsecs/}.
     98This test demonstrates that the BSP has support for nanosecond
     99timestamp granularity.  It prints the time of day and uptime multiple
     100times as quickly as possible.  It should be possible from the output
     101to determine if your BSP has nanosecond accurate clock support
     102and it is functional.
     103
     104@item Paranoia Floating Point Test
     105The directory @code{$@{RTEMS_ROOT@}/testsuites/samples/paranoia/}
     106contains the public domain floating point and math library test.
     107
     108@item Point-to-Point Protocol Daemon
     109The RTEMS Point-to-Point Protocol Daemon test is provided in
     110the subdirectory @code{$@{RTEMS_ROOT@}/testsuites/samples/pppd/}.
     111This test primarily serves as the baseline for a user application
     112using the PPP protocol.
     113
    67114@item Unlimited Object Allocation
    68115The @code{$@{RTEMS_ROOT@}/testsuites/samples/unlimited/}
     
    70117@i{unlimited} object allocation configuration option to RTEMS.
    71118
    72 @item Network Loopback Test
    73 The @code{$@{RTEMS_ROOT@}/testsuites/samples/loopback/}
    74 directory contains a sample test that demonstrates the use of
    75 sockets and the loopback network device.  It does not require
    76 the presence of network hardware in order to run.
    77 It is only built if RTEMS was configured with networking enabled.
    78 
    79119@end table
    80120
     
    83123material presented in the @b{RTEMS Applications Users Guide}.
    84124
     125@c
     126@c
     127@c
    85128@section Hello World
    86129
     
    95138sample application uses the printf function from the RTEMS
    96139Standard C Library to output messages.   The Ada version of this
    97 sample use the TEXT_IO package to output the hello messages.
     140sample uses the TEXT_IO package to output the hello messages.
    98141The following messages are printed:
    99142
     
    111154console output routine is not operating properly.
    112155
     156@c
     157@c
     158@c
    113159@section Clock Tick
    114160
     
    158204operating properly.
    159205
     206@c
     207@c
     208@c
    160209@section Base Single Processor Application
    161210
     
    185234are printed from the single application task.
    186235
     236@c
     237@c
     238@c
    187239@section Base Multiple Processor Application
    188240
     
    234286must be unique on each node.
    235287
     288@c
     289@c
     290@c
    236291@section Constructor/Destructor C++ Application
    237292
     
    280335@end example
    281336
     337@c
     338@c
     339@c
    282340@section Minimum Size Test
    283341
     
    296354hardware shutdown support.
    297355
     356@c
     357@c
     358@c
     359@section Nanosecond Granularity Application
     360
     361This sample application is in the following directory:
     362
     363@example
     364$@{RTEMS_ROOT@}/testsuites/samples/nsecs/
     365@end example
     366
     367This sample application exercises the Clock Driver
     368for this BSP and demonstrates its ability to generate
     369accurate timestamps.  This application does this by
     370exercising the time subsystem in three ways:
     371
     372@itemize @bullet
     373@item Obtain Time of Day Twice Back to Back
     374@item Obtain System Up Time Twice Back to Back
     375@item Use System Up Time to Measure Loops
     376@end itemize
     377
     378The following is an example of what the output of this
     379test may appear like:
     380
     381@example
     382*** NANOSECOND CLOCK TEST ***
     38310 iterations of getting TOD
     384Start: Sat Mar 24 11:15:00 2007:540000
     385Stop : Sat Mar 24 11:15:00 2007:549000 --> 0:9000
     386Start: Sat Mar 24 11:15:00 2007:3974000
     387Stop : Sat Mar 24 11:15:00 2007:3983000 --> 0:9000
     388Start: Sat Mar 24 11:15:00 2007:7510000
     389Stop : Sat Mar 24 11:15:00 2007:7519000 --> 0:9000
     390Start: Sat Mar 24 11:15:00 2007:11054000
     391Stop : Sat Mar 24 11:15:00 2007:11063000 --> 0:9000
     392Start: Sat Mar 24 11:15:00 2007:14638000
     393Stop : Sat Mar 24 11:15:00 2007:14647000 --> 0:9000
     394Start: Sat Mar 24 11:15:00 2007:18301000
     395Stop : Sat Mar 24 11:15:00 2007:18310000 --> 0:9000
     396Start: Sat Mar 24 11:15:00 2007:21901000
     397Stop : Sat Mar 24 11:15:00 2007:21910000 --> 0:9000
     398Start: Sat Mar 24 11:15:00 2007:25526000
     399Stop : Sat Mar 24 11:15:00 2007:25535000 --> 0:9000
     400Start: Sat Mar 24 11:15:00 2007:29196000
     401Stop : Sat Mar 24 11:15:00 2007:29206000 --> 0:10000
     402Start: Sat Mar 24 11:15:00 2007:32826000
     403Stop : Sat Mar 24 11:15:00 2007:32835000 --> 0:9000
     404
     40510 iterations of getting Uptime
     4060:38977000 0:38986000 --> 0:9000
     4070:40324000 0:40332000 --> 0:8000
     4080:41636000 0:41645000 --> 0:9000
     4090:42949000 0:42958000 --> 0:9000
     4100:44295000 0:44304000 --> 0:9000
     4110:45608000 0:45617000 --> 0:9000
     4120:46921000 0:46930000 --> 0:9000
     4130:48282000 0:48291000 --> 0:9000
     4140:49595000 0:49603000 --> 0:8000
     4150:50908000 0:50917000 --> 0:9000
     416
     41710 iterations of getting Uptime with different loop values
     418loop of 10000 0:119488000 0:119704000 --> 0:216000
     419loop of 20000 0:124028000 0:124463000 --> 0:435000
     420loop of 30000 0:128567000 0:129220000 --> 0:653000
     421loop of 40000 0:133097000 0:133964000 --> 0:867000
     422loop of 50000 0:137643000 0:138728000 --> 0:1085000
     423loop of 60000 0:142265000 0:143572000 --> 0:1307000
     424loop of 70000 0:146894000 0:148416000 --> 0:1522000
     425loop of 80000 0:151519000 0:153260000 --> 0:1741000
     426loop of 90000 0:156145000 0:158099000 --> 0:1954000
     427loop of 100000 0:160770000 0:162942000 --> 0:2172000
     428*** END OF NANOSECOND CLOCK TEST ***
     429@end example
     430
     431@c
     432@c
     433@c
    298434@section Paranoia Floating Point Application
    299435
     
    314450handlers not installed.
    315451
     452@c
     453@c
     454@c
    316455@section Network Loopback Test
    317456
Note: See TracChangeset for help on using the changeset viewer.