testsuites/samples/README.md

0001 Samples
0002 =======
0003 COPYRIGHT (c) 1989-1999.
0004 On-Line Applications Research Corporation (OAR).
0005
0006 The license and distribution terms for this file may be
0007 found in the file LICENSE in this distribution or at
0008 http://www.rtems.org/license/LICENSE.
0009
0010 This directory contains the RTEMS Sample Application Suite.
0011 The tests in this directory perform two functions:
0012
0013    + provide simple examples of applications which can be
0014      used as a starting point for your application.
0015
0016    + help test a new board support package
0017
0018 The hello and ticker applications are useful when first bringing up
0019 a new board support package.  The base_mp test is useful when
0020 performing initial checkout on a new MPCI layer.
0021
0022 The following describes each of the sample applications:
0023
0024    base_mp
0025
0026       This is a very simple two node multiprocessor application.  It consists
0027       of a single initialization task on each node which print out
0028       their respective node numbers and task IDs.  This test can be
0029       used as a simple test of a new MPCI layer because it minimizes
0030       the number of packets sent by RTEMS.
0031
0032       This is intended as a starting point for custom developed multiprocessor
0033       applications.
0034
0035    base_sp
0036
0037       This is a simple single processor application which consists of
0038       an initialization task which creates another task.
0039
0040       This is intended as a starting point for custom developed single
0041       processor applications.
0042
0043    capture
0044
0045       This simple application starts the monitor and allows you access
0046       to the capture engine. The capture engine provides a trace of
0047       RTEMS activity and is used to debug your application.
0048
0049    cdtest
0050
0051       A very simple C++ application which demonstrates that it is
0052       possible to use C++ contructors and destructors in an RTEMS
0053       application.  Also does a perfunctory iostream test.
0054
0055    hello
0056
0057       This is the RTEMS version of the classic hello world program.
0058       It consists of single initialization task which prints out
0059       a few messages.
0060
0061       This test does not include a Clock Tick device driver and can
0062       be used to test the startup code of the board support package
0063       as well as console output.
0064
0065    paranoia
0066
0067       A public domain test of the floating point and math library
0068       capabilities of a toolset.  It reports discrepancies between
0069       actual and expected results.  It is a large test.
0070
0071    ticker
0072
0073       This is a simple test of the user's Clock Tick device driver.
0074       This test has an initialization task create three application
0075       tasks which sleep and periodically wake up and print the time.
0076
0077    unlimited
0078
0079       This is a test for the umlimited object feature of RTEMS. Here
0080       you can configure RTEMS to give as many objects as memory
0081       in the Workspace.