Changeset 211cafba in rtems


Ignore:
Timestamp:
Apr 16, 2008, 6:30:16 PM (13 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.9, 5, master
Children:
ed1a9004
Parents:
58b9db5
Message:

2008-04-16 Joel Sherrill <joel.sherrill@…>

  • user/bsp.t, user/conf.t, user/init.t, user/intr.t, user/overview.t, user/timer.t: Correct default values. Make it clear that confdefs.h calculates the memory required for you.
Location:
doc
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r58b9db5 r211cafba  
     12008-04-16      Joel Sherrill <joel.sherrill@OARcorp.com>
     2
     3        * user/bsp.t, user/conf.t, user/init.t, user/intr.t, user/overview.t,
     4        user/timer.t: Correct default values. Make it clear that confdefs.h
     5        calculates the memory required for you.
     6
    172008-03-29      Chris Johns <chrisj@rtems.org>
    28
  • doc/user/bsp.t

    r58b9db5 r211cafba  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2008.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    6464@code{@value{DIRPREFIX}initialize_executive} directive,
    6565the Interrupt Vector Table MUST
    66 be set before this directive is invoked to insure correct
     66be set before this directive is invoked to ensure correct
    6767interrupt vectoring.  The processor's Interrupt Vector Table
    6868must be accessible by RTEMS as it will be modified by the
  • doc/user/conf.t

    r58b9db5 r211cafba  
    1 @c  COPYRIGHT (c) 1988-2002.
     1@c  COPYRIGHT (c) 1988-2008.
    22@c  On-Line Applications Research Corporation (OAR).
    33@c  All rights reserved.
     
    10591059to the setting of the macro @code{CONFIGURE_MAXIMUM_TASKS}.
    10601060If not defined by the application, then the @code{CONFIGURE_MAXIMUM_TASKS}
    1061 macro defaults to 10.
     1061macro defaults to 0.
    10621062
    10631063@item maximum_timers
     
    12221222to the setting of the macro @code{CONFIGURE_MAXIMUM_POSIX_THREADS}.
    12231223If not defined by the application, then the
    1224 @code{CONFIGURE_MAXIMUM_POSIX_THREADS} macro defaults to 10.
     1224@code{CONFIGURE_MAXIMUM_POSIX_THREADS} macro defaults to 0.
    12251225
    12261226@item maximum_mutexes
     
    18011801satisfying even the most stringent memory constraints.  As
    18021802result, the size of the RTEMS executive is application
    1803 dependent.  A Memory Requirements worksheet is provided in the
    1804 Applications Supplement document for a specific target
    1805 processor.  This worksheet can be used to calculate the memory
    1806 requirements of a custom RTEMS run-time environment.  To insure
    1807 that enough memory is allocated for future versions of RTEMS,
    1808 the application designer should round these memory requirements
    1809 up.  The following Classic API managers may be optionally excluded:
     1803dependent.
     1804
     1805It is not necessary for RTEMS Application Developers to calculate
     1806the amount of memory required for the RTEMS Workspace.  This
     1807is done automatically by @code{<rtems/confdefs.h>}. 
     1808See @ref{Configuring a System Sizing the RTEMS RAM Workspace} for
     1809more details on how
     1810this works.  In the event, you are interested in the memory required
     1811for an instance of a particular RTEMS object, please run the test
     1812@code{spsize} on your target board.
     1813
     1814RTEMS is built to be a library and any routines that you do not
     1815directly or indirectly require in your application will @b{NOT}
     1816be included in your executable image.  However, some managers
     1817may be explicitly excluded and no attempt to create these instances
     1818of these objects will succeed even if they are configured.
     1819The following Classic API managers may be optionally excluded:
    18101820
    18111821@itemize @bullet
     
    18281838linker being forced to pull large object files in their
    18291839entirety into an application when the application references
    1830 a single symbol.
     1840a single symbol.  In the event you discover an RTEMS method
     1841that is included in your executable but never entered, please
     1842let us know.  It might be an opportunity to break a dependency
     1843and shrink many RTEMS applications.
    18311844
    18321845RTEMS based applications must somehow provide memory
     
    18801893@code{@value{RPREFIX}INVALID_ADDRESS} error code.
    18811894
    1882 A worksheet is provided in the @b{Memory Requirements}
    1883 chapter of the Applications Supplement document for a specific
    1884 target processor to assist the user in calculating the minimum
    1885 size of the RTEMS RAM Workspace for each application.  The value
    1886 calculated with this worksheet is the minimum value that should
    1887 be specified as the @code{work_space_size} parameter of the
    1888 Configuration Table. 
     1895The file @code{<rtems/confdefs.h>} will calculate the
     1896value that is specified as the @code{work_space_size}
     1897parameter of the Configuration Table. There are many
     1898parameters the application developer can specify to
     1899help @code{<rtems/confdefs.h>} in its calculations.  Correctly
     1900specifying the application requirements via parameters
     1901such as @code{CONFIGURE_EXTRA_TASK_STACKS} and
     1902@code{CONFIGURE_MAXIMUM_TASKS} is critical.
    18891903
    18901904The allocation of objects can operate in two modes. The default mode
     
    19151929suficient for a particular target processor and release of RTEMS,
    19161930memory usage is subject to change across versions and target
    1917 processors.  The user is advised to allocate somewhat more memory than
    1918 the worksheet recommends to insure compatibility with future releases
    1919 for a specific target processor and other target processors. To avoid
    1920 problems, the user should recalculate the memory requirements each
     1931processors.  To avoid problems, the user should accurately
     1932specify each configuration parameter and allow
     1933@code{<rtems/confdefs.h>} to calculate the memory requirements.
     1934The memory requirements are likely to change each
    19211935time one of the following events occurs:
    19221936
  • doc/user/init.t

    r58b9db5 r211cafba  
    11@c
    2 @c  COPYRIGHT (c) 1988-2007.
     2@c  COPYRIGHT (c) 1988-2008.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    3838initialization sequence.  Since the initialization tasks are
    3939scheduled using the same algorithm as all other RTEMS tasks,
    40 they must be configured at a priority and mode which will insure
     40they must be configured at a priority and mode which will ensure
    4141that they will complete execution before other application tasks
    4242execute.  Although there is no upper limit on the number of
     
    5858The System Initialization Task is responsible for
    5959initializing all device drivers.  As a result, this task has a
    60 higher priority than all other tasks to insure that no
     60higher priority than all other tasks to ensure that no
    6161application tasks executes until all device drivers are
    6262initialized.  After device initialization in a single processor
  • doc/user/intr.t

    r58b9db5 r211cafba  
    11@c
    2 @c  COPYRIGHT (c) 1988-2007.
     2@c  COPYRIGHT (c) 1988-2008.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    140140execution of the section and restores them to the previous level
    141141upon completion of the section.  RTEMS has been optimized to
    142 insure that interrupts are disabled for a minimum length of
     142ensure that interrupts are disabled for a minimum length of
    143143time.  The maximum length of time interrupts are disabled by
    144144RTEMS is processor dependent and is detailed in the Timing
     
    168168@subsection Directives Allowed from an ISR
    169169
    170 Using the interrupt manager insures that RTEMS knows
     170Using the interrupt manager ensures that RTEMS knows
    171171when a directive is being called from an ISR.  The ISR may then
    172172use system calls to synchronize itself with an application task.
  • doc/user/overview.t

    r58b9db5 r211cafba  
    11@c
    2 @c  COPYRIGHT (c) 1988-2002.
     2@c  COPYRIGHT (c) 1988-2008.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    330330
    331331Since memory is a critical resource in many real-time
    332 embedded systems, RTEMS was specifically designed to allow
    333 unused managers to be excluded from the run-time environment.
    334 This allows the application designer the flexibility to tailor
    335 RTEMS to most efficiently meet system requirements while still
    336 satisfying even the most stringent memory constraints.  As a
    337 result, the size of the RTEMS executive is application
    338 dependent.  A worksheet is provided in the Memory Requirements
    339 chapter of the Applications Supplement document for a specific
    340 target processor.  The worksheet is used to calculate the memory
    341 requirements of a custom RTEMS run-time environment.  The
    342 following managers may be optionally excluded:
    343 
    344 @itemize @bullet
    345 @item clock
    346 @item timer
    347 @item semaphore
    348 @item message
    349 @item event
    350 @item signal
    351 @item partition
    352 @item region
    353 @item dual ported memory
    354 @item I/O
    355 @item rate monotonic
    356 @item fatal error
    357 @item multiprocessing
    358 @end itemize
     332embedded systems, RTEMS was specifically designed to automatically
     333leave out all services that are not required from the run-time
     334environment.  Features such as networking, various fileystems,
     335and many other features are completely optionsl.  This allows
     336the application designer the flexibility to tailor RTEMS to most
     337efficiently meet system requirements while still satisfying even
     338the most stringent memory constraints.  As a result, the size
     339of the RTEMS executive is application dependent.
     340
     341RTEMS requires RAM to manage each instance of an RTEMS object
     342that is created.  Thus the more RTEMS objects an application
     343needs, the more memory that must be reserved.  See
     344@ref{Configuring a System Determining Memory Requirements} for
     345more details.
    359346
    360347RTEMS utilizes memory for both code and data space.
  • doc/user/timer.t

    r58b9db5 r211cafba  
    11@c
    2 @c  COPYRIGHT (c) 1988-2007.
     2@c  COPYRIGHT (c) 1988-2008.
    33@c  On-Line Applications Research Corporation (OAR).
    44@c  All rights reserved.
     
    5050which only fire to denote that an application error has
    5151occurred.  The timer is reset at specific points in the
    52 application to insure that the watchdog does not fire.  Thus, if
     52application to ensure that the watchdog does not fire.  Thus, if
    5353the application does not reset the watchdog timer, then the
    5454timer service routine will fire to indicate that the application
Note: See TracChangeset for help on using the changeset viewer.